A Discrete-Event Network Simulator
API
he-capabilities.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016
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  * Author: S├ębastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #ifndef HE_CAPABILITIES_H
22 #define HE_CAPABILITIES_H
23 
25 
26 namespace ns3 {
27 
34 {
35 public:
36  HeCapabilities ();
41  void SetHeSupported (uint8_t hesupported);
56  uint8_t GetInformationFieldSize () const;
68  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
69 
76  void SetHeMacCapabilitiesInfo (uint32_t ctrl1, uint8_t ctrl2);
83  void SetHePhyCapabilitiesInfo (uint64_t ctrl1, uint8_t ctrl2);
89  void SetSupportedMcsAndNss (uint16_t ctrl);
90 
96  uint32_t GetHeMacCapabilitiesInfo1 () const;
102  uint8_t GetHeMacCapabilitiesInfo2 () const;
108  uint64_t GetHePhyCapabilitiesInfo1 () const;
114  uint8_t GetHePhyCapabilitiesInfo2 () const;
120  uint16_t GetSupportedMcsAndNss () const;
121 
122  // PHY Capabilities Info fields
128  void SetChannelWidthSet (uint8_t channelWidthSet);
134  void SetHeLtfAndGiForHePpdus (uint8_t heLtfAndGiForHePpdus);
140  uint8_t GetChannelWidthSet (void) const;
146  uint8_t GetHeLtfAndGiForHePpdus (void) const;
152  uint8_t GetHighestMcsSupported (void) const;
158  uint8_t GetHighestNssSupported (void) const;
159 
160  // MAC Capabilities Info fields
166  void SetMaxAmpduLength (uint32_t maxampdulength);
167 
168  // MCS and NSS field information
174  void SetHighestMcsSupported (uint8_t mcs);
180  void SetHighestNssSupported (uint8_t nss);
181 
188  bool IsSupportedTxMcs (uint8_t mcs) const;
195  bool IsSupportedRxMcs (uint8_t mcs) const;
196 
202  uint32_t GetMaxAmpduLength (void) const;
203 
204  /*
205  * This information element is a bit special in that it is only
206  * included if the STA is an HE STA. To support this we
207  * override the Serialize and GetSerializedSize methods of
208  * WifiInformationElement.
209  */
210 
223  uint16_t GetSerializedSize () const;
224 
225 
226 private:
227  //MAC Capabilities Info fields
237  uint8_t m_allAckSupport;
239  uint8_t m_aBsrSupport;
252  uint8_t m_qtpSupport;
253  uint8_t m_aBqrSupport;
254 
255  //PHY Capabilities Info fields
259  uint8_t m_deviceClass;
263  uint8_t m_stbcTxAndRx;
264  uint8_t m_doppler;
265  uint8_t m_ulMu;
266  uint8_t m_dcmEncodingTx;
267  uint8_t m_dcmEncodingRx;
269  uint8_t m_suBeamformer;
270  uint8_t m_suBeamformee;
271  uint8_t m_muBeamformer;
289 
290  //MCS and NSS field information
293  std::vector<uint8_t> m_txBwMap;
294  std::vector<uint8_t> m_rxBwMap;
295 
297  uint8_t m_heSupported;
298 };
299 
300 std::ostream &operator << (std::ostream &os, const HeCapabilities &HeCapabilities);
301 
302 } //namespace ns3
303 
304 #endif /* HE_CAPABILITY_H */
uint8_t m_4TimesHeLtfAnd800NsGiSupportForHePpdus
4 times HE LFT and 800 HS GI support for HE PPDUs
uint8_t m_rxControlFrameToMultiBss
receive control frame to multi bias
uint8_t m_beamformeeStsForSmallerOrEqualThan80Mhz
beam formee STS for < 80 MHz
uint8_t m_heLtfAndGiForNdp
HE LTF and GI for NDP.
uint8_t m_srpBasedSrSupport
SRP based SR support.
uint8_t m_bsrpAmpduAggregation
BSRP AMPDU aggregation.
uint8_t GetChannelWidthSet(void) const
Get channel width set.
uint8_t m_ngEqual16ForMuFeedbackSupport
equal 16 for MU feedback
uint8_t m_numberOfSoundingDimensionsForSmallerOrEqualThan80Mhz
of sounding diemnsions for < 80 MHz
uint8_t m_ackEnabledMultiTidAggregationSupport
ack enabled multi TID aggregation support
uint8_t m_minimumFragmentSize
minimum fragment size
uint8_t m_beamformeeStsForLargerThan80Mhz
beam formee STS for > 80MHz
uint8_t m_ulMuResponseSchedulingSupport
UL MU response scheduling support.
bool IsSupportedRxMcs(uint8_t mcs) const
Is RX MCS supported.
uint8_t m_muCascadeSupport
MU cascade support.
uint8_t GetHePhyCapabilitiesInfo2() const
Return the last octet of the HE PHY Capabilities Info field in the HE Capabilities information elemen...
uint16_t GetSupportedMcsAndNss() const
Return the MCS and NSS field in the HE Capabilities information element.
WifiInformationElementId ElementId() const
Get the wifi information element ID.
def start()
Definition: core.py:1858
uint8_t m_broadcastTwtSupport
broadcast TXT support
uint8_t m_twtResponderSupport
TWT responder support.
uint8_t m_heLinkAdaptation
HE link adaptation.
uint8_t m_maximumNumberOfFragmentedMsdus
maximum number of fragmentation MSDUs
void SetHighestNssSupported(uint8_t nss)
Set highest NSS supported.
uint8_t m_qtpSupport
QTP support.
void SetMaxAmpduLength(uint32_t maxampdulength)
Set the maximum AMPDU length.
uint8_t m_highestNssSupportedM1
highest NSS support M1
uint8_t m_dcmEncodingTx
DCM encoding transmit.
uint8_t DeserializeInformationField(Buffer::Iterator start, uint8_t length)
Deserialize information field.
uint8_t m_plusHtcHeSupport
HTC HE support.
iterator in a Buffer instance
Definition: buffer.h:98
uint8_t m_dualBandSupport
dual band support
void SetChannelWidthSet(uint8_t channelWidthSet)
Set channel width set.
uint8_t m_nstsTotalForLargerThan80Mhz
STS total for > 80 MHz.
void SetHeLtfAndGiForHePpdus(uint8_t heLtfAndGiForHePpdus)
Set HE LTF and GI for HE PDPUs.
Information element, as defined in 802.11-2007 standardThe IEEE 802.11 standard includes the notion o...
void SetHePhyCapabilitiesInfo(uint64_t ctrl1, uint8_t ctrl2)
Set the HE PHY Capabilities Info field in the HE Capabilities information element.
uint16_t GetSerializedSize() const
Set serialize size function.
uint8_t m_deviceClass
device class
uint8_t m_aBqrSupport
ABQR support.
uint8_t m_ulMu
UL MU.
void SetHighestMcsSupported(uint8_t mcs)
Set highest MCS supported.
uint64_t GetHePhyCapabilitiesInfo1() const
Return the 8 first octets of the HE PHY Capabilities Info field in the HE Capabilities information el...
uint8_t m_suBeamformee
SU beam formee.
uint8_t m_stbcTxAndRx
STBC transmit and receive.
uint8_t m_multiTidAggregationSupport
multi TID aggregation support
uint8_t m_heSupported
This is used to decide if this element should be added to the frame or not.
uint8_t m_omiAcontrolSupport
OMI A control support.
uint8_t m_fragmentationSupport
fragmentation support
uint8_t m_beamformingFeedbackWithTriggerFrame
beam forming feedback with trigger frame
uint8_t GetInformationFieldSize() const
Get information field size.
WifiInformationElementId ElementIdExt() const
Get the wifi information element ID extension.
std::vector< uint8_t > m_txBwMap
transmit BW map
uint8_t m_32bitBaBitmapSupport
32bit BA bitmap support
uint8_t m_ngEqual16ForSuFeedbackSupport
equal 16 for SU feedback
void SetHeMacCapabilitiesInfo(uint32_t ctrl1, uint8_t ctrl2)
Set the HE MAC Capabilities Info field in the HE Capabilities information element.
uint8_t m_doppler
doppler
uint8_t m_allAckSupport
ack support
uint8_t m_ldpcCodingInPayload
LDPC coding in payload.
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
uint8_t m_muBeamformer
MU beam former.
uint8_t m_heErSuPpduPayload
HE ER SU PPDU payload.
uint8_t m_ulHeMuPpduPayloadSupport
UL HE MU PDPU payload support.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint8_t m_preamblePuncturingRx
preamble puncturing receive
uint32_t GetHeMacCapabilitiesInfo1() const
Return the 4 first octets of the HE MAC Capabilities Info field in the HE Capabilities information el...
bool IsSupportedTxMcs(uint8_t mcs) const
Is RX MCS supported.
uint8_t GetHeMacCapabilitiesInfo2() const
Return the last octet of the HE MAC Capabilities Info field in the HE Capabilities information elemen...
uint8_t GetHighestMcsSupported(void) const
Get highest MCS supported.
uint8_t GetHeLtfAndGiForHePpdus(void) const
Get HE LTF and GI for HE PDPUs.
uint32_t GetMaxAmpduLength(void) const
Return the maximum A-MPDU length.
uint8_t m_codebookSize42ForSuSupport
codebook size 42 for SU
uint8_t m_channelWidthSet
channel width set
uint8_t m_codebookSize75ForSuSupport
codebook size 75 for SU
uint8_t m_triggerFrameMacPaddingDuration
trigger frame MAC padding duration
uint8_t m_amsduFragmentationSupport
AMSDU fragmentation support.
void SerializeInformationField(Buffer::Iterator start) const
Serialize information field.
void SetHeSupported(uint8_t hesupported)
Set HE supported.
uint8_t m_maxAmpduLengthExponent
maximum AMPDU length exponenet
uint8_t m_heLtfAndGiForHePpdus
HE LTF and GI for HE PDUs.
uint8_t m_highestMcsSupported
highest MCS support
uint8_t m_flexibleTwtScheduleSupport
flexible TWT schedule support
uint8_t m_dlMuMimoOnPartialBandwidth
DL MU MIMO on partial bandwidth.
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
uint8_t m_powerBoostFactorAlphaSupport
power boost factor alpha support
Buffer::Iterator Serialize(Buffer::Iterator start) const
Serialize function.
void SetSupportedMcsAndNss(uint16_t ctrl)
Set the MCS and NSS field in the HE Capabilities information element.
uint8_t m_ofdmaRaSupport
OFDM RA support.
uint8_t m_aBsrSupport
BSR support.
uint8_t m_twtRequesterSupport
TWT requester support.
uint8_t m_dcmEncodingRx
DCM encoding receive.
uint8_t m_suBeamformer
SU beam former.
The IEEE 802.11ax HE Capabilities.
std::vector< uint8_t > m_rxBwMap
receive BW map
uint8_t m_groupAddressedMultiStaBlockAckInDlMuSupport
group addressed multi STA block ack in DL support
uint8_t GetHighestNssSupported(void) const
Get highest NSS supported.
uint8_t m_ppeThresholdPresent
PPE threshold present.
uint8_t m_numberOfSoundingDimensionsForLargerThan80Mhz
of sounding dimensions for > 80 MHz
uint8_t m_nstsTotalForSmallerOrEqualThan80Mhz
STS total for < 80 MHz.