wifi-phy.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006 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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef WIFI_PHY_H
#define WIFI_PHY_H

#include <stdint.h>
#include <map>
#include "ns3/callback.h"
#include "ns3/event-id.h"
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
#include "ns3/mobility-model.h"
#include "ns3/random-variable-stream.h"
#include "wifi-mode.h"
#include "wifi-preamble.h"
#include "wifi-phy-standard.h"
#include "ns3/traced-callback.h"
#include "wifi-tx-vector.h"
#include "wifi-phy-standard.h"
#include "interference-helper.h"
#include "ns3/net-device.h"
#include "ns3/node.h"
#include "wifi-channel.h"

namespace ns3 {

#define VHT_PHY 126
#define HT_PHY 127

class WifiPhyStateHelper;

enum mpduType
{
  NORMAL_MPDU = 0,
  MPDU_IN_AGGREGATE,
  LAST_MPDU_IN_AGGREGATE
};

struct signalNoiseDbm
{
  double signal; //in dBm
  double noise; //in dBm
};

struct mpduInfo
{
  enum mpduType type;
  uint32_t mpduRefNumber;
};

class WifiPhyListener
{
public:
  virtual ~WifiPhyListener ();

  virtual void NotifyRxStart (Time duration) = 0;
  virtual void NotifyRxEndOk (void) = 0;
  virtual void NotifyRxEndError (void) = 0;
  virtual void NotifyTxStart (Time duration, double txPowerDbm) = 0;
  virtual void NotifyMaybeCcaBusyStart (Time duration) = 0;
  virtual void NotifySwitchingStart (Time duration) = 0;
  virtual void NotifySleep (void) = 0;
  virtual void NotifyWakeup (void) = 0;
};


class WifiPhy : public Object
{
public:
  enum State
  {
    IDLE,
    CCA_BUSY,
    TX,
    RX,
    SWITCHING,
    SLEEP
  };

  typedef Callback<void, Ptr<Packet>, double, WifiTxVector, enum WifiPreamble> RxOkCallback;
  typedef Callback<void, Ptr<Packet>, double> RxErrorCallback;

  static TypeId GetTypeId (void);

  WifiPhy ();
  virtual ~WifiPhy ();

  virtual void SetReceiveOkCallback (RxOkCallback callback) = 0;
  virtual void SetReceiveErrorCallback (RxErrorCallback callback) = 0;

  virtual void SendPacket (Ptr<const Packet> packet, WifiTxVector txVector, enum WifiPreamble preamble) = 0;
  virtual void SendPacket (Ptr<const Packet> packet, WifiTxVector txVector, enum WifiPreamble preamble, enum mpduType mpdutype) = 0;

  virtual void RegisterListener (WifiPhyListener *listener) = 0;
  virtual void UnregisterListener (WifiPhyListener *listener) = 0;

  virtual void SetSleepMode (void) = 0;
  virtual void ResumeFromSleep (void) = 0;

  virtual bool IsStateIdle (void);
  virtual bool IsStateCcaBusy (void);
  virtual bool IsStateBusy (void);
  virtual bool IsStateRx (void);
  virtual bool IsStateTx (void);
  virtual bool IsStateSwitching (void);
  virtual bool IsStateSleep (void);
  virtual Time GetStateDuration (void);
  virtual Time GetDelayUntilIdle (void);

  virtual Time GetLastRxStartTime (void) const;

  Time CalculateTxDuration (uint32_t size, WifiTxVector txVector, enum WifiPreamble preamble, double frequency);
  Time CalculateTxDuration (uint32_t size, WifiTxVector txVector, enum WifiPreamble preamble, double frequency, enum mpduType mpdutype, uint8_t incFlag);

  Time CalculatePlcpPreambleAndHeaderDuration (WifiTxVector txVector, enum WifiPreamble preamble);

  static Time GetPlcpHtTrainingSymbolDuration (WifiPreamble preamble, WifiTxVector txVector);
  static WifiMode GetHtPlcpHeaderMode (WifiMode payloadMode);
  static WifiMode GetVhtPlcpHeaderMode (WifiMode payloadMode);
  static Time GetPlcpHtSigHeaderDuration (WifiPreamble preamble);
  static Time GetPlcpVhtSigA1Duration (WifiPreamble preamble);
  static Time GetPlcpVhtSigA2Duration (WifiPreamble preamble);
  static Time GetPlcpVhtSigBDuration (WifiPreamble preamble);
  static WifiMode GetPlcpHeaderMode (WifiMode payloadMode, WifiPreamble preamble, WifiTxVector txVector);
  static Time GetPlcpHeaderDuration (WifiTxVector txVector, WifiPreamble preamble);
  static Time GetPlcpPreambleDuration (WifiTxVector txVector, WifiPreamble preamble);
  Time GetPayloadDuration (uint32_t size, WifiTxVector txVector, WifiPreamble preamble, double frequency);
  Time GetPayloadDuration (uint32_t size, WifiTxVector txVector, WifiPreamble preamble, double frequency, enum mpduType mpdutype, uint8_t incFlag);

