3.35/doxygen/wifi-phy_8h_source.html

/* -*- 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 "ns3/error-model.h"

#include "wifi-standards.h"

#include "interference-helper.h"

#include "wifi-phy-state-helper.h"

#include "phy-entity.h"

#include "wifi-phy-operating-channel.h"


namespace ns3 {


class Channel;

class NetDevice;

class MobilityModel;

class WifiPhyStateHelper;

class FrameCaptureModel;

class PreambleDetectionModel;

class WifiRadioEnergyModel;

class UniformRandomVariable;


class WifiPhy : public Object

{

public:

  friend class PhyEntity;

  static TypeId GetTypeId (void);


  WifiPhy ();

  virtual ~WifiPhy ();


  static const std::set<FrequencyChannelInfo> m_frequencyChannels;


  Ptr<WifiPhyStateHelper> GetState (void) const;


  void SetReceiveOkCallback (RxOkCallback callback);

  void SetReceiveErrorCallback (RxErrorCallback callback);


  void RegisterListener (WifiPhyListener *listener);

  void UnregisterListener (WifiPhyListener *listener);


  void SetCapabilitiesChangedCallback (Callback<void> callback);


  void StartReceivePreamble (Ptr<WifiPpdu> ppdu, RxPowerWattPerChannelBand& rxPowersW, Time rxDuration);


  void ResetReceive (Ptr<Event> event);


  void EndReceiveInterBss (void);


  static WifiConstPsduMap GetWifiConstPsduMap (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector);


  void Send (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector);

  void Send (WifiConstPsduMap psdus, WifiTxVector txVector);


  virtual void StartTx (Ptr<WifiPpdu> ppdu) = 0;


  void SetSleepMode (void);

  void ResumeFromSleep (void);

  void SetOffMode (void);

  void ResumeFromOff (void);


  bool IsStateIdle (void) const;

  bool IsStateCcaBusy (void) const;

  bool IsStateRx (void) const;

  bool IsStateTx (void) const;

  bool IsStateSwitching (void) const;

  bool IsStateSleep (void) const;

  bool IsStateOff (void) const;


  Time GetDelayUntilIdle (void);


  Time GetLastRxStartTime (void) const;

  Time GetLastRxEndTime (void) const;


  static Time CalculateTxDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band,

                                   uint16_t staId = SU_STA_ID);

  static Time CalculateTxDuration (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector, WifiPhyBand band);

  static Time CalculateTxDuration (WifiConstPsduMap psduMap, const WifiTxVector& txVector, WifiPhyBand band);


  static Time CalculatePhyPreambleAndHeaderDuration (const WifiTxVector& txVector);

  static Time GetPreambleDetectionDuration (void);

  static Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype = NORMAL_MPDU,

                                  uint16_t staId = SU_STA_ID);

  static Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype,

                                  bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols,

                                  uint16_t staId);

  static Time GetStartOfPacketDuration (const WifiTxVector& txVector);


  std::list<WifiMode> GetModeList (void) const;

  std::list<WifiMode> GetModeList (WifiModulationClass modulation) const;

  bool IsModeSupported (WifiMode mode) const;

  WifiMode GetDefaultMode (void) const;

  bool IsMcsSupported (WifiModulationClass modulation, uint8_t mcs) const;


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


  void SetSifs (Time sifs);

  Time GetSifs (void) const;

  void SetSlot (Time slot);

  Time GetSlot (void) const;

  void SetPifs (Time pifs);

  Time GetPifs (void) const;

  Time GetAckTxTime (void) const;

  Time GetBlockAckTxTime (void) const;


  static uint32_t GetMaxPsduSize (WifiModulationClass modulation);


  std::list<uint8_t> GetBssMembershipSelectorList (void) const;

  uint16_t GetNMcs (void) const;

  std::list<WifiMode> GetMcsList (void) const;

  std::list<WifiMode> GetMcsList (WifiModulationClass modulation) const;

  WifiMode GetMcs (WifiModulationClass modulation, uint8_t mcs) const;


  virtual void SetChannelNumber (uint8_t id);

  uint8_t GetChannelNumber (void) const;

  Time GetChannelSwitchDelay (void) const;


  virtual void ConfigureStandardAndBand (WifiPhyStandard standard, WifiPhyBand band);


  WifiPhyStandard GetPhyStandard (void) const;


  WifiPhyBand GetPhyBand (void) const;


  const WifiPhyOperatingChannel& GetOperatingChannel (void) const;


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


  void NotifyTxBegin (WifiConstPsduMap psdus, double txPowerW);

  void NotifyTxEnd (WifiConstPsduMap psdus);

  void NotifyTxDrop (Ptr<const WifiPsdu> psdu);

  void NotifyRxBegin (Ptr<const WifiPsdu> psdu, const RxPowerWattPerChannelBand& rxPowersW);

  void NotifyRxEnd (Ptr<const WifiPsdu> psdu);

  void NotifyRxDrop (Ptr<const WifiPsdu> psdu, WifiPhyRxfailureReason reason);


  void NotifyMonitorSniffRx (Ptr<const WifiPsdu> psdu,

                             uint16_t channelFreqMhz,

                             WifiTxVector txVector,

                             SignalNoiseDbm signalNoise,

                             std::vector<bool> statusPerMpdu,

                             uint16_t staId = SU_STA_ID);


  typedef void (* MonitorSnifferRxCallback)(Ptr<const Packet> packet,

                                            uint16_t channelFreqMhz,

                                            WifiTxVector txVector,

                                            MpduInfo aMpdu,

                                            SignalNoiseDbm signalNoise,

                                            uint16_t staId);


  void NotifyMonitorSniffTx (Ptr<const WifiPsdu> psdu,

                             uint16_t channelFreqMhz,

                             WifiTxVector txVector,

                             uint16_t staId = SU_STA_ID);


  typedef void (* MonitorSnifferTxCallback)(const Ptr<const Packet> packet,

                                            uint16_t channelFreqMhz,

                                            WifiTxVector txVector,

                                            MpduInfo aMpdu,

                                            uint16_t staId);


  typedef void (* PhyTxBeginTracedCallback)(Ptr<const Packet> packet, double txPowerW);


  typedef void (* PsduTxBeginCallback)(WifiConstPsduMap psduMap, WifiTxVector txVector, double txPowerW);


  typedef void (* PhyRxBeginTracedCallback) (Ptr<const Packet> packet, RxPowerWattPerChannelBand rxPowersW);


  typedef void (* PhyRxPayloadBeginTracedCallback)(WifiTxVector txVector, Time psduDuration);


  virtual int64_t AssignStreams (int64_t stream);


  void SetRxSensitivity (double threshold);

  double GetRxSensitivity (void) const;

  void SetCcaEdThreshold (double threshold);

  double GetCcaEdThreshold (void) const;

  void SetRxNoiseFigure (double noiseFigureDb);

  void SetTxPowerStart (double start);

  double GetTxPowerStart (void) const;

  void SetTxPowerEnd (double end);

  double GetTxPowerEnd (void) const;

  void SetNTxPower (uint8_t n);

  uint8_t GetNTxPower (void) const;

  void SetTxGain (double gain);

  double GetTxGain (void) const;

  void SetRxGain (double gain);

  double GetRxGain (void) const;


  void SetDevice (const Ptr<NetDevice> device);

  Ptr<NetDevice> GetDevice (void) const;

  void SetMobility (const Ptr<MobilityModel> mobility);

  Ptr<MobilityModel> GetMobility (void) const;


  void SetOperatingChannel (uint8_t number, uint16_t frequency, uint16_t width);

  virtual void SetFrequency (uint16_t freq);

  uint16_t GetFrequency (void) const;

  void SetPrimary20Index (uint8_t index);

  void SetNumberOfAntennas (uint8_t antennas);

  uint8_t GetNumberOfAntennas (void) const;

  void SetMaxSupportedTxSpatialStreams (uint8_t streams);

  uint8_t GetMaxSupportedTxSpatialStreams (void) const;

  void SetMaxSupportedRxSpatialStreams (uint8_t streams);

  uint8_t GetMaxSupportedRxSpatialStreams (void) const;

  void SetShortPhyPreambleSupported (bool preamble);

  bool GetShortPhyPreambleSupported (void) const;


  void SetErrorRateModel (const Ptr<ErrorRateModel> rate);

  void SetPostReceptionErrorModel (const Ptr<ErrorModel> em);

  void SetFrameCaptureModel (const Ptr<FrameCaptureModel> frameCaptureModel);

  void SetPreambleDetectionModel (const Ptr<PreambleDetectionModel> preambleDetectionModel);

  void SetWifiRadioEnergyModel (const Ptr<WifiRadioEnergyModel> wifiRadioEnergyModel);


  uint16_t GetChannelWidth (void) const;

  virtual void SetChannelWidth (uint16_t channelWidth);

  void AddSupportedChannelWidth (uint16_t width);

  std::vector<uint16_t> GetSupportedChannelWidthSet (void) const;


  double GetPowerDbm (uint8_t power) const;


  void ResetCca (bool powerRestricted, double txPowerMaxSiso = 0, double txPowerMaxMimo = 0);

  double GetTxPowerForTransmission (Ptr<const WifiPpdu> ppdu) const;

  void NotifyChannelAccessRequested (void);


  virtual WifiSpectrumBand ConvertHeRuSubcarriers (uint16_t bandWidth, uint16_t guardBandwidth,

                                                   HeRu::SubcarrierRange range, uint8_t bandIndex = 0) const;


  static void AddStaticPhyEntity (WifiModulationClass modulation, Ptr<PhyEntity> phyEntity);


  static const Ptr<const PhyEntity> GetStaticPhyEntity (WifiModulationClass modulation);


  Ptr<PhyEntity> GetPhyEntity (WifiModulationClass modulation) const;


  uint64_t GetPreviouslyRxPpduUid (void) const;


  virtual uint16_t GetGuardBandwidth (uint16_t currentChannelWidth) const = 0;

  virtual std::tuple<double, double, double> GetTxMaskRejectionParams (void) const = 0;


protected:

  virtual void DoDispose (void);


  void Reset (void);


  Time DoChannelSwitch (void);


  void SwitchMaybeToCcaBusy (uint16_t channelWidth);


  uint16_t GetMeasurementChannelWidth (const Ptr<const WifiPpdu> ppdu) const;


  virtual WifiSpectrumBand GetBand (uint16_t bandWidth, uint8_t bandIndex = 0);


  WifiSpectrumBand GetPrimaryBand (uint16_t bandWidth);


  void AddPhyEntity (WifiModulationClass modulation, Ptr<PhyEntity> phyEntity);


  InterferenceHelper m_interference;

  Ptr<UniformRandomVariable> m_random;

  Ptr<WifiPhyStateHelper> m_state;


  uint32_t m_txMpduReferenceNumber;

  uint32_t m_rxMpduReferenceNumber;


  EventId m_endPhyRxEvent;

  EventId m_endTxEvent;


  Ptr<Event> m_currentEvent;

  std::map <std::pair<uint64_t /* UID*/, WifiPreamble>, Ptr<Event> > m_currentPreambleEvents;


  uint64_t m_previouslyRxPpduUid;


  std::map<WifiModulationClass, Ptr<PhyEntity> > m_phyEntities;


