vht-capabilities.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Ghada Badawy <gbadawy@gmail.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef VHT_CAPABILITIES_H
#define VHT_CAPABILITIES_H

#include "wifi-information-element.h"

namespace ns3 {

class VhtCapabilities : public WifiInformationElement
{
public:
  VhtCapabilities ();

  // Implementations of pure virtual methods of WifiInformationElement
  WifiInformationElementId ElementId () const;
  uint8_t GetInformationFieldSize () const;
  void SerializeInformationField (Buffer::Iterator start) const;
  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
  /* This information element is a bit special in that it is only
     included if the STA is an VHT STA. To support this we
     override the Serialize and GetSerializedSize methods of
     WifiInformationElement. */
  Buffer::Iterator Serialize (Buffer::Iterator start) const;
  uint16_t GetSerializedSize () const;

  void SetVhtSupported (uint8_t vhtSupported);

  void SetVhtCapabilitiesInfo (uint32_t ctrl);
  void SetSupportedMcsAndNssSet (uint64_t ctrl);

  uint32_t GetVhtCapabilitiesInfo () const;
  uint64_t GetSupportedMcsAndNssSet () const;

  //Capabilities Info fields
  void SetMaxMpduLength (uint16_t length);
  void SetSupportedChannelWidthSet (uint8_t channelWidthSet);
  void SetRxLdpc (uint8_t rxLdpc);
  void SetShortGuardIntervalFor80Mhz (uint8_t shortGuardInterval);
  void SetShortGuardIntervalFor160Mhz (uint8_t shortGuardInterval);
  void SetRxStbc (uint8_t rxStbc);
  void SetTxStbc (uint8_t txStbc);
  void SetMaxAmpduLength (uint32_t maxAmpduLength);

  uint16_t GetMaxMpduLength (void) const;
  uint8_t GetSupportedChannelWidthSet () const;
  uint8_t GetRxLdpc () const;
  uint8_t GetRxStbc () const;
  uint8_t GetTxStbc () const;

  void SetRxMcsMap (uint8_t mcs, uint8_t nss);
  void SetTxMcsMap (uint8_t mcs, uint8_t nss);
  void SetRxHighestSupportedLgiDataRate (uint16_t supportedDatarate);
  void SetTxHighestSupportedLgiDataRate (uint16_t supportedDatarate);
  bool IsSupportedMcs (uint8_t mcs, uint8_t nss) const;

  uint16_t GetRxHighestSupportedLgiDataRate () const;

  bool IsSupportedTxMcs (uint8_t mcs) const;
  bool IsSupportedRxMcs (uint8_t mcs) const;

  uint32_t GetMaxAmpduLength (void) const;


private:
  //Capabilities Info fields
  uint8_t m_maxMpduLength;               
  uint8_t m_supportedChannelWidthSet;    
  uint8_t m_rxLdpc;                      
  uint8_t m_shortGuardIntervalFor80Mhz;  
  uint8_t m_shortGuardIntervalFor160Mhz; 
  uint8_t m_txStbc;                      
  uint8_t m_rxStbc;                      
  uint8_t m_suBeamformerCapable;         
  uint8_t m_suBeamformeeCapable;         
  uint8_t m_beamformeeStsCapable;        
  uint8_t m_numberOfSoundingDimensions;  
  uint8_t m_muBeamformerCapable;         
  uint8_t m_muBeamformeeCapable;         
  uint8_t m_vhtTxopPs;                   
  uint8_t m_htcVhtCapable;               
  uint8_t m_maxAmpduLengthExponent;      
  uint8_t m_vhtLinkAdaptationCapable;    
  uint8_t m_rxAntennaPatternConsistency; 
  uint8_t m_txAntennaPatternConsistency; 

  //MCS and NSS field information
  std::vector<uint8_t> m_rxMcsMap;                        
  uint16_t m_rxHighestSupportedLongGuardIntervalDataRate; 
  std::vector<uint8_t> m_txMcsMap;                        
  uint16_t m_txHighestSupportedLongGuardIntervalDataRate; 

  uint8_t m_vhtSupported;
};

std::ostream &operator << (std::ostream &os, const VhtCapabilities &vhtcapabilities);

} //namespace ns3

#endif /* VHT_CAPABILITY_H */