nr-mac-scheduler.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#pragma once
 
#include "nr-mac-csched-sap.h"
#include "nr-mac-sched-sap.h"
 
#include "ns3/object.h"
 
namespace ns3
{
 
class NrFhSchedSapProvider;
class NrFhSchedSapUser;
 
class NrMacScheduler : public Object
{
  public:
    static TypeId GetTypeId();
 
    NrMacScheduler();
 
    ~NrMacScheduler() override;
 
    void SetMacSchedSapUser(NrMacSchedSapUser* sap)
    {
        m_macSchedSapUser = sap;
    }
 
    NrMacSchedSapProvider* GetMacSchedSapProvider()
    {
        return m_macSchedSapProvider;
    }
 
    void SetMacCschedSapUser(NrMacCschedSapUser* sap)
    {
        m_macCschedSapUser = sap;
    }
 
    NrMacCschedSapProvider* GetMacCschedSapProvider()
    {
        return m_macCschedSapProvider;
    }
 
    // FH Control SAPs
    virtual void SetNrFhSchedSapProvider(NrFhSchedSapProvider* s) = 0;
 
    virtual NrFhSchedSapUser* GetNrFhSchedSapUser() = 0;
 
    //
    // Implementation of the CSCHED API primitives
    // (See 4.1 for description of the primitives)
    //
 
    virtual void DoCschedCellConfigReq(
        const NrMacCschedSapProvider::CschedCellConfigReqParameters& params) = 0;
 
    virtual void DoCschedUeConfigReq(
        const NrMacCschedSapProvider::CschedUeConfigReqParameters& params) = 0;
 
    virtual void DoCschedLcConfigReq(
        const NrMacCschedSapProvider::CschedLcConfigReqParameters& params) = 0;
 
    virtual void DoCschedLcReleaseReq(
        const NrMacCschedSapProvider::CschedLcReleaseReqParameters& params) = 0;
 
    virtual void DoCschedUeReleaseReq(
        const NrMacCschedSapProvider::CschedUeReleaseReqParameters& params) = 0;
 
    //
    // Implementation of the SCHED API primitives
    // (See 4.2 for description of the primitives)
    //
 
    virtual void DoSchedDlRlcBufferReq(
        const NrMacSchedSapProvider::SchedDlRlcBufferReqParameters& params) = 0;
 
    virtual void DoSchedDlCqiInfoReq(
        const NrMacSchedSapProvider::SchedDlCqiInfoReqParameters& params) = 0;
 
    virtual void DoSchedUlCqiInfoReq(
        const NrMacSchedSapProvider::SchedUlCqiInfoReqParameters& params) = 0;
 
    virtual void DoSchedUlMacCtrlInfoReq(
        const NrMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters& params) = 0;
 
    virtual void DoSchedDlTriggerReq(
        const NrMacSchedSapProvider::SchedDlTriggerReqParameters& params) = 0;
 
    virtual void DoSchedUlTriggerReq(
        const NrMacSchedSapProvider::SchedUlTriggerReqParameters& params) = 0;
 
    virtual void DoSchedUlSrInfoReq(
        const NrMacSchedSapProvider::SchedUlSrInfoReqParameters& params) = 0;
 
    virtual void DoSchedSetMcs(uint32_t mcs) = 0;
 
    virtual void DoSchedDlRachInfoReq(
        const NrMacSchedSapProvider::SchedDlRachInfoReqParameters& params) = 0;
 
    virtual uint8_t GetDlCtrlSyms() const = 0;
 
    virtual uint8_t GetUlCtrlSyms() const = 0;
 
    virtual int64_t AssignStreams(int64_t stream) = 0;
 
  protected:
    NrMacSchedSapUser* m_macSchedSapUser{nullptr};           
    NrMacCschedSapUser* m_macCschedSapUser{nullptr};         
    NrMacCschedSapProvider* m_macCschedSapProvider{nullptr}; 
    NrMacSchedSapProvider* m_macSchedSapProvider{nullptr};   
};
 
} // namespace ns3