A Discrete-Event Network Simulator
API
vht-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 VHT_PHY_H
23#define VHT_PHY_H
24
25#include "ns3/ht-phy.h"
26
33namespace ns3 {
34
38#define VHT_PHY 126
39
48class VhtPhy : public HtPhy
49{
50public:
57 VhtPhy (bool buildModeList = true);
61 virtual ~VhtPhy ();
62
63 WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const override;
64 const PpduFormats & GetPpduFormats (void) const override;
65 Time GetDuration (WifiPpduField field, const WifiTxVector& txVector) const override;
66 Time GetLSigDuration (WifiPreamble preamble) const override;
67 Time GetTrainingDuration (const WifiTxVector& txVector,
68 uint8_t nDataLtf,
69 uint8_t nExtensionLtf = 0) const override;
71 const WifiTxVector& txVector,
72 Time ppduDuration) override;
73 double GetCcaThreshold (const Ptr<const WifiPpdu> ppdu, WifiChannelListType channelType) const override;
74
78 virtual WifiMode GetSigAMode (void) const;
83 virtual WifiMode GetSigBMode (const WifiTxVector& txVector) const;
84
89 virtual Time GetSigADuration (WifiPreamble preamble) const;
94 virtual Time GetSigBDuration (const WifiTxVector& txVector) const;
95
99 static void InitializeModes (void);
107 static WifiMode GetVhtMcs (uint8_t index);
108
114 static WifiMode GetVhtMcs0 (void);
120 static WifiMode GetVhtMcs1 (void);
126 static WifiMode GetVhtMcs2 (void);
132 static WifiMode GetVhtMcs3 (void);
138 static WifiMode GetVhtMcs4 (void);
144 static WifiMode GetVhtMcs5 (void);
150 static WifiMode GetVhtMcs6 (void);
156 static WifiMode GetVhtMcs7 (void);
162 static WifiMode GetVhtMcs8 (void);
168 static WifiMode GetVhtMcs9 (void);
169
179 static WifiCodeRate GetCodeRate (uint8_t mcsValue);
189 static uint16_t GetConstellationSize (uint8_t mcsValue);
203 static uint64_t GetPhyRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
214 static uint64_t GetPhyRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
225 static uint64_t GetDataRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
238 static uint64_t GetDataRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
247 static uint64_t GetNonHtReferenceRate (uint8_t mcsValue);
257 static bool IsCombinationAllowed (uint8_t mcsValue, uint16_t channelWidth, uint8_t nss);
265 static bool IsAllowed (const WifiTxVector& txVector);
266
267protected:
268 WifiMode GetHtSigMode (void) const override;
269 Time GetHtSigDuration (void) const override;
270 uint8_t GetNumberBccEncoders (const WifiTxVector& txVector) const override;
272 bool IsAllConfigSupported (WifiPpduField field, Ptr<const WifiPpdu> ppdu) const override;
273 uint32_t GetMaxPsduSize (void) const override;
275
288
296
307
321 static uint64_t CalculateNonHtReferenceRate (WifiCodeRate codeRate, uint16_t constellationSize);
326 static uint16_t GetUsableSubcarriers (uint16_t channelWidth);
327
328private:
329 void BuildModeList (void) override;
330
339 static WifiMode CreateVhtMcs (uint8_t index);
340
344 typedef std::map< std::tuple<uint16_t /* channelWidth in MHz */,
345 uint8_t /* Nss */,
346 uint8_t /* MCS index */>, uint8_t /* Nes */ > NesExceptionMap;
349}; //class VhtPhy
350
351} //namespace ns3
352
353#endif /* VHT_PHY_H */
PHY entity for HT (11n)
Definition: ht-phy.h:51
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
PHY entity for VHT (11ac)
Definition: vht-phy.h:49
static bool IsAllowed(const WifiTxVector &txVector)
Check whether the combination in TXVECTOR is allowed.
Definition: vht-phy.cc:505
static WifiMode GetVhtMcs4(void)
Return MCS 4 from VHT MCS values.
static WifiCodeRate GetCodeRate(uint8_t mcsValue)
Return the coding rate corresponding to the supplied VHT MCS index.
Definition: vht-phy.cc:396
static bool IsCombinationAllowed(uint8_t mcsValue, uint16_t channelWidth, uint8_t nss)
Check whether the combination of <MCS, channel width, NSS> is allowed.
Definition: vht-phy.cc:513
static WifiMode GetVhtMcs9(void)
Return MCS 9 from VHT MCS values.
static WifiMode GetVhtMcs8(void)
Return MCS 8 from VHT MCS values.
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: vht-phy.cc:168
static const NesExceptionMap m_exceptionsMap
exception map for number of BCC encoders (extracted from VHT-MCS tables)
Definition: vht-phy.h:347
Time GetHtSigDuration(void) const override
Definition: vht-phy.cc:188
double GetCcaThreshold(const Ptr< const WifiPpdu > ppdu, WifiChannelListType channelType) const override
Return the CCA threshold in dBm for a given channel type.
Definition: vht-phy.cc:533
static const PpduFormats m_vhtPpduFormats
VHT PPDU formats.
Definition: vht-phy.h:348
std::map< std::tuple< uint16_t, uint8_t, uint8_t >, uint8_t > NesExceptionMap
Typedef for storing exceptions in the number of BCC encoders for VHT MCSs.
Definition: vht-phy.h:346
void BuildModeList(void) override
Build mode list.
Definition: vht-phy.cc:113
bool IsAllConfigSupported(WifiPpduField field, Ptr< const WifiPpdu > ppdu) const override
Checks if the signaled configuration (including bandwidth) is supported by the PHY.
Definition: vht-phy.cc:315
static uint64_t GetDataRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the data rate corresponding to the supplied TXVECTOR.
Definition: vht-phy.cc:440
PhyFieldRxStatus EndReceiveSig(Ptr< Event > event, WifiPpduField field)
End receiving the SIG-A or SIG-B, perform VHT-specific actions, and provide the status of the recepti...
Definition: vht-phy.cc:266
static WifiMode GetVhtMcs5(void)
Return MCS 5 from VHT MCS values.
uint8_t GetNumberBccEncoders(const WifiTxVector &txVector) const override
Definition: vht-phy.cc:215
Time GetTrainingDuration(const WifiTxVector &txVector, uint8_t nDataLtf, uint8_t nExtensionLtf=0) const override
Definition: vht-phy.cc:194
virtual WifiMode GetSigAMode(void) const
Definition: vht-phy.cc:155
static WifiMode GetVhtMcs0(void)
Return MCS 0 from VHT MCS values.
virtual Time GetSigBDuration(const WifiTxVector &txVector) const
Definition: vht-phy.cc:209
static uint64_t GetPhyRateFromTxVector(const WifiTxVector &txVector, uint16_t staId)
Return the PHY rate corresponding to the supplied TXVECTOR.
Definition: vht-phy.cc:431
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: vht-phy.cc:573
static WifiMode GetVhtMcs(uint8_t index)
Return the VHT MCS corresponding to the provided index.
Definition: vht-phy.cc:334
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: vht-phy.cc:483
Ptr< WifiPpdu > BuildPpdu(const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration) override
Build amendment-specific PPDU.
Definition: vht-phy.cc:241
static uint64_t GetPhyRate(uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the PHY rate corresponding to the supplied VHT MCS index, channel width, guard interval,...
Definition: vht-phy.cc:423
uint32_t GetMaxPsduSize(void) const override
Get the maximum PSDU size in bytes.
Definition: vht-phy.cc:527
WifiMode GetHtSigMode(void) const override
Definition: vht-phy.cc:147
static WifiMode GetVhtMcs6(void)
Return MCS 6 from VHT MCS values.
static WifiMode GetVhtMcs7(void)
Return MCS 7 from VHT MCS values.
Time GetLSigDuration(WifiPreamble preamble) const override
Definition: vht-phy.cc:182
virtual PhyFieldRxStatus ProcessSig(Ptr< Event > event, PhyFieldRxStatus status, WifiPpduField field)
Process SIG-A or SIG-B, perform amendment-specific actions, and provide an updated status of the rece...
Definition: vht-phy.cc:306
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: vht-phy.cc:251
static void InitializeModes(void)
Initialize all VHT modes.
Definition: vht-phy.cc:325
static uint64_t GetDataRate(uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss)
Return the data rate corresponding to the supplied VHT MCS index, channel width, guard interval,...
Definition: vht-phy.cc:449
static WifiMode GetVhtMcs3(void)
Return MCS 3 from VHT MCS values.
static WifiMode CreateVhtMcs(uint8_t index)
Return the VHT MCS corresponding to the provided index.
Definition: vht-phy.cc:380
virtual ~VhtPhy()
Destructor for VHT PHY.
Definition: vht-phy.cc:107
static uint16_t GetConstellationSize(uint8_t mcsValue)
Return the constellation size corresponding to the supplied VHT MCS index.
Definition: vht-phy.cc:410
static uint64_t GetNonHtReferenceRate(uint8_t mcsValue)
Calculate the rate in bps of the non-HT Reference Rate corresponding to the supplied VHT MCS index.
Definition: vht-phy.cc:475
virtual Time GetSigADuration(WifiPreamble preamble) const
Definition: vht-phy.cc:203
static WifiMode GetVhtMcs2(void)
Return MCS 2 from VHT MCS values.
static WifiMode GetVhtMcs1(void)
Return MCS 1 from VHT MCS values.
VhtPhy(bool buildModeList=true)
Constructor for VHT PHY.
Definition: vht-phy.cc:94
virtual WifiMode GetSigBMode(const WifiTxVector &txVector) const
Definition: vht-phy.cc:161
virtual WifiPhyRxfailureReason GetFailureReason(WifiPpduField field) const
Get the failure reason corresponding to the unsuccessful processing of a given PPDU field.
Definition: vht-phy.cc:291
const PpduFormats & GetPpduFormats(void) const override
Return the PPDU formats of the PHY.
Definition: vht-phy.cc:126
WifiMode GetSigMode(WifiPpduField field, const WifiTxVector &txVector) const override
Get the WifiMode for the SIG field specified by the PPDU field.
Definition: vht-phy.cc:132
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...
WifiPhyRxfailureReason
Enumeration of the possible reception failure reasons.
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
WifiChannelListType
Enumeration of the possible channel-list parameter elements defined in Table 8-5 of IEEE 802....
WifiPpduField
The type of PPDU field (grouped for convenience)
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