  virtual uint32_t GetNModes (void) const;
  virtual WifiMode GetMode (uint32_t mode) const;
  virtual bool IsModeSupported (WifiMode mode) const;
  virtual bool IsMcsSupported (WifiMode mcs) const;

  virtual double CalculateSnr (WifiTxVector txVector, double ber) const;

  virtual uint32_t GetNBssMembershipSelectors (void) const;
  virtual uint32_t GetBssMembershipSelector (uint32_t selector) const;
  virtual WifiModeList GetMembershipSelectorModes (uint32_t selector);
  virtual uint8_t GetNMcs (void) const;
  virtual WifiMode GetMcs (uint8_t mcs) const;

  virtual void SetChannelNumber (uint16_t id);
  virtual uint16_t GetChannelNumber (void) const;
  virtual Time GetChannelSwitchDelay (void) const;

  virtual void ConfigureStandard (enum WifiPhyStandard standard);

  virtual enum WifiPhyStandard GetStandard (void) const;

  bool DefineChannelNumber (uint16_t channelNumber, enum WifiPhyStandard standard, uint32_t frequency, uint32_t channelWidth);

  typedef std::pair<uint16_t, enum WifiPhyStandard> ChannelNumberStandardPair;
  typedef std::pair<uint32_t, uint32_t> FrequencyWidthPair;

  virtual Ptr<WifiChannel> GetChannel (void) const = 0;

  static WifiMode GetDsssRate1Mbps ();
  static WifiMode GetDsssRate2Mbps ();
  static WifiMode GetDsssRate5_5Mbps ();
  static WifiMode GetDsssRate11Mbps ();
  static WifiMode GetErpOfdmRate6Mbps ();
  static WifiMode GetErpOfdmRate9Mbps ();
  static WifiMode GetErpOfdmRate12Mbps ();
  static WifiMode GetErpOfdmRate18Mbps ();
  static WifiMode GetErpOfdmRate24Mbps ();
  static WifiMode GetErpOfdmRate36Mbps ();
  static WifiMode GetErpOfdmRate48Mbps ();
  static WifiMode GetErpOfdmRate54Mbps ();
  static WifiMode GetOfdmRate6Mbps ();
  static WifiMode GetOfdmRate9Mbps ();
  static WifiMode GetOfdmRate12Mbps ();
  static WifiMode GetOfdmRate18Mbps ();
  static WifiMode GetOfdmRate24Mbps ();
  static WifiMode GetOfdmRate36Mbps ();
  static WifiMode GetOfdmRate48Mbps ();
  static WifiMode GetOfdmRate54Mbps ();
  static WifiMode GetOfdmRate3MbpsBW10MHz ();
  static WifiMode GetOfdmRate4_5MbpsBW10MHz ();
  static WifiMode GetOfdmRate6MbpsBW10MHz ();
  static WifiMode GetOfdmRate9MbpsBW10MHz ();
  static WifiMode GetOfdmRate12MbpsBW10MHz ();
  static WifiMode GetOfdmRate18MbpsBW10MHz ();
  static WifiMode GetOfdmRate24MbpsBW10MHz ();
  static WifiMode GetOfdmRate27MbpsBW10MHz ();
  static WifiMode GetOfdmRate1_5MbpsBW5MHz ();
  static WifiMode GetOfdmRate2_25MbpsBW5MHz ();
  static WifiMode GetOfdmRate3MbpsBW5MHz ();
  static WifiMode GetOfdmRate4_5MbpsBW5MHz ();
  static WifiMode GetOfdmRate6MbpsBW5MHz ();
  static WifiMode GetOfdmRate9MbpsBW5MHz ();
  static WifiMode GetOfdmRate12MbpsBW5MHz ();
  static WifiMode GetOfdmRate13_5MbpsBW5MHz ();

