LTENR_Msg.h

Go to the documentation of this file.

#pragma once
/************************************************************************************
* Copyright (C) 2021                                                                *
* TETCOS, Bangalore. India                                                          *
*                                                                                   *
* Tetcos owns the intellectual property rights in the Product and its content.      *
* The copying, redistribution, reselling or publication of any or all of the        *
* Product or its content without express prior written consent of Tetcos is         *
* prohibited. Ownership and / or any other right relating to the software and all   *
* intellectual property rights therein shall remain at all times with Tetcos.       *
*                                                                                   *
* This source code is licensed per the NetSim license agreement.                    *
*                                                                                   *
* No portion of this source code may be used as the basis for a derivative work,    *
* or used, for any purpose other than its intended use per the NetSim license       *
* agreement.                                                                        *
*                                                                                   *
* This source code and the algorithms contained within it are confidential trade    *
* secrets of TETCOS and may not be used as the basis for any other software,        *
* hardware, product or service.                                                     *
*                                                                                   *
* Author:    Shashi Kant Suman                                                      *
*                                                                                   *
* ----------------------------------------------------------------------------------*/
#ifndef _NETSIM_LTENR_MSG_H_
#define _NETSIM_LTENR_MSG_H_
 
#ifdef  __cplusplus
extern "C" {
#endif
 
#pragma region MACROS
#define LTENR_HDRTYPE_MAX 100 //Read-only
#define IPV4_HEADER_SIZE 20
#pragma endregion
 
#pragma region MSG_TYPE
    typedef enum enum_LTENR_MSGTYPE
    {
 
        //RRC
        LTENR_MSG_RRC_MIB = MAC_PROTOCOL_LTE_NR * 100,
        LTENR_MSG_RRC_SIB1,
        LTENR_MSG_RRC_SI,
        LTENR_MSG_RRC_SETUP_REQUEST,
        LTENR_MSG_RRC_SETUP,
        LTENR_MSG_RRC_SETUP_COMPLETE,
        LTENR_MSG_RRC_UE_MEASUREMENT_REPORT,
        LTENR_MSG_RRC_REESTABLISHMENT_REQUEST,
        LTENR_MSG_RRC_REESTABLISHMENT,
        LTENR_MSG_RRC_RECONFIGURATION,
        //NAS
        LTENR_MSG_NAS_HANDOVER_REQUEST,
        LTENR_MSG_NAS_HANDOVER_REQUEST_ACK,
        LTENR_MSG_NAS_HANDOVER_COMMAND,
        LTENR_MSG_NAS_HANDOVER_PATH_SWITCH,
        LTENR_MSG_NAS_HANDOVER_PATH_SWITCH_ACK,
        LTENR_MSG_NAS_HANDOVER_UE_CONTEXT_RELEASE,
        LTENR_MSG_NAS_HANDOVER_UE_CONTEXT_RELEASE_ACK,
        LTENR_MSG_NAS_HANDOVER_COMPLETE,
        //RLC
        LTENR_MSG_RLC_STATUSPDU,
        LTENR_MSG_RLC_TMDPDU,
        LTENR_MSG_RLC_UMDPDU,
        LTENR_MSG_RLC_AMDPDU,
        //CORE
        LTENR_MSG_CORE_INITIAL_UE_MESSAGE,
        LTENR_MSG_CORE_CREATE_SESSION_REQUEST,
        LTENR_MSG_CORE_CREATE_SESSION_RESPONSE,
        LTENR_MSG_CORE_INITIAL_CONTEXT_SETUP_REQUEST,
        LTENR_MSG_CORE_INITIAL_CONTEXT_SETUP_RESPONSE,
        LTENR_MSG_CORE_REGISTRATION_COMPLETE,
        LTENR_MSG_CORE_NSMF_PDUSESSION_UPDATESMCONTEXT_REQUSET,
        LTENR_MSG_CORE_NSMF_PDUSESSION_UPDATESMCONTEXT_RESPONSE,
        LTENR_MSG_CORE_PFCP_SESSION_REQUSET,
        LTENR_MSG_CORE_PFCP_SESSION_RESPONSE,
        LTENR_MSG_CORE_MODIFY_BEARER_REQUEST,
        LTENR_MSG_CORE_MODIFY_BEARER_RESPONSE,
 
        //DC
        LTENR_MSG_DC_SEC_CELL_ADDITION_REQUEST,
        LTENR_MSG_DC_SEC_CELL_ADDITION_RESPONSE,
 
        //SN_HANDOVER
        LTENR_MSG_DC_HO_SEC_CELL_CHANGE_REQUEST,
        LTENR_MSG_DC_HO_SEC_CELL_ADDITION_REQUEST,
        LTENR_MSG_DC_HO_SEC_CELL_ADDITION_REQUEST_ACK,
        LTENR_MSG_DC_HO_SEC_CELL_RELEASE_REQUEST,
        LTENR_MSG_DC_HO_SEC_CELL_RELEASE_REQUEST_ACK,
        LTENR_MSG_DC_HO_SEC_CELL_PATH_SWITCH,
        LTENR_MSG_DC_HO_SEC_CELL_PATH_SWITCH_ACK,
        LTENR_MSG_DC_HO_SEC_CELL_UE_CONTEXT_RELEASE,
        LTENR_MSG_DC_HO_SEC_CELL_UE_CONTEXT_RELEASE_ACK,
 
        LTENR_MSG_USERDATA,
        LTENR_MSG_LAST, //Keep me at last
    }LTENR_MSGTYPE;
    static const char* strLTENR_MSGTYPE[] = { "RRC_MIB","RRC_SIB1","RRC_SI","RRC_SETUP_REQUEST","RRC_SETUP","RRC_SETUP_COMPLETE","UE_MEASUREMENT_REPORT",
        "RRC_REESTABLISHMENT_REQUEST","RRC_REESTABLISHMENT","RRC_RECONFIGURATION","HANDOVER_REQUEST","HANDOVER_REQUEST_ACK","HANDOVER_COMMAND","PATH_SWITCH","PATH_SWICTH_ACK",
        "UE_CONTEXT_RELEASE","UE_CONTEXT_RELEASE_ACK","HANDOVER_COMPLETE","STATUSPDU","TMDPDU","UMDPDU","AMDPDU",
        "INITIAL_UE_MSG_AND_REGISTRATION_REQUEST","CREATE_SESSION_REQUEST","CREATE_SESSION_RESPONSE","INITIAL_CONTEXT_SETUP_REQUEST",
        "INITIAL_CONTEXT_SETUP_RESPONSE_REGISTRATION_COMPLETE", "REGISTRATION_COMPLETE","NSMF_PDUSESSION_UPDATESMCONTEXT_REQUSET",
        "NSMF_PDUSESSION_UPDATESMCONTEXT_RESPONSE","PFCP_SESSION_REQUSET","PFCP_SESSION_RESPONSE","MODIFY_BEARER_REQUEST",
        "MODIFY_BEARER_RESPONSE", "DC_SEC_CELL_ADDITION_REQUEST", "DC_SEC_CELL_ADDITION_RESPONSE",
        "DC_HO_SEC_CELL_CHANGE_REQUEST","DC_HO_SEC_CELL_ADDITION_REQUEST","DC_HO_SEC_CELL_ADDITION_REQUEST_ACK",
        "DC_HO_SEC_CELL_RELEASE_REQUEST","DC_HO_SEC_CELL_RELEASE_REQUEST_ACK","DC_HO_SEC_CELL_PATH_SWITCH",
        "DC_HO_SEC_CELL_PATH_SWITCH_ACK","DC_HO_SEC_CELL_UE_CONTEXT_RELEASE","DC_HO_SEC_CELL_UE_CONTEXT_RELEASE_ACK","UserData","Unknown" };
#pragma endregion   
 
#pragma region LTENR_HEADER
    typedef struct stru_LTENR_HDR
    {
        UINT hdrType;
        UINT size;
        void* hdr;
        struct stru_LTENR_HDR* next;
    }LTENR_HDR, *ptrLTENR_HDR;
#pragma endregion
 
#pragma region LTENR_MSG_AND_ITS_API
    typedef struct stru_LTENR_MSG
    {
        UINT msgType;
 
        UINT hdrSize;
        ptrLTENR_HDR hdr;
        
        LTENR_LOGICALCHANNEL logicalChannel;
        LTENR_TRANSPORTCHANNEL transportChannel;
        LTENR_PHYSICALCHANNEL physicalChannel;
        LTENR_SRB srb;
        
        LTENR_RLCMODE rlcMode;
    }LTENR_MSG,*ptrLTENR_MSG;
#define LTENR_MSG_GET(packet) ((ptrLTENR_MSG)(packet->pstruMacData->Packet_MACProtocol))
#define LTENR_IS_UPLANE_MSG(packet) ((LTENR_MSG_GET(packet) == NULL) || (LTENR_MSG_GET(packet)->msgType == LTENR_MSG_USERDATA))
 
#define LTENR_PACKET_GET_LOGICALCHANNEL(packet)             (LTENR_MSG_GET(packet)->logicalChannel)
#define LTENR_PACKET_SET_LOGICALCHANNEL(packet,channel)     (LTENR_MSG_GET(packet)->logicalChannel = channel)
#define LTENR_PACKET_GET_TRANSPORTCHANNEL(packet)           (LTENR_MSG_GET(packet)->transportChannel)
#define LTENR_PACKET_SET_TRANSPORTCHANNEL(packet,channel)   (LTENR_MSG_GET(packet)->transportChannel = channel)
#define LTENR_PACKET_GET_PHYSICALCHANNEL(packet)            (LTENR_MSG_GET(packet)->physicalChannel)
#define LTENR_PACKET_SET_PHYSICALCHANNEL(packet,channel)    (LTENR_MSG_GET(packet)->physicalChannel = channel)
 
#define LTENR_PACKET_SET_RLCMODE(packet,mode)               (LTENR_MSG_GET(packet)->rlcMode = mode)
#define LTENR_PACKET_GET_RLCMODE(packet)                    (LTENR_MSG_GET(packet)->rlcMode)
#pragma endregion
 
#pragma region MSG_FUN_DEF
    ptrLTENR_MSG LTENR_MSG_CREATE(LTENR_MSGTYPE type);
    void LTENR_MSG_FREE(NetSim_PACKET* packet);
    ptrLTENR_MSG LTENR_MSG_COPY(const NetSim_PACKET* packet);
    ptrLTENR_MSG LTENR_MSG_APP_COPY(const NetSim_PACKET* packet);
#pragma endregion 
 
#pragma region HEADER_HANDLER_AND_ITS_APIS
    typedef struct stru_LTENR_HDRHANDLER
    {
        UINT hdrType;
        char* hdrName;
        void(*fnHandler)();
        void*(*fnCopyHdr)(void*);
        void(*fnFreeHdr)();
        void(*fnTraceWriter)(void*, char*);
    }LTENR_HDRHANDLER, *ptrLTENR_HDRHANDLER;
    UINT LTENR_HDR_REGISTER(char* name,
                            void(*fnHandler)(),
                            void*(*fnCopy)(void*),
                            void(*fnFree)(void*),
                            void(*fnTraceWriter)(void*, char*));
#pragma endregion
 
#pragma region FUN_DEF
    void LTENR_HDR_ADD_TO_PACKET(NetSim_PACKET* packet,
                                 void* hdr,
                                 UINT type,
                                 UINT size);
    void LTENR_RRC_HDR_ADD_TO_PACKET(NetSim_PACKET* packet,
        void* hdr,
        UINT type,
        UINT size,
        LTENR_MSGTYPE msgType);
    void LTENR_CORE_HDR_ADD_TO_PACKET(NetSim_PACKET* packet,
        void* hdr,
        UINT type,
        UINT size,
        LTENR_MSGTYPE msgType);
    void LTENR_HANDOVER_HDR_ADD_TO_PACKET(NetSim_PACKET* packet,
        void* hdr,
        UINT type,
        UINT size,
        LTENR_MSGTYPE msgType);
    void* LTENR_HDR_GET_FROM_PACKET(NetSim_PACKET* packet,
                                    UINT type);
    void* LTENR_CORE_HDR_GET_FROM_PACKET(NetSim_PACKET* packet,
        UINT type);
    void* LTENR_HANDOVER_HDR_GET_FROM_PACKET(NetSim_PACKET* packet,
        UINT type);
    void LTENR_HDR_FREE_FROM_PACKET(NetSim_PACKET* packet,
                                    UINT type);
    void LTENR_CORE_HDR_FREE_FROM_PACKET(NetSim_PACKET* packet,
        UINT type);
    void LTENR_HANDOVER_HDR_FREE_FROM_PACKET(NetSim_PACKET* packet,
        UINT type);
    ptrLTENR_HDR LTENR_HDR_NEW(void* hdr,
        UINT type,
        UINT size);
 
    // LTENR_PACKET
    NetSim_PACKET* LTENR_PACKET_CREATE(NETSIM_ID src, NETSIM_ID dest,
        double time, LTENR_MSGTYPE type);
#pragma endregion
 
#ifdef __cplusplus
}
#endif // __cplusplus
#endif //_NETSIM_LTENR_MSG_H_