nr-rlc.h

// Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Nicola Baldo <nbaldo@cttc.es>
 
#ifndef NR_RLC_H
#define NR_RLC_H
 
#include "nr-mac-sap.h"
#include "nr-rlc-sap.h"
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/packet.h"
#include "ns3/simple-ref-count.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/traced-value.h"
#include "ns3/uinteger.h"
 
namespace ns3
{
 
// class NrRlcSapProvider;
// class NrRlcSapUser;
//
// class NrMacSapProvider;
// class NrMacSapUser;
 
class NrRlc : public Object // SimpleRefCount<NrRlc>
{
    friend class NrRlcSpecificNrMacSapUser;
    friend class NrRlcSpecificNrRlcSapProvider<NrRlc>;
 
  public:
    NrRlc();
    ~NrRlc() override;
    static TypeId GetTypeId();
    void DoDispose() override;
 
    void SetRnti(uint16_t rnti);
 
    void SetLcId(uint8_t lcId);
 
    void SetPacketDelayBudgetMs(uint16_t packetDelayBudget);
 
    void SetNrRlcSapUser(NrRlcSapUser* s);
 
    NrRlcSapProvider* GetNrRlcSapProvider();
 
    void SetNrMacSapProvider(NrMacSapProvider* s);
 
    NrMacSapUser* GetNrMacSapUser();
 
    typedef void (*NotifyTxTracedCallback)(uint16_t rnti, uint8_t lcid, uint32_t bytes);
 
    typedef void (*ReceiveTracedCallback)(uint16_t rnti,
                                          uint8_t lcid,
                                          uint32_t bytes,
                                          uint64_t delay);
 
    // NB to avoid the use of multiple inheritance
 
  protected:
    // Interface forwarded by NrRlcSapProvider
    virtual void DoTransmitPdcpPdu(Ptr<Packet> p) = 0;
 
    NrRlcSapUser* m_rlcSapUser;         
    NrRlcSapProvider* m_rlcSapProvider; 
 
    // Interface forwarded by NrMacSapUser
    virtual void DoNotifyTxOpportunity(NrMacSapUser::TxOpportunityParameters params) = 0;
    virtual void DoNotifyHarqDeliveryFailure() = 0;
    virtual void DoReceivePdu(NrMacSapUser::ReceivePduParameters params) = 0;
 
    NrMacSapUser* m_macSapUser;         
    NrMacSapProvider* m_macSapProvider; 
 
    uint16_t m_rnti; 
    uint8_t m_lcid;  
    uint16_t m_packetDelayBudgetMs{
        UINT16_MAX}; 
 
    TracedCallback<uint16_t, uint8_t, uint32_t> m_txPdu;
    TracedCallback<uint16_t, uint8_t, uint32_t, uint64_t> m_rxPdu;
    TracedCallback<Ptr<const Packet>> m_txDropTrace;
};
 
class NrRlcSm : public NrRlc
{
  public:
    NrRlcSm();
    ~NrRlcSm() override;
    static TypeId GetTypeId();
    void DoInitialize() override;
    void DoDispose() override;
 
    void DoTransmitPdcpPdu(Ptr<Packet> p) override;
    void DoNotifyTxOpportunity(NrMacSapUser::TxOpportunityParameters txOpParams) override;
    void DoNotifyHarqDeliveryFailure() override;
    void DoReceivePdu(NrMacSapUser::ReceivePduParameters rxPduParams) override;
 
  private:
    void BufferStatusReport();
};
 
// /**
//  * Implements NR_RLC Transparent Mode (TM), see  3GPP TS 36.322
//  *
//  */
// class NrRlcTm : public NrRlc
// {
// public:
//   virtual ~NrRlcTm ();
 
// };
 
// /**
//  * Implements NR_RLC Unacknowledged Mode (UM), see  3GPP TS 36.322
//  *
//  */
// class NrRlcUm : public NrRlc
// {
// public:
//   virtual ~NrRlcUm ();
 
// };
 
// /**
//  * Implements NR_RLC Acknowledged Mode (AM), see  3GPP TS 36.322
//  *
//  */
 
// class NrRlcAm : public NrRlc
// {
// public:
//   virtual ~NrRlcAm ();
// };
 
} // namespace ns3
 
#endif // NR_RLC_H