wifi-mac.h

Go to the documentation of this file.

/* -*- 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 WIFI_MAC_H
#define WIFI_MAC_H
 
#include <set>
#include <unordered_map>
#include "wifi-standards.h"
#include "wifi-remote-station-manager.h"
#include "qos-utils.h"
#include "ssid.h"
 
namespace ns3 {
 
class Txop;
class WifiNetDevice;
class QosTxop;
class WifiPsdu;
class MacRxMiddle;
class MacTxMiddle;
class WifiMacQueue;
class WifiMacQueueItem;
class HtConfiguration;
class VhtConfiguration;
class HeConfiguration;
class FrameExchangeManager;
class ChannelAccessManager;
class ExtendedCapabilities;
 
enum TypeOfStation
{
  STA,
  AP,
  ADHOC_STA,
  MESH,
  OCB
};
 
enum WifiMacDropReason : uint8_t
{
  WIFI_MAC_DROP_FAILED_ENQUEUE = 0,
  WIFI_MAC_DROP_EXPIRED_LIFETIME,
  WIFI_MAC_DROP_REACHED_RETRY_LIMIT,
  WIFI_MAC_DROP_QOS_OLD_PACKET
};
 
typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;
 
class WifiMac : public Object
{
public:
  static TypeId GetTypeId (void);
 
  WifiMac ();
  virtual ~WifiMac ();
 
  void SetDevice (const Ptr<WifiNetDevice> device);
  Ptr<WifiNetDevice> GetDevice (void) const;
 
  Ptr<FrameExchangeManager> GetFrameExchangeManager (void) const;
 
  Ptr<Txop> GetTxop (void) const;
  Ptr<QosTxop> GetQosTxop (AcIndex ac) const;
  Ptr<QosTxop> GetQosTxop (uint8_t tid) const;
  virtual Ptr<WifiMacQueue> GetTxopQueue (AcIndex ac) const;
 
  void SetTypeOfStation (TypeOfStation type);
  TypeOfStation GetTypeOfStation (void) const;
 
  void SetSsid (Ssid ssid);
  void SetPromisc (void);
  void SetCtsToSelfSupported (bool enable);
 
  Mac48Address GetAddress (void) const;
  Ssid GetSsid (void) const;
  virtual void SetAddress (Mac48Address address);
  Mac48Address GetBssid (void) const;
  void SetBssid (Mac48Address bssid);
 
  virtual bool CanForwardPacketsTo (Mac48Address to) const = 0;
  virtual void Enqueue (Ptr<Packet> packet, Mac48Address to, Mac48Address from);
  virtual void Enqueue (Ptr<Packet> packet, Mac48Address to) = 0;
  virtual bool SupportsSendFrom (void) const;
 
  virtual void SetWifiPhy (Ptr<WifiPhy> phy);
  Ptr<WifiPhy> GetWifiPhy (void) const;
  void ResetWifiPhy (void);
 
  void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager);
  Ptr<WifiRemoteStationManager> GetWifiRemoteStationManager (void) const;
 
  typedef Callback<void, Ptr<const Packet>, Mac48Address, Mac48Address> ForwardUpCallback;
 
  void SetForwardUpCallback (ForwardUpCallback upCallback);
  virtual void SetLinkUpCallback (Callback<void> linkUp);
  void SetLinkDownCallback (Callback<void> linkDown);
  /* Next functions are not pure virtual so non QoS WifiMacs are not
   * forced to implement them.
   */
 
  virtual void NotifyChannelSwitching (void);
 
  void NotifyTx (Ptr<const Packet> packet);
  void NotifyTxDrop (Ptr<const Packet> packet);
  void NotifyRx (Ptr<const Packet> packet);
  void NotifyPromiscRx (Ptr<const Packet> packet);
  void NotifyRxDrop (Ptr<const Packet> packet);
 
  virtual void ConfigureStandard (WifiStandard standard);
 
  Ptr<HtConfiguration> GetHtConfiguration (void) const;
  Ptr<VhtConfiguration> GetVhtConfiguration (void) const;
  Ptr<HeConfiguration> GetHeConfiguration (void) const;
 
  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  HeCapabilities GetHeCapabilities (void) const;
 
  bool GetQosSupported () const;
  bool GetErpSupported () const;
  bool GetDsssSupported () const;
  bool GetHtSupported () const;
  bool GetVhtSupported () const;
  bool GetHeSupported () const;
 
  uint32_t GetMaxAmpduSize (AcIndex ac) const;
  uint16_t GetMaxAmsduSize (AcIndex ac) const;
 
 
