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 */
21 #define MAX_NUM_TRANSACTION 256 /* As per, O-RAN WG3 E2AP v3.0, section 9.2.33 */
22 #define MAX_E2_SETUP_TMR 1
23 #define EVENT_E2_SETUP_TMR 1
24 #define MAX_RAN_FUNCTION 256 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.2 : maxofRANfunctionID */
25 #define MAX_E2_NODE_COMPONENT 1024 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.2 : maxofE2nodeComponents */
26 #define MAX_TNL_ASSOCIATION 32 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.2.11 : maxofTNLA */
27 #define MAX_RIC_STYLES 64 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 : maxnoofRICstyle */
28 #define MAX_MEASUREMENT_INFO 65535 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 : maxnoofMeasurementInfo */
29 #define MAX_LABEL_INFO 2147483648 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 : maxnoofLabelInfo */
30 #define MAX_RIC_ACTION 16 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
31 #define MAX_RIC_REQUEST 65535 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.7 */
33 #define STRING_SIZE_150_BYTES 150
34 #define STRING_SIZE_1000_BYTES 1000
36 #define SHORT_NAME "ORAN-E2SM-KPM"
37 #define SERVICE_MODEL_OID "1.3.6.1.4.1.53148.1.2.2.2"
38 #define DESCRIPTION "KPM Monitor"
39 #define NUM_OF_EVENT_TRIGGER_STYLE_SUPPORTED 1
40 #define EVENT_TRIGGER_STYLE_NAME "Periodic Report"
41 #define EVENT_TRIGGER_STYLE_TYPE 1
42 #define EVENT_TRIGGER_STYLE_FORMAT_TYPE 1
43 #define NUM_OF_RIC_REPORT_STYLE_SUPPORTED 1
44 #define REPORT_STYLE_NAME "E2 Node Measurement"
45 #define REPORT_STYLE_TYPE 1
46 #define REPORT_ACTION_FORMAT_TYPE 1
47 #define MEASUREMENT_TYPE_NAME (char*[]) {"RRU.PrbTotDl", "RRU.PrbTotUl"}
48 #define RIC_INDICATION_HEADER_FORMAT 1
49 #define RIC_INDICATION_MESSAGE_FORMAT 1
51 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26 */
65 E2_NODE_COMPONENT_ADD,
66 E2_NODE_COMPONENT_UPDATE
69 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.30 */
77 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.11 */
89 }E2ProcedureDirection;
93 E2_RAN_FUNCTION_ID_INVALID,
94 E2_ACTION_NOT_SUPPORTED,
95 E2_EXECESSIVE_ACTIONS,
97 E2_DUPLICATE_EVENT_TRIGGER,
98 E2_FUNCTION_RESOURCE_LIMIT,
99 E2_REQUEST_ID_UNKNOWN,
100 E2_INCONSISTENT_ACTION_SUBSEQUENT_ACTION_SEQUENCE,
101 E2_CONTROL_MESSAGE_INVALID,
102 E2_RIC_CALL_PROCESS_ID_INVALID,
103 E2_CONTROL_TIMER_EXPIRED,
104 E2_CONTROL_FAILED_TO_EXECUTE,
106 E2_RIC_REQUEST_CAUSE_UNSPECIFIED,
107 E2_RIC_SUBSCRIPTION_END_TIME_EXPIRED,
108 E2_RIC_SUBSCRIPTION_END_TIME_INVALID,
109 E2_DUPLICATE_RIC_REQUEST_ID,
110 E2_EVENT_TRIGGER_NOT_SUPPORTED,
111 E2_REQUEST_INFORMATION_UNAVAILABLE,
112 E2_INVALID_INFORMATION_REQUEST
117 E2_RAN_FUNCTION_NOT_SUPPORTED,
118 E2_EXCESSIVE_FUNCTIONS,
119 E2_RIC_RESOURCE_LIMIT,
124 E2_NODE_COMPONENT_UNKNOWN
129 E2_TRANSPORT_CAUSE_UNSPECIFIED,
130 E2_TRANSPORT_RESOURCE_UNAVAILABLE
135 E2_TRANSFER_SYNTAX_ERROR,
136 E2_ABSTRACT_SYNTAX_ERROR_REJECT,
137 E2_ABSTRACT_SYNTAX_ERROR_IGNORE_AND_NOTIFY,
138 E2_MESSAGE_NOT_COMPATIBLE_WITH_RECEIVER_STATE,
140 E2_ABSTRACT_SYNTAX_ERROR_FALSELY_CONSTRUCTED_MESSAGE,
141 E2_PROTOCOL_CAUSE_UNSPECIFIED
146 E2_CONTROL_PROCESSING_OVERLOAD,
149 E2_MISCELLANEOUS_CAUSE_UNSPECIFIED
163 typedef uint8_t E2Cause;
167 uint8_t transactionId;
168 uint8_t procedureCode;
171 typedef struct e2Transcation
173 uint8_t transIdCounter; /* counting the total number of DU initiated transaction */
174 E2TransInfo e2InitTransaction[MAX_NUM_TRANSACTION]; /* Storing DU-initiated transactions information */
175 E2TransInfo ricInitTransaction[MAX_NUM_TRANSACTION]; /* Storing RIC-initiated transactions information */
178 typedef struct e2Timer
180 CmTimer e2SetupTimer;
181 /* More timers can be added to this structure in future */
185 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.4 */
189 uint32_t nearRtRicId;
192 /* O-RAN.WG3.E2SM-R003-v03.00 : Section 6.2.2.1 */
195 char shortName[STRING_SIZE_150_BYTES];
196 char serviceModelOID[STRING_SIZE_1000_BYTES];
197 char description[STRING_SIZE_150_BYTES];
200 /* O-RAN.WG3.E2SM-R003-v03.00 : Section 6.2.2.2-6.2.2.4 */
204 char name[STRING_SIZE_150_BYTES];
208 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 */
211 char measurementTypeName[STRING_SIZE_150_BYTES];
212 uint16_t measurementTypeId;
213 }MeasurementInfoForAction;
217 RicStyle reportStyle;
218 CmLListCp measurementInfoList;
221 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.7 */
224 uint16_t requestorId;
228 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.1.1 */
231 uint32_t reportingPeriod;
232 }EventTriggerFormat1;
234 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.1 */
240 EventTriggerFormat1 format1;
241 /* More formats can be added in future */
243 }EventTriggerDefinition;
245 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.3.11 */
248 /* TODO : To be added in future when subcounters for any
249 * measurment type is required */
252 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 */
257 char measurementTypeName[STRING_SIZE_150_BYTES];
258 uint16_t measurementTypeId;
261 /* As of now Labels are not used, hence it is not implemented completely */
262 //uint32_t numOfLabels;
263 //LabelInfo LabelInfoList[MAX_LABEL_INFO];
265 CmLListCp measuredValue; /* To be filled when numOfLabels is 0, else values are calculated per Label */
268 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.1 */
271 CmLListCp measurementInfoList; /* Each node corresponds to MeasurementInfo */
272 uint32_t granularityPeriod; /* In millisecond */
275 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.2 */
278 /* TODO : This format will be defined in future if required */
281 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.3 */
284 /* TODO : This format will be defined in future if required */
287 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.4 */
290 /* TODO : This format will be defined in future if required */
293 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2.5 */
296 /* TODO : This format will be defined in future if required */
299 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.1.2 */
305 ActionDefFormat1 format1;
306 ActionDefFormat2 format2;
307 ActionDefFormat3 format3;
308 ActionDefFormat4 format4;
309 ActionDefFormat5 format5;
313 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
318 ActionDefinition definition;
322 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 : maxofRICActionID */
325 RicRequestId requestId;
326 EventTriggerDefinition eventTriggerDefinition;
327 uint8_t numOfActions;
328 ActionInfo actionSequence[MAX_RIC_ACTION];
333 /* O-RAN.WG3.E2SM-KPM-R003-v03.00 : Section 8.2.2.1 */
335 RanFunctionName name;
336 uint16_t revisionCounter;
337 uint8_t numOfEventTriggerStyleSupported;
338 RicStyle eventTriggerStyleList[MAX_RIC_STYLES];
339 uint8_t numOfReportStyleSupported;
340 RicReportStyle reportStyleList[MAX_RIC_STYLES];
341 uint8_t ricIndicationHeaderFormat;
342 uint8_t ricIndicationMessageFormat;
343 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.1.1.1 */
344 CmLListCp subscriptionList;
347 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.26-9.2.27 */
350 InterfaceType interfaceType;
351 uint64_t componentId;
352 ComponentActionType componentActionType;
354 uint8_t *componentRequestPart;
356 uint8_t *componentResponsePart;
359 /* O-RAN.WG3.E2AP-R003-v03.00 : Section 9.2.29 */
361 typedef struct e2Ipaddr
369 E2IpAddr localIpAddress;
371 E2IpAddr destIpAddress;
376 typedef struct e2TimersInfo
379 uint8_t e2SetupTimerInterval;
386 E2Transaction e2TransInfo;
387 uint16_t numOfRanFunction;
388 RanFunction ranFunction[MAX_RAN_FUNCTION];
389 CmLListCp e2NodeComponentList;
390 uint8_t numOfTNLAssoc;
391 TNLAssociation tnlAssoc[MAX_TNL_ASSOCIATION];
392 E2TimersInfo e2TimersInfo;
398 uint16_t revisionCounter;
404 uint8_t addArr[MAX_RAN_FUNCTION];
406 uint8_t modArr[MAX_RAN_FUNCTION];
408 RanFuncInfo delArr[MAX_RAN_FUNCTION];
411 uint8_t assignTransactionId();
412 uint8_t ResetE2Request(E2ProcedureDirection dir, E2CauseType type, E2Cause cause);
413 uint8_t SendE2APMsg(Region region, Pool pool, char *encBuf, int encBufSize);
414 /**********************************************************************
416 **********************************************************************/