A Discrete-Event Network Simulator
API
ht-capabilities.h
Go to the documentation of this file.
1/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2013
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: Ghada Badawy <gbadawy@gmail.com>
19 * S├ębastien Deronne <sebastien.deronne@gmail.com>
20 */
21
22#ifndef HT_CAPABILITIES_H
23#define HT_CAPABILITIES_H
24
25#include "ns3/wifi-information-element.h"
26
31#define MAX_SUPPORTED_MCS (77)
32
33namespace ns3 {
34
42{
43public:
45
46 // Implementations of pure virtual methods of WifiInformationElement
47 WifiInformationElementId ElementId () const override;
48 uint8_t GetInformationFieldSize () const override;
51 uint8_t length) override;
52 /* This information element is a bit special in that it is only
53 included if the STA is an HT STA. To support this we
54 override the Serialize and GetSerializedSize methods of
55 WifiInformationElement. */
57 uint16_t GetSerializedSize () const override;
58
64 void SetHtSupported (uint8_t htSupported);
65
71 void SetHtCapabilitiesInfo (uint16_t ctrl);
77 void SetAmpduParameters (uint8_t ctrl);
84 void SetSupportedMcsSet (uint64_t ctrl1, uint64_t ctrl2);
90 void SetExtendedHtCapabilities (uint16_t ctrl);
96 void SetTxBfCapabilities (uint32_t ctrl);
102 void SetAntennaSelectionCapabilities (uint8_t ctrl);
103
109 void SetLdpc (uint8_t ldpc);
115 void SetSupportedChannelWidth (uint8_t supportedChannelWidth);
121 void SetShortGuardInterval20 (uint8_t shortGuardInterval);
127 void SetShortGuardInterval40 (uint8_t shortGuardInterval);
133 void SetMaxAmsduLength (uint16_t maxAmsduLength);
139 void SetLSigProtectionSupport (uint8_t lSigProtection);
140
146 void SetMaxAmpduLength (uint32_t maxAmpduLength);
147
153 void SetRxMcsBitmask (uint8_t index);
159 void SetRxHighestSupportedDataRate (uint16_t maxSupportedRate);
165 void SetTxMcsSetDefined (uint8_t txMcsSetDefined);
171 void SetTxRxMcsSetUnequal (uint8_t txRxMcsSetUnequal);
177 void SetTxMaxNSpatialStreams (uint8_t maxTxSpatialStreams);
183 void SetTxUnequalModulation (uint8_t txUnequalModulation);
184
190 uint16_t GetHtCapabilitiesInfo (void) const;
196 uint8_t GetAmpduParameters (void) const;
202 uint64_t GetSupportedMcsSet1 (void) const;
208 uint64_t GetSupportedMcsSet2 (void) const;
214 uint16_t GetExtendedHtCapabilities (void) const;
220 uint32_t GetTxBfCapabilities (void) const;
226 uint8_t GetAntennaSelectionCapabilities (void) const;
227
233 uint8_t GetLdpc (void) const;
239 uint8_t GetSupportedChannelWidth (void) const;
245 uint8_t GetShortGuardInterval20 (void) const;
251 uint16_t GetMaxAmsduLength (void) const;
257 uint32_t GetMaxAmpduLength (void) const;
265 bool IsSupportedMcs (uint8_t mcs) const;
271 uint8_t GetRxHighestSupportedAntennas (void) const;
272
273
274private:
275 //HT Capabilities Info field
276 uint8_t m_ldpc;
279 uint8_t m_greenField;
282 uint8_t m_txStbc;
283 uint8_t m_rxStbc;
286 uint8_t m_dssMode40;
290
291 //A-MPDU Parameters field
295
296 //Supported MCS Set field
306
307 //HT Extended Capabilities field
308 uint8_t m_pco;
312 uint8_t m_htcSupport;
315
316 //Transmit Beamforming Capabilities field
337
338 //ASEL Capabilities field
347
350};
351
360std::ostream &operator << (std::ostream &os, const HtCapabilities &htcapabilities);
361
362} //namespace ns3
363
364#endif /* HT_CAPABILITY_H */
iterator in a Buffer instance
Definition: buffer.h:99
The HT Capabilities Information Element.
uint8_t m_calibration
calibration
uint8_t GetShortGuardInterval20(void) const
Return the short guard interval 20 value.
void SetLdpc(uint8_t ldpc)
Set the LDPC field.
uint8_t m_reservedExtendedCapabilities2
reserver extended capabilities 2
uint8_t m_htcSupport
HTC support.
uint8_t m_shortGuardInterval40
short guard interval 40 MHz
void SetTxRxMcsSetUnequal(uint8_t txRxMcsSetUnequal)
Set the transmit / receive MCS set unequal.
uint8_t GetAntennaSelectionCapabilities(void) const
Return the Antenna Selection (ASEL) Capabilities field in the HT Capabilities information element.
uint8_t m_shortGuardInterval20
short guard interval 20 MHz
void SetRxHighestSupportedDataRate(uint16_t maxSupportedRate)
Set the receive highest supported data rate.
void SetLSigProtectionSupport(uint8_t lSigProtection)
Set the LSIG protection support.
void SetMaxAmsduLength(uint16_t maxAmsduLength)
Set the maximum AMSDU length.
void SetExtendedHtCapabilities(uint16_t ctrl)
Set the Extended HT Capabilities field in the HT Capabilities information element.
void SetAmpduParameters(uint8_t ctrl)
Set the A-MPDU Parameters field in the HT Capabilities information element.
uint8_t m_explicitCompressedBfFeedbackCapable
explicit compressed BF feedback capable
uint8_t m_compressedSteeringNBfAntennasSupported
compressed steering NBF antenna supported
uint64_t GetSupportedMcsSet1(void) const
Return the first 64 bytes of the Supported MCS Set field in the HT Capabilities information element.
void SetTxMaxNSpatialStreams(uint8_t maxTxSpatialStreams)
Set the transmit maximum N spatial streams.
uint8_t m_rxStaggeredSoundingCapable
receive staggered sounding capable
uint8_t m_reservedTxBf
reserved transmit BF
uint8_t m_txMcsSetDefined
transmit MCS set defined
uint8_t m_maxAmpduLengthExponent
maximum A-MPDU length
uint8_t GetAmpduParameters(void) const
Return the A-MPDU Parameters field in the HT Capabilities information element.
uint8_t m_txSoundingPpdusCapable
sounding PPDUS capable
void SetAntennaSelectionCapabilities(uint8_t ctrl)
Set the the Antenna Selection (ASEL) Capabilities field in the HT Capabilities information element.
void SetSupportedMcsSet(uint64_t ctrl1, uint64_t ctrl2)
Set the Supported MCS Set field in the HT Capabilities information element.
uint64_t GetSupportedMcsSet2(void) const
Return the last 64 bytes of the Supported MCS Set field in the HT Capabilities information element.
uint32_t GetTxBfCapabilities(void) const
Return the Transmit Beamforming (TxBF) Capabilities field in the HT Capabilities information element.
uint16_t GetExtendedHtCapabilities(void) const
Return the Extended HT Capabilities field in the HT Capabilities information element.
uint8_t m_dssMode40
DSS mode 40.
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
uint8_t m_minimalGrouping
minimal grouping
uint8_t m_minMpduStartSpace
minimum MPDU start space
uint8_t m_txRxMcsSetUnequal
transmit / receive MCS set unequal
void SetTxBfCapabilities(uint32_t ctrl)
Set the Transmit Beamforming (TxBF) Capabilities field in the HT Capabilities information element.
uint8_t m_txStaggeredSoundingCapable
transmit staggered sounding capable
uint8_t m_maxAmsduLength
maximum A-MSDU length
uint8_t m_implicitTxBfCapable
implicit transmit BF capable
uint8_t m_htDelayedBlockAck
HT delayed block ack.
Buffer::Iterator Serialize(Buffer::Iterator start) const override
Serialize entire IE including Element ID and length fields.
void SetShortGuardInterval20(uint8_t shortGuardInterval)
Set the short guard interval 20 field.
uint8_t m_csiMaxNRowsBfSupported
CSI maximum number rows BF supported.
uint8_t m_explicitTxBfCsiFeedback
explicit transmit BF CSI feedback
uint8_t m_rxNdpCapable
receive NDP capable
uint8_t m_rxMcsBitmask[MAX_SUPPORTED_MCS]
receive MCS bitmask
void SetHtCapabilitiesInfo(uint16_t ctrl)
Set the HT Capabilities Info field in the HT Capabilities information element.
void SetTxUnequalModulation(uint8_t txUnequalModulation)
Set the transmit unequal modulation.
uint8_t m_reverseDirectionResponder
reverse direction responder
uint16_t GetSerializedSize() const override
Get the size of the serialized IE including Element ID and length fields.
uint32_t GetMaxAmpduLength(void) const
Return the maximum A-MPDU length.
uint16_t GetHtCapabilitiesInfo(void) const
Return the HT Capabilities Info field in the HT Capabilities information element.
uint8_t m_txNdpCapable
transmit NDP capable
uint8_t GetLdpc(void) const
Return LDPC.
void SetTxMcsSetDefined(uint8_t txMcsSetDefined)
Set the transmit MCS set defined.
uint8_t m_txUnequalModulation
transmit unequal modulation
uint8_t m_reservedExtendedCapabilities
reserved extended capabilities
uint8_t m_lsigProtectionSupport
L-SIG protection support.
void SetHtSupported(uint8_t htSupported)
Set the HT supported field.
uint8_t m_explicitCsiFeedbackCapable
explicit CSI feedback capable
uint8_t m_txMaxNSpatialStreams
transmit maximum number spatial streams
uint8_t m_explicitNoncompressedBfFeedbackCapable
explicit non compressed BF feedback capable
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint8_t m_pcoTransitionTime
PCO transition time.
uint8_t m_reservedMcsSet2
reserved MCS set 2
uint16_t GetMaxAmsduLength(void) const
Return the maximum A-MSDU length.
uint8_t m_antennaIndicesFeedbackBasedTxASelCapable
antenna indices feedback based transmit antenna selection capable
uint8_t m_explicitNoncompressedSteeringCapable
explicit non compressed steeering capable
void SetRxMcsBitmask(uint8_t index)
Set the receive MCS bitmask.
uint8_t m_implicitRxBfCapable
implicit receive BF capable
void SetSupportedChannelWidth(uint8_t supportedChannelWidth)
Set the supported channel width field.
bool IsSupportedMcs(uint8_t mcs) const
Return the is MCS supported flag.
uint8_t GetSupportedChannelWidth(void) const
Return the supported channel width.
uint8_t m_mcsFeedback
MCS feedback.
uint8_t m_fortyMhzIntolerant
40 MHz intolerant
uint8_t m_channelEstimationCapability
channel estimation capability
uint8_t DeserializeInformationField(Buffer::Iterator start, uint8_t length) override
Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint8_t m_rxASelCapable
receive antenna selection capable
uint16_t m_rxHighestSupportedDataRate
receive highest supported data rate
uint8_t m_csiNBfAntennasSupported
CSI NBF antenna supported.
uint8_t m_antennaSelectionCapability
antenna selection capability
uint8_t m_txStbc
transmit STBC
uint8_t m_htSupported
This is used to decide whether this element should be added to the frame or not.
uint8_t m_ampduReserved
A-MPDU reserved.
uint8_t m_antennaIndicesFeedbackCapable
antenna indices feedback capable
uint8_t m_supportedChannelWidth
supported channel width
uint8_t GetRxHighestSupportedAntennas(void) const
Return the receive highest supported antennas.
uint32_t m_reservedMcsSet3
reserved MCS set 3
uint8_t m_greenField
Greenfield.
uint8_t m_noncompressedSteeringNBfAntennasSupported
non compressed steering NBF antenna supported
uint8_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
void SetMaxAmpduLength(uint32_t maxAmpduLength)
Set the maximum AMPDU length.
uint8_t m_explicitCsiFeedbackBasedTxASelCapable
explicit CSI feedback based transmit antenna selection capable
void SetShortGuardInterval40(uint8_t shortGuardInterval)
Set the short guard interval 40 field.
uint8_t m_psmpSupport
PSMP support.
uint8_t m_reservedMcsSet1
reserved MCS set 1
uint8_t m_explicitCsiTxBfCapable
explicit CSI transmit BF capable
uint8_t m_explicitCompressedSteeringCapable
explicit compressed steeering capable
uint8_t m_reservedASel
reserved ASEL
uint8_t m_rxStbc
receive STBC
uint8_t m_smPowerSave
SM power save.
Information element, as defined in 802.11-2007 standard.
#define MAX_SUPPORTED_MCS
This defines the maximum number of supported MCSs that a STA is allowed to have.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:139
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
def start()
Definition: core.py:1853