A Discrete-Event Network Simulator
API
ofdm-phy.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2020 Orange Labs
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Rediet <getachew.redieteab@orange.com>
19  * S├ębastien Deronne <sebastien.deronne@gmail.com> (for logic ported from wifi-phy)
20  * Mathieu Lacage <mathieu.lacage@sophia.inria.fr> (for logic ported from wifi-phy)
21  */
22 
23 #ifndef OFDM_PHY_H
24 #define OFDM_PHY_H
25 
26 #include "ns3/phy-entity.h"
27 
35 namespace ns3 {
36 
44 {
48 };
49 
60 class OfdmPhy : public PhyEntity
61 {
62 public:
70  OfdmPhy (OfdmPhyVariant variant = OFDM_PHY_DEFAULT, bool buildModeList = true);
74  virtual ~OfdmPhy ();
75 
76  // Inherited
77  virtual WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const override;
78  virtual const PpduFormats & GetPpduFormats (void) const override;
79  virtual Time GetDuration (WifiPpduField field, const WifiTxVector& txVector) const override;
80  virtual Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype,
81  bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols,
82  uint16_t staId) const override;
83  virtual Ptr<WifiPpdu> BuildPpdu (const WifiConstPsduMap & psdus, const WifiTxVector& txVector, Time ppduDuration) override;
84 
88  static void InitializeModes (void);
98  static WifiMode GetOfdmRate (uint64_t rate, uint16_t bw = 20);
104  static WifiMode GetOfdmRate6Mbps (void);
110  static WifiMode GetOfdmRate9Mbps (void);
116  static WifiMode GetOfdmRate12Mbps (void);
122  static WifiMode GetOfdmRate18Mbps (void);
128  static WifiMode GetOfdmRate24Mbps (void);
134  static WifiMode GetOfdmRate36Mbps (void);
140  static WifiMode GetOfdmRate48Mbps (void);
146  static WifiMode GetOfdmRate54Mbps (void);
152  static WifiMode GetOfdmRate3MbpsBW10MHz (void);
158  static WifiMode GetOfdmRate4_5MbpsBW10MHz (void);
164  static WifiMode GetOfdmRate6MbpsBW10MHz (void);
170  static WifiMode GetOfdmRate9MbpsBW10MHz (void);
176  static WifiMode GetOfdmRate12MbpsBW10MHz (void);
182  static WifiMode GetOfdmRate18MbpsBW10MHz (void);
188  static WifiMode GetOfdmRate24MbpsBW10MHz (void);
194  static WifiMode GetOfdmRate27MbpsBW10MHz (void);
200  static WifiMode GetOfdmRate1_5MbpsBW5MHz (void);
206  static WifiMode GetOfdmRate2_25MbpsBW5MHz (void);
212  static WifiMode GetOfdmRate3MbpsBW5MHz (void);
218  static WifiMode GetOfdmRate4_5MbpsBW5MHz (void);
224  static WifiMode GetOfdmRate6MbpsBW5MHz (void);
230  static WifiMode GetOfdmRate9MbpsBW5MHz (void);
236  static WifiMode GetOfdmRate12MbpsBW5MHz (void);
242  static WifiMode GetOfdmRate13_5MbpsBW5MHz (void);
243 
252  static WifiCodeRate GetCodeRate (const std::string& name);
261  static uint16_t GetConstellationSize (const std::string& name);
274  static uint64_t GetPhyRate (const std::string& name, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
275 
286  static uint64_t GetPhyRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
297  static uint64_t GetDataRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
310  static uint64_t GetDataRate (const std::string& name, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
320  static bool IsModeAllowed (uint16_t channelWidth, uint8_t nss);
321 
322 protected:
323  // Inherited
324  virtual PhyFieldRxStatus DoEndReceiveField (WifiPpduField field, Ptr<Event> event) override;
325  virtual Ptr<SpectrumValue> GetTxPowerSpectralDensity (double txPowerW, Ptr<const WifiPpdu> ppdu) const override;
326 
331  virtual WifiMode GetHeaderMode (const WifiTxVector& txVector) const;
332 
339  virtual Time GetPreambleDuration (const WifiTxVector& txVector) const;
344  virtual Time GetHeaderDuration (const WifiTxVector& txVector) const;
345 
349  uint8_t GetNumberServiceBits (void) const;
354  Time GetSignalExtension (WifiPhyBand band) const;
355 
364 
371  virtual bool IsChannelWidthSupported (Ptr<const WifiPpdu> ppdu) const;
380  virtual bool IsAllConfigSupported (WifiPpduField field, Ptr<const WifiPpdu> ppdu) const;
381 
389  static uint64_t CalculatePhyRate (WifiCodeRate codeRate, uint64_t dataRate);
396  static double GetCodeRatio (WifiCodeRate codeRate);
408  static uint64_t CalculateDataRate (WifiCodeRate codeRate, uint16_t constellationSize, uint16_t channelWidth,
409  uint16_t guardInterval, uint8_t nss);
421  static uint64_t CalculateDataRate (double symbolDuration, uint16_t guardInterval,
422  uint16_t usableSubCarriers, uint16_t numberOfBitsPerSubcarrier,
423  double codingRate);
424 
431  virtual uint32_t GetMaxPsduSize (void) const override;
432 
433 private:
443  static WifiMode CreateOfdmMode (std::string uniqueName, bool isMandatory);
444 
446 
448 }; //class OfdmPhy
449 
450 } //namespace ns3
451 
452 #endif /* OFDM_PHY_H */
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
static WifiMode GetOfdmRate24MbpsBW10MHz(void)
Return a WifiMode for OFDM at 24 Mbps with 10 MHz channel spacing.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
static double GetCodeRatio(WifiCodeRate codeRate)
Convert WifiCodeRate to a ratio, e.g., code ratio of WIFI_CODE_RATE_1_2 is 0.5.
Definition: ofdm-phy.cc:533
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
PhyFieldRxStatus EndReceiveHeader(Ptr< Event > event)
End receiving the header, perform OFDM-specific actions, and provide the status of the reception...
Definition: ofdm-phy.cc:288
static bool IsModeAllowed(uint16_t channelWidth, uint8_t nss)
Check whether the combination of <WifiMode, channel width, NSS> is allowed.
Definition: ofdm-phy.cc:597
static const PpduFormats m_ofdmPpduFormats
OFDM PPDU formats.
Definition: ofdm-phy.h:445
static WifiMode GetOfdmRate1_5MbpsBW5MHz(void)
Return a WifiMode for OFDM at 1.5 Mbps with 5 MHz channel spacing.
uint8_t GetNumberServiceBits(void) const
Definition: ofdm-phy.cc:257
static WifiMode CreateOfdmMode(std::string uniqueName, bool isMandatory)
Create an OFDM mode from a unique name, the unique name must already be contained inside ModulationLo...
Definition: ofdm-phy.cc:479
static WifiMode GetOfdmRate36Mbps(void)
Return a WifiMode for OFDM at 36 Mbps.
static WifiMode GetOfdmRate18MbpsBW10MHz(void)
Return a WifiMode for OFDM at 18 Mbps with 10 MHz channel spacing.
static WifiMode GetOfdmRate48Mbps(void)
Return a WifiMode for OFDM at 48 Mbps.
static WifiMode GetOfdmRate3MbpsBW10MHz(void)
Return a WifiMode for OFDM at 3 Mbps with 10 MHz channel spacing.
static WifiMode GetOfdmRate(uint64_t rate, uint16_t bw=20)
Return a WifiMode for OFDM corresponding to the provided rate and the channel bandwidth (20...
Definition: ofdm-phy.cc:359
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:47
virtual Time GetHeaderDuration(const WifiTxVector &txVector) const
Definition: ofdm-phy.cc:214
std::map< std::string, CodeRateConstellationSizePair > ModulationLookupTable
A modulation lookup table using unique name of modulation as key.
Definition: phy-entity.h:509
static uint64_t CalculatePhyRate(WifiCodeRate codeRate, uint64_t dataRate)
Calculate the PHY rate in bps from code rate and data rate.
Definition: ofdm-phy.cc:518
static WifiMode GetOfdmRate6MbpsBW5MHz(void)
Return a WifiMode for OFDM at 6 Mbps with 5 MHz channel spacing.
static WifiMode GetOfdmRate9MbpsBW5MHz(void)
Return a WifiMode for OFDM at 9 Mbps with 5 MHz channel spacing.
MpduType
The type of an MPDU.
static WifiMode GetOfdmRate3MbpsBW5MHz(void)
Return a WifiMode for OFDM at 3 Mbps with 5 MHz channel spacing.
virtual bool IsChannelWidthSupported(Ptr< const WifiPpdu > ppdu) const
Checks if the PPDU&#39;s bandwidth is supported by the PHY.
Definition: ofdm-phy.cc:312
static uint64_t GetPhyRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the PHY rate corresponding to the supplied TXVECTOR.
Definition: ofdm-phy.cc:524
virtual WifiMode GetSigMode(WifiPpduField field, const WifiTxVector &txVector) const override
Get the WifiMode for the SIG field specified by the PPDU field.
Definition: ofdm-phy.cc:141
Status of the reception of the PPDU field.
Definition: phy-entity.h:110
static WifiMode GetOfdmRate4_5MbpsBW10MHz(void)
Return a WifiMode for OFDM at 4.5 Mbps with 10 MHz channel spacing.
static WifiCodeRate GetCodeRate(const std::string &name)
Return the WifiCodeRate from the OFDM mode&#39;s unique name using ModulationLookupTable.
Definition: ofdm-phy.cc:498
static void InitializeModes(void)
Initialize all OFDM modes (for all variants).
Definition: ofdm-phy.cc:347
virtual Time GetPayloadDuration(uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, MpduType mpdutype, bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols, uint16_t staId) const override
Definition: ofdm-phy.cc:237
virtual bool IsAllConfigSupported(WifiPpduField field, Ptr< const WifiPpdu > ppdu) const
Checks if the signaled configuration (including bandwidth) is supported by the PHY.
Definition: ofdm-phy.cc:324
virtual PhyFieldRxStatus DoEndReceiveField(WifiPpduField field, Ptr< Event > event) override
End receiving a given field, perform amendment-specific actions, and provide the status of the recept...
Definition: ofdm-phy.cc:277
OfdmPhyVariant
The OFDM (11a) PHY variants.
Definition: ofdm-phy.h:43
WifiPpduField
The type of PPDU field (grouped for convenience)
OfdmPhy(OfdmPhyVariant variant=OFDM_PHY_DEFAULT, bool buildModeList=true)
Constructor for OFDM PHY.
Definition: ofdm-phy.cc:95
Time GetSignalExtension(WifiPhyBand band) const
Definition: ofdm-phy.cc:263
virtual Ptr< SpectrumValue > GetTxPowerSpectralDensity(double txPowerW, Ptr< const WifiPpdu > ppdu) const override
Definition: ofdm-phy.cc:334
static WifiMode GetOfdmRate54Mbps(void)
Return a WifiMode for OFDM at 54 Mbps.
Abstract class for PHY entitiesThis class enables to have a unique set of APIs to be used by each PHY...
Definition: phy-entity.h:93
static uint64_t CalculateDataRate(WifiCodeRate codeRate, uint16_t constellationSize, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Calculates data rate from the supplied parameters.
Definition: ofdm-phy.cc:568
uint16_t WifiCodeRate
These constants define the various convolutional coding rates used for the OFDM transmission modes in...
static WifiMode GetOfdmRate9Mbps(void)
Return a WifiMode for OFDM at 9 Mbps.
virtual uint32_t GetMaxPsduSize(void) const override
Get the maximum PSDU size in bytes (see Table 17-21 OFDM PHY characteristics of IEEE 802...
Definition: ofdm-phy.cc:603
static const ModulationLookupTable m_ofdmModulationLookupTable
lookup table to retrieve code rate and constellation size corresponding to a unique name of modulatio...
Definition: ofdm-phy.h:447
static WifiMode GetOfdmRate9MbpsBW10MHz(void)
Return a WifiMode for OFDM at 9 Mbps with 10 MHz channel spacing.
static WifiMode GetOfdmRate12MbpsBW10MHz(void)
Return a WifiMode for OFDM at 12 Mbps with 10 MHz channel spacing.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual const PpduFormats & GetPpduFormats(void) const override
Return the PPDU formats of the PHY.
Definition: ofdm-phy.cc:173
static WifiMode GetOfdmRate2_25MbpsBW5MHz(void)
Return a WifiMode for OFDM at 2.25 Mbps with 5 MHz channel spacing.
static uint64_t GetPhyRate(const std::string &name, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the PHY rate from the OFDM mode&#39;s unique name and the supplied parameters. ...
Definition: ofdm-phy.cc:510
static uint64_t GetDataRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the data rate corresponding to the supplied TXVECTOR.
Definition: ofdm-phy.cc:551
PHY entity for OFDM (11a)This class is also used for the 10 MHz and 5 MHz bandwidth variants addressi...
Definition: ofdm-phy.h:60
static uint16_t GetConstellationSize(const std::string &name)
Return the constellation size from the OFDM mode&#39;s unique name using ModulationLookupTable.
Definition: ofdm-phy.cc:504
static WifiMode GetOfdmRate6MbpsBW10MHz(void)
Return a WifiMode for OFDM at 6 Mbps with 10 MHz channel spacing.
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:32
virtual Ptr< WifiPpdu > BuildPpdu(const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration) override
Build amendment-specific PPDU.
Definition: ofdm-phy.cc:269
static WifiMode GetOfdmRate4_5MbpsBW5MHz(void)
Return a WifiMode for OFDM at 4.5 Mbps with 5 MHz channel spacing.
static WifiMode GetOfdmRate27MbpsBW10MHz(void)
Return a WifiMode for OFDM at 27 Mbps with 10 MHz channel spacing.
static uint64_t GetDataRate(const std::string &name, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the data rate from the OFDM mode&#39;s unique name and the supplied parameters.
Definition: ofdm-phy.cc:560
static WifiMode GetOfdmRate6Mbps(void)
Return a WifiMode for OFDM at 6 Mbps.
std::map< WifiPreamble, std::vector< WifiPpduField > > PpduFormats
A map of PPDU field elements per preamble type.
Definition: phy-entity.h:499
static WifiMode GetOfdmRate13_5MbpsBW5MHz(void)
Return a WifiMode for OFDM at 13.5 Mbps with 5 MHz channel spacing.
static WifiMode GetOfdmRate24Mbps(void)
Return a WifiMode for OFDM at 24 Mbps.
virtual WifiMode GetHeaderMode(const WifiTxVector &txVector) const
Definition: ofdm-phy.cc:154
virtual Time GetDuration(WifiPpduField field, const WifiTxVector &txVector) const override
Get the duration of the PPDU field (or group of fields) used by this entity for the given transmissio...
Definition: ofdm-phy.cc:179
virtual ~OfdmPhy()
Destructor for OFDM PHY.
Definition: ofdm-phy.cc:135
static WifiMode GetOfdmRate12MbpsBW5MHz(void)
Return a WifiMode for OFDM at 12 Mbps with 5 MHz channel spacing.
static WifiMode GetOfdmRate12Mbps(void)
Return a WifiMode for OFDM at 12Mbps.
std::unordered_map< uint16_t, Ptr< const WifiPsdu > > WifiConstPsduMap
Map of const PSDUs indexed by STA-ID.
virtual Time GetPreambleDuration(const WifiTxVector &txVector) const
Definition: ofdm-phy.cc:193
static WifiMode GetOfdmRate18Mbps(void)
Return a WifiMode for OFDM at 18 Mbps.