A Discrete-Event Network Simulator
API
ht-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 */
21
22#ifndef HT_PHY_H
23#define HT_PHY_H
24
25#include "ns3/ofdm-phy.h"
26
33namespace ns3 {
34
38#define HT_PHY 127
39
50class HtPhy : public OfdmPhy
51{
52public:
60 HtPhy (uint8_t maxNss = 1, bool buildModeList = true);
64 virtual ~HtPhy ();
65
66 WifiMode GetMcs (uint8_t index) const override;
67 bool IsMcsSupported (uint8_t index) const override;
68 bool HandlesMcsModes (void) const override;
69 WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const override;
70 const PpduFormats & GetPpduFormats (void) const override;
71 Time GetDuration (WifiPpduField field, const WifiTxVector& txVector) const override;
72 Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype,
73 bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols,
74 uint16_t staId) const override;
75 Ptr<WifiPpdu> BuildPpdu (const WifiConstPsduMap & psdus, const WifiTxVector& txVector, Time ppduDuration) override;
76
80 static WifiMode GetLSigMode (void);
84 virtual WifiMode GetHtSigMode (void) const;
85
89 uint8_t GetBssMembershipSelector (void) const;
90
97 uint8_t GetMaxSupportedMcsIndexPerSs (void) const;
106 void SetMaxSupportedMcsIndexPerSs (uint8_t maxIndex);
113 void SetMaxSupportedNss (uint8_t maxNss);
114
121 virtual Time GetLSigDuration (WifiPreamble preamble) const;
130 virtual Time GetTrainingDuration (const WifiTxVector& txVector,
131 uint8_t nDataLtf, uint8_t nExtensionLtf = 0) const;
135 virtual Time GetHtSigDuration (void) const;
136
140 static void InitializeModes (void);
148 static WifiMode GetHtMcs (uint8_t index);
149
155 static WifiMode GetHtMcs0 (void);
161 static WifiMode GetHtMcs1 (void);
167 static WifiMode GetHtMcs2 (void);
173 static WifiMode GetHtMcs3 (void);
179 static WifiMode GetHtMcs4 (void);
185 static WifiMode GetHtMcs5 (void);
191 static WifiMode GetHtMcs6 (void);
197 static WifiMode GetHtMcs7 (void);
203 static WifiMode GetHtMcs8 (void);
209 static WifiMode GetHtMcs9 (void);
215 static WifiMode GetHtMcs10 (void);
221 static WifiMode GetHtMcs11 (void);
227 static WifiMode GetHtMcs12 (void);
233 static WifiMode GetHtMcs13 (void);
239 static WifiMode GetHtMcs14 (void);
245 static WifiMode GetHtMcs15 (void);
251 static WifiMode GetHtMcs16 (void);
257 static WifiMode GetHtMcs17 (void);
263 static WifiMode GetHtMcs18 (void);
269 static WifiMode GetHtMcs19 (void);
275 static WifiMode GetHtMcs20 (void);
281 static WifiMode GetHtMcs21 (void);
287 static WifiMode GetHtMcs22 (void);
293 static WifiMode GetHtMcs23 (void);
299 static WifiMode GetHtMcs24 (void);
305 static WifiMode GetHtMcs25 (void);
311 static WifiMode GetHtMcs26 (void);
317 static WifiMode GetHtMcs27 (void);
323 static WifiMode GetHtMcs28 (void);
329 static WifiMode GetHtMcs29 (void);
335 static WifiMode GetHtMcs30 (void);
341 static WifiMode GetHtMcs31 (void);
342
352 static WifiCodeRate GetHtCodeRate (uint8_t mcsValue);
362 static WifiCodeRate GetCodeRate (uint8_t mcsValue);
370 static uint16_t GetHtConstellationSize (uint8_t mcsValue);
380 static uint16_t GetConstellationSize (uint8_t mcsValue);
394 static uint64_t GetPhyRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
405 static uint64_t GetPhyRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
416 static uint64_t GetDataRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
429 static uint64_t GetDataRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
438 static uint64_t GetNonHtReferenceRate (uint8_t mcsValue);
446 static bool IsAllowed (const WifiTxVector& txVector);
447
448protected:
450 bool IsAllConfigSupported (WifiPpduField field, Ptr<const WifiPpdu> ppdu) const override;
451 bool IsConfigSupported (Ptr<const WifiPpdu> ppdu) const override;
452 Ptr<SpectrumValue> GetTxPowerSpectralDensity (double txPowerW, Ptr<const WifiPpdu> ppdu, const WifiTxVector& txVector) const override;
453 uint32_t GetMaxPsduSize (void) const override;
455
462 virtual void BuildModeList (void);
463
468 virtual uint8_t GetNumberBccEncoders (const WifiTxVector& txVector) const;
473 virtual Time GetSymbolDuration (const WifiTxVector& txVector) const;
474
483 static uint64_t CalculatePhyRate (WifiCodeRate codeRate, uint64_t dataRate);
497 static uint64_t CalculateNonHtReferenceRate (WifiCodeRate codeRate, uint16_t constellationSize);
504 static double GetCodeRatio (WifiCodeRate codeRate);
516 static uint64_t CalculateDataRate (Time symbolDuration, uint16_t usableSubCarriers,
517 uint16_t numberOfBitsPerSubcarrier,
518 double codingRate, uint8_t nss);
519
524 static Time GetSymbolDuration (uint16_t channelWidth);
525
530 static uint16_t GetUsableSubcarriers (uint16_t channelWidth);
531
536 static Time GetSymbolDuration (Time guardInterval);
537
541
542private:
551
560 static WifiMode CreateHtMcs (uint8_t index);
561
563
565}; //class HtPhy
566
567} //namespace ns3
568
569#endif /* HT_PHY_H */
PHY entity for HT (11n)
Definition: ht-phy.h:51
static uint64_t CalculatePhyRate(WifiCodeRate codeRate, uint64_t dataRate)
Return the PHY rate corresponding to the supplied code rate and data rate.
Definition: ht-phy.cc:628
CcaIndication GetCcaIndication(const Ptr< const WifiPpdu > ppdu) override
Get CCA end time and its corresponding channel list type when a new signal has been received by the P...
Definition: ht-phy.cc:786
Ptr< SpectrumValue > GetTxPowerSpectralDensity(double txPowerW, Ptr< const WifiPpdu > ppdu, const WifiTxVector &txVector) const override
Definition: ht-phy.cc:437
static uint16_t GetConstellationSize(uint8_t mcsValue)
Return the constellation size corresponding to the supplied HT MCS index between 0 and 7,...
Definition: ht-phy.cc:598
uint8_t m_bssMembershipSelector
the BSS membership selector
Definition: ht-phy.h:540
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: ht-phy.cc:368
uint8_t GetMaxSupportedMcsIndexPerSs(void) const
Set the maximum supported MCS index per spatial stream.
Definition: ht-phy.cc:179
static WifiMode GetHtMcs13(void)
Return MCS 13 from HT MCS values.
uint32_t GetMaxPsduSize(void) const override
Get the maximum PSDU size in bytes.
Definition: ht-phy.cc:780
static WifiMode GetHtMcs25(void)
Return MCS 25 from HT MCS values.
uint8_t GetBssMembershipSelector(void) const
Definition: ht-phy.cc:159
static uint16_t GetHtConstellationSize(uint8_t mcsValue)
Return the constellation size corresponding to the supplied HT MCS index.
Definition: ht-phy.cc:592
static WifiMode GetHtMcs27(void)
Return MCS 27 from HT MCS values.
static WifiMode GetHtMcs29(void)
Return MCS 29 from HT MCS values.
uint8_t m_maxMcsIndexPerSs
the maximum MCS index per spatial stream as defined by the standard
Definition: ht-phy.h:538
bool IsAllConfigSupported(WifiPpduField field, Ptr< const WifiPpdu > ppdu) const override
Checks if the signaled configuration (including bandwidth) is supported by the PHY.
Definition: ht-phy.cc:410
HtPhy(uint8_t maxNss=1, bool buildModeList=true)
Constructor for HT PHY.
Definition: ht-phy.cc:49
static uint64_t GetDataRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the data rate corresponding to the supplied TXVECTOR.
Definition: ht-phy.cc:655
static uint64_t GetDataRate(uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the data rate corresponding to the supplied HT MCS index, channel width, guard interval,...
Definition: ht-phy.cc:664
static WifiCodeRate GetHtCodeRate(uint8_t mcsValue)
Return the coding rate corresponding to the supplied HT MCS index.
Definition: ht-phy.cc:564
static WifiMode GetHtMcs19(void)
Return MCS 19 from HT MCS values.
static WifiMode GetHtMcs1(void)
Return MCS 1 from HT MCS values.
static WifiMode GetHtMcs16(void)
Return MCS 16 from HT MCS values.
static uint64_t CalculateNonHtReferenceRate(WifiCodeRate codeRate, uint16_t constellationSize)
Return the rate (in bps) of the non-HT Reference Rate which corresponds to the supplied code rate and...
Definition: ht-phy.cc:706
virtual Time GetTrainingDuration(const WifiTxVector &txVector, uint8_t nDataLtf, uint8_t nExtensionLtf=0) const
Definition: ht-phy.cc:246
static WifiMode GetHtMcs22(void)
Return MCS 22 from HT MCS values.
virtual ~HtPhy()
Destructor for HT PHY.
Definition: ht-phy.cc:64
static WifiMode GetHtMcs20(void)
Return MCS 20 from HT MCS values.
bool IsMcsSupported(uint8_t index) const override
Check if the WifiMode corresponding to the given MCS index is supported.
Definition: ht-phy.cc:106
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: ht-phy.cc:200
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: ht-phy.cc:262
static WifiMode GetHtMcs11(void)
Return MCS 11 from HT MCS values.
static WifiMode GetHtMcs15(void)
Return MCS 15 from HT MCS values.
static bool IsAllowed(const WifiTxVector &txVector)
Check whether the combination in TXVECTOR is allowed.
Definition: ht-phy.cc:774
static uint64_t GetPhyRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the PHY rate corresponding to the supplied TXVECTOR.
Definition: ht-phy.cc:634
static WifiMode GetHtMcs31(void)
Return MCS 31 from HT MCS values.
WifiMode GetMcs(uint8_t index) const override
Get the WifiMode corresponding to the given MCS index.
Definition: ht-phy.cc:90
static WifiMode GetHtMcs9(void)
Return MCS 9 from HT MCS values.
virtual uint8_t GetNumberBccEncoders(const WifiTxVector &txVector) const
Definition: ht-phy.cc:336
static uint64_t GetNonHtReferenceRate(uint8_t mcsValue)
Calculate the rate in bps of the non-HT Reference Rate corresponding to the supplied HT MCS index.
Definition: ht-phy.cc:698
static WifiMode GetHtMcs3(void)
Return MCS 3 from HT MCS values.
static WifiMode GetHtMcs24(void)
Return MCS 24 from HT MCS values.
static WifiMode GetHtMcs30(void)
Return MCS 30 from HT MCS values.
static WifiMode GetHtMcs23(void)
Return MCS 23 from HT MCS values.
virtual Time GetLSigDuration(WifiPreamble preamble) const
Definition: ht-phy.cc:240
static uint64_t GetPhyRate(uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the PHY rate corresponding to the supplied HT MCS index, channel width, guard interval,...
Definition: ht-phy.cc:620
void SetMaxSupportedMcsIndexPerSs(uint8_t maxIndex)
Set the maximum supported MCS index per spatial stream.
Definition: ht-phy.cc:165
static WifiMode GetHtMcs(uint8_t index)
Return the HT MCS corresponding to the provided index.
Definition: ht-phy.cc:458
virtual WifiMode GetHtSigMode(void) const
Definition: ht-phy.cc:153
static WifiMode GetLSigMode(void)
Definition: ht-phy.cc:147
static WifiMode CreateHtMcs(uint8_t index)
Return the HT MCS corresponding to the provided index.
Definition: ht-phy.cc:548
static void InitializeModes(void)
Initialize all HT modes.
Definition: ht-phy.cc:449
static WifiMode GetHtMcs21(void)
Return MCS 21 from HT MCS values.
static WifiMode GetHtMcs2(void)
Return MCS 2 from HT MCS values.
static WifiCodeRate GetCodeRate(uint8_t mcsValue)
Return the coding rate corresponding to the supplied HT MCS index between 0 and 7,...
Definition: ht-phy.cc:570
static WifiMode GetHtMcs4(void)
Return MCS 4 from HT MCS values.
WifiMode GetSigMode(WifiPpduField field, const WifiTxVector &txVector) const override
Get the WifiMode for the SIG field specified by the PPDU field.
Definition: ht-phy.cc:131
virtual void BuildModeList(void)
Build mode list.
Definition: ht-phy.cc:70
static uint64_t CalculateDataRate(Time symbolDuration, uint16_t usableSubCarriers, uint16_t numberOfBitsPerSubcarrier, double codingRate, uint8_t nss)
Calculates data rate from the supplied parameters.
Definition: ht-phy.cc:675
static WifiMode GetHtMcs10(void)
Return MCS 10 from HT MCS values.
bool HandlesMcsModes(void) const override
Check if the WifiModes handled by this PHY are MCSs.
Definition: ht-phy.cc:119
bool IsConfigSupported(Ptr< const WifiPpdu > ppdu) const override
Checks if the signaled configuration (excluding bandwidth) is supported by the PHY.
Definition: ht-phy.cc:420
static WifiMode GetHtMcs5(void)
Return MCS 5 from HT MCS values.
Ptr< WifiPpdu > BuildPpdu(const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration) override
Build amendment-specific PPDU.
Definition: ht-phy.cc:358
uint8_t m_maxSupportedNss
Maximum supported number of spatial streams (used to build HT MCS indices)
Definition: ht-phy.h:562
static WifiMode GetHtMcs7(void)
Return MCS 7 from HT MCS values.
static WifiMode GetHtMcs17(void)
Return MCS 17 from HT MCS values.
static Time GetSymbolDuration(uint16_t channelWidth)
static WifiMode GetHtMcs26(void)
Return MCS 26 from HT MCS values.
static double GetCodeRatio(WifiCodeRate codeRate)
Convert WifiCodeRate to a ratio, e.g., code ratio of WIFI_CODE_RATE_1_2 is 0.5.
Definition: ht-phy.cc:643
static WifiMode GetHtMcs12(void)
Return MCS 12 from HT MCS values.
static WifiMode GetHtMcs28(void)
Return MCS 28 from HT MCS values.
static const PpduFormats m_htPpduFormats
HT PPDU formats.
Definition: ht-phy.h:564
static WifiMode GetHtMcs8(void)
Return MCS 8 from HT MCS values.
virtual Time GetHtSigDuration(void) const
Definition: ht-phy.cc:256
void SetMaxSupportedNss(uint8_t maxNss)
Configure the maximum number of spatial streams supported by this HT PHY.
Definition: ht-phy.cc:185
PhyFieldRxStatus EndReceiveHtSig(Ptr< Event > event)
End receiving the HT-SIG, perform HT-specific actions, and provide the status of the reception.
Definition: ht-phy.cc:385
const PpduFormats & GetPpduFormats(void) const override
Return the PPDU formats of the PHY.
Definition: ht-phy.cc:125
static WifiMode GetHtMcs18(void)
Return MCS 18 from HT MCS values.
static WifiMode GetHtMcs14(void)
Return MCS 14 from HT MCS values.
uint8_t m_maxSupportedMcsIndexPerSs
the maximum supported MCS index per spatial stream
Definition: ht-phy.h:539
static WifiMode GetHtMcs0(void)
Return MCS 0 from HT MCS values.
static WifiMode GetHtMcs6(void)
Return MCS 6 from HT MCS values.
virtual Time GetSymbolDuration(const WifiTxVector &txVector) const
Definition: ht-phy.cc:350
PHY entity for OFDM (11a)
Definition: ofdm-phy.h:61
static uint16_t GetUsableSubcarriers(void)
Definition: ofdm-phy.cc:585
std::map< WifiPreamble, std::vector< WifiPpduField > > PpduFormats
A map of PPDU field elements per preamble type.
Definition: phy-entity.h:489
std::optional< std::pair< Time, WifiChannelListType > > CcaIndication
CCA end time and its corresponding channel list type (can be std::nullopt if IDLE)
Definition: phy-entity.h:873
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
represent a single transmission mode
Definition: wifi-mode.h:48
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:33
WifiPpduField
The type of PPDU field (grouped for convenience)
MpduType
The type of an MPDU.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::unordered_map< uint16_t, Ptr< const WifiPsdu > > WifiConstPsduMap
Map of const PSDUs indexed by STA-ID.
uint16_t WifiCodeRate
These constants define the various convolutional coding rates used for the OFDM transmission modes in...
Status of the reception of the PPDU field.
Definition: phy-entity.h:113