nr-amc.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_AMC_H
#define NR_AMC_H
 
#include "nr-error-model.h"
#include "nr-phy-mac-common.h"
 
namespace ns3
{
 
class NrAmc : public Object
{
  public:
    static TypeId GetTypeId();
 
    NrAmc();
 
    ~NrAmc() override;
 
    void SetDlMode();
 
    void SetUlMode();
 
    enum AmcModel
    {
        ShannonModel, 
        ErrorModel    
    };
 
    uint8_t GetMcsFromCqi(uint8_t cqi) const;
 
    uint8_t GetNumRefScPerRb() const;
 
    void SetNumRefScPerRb(uint8_t nref);
 
    uint8_t CreateCqiFeedbackSiso(const SpectrumValue& sinr, uint8_t& mcsWb) const;
 
    uint8_t GetCqiFromSpectralEfficiency(double s) const;
 
    uint8_t GetMcsFromSpectralEfficiency(double s) const;
 
    uint32_t GetMaxMcs() const;
 
    void SetAmcModel(AmcModel m);
    AmcModel GetAmcModel() const;
 
    void SetErrorModelType(const TypeId& type);
    TypeId GetErrorModelType() const;
 
    uint32_t CalculateTbSize(uint8_t mcs, uint8_t rank, uint32_t nprb) const;
 
    uint32_t GetPayloadSize(uint8_t mcs, uint8_t rank, uint32_t nprb) const;
 
    static constexpr size_t NR_AMC_NUM_SYMBOLS_DEFAULT = 12; 
 
    struct McsParams
    {
        uint8_t mcs{};                 
        uint8_t wbCqi{};               
        std::vector<uint8_t> sbCqis{}; 
        uint32_t tbSize{};             
    };
 
    McsParams GetMaxMcsParams(const NrSinrMatrix& sinrMat, size_t subbandSize) const;
 
    std::vector<uint8_t> GetSbMcs(const size_t subbandSize, const NrSinrMatrix& sinrMat) const;
 
    uint8_t GetMcs(const NrSinrMatrix& sinrMat) const;
 
    NrSinrMatrix CreateSinrMatForSb(const NrSinrMatrix& avgSinrSb,
                                    const NrSinrMatrix& sinrMat) const;
 
    NrSinrMatrix ExtractSbFromMat(const uint8_t sbIndex,
                                  const size_t subbandSize,
                                  const NrSinrMatrix& sinrMat) const;
 
    double GetSpectralEfficiencyForCqi(uint8_t cqi) const
    {
        return m_errorModel->GetSpectralEfficiencyForCqi(cqi);
    }
 
    double GetSpectralEfficiencyForSinr(double sinr) const;
 
    double GetSinrFromSpectralEfficiency(double spectralEff) const;
 
  private:
    uint8_t GetMaxMcsForErrorModel(const NrSinrMatrix& sinrMat) const;
 
    uint8_t GetWbCqiFromMcs(uint8_t mcs) const;
 
    uint32_t CalcTbSizeForMimoMatrix(uint8_t mcs, const NrSinrMatrix& sinrMat) const;
 
    double CalcTblerForMimoMatrix(uint8_t mcs, const NrSinrMatrix& sinrMat) const;
 
    double GetBer() const;
 
  private:
    AmcModel m_amcModel;                           
    Ptr<NrErrorModel> m_errorModel;                
    TypeId m_errorModelType;                       
    uint8_t m_numRefScPerRb{1};                    
    NrErrorModel::Mode m_emMode{NrErrorModel::DL}; 
    static const unsigned int m_crcLen = 24 / 8;   
    mutable std::unordered_map<uint8_t, uint8_t> m_cachedCqiToMcsMap; 
};
 
} // end namespace ns3
 
#endif /* NR_AMC_H */