  static WifiMode GetHtMcs0 ();
  static WifiMode GetHtMcs1 ();
  static WifiMode GetHtMcs2 ();
  static WifiMode GetHtMcs3 ();
  static WifiMode GetHtMcs4 ();
  static WifiMode GetHtMcs5 ();
  static WifiMode GetHtMcs6 ();
  static WifiMode GetHtMcs7 ();
  static WifiMode GetHtMcs8 ();
  static WifiMode GetHtMcs9 ();
  static WifiMode GetHtMcs10 ();
  static WifiMode GetHtMcs11 ();
  static WifiMode GetHtMcs12 ();
  static WifiMode GetHtMcs13 ();
  static WifiMode GetHtMcs14 ();
  static WifiMode GetHtMcs15 ();
  static WifiMode GetHtMcs16 ();
  static WifiMode GetHtMcs17 ();
  static WifiMode GetHtMcs18 ();
  static WifiMode GetHtMcs19 ();
  static WifiMode GetHtMcs20 ();
  static WifiMode GetHtMcs21 ();
  static WifiMode GetHtMcs22 ();
  static WifiMode GetHtMcs23 ();
  static WifiMode GetHtMcs24 ();
  static WifiMode GetHtMcs25 ();
  static WifiMode GetHtMcs26 ();
  static WifiMode GetHtMcs27 ();
  static WifiMode GetHtMcs28 ();
  static WifiMode GetHtMcs29 ();
  static WifiMode GetHtMcs30 ();
  static WifiMode GetHtMcs31 ();

  static WifiMode GetVhtMcs0 ();
  static WifiMode GetVhtMcs1 ();
  static WifiMode GetVhtMcs2 ();
  static WifiMode GetVhtMcs3 ();
  static WifiMode GetVhtMcs4 ();
  static WifiMode GetVhtMcs5 ();
  static WifiMode GetVhtMcs6 ();
  static WifiMode GetVhtMcs7 ();
  static WifiMode GetVhtMcs8 ();
  static WifiMode GetVhtMcs9 ();
  static bool IsValidTxVector (WifiTxVector txVector);

  void NotifyTxBegin (Ptr<const Packet> packet);
  void NotifyTxEnd (Ptr<const Packet> packet);
  void NotifyTxDrop (Ptr<const Packet> packet);
  void NotifyRxBegin (Ptr<const Packet> packet);
  void NotifyRxEnd (Ptr<const Packet> packet);
  void NotifyRxDrop (Ptr<const Packet> packet);

  void NotifyMonitorSniffRx (Ptr<const Packet> packet, uint16_t channelFreqMhz,
                             uint16_t channelNumber, uint32_t rate, WifiPreamble preamble,
                             WifiTxVector txVector, struct mpduInfo aMpdu, struct signalNoiseDbm signalNoise);

  typedef void (* MonitorSnifferRxCallback)(Ptr<const Packet> packet, uint16_t channelFreqMhz,
                                            uint16_t channelNumber, uint32_t rate, WifiPreamble preamble,
                                            WifiTxVector txVector, struct mpduInfo aMpdu, struct signalNoiseDbm signalNoise);

  void NotifyMonitorSniffTx (Ptr<const Packet> packet, uint16_t channelFreqMhz,
                             uint16_t channelNumber, uint32_t rate, WifiPreamble preamble,
                             WifiTxVector txVector, struct mpduInfo aMpdu);

  typedef void (* MonitorSnifferTxCallback)(const Ptr<const Packet> packet, uint16_t channelFreqMhz,
                                            uint16_t channelNumber, uint32_t rate, WifiPreamble preamble,
                                            WifiTxVector txVector, struct mpduInfo aMpdu);

  virtual int64_t AssignStreams (int64_t stream);

  void SetEdThreshold (double threshold);
  double GetEdThreshold (void) const;
  double GetEdThresholdW (void) const;
  void SetCcaMode1Threshold (double threshold);
  double GetCcaMode1Threshold (void) const;
  void SetRxNoiseFigure (double noiseFigureDb);
  double GetRxNoiseFigure (void) const;
  void SetTxPowerStart (double start);
  virtual double GetTxPowerStart (void) const;
  void SetTxPowerEnd (double end);
  virtual double GetTxPowerEnd (void) const;
  void SetNTxPower (uint32_t n);
  virtual uint32_t GetNTxPower (void) const;
  void SetTxGain (double gain);
  double GetTxGain (void) const;
  void SetRxGain (double gain);
  double GetRxGain (void) const;
  void SetDevice (Ptr<NetDevice> device);
  Ptr<NetDevice> GetDevice (void) const;
  void SetMobility (Ptr<MobilityModel> mobility);
  Ptr<MobilityModel> GetMobility (void);

  virtual void SetFrequency (uint32_t freq);
  virtual uint32_t GetFrequency (void) const;
  virtual void SetNumberOfTransmitAntennas (uint32_t tx);
  virtual uint32_t GetNumberOfTransmitAntennas (void) const;
  virtual void SetNumberOfReceiveAntennas (uint32_t rx);
  virtual uint32_t GetNumberOfReceiveAntennas (void) const;

