nr-epc-s1ap-sap.h

// Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Nicola Baldo <nbaldo@cttc.cat>
 
#ifndef NR_EPC_S1AP_SAP_H
#define NR_EPC_S1AP_SAP_H
 
#include "nr-eps-bearer.h"
 
#include "ns3/address.h"
#include "ns3/ipv4-address.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <list>
 
namespace ns3
{
 
class NrEpcS1apSap
{
  public:
    virtual ~NrEpcS1apSap() = default;
};
 
class NrEpcS1apSapMme : public NrEpcS1apSap
{
  public:
    virtual void InitialUeMessage(uint64_t mmeUeS1Id,
                                  uint16_t gnbUeS1Id,
                                  uint64_t stmsi,
                                  uint16_t ecgi) = 0;
 
    struct ErabToBeReleasedIndication
    {
        uint8_t erabId; 
    };
 
    virtual void ErabReleaseIndication(
        uint64_t mmeUeS1Id,
        uint16_t gnbUeS1Id,
        std::list<ErabToBeReleasedIndication> erabToBeReleaseIndication) = 0;
 
    struct ErabSetupItem
    {
        uint16_t erabId;                      
        Ipv4Address gnbTransportLayerAddress; 
        uint32_t gnbTeid;                     
    };
 
    virtual void InitialContextSetupResponse(uint64_t mmeUeS1Id,
                                             uint16_t gnbUeS1Id,
                                             std::list<ErabSetupItem> erabSetupList) = 0;
 
    struct ErabSwitchedInDownlinkItem
    {
        uint16_t erabId;                      
        Ipv4Address gnbTransportLayerAddress; 
        uint32_t gnbTeid;                     
    };
 
    virtual void PathSwitchRequest(
        uint64_t gnbUeS1Id,
        uint64_t mmeUeS1Id,
        uint16_t gci,
        std::list<ErabSwitchedInDownlinkItem> erabToBeSwitchedInDownlinkList) = 0;
};
 
class NrEpcS1apSapGnb : public NrEpcS1apSap
{
  public:
    struct ErabToBeSetupItem
    {
        uint8_t erabId;                     
        NrEpsBearer erabLevelQosParameters; 
        Ipv4Address transportLayerAddress;  
        uint32_t sgwTeid;                   
    };
 
    virtual void InitialContextSetupRequest(uint64_t mmeUeS1Id,
                                            uint16_t gnbUeS1Id,
                                            std::list<ErabToBeSetupItem> erabToBeSetupList) = 0;
 
    struct ErabSwitchedInUplinkItem
    {
        uint8_t erabId;                    
        Ipv4Address transportLayerAddress; 
        uint32_t gnbTeid;                  
    };
 
    virtual void PathSwitchRequestAcknowledge(
        uint64_t gnbUeS1Id,
        uint64_t mmeUeS1Id,
        uint16_t cgi,
        std::list<ErabSwitchedInUplinkItem> erabToBeSwitchedInUplinkList) = 0;
};
 
template <class C>
class NrMemberEpcS1apSapMme : public NrEpcS1apSapMme
{
  public:
    NrMemberEpcS1apSapMme(C* owner);
 
    // Delete default constructor to avoid misuse
    NrMemberEpcS1apSapMme() = delete;
 
    // inherited from NrEpcS1apSapMme
    void InitialUeMessage(uint64_t mmeUeS1Id,
                          uint16_t gnbUeS1Id,
                          uint64_t imsi,
                          uint16_t ecgi) override;
    void ErabReleaseIndication(
        uint64_t mmeUeS1Id,
        uint16_t gnbUeS1Id,
        std::list<ErabToBeReleasedIndication> erabToBeReleaseIndication) override;
 
    void InitialContextSetupResponse(uint64_t mmeUeS1Id,
                                     uint16_t gnbUeS1Id,
                                     std::list<ErabSetupItem> erabSetupList) override;
    void PathSwitchRequest(
        uint64_t gnbUeS1Id,
        uint64_t mmeUeS1Id,
        uint16_t cgi,
        std::list<ErabSwitchedInDownlinkItem> erabToBeSwitchedInDownlinkList) override;
 
