nr-control-messages.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef SRC_NR_MODEL_NR_CONTROL_MESSAGES_H_
#define SRC_NR_MODEL_NR_CONTROL_MESSAGES_H_
 
#include "nr-phy-mac-common.h"
 
#include <ns3/ff-mac-common.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/simple-ref-count.h>
 
namespace ns3
{
 
enum LteNrTddSlotType : uint8_t
{
    DL = 0, 
    S = 1,  
    F = 2,  
    UL = 3, 
};
 
std::ostream& operator<<(std::ostream& os, const LteNrTddSlotType& item);
 
class NrControlMessage : public SimpleRefCount<NrControlMessage>
{
  public:
    enum messageType
    {
        UL_DCI,        
        DL_DCI,        
        DL_CQI,        
        MIB,           
        SIB1,          
        RACH_PREAMBLE, 
        RAR,           
        BSR,           
        DL_HARQ,       
        SR,            
        SRS,           
    };
 
    NrControlMessage();
    virtual ~NrControlMessage();
 
    messageType GetMessageType() const;
 
    void SetSourceBwp(uint16_t bwpId);
 
    uint16_t GetSourceBwp() const;
 
  protected:
    void SetMessageType(messageType type);
 
  private:
    messageType m_messageType; 
    int32_t m_bwpId{-1};       
};
 
class NrSRMessage : public NrControlMessage
{
  public:
    NrSRMessage();
    ~NrSRMessage() override;
 
    void SetRNTI(uint16_t rnti);
 
    uint16_t GetRNTI() const;
 
  private:
    uint16_t m_rnti{0}; 
};
 
class NrDlDciMessage : public NrControlMessage
{
  public:
    NrDlDciMessage(const std::shared_ptr<DciInfoElementTdma>& dci);
    ~NrDlDciMessage() override;
 
    std::shared_ptr<DciInfoElementTdma> GetDciInfoElement();
 
    void SetKDelay(uint32_t delay);
    uint32_t GetKDelay() const;
 
    void SetK1Delay(uint32_t delay);
    uint32_t GetK1Delay() const;
 
  private:
    uint32_t m_k; 
    uint32_t m_k1; 
    std::shared_ptr<DciInfoElementTdma> m_dciInfoElement;
};
 
class NrUlDciMessage : public NrControlMessage
{
  public:
    NrUlDciMessage(const std::shared_ptr<DciInfoElementTdma>& dci);
    ~NrUlDciMessage() override;
 
    std::shared_ptr<DciInfoElementTdma> GetDciInfoElement();
 
    void SetKDelay(uint32_t delay);
    uint32_t GetKDelay() const;
 
  private:
    uint32_t m_k; 
    std::shared_ptr<DciInfoElementTdma> m_dciInfoElement; 
};
 
class NrDlCqiMessage : public NrControlMessage
{
  public:
    NrDlCqiMessage();
    ~NrDlCqiMessage() override;
 
    void SetDlCqi(DlCqiInfo cqi);
    DlCqiInfo GetDlCqi();
 
  private:
    DlCqiInfo m_cqi; 
};
 
class NrBsrMessage : public NrControlMessage
{
  public:
    NrBsrMessage();
    ~NrBsrMessage() override;
 
    void SetBsr(MacCeElement bsr);
 
    MacCeElement GetBsr();
 
  private:
    MacCeElement m_bsr; 
};
 
// ---------------------------------------------------------------------------
 
class NrMibMessage : public NrControlMessage
{
  public:
    NrMibMessage();
 
    void SetMib(LteRrcSap::MasterInformationBlock mib);
 
    LteRrcSap::MasterInformationBlock GetMib() const;
 
  private:
    LteRrcSap::MasterInformationBlock m_mib; 
};
 
// ---------------------------------------------------------------------------
 
class NrSib1Message : public NrControlMessage
{
  public:
    NrSib1Message();
 
    void SetSib1(LteRrcSap::SystemInformationBlockType1 sib1);
 
    LteRrcSap::SystemInformationBlockType1 GetSib1() const;
 
  private:
    LteRrcSap::SystemInformationBlockType1 m_sib1; 
};
 
// ---------------------------------------------------------------------------
 
class NrRachPreambleMessage : public NrControlMessage
{
  public:
    NrRachPreambleMessage();
 
    ~NrRachPreambleMessage() override;
 
    void SetRapId(uint32_t rapid);
 
    uint32_t GetRapId() const;
 
  private:
    uint32_t m_rapId; 
};
 
// ---------------------------------------------------------------------------
 
class NrRarMessage : public NrControlMessage
{
  public:
    NrRarMessage();
 
    ~NrRarMessage() override;
 
    void SetRaRnti(uint16_t raRnti);
 
    uint16_t GetRaRnti() const;
 
    struct Rar
    {
        uint8_t rapId;                    
        BuildRarListElement_s rarPayload; 
    };
 
    void AddRar(Rar rar);
 
    std::list<Rar>::const_iterator RarListBegin() const;
 
    std::list<Rar>::const_iterator RarListEnd() const;
 
  private:
    std::list<Rar> m_rarList; 
    uint16_t m_raRnti;        
};
 
class NrDlHarqFeedbackMessage : public NrControlMessage
{
  public:
    NrDlHarqFeedbackMessage();
    ~NrDlHarqFeedbackMessage() override;
 
    void SetDlHarqFeedback(DlHarqInfo m);
 
    DlHarqInfo GetDlHarqFeedback();
 
  private:
    DlHarqInfo m_dlHarqInfo; 
};
 
class NrSrsMessage : public NrControlMessage
{
  public:
    NrSrsMessage();
    ~NrSrsMessage() override = default;
};
 
} // namespace ns3
 
#endif /* SRC_NR_MODEL_NR_CONTROL_MESSAGES_H_ */