regular-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 REGULAR_WIFI_MAC_H
#define REGULAR_WIFI_MAC_H

#include "wifi-mac.h"
#include "qos-txop.h"
#include "ssid.h"
#include <set>
#include <unordered_map>

namespace ns3 {

class MacRxMiddle;
class MacTxMiddle;
class ChannelAccessManager;
class ExtendedCapabilities;
class FrameExchangeManager;
class WifiPsdu;
enum WifiTxTimerReason : uint8_t;

typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;

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

  RegularWifiMac ();
  virtual ~RegularWifiMac ();

  // Implementations of pure virtual methods.
  void SetShortSlotTimeSupported (bool enable) override;
  void SetSsid (Ssid ssid) override;
  void SetAddress (Mac48Address address) override;
  void SetPromisc (void) override;
  bool GetShortSlotTimeSupported (void) const override;
  Ssid GetSsid (void) const override;
  Mac48Address GetAddress (void) const override;
  Mac48Address GetBssid (void) const override;
  void Enqueue (Ptr<Packet> packet, Mac48Address to, Mac48Address from) override;
  bool SupportsSendFrom (void) const override;
  void SetWifiPhy (const Ptr<WifiPhy> phy) override;
  Ptr<WifiPhy> GetWifiPhy (void) const override;
  void ResetWifiPhy (void) override;
  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> stationManager) override;
  void ConfigureStandard (WifiStandard standard) override;
  TypeOfStation GetTypeOfStation (void) const override;
  void SetForwardUpCallback (ForwardUpCallback upCallback) override;
  void SetLinkUpCallback (Callback<void> linkUp) override;
  void SetLinkDownCallback (Callback<void> linkDown) override;
  Ptr<WifiRemoteStationManager> GetWifiRemoteStationManager (void) const override;

  // Should be implemented by child classes
  void Enqueue (Ptr<Packet> packet, Mac48Address to) override = 0;

  Ptr<FrameExchangeManager> GetFrameExchangeManager (void) const;

  void SetCtsToSelfSupported (bool enable);
  void SetBssid (Mac48Address bssid);

  Ptr<Txop> GetTxop (void) const;
  Ptr<QosTxop> GetQosTxop (AcIndex ac) const;
  Ptr<QosTxop> GetQosTxop (uint8_t tid) const;

  ExtendedCapabilities GetExtendedCapabilities (void) const;
  HtCapabilities GetHtCapabilities (void) const;
  VhtCapabilities GetVhtCapabilities (void) const;
  HeCapabilities GetHeCapabilities (void) const;

protected:
  void DoInitialize () override;
  void DoDispose () override;
  void SetTypeOfStation (TypeOfStation type) override;

  Ptr<MacRxMiddle> m_rxMiddle;                      
  Ptr<MacTxMiddle> m_txMiddle;                      
  Ptr<ChannelAccessManager> m_channelAccessManager; 
  Ptr<WifiPhy> m_phy;                               
  Ptr<FrameExchangeManager> m_feManager;            

  Ptr<WifiRemoteStationManager> m_stationManager; 

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

  Ssid m_ssid; 

  Ptr<Txop> m_txop;

  typedef std::map<AcIndex, Ptr<QosTxop> > EdcaQueues;

  EdcaQueues m_edca;

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

  void ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax);

  virtual void Receive (Ptr<WifiMacQueueItem> mpdu);

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

  virtual void DeaggregateAmsduAndForward (Ptr<WifiMacQueueItem> mpdu);

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

  void SetupFrameExchangeManager (void);

  bool GetHtSupported () const;

  bool GetVhtSupported () const;

  void SetErpSupported (bool enable);
  bool GetErpSupported () const;

  void SetDsssSupported (bool enable);
  bool GetDsssSupported () const;

  bool GetHeSupported () const;

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

  void SetupEdcaQueue (AcIndex ac);

  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);

  TypeOfStation m_typeOfStation;                        

  bool m_qosSupported;
  bool m_erpSupported;
  bool m_dsssSupported;

  Mac48Address m_address;   
  Mac48Address m_bssid;     

  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; 

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

  typedef TracedCallback<Ptr<const WifiMacQueueItem>> MpduTracedCallback;

  MpduTracedCallback m_ackedMpduCallback;  
  MpduTracedCallback m_nackedMpduCallback; 

  typedef void (* DroppedMpduCallback)(WifiMacDropReason reason, Ptr<const WifiMacQueueItem> mpdu);

  typedef TracedCallback<WifiMacDropReason, Ptr<const WifiMacQueueItem>> DroppedMpduTracedCallback;

  DroppedMpduTracedCallback m_droppedMpduCallback;

  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;

  bool m_shortSlotTimeSupported; 
  bool m_ctsToSelfSupported;     
};

} //namespace ns3

#endif /* REGULAR_WIFI_MAC_H */