  virtual void SetGuardInterval (bool guardInterval);
  virtual bool GetGuardInterval (void) const;
  virtual void SetLdpc (bool ldpc);
  virtual bool GetLdpc (void) const;
  virtual void SetStbc (bool stbc);
  virtual bool GetStbc (void) const;
  virtual void SetGreenfield (bool greenfield);
  virtual bool GetGreenfield (void) const;
  virtual void SetShortPlcpPreambleSupported (bool preamble);
  virtual bool GetShortPlcpPreambleSupported (void) const;

  void SetErrorRateModel (Ptr<ErrorRateModel> rate);
  Ptr<ErrorRateModel> GetErrorRateModel (void) const;

  virtual uint32_t GetChannelWidth (void) const;
  virtual void SetChannelWidth (uint32_t channelwidth);
  virtual void AddSupportedChannelWidth (uint32_t channelwidth);
  virtual std::vector<uint32_t> GetSupportedChannelWidthSet (void) const;
  virtual uint8_t GetSupportedRxSpatialStreams (void) const;
  virtual uint8_t GetSupportedTxSpatialStreams (void) const;
  double DbmToW (double dbm) const;
  double DbToRatio (double db) const;
  double WToDbm (double w) const;
  double RatioToDb (double ratio) const;

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

  virtual bool DoChannelSwitch (uint16_t id);
  virtual bool DoFrequencySwitch (uint32_t frequency);

  double GetPowerDbm (uint8_t power) const;
  
  InterferenceHelper m_interference;   
  Ptr<UniformRandomVariable> m_random; 
  Ptr<WifiPhyStateHelper> m_state;     

  uint16_t m_mpdusNum;                 
  bool m_plcpSuccess;                  
  uint32_t m_txMpduReferenceNumber;    
  uint32_t m_rxMpduReferenceNumber;    
  
  EventId m_endRxEvent;
  EventId m_endPlcpRxEvent;

private:
  void InitializeFrequencyChannelNumber (void);
  void Configure80211a (void);
  void Configure80211b (void);
  void Configure80211g (void);
  void Configure80211_10Mhz (void);
  void Configure80211_5Mhz ();
  void ConfigureHolland (void);
  void Configure80211n (void);
  void Configure80211ac (void);
  void ConfigureHtDeviceMcsSet (void);
  virtual void ConfigureDefaultsForStandard (enum WifiPhyStandard standard);
  virtual void ConfigureChannelForStandard (enum WifiPhyStandard standard);

  uint16_t FindChannelNumberForFrequencyWidth (uint32_t frequency, uint32_t width) const;
  FrequencyWidthPair GetFrequencyWidthForChannelNumberStandard (uint16_t channelNumber, enum WifiPhyStandard standard) const;

  TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;

  TracedCallback<Ptr<const Packet>, uint16_t, uint16_t, uint32_t,
                 WifiPreamble, WifiTxVector, struct mpduInfo, struct signalNoiseDbm> m_phyMonitorSniffRxTrace;

  TracedCallback<Ptr<const Packet>, uint16_t, uint16_t, uint32_t,
                 WifiPreamble, WifiTxVector, struct mpduInfo> m_phyMonitorSniffTxTrace;
    
  WifiModeList m_deviceRateSet;
  WifiModeList m_deviceMcsSet;

  std::vector<uint32_t> m_bssMembershipSelectorSet;

  enum WifiPhyStandard m_standard;     
  bool m_isConstructed;                
  uint32_t m_channelCenterFrequency;   
  uint32_t m_initialFrequency;         
  bool m_frequencyChannelNumberInitialized; 
  uint32_t m_channelWidth;             

  double m_edThresholdW;          
  double   m_ccaMode1ThresholdW;  
  double   m_txGainDb;            
  double   m_rxGainDb;            
  double   m_txPowerBaseDbm;      
  double   m_txPowerEndDbm;       
  uint32_t m_nTxPower;            
  
  bool     m_ldpc;                  
  bool     m_stbc;                  
  bool     m_greenfield;            
  bool     m_guardInterval;         
  bool     m_shortPreamble;         

  uint32_t m_numberOfTransmitters;     
  uint32_t m_numberOfReceivers;        

  typedef std::map<ChannelNumberStandardPair,FrequencyWidthPair> ChannelToFrequencyWidthMap;
  static ChannelToFrequencyWidthMap m_channelToFrequencyWidth;

  std::vector<uint32_t> m_supportedChannelWidthSet; 
  uint16_t             m_channelNumber;  
  uint16_t             m_initialChannelNumber;  

  Time m_channelSwitchDelay;     
  uint32_t m_totalAmpduSize;     
  double m_totalAmpduNumSymbols; 
  
  Ptr<NetDevice>     m_device;   
  Ptr<MobilityModel> m_mobility; 
};

std::ostream& operator<< (std::ostream& os, enum WifiPhy::State state);

} //namespace ns3

#endif /* WIFI_PHY_H */