A Discrete-Event Network Simulator
API
ht-phy.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Orange Labs
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Authors: Rediet <getachew.redieteab@orange.com>
18 * Sébastien Deronne <sebastien.deronne@gmail.com> (for logic ported from wifi-phy)
19 */
20
21#ifndef HT_PHY_H
22#define HT_PHY_H
23
24#include "ns3/ofdm-phy.h"
25
32namespace ns3
33{
34
38#define HT_PHY 127
39
50class HtPhy : public OfdmPhy
51{
52 public:
60 HtPhy(uint8_t maxNss = 1, bool buildModeList = true);
64 ~HtPhy() override;
65
66 WifiMode GetMcs(uint8_t index) const override;
67 bool IsMcsSupported(uint8_t index) const override;
68 bool HandlesMcsModes() const override;
69 WifiMode GetSigMode(WifiPpduField field, const WifiTxVector& txVector) const override;
70 const PpduFormats& GetPpduFormats() const override;
71 Time GetDuration(WifiPpduField field, const WifiTxVector& txVector) const override;
73 const WifiTxVector& txVector,
74 WifiPhyBand band,
75 MpduType mpdutype,
76 bool incFlag,
77 uint32_t& totalAmpduSize,
78 double& totalAmpduNumSymbols,
79 uint16_t staId) const override;
81 const WifiTxVector& txVector,
82 Time ppduDuration) override;
83
87 static WifiMode GetLSigMode();
91 virtual WifiMode GetHtSigMode() const;
92
96 uint8_t GetBssMembershipSelector() const;
97
104 uint8_t GetMaxSupportedMcsIndexPerSs() const;
113 void SetMaxSupportedMcsIndexPerSs(uint8_t maxIndex);
120 void SetMaxSupportedNss(uint8_t maxNss);
121
128 virtual Time GetLSigDuration(WifiPreamble preamble) const;
137 virtual Time GetTrainingDuration(const WifiTxVector& txVector,
138 uint8_t nDataLtf,
139 uint8_t nExtensionLtf = 0) const;
143 virtual Time GetHtSigDuration() const;
144
148 static void InitializeModes();
156 static WifiMode GetHtMcs(uint8_t index);
157
350
360 static WifiCodeRate GetHtCodeRate(uint8_t mcsValue);
370 static WifiCodeRate GetCodeRate(uint8_t mcsValue);
378 static uint16_t GetHtConstellationSize(uint8_t mcsValue);
388 static uint16_t GetConstellationSize(uint8_t mcsValue);
402 static uint64_t GetPhyRate(uint8_t mcsValue,
403 uint16_t channelWidth,
404 uint16_t guardInterval,
405 uint8_t nss);
416 static uint64_t GetPhyRateFromTxVector(const WifiTxVector& txVector, uint16_t staId);
427 static uint64_t GetDataRateFromTxVector(const WifiTxVector& txVector, uint16_t staId);
440 static uint64_t GetDataRate(uint8_t mcsValue,
441 uint16_t channelWidth,
442 uint16_t guardInterval,
443 uint8_t nss);
452 static uint64_t GetNonHtReferenceRate(uint8_t mcsValue);
460 static bool IsAllowed(const WifiTxVector& txVector);
461
462 protected:
464 bool IsAllConfigSupported(WifiPpduField field, Ptr<const WifiPpdu> ppdu) const override;
465 bool IsConfigSupported(Ptr<const WifiPpdu> ppdu) const override;
468 const WifiTxVector& txVector) const override;
469 uint32_t GetMaxPsduSize() const override;
471
478 virtual void BuildModeList();
479
484 virtual uint8_t GetNumberBccEncoders(const WifiTxVector& txVector) const;
489 virtual Time GetSymbolDuration(const WifiTxVector& txVector) const;
490
499 static uint64_t CalculatePhyRate(WifiCodeRate codeRate, uint64_t dataRate);
513 static uint64_t CalculateNonHtReferenceRate(WifiCodeRate codeRate, uint16_t constellationSize);
520 static double GetCodeRatio(WifiCodeRate codeRate);
532 static uint64_t CalculateDataRate(Time symbolDuration,
533 uint16_t usableSubCarriers,
534 uint16_t numberOfBitsPerSubcarrier,
535 double codingRate,
536 uint8_t nss);
537
542 static Time GetSymbolDuration(uint16_t channelWidth);
543
548 static uint16_t GetUsableSubcarriers(uint16_t channelWidth);
549
554 static Time GetSymbolDuration(Time guardInterval);
555
556 uint8_t
560
561 private:
570
579 static WifiMode CreateHtMcs(uint8_t index);
580
583
585}; // class HtPhy
586
587} // namespace ns3
588
589#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:660
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:825
Ptr< SpectrumValue > GetTxPowerSpectralDensity(double txPowerW, Ptr< const WifiPpdu > ppdu, const WifiTxVector &txVector) const override
Definition: ht-phy.cc:462
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:630
static WifiMode GetHtMcs3()
Return MCS 3 from HT MCS values.
static WifiMode GetHtMcs29()
Return MCS 29 from HT MCS values.
uint8_t m_bssMembershipSelector
the BSS membership selector
Definition: ht-phy.h:559
static WifiMode GetHtMcs13()
Return MCS 13 from HT MCS values.
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:392
~HtPhy() override
Destructor for HT PHY.
Definition: ht-phy.cc:69
static WifiMode GetHtMcs1()
Return MCS 1 from HT MCS values.
static WifiMode GetLSigMode()
Definition: ht-phy.cc:154
static WifiMode GetHtMcs14()
Return MCS 14 from HT MCS values.
static WifiMode GetHtMcs11()
Return MCS 11 from HT MCS values.
static WifiMode GetHtMcs19()
Return MCS 19 from HT MCS values.
static uint16_t GetHtConstellationSize(uint8_t mcsValue)
Return the constellation size corresponding to the supplied HT MCS index.
Definition: ht-phy.cc:624
static WifiMode GetHtMcs4()
Return MCS 4 from HT MCS values.
uint8_t m_maxMcsIndexPerSs
the maximum MCS index per spatial stream as defined by the standard
Definition: ht-phy.h:557
static WifiMode GetHtMcs27()
Return MCS 27 from HT MCS values.
static WifiMode GetHtMcs0()
Return MCS 0 from HT MCS values.
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:434
HtPhy(uint8_t maxNss=1, bool buildModeList=true)
Constructor for HT PHY.
Definition: ht-phy.cc:53
static uint64_t GetDataRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the data rate corresponding to the supplied TXVECTOR.
Definition: ht-phy.cc:687
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:696
static void InitializeModes()
Initialize all HT modes.
Definition: ht-phy.cc:482
static WifiCodeRate GetHtCodeRate(uint8_t mcsValue)
Return the coding rate corresponding to the supplied HT MCS index.
Definition: ht-phy.cc:596
static WifiMode GetHtMcs8()
Return MCS 8 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:741
virtual Time GetTrainingDuration(const WifiTxVector &txVector, uint8_t nDataLtf, uint8_t nExtensionLtf=0) const
Definition: ht-phy.cc:256
static WifiMode GetHtMcs5()
Return MCS 5 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:111
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:210
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:277
uint8_t GetBssMembershipSelector() const
Definition: ht-phy.cc:166
static bool IsAllowed(const WifiTxVector &txVector)
Check whether the combination in TXVECTOR is allowed.
Definition: ht-phy.cc:813
static uint64_t GetPhyRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the PHY rate corresponding to the supplied TXVECTOR.
Definition: ht-phy.cc:666
static WifiMode GetHtMcs20()
Return MCS 20 from HT MCS values.
static WifiMode GetHtMcs17()
Return MCS 17 from HT MCS values.
WifiMode GetMcs(uint8_t index) const override
Get the WifiMode corresponding to the given MCS index.
Definition: ht-phy.cc:95
static WifiMode GetHtMcs9()
Return MCS 9 from HT MCS values.
virtual uint8_t GetNumberBccEncoders(const WifiTxVector &txVector) const
Definition: ht-phy.cc:357
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:733
static WifiMode GetHtMcs24()
Return MCS 24 from HT MCS values.
static WifiMode GetHtMcs22()
Return MCS 22 from HT MCS values.
static WifiMode GetHtMcs12()
Return MCS 12 from HT MCS values.
virtual Time GetLSigDuration(WifiPreamble preamble) const
Definition: ht-phy.cc:250
static WifiMode GetHtMcs2()
Return MCS 2 from HT MCS values.
static WifiMode GetHtMcs15()
Return MCS 15 from HT MCS values.
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:652
void SetMaxSupportedMcsIndexPerSs(uint8_t maxIndex)
Set the maximum supported MCS index per spatial stream.
Definition: ht-phy.cc:172
static WifiMode GetHtMcs(uint8_t index)
Return the HT MCS corresponding to the provided index.
Definition: ht-phy.cc:491
static WifiMode GetHtMcs6()
Return MCS 6 from HT MCS values.
static WifiMode GetHtMcs28()
Return MCS 28 from HT MCS values.
static WifiMode CreateHtMcs(uint8_t index)
Return the HT MCS corresponding to the provided index.
Definition: ht-phy.cc:580
uint32_t GetMaxPsduSize() const override
Get the maximum PSDU size in bytes.
Definition: ht-phy.cc:819
static WifiMode GetHtMcs30()
Return MCS 30 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:602
virtual WifiMode GetHtSigMode() const
Definition: ht-phy.cc:160
static WifiMode GetHtMcs21()
Return MCS 21 from HT MCS values.
static WifiMode GetHtMcs23()
Return MCS 23 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:136
static WifiMode GetHtMcs16()
Return MCS 16 from HT MCS values.
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:708
uint8_t GetMaxSupportedMcsIndexPerSs() const
Set the maximum supported MCS index per spatial stream.
Definition: ht-phy.cc:189
static WifiMode GetHtMcs7()
Return MCS 7 from HT MCS values.
bool IsConfigSupported(Ptr< const WifiPpdu > ppdu) const override
Checks if the signaled configuration (excluding bandwidth) is supported by the PHY.
Definition: ht-phy.cc:444
Ptr< WifiPpdu > BuildPpdu(const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration) override
Build amendment-specific PPDU.
Definition: ht-phy.cc:379
uint8_t m_maxSupportedNss
Maximum supported number of spatial streams (used to build HT MCS indices)
Definition: ht-phy.h:581
virtual void BuildModeList()
Build mode list.
Definition: ht-phy.cc:75
static Time GetSymbolDuration(uint16_t channelWidth)
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:675
static WifiMode GetHtMcs26()
Return MCS 26 from HT MCS values.
bool HandlesMcsModes() const override
Check if the WifiModes handled by this PHY are MCSs.
Definition: ht-phy.cc:124
static WifiMode GetHtMcs25()
Return MCS 25 from HT MCS values.
static WifiMode GetHtMcs18()
Return MCS 18 from HT MCS values.
static const PpduFormats m_htPpduFormats
HT PPDU formats.
Definition: ht-phy.h:584
static WifiMode GetHtMcs31()
Return MCS 31 from HT MCS values.
void SetMaxSupportedNss(uint8_t maxNss)
Configure the maximum number of spatial streams supported by this HT PHY.
Definition: ht-phy.cc:195
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:409
virtual Time GetHtSigDuration() const
Definition: ht-phy.cc:271
static WifiMode GetHtMcs10()
Return MCS 10 from HT MCS values.
uint8_t m_maxSupportedMcsIndexPerSs
the maximum supported MCS index per spatial stream
Definition: ht-phy.h:558
const PpduFormats & GetPpduFormats() const override
Return the PPDU formats of the PHY.
Definition: ht-phy.cc:130
virtual Time GetSymbolDuration(const WifiTxVector &txVector) const
Definition: ht-phy.cc:371
PHY entity for OFDM (11a)
Definition: ofdm-phy.h:61
static uint16_t GetUsableSubcarriers()
Definition: ofdm-phy.cc:616
std::map< WifiPreamble, std::vector< WifiPpduField > > PpduFormats
A map of PPDU field elements per preamble type.
Definition: phy-entity.h:524
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:930
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
represent a single transmission mode
Definition: wifi-mode.h:50
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