private:

  void Configure80211a (void);

  void Configure80211b (void);

  void Configure80211g (void);

  void Configure80211p (void);

  void Configure80211n (void);

  void Configure80211ac (void);

  void Configure80211ax (void);

  void ConfigureHtDeviceMcsSet (void);

  void PushMcs (WifiMode mode);

  void RebuildMcsMap (void);


  void AbortCurrentReception (WifiPhyRxfailureReason reason);


  Ptr<const WifiPsdu> GetAddressedPsduInPpdu (Ptr<const WifiPpdu> ppdu) const;


  TracedCallback<Ptr<const Packet>, double > m_phyTxBeginTrace;

  TracedCallback<WifiConstPsduMap, WifiTxVector, double /* TX power (W) */> m_phyTxPsduBeginTrace;


  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;


  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;


  TracedCallback<Ptr<const Packet>, RxPowerWattPerChannelBand > m_phyRxBeginTrace;


  TracedCallback<WifiTxVector, Time> m_phyRxPayloadBeginTrace;


  TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;


  TracedCallback<Ptr<const Packet>, WifiPhyRxfailureReason > m_phyRxDropTrace;


  TracedCallback<Ptr<const Packet>, uint16_t /* frequency (MHz) */, WifiTxVector, MpduInfo, SignalNoiseDbm, uint16_t /* STA-ID*/> m_phyMonitorSniffRxTrace;


  TracedCallback<Ptr<const Packet>, uint16_t /* frequency (MHz) */, WifiTxVector, MpduInfo, uint16_t /* STA-ID*/> m_phyMonitorSniffTxTrace;


  static std::map<WifiModulationClass, Ptr<PhyEntity> > m_staticPhyEntities;


  WifiPhyStandard m_standard;

  WifiPhyBand m_band;

  uint16_t m_initialFrequency;

  uint8_t m_initialChannelNumber;

  uint16_t m_initialChannelWidth;

  uint8_t m_initialPrimary20Index;


  WifiPhyOperatingChannel m_operatingChannel;

  std::vector<uint16_t> m_supportedChannelWidthSet;


  Time m_sifs;

  Time m_slot;

  Time m_pifs;

  Time m_ackTxTime;

  Time m_blockAckTxTime;


  double   m_rxSensitivityW;

  double   m_ccaEdThresholdW;

  double   m_txGainDb;

  double   m_rxGainDb;

  double   m_txPowerBaseDbm;

  double   m_txPowerEndDbm;

  uint8_t  m_nTxPower;

  double m_powerDensityLimit;


  bool m_powerRestricted;

  double m_txPowerMaxSiso;

  double m_txPowerMaxMimo;

  bool m_channelAccessRequested;


  bool m_shortPreamble;

  uint8_t m_numberOfAntennas;

  uint8_t m_txSpatialStreams;

  uint8_t m_rxSpatialStreams;


  Time m_channelSwitchDelay;


  Ptr<NetDevice>     m_device;

  Ptr<MobilityModel> m_mobility;


  Ptr<FrameCaptureModel> m_frameCaptureModel;

  Ptr<PreambleDetectionModel> m_preambleDetectionModel;

  Ptr<WifiRadioEnergyModel> m_wifiRadioEnergyModel;

  Ptr<ErrorModel> m_postReceptionErrorModel;

  Time m_timeLastPreambleDetected;


  Callback<void> m_capabilitiesChangedCallback;

};


std::ostream& operator<< (std::ostream& os, RxSignalInfo rxSignalInfo);


} //namespace ns3


#endif /* WIFI_PHY_H */