  private:
    C* m_owner; 
};
 
template <class C>
NrMemberEpcS1apSapMme<C>::NrMemberEpcS1apSapMme(C* owner)
    : m_owner(owner)
{
}
 
template <class C>
void
NrMemberEpcS1apSapMme<C>::InitialUeMessage(uint64_t mmeUeS1Id,
                                           uint16_t gnbUeS1Id,
                                           uint64_t imsi,
                                           uint16_t ecgi)
{
    m_owner->DoInitialUeMessage(mmeUeS1Id, gnbUeS1Id, imsi, ecgi);
}
 
template <class C>
void
NrMemberEpcS1apSapMme<C>::ErabReleaseIndication(
    uint64_t mmeUeS1Id,
    uint16_t gnbUeS1Id,
    std::list<ErabToBeReleasedIndication> erabToBeReleaseIndication)
{
    m_owner->DoErabReleaseIndication(mmeUeS1Id, gnbUeS1Id, erabToBeReleaseIndication);
}
 
template <class C>
void
NrMemberEpcS1apSapMme<C>::InitialContextSetupResponse(uint64_t mmeUeS1Id,
                                                      uint16_t gnbUeS1Id,
                                                      std::list<ErabSetupItem> erabSetupList)
{
    m_owner->DoInitialContextSetupResponse(mmeUeS1Id, gnbUeS1Id, erabSetupList);
}
 
template <class C>
void
NrMemberEpcS1apSapMme<C>::PathSwitchRequest(
    uint64_t gnbUeS1Id,
    uint64_t mmeUeS1Id,
    uint16_t cgi,
    std::list<ErabSwitchedInDownlinkItem> erabToBeSwitchedInDownlinkList)
{
    m_owner->DoPathSwitchRequest(gnbUeS1Id, mmeUeS1Id, cgi, erabToBeSwitchedInDownlinkList);
}
 
template <class C>
class NrMemberEpcS1apSapGnb : public NrEpcS1apSapGnb
{
  public:
    NrMemberEpcS1apSapGnb(C* owner);
 
    // Delete default constructor to avoid misuse
    NrMemberEpcS1apSapGnb() = delete;
 
    // inherited from NrEpcS1apSapGnb
    void InitialContextSetupRequest(uint64_t mmeUeS1Id,
                                    uint16_t gnbUeS1Id,
                                    std::list<ErabToBeSetupItem> erabToBeSetupList) override;
    void PathSwitchRequestAcknowledge(
        uint64_t gnbUeS1Id,
        uint64_t mmeUeS1Id,
        uint16_t cgi,
        std::list<ErabSwitchedInUplinkItem> erabToBeSwitchedInUplinkList) override;
 
  private:
    C* m_owner; 
};
 
template <class C>
NrMemberEpcS1apSapGnb<C>::NrMemberEpcS1apSapGnb(C* owner)
    : m_owner(owner)
{
}
 
template <class C>
void
NrMemberEpcS1apSapGnb<C>::InitialContextSetupRequest(uint64_t mmeUeS1Id,
                                                     uint16_t gnbUeS1Id,
                                                     std::list<ErabToBeSetupItem> erabToBeSetupList)
{
    m_owner->DoInitialContextSetupRequest(mmeUeS1Id, gnbUeS1Id, erabToBeSetupList);
}
 
template <class C>
void
NrMemberEpcS1apSapGnb<C>::PathSwitchRequestAcknowledge(
    uint64_t gnbUeS1Id,
    uint64_t mmeUeS1Id,
    uint16_t cgi,
    std::list<ErabSwitchedInUplinkItem> erabToBeSwitchedInUplinkList)
{
    m_owner->DoPathSwitchRequestAcknowledge(gnbUeS1Id,
                                            mmeUeS1Id,
                                            cgi,
                                            erabToBeSwitchedInUplinkList);
}
 
} // namespace ns3
 
#endif /* NR_EPC_S1AP_SAP_H */