he-ppdu.h

Go to the documentation of this file.

/*
 * 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
 *
 * Author: Rediet <getachew.redieteab@orange.com>
 *         Muhammad Iqbal Rochman <muhiqbalcr@uchicago.edu>
 *         Sébastien Deronne <sebastien.deronne@gmail.com> (HeSigHeader)
 */
 
#ifndef HE_PPDU_H
#define HE_PPDU_H
 
#include "ns3/ofdm-ppdu.h"
 
namespace ns3
{
 
class WifiPsdu;
 
class HePpdu : public OfdmPpdu
{
  public:
    class HeSigHeader : public Header
    {
      public:
        HeSigHeader();
 
        static TypeId GetTypeId();
 
        TypeId GetInstanceTypeId() const override;
        void Print(std::ostream& os) const override;
        uint32_t GetSerializedSize() const override;
        void Serialize(Buffer::Iterator start) const override;
        uint32_t Deserialize(Buffer::Iterator start) override;
 
        void SetMuFlag(bool mu);
 
        void SetMcs(uint8_t mcs);
        uint8_t GetMcs() const;
        void SetBssColor(uint8_t bssColor);
        uint8_t GetBssColor() const;
        void SetChannelWidth(uint16_t channelWidth);
        uint16_t GetChannelWidth() const;
        void SetGuardIntervalAndLtfSize(uint16_t gi, uint8_t ltf);
        uint16_t GetGuardInterval() const;
        void SetNStreams(uint8_t nStreams);
        uint8_t GetNStreams() const;
 
      private:
        // HE-SIG-A1 fields
        uint8_t m_format;       
        uint8_t m_bssColor;     
        uint8_t m_ul_dl;        
        uint8_t m_mcs;          
        uint8_t m_spatialReuse; 
        uint8_t m_bandwidth;    
        uint8_t m_gi_ltf_size;  
        uint8_t m_nsts;         
 
        bool m_mu;
    }; // class HeSigHeader
 
    enum TxPsdFlag
    {
        PSD_NON_HE_PORTION, 
        PSD_HE_PORTION      
    };
 
    HePpdu(Ptr<const WifiPsdu> psdu,
           const WifiTxVector& txVector,
           uint16_t txCenterFreq,
           Time ppduDuration,
           WifiPhyBand band,
           uint64_t uid);
    HePpdu(const WifiConstPsduMap& psdus,
           const WifiTxVector& txVector,
           uint16_t txCenterFreq,
           Time ppduDuration,
           WifiPhyBand band,
           uint64_t uid,
           TxPsdFlag flag);
 
    Time GetTxDuration() const override;
    Ptr<WifiPpdu> Copy() const override;
    WifiPpduType GetType() const override;
    uint16_t GetStaId() const override;
    uint16_t GetTransmissionChannelWidth() const override;
 
    Ptr<const WifiPsdu> GetPsdu(uint8_t bssColor, uint16_t staId = SU_STA_ID) const;
 
    TxPsdFlag GetTxPsdFlag() const;
 
    void SetTxPsdFlag(TxPsdFlag flag) const;
 
    void UpdateTxVectorForUlMu(const std::optional<WifiTxVector>& trigVector) const;
 
    bool IsStaInContentChannel(uint16_t staId, size_t channelId) const;
 
    bool IsAllocated(uint16_t staId) const;
 
  protected:
    virtual void SetTxVectorFromPhyHeaders(WifiTxVector& txVector,
                                           const LSigHeader& lSig,
                                           const HeSigHeader& heSig) const;
 
#ifndef NS3_BUILD_PROFILE_DEBUG
    HeSigHeader m_heSig; 
#endif
    mutable TxPsdFlag m_txPsdFlag; 
 
    WifiTxVector::HeMuUserInfoMap m_muUserInfos; 
    ContentChannelAllocation
        m_contentChannelAlloc; 
    RuAllocation m_ruAllocation; 
 
  private:
    std::string PrintPayload() const override;
    WifiTxVector DoGetTxVector() const override;
 
    virtual bool IsMu() const;
 
    virtual bool IsDlMu() const;
 
    virtual bool IsUlMu() const;
 
    virtual void SetPhyHeaders(const WifiTxVector& txVector, Time ppduDuration);
 
    virtual void SetLSigHeader(LSigHeader& lSig, Time ppduDuration) const;
 
    void SetHeSigHeader(HeSigHeader& heSig, const WifiTxVector& txVector) const;
}; // class HePpdu
 
std::ostream& operator<<(std::ostream& os, const HePpdu::TxPsdFlag& flag);
 
} // namespace ns3
 
#endif /* HE_PPDU_H */