regular-wifi-mac.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 INRIA
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef REGULAR_WIFI_MAC_H
#define REGULAR_WIFI_MAC_H

#include "ns3/wifi-mac.h"
#include "ns3/spectrum-manager.h"

#include "dca-txop.h"
#include "edca-txop-n.h"
#include "wifi-remote-station-manager.h"
#include "ssid.h"
#include "qos-utils.h"

#include <map>

namespace ns3 {

class Dcf;
class MacLow;
class MacRxMiddle;
class MacTxMiddle;
class DcfManager;

class RegularWifiMac : public WifiMac
{
public:
  static TypeId GetTypeId (void);

  RegularWifiMac ();
  virtual ~RegularWifiMac ();

  void SetSlot (Time slotTime);
  void SetSifs (Time sifs);
  void SetEifsNoDifs (Time eifsNoDifs);
  void SetPifs (Time pifs);
  void SetCtsTimeout (Time ctsTimeout);
  void SetAckTimeout (Time ackTimeout);
  Time GetPifs (void) const;
  Time GetSifs (void) const;
  Time GetSlot (void) const;
  Time GetEifsNoDifs (void) const;
  Time GetCtsTimeout (void) const;
  Time GetAckTimeout (void) const;
  virtual Mac48Address GetAddress (void) const;
  virtual Ssid GetSsid (void) const;
  virtual void SetAddress (Mac48Address address);
  virtual void SetSsid (Ssid ssid);
  virtual void SetBssid (Mac48Address bssid);
  virtual Mac48Address GetBssid (void) const;
  virtual void SetPromisc (void);

  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from);
  virtual bool SupportsSendFrom (void) const;

  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to) = 0;
  virtual void SetWifiPhy (Ptr<WifiPhy> phy);
  virtual Ptr<WifiPhy> GetWifiPhy () const;
  virtual void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager);
  virtual Ptr<WifiRemoteStationManager> GetWifiRemoteStationManager () const;

  typedef Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> ForwardUpCallback;
  virtual void SetForwardUpCallback (ForwardUpCallback upCallback);
  virtual void SetLinkUpCallback (Callback<void> linkUp);
  virtual void SetLinkDownCallback (Callback<void> linkDown);
  /* Next functions are not pure virtual so non Qos WifiMacs are not
   * forced to implement them.
   */
  virtual void SetBasicBlockAckTimeout (Time blockAckTimeout);
  virtual Time GetBasicBlockAckTimeout (void) const;
  virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout);
  virtual Time GetCompressedBlockAckTimeout (void) const;
  void RestartAccess(void);

protected:
  virtual void DoInitialize ();
  virtual void DoDispose ();

  MacRxMiddle *m_rxMiddle;
  MacTxMiddle *m_txMiddle;
  Ptr<MacLow> m_low;
  DcfManager *m_dcfManager;
  Ptr<WifiPhy> m_phy;

  Ptr<WifiRemoteStationManager> m_stationManager;

  ForwardUpCallback m_forwardUp;
  Callback<void> m_linkUp;
  Callback<void> m_linkDown;

  Ssid m_ssid;

  Ptr<DcaTxop> m_dca;

  typedef std::map<AcIndex, Ptr<EdcaTxopN> > EdcaQueues;
  EdcaQueues m_edca;

  virtual void FinishConfigureStandard (enum WifiPhyStandard standard);

  void SetTypeOfStation (TypeOfStation type);

  virtual void Receive (Ptr<Packet> packet, const WifiMacHeader *hdr);
  virtual void TxOk (const WifiMacHeader &hdr);
  virtual void TxFailed (const WifiMacHeader &hdr);

  void ForwardUp (Ptr<Packet> packet, Mac48Address from, Mac48Address to);

  virtual void DeaggregateAmsduAndForward (Ptr<Packet> aggregatedPacket,
                                           const WifiMacHeader *hdr);

  virtual void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr,
                                  Mac48Address originator);

  bool m_qosSupported;
  void SetQosSupported (bool enable);
  bool GetQosSupported () const;

  bool IsTxRadio (void);
  void SetTxRadio (bool isTx);
  bool IsRxRadio (void);
  void SetRxRadio (bool isRx, Ptr<Node> node, Ptr<Repository> repo,
      Ptr<PUModel> puModel, Ptr<WifiPhy> phy);

private:
  RegularWifiMac (const RegularWifiMac &);
  RegularWifiMac & operator= (const RegularWifiMac &);

  void SetupEdcaQueue (enum AcIndex ac);

  Ptr<DcaTxop> GetDcaTxop (void) const;

  Ptr<EdcaTxopN> GetVOQueue (void) const;
  Ptr<EdcaTxopN> GetVIQueue (void) const;
  Ptr<EdcaTxopN> GetBEQueue (void) const;
  Ptr<EdcaTxopN> GetBKQueue (void) const;

  SpectrumManager *m_spectrumManager;
  Ptr<Node> m_node;
  Time m_snsInterval;
  Time m_txInterval;
  double m_probMisdetect;

  TracedCallback<const WifiMacHeader &> m_txOkCallback;
  TracedCallback<const WifiMacHeader &> m_txErrCallback;
};

} // namespace ns3

#endif /* REGULAR_WIFI_MAC_H */