nr-mac-csched-sap.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_MAC_CSCHED_SAP_H
#define NR_MAC_CSCHED_SAP_H
 
#include "beam-id.h"
#include "nr-phy-mac-common.h"
 
#include <vector>
 
namespace ns3
{
 
class NrMacCschedSapProvider
{
  public:
    virtual ~NrMacCschedSapProvider()
    {
    }
 
    enum class NormalExtended_e
    {
        normal,
        extended
    };
 
    struct CschedCellConfigReqParameters
    {
        uint8_t m_puschHoppingOffset;
 
        enum HoppingMode_e
        {
            inter,
            interintra
        } m_hoppingMode;
 
        uint8_t m_nSb;
 
        enum PhichResource_e
        {
            PHICH_R_ONE_SIXTH,
            PHICH_R_HALF,
            PHICH_R_ONE,
            PHICH_R_TWO
        } m_phichResource;
 
        NormalExtended_e m_phichDuration;
 
        uint8_t m_initialNrOfPdcchOfdmSymbols;
 
        uint16_t m_ulBandwidth; 
        uint16_t m_dlBandwidth; 
 
        NormalExtended_e m_ulCyclicPrefixLength;
        NormalExtended_e m_dlCyclicPrefixLength;
 
        uint8_t m_antennaPortsCount;
 
        enum DuplexMode_e
        {
            DM_TDD,
            DM_FDD
        } m_duplexMode;
 
        uint8_t m_subframeAssignment;
        uint8_t m_specialSubframePatterns;
        std::vector<uint8_t> m_mbsfnSubframeConfigRfPeriod;
        std::vector<uint8_t> m_mbsfnSubframeConfigRfOffset;
        std::vector<uint8_t> m_mbsfnSubframeConfigSfAllocation;
        uint8_t m_prachConfigurationIndex;
        uint8_t m_prachFreqOffset;
        uint8_t m_raResponseWindowSize;
        uint8_t m_macContentionResolutionTimer;
        uint8_t m_maxHarqMsg3Tx;
        uint16_t m_n1PucchAn;
        uint8_t m_deltaPucchShift;
        uint8_t m_nrbCqi;
        uint8_t m_ncsAn;
        uint8_t m_srsSubframeConfiguration;
        uint8_t m_srsSubframeOffset;
        uint8_t m_srsBandwidthConfiguration;
        bool m_srsMaxUpPts;
 
        enum Enable64Qam_e
        {
            MOD_16QAM,
            MOD_64QAM
        } m_enable64Qam;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedUeConfigReqParameters
    {
        uint16_t m_rnti;
        BeamId m_beamId; 
        bool m_reconfigureFlag;
        uint16_t m_timeAlignmentTimer;
 
        enum MeasGapConfigPattern_e
        {
            MGP_GP1,
            MGP_GP2,
            OFF
        } m_measGapConfigPattern;
 
        uint8_t m_measGapConfigSubframeOffset;
        uint8_t m_transmissionMode;
        uint64_t m_ueAggregatedMaximumBitrateUl;
        uint64_t m_ueAggregatedMaximumBitrateDl;
 
        enum OpenClosedLoop_e
        {
            noneloop,
            openloop,
            closedloop
        } m_ueTransmitAntennaSelection;
 
        bool m_ttiBundling;
        uint8_t m_maxHarqTx;
        uint8_t m_betaOffsetAckIndex;
        uint8_t m_betaOffsetRiIndex;
        uint8_t m_betaOffsetCqiIndex;
        bool m_ackNackSrsSimultaneousTransmission;
        bool m_simultaneousAckNackAndCqi;
 
        enum RepMode_e
        {
            rm12,
            rm20,
            rm22,
            rm30,
            rm31,
            nonemode
        } m_aperiodicCqiRepMode;
 
        enum FeedbackMode_e
        {
            bundling,
            multiplexing
        } m_tddAckNackFeedbackMode;
 
        uint8_t m_ackNackRepetitionFactor;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedLcConfigReqParameters
    {
        uint16_t m_rnti;
        bool m_reconfigureFlag;
 
        std::vector<struct nr::LogicalChannelConfigListElement_s> m_logicalChannelConfigList;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedLcReleaseReqParameters
    {
        uint16_t m_rnti;
 
        std::vector<uint8_t> m_logicalChannelIdentity;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedUeReleaseReqParameters
    {
        uint16_t m_rnti;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    //
    // CSCHED - MAC Scheduler Control SAP primitives
    // (See 4.1 for description of the primitives)
    //
 
    virtual void CschedCellConfigReq(const struct CschedCellConfigReqParameters& params) = 0;
 
    virtual void CschedUeConfigReq(const struct CschedUeConfigReqParameters& params) = 0;
 
    virtual void CschedLcConfigReq(const struct CschedLcConfigReqParameters& params) = 0;
 
    virtual void CschedLcReleaseReq(const struct CschedLcReleaseReqParameters& params) = 0;
 
    virtual void CschedUeReleaseReq(const struct CschedUeReleaseReqParameters& params) = 0;
 
  private:
};
 
class NrMacCschedSapUser
{
  public:
    virtual ~NrMacCschedSapUser()
    {
    }
 
    enum class Result_e
    {
        SUCCESS,
        FAILURE
    };
 
    struct CschedCellConfigCnfParameters
    {
        Result_e m_result;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedUeConfigCnfParameters
    {
        uint16_t m_rnti;
        Result_e m_result;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedLcConfigCnfParameters
    {
        uint16_t m_rnti;
        Result_e m_result;
 
        std::vector<uint8_t> m_logicalChannelIdentity;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedLcReleaseCnfParameters
    {
        uint16_t m_rnti;
        Result_e m_result;
 
        std::vector<uint8_t> m_logicalChannelIdentity;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedUeReleaseCnfParameters
    {
        uint16_t m_rnti;
        Result_e m_result;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedUeConfigUpdateIndParameters
    {
        uint16_t m_rnti;
        uint8_t m_transmissionMode;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    struct CschedCellConfigUpdateIndParameters
    {
        uint8_t m_prbUtilizationDl;
        uint8_t m_prbUtilizationUl;
 
        std::vector<struct nr::VendorSpecificListElement_s> m_vendorSpecificList;
    };
 
    //
    // CSCHED - MAC Scheduler Control SAP primitives
    // (See 4.1 for description of the primitives)
    //
 
    virtual void CschedCellConfigCnf(const struct CschedCellConfigCnfParameters& params) = 0;
 
    virtual void CschedUeConfigCnf(const struct CschedUeConfigCnfParameters& params) = 0;
 
    virtual void CschedLcConfigCnf(const struct CschedLcConfigCnfParameters& params) = 0;
 
    virtual void CschedLcReleaseCnf(const struct CschedLcReleaseCnfParameters& params) = 0;
 
    virtual void CschedUeReleaseCnf(const struct CschedUeReleaseCnfParameters& params) = 0;
 
    virtual void CschedUeConfigUpdateInd(
        const struct CschedUeConfigUpdateIndParameters& params) = 0;
 
    virtual void CschedCellConfigUpdateInd(
        const struct CschedCellConfigUpdateIndParameters& params) = 0;
 
  private:
};
 
} // end namespace ns3
 
#endif /* NR_MAC_CSCHED_SAP_H */