he-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 and spectrum-wifi-phy)
 */

#ifndef HE_PHY_H
#define HE_PHY_H

#include "ns3/vht-phy.h"
#include "ns3/wifi-phy-band.h"
#include "ns3/callback.h"

namespace ns3 {

#define HE_PHY 125

struct HeSigAParameters
{
  double rssiW;     
  uint8_t bssColor; 
};

class HePhy : public VhtPhy
{
public:
  typedef Callback<void, HeSigAParameters> EndOfHeSigACallback;

  HePhy (bool buildModeList = true);
  virtual ~HePhy ();

  WifiMode GetSigMode (WifiPpduField field, const WifiTxVector& txVector) const override;
  WifiMode GetSigAMode (void) const override;
  WifiMode GetSigBMode (const WifiTxVector& txVector) const override;
  const PpduFormats & GetPpduFormats (void) const override;
  Time GetLSigDuration (WifiPreamble preamble) const override;
  Time GetTrainingDuration (const WifiTxVector& txVector,
                            uint8_t nDataLtf,
                            uint8_t nExtensionLtf = 0) const override;
  Time GetSigADuration (WifiPreamble preamble) const override;
  Time GetSigBDuration (const WifiTxVector& txVector) const override;
  Ptr<WifiPpdu> BuildPpdu (const WifiConstPsduMap & psdus,
                           const WifiTxVector& txVector,
                           Time ppduDuration) override;
  Ptr<const WifiPsdu> GetAddressedPsduInPpdu (Ptr<const WifiPpdu> ppdu) const override;
  void StartReceivePreamble (Ptr<WifiPpdu> ppdu,
                             RxPowerWattPerChannelBand rxPowersW,
                             Time rxDuration) override;
  void CancelAllEvents (void) override;
  uint16_t GetStaId (const Ptr<const WifiPpdu> ppdu) const override;
  uint16_t GetMeasurementChannelWidth (const Ptr<const WifiPpdu> ppdu) const override;
  void StartTx (Ptr<WifiPpdu> ppdu) override;
  Time CalculateTxDuration (WifiConstPsduMap psduMap, const WifiTxVector& txVector, WifiPhyBand band) const override;

  uint8_t GetBssColor (void) const;

  static uint16_t ConvertHeTbPpduDurationToLSigLength (Time ppduDuration, WifiPhyBand band);
  static Time ConvertLSigLengthToHeTbPpduDuration (uint16_t length, const WifiTxVector& txVector, WifiPhyBand band);
  Time CalculateNonOfdmaDurationForHeTb (const WifiTxVector& txVector) const;

  WifiSpectrumBand GetRuBandForTx (const WifiTxVector& txVector, uint16_t staId) const;
  WifiSpectrumBand GetRuBandForRx (const WifiTxVector& txVector, uint16_t staId) const;
  WifiSpectrumBand GetNonOfdmaBand (const WifiTxVector& txVector, uint16_t staId) const;
  uint16_t GetNonOfdmaWidth (HeRu::RuSpec ru) const;

  uint64_t GetCurrentHeTbPpduUid (void) const;

  uint16_t GetCenterFrequencyForNonOfdmaPart (const WifiTxVector& txVector, uint16_t staId) const;

  void SetEndOfHeSigACallback (EndOfHeSigACallback callback);

  void NotifyEndOfHeSigA (HeSigAParameters params);

  static void InitializeModes (void);
  static WifiMode GetHeMcs (uint8_t index);

  static WifiMode GetHeMcs0 (void);
  static WifiMode GetHeMcs1 (void);
  static WifiMode GetHeMcs2 (void);
  static WifiMode GetHeMcs3 (void);
  static WifiMode GetHeMcs4 (void);
  static WifiMode GetHeMcs5 (void);
  static WifiMode GetHeMcs6 (void);
  static WifiMode GetHeMcs7 (void);
  static WifiMode GetHeMcs8 (void);
  static WifiMode GetHeMcs9 (void);
  static WifiMode GetHeMcs10 (void);
  static WifiMode GetHeMcs11 (void);

  static WifiCodeRate GetCodeRate (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 = SU_STA_ID);
  static uint64_t GetDataRateFromTxVector (const WifiTxVector& txVector, uint16_t staId = SU_STA_ID);
  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 IsModeAllowed (uint16_t channelWidth, uint8_t nss);

protected:
  PhyFieldRxStatus ProcessSigA (Ptr<Event> event, PhyFieldRxStatus status) override;
  PhyFieldRxStatus ProcessSigB (Ptr<Event> event, PhyFieldRxStatus status) override;
  Ptr<Event> DoGetEvent (Ptr<const WifiPpdu> ppdu, RxPowerWattPerChannelBand rxPowersW) override;
  bool IsConfigSupported (Ptr<const WifiPpdu> ppdu) const override;
  void DoStartReceivePayload (Ptr<Event> event) override;
  std::pair<uint16_t, WifiSpectrumBand> GetChannelWidthAndBand (const WifiTxVector& txVector, uint16_t staId) const override;
  void DoEndReceivePayload (Ptr<const WifiPpdu> ppdu) override;
  void DoResetReceive (Ptr<Event> event) override;
  void DoAbortCurrentReception (WifiPhyRxfailureReason reason) override;
  uint64_t ObtainNextUid (const WifiTxVector& txVector) override;
  Ptr<SpectrumValue> GetTxPowerSpectralDensity (double txPowerW, Ptr<const WifiPpdu> ppdu) const override;
  uint32_t GetMaxPsduSize (void) const override;
  WifiConstPsduMap GetWifiConstPsduMap (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector) const override;

  void StartReceiveOfdmaPayload (Ptr<Event> event);

  static uint64_t CalculateNonHtReferenceRate (WifiCodeRate codeRate, uint16_t constellationSize);
  static uint16_t GetUsableSubcarriers (uint16_t channelWidth);

  uint64_t m_previouslyTxPpduUid;  
  uint64_t m_currentHeTbPpduUid;   

  std::map <uint16_t /* STA-ID */, EventId> m_beginOfdmaPayloadRxEvents; 

  EndOfHeSigACallback m_endOfHeSigACallback; 

private:
  void BuildModeList (void) override;
  uint8_t GetNumberBccEncoders (const WifiTxVector& txVector) const override;
  Time GetSymbolDuration (const WifiTxVector& txVector) const override;

  static WifiMode CreateHeMcs (uint8_t index);

  static const PpduFormats m_hePpduFormats; 
}; //class HePhy

} //namespace ns3

#endif /* HE_PHY_H */