ht-phy.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 Orange Labs
 *
 * 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: Rediet <getachew.redieteab@orange.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com> (for logic ported from wifi-phy)
 */
 
#ifndef HT_PHY_H
#define HT_PHY_H
 
#include "ns3/ofdm-phy.h"
 
namespace ns3 {
 
#define HT_PHY 127
 
class HtPhy : public OfdmPhy
{
public:
  HtPhy (uint8_t maxNss = 1, bool buildModeList = true);
  virtual ~HtPhy ();
 
  WifiMode GetMcs (uint8_t index) const override;
  bool IsMcsSupported (uint8_t index) const override;
  bool HandlesMcsModes (void) const override;
  WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const override;
  const PpduFormats & GetPpduFormats (void) const override;
  Time GetDuration (WifiPpduField field, const WifiTxVector& txVector) const override;
  Time GetPayloadDuration (uint32_t size, const WifiTxVector& txVector, WifiPhyBand band, MpduType mpdutype,
                           bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols,
                           uint16_t staId) const override;
  Ptr<WifiPpdu> BuildPpdu (const WifiConstPsduMap & psdus, const WifiTxVector& txVector, Time ppduDuration) override;
 
  static WifiMode GetLSigMode (void);
  virtual WifiMode GetHtSigMode (void) const;
 
  uint8_t GetBssMembershipSelector (void) const;
 
  uint8_t GetMaxSupportedMcsIndexPerSs (void) const;
  void SetMaxSupportedMcsIndexPerSs (uint8_t maxIndex);
  void SetMaxSupportedNss (uint8_t maxNss);
 
  virtual Time GetLSigDuration (WifiPreamble preamble) const;
  virtual Time GetTrainingDuration (const WifiTxVector& txVector,
                                    uint8_t nDataLtf, uint8_t nExtensionLtf = 0) const;
  virtual Time GetHtSigDuration (void) const;
 
  static void InitializeModes (void);
  static WifiMode GetHtMcs (uint8_t index);
 
  static WifiMode GetHtMcs0 (void);
  static WifiMode GetHtMcs1 (void);
  static WifiMode GetHtMcs2 (void);
  static WifiMode GetHtMcs3 (void);
  static WifiMode GetHtMcs4 (void);
  static WifiMode GetHtMcs5 (void);
  static WifiMode GetHtMcs6 (void);
  static WifiMode GetHtMcs7 (void);
  static WifiMode GetHtMcs8 (void);
  static WifiMode GetHtMcs9 (void);
  static WifiMode GetHtMcs10 (void);
  static WifiMode GetHtMcs11 (void);
  static WifiMode GetHtMcs12 (void);
  static WifiMode GetHtMcs13 (void);
  static WifiMode GetHtMcs14 (void);
  static WifiMode GetHtMcs15 (void);
  static WifiMode GetHtMcs16 (void);
  static WifiMode GetHtMcs17 (void);
  static WifiMode GetHtMcs18 (void);
  static WifiMode GetHtMcs19 (void);
  static WifiMode GetHtMcs20 (void);
  static WifiMode GetHtMcs21 (void);
  static WifiMode GetHtMcs22 (void);
  static WifiMode GetHtMcs23 (void);
  static WifiMode GetHtMcs24 (void);
  static WifiMode GetHtMcs25 (void);
  static WifiMode GetHtMcs26 (void);
  static WifiMode GetHtMcs27 (void);
  static WifiMode GetHtMcs28 (void);
  static WifiMode GetHtMcs29 (void);
  static WifiMode GetHtMcs30 (void);
  static WifiMode GetHtMcs31 (void);
 
  static WifiCodeRate GetHtCodeRate (uint8_t mcsValue);
  static WifiCodeRate GetCodeRate (uint8_t mcsValue);
  static uint16_t GetHtConstellationSize (uint8_t mcsValue);
  static uint16_t GetConstellationSize (uint8_t mcsValue);
  static uint64_t GetPhyRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
  static uint64_t GetPhyRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
  static uint64_t GetDataRateFromTxVector (const WifiTxVector& txVector, uint16_t staId);
  static uint64_t GetDataRate (uint8_t mcsValue, uint16_t channelWidth, uint16_t guardInterval, uint8_t nss);
  static uint64_t GetNonHtReferenceRate (uint8_t mcsValue);
  static bool IsAllowed (const WifiTxVector& txVector);
 
protected:
  PhyFieldRxStatus DoEndReceiveField (WifiPpduField field, Ptr<Event> event) override;
  bool IsAllConfigSupported (WifiPpduField field, Ptr<const WifiPpdu> ppdu) const override;
  bool IsConfigSupported (Ptr<const WifiPpdu> ppdu) const override;
  Ptr<SpectrumValue> GetTxPowerSpectralDensity (double txPowerW, Ptr<const WifiPpdu> ppdu) const override;
  uint32_t GetMaxPsduSize (void) const override;
 
  virtual void BuildModeList (void);
 
  virtual uint8_t GetNumberBccEncoders (const WifiTxVector& txVector) const;
  virtual Time GetSymbolDuration (const WifiTxVector& txVector) const;
 
  static uint64_t CalculatePhyRate (WifiCodeRate codeRate, uint64_t dataRate);
  static uint64_t CalculateNonHtReferenceRate (WifiCodeRate codeRate, uint16_t constellationSize);
  static double GetCodeRatio (WifiCodeRate codeRate);
  static uint64_t CalculateDataRate (double symbolDuration, uint16_t guardInterval,
                                     uint16_t usableSubCarriers, uint16_t numberOfBitsPerSubcarrier,
                                     double codingRate, uint8_t nss);
  static uint16_t GetUsableSubcarriers (uint16_t channelWidth);
 
  uint8_t m_maxMcsIndexPerSs;          
  uint8_t m_maxSupportedMcsIndexPerSs; 
  uint8_t m_bssMembershipSelector;     
 
private:
  PhyFieldRxStatus EndReceiveHtSig (Ptr<Event> event);
 
  static WifiMode CreateHtMcs (uint8_t index);
 
  uint8_t m_maxSupportedNss; 
 
  static const PpduFormats m_htPpduFormats; 
}; //class HtPhy
 
} //namespace ns3
 
#endif /* HT_PHY_H */