nr-phy-sap.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NR_PHY_SAP_H
#define NR_PHY_SAP_H
 
#include "beam-id.h"
#include "nr-control-messages.h"
#include "nr-mac-sched-sap.h"
#include "nr-phy-mac-common.h"
 
#include <ns3/packet-burst.h>
 
namespace ns3
{
 
class NrControlMessage;
 
class NrPhySapProvider
{
  public:
    virtual ~NrPhySapProvider() = default;
 
    virtual void SendMacPdu(const Ptr<Packet>& p,
                            const SfnSf& sfn,
                            uint8_t symStart,
                            uint16_t rnti) = 0;
 
    virtual void SendControlMessage(Ptr<NrControlMessage> msg) = 0;
 
    virtual void SendRachPreamble(uint8_t PreambleId, uint8_t Rnti) = 0;
 
    virtual void SetSlotAllocInfo(const SlotAllocInfo& slotAllocInfo) = 0;
 
    virtual void NotifyConnectionSuccessful() = 0;
 
    virtual BeamId GetBeamId(uint8_t rnti) const = 0;
 
    virtual Ptr<const SpectrumModel> GetSpectrumModel() = 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 uint32_t GetRbNum() const = 0;
};
 
class NrGnbPhySapUser
{
  public:
    virtual ~NrGnbPhySapUser() = default;
 
    virtual void ReceivePhyPdu(Ptr<Packet> p) = 0;
 
    virtual void ReceiveControlMessage(Ptr<NrControlMessage> msg) = 0;
 
    virtual void SetCurrentSfn(const SfnSf& sfn) = 0;
 
    virtual void SlotDlIndication(const SfnSf& sfn, LteNrTddSlotType slotType) = 0;
 
    virtual void SlotUlIndication(const SfnSf& sfn, LteNrTddSlotType slotType) = 0;
 
    // We do a DL and then manually add an UL CTRL if it's an S slot.
    // virtual void SlotSIndication (const SfnSf &sfn) = 0;
    // We do UL and then DL to model an F slot.
    // virtual void SlotFIndication (const SfnSf &sfn) = 0;
 
    virtual void UlCqiReport(NrMacSchedSapProvider::SchedUlCqiInfoReqParameters ulcqi) = 0;
 
    virtual void ReceiveRachPreamble(uint32_t raId) = 0;
 
    virtual void UlHarqFeedback(UlHarqInfo params) = 0;
 
    virtual void BeamChangeReport(BeamId beamId, uint8_t rnti) = 0;
 
    virtual uint32_t GetNumRbPerRbg() const = 0;
 
    virtual std::shared_ptr<DciInfoElementTdma> GetDlCtrlDci() const = 0;
 
    virtual std::shared_ptr<DciInfoElementTdma> GetUlCtrlDci() const = 0;
 
    virtual uint8_t GetDlCtrlSymbols() const = 0;
};
 
class NrUePhySapUser
{
  public:
    virtual ~NrUePhySapUser()
    {
    }
 
    virtual void ReceivePhyPdu(Ptr<Packet> p) = 0;
 
    virtual void ReceiveControlMessage(Ptr<NrControlMessage> msg) = 0;
 
    virtual void SlotIndication(SfnSf s) = 0;
 
    virtual uint8_t GetNumHarqProcess() const = 0;
};
 
} // namespace ns3
 
#endif /* NR_PHY_SAP_H */