ff-mac-sched-sap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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: Manuel Requena <manuel.requena@cttc.es>
 */
 
#ifndef FF_MAC_SCHED_SAP_H
#define FF_MAC_SCHED_SAP_H
 
#include "ff-mac-common.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class FfMacSchedSapProvider
{
  public:
    virtual ~FfMacSchedSapProvider();
 
    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;             
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedDlPagingBufferReqParameters
    {
        uint16_t m_rnti;                                              
        std::vector<struct PagingInfoListElement_s> m_pagingInfoList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedDlMacBufferReqParameters
    {
        uint16_t m_rnti;            
        enum CeBitmap_e m_ceBitmap; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedDlTriggerReqParameters
    {
        uint16_t m_sfnSf;                                     
        std::vector<struct DlInfoListElement_s> m_dlInfoList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedDlRachInfoReqParameters
    {
        uint16_t m_sfnSf;                                 
        std::vector<struct RachListElement_s> m_rachList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedDlCqiInfoReqParameters
    {
        uint16_t m_sfnSf;                               
        std::vector<struct CqiListElement_s> m_cqiList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlTriggerReqParameters
    {
        uint16_t m_sfnSf;                                     
        std::vector<struct UlInfoListElement_s> m_ulInfoList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlNoiseInterferenceReqParameters
    {
        uint16_t m_sfnSf; 
        uint16_t m_rip;   
        uint16_t m_tnp;   
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlSrInfoReqParameters
    {
        uint16_t m_sfnSf;                             
        std::vector<struct SrListElement_s> m_srList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlMacCtrlInfoReqParameters
    {
        uint16_t m_sfnSf;                                   
        std::vector<struct MacCeListElement_s> m_macCeList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlCqiInfoReqParameters
    {
        uint16_t m_sfnSf;       
        struct UlCqi_s m_ulCqi; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    //
    // SCHED - MAC Scheduler SAP primitives
    // (See 4.2 for description of the primitives)
    //
 
    virtual void SchedDlRlcBufferReq(const struct SchedDlRlcBufferReqParameters& params) = 0;
 
    virtual void SchedDlPagingBufferReq(const struct SchedDlPagingBufferReqParameters& params) = 0;
 
    virtual void SchedDlMacBufferReq(const struct SchedDlMacBufferReqParameters& params) = 0;
 
    virtual void SchedDlTriggerReq(const struct SchedDlTriggerReqParameters& params) = 0;
 
    virtual void SchedDlRachInfoReq(const struct SchedDlRachInfoReqParameters& params) = 0;
 
    virtual void SchedDlCqiInfoReq(const struct SchedDlCqiInfoReqParameters& params) = 0;
 
    virtual void SchedUlTriggerReq(const struct SchedUlTriggerReqParameters& params) = 0;
 
    virtual void SchedUlNoiseInterferenceReq(
        const struct SchedUlNoiseInterferenceReqParameters& params) = 0;
 
    virtual void SchedUlSrInfoReq(const struct SchedUlSrInfoReqParameters& params) = 0;
 
    virtual void SchedUlMacCtrlInfoReq(const struct SchedUlMacCtrlInfoReqParameters& params) = 0;
 
    virtual void SchedUlCqiInfoReq(const struct SchedUlCqiInfoReqParameters& params) = 0;
 
  private:
};
 
class FfMacSchedSapUser
{
  public:
    virtual ~FfMacSchedSapUser();
 
    struct SchedDlConfigIndParameters
    {
        std::vector<struct BuildDataListElement_s> m_buildDataList; 
        std::vector<struct BuildRarListElement_s> m_buildRarList;   
        std::vector<struct BuildBroadcastListElement_s>
            m_buildBroadcastList; 
 
        uint8_t m_nrOfPdcchOfdmSymbols; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    struct SchedUlConfigIndParameters
    {
        std::vector<struct UlDciListElement_s> m_dciList;   
        std::vector<struct PhichListElement_s> m_phichList; 
 
        std::vector<struct VendorSpecificListElement_s>
            m_vendorSpecificList; 
    };
 
    //
    // SCHED - MAC Scheduler SAP primitives
    // (See 4.2 for description of the primitives)
    //
 
    virtual void SchedDlConfigInd(const struct SchedDlConfigIndParameters& params) = 0;
 
    virtual void SchedUlConfigInd(const struct SchedUlConfigIndParameters& params) = 0;
 
  private:
};
 
template <class C>
class MemberSchedSapProvider : public FfMacSchedSapProvider
{
  public:
    MemberSchedSapProvider(C* scheduler);
 
    // Delete default constructor to avoid misuse
    MemberSchedSapProvider() = delete;
 
    // inherited from FfMacSchedSapProvider
    void SchedDlRlcBufferReq(const struct SchedDlRlcBufferReqParameters& params) override;
    void SchedDlPagingBufferReq(const struct SchedDlPagingBufferReqParameters& params) override;
    void SchedDlMacBufferReq(const struct SchedDlMacBufferReqParameters& params) override;
    void SchedDlTriggerReq(const struct SchedDlTriggerReqParameters& params) override;
    void SchedDlRachInfoReq(const struct SchedDlRachInfoReqParameters& params) override;
    void SchedDlCqiInfoReq(const struct SchedDlCqiInfoReqParameters& params) override;
    void SchedUlTriggerReq(const struct SchedUlTriggerReqParameters& params) override;
    void SchedUlNoiseInterferenceReq(
        const struct SchedUlNoiseInterferenceReqParameters& params) override;
    void SchedUlSrInfoReq(const struct SchedUlSrInfoReqParameters& params) override;
    void SchedUlMacCtrlInfoReq(const struct SchedUlMacCtrlInfoReqParameters& params) override;
    void SchedUlCqiInfoReq(const struct SchedUlCqiInfoReqParameters& params) override;
 
  private:
    C* m_scheduler; 
};
 
template <class C>
MemberSchedSapProvider<C>::MemberSchedSapProvider(C* scheduler)
    : m_scheduler(scheduler)
{
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlRlcBufferReq(const struct SchedDlRlcBufferReqParameters& params)
{
    m_scheduler->DoSchedDlRlcBufferReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlPagingBufferReq(
    const struct SchedDlPagingBufferReqParameters& params)
{
    m_scheduler->DoSchedDlPagingBufferReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlMacBufferReq(const struct SchedDlMacBufferReqParameters& params)
{
    m_scheduler->DoSchedDlMacBufferReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlTriggerReq(const struct SchedDlTriggerReqParameters& params)
{
    m_scheduler->DoSchedDlTriggerReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlRachInfoReq(const struct SchedDlRachInfoReqParameters& params)
{
    m_scheduler->DoSchedDlRachInfoReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedDlCqiInfoReq(const struct SchedDlCqiInfoReqParameters& params)
{
    m_scheduler->DoSchedDlCqiInfoReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedUlTriggerReq(const struct SchedUlTriggerReqParameters& params)
{
    m_scheduler->DoSchedUlTriggerReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedUlNoiseInterferenceReq(
    const struct SchedUlNoiseInterferenceReqParameters& params)
{
    m_scheduler->DoSchedUlNoiseInterferenceReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedUlSrInfoReq(const struct SchedUlSrInfoReqParameters& params)
{
    m_scheduler->DoSchedUlSrInfoReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedUlMacCtrlInfoReq(
    const struct SchedUlMacCtrlInfoReqParameters& params)
{
    m_scheduler->DoSchedUlMacCtrlInfoReq(params);
}
 
template <class C>
void
MemberSchedSapProvider<C>::SchedUlCqiInfoReq(const struct SchedUlCqiInfoReqParameters& params)
{
    m_scheduler->DoSchedUlCqiInfoReq(params);
}
 
} // namespace ns3
 
#endif /* FF_MAC_SCHED_SAP_H */