1 /*******************************************************************************
2 ################################################################################
3 # Copyright (c) [2017-2019] [Radisys] #
5 # Licensed under the Apache License, Version 2.0 (the "License"); #
6 # you may not use this file except in compliance with the License. #
7 # You may obtain a copy of the License at #
9 # http://www.apache.org/licenses/LICENSE-2.0 #
11 # Unless required by applicable law or agreed to in writing, software #
12 # distributed under the License is distributed on an "AS IS" BASIS, #
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
14 # See the License for the specific language governing permissions and #
15 # limitations under the License. #
16 ################################################################################
17 *******************************************************************************/
19 /* This file contains all E2AP message handler related functionality */
20 #define MAX_E2_SETUP_TMR 1
21 #define MAX_RIC_SERVICE_UPDATE_TMR 1
23 #define EVENT_E2_SETUP_TMR 1
24 #define EVENT_RIC_SERVICE_UPDATE_TMR 2
26 #define MAX_NUM_TRANSACTION 256 /* As per, O-RAN WG3 E2AP v3.0, section 9.2.33 */
27 #define MAX_RAN_FUNCTION 256 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.2 : maxofRANfunctionID */
28 #define MAX_E2_NODE_COMPONENT 1024 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.2 : maxofE2nodeComponents */
29 #define MAX_TNL_ASSOCIATION 32 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.11 : maxofTNLA */
30 #define MAX_RIC_STYLES 64 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 : maxnoofRICstyle */
31 #define MAX_MEASUREMENT_INFO 65535 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 : maxnoofMeasurementInfo */
32 #define MAX_LABEL_INFO 2147483648 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 : maxnoofLabelInfo */
33 #define MAX_RIC_ACTION 16 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
34 #define MAX_RIC_REQUEST 65535 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.7 */
36 #define STRING_SIZE_150_BYTES 150
37 #define STRING_SIZE_1000_BYTES 1000
39 #define SHORT_NAME "ORAN-E2SM-KPM"
40 #define SERVICE_MODEL_OID "1.3.6.1.4.1.53148.1.2.2.2"
41 #define DESCRIPTION "KPM Monitor"
42 #define NUM_OF_EVENT_TRIGGER_STYLE_SUPPORTED 1
43 #define EVENT_TRIGGER_STYLE_NAME "Periodic Report"
44 #define EVENT_TRIGGER_STYLE_TYPE 1
45 #define EVENT_TRIGGER_STYLE_FORMAT_TYPE 1
46 #define NUM_OF_RIC_REPORT_STYLE_SUPPORTED 1
47 #define REPORT_STYLE_NAME "E2 Node Measurement"
48 #define REPORT_STYLE_TYPE 1
49 #define REPORT_ACTION_FORMAT_TYPE 1
50 #define MEASUREMENT_TYPE_NAME (char*[]) {"RRU.PrbTotDl", "RRU.PrbTotUl"}
51 #define RIC_INDICATION_HEADER_FORMAT 1
52 #define RIC_INDICATION_MESSAGE_FORMAT 1
54 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26 */
68 E2_NODE_COMPONENT_ADD,
69 E2_NODE_COMPONENT_UPDATE
72 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.30 */
80 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.11 */
92 }E2ProcedureDirection;
96 E2_RAN_FUNCTION_ID_INVALID,
97 E2_ACTION_NOT_SUPPORTED,
98 E2_EXECESSIVE_ACTIONS,
100 E2_DUPLICATE_EVENT_TRIGGER,
101 E2_FUNCTION_RESOURCE_LIMIT,
102 E2_REQUEST_ID_UNKNOWN,
103 E2_INCONSISTENT_ACTION_SUBSEQUENT_ACTION_SEQUENCE,
104 E2_CONTROL_MESSAGE_INVALID,
105 E2_RIC_CALL_PROCESS_ID_INVALID,
106 E2_CONTROL_TIMER_EXPIRED,
107 E2_CONTROL_FAILED_TO_EXECUTE,
109 E2_RIC_REQUEST_CAUSE_UNSPECIFIED,
110 E2_RIC_SUBSCRIPTION_END_TIME_EXPIRED,
111 E2_RIC_SUBSCRIPTION_END_TIME_INVALID,
112 E2_DUPLICATE_RIC_REQUEST_ID,
113 E2_EVENT_TRIGGER_NOT_SUPPORTED,
114 E2_REQUEST_INFORMATION_UNAVAILABLE,
115 E2_INVALID_INFORMATION_REQUEST
120 E2_RAN_FUNCTION_NOT_SUPPORTED,
121 E2_EXCESSIVE_FUNCTIONS,
122 E2_RIC_RESOURCE_LIMIT,
127 E2_NODE_COMPONENT_UNKNOWN
132 E2_TRANSPORT_CAUSE_UNSPECIFIED,
133 E2_TRANSPORT_RESOURCE_UNAVAILABLE
138 E2_TRANSFER_SYNTAX_ERROR,
139 E2_ABSTRACT_SYNTAX_ERROR_REJECT,
140 E2_ABSTRACT_SYNTAX_ERROR_IGNORE_AND_NOTIFY,
141 E2_MESSAGE_NOT_COMPATIBLE_WITH_RECEIVER_STATE,
143 E2_ABSTRACT_SYNTAX_ERROR_FALSELY_CONSTRUCTED_MESSAGE,
144 E2_PROTOCOL_CAUSE_UNSPECIFIED
149 E2_CONTROL_PROCESSING_OVERLOAD,
152 E2_MISCELLANEOUS_CAUSE_UNSPECIFIED
166 typedef uint8_t E2Cause;
170 uint8_t transactionId;
171 uint8_t procedureCode;
174 typedef struct e2Transcation
176 uint8_t transIdCounter; /* counting the total number of DU initiated transaction */
177 E2TransInfo e2InitTransaction[MAX_NUM_TRANSACTION]; /* Storing DU-initiated transactions information */
178 E2TransInfo ricInitTransaction[MAX_NUM_TRANSACTION]; /* Storing RIC-initiated transactions information */
184 uint16_t revisionCounter;
189 uint8_t numOfRanFunToBeAdded;
190 RanFuncInfo ranFunToBeAdded[MAX_RAN_FUNCTION];
191 uint8_t numOfRanFunToBeModified;
192 RanFuncInfo ranFunToBeModified[MAX_RAN_FUNCTION];
193 uint8_t numOfRanFunToBeDeleted;
194 RanFuncInfo ranFunToBeDeleted[MAX_RAN_FUNCTION];
197 typedef struct ricServiceUpdate
199 E2ProcedureDirection dir;
201 E2TmpRanFunList recvRanFuncList;
206 RicServiceUpdate ricService;
208 }RicServiceUpdateTimer;
210 typedef struct e2Timer
212 CmTimer e2SetupTimer;
213 RicServiceUpdateTimer ricServiceUpdateTimer;
214 /* More timers can be added to this structure in future */
218 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.4 */
222 uint32_t nearRtRicId;
225 /* O-RAN.WG3.E2SM-R003-v03.00 : Section 6.2.2.1 */
228 char shortName[STRING_SIZE_150_BYTES];
229 char serviceModelOID[STRING_SIZE_1000_BYTES];
230 char description[STRING_SIZE_150_BYTES];
233 /* O-RAN.WG3.E2SM-R003-v03.00 : Section 6.2.2.2-6.2.2.4 */
237 char name[STRING_SIZE_150_BYTES];
241 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 */
244 char measurementTypeName[STRING_SIZE_150_BYTES];
245 uint16_t measurementTypeId;
246 }MeasurementInfoForAction;
250 RicStyle reportStyle;
251 CmLListCp measurementInfoList;
254 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.7 */
257 uint16_t requestorId;
261 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.1.1 */
264 uint32_t reportingPeriod; /* In milliseconds */
265 }EventTriggerFormat1;
267 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.1 */
273 EventTriggerFormat1 format1;
274 /* More formats can be added in future */
276 }EventTriggerDefinition;
278 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.3.11 */
281 /* TODO : To be added in future when subcounters for any
282 * measurment type is required */
285 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 */
288 char measurementTypeName[STRING_SIZE_150_BYTES];
289 uint16_t measurementTypeId;
291 /* As of now Labels are not used, hence it is not implemented completely */
292 //uint32_t numOfLabels;
293 //LabelInfo LabelInfoList[MAX_LABEL_INFO];
295 CmLListCp measuredValue; /* To be filled when numOfLabels is 0, else values are calculated per Label */
298 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 */
301 CmLListCp measurementInfoList; /* Each node corresponds to MeasurementInfo */
302 uint32_t granularityPeriod; /* In millisecond */
305 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.2 */
308 /* TODO : This format will be defined in future if required */
311 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.3 */
314 /* TODO : This format will be defined in future if required */
317 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.4 */
320 /* TODO : This format will be defined in future if required */
323 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.5 */
326 /* TODO : This format will be defined in future if required */
329 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2 */
336 ActionDefFormat1 format1;
337 ActionDefFormat2 format2;
338 ActionDefFormat3 format3;
339 ActionDefFormat4 format4;
340 ActionDefFormat5 format5;
344 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
349 ActionDefinition definition;
353 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
356 RicRequestId requestId;
357 EventTriggerDefinition eventTriggerDefinition;
358 uint8_t numOfActions;
359 ActionInfo actionSequence[MAX_RIC_ACTION];
364 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 */
366 RanFunctionName name;
367 uint16_t revisionCounter;
368 uint8_t numOfEventTriggerStyleSupported;
369 RicStyle eventTriggerStyleList[MAX_RIC_STYLES];
370 uint8_t numOfReportStyleSupported;
371 RicReportStyle reportStyleList[MAX_RIC_STYLES];
372 uint8_t ricIndicationHeaderFormat;
373 uint8_t ricIndicationMessageFormat;
374 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 */
375 CmLListCp subscriptionList;
378 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26-9.2.27 */
381 InterfaceType interfaceType;
382 uint64_t componentId;
383 ComponentActionType componentActionType;
385 uint8_t *componentRequestPart;
387 uint8_t *componentResponsePart;
390 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.29 */
392 typedef struct e2Ipaddr
400 E2IpAddr localIpAddress;
402 E2IpAddr destIpAddress;
407 typedef struct e2TimersInfo
410 uint8_t e2SetupTimerInterval;
417 E2Transaction e2TransInfo;
418 uint16_t numOfRanFunction;
419 RanFunction ranFunction[MAX_RAN_FUNCTION];
420 CmLListCp e2NodeComponentList;
421 uint8_t numOfTNLAssoc;
422 TNLAssociation tnlAssoc[MAX_TNL_ASSOCIATION];
423 E2TimersInfo e2TimersInfo;
426 typedef struct e2FailureCause
428 E2CauseType causeType;
432 uint8_t assignTransactionId();
433 uint8_t ResetE2Request(E2ProcedureDirection dir, E2FailureCause resetCause);
434 uint8_t SendE2APMsg(Region region, Pool pool, char *encBuf, int encBufSize);
435 /**********************************************************************
437 **********************************************************************/