e2ap/libe2ap_wrapper/E2AP_if.h

   1 /*
   2 ==================================================================================
   3   Copyright (c) 2019 AT&T Intellectual Property.
   4   Copyright (c) 2019 Nokia
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 */
  19
  20 #ifndef E2AP_IF_H
  21 #define E2AP_IF_H
  22
  23 #ifndef ASN_DISABLE_OER_SUPPORT
  24 #define ASN_DISABLE_OER_SUPPORT
  25 #endif
  26
  27 #include <stdbool.h>
  28 #include <stdint.h>
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 typedef unsigned char byte;
  35
  36 extern const int64_t cMaxNrOfErrors;
  37
  38 extern const uint64_t cMaxSizeOfOctetString;
  39
  40 typedef struct { // Octet string in ASN.1 does not have maximum length!
  41     size_t contentLength;
  42     uint8_t data[1024]; // table size is const cMaxSizeOfOctetString
  43 } OctetString_t;
  44
  45 typedef struct {
  46     uint8_t unusedbits; // trailing unused bits 0 - 7
  47     size_t byteLength;  // length in bytes
  48     uint8_t data[1024];
  49 } Bitstring_t;
  50
  51 typedef struct  {
  52         uint32_t ricRequestorID;
  53         uint32_t ricRequestSequenceNumber;
  54 } RICRequestID_t;
  55
  56 typedef uint16_t RANFunctionID_t;
  57
  58 typedef uint64_t RICActionID_t;
  59
  60 enum RICActionType_t {
  61      RICActionType_report
  62     ,RICActionType_insert
  63     ,RICActionType_policy
  64 };
  65
  66 typedef uint64_t StyleID_t;
  67
  68 typedef uint32_t ParameterID_t;
  69
  70 typedef struct {
  71     uint32_t dummy; // This data type has no content. This dymmy is added here to solve problem with Golang. Golang do not like empty types.
  72 } ParameterValue_t;
  73
  74 typedef struct {
  75     ParameterID_t parameterID;
  76     ParameterValue_t ParameterValue;
  77 } SequenceOfActionParameters_t;
  78
  79 typedef struct {
  80     StyleID_t styleID;
  81     SequenceOfActionParameters_t sequenceOfActionParameters;
  82 } RICActionDefinition_t;
  83
  84 enum RICSubsequentActionType_t {
  85         RICSubsequentActionType_Continue,
  86         RICSubsequentActionType_wait
  87 };
  88
  89 enum RICTimeToWait_t {
  90         RICTimeToWait_zero,
  91         RICTimeToWait_w1ms,
  92         RICTimeToWait_w2ms,
  93         RICTimeToWait_w5ms,
  94         RICTimeToWait_w10ms,
  95         RICTimeToWait_w20ms,
  96         RICTimeToWait_w30ms,
  97         RICTimeToWait_w40ms,
  98         RICTimeToWait_w50ms,
  99         RICTimeToWait_w100ms,
 100         RICTimeToWait_w200ms,
 101     RICTimeToWait_w500ms,
 102         RICTimeToWait_w1s,
 103         RICTimeToWait_w2s,
 104         RICTimeToWait_w5s,
 105         RICTimeToWait_w10s,
 106         RICTimeToWait_w20s,
 107         RICTimeToWait_w60s
 108 };
 109
 110 typedef struct {
 111         uint64_t ricSubsequentActionType;  // this is type of enum RICSubsequentActionType_t
 112         uint64_t ricTimeToWait;  // this is type of enum RICTimeToWait_t
 113 } RICSubsequentAction_t;
 114
 115 typedef struct  {
 116         RICActionID_t ricActionID;
 117         uint64_t ricActionType;  // this is type of enum RICActionType_t
 118         bool ricActionDefinitionPresent;
 119         RICActionDefinition_t ricActionDefinition;
 120         bool ricSubsequentActionPresent;
 121         RICSubsequentAction_t ricSubsequentAction;
 122 } RICActionToBeSetupItem_t;
 123
 124 static const uint64_t cMaxofRICactionID = 16;
 125
 126 typedef struct  {
 127     uint8_t contentLength;
 128     RICActionToBeSetupItem_t ricActionToBeSetupItem[16];  // table size is const cMaxofRICactionID
 129 } RICActionToBeSetupList_t;
 130
 131 typedef struct {
 132     uint8_t contentLength;
 133     uint8_t pLMNIdentityVal[3];
 134 } PLMNIdentity_t;
 135
 136 // size of eNB-id
 137 extern const size_t cMacroENBIDP_20Bits;
 138 extern const size_t cHomeENBID_28Bits;
 139 extern const size_t cShortMacroENBID_18Bits;
 140 extern const size_t clongMacroENBIDP_21Bits;
 141
 142 typedef struct {   // gNB-ID (SIZE 22..32 bits) or eNB-ID (SIZE 18, 20,21 or 28 bits)
 143     uint8_t bits;
 144     uint32_t nodeID;
 145 } NodeID_t;
 146
 147 typedef struct {
 148         PLMNIdentity_t  pLMNIdentity;
 149         NodeID_t        nodeID;
 150 }  GlobalNodeID_t;
 151
 152 typedef struct {   // CHOICE. Only either value can be present
 153         bool globalENBIDPresent;
 154         GlobalNodeID_t globalENBID;
 155         bool globalGNBIDPresent;
 156         GlobalNodeID_t globalGNBID;
 157 } InterfaceID_t;
 158
 159 enum InterfaceDirection__t {
 160         InterfaceDirection__incoming,
 161         InterfaceDirection__outgoing
 162 };
 163
 164 typedef uint8_t ProcedureCode__t;
 165
 166 typedef struct  {
 167         ProcedureCode__t procedureCode;
 168         uint8_t typeOfMessage;  // This is X2AP-PDU, CHOICE of InitiatingMessage or SuccessfulOutcome or UnsuccessfulOutcome
 169 } RICInterfaceMessageType_t;
 170
 171 typedef uint32_t InterfaceProtocolIEID_t;
 172
 173 enum ProtocolIEtestCondition_t {
 174         ProtocolIEtestCondition_equal,
 175         ProtocolIEtestCondition_greaterthan,
 176         ProtocolIEtestCondition_lessthan,
 177         ProtocolIEtestCondition_contains,
 178         ProtocolIEtestCondition_present
 179 };
 180
 181 typedef struct {   // CHOICE. Only one value can be present
 182     bool valueIntPresent;
 183         int64_t integer;           //INTEGER;
 184         bool valueEnumPresent;
 185         int64_t valueEnum;         // INTEGER
 186     bool valueBoolPresent;
 187         bool valueBool;            // BOOLEAN
 188     bool valueBitSPresent;
 189         Bitstring_t octetstring;   // OCTET STRING,
 190     bool octetstringPresent;
 191         OctetString_t octetString; // OCTET STRING,
 192 } InterfaceProtocolIEValue_t;
 193
 194 typedef struct {
 195     InterfaceProtocolIEID_t interfaceProtocolIEID;
 196     //ProtocolIEtestCondition_t protocolIEtestCondition;  Golang do not like this line. We do not need this right now.
 197     InterfaceProtocolIEValue_t  interfaceProtocolIEValue;
 198 } SequenceOfProtocolIE_t;
 199
 200 static const uint64_t cMaxofProtocolIE = 16;
 201
 202 typedef struct {
 203     SequenceOfProtocolIE_t sequenceOfProtocolIE[16]; // table size is const cMaxofProtocolIE
 204 } SequenceOfProtocolIEList_t;
 205
 206 typedef struct {
 207     OctetString_t octetString;   // E2AP spec format, the other elements for E2SM-X2 format
 208     InterfaceID_t interfaceID;
 209     uint8_t interfaceDirection;  // this is type of enum InterfaceDirection_t
 210     RICInterfaceMessageType_t interfaceMessageType ;
 211     bool sequenceOfProtocolIEListPresent;
 212     SequenceOfProtocolIEList_t SequenceOfProtocolIEList;
 213 } RICEventTriggerDefinition_t;
 214
 215 typedef struct {
 216     RICEventTriggerDefinition_t ricEventTriggerDefinition;
 217     RICActionToBeSetupList_t ricActionToBeSetupItemIEs;
 218 } RICSubscription_t;
 219
 220 typedef struct {
 221     uint8_t contentLength;
 222         RICActionID_t ricActionID[16]; // table size is const cMaxofRICactionID
 223 } RICActionAdmittedList_t;
 224
 225 enum CauseRIC_t {
 226         CauseRIC__function_id_Invalid,
 227         CauseRIC__action_not_supported,
 228         CauseRIC__excessive_actions,
 229         CauseRIC__duplicate_action,
 230         CauseRIC__duplicate_event,
 231         CauseRIC__function_resource_limit,
 232         CauseRIC__request_id_unknown,
 233         CauseRIC__inconsistent_action_subsequent_action_sequence,
 234         CauseRIC__control_message_invalid,
 235         CauseRIC__call_process_id_invalid,
 236         CauseRIC__function_not_required,
 237         CauseRIC__excessive_functions,
 238         CauseRIC__ric_resource_limit
 239 };
 240
 241 extern const int cRICCauseRadioNetwork; // this is content of type RICCause_t
 242 extern const int cRICCauseTransport; // this is content of type RICCause_t
 243 extern const int cRICCauseProtocol; // this is content of type RICCause_t
 244 extern const int cRICCauseMisc; // this is content of type RICCause_t
 245 extern const int cRICCauseRic; // this is content of type RICCause_t
 246
 247 typedef struct {
 248     uint8_t content; // See above constants
 249     uint8_t cause; // this is type of enum CauseRIC_t
 250 } RICCause_t;
 251
 252 typedef struct {
 253         RICActionID_t ricActionID;
 254     RICCause_t ricCause;
 255 } RICActionNotAdmittedItem_t;
 256
 257 typedef struct {
 258     uint8_t contentLength;
 259     RICActionNotAdmittedItem_t RICActionNotAdmittedItem[16];  // table size is const cMaxofRICactionID
 260 } RICActionNotAdmittedList_t;
 261
 262 enum Criticality_t {
 263     Criticality__reject,
 264     Criticality__ignore,
 265     Criticality__notify
 266 };
 267
 268 typedef uint32_t ProtocolIE_ID__t;
 269
 270 enum TriggeringMessage__t {
 271     TriggeringMessage__initiating_message,
 272     TriggeringMessage__successful_outcome,
 273     TriggeringMessage__unsuccessful_outcome
 274 };
 275
 276 enum TypeOfError_t {
 277         TypeOfError_not_understood,
 278         TypeOfError_missing
 279 };
 280
 281 typedef struct {
 282         uint8_t iECriticality; // this is type of enum Criticality_t
 283         ProtocolIE_ID__t iE_ID;
 284         uint8_t typeOfError; // this is type of enum TypeOfError_t
 285         //iE-Extensions  // This has no content in E2AP ASN.1 specification
 286 } CriticalityDiagnosticsIEListItem_t;
 287
 288 typedef struct {
 289     bool procedureCodePresent;
 290         ProcedureCode__t procedureCode;
 291         bool triggeringMessagePresent;
 292         uint8_t triggeringMessage; // this is type of enum TriggeringMessage_t
 293         bool procedureCriticalityPresent;
 294         uint8_t procedureCriticality; // this is type of enum Criticality_t
 295         bool iEsCriticalityDiagnosticsPresent;
 296     uint16_t criticalityDiagnosticsIELength;
 297         CriticalityDiagnosticsIEListItem_t criticalityDiagnosticsIEListItem[256];  // table size is const cMaxNrOfErrors
 298         //iE-Extensions   // This has no content in E2AP ASN.1 specification
 299
 300 } CriticalityDiagnostics__t;
 301
 302 typedef int32_t RICIndicationSN_t;
 303
 304 enum RICIndicationType_t {
 305         RICIndicationType_RICIndicationTypeReport,
 306         RICIndicationType_RICIndicationTypeInsert
 307 };
 308
 309 typedef struct {
 310     OctetString_t octetString;    // E2AP spec format, the other elements for E2SM-X2 format
 311     InterfaceID_t interfaceID;
 312     uint8_t interfaceDirection;
 313 } RICIndicationHeader_t;
 314
 315 typedef struct {
 316     OctetString_t octetString;    // E2AP spec format, the other elements for E2SM-X2 format
 317     OctetString_t interfaceMessage;
 318 } RICIndicationMessage_t;
 319
 320 typedef struct {
 321     OctetString_t octetString;    // E2AP spec format, the other elements for E2SM-X2 format
 322     uint64_t ricCallProcessIDVal;
 323 } RICCallProcessID_t;
 324
 325 //////////////////////////////////////////////////////////////////////
 326 // E2 Error codes
 327 enum e2err {
 328     e2err_OK,
 329     e2err_RICSubscriptionRequestAllocRICrequestIDFail,
 330     e2err_RICSubscriptionRequestAllocRANfunctionIDFail,
 331     e2err_RICSubscriptionRequestAllocRICeventTriggerDefinitionBufFail,
 332     e2err_RICSubscriptionRequestAllocRICaction_ToBeSetup_ItemIEsFail,
 333     e2err_RICSubscriptionRequestAllocRICsubsequentActionFail,
 334     e2err_RICSubscriptionRequestAllocRICsubscriptionRequest_IEsFail,
 335     e2err_RICSubscriptionRequestEncodeFail,
 336     e2err_RICSubscriptionRequestAllocE2AP_PDUFail,
 337     e2err_RICEventTriggerDefinitionIEValueFail_1,
 338     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDpLMN_IdentityBufFail,
 339     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDmacro_eNB_IDBufFail,
 340     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDhome_eNB_IDBufFail,
 341     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDshort_Macro_eNB_IDBufFail,
 342     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDlong_Macro_eNB_IDBufFail,
 343     e2err_RICEventTriggerDefinitionIEValueFail_2,
 344     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_gNB_IDpLMN_IdentityBufFail,
 345     e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_gNB_IDgNB_IDBufFail,
 346     e2err_RICEventTriggerDefinitionIEValueFail_3,
 347     e2err_RICEventTriggerDefinitionIEValueFail_4,
 348     e2err_RICEventTriggerDefinitionPackFail_1,
 349     e2err_RICEventTriggerDefinitionPackFail_2,
 350     e2err_RICEventTriggerDefinitionAllocE2SM_gNB_X2_eventTriggerDefinitionFail,
 351     e2err_RICSubscriptionResponseAllocRICrequestIDFail,
 352     e2err_RICSubscriptionResponseAllocRANfunctionIDFail,
 353     e2err_RICSubscriptionResponseAllocRICaction_Admitted_ItemIEsFail,
 354     e2err_RICSubscriptionResponseAllocRICActionAdmittedListFail,
 355     e2err_RICSubscriptionResponseAllocRICaction_NotAdmitted_ItemIEsFail,
 356     e2err_RICSubscriptionResponseAllocRICActionNotAdmittedListFail,
 357     e2err_RICSubscriptionResponseEncodeFail,
 358     e2err_RICSubscriptionResponseAllocE2AP_PDUFail,
 359     e2err_RICSubscriptionFailureAllocRICrequestIDFail,
 360     e2err_RICSubscriptionFailureAllocRANfunctionIDFail,
 361     e2err_RICSubscriptionFailureAllocRICaction_NotAdmitted_ItemIEsFail,
 362     e2err_RICSubscriptionFailureAllocRICActionAdmittedListFail,
 363     e2err_RICSubscriptionFailureEncodeFail,
 364     e2err_RICSubscriptionFailureAllocE2AP_PDUFail,
 365     e2err_RICIndicationRICrequestIDFail,
 366     e2err_RICIndicationAllocRANfunctionIDFail,
 367     e2err_RICIndicationAllocRICactionIDFail,
 368     e2err_RICIndicationAllocRICindicationSNFail,
 369     e2err_RICIndicationAllocRICindicationTypeFail,
 370     e2err_RICIndicationAllocRRICindicationHeaderBufFail,
 371     e2err_RICIndicationAllocRICindicationHeaderFail,
 372     e2err_RICIndicationAllocRICindicationMessageBufFail,
 373     e2err_RICIndicationAllocRICindicationMessageFail,
 374     e2err_RICIndicationEncodeFail,
 375     e2err_RICIndicationAllocE2AP_PDUFail,
 376     e2err_RICindicationHeaderIEValueFail_1,
 377     e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDpLMN_IdentityBufFail,
 378     e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDmacro_eNB_IDBufFail,
 379     e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDhome_eNB_IDBufFail,
 380     e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDshort_Macro_eNB_IDBufFail,
 381     e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDlong_Macro_eNB_IDBufFail,
 382     e2err_RICindicationHeaderIEValueFail_2,
 383     e2err_RICIndicationAllocRICIndicationHeaderglobal_gNB_IDpLMN_IdentityBufFail,
 384     e2err_RICIndicationAllocRICIndicationHeaderglobal_gNB_IDgNB_IDgNB_IDBufFail,
 385     e2err_RICindicationHeaderIEValueFail_3,
 386     e2err_RICindicationHeaderPackFail_1,
 387     e2err_RICindicationHeaderPackFail_2,
 388     e2err_RICIndicationHeaderAllocE2AP_PDUFail,
 389     e2err_RICIndicationMessageAllocinterfaceMessageFail,
 390     e2err_RICindicationMessagePackFail_1,
 391     e2err_RICindicationMessagePackFail_2,
 392     e2err_E2SM_gNB_X2_indicationMessageAllocE2AP_PDUFail,
 393     e2err_RICSubscriptionDeleteRequestAllocRICrequestIDFail,
 394     e2err_RICSubscriptionDeleteRequestAllocRANfunctionIDFail,
 395     e2err_RICSubscriptionDeleteRequestEncodeFail,
 396     e2err_RICSubscriptionDeleteRequestAllocE2AP_PDUFail,
 397     e2err_RICSubscriptionDeleteResponseAllocRICrequestIDFail,
 398     e2err_RICSubscriptionDeleteResponseAllocRANfunctionIDFail,
 399     e2err_RICSubscriptionDeleteResponseEncodeFail,
 400     e2err_RICSubscriptionDeleteResponseAllocE2AP_PDUFail,
 401     e2err_RICSubscriptionDeleteFailureAllocRICrequestIDFail,
 402     e2err_RICSubscriptionDeleteFailureAllocRANfunctionIDFail,
 403     e2err_RICSubscriptionDeleteFailureAllocRICcauseFail,
 404     e2err_RICSubscriptionDeleteFailureEncodeFail,
 405     e2err_RICSubscriptionDeleteFailureAllocE2AP_PDUFail,
 406     e2err_RICsubscriptionRequestRICrequestIDMissing,
 407     e2err_RICsubscriptionRequestRANfunctionIDMissing,
 408     e2err_RICsubscriptionRequestICsubscriptionMissing,
 409     e2err_RICEventTriggerDefinitionIEValueFail_5,
 410     e2err_RICEventTriggerDefinitionIEValueFail_6,
 411     e2err_RICEventTriggerDefinitionIEValueFail_7,
 412     e2err_RICEventTriggerDefinitionIEValueFail_8,
 413     e2err_RICEventTriggerDefinitionDecodeWMOREFail,
 414     e2err_RICEventTriggerDefinitionDecodeFAIL,
 415     e2err_RICEventTriggerDefinitionDecodeDefaultFail,
 416     e2err_RICsubscriptionResponseRICrequestIDMissing,
 417     e2err_RICsubscriptionResponseRANfunctionIDMissing,
 418     e2err_RICsubscriptionResponseRICaction_Admitted_ListMissing,
 419     e2err_RICsubscriptionFailureRICrequestIDMissing,
 420     e2err_RICsubscriptionFailureRANfunctionIDMissing,
 421     e2err_RICsubscriptionFailureRICaction_NotAdmitted_ListMissing,
 422     e2err_RICindicationRICrequestIDMissing,
 423     e2err_RICindicationRANfunctionIDMissing,
 424     e2err_RICindicationRICactionIDMissing,
 425     e2err_RICindicationRICindicationSNMissing,
 426     e2err_RICindicationRICindicationTypeMissing,
 427     e2err_RICIndicationHeaderContentLengthFail,
 428     e2err_RICindicationRICindicationHeaderMissing,
 429     e2err_RICIndicationMessageContentLengthFail,
 430     e2err_RICindicationRICindicationMessageMissing,
 431     e2err_RICEventTriggerDefinitionIEValueFail_9,
 432     e2err_RICEventTriggerDefinitionIEValueFail_10,
 433     e2err_RICEventTriggerDefinitionIEValueFail_11,
 434     e2err_RICIndicationHeaderDecodeWMOREFail,
 435     e2err_RICIndicationHeaderDecodeFAIL,
 436     e2err_RICIndicationHeaderDecodeDefaultFail,
 437     e2err_RICIndicationMessageIEContentLengthFail,
 438     e2err_RICIndicationMessageDecodeWMOREFail,
 439     e2err_RICIndicationMessageDecodeFAIL,
 440     e2err_RICIndicationMessageDecodeDefaultFail,
 441     e2err_RICsubscriptionDeleteRequestRICrequestIDMissing,
 442     e2err_RICsubscriptionDeleteRequestRANfunctionIDMissing,
 443     e2err_RICsubscriptionDeleteResponseRICrequestIDMissing,
 444     e2err_RICsubscriptionDeleteResponseRANfunctionIDMissing,
 445     e2err_RICsubscriptionDeleteFailureRICrequestIDMissing,
 446     e2err_RICsubscriptionDeleteFailureRANfunctionIDMissing,
 447     e2err_RICsubscriptionDeleteFailureRICcauseMissing
 448 };
 449
 450
 451 static const char* const E2ErrorStrings[] = {
 452     "e2err_OK",
 453     "e2err_RICSubscriptionRequestAllocRICrequestIDFail",
 454     "e2err_RICSubscriptionRequestAllocRANfunctionIDFail",
 455     "e2err_RICSubscriptionRequestAllocRICeventTriggerDefinitionBufFail",
 456     "e2err_RICSubscriptionRequestAllocRICaction_ToBeSetup_ItemIEsFail",
 457     "e2err_RICSubscriptionRequestAllocRICsubsequentActionFail",
 458     "e2err_RICSubscriptionRequestAllocRICsubscriptionRequest_IEsFail",
 459     "e2err_RICSubscriptionRequestEncodeFail",
 460     "e2err_RICSubscriptionRequestAllocE2AP_PDUFail",
 461     "e2err_RICEventTriggerDefinitionIEValueFail_1",
 462     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDpLMN_IdentityBufFail",
 463     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDmacro_eNB_IDBufFail",
 464     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDhome_eNB_IDBufFail",
 465     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDshort_Macro_eNB_IDBufFail",
 466     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_eNB_IDeNB_IDlong_Macro_eNB_IDBufFail",
 467     "e2err_RICEventTriggerDefinitionIEValueFail_2",
 468     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_gNB_IDpLMN_IdentityBufFail",
 469     "e2err_RICIndicationAllocRICEventTriggerDefinitionglobal_gNB_IDgNB_IDBufFail",
 470     "e2err_RICEventTriggerDefinitionIEValueFail_3",
 471     "e2err_RICEventTriggerDefinitionIEValueFail_4",
 472     "e2err_RICEventTriggerDefinitionPackFail_1",
 473     "e2err_RICEventTriggerDefinitionPackFail_2",
 474     "e2err_RICEventTriggerDefinitionAllocE2SM_gNB_X2_eventTriggerDefinitionFail",
 475     "e2err_RICSubscriptionResponseAllocRICrequestIDFail",
 476     "e2err_RICSubscriptionResponseAllocRANfunctionIDFail",
 477     "e2err_RICSubscriptionResponseAllocRICaction_Admitted_ItemIEsFail",
 478     "e2err_RICSubscriptionResponseAllocRICActionAdmittedListFail",
 479     "e2err_RICSubscriptionResponseAllocRICaction_NotAdmitted_ItemIEsFail",
 480     "e2err_RICSubscriptionResponseAllocRICActionNotAdmittedListFail",
 481     "e2err_RICSubscriptionResponseEncodeFail",
 482     "e2err_RICSubscriptionResponseAllocE2AP_PDUFail",
 483     "e2err_RICSubscriptionFailureAllocRICrequestIDFail",
 484     "e2err_RICSubscriptionFailureAllocRANfunctionIDFail",
 485     "e2err_RICSubscriptionFailureAllocRICaction_NotAdmitted_ItemIEsFail",
 486     "e2err_RICSubscriptionFailureAllocRICActionAdmittedListFail",
 487     "e2err_RICSubscriptionFailureEncodeFail",
 488     "e2err_RICSubscriptionFailureAllocE2AP_PDUFail",
 489     "e2err_RICIndicationRICrequestIDFail",
 490     "e2err_RICIndicationAllocRANfunctionIDFail",
 491     "e2err_RICIndicationAllocRICactionIDFail",
 492     "e2err_RICIndicationAllocRICindicationSNFail",
 493     "e2err_RICIndicationAllocRICindicationTypeFail",
 494     "e2err_RICIndicationAllocRRICindicationHeaderBufFail",
 495     "e2err_RICIndicationAllocRICindicationHeaderFail",
 496     "e2err_RICIndicationAllocRICindicationMessageBufFail",
 497     "e2err_RICIndicationAllocRICindicationMessageFail",
 498     "e2err_RICIndicationEncodeFail",
 499     "e2err_RICIndicationAllocE2AP_PDUFail",
 500     "e2err_RICindicationHeaderIEValueFail_1",
 501     "e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDpLMN_IdentityBufFail",
 502     "e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDmacro_eNB_IDBufFail",
 503     "e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDhome_eNB_IDBufFail",
 504     "e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDshort_Macro_eNB_IDBufFail",
 505     "e2err_RICIndicationAllocRICIndicationHeaderglobal_eNB_IDeNB_IDlong_Macro_eNB_IDBufFail",
 506     "e2err_RICindicationHeaderIEValueFail_2",
 507     "e2err_RICIndicationAllocRICIndicationHeaderglobal_gNB_IDpLMN_IdentityBufFail",
 508     "e2err_RICIndicationAllocRICIndicationHeaderglobal_gNB_IDgNB_IDgNB_IDBufFail",
 509     "e2err_RICindicationHeaderIEValueFail_3",
 510     "e2err_RICindicationHeaderPackFail_1",
 511     "e2err_RICindicationHeaderPackFail_2",
 512     "e2err_RICIndicationHeaderAllocE2AP_PDUFail",
 513     "e2err_RICIndicationMessageAllocinterfaceMessageFail",
 514     "e2err_RICindicationMessagePackFail_1",
 515     "e2err_RICindicationMessagePackFail_2",
 516     "e2err_E2SM_gNB_X2_indicationMessageAllocE2AP_PDUFail",
 517     "e2err_RICSubscriptionDeleteRequestAllocRICrequestIDFail",
 518     "e2err_RICSubscriptionDeleteRequestAllocRANfunctionIDFail",
 519     "e2err_RICSubscriptionDeleteRequestEncodeFail",
 520     "e2err_RICSubscriptionDeleteRequestAllocE2AP_PDUFail",
 521     "e2err_RICSubscriptionDeleteResponseAllocRICrequestIDFail",
 522     "e2err_RICSubscriptionDeleteResponseAllocRANfunctionIDFail",
 523     "e2err_RICSubscriptionDeleteResponseEncodeFail",
 524     "e2err_RICSubscriptionDeleteResponseAllocE2AP_PDUFail",
 525     "e2err_RICSubscriptionDeleteFailureAllocRICrequestIDFail",
 526     "e2err_RICSubscriptionDeleteFailureAllocRANfunctionIDFail",
 527     "e2err_RICSubscriptionDeleteFailureAllocRICcauseFail",
 528     "e2err_RICSubscriptionDeleteFailureEncodeFail",
 529     "e2err_RICSubscriptionDeleteFailureAllocE2AP_PDUFail",
 530     "e2err_RICsubscriptionRequestRICrequestIDMissing",
 531     "e2err_RICsubscriptionRequestRANfunctionIDMissing",
 532     "e2err_RICsubscriptionRequestICsubscriptionMissing",
 533     "e2err_RICEventTriggerDefinitionIEValueFail_5",
 534     "e2err_RICEventTriggerDefinitionIEValueFail_6",
 535     "e2err_RICEventTriggerDefinitionIEValueFail_7",
 536     "e2err_RICEventTriggerDefinitionIEValueFail_8",
 537     "e2err_RICEventTriggerDefinitionDecodeWMOREFail",
 538     "e2err_RICEventTriggerDefinitionDecodeFAIL",
 539     "e2err_RICEventTriggerDefinitionDecodeDefaultFail",
 540     "e2err_RICsubscriptionResponseRICrequestIDMissing",
 541     "e2err_RICsubscriptionResponseRANfunctionIDMissing",
 542     "e2err_RICsubscriptionResponseRICaction_Admitted_ListMissing",
 543     "e2err_RICsubscriptionFailureRICrequestIDMissing",
 544     "e2err_RICsubscriptionFailureRANfunctionIDMissing",
 545     "e2err_RICsubscriptionFailureRICaction_NotAdmitted_ListMissing",
 546     "e2err_RICindicationRICrequestIDMissing",
 547     "e2err_RICindicationRANfunctionIDMissing",
 548     "e2err_RICindicationRICactionIDMissing",
 549     "e2err_RICindicationRICindicationSNMissing",
 550     "e2err_RICindicationRICindicationTypeMissing",
 551     "e2err_RICIndicationHeaderContentLengthFail",
 552     "e2err_RICindicationRICindicationHeaderMissing",
 553     "e2err_RICIndicationMessageContentLengthFail",
 554     "e2err_RICindicationRICindicationMessageMissing",
 555     "e2err_RICEventTriggerDefinitionIEValueFail_9",
 556     "e2err_RICEventTriggerDefinitionIEValueFail_10",
 557     "e2err_RICEventTriggerDefinitionIEValueFail_11",
 558     "e2err_RICIndicationHeaderDecodeWMOREFail",
 559     "e2err_RICIndicationHeaderDecodeFAIL",
 560     "e2err_RICIndicationHeaderDecodeDefaultFail",
 561     "e2err_RICIndicationMessageIEContentLengthFail",
 562     "e2err_RICIndicationMessageDecodeWMOREFail",
 563     "e2err_RICIndicationMessageDecodeFAIL",
 564     "e2err_RICIndicationMessageDecodeDefaultFail",
 565     "e2err_RICsubscriptionDeleteRequestRICrequestIDMissing",
 566     "e2err_RICsubscriptionDeleteRequestRANfunctionIDMissing",
 567     "e2err_RICsubscriptionDeleteResponseRICrequestIDMissing",
 568     "e2err_RICsubscriptionDeleteResponseRANfunctionIDMissing",
 569     "e2err_RICsubscriptionDeleteFailureRICrequestIDMissing",
 570     "e2err_RICsubscriptionDeleteFailureRANfunctionIDMissing",
 571     "e2err_RICsubscriptionDeleteFailureRICcauseMissing"
 572 };
 573
 574 typedef struct {
 575     uint64_t messageType; // Initiating message or Successful outcome or Unsuccessful outcome
 576     uint64_t messageId;
 577 } E2MessageInfo_t;
 578
 579 //////////////////////////////////////////////////////////////////////
 580 // Message definitons
 581
 582 // Below constant values are same as in E2AP, E2SM and X2AP specs
 583 extern const uint64_t cE2InitiatingMessage;
 584 extern const uint64_t cE2SuccessfulOutcome;
 585 extern const uint64_t cE2UnsuccessfulOutcome;
 586
 587 // E2AP messages. Below message id constant values are the same as in ASN.1 specification
 588
 589 // Initiating message
 590 extern const uint64_t cRICSubscriptionRequest;
 591 extern const uint64_t cRICSubscriptionDeleteRequest;
 592 extern const uint64_t cRICIndication;
 593
 594 // Successful outcome
 595 extern const uint64_t cRICSubscriptionResponse;
 596 extern const uint64_t cRICsubscriptionDeleteResponse;
 597
 598 // Unsuccessful outcome
 599 extern const uint64_t cRICSubscriptionFailure;
 600 extern const uint64_t cRICsubscriptionDeleteFailure;
 601
 602 typedef struct {
 603     RICRequestID_t ricRequestID;
 604     RANFunctionID_t ranFunctionID;
 605     RICSubscription_t ricSubscription;
 606 } RICSubscriptionRequest_t;
 607
 608 typedef struct {
 609     RICRequestID_t ricRequestID;
 610     RANFunctionID_t ranFunctionID;
 611     RICActionAdmittedList_t ricActionAdmittedList;
 612     bool ricActionNotAdmittedListPresent;
 613     RICActionNotAdmittedList_t ricActionNotAdmittedList;
 614 } RICSubscriptionResponse_t;
 615
 616
 617 typedef struct {
 618     RICRequestID_t ricRequestID;
 619     RANFunctionID_t ranFunctionID;
 620     RICActionNotAdmittedList_t ricActionNotAdmittedList;
 621     bool criticalityDiagnosticsPresent;
 622     CriticalityDiagnostics__t criticalityDiagnostics;
 623 } RICSubscriptionFailure_t;
 624
 625 typedef struct {
 626         RICRequestID_t ricRequestID;
 627         RANFunctionID_t ranFunctionID;
 628         RICActionID_t ricActionID;
 629         RICIndicationSN_t ricIndicationSN;
 630         uint64_t ricIndicationType; // this is type of enum RICIndicationType_t
 631         RICIndicationHeader_t ricIndicationHeader;
 632         RICIndicationMessage_t ricIndicationMessage;
 633     RICCallProcessID_t ricCallProcessID;  // Not usein RIC currently
 634 } RICIndication_t;
 635
 636 typedef struct {
 637     RICRequestID_t ricRequestID;
 638     RANFunctionID_t ranFunctionID;
 639 } RICSubscriptionDeleteRequest_t;
 640
 641 typedef struct  {
 642     RICRequestID_t ricRequestID;
 643     RANFunctionID_t ranFunctionID;
 644 } RICSubscriptionDeleteResponse_t;
 645
 646 typedef struct  {
 647     RICRequestID_t ricRequestID;
 648     RANFunctionID_t ranFunctionID;
 649     RICCause_t ricCause;
 650     bool criticalityDiagnosticsPresent;
 651     CriticalityDiagnostics__t criticalityDiagnostics; // Not usein RIC currently
 652 } RICSubscriptionDeleteFailure_t;
 653
 654 //////////////////////////////////////////////////////////////////////
 655 // Function declarations
 656
 657 const char* getE2ErrorString(uint64_t);
 658
 659 typedef void* e2ap_pdu_ptr_t;
 660
 661 uint64_t packRICSubscriptionRequest(size_t*, byte*, char*,RICSubscriptionRequest_t*);
 662 uint64_t packRICEventTriggerDefinition(char*,RICEventTriggerDefinition_t*);
 663 uint64_t packRICSubscriptionResponse(size_t*, byte*, char*,RICSubscriptionResponse_t*);
 664 uint64_t packRICSubscriptionFailure(size_t*, byte*, char*,RICSubscriptionFailure_t*);
 665 uint64_t packRICIndication(size_t*, byte*, char*,RICIndication_t*);
 666 uint64_t packRICIndicationHeader(char*,RICIndicationHeader_t*);
 667 uint64_t packRICIndicationMessage(char*,RICIndicationMessage_t*);
 668 uint64_t packRICSubscriptionDeleteRequest(size_t*, byte*, char*,RICSubscriptionDeleteRequest_t*);
 669 uint64_t packRICSubscriptionDeleteResponse(size_t*, byte*, char*,RICSubscriptionDeleteResponse_t*);
 670 uint64_t packRICSubscriptionDeleteFailure(size_t*, byte*, char*,RICSubscriptionDeleteFailure_t*);
 671
 672 e2ap_pdu_ptr_t* unpackE2AP_pdu(const size_t, const byte*, char*, E2MessageInfo_t*);
 673 uint64_t getRICSubscriptionRequestData(e2ap_pdu_ptr_t*, RICSubscriptionRequest_t*);
 674 uint64_t getRICEventTriggerDefinitionData(RICEventTriggerDefinition_t*);
 675 uint64_t getRICSubscriptionResponseData(e2ap_pdu_ptr_t*, RICSubscriptionResponse_t*);
 676 uint64_t getRICSubscriptionFailureData(e2ap_pdu_ptr_t*, RICSubscriptionFailure_t*);
 677 uint64_t getRICIndicationData(e2ap_pdu_ptr_t*, RICIndication_t*);
 678 uint64_t getRICIndicationHeaderData(RICIndicationHeader_t*);
 679 uint64_t getRICIndicationMessageData(RICIndicationMessage_t*);
 680 uint64_t getRICSubscriptionDeleteRequestData(e2ap_pdu_ptr_t*, RICSubscriptionDeleteRequest_t*);
 681 uint64_t getRICSubscriptionDeleteResponseData(e2ap_pdu_ptr_t*, RICSubscriptionDeleteResponse_t*);
 682 uint64_t getRICSubscriptionDeleteFailureData(e2ap_pdu_ptr_t*, RICSubscriptionDeleteFailure_t*);
 683
 684
 685 #if DEBUG
 686 bool TestRICSubscriptionRequest();
 687 bool TestRICSubscriptionResponse();
 688 bool TestRICSubscriptionFailure();
 689 bool TestRICIndication();
 690 bool TestRICSubscriptionDeleteRequest();
 691 bool TestRICSubscriptionDeleteResponse();
 692 bool TestRICSubscriptionDeleteFailure();
 693
 694 void printRICSubscriptionRequest(const RICSubscriptionRequest_t*);
 695 void printRICSubscriptionResponse(const RICSubscriptionResponse_t*);
 696 void printRICSubscriptionFailure(const RICSubscriptionFailure_t*);
 697 void printRICIndication(const RICIndication_t*);
 698 void printRICSubscriptionDeleteRequest(const RICSubscriptionDeleteRequest_t*);
 699 void printRICSubscriptionDeleteResponse(const RICSubscriptionDeleteResponse_t*);
 700 void printRICSubscriptionDeleteFailure(const RICSubscriptionDeleteFailure_t*);
 701 #endif
 702
 703 #ifdef  __cplusplus
 704 }
 705 #endif
 706
 707 #endif