nr-mac-sched-sap.h

// Copyright (c) 2018 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_MAC_SCHED_SAP_PROVIDER_H
#define NR_MAC_SCHED_SAP_PROVIDER_H
 
#include "nr-control-messages.h"
#include "nr-phy-mac-common.h"
 
namespace ns3
{
 
class SpectrumModel;
 
class NrMacSchedSapProvider
{
  public:
    NrMacSchedSapProvider() = default;
    NrMacSchedSapProvider(const NrMacSchedSapProvider& o) = delete;
 
    virtual ~NrMacSchedSapProvider() = default;
 
    struct SchedDlRlcBufferReqParameters
    {
        uint16_t m_rnti;                  
        uint8_t m_logicalChannelIdentity; 
        uint32_t
            m_rlcTransmissionQueueSize; 
        uint16_t m_rlcTransmissionQueueHolDelay; 
        uint32_t
            m_rlcRetransmissionQueueSize; 
        uint16_t m_rlcRetransmissionHolDelay; 
        uint16_t m_rlcStatusPduSize; 
    };
 
    struct SchedDlCqiInfoReqParameters
    {
        SfnSf m_sfnsf;                           
        std::vector<struct DlCqiInfo> m_cqiList; 
    };
 
    struct SchedUlMacCtrlInfoReqParameters
    {
        SfnSf m_sfnSf;                                
        std::vector<struct MacCeElement> m_macCeList; 
    };
 
    struct SchedUlCqiInfoReqParameters
    {
        SfnSf m_sfnSf;            
        uint8_t m_symStart;       
        struct UlCqiInfo m_ulCqi; 
    };
 
    struct SchedUlTriggerReqParameters
    {
        SfnSf m_snfSf;                                   
        std::vector<struct UlHarqInfo> m_ulHarqInfoList; 
        LteNrTddSlotType m_slotType{F};                  
    };
 
    struct SchedDlTriggerReqParameters
    {
        SfnSf m_snfSf;                                   
        std::vector<struct DlHarqInfo> m_dlHarqInfoList; 
        LteNrTddSlotType m_slotType{F};                  
    };
 
    struct SchedUlSrInfoReqParameters
    {
        SfnSf m_snfSf;                  
        std::vector<uint16_t> m_srList; 
    };
 
    struct SchedDlRachInfoReqParameters
    {
        uint16_t m_sfnSf;                                     
        std::vector<struct nr::RachListElement_s> m_rachList; 
 
        std::vector<struct nr::VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    virtual void SchedDlRlcBufferReq(const struct SchedDlRlcBufferReqParameters& params) = 0;
 
    virtual void SchedDlCqiInfoReq(const SchedDlCqiInfoReqParameters& params) = 0;
 
    virtual void SchedDlTriggerReq(const struct SchedDlTriggerReqParameters& params) = 0;
 
    virtual void SchedUlCqiInfoReq(const struct SchedUlCqiInfoReqParameters& params) = 0;
 
    virtual void SchedUlTriggerReq(const struct SchedUlTriggerReqParameters& params) = 0;
 
    virtual void SchedUlSrInfoReq(const SchedUlSrInfoReqParameters& params) = 0;
 
    virtual void SchedUlMacCtrlInfoReq(const struct SchedUlMacCtrlInfoReqParameters& params) = 0;
 
    virtual void SchedSetMcs(uint32_t mcs) = 0;
 
    virtual void SchedDlRachInfoReq(const SchedDlRachInfoReqParameters& params) = 0;
 
    virtual uint8_t GetDlCtrlSyms() const = 0;
 
    virtual uint8_t GetUlCtrlSyms() const = 0;
 
    virtual bool IsHarqReTxEnable() const = 0;
 
    virtual bool IsMaxSrsReached() const = 0;
 
  private:
};
 
class NrMacSchedSapUser
{
  public:
    virtual ~NrMacSchedSapUser() = default;
 
    struct SchedConfigIndParameters
    {
        SchedConfigIndParameters(const SfnSf sfnSf)
            : m_sfnSf(sfnSf),
              m_slotAllocInfo(sfnSf)
        {
        }
 
        const SfnSf m_sfnSf;           
        SlotAllocInfo m_slotAllocInfo; 
    };
 
    virtual void SchedConfigInd(const struct SchedConfigIndParameters& params) = 0;
 
    virtual Ptr<const SpectrumModel> GetSpectrumModel() const = 0;
 
    virtual uint32_t GetNumRbPerRbg() const = 0;
 
    virtual uint8_t GetNumHarqProcess() const = 0;
 
    virtual uint16_t GetBwpId() const = 0;
 
    virtual uint16_t GetCellId() const = 0;
 
    virtual uint32_t GetSymbolsPerSlot() const = 0;
 
    virtual Time GetSlotPeriod() const = 0;
 
    virtual void BuildRarList(SlotAllocInfo& slotAllocInfo) = 0;
};
 
inline std::ostream&
operator<<(std::ostream& os, const NrMacSchedSapProvider::SchedDlRlcBufferReqParameters& p)
{
    os << "RNTI: " << p.m_rnti << " LCId: " << static_cast<uint32_t>(p.m_logicalChannelIdentity)
       << " RLCTxQueueSize: " << p.m_rlcTransmissionQueueSize
       << " B, RLCTXHolDel: " << p.m_rlcTransmissionQueueHolDelay
       << " ms, RLCReTXQueueSize: " << p.m_rlcRetransmissionQueueSize
       << " B, RLCReTXHolDel: " << p.m_rlcRetransmissionHolDelay
       << " ms, RLCStatusPduSize: " << p.m_rlcStatusPduSize << " B.";
    return os;
}
 
} // namespace ns3
 
#endif /* NR_MAC_SCHED_SAP_PROVIDER_H */