protected:
  void DoInitialize () override;
  void DoDispose () override;
 
  virtual void ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax);
 
  void SetQosSupported (bool enable);
 
  void SetShortSlotTimeSupported (bool enable);
  bool GetShortSlotTimeSupported (void) const;
 
  Ptr<QosTxop> GetVOQueue (void) const;
  Ptr<QosTxop> GetVIQueue (void) const;
  Ptr<QosTxop> GetBEQueue (void) const;
  Ptr<QosTxop> GetBKQueue (void) const;
 
  virtual void Receive (Ptr<WifiMacQueueItem> mpdu);
  void ForwardUp (Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
 
  virtual void DeaggregateAmsduAndForward (Ptr<WifiMacQueueItem> mpdu);
 
  Ptr<MacRxMiddle> m_rxMiddle;                      
  Ptr<MacTxMiddle> m_txMiddle;                      
  Ptr<ChannelAccessManager> m_channelAccessManager; 
  Ptr<FrameExchangeManager> m_feManager;            
  Ptr<Txop> m_txop;                                 
 
  Callback<void> m_linkUp;       
  Callback<void> m_linkDown;     
 
 
private:
  WifiMac (const WifiMac&);
  WifiMac & operator= (const WifiMac& mac);
 
  void ConfigureDcf (Ptr<Txop> dcf, uint32_t cwmin, uint32_t cwmax, bool isDsss, AcIndex ac);
 
  void ConfigurePhyDependentParameters (void);
 
  void SetupEdcaQueue (AcIndex ac);
 
  void SetupFrameExchangeManager (WifiStandard standard);
 
  void SetErpSupported (bool enable);
  void SetDsssSupported (bool enable);
 
  void SetVoBlockAckThreshold (uint8_t threshold);
  void SetViBlockAckThreshold (uint8_t threshold);
  void SetBeBlockAckThreshold (uint8_t threshold);
  void SetBkBlockAckThreshold (uint8_t threshold);
 
  void SetVoBlockAckInactivityTimeout (uint16_t timeout);
  void SetViBlockAckInactivityTimeout (uint16_t timeout);
  void SetBeBlockAckInactivityTimeout (uint16_t timeout);
  void SetBkBlockAckInactivityTimeout (uint16_t timeout);
 
  bool m_qosSupported;
  bool m_erpSupported;
  bool m_dsssSupported;
 
  bool m_shortSlotTimeSupported; 
  bool m_ctsToSelfSupported;     
 
  TypeOfStation m_typeOfStation; 
 
  Ptr<WifiNetDevice> m_device;                    
  Ptr<WifiPhy> m_phy;                             
  Ptr<WifiRemoteStationManager> m_stationManager; 
 
  Mac48Address m_address; 
  Ssid m_ssid;            
  Mac48Address m_bssid;   
 
  typedef std::map<AcIndex, Ptr<QosTxop> > EdcaQueues;
 
  EdcaQueues m_edca;
 
  uint16_t m_voMaxAmsduSize; 
  uint16_t m_viMaxAmsduSize; 
  uint16_t m_beMaxAmsduSize; 
  uint16_t m_bkMaxAmsduSize; 
 
  uint32_t m_voMaxAmpduSize; 
  uint32_t m_viMaxAmpduSize; 
  uint32_t m_beMaxAmpduSize; 
  uint32_t m_bkMaxAmpduSize; 
 
  ForwardUpCallback m_forwardUp; 
 
  TracedCallback<Ptr<const Packet> > m_macTxTrace;
  TracedCallback<Ptr<const Packet> > m_macTxDropTrace;
  TracedCallback<Ptr<const Packet> > m_macPromiscRxTrace;
  TracedCallback<Ptr<const Packet> > m_macRxTrace;
  TracedCallback<Ptr<const Packet> > m_macRxDropTrace;
 
  TracedCallback<const WifiMacHeader &> m_txOkCallback;  
  TracedCallback<const WifiMacHeader &> m_txErrCallback; 
 
  typedef void (* DroppedMpduCallback)(WifiMacDropReason reason, Ptr<const WifiMacQueueItem> mpdu);
 
  typedef TracedCallback<WifiMacDropReason, Ptr<const WifiMacQueueItem>> DroppedMpduTracedCallback;
 
  DroppedMpduTracedCallback m_droppedMpduCallback;
 
  typedef TracedCallback<Ptr<const WifiMacQueueItem>> MpduTracedCallback;
 
  MpduTracedCallback m_ackedMpduCallback;  
  MpduTracedCallback m_nackedMpduCallback; 
 
  typedef void (* MpduResponseTimeoutCallback)(uint8_t reason, Ptr<const WifiMacQueueItem> mpdu,
                                               const WifiTxVector& txVector);
 
  typedef TracedCallback<uint8_t, Ptr<const WifiMacQueueItem>, const WifiTxVector&> MpduResponseTimeoutTracedCallback;
 
  MpduResponseTimeoutTracedCallback m_mpduResponseTimeoutCallback;
 
  typedef void (* PsduResponseTimeoutCallback)(uint8_t reason, Ptr<const WifiPsdu> psdu,
                                               const WifiTxVector& txVector);
 
  typedef TracedCallback<uint8_t, Ptr<const WifiPsdu>, const WifiTxVector&> PsduResponseTimeoutTracedCallback;
 
  PsduResponseTimeoutTracedCallback m_psduResponseTimeoutCallback;
 
  typedef void (* PsduMapResponseTimeoutCallback)(uint8_t reason, WifiPsduMap* psduMap,
                                                  const std::set<Mac48Address>* missingStations,
                                                  std::size_t nTotalStations);
 
  typedef TracedCallback<uint8_t, WifiPsduMap*, const std::set<Mac48Address>*, std::size_t> PsduMapResponseTimeoutTracedCallback;
 
  PsduMapResponseTimeoutTracedCallback m_psduMapResponseTimeoutCallback;
};
 
} //namespace ns3
 
#endif /* WIFI_MAC_H */