# The Jenkins job requires a tag to build the Docker image.
# Global-JJB script assumes this file is in the repo root.
---
-tag: 8.0.1
+tag: 9.0.1
4. Install PCAP:
a. On ubuntu : sudo apt-get install -y libpcap-dev
b. On CentOS : sudo yum install -y libpcap-devel
+5. Install libxml2:
+ a. On Ubuntu : sudo apt-get install -y libxml2-dev
+ b. On CentOS : sudo yum install -y libxml2
C. Pre-requisite for O1 Interface (Required only if run with O1 interface enabled)
.. http://creativecommons.org/licenses/by/4.0
-
+########
API-Docs
-**********
+########
-This is the API-docs for H release o-du/l2.
+This is the API-docs for I release o-du/l2.
.. contents::
:depth: 3
:local:
-
Introduction
------------------
-This document tabulates the APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of
-ODU-High and their functionality.
-These are in line with ORAN-WG8.AAD-v7.00.00, hereafter referred to as AAD Spec.
+============
+
+This section tabulates the APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of
+ODU-High and also with external modules of ORAN.
+
+*****************
+F1 Interface APIs
+*****************
+
+Below table lists APIs Aligned(Implemented)/Not Implemented at F1 interface of
+ODU-High i.e. between O-DU and O-CU. These are in line with 3GPP 38.473 V15.3.0.
+
++------------+-------------------------------+-----------------+-----------+-----------------------------------------+
+| Interface | API | Status | Section | Remark |
++============+===============================+=================+===========+=========================================+
+| |Reset | Aligned |9.2.1.1 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Reset Acknowledge | Aligned |9.2.1.2 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Error Indication | Not Implemented |9.2.1.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |F1 Setup Request | Aligned |9.2.1.4 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |F1 Setup Response | Aligned |9.2.1.5 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |F1 Setup Failure | Not Implemented |9.2.1.6 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-DU Configuration Update | Aligned |9.2.1.7 | |
+| **CU** +-------------------------------+-----------------+-----------+-----------------------------------------+
+| & **DU** |GNB-DU Configuration Update | Aligned |9.2.1.8 | |
+| |Acknowledge | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-DU Configuration Update | Not Implemented |9.2.1.9 | |
+| |Failure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-CU Configuration Update | Not Implemented |9.2.1.10 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-CU Configuration Update | Not Implemented |9.2.1.11 | |
+| |Acknowledge | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-CU Configuration Update | Not Implemented |9.2.1.12 | |
+| |Failure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-DU Resource Coordination | Not Implemented |9.2.1.13 | |
+| |Request | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-DU Resource Coordination | Not Implemented |9.2.1.14 | |
+| |Response | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |GNB-DU Status Indication | Not Implemented |9.2.1.15 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Setup Request | Aligned |9.2.2.1 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Setup Response | Aligned |9.2.2.2 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Setup Faliure | Not Implemented |9.2.2.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Release Request | Aligned |9.2.2.4 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Release Command | Aligned |9.2.2.5 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Release Complete | Aligned |9.2.2.6 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Modification | Aligned |9.2.2.7 | |
+| |Request | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Modification | Aligned |9.2.2.8 | |
+| |Response | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Modification | Not Implemented |9.2.2.9 | |
+| |Failure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Modification | Not Implemented |9.2.2.10 | |
+| |Required | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Context Modification | Not Implemented |9.2.2.11 | |
+| |Confirm | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UE Inactivity Notification | Not Implemented |9.2.2.12 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Notify | Not Implemented |9.2.2.13 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Initial UL RRC Message | Aligned |9.2.3.1 | |
+| |Transfer | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |DL RRC Message Transfer | Aligned |9.2.3.2 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |UL RRC Message Transfer | Aligned |9.2.3.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Write-Replace Warning Request | Not Implemented |9.2.4.1 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Write-Replace Warning Response | Not Implemented |9.2.4.2 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |PWS Cancel Request | Not Implemented |9.2.4.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |PWS Cancel Response | Not Implemented |9.2.4.4 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |PWS Restart Indication | Not Implemented |9.2.4.5 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |PWS failure Indication | Not Implemented |9.2.4.6 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |System Information Delivery | Not Implemented |9.2.5.1 | |
+| |Command | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Paging | Aligned |9.2.6.1 | |
++------------+-------------------------------+-----------------+-----------+-----------------------------------------+
+
+*****************
+E2 Interface APIs
+*****************
+
+This section tabulates the APIs Aligned(Implemented)/Not Implemented between ODU-High and Near-RT RIC.
+These are in line with O-RAN.WG3.E2GAP-R003-v03.00 and O-RAN.WG3.E2AP-R003-v03.00.
+Below mentioned section number are taken reference from sections of O-RAN.WG3.E2AP-R003-v03.00.
+
++------------+-------------------------------+-----------------+-----------+-----------------------------------------+
+| Interface | API | Status |Section | Remark |
++============+===============================+=================+===========+=========================================+
+| |RIC Subscription procedure | Aligned |8.2.1 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Subscription Delete | Aligned |8.2.2 | |
+| |procedure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Subscription Delete | Aligned |8.2.2A | |
+| |Required procedure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Indication procedure | Aligned |8.2.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Control procedure | Not Implemented |8.2.4 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Subscription Modification | Aligned |8.2.5 | |
+| |procedure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| **DU** |RIC Subscription Modification | Aligned |8.2.6 | |
+| &**RIC** |Required procedure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC query procedure | Not Implemented |8.2.7 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |E2 Setup procedure | Aligned |8.3.1 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Reset procedure | Aligned |8.3.2 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Error Indication | Aligned |8.3.3 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |RIC Service Update procedure | Aligned |8.3.4 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |E2 Node Configuration Update | Aligned |8.3.5 | |
+| |procedure | | | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |E2 Connection Update procedure | Aligned |8.3.6 | |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |E2 Removal procedure | Aligned |8.3.7 | |
++------------+-------------------------------+-----------------+-----------+-----------------------------------------+
+
+********************************
+ODU-High Internal Interface APIs
+********************************
+
+Below table lists APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of ODU-High.
+These are in line with ORAN-WG8.AAD-v9.00.00, hereafter referred to as AAD Spec.
-Note: DU APP module consist functionality related to F1 Handler and O1 Handler
+Note: DU APP module consist functionality related to F1 Handler, E2 Handler and O1 Handler.
-API Table
------------
+------------+-------------------------------+-----------------+-----------+-----------------------------------------+
| Interface | API | Status | Section | Remark |
+============+===============================+=================+===========+=========================================+
| |UL Buffer Status Report Ind | Aligned |11.2.4.2.18| |
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| |Power Headroom Indication | Aligned |11.2.4.2.19| |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Request | Additional API | | Adding new statistics group |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Modification Request| Additional API | | Modification of statistics group |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Delete Request | Additional API | | Deletion of statistics group |
+------------+-------------------------------+-----------------+-----------+-----------------------------------------+
| |Cell Configuration Response | Aligned |11.2.4.3.1 | |
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| |RACH Resource Response | Additional API | |Response to RACH Resource Request for |
| | | | |dedicated resource for CF-RA |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Response | Additional API | |Response to statistics request |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Modification | Additional API | |Response to statistics modification |
+| |Resonse | | |request |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Delete Response | Additional API | |Response to statistics delete request |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Indication | Additional API | |Calculate the KPI related to a specific |
+| | | | |statistics group |
+------------+-------------------------------+-----------------+-----------+-----------------------------------------+
| |Cell Start | Aligned |1.1.1.1 | |
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| |Slot Indication | Additional API | |Indication about the ongoing SFN and |
| | | | | Slot information to DU APP |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Request | Additional API | | Adding new statistics at DU layer |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Response | Additional API | | Response to statistics request from MAC |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Modification Request| Additional API | | Modification of statistics at DU layer |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Modification | Additional API | | Response to statistics modification |
+| |Response | | | request from MAC |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Delete Request | Additional API | | Deletion of statistics at DU layer |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Delete Response | Additional API | | Response to statistics delete request |
+| | | | | from MAC |
+| +-------------------------------+-----------------+-----------+-----------------------------------------+
+| |Statistics Indication | Additional API | | Sending the calculated KPI value to DU |
+| | | | | from MAC |
+------------+-------------------------------+-----------------+-----------+-----------------------------------------+
| |UE Create | Aligned |11.2.5.1 | |
| +-------------------------------+-----------------+-----------+-----------------------------------------+
| | | | |every 60sec for every slice configured |
+------------+-------------------------------+-----------------+-----------+-----------------------------------------+
+
.. figure:: LicHeader.jpg
:width: 600
- :alt: Figure 17 License Header and Footer
+ :alt: Figure 29 License Header and Footer
- Figure 17 : License Header and Footer
+ Figure 29 : License Header and Footer
O-DU High code
---------------
.. figure:: ModeofCommunication.jpg
:width: 600
- :alt: Figure 18 Mode of communication between O-DU High entities
+ :alt: Figure 30 Mode of communication between O-DU High entities
- Figure 18: Mode of communication between O-DU High entities
+ Figure 30: Mode of communication between O-DU High entities
Steps of Communication
++++++++++++++++++++++
.. figure:: StepsOfCommunication.jpg
:width: 600
- :alt: Figure 19 Communication between entities
+ :alt: Figure 31 Communication between entities
- Figure 19: Steps of Communication between O-DU High entities
+ Figure 31: Steps of Communication between O-DU High entities
Communication with Intel O-DU Low
:width: 600
:alt: 5G NR Scheduler Framework Design
- Figure 20: 5G NR Scheduler Framework Design
+ Figure 32: 5G NR Scheduler Framework Design
- The code for scheduler has been divided into 2 parts i.e. the common APIs and scheduler-specific APIs.
- Any code (structure/API) which is specific to a scheduling algorithm must be within scheduler-specific files such as sch_rr.c and sch_rr.h for round-roubin scheduler.
:width: 600
:alt: Call flow example of Multi-Scheduling Algorithm framework
- Figure 21: Example of a call flow in multi-scheduling algorithm framework
+ Figure 33: Example of a call flow in multi-scheduling algorithm framework
Additional Utility Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+| 2023-12-14 | 7.0.1 | Radisys | I release |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
| 2023-06-13 | 6.0.1 | Radisys | H release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
- Ubuntu : sudo apt-get install -y libpcap-dev
- CentOS : sudo yum install -y libpcap-devel
+- libxml2
+ - Ubuntu : sudo apt-get install -y libxml2-dev
+ - CentOS : sudo yum install -y libxml2
Cloning code
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
-##################
+==================
O-DU High Overview
-##################
+==================
**********************
O-DU High Architecture
Figure 1 - O-DU High Architecture Diagram
-==============================
+******************************
O-DU High Thread Architecture
-==============================
+******************************
As shown in Figure 1, there are multiple entities within O-DU High. Modules sharing a
given color belong to one thread. O-DU architecture can be defined at a thread
- Thread 8: O1
-=================
+*****************
O-DU High Modules
-=================
+*****************
DU APP
-************
+------
This module configures and manages all the operations of O-DU.
It interfaces with external entities as follows:
- ASN.1 Codecs contain ASN.1 encode/decode functions which are used for System information, F1AP and E2AP messages.
5G NR RLC
-************
+---------
This module provides services for transferring the control and data messages
between MAC layer and O-CU (via DU App).
uplink and downlink functionality respectively.
5G NR MAC
-************
+------------
This module uses the services of the NR physical layer to send and receive data
on the various logical channels.
specification. It has a receiver thread to handle messages from L1.
5G NR SCH
-**********
+----------
- This module is completely encapuslated withing 5G NR MAC i.e. all interactions of the 5G NR SCH is via the 5G NR MAC.
- Schedules resources in UL and DL for cell and UE based procedures.
- SCH framework design supports plugging-in new scheduling algorithm easily. Refer to section "Scheduler Framework with plug-in support" in Developer-Guide document for details.
O-DU Utility and Common Functions
-*********************************
+---------------------------------
These modules contain platform specific files and support O-DU High functionality and message exchanges.
O1 Module
-*********
+---------
.. figure:: ODU-O1-Arch.jpg
:width: 554
- Interface Management
- - F1 Setup
-
- - gNB-DU Configuration Update
-
- - F1 Reset
-
- - PAGING
+ - F1 Setup
+
+ - gNB-DU Configuration Update
+
+ - F1 Reset
+
+ - PAGING
- UE Context Management
- - UE Context Setup
+ - UE Context Setup
- - UE Context Modification
+ - UE Context Modification
- - UE Context Release
+ - UE Context Release
- RRC Message Transfer
- - Initial UL RRC Message Transfer
+ - Initial UL RRC Message Transfer
- - DL RRC Message Transfer
+ - DL RRC Message Transfer
- - UL RRC Message Transfer
+ - UL RRC Message Transfer
- - RRC Delivery Report
+ - RRC Delivery Report
- Near RT RIC: O-DU High communicates with Near RT RIC on the E2 interface. The below E2AP messages are
- implemented, as per ORAN WG3.E2AP v02.00:
+ implemented, as per O-RAN.WG3.E2GAP-R003-v03.00 and O-RAN.WG3.E2AP-R003-v03.00.
- Global Procedures
- - E2 Setup
+ - E2 Setup
+
+ - E2 Node Configuration Update
+
+ - RIC Service Update
+
+ - E2 Connection Update
- - E2 Node Configuration Update
+ - E2 Removal
- - E2 Reset
+ - E2 Reset
+ - Error Indication
+
- Near RT RIC Functional Procedures
- - RIC Subscription
+ - RIC Subscription
- - RIC Indication
+ - RIC Subscription Modification
+
+ - RIC Subscription Modification Required
+
+ - RIC Subscription Delete
+
+ - RIC Subscription Delete Required
+
+ - RIC Indication
- O-DU Low: O-DU High communicates with O-DU Low on the FAPI interface. The below FAPI messages are supported,
as per FAPI interface files shared by Intel:
- P5 messages - PHY mode control interface
-
- - PARAM.request/PARAM.response
+
+ - PARAM.request/PARAM.response
- - CONFIG.request/CONFIG.response
+ - CONFIG.request/CONFIG.response
- - START.request
+ - START.request
- - STOP.request
+ - STOP.request
- - STOP.indication
+ - STOP.indication
- P7 messages - Main data path interface
- - DL_TTI.request
+ - DL_TTI.request
- - UL_TTI.request
+ - UL_TTI.request
- - SLOT.indication
+ - SLOT.indication
- - UL_DCI.request
+ - UL_DCI.request
- - TX_Data.request
+ - TX_Data.request
- - RX_Data.indication
+ - RX_Data.indication
- - CRC.indication
+ - CRC.indication
- - UCI.indication
+ - UCI.indication
- - RACH.indication
+ - RACH.indication
- OAM: O-DU High communicates with OAM on the O1 interface.
O-DU High functionality
***********************
-===============================
Cell Up and Broadcast Procedure
-===============================
+-------------------------------
This section describes the cell-up procedure within O-DU High.
- The 5G NR MAC mutiplexes the PDU and sends SSB/SIB1 packets towards the O-DU Low through the Lower MAC.
-=====================
UE Related Procedure
-=====================
+---------------------
The O-DU High supports
- RRC Release
-================================
Closed Loop Automation Procedure
-================================
+--------------------------------
This section describes the closed loop automation procedure within O-DU High.
7. On receiving cell bring up command from SMO, the complete Cell bring up and UE attach procedure will be repeated (as explained in above sections)
-===================================
O1 Netconf get-alarm list procedure
-===================================
+-----------------------------------
This section describes the *Health Status Retrieval* scenario of O-DU High health-check. It enables a northbound client(SMO) to retrieve the health of the O-DU High based on the last self-check performed. The alarm-list is provided as the response to the request via O1 Netconf interface.
- The callback function fetches the alarm list from Alarm Manager and sends it back to the client (SMO/OAM) via Netconf interface.
-==========================
Network Slicing procedure
-==========================
+--------------------------
This section describes the Network Slicing feature within O-DU High.
- Scheduler updates the received Slice Configuration in its DB and sends back the Slice Reconfiguration Response to MAC and further MAC forwards it to DU APP. Scheduler applies the optimized RRM policies for the dedicated slice.
-==========================
Idle Mode Paging procedure
-==========================
+--------------------------
This section describes the Idle Mode Paging procedure within O-DU High.
- MAC forwards the PAGE to PHY in TX_Data.Request.
-==============================
Inter-DU Handover within O-CU
-==============================
+------------------------------
This section describes the handling of inter-DU handover of a UE within O-DU High.
- The source O-DU responds to O-CU with UE CONTEXT RELEASE COMPLETE message.
-==============================
Inter-CU Handover (Xn-Based)
-==============================
+------------------------------
This section describes the handling of inter-CU handover of a UE over Xn interface.
- DU releases UE context at all layers and responds to source GNB CU with UE CONTEXT RELEASE COMPLETE message.
-=============================
Discontinuous reception (DRX)
-=============================
+-----------------------------
This section describes the Discontinuous reception (DRX) feature within O-DU High.
- If O-DU receives DRX configuration release indicator IE as a part of UE CONTEXT MODIFICATION REQUEST from O-CU, DU APP will forward this indicator to MAC which forwards it to SCH as part of UE reconfiguration request. In this case SCH stops all DRX timers, deletes DRX configuration and marks UE as active by default.
-***********************
+
+E2AP Functionality
+------------------
+
+O-DU High communicates with Near RT RIC on the E2 interface using various Global Procedures and Near-RT RIC Functional Procedures.
+The implementation of these procedures are strictly compliant to O-RAN.WG3.E2GAP-R003-v03.00, O-RAN.WG3.E2AP-R003-v03.00.
+
+ODU-High supports E2 Service Model-Key Performance Measurement, compliant to O-RAN.WG3.E2SM-KPM-R003-v03.00.
+Following KPIs are implemented in ODU-High as part of E2SM-KPM. These comply with 3GPP 28.552 v15.6.0 section 5.1.1.2 Radio resource utilization.
+
++--------------------------------+-----------+-----------------------------------------+
+| KPI | Section | Remark |
++================================+===========+=========================================+
+|DL Total PRB Usage(RRU.PrbTotDl)| 5.1.1.2.1 | Calulates the total usage of PRBs on DL |
++--------------------------------+-----------+-----------------------------------------+
+|UL Total PRB Usage(RRU.PrbTotUl)| 5.1.1.2.2 | Calulates the total usage of PRBs on UL |
++--------------------------------+-----------+-----------------------------------------+
+
+E2 API Flow Triggered in ODU-High's stub-based test framework
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+This section describes the E2AP messages triggered when executing O-DU High in stub-based test framework.
+
+
+.. figure:: E2AP_Flow_Triggered_In_Code.PNG
+ :width: 600
+ :alt: E2AP Flow Triggered In Code
+
+ Figure 16 - E2AP Flow Triggered In Code
+
+E2AP Procedures Supported in ODU-High
+++++++++++++++++++++++++++++++++++++++
+
+This section contains flow diagrams for E2AP procedures that may/may not be triggered in ODU-High, however the code supports its working as per O-RAN WG3 E2 specifications.
+
+
+E2 Setup Procedure
+^^^^^^^^^^^^^^^^^^
+
+
+This section describes the E2 Setup Procedure within O-DU High and Near-RT RIC.
+
+
+.. figure:: E2_Setup_Procedure.PNG
+ :width: 600
+ :alt: E2 Setup Procedure
+
+ Figure 17 - E2 Setup Procedure
+
+E2 Node Configuration Update Procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the E2 Node Configuration Procedure within O-DU High and Near-RT RIC.
+
+.. figure:: E2_Node_Configuration_Update_Procedure.PNG
+ :width: 600
+ :alt: E2 Node Configuration Update Procedure
+
+ Figure 18 - E2 Node Configuration Update Procedure
+
+
+RIC Service Update procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the RIC Service Update Procedure within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by ODU-High.
+
+.. figure:: RIC_Service_Update_Procedure.PNG
+ :width: 600
+ :alt: RIC Service Update Procedure
+
+ Figure 19 - RIC Service Update Procedure
+
+
+E2 Connection Update Procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the E2 Connection Update Procedure within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by stub-based framework.
+
+.. figure:: E2_Connection_Update_Procedure.PNG
+ :width: 600
+ :alt: E2 Connection Update Procedure
+
+ Figure 20 - E2 Connection Update Procedure
+
+
+E2 Removal Procedure
+^^^^^^^^^^^^^^^^^^^^
+
+This section describes the E2 removal Procedure from both DU-initiated and RIC-initiated within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by ODU-High or Stub-based test framework as of now.
+
+.. figure:: E2_Removal_Procedure(DU-initiated).PNG
+ :width: 600
+ :alt: E2 Removal Procedure(DU-initiated)
+
+ Figure 21 - E2 Removal Procedure(DU-initiated)
+
+.. figure:: E2_Removal_Procedure(RIC-initiated).PNG
+ :width: 600
+ :alt: E2 Removal Procedure(RIC-initiated)
+
+ Figure 22 - E2 Removal Procedure(RIC-initiated)
+
+
+Reset Procedure
+^^^^^^^^^^^^^^^
+
+This section describes the Reset Procedure from both DU-initiated and RIC-initiated within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by ODU-High or Stub-based test framework as of now.
+
+.. figure:: Reset_Procedure(DU-initiated).PNG
+ :width: 600
+ :alt: Reset Procedure(DU-initiated)
+
+ Figure 23 - Reset Procedure(DU-initiated)
+
+.. figure:: Reset_Procedure(RIC-initiated).PNG
+ :width: 600
+ :alt: Reset Procedure(RIC-initiated)
+
+ Figure 24 - Reset Procedure(RIC-initiated)
+
+
+
+
+Error Indication Procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This procedure can be triggered from either O-DU or Near-RT RIC. It informs that an error has been found in DU or Near-RT RIC.
+Note - This API is not currently triggered by ODU-High or Stub-based test framework as of now.
+
+RIC Subscription Procedure / RIC Indication
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the RIC Subscription Procedure within O-DU High and Near-RT RIC. In addition to this procedure, the RIC indication procedure has been described.
+
+.. figure:: RIC_Subscription_Procedure.PNG
+ :width: 600
+ :alt: RIC Subscription Procedure
+
+ Figure 25 - RIC Subscription Procedure
+
+
+RIC Subscription Modification Required
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Only framework is added as part of this procedure. The complete handling and flow will be added once use-case is determined.
+
+
+RIC Subscription Modification Procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the RIC Subscription Modification Procedure within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by stub-based framework.
+
+.. figure:: RIC_Subscription_Modification_Procedure.png
+ :width: 600
+ :alt: RIC Subscription Modification Procedure
+
+ Figure 26 - RIC Subscription Modification Procedure
+
+
+RIC Subscription Delete Procedure
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This section describes the RIC Subscription Delete Procedure within O-DU High and Near-RT RIC.
+Note - This API is not currently triggered by stub-based framework.
+
+.. figure:: RIC_Subscription_Delete_Procedure.PNG
+ :width: 600
+ :alt: RIC Subscription Delete Procedure
+
+ Figure 27 - RIC Subscription Delete Procedure
+
+
OSC Testcases Supported
-***********************
+-----------------------
The O-DU High partially supports below use-cases:
Release-Notes
**************
-This document provides the release notes for H Release of O-DU-L2.
+This document provides the release notes for I Release of O-DU-L2.
.. contents::
:depth: 3
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
+| 2023-12-14 | 9.0.0 | Radisys | I release |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
| 2023-05-15 | 8.0.0 | Radisys | H release |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Summary
-------
+I- release
+^^^^^^^^^^
+This release contains the following:
+
+ - Alignment to E2 interface "O-RAN.WG3.E2AP-R003-v03.00" and "O-RAN.WG3.E2SM-KPM-R003-v03.00" specifications
+ - All Global Procedures
+ - Near-RT RIC Functional Procedures
+ - Supporting Radio resource utilization related KPIs
+
+ - Alignment to latest "O-RAN WG8 AAD v09.00" Specification
+
+ - Multi UE (max=2) scheduling per TTI in scheduler
+ - Supporting DL scheduling only
+
+ - XML based input configuration for ODU-High
+
H- release
^^^^^^^^^^
This release contains the following:
- Upgrade to E2AP v3.0 and implementation of E2 messages
- - E2 Setup failure
- - Reset Procedure
+ - E2 Setup failure
+ - Reset Procedure
- End-to-end integration support
- - Testing with TM500 UE simulator to detect broadcast message
+ - Testing with TM500 UE simulator to detect broadcast message
G- release
^^^^^^^^^^
- End-to-end integration support
- - WLS memory management update aligned with latest odu-low (FlexRAN 21.11 intel L1)
- - Upgrade to the latest FAPI Interface and vendor-specific messages
- - Successfully tested broadcast message reception at L1
+ - WLS memory management update aligned with latest odu-low (FlexRAN 21.11 intel L1)
+ - Upgrade to the latest FAPI Interface and vendor-specific messages
+ - Successfully tested broadcast message reception at L1
F- release
^^^^^^^^^^
Release Data
------------
+I release
+^^^^^^^^^^
++--------------------------------------+------------------------------------------+
+| **Project** | ODUHIGH |
+| | |
++--------------------------------------+------------------------------------------+
+| **Repo/commit-ID** | o-du/l2/ |
+| | I79a886d474175ca20d2b7e8b38fa63a0ce1b3477|
++--------------------------------------+------------------------------------------+
+| **Release designation** | I release |
+| | |
++--------------------------------------+------------------------------------------+
+| **Release date** | 2023-12-14 |
+| | |
++--------------------------------------+------------------------------------------+
+| **Purpose of the delivery** | I release |
+| | |
++--------------------------------------+------------------------------------------+
+
H release
^^^^^^^^^^
+--------------------------------------+------------------------------------------+
**JIRA BACK-LOG:**
+I-release
+^^^^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-516 | Alignment to "O-RAN.WG3.E2AP-R003-v03.00" and |
+| | "O-RAN.WG3.E2SM-KPM-R003-v03.00" |
+| | |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-517 | Multi UE per slot scheduling |
+| | |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-518 | Alignment to ORAN WG8 AAD v9.0 specification |
+| | |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-538 | XML based input configuration for ODU-High |
+| | |
++-----------------------------------------------+-----------------------------------------------+
+
H-release
^^^^^^^^^^
- Cell broadcast is for SSB and SIB1 only.
-- FAPI files not in-line with SCF FAPI 1.0.5.
+- FAPI files not in-line with SCF FAPI 222.10.02.
O-DU High currently compatible with FAPI files provided by Intel.
- Implementation of F1 reset is limited to intializing UE contexts.
-- E2 interface is limited to Traffic Steering Usecase.
-
-- Forming of RIC event trigger definition, RIC indication header and RIC indication message is unclear in the E2AP draft spec versions. Therefore, implementation does not contain accurate values. Contents of RIC indication message are mocked and triggered just once.
+- E2 interface is limited to KPM service model.
- On the F1-U interface, UE, RB and tunnel configurations are static.
- We have to manually download the 3GPP yang models and install.
+- Currently, only two Radio resource utilization related KPIs are calculated.
+ - DL Total PRB Usage.
+ - UL Total PRB Usage.
+
+- Multi UE scheduling per TTI is supported up to 2 UEs as of now.
+
+- Currently, only DL supports multi-UE scheduling. UL supports single-UE scheduling per TTI
+
+
Known Issues
^^^^^^^^^^^^^
Workarounds
^^^^^^^^^^^
-O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
+O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 222.10.02.
References
----------
-1. ORAN-WG8.AAD.0-v07.00.00
+1. ORAN-WG8.AAD.0-v09.00.00
2. O-RAN.WG5.C.1-v05.00
-3. ORAN WG3.E2AP v03.00
+3. O-RAN.WG3.E2GAP-R003-v03.00
+
+4. O-RAN.WG3.E2AP-R003-v03.00
+
+5. O-RAN.WG3.E2SM-KPM-R003-v03.00
+
+6. 3GPP TS 28 552 V15.6.0
-4. 3GPP 38.473-f60 v15.3
+7. 3GPP TS 38.473 v15.3
-5. 3GPP TS 38.211 v15.3
+8. 3GPP TS 38.211 v15.3
-6. 3GPP TS 38.212 v15.3
+9. 3GPP TS 38.212 v15.3
-7. 3GPP TS 38.213 v15.3
+10. 3GPP TS 38.213 v15.3
-8. 3GPP TS 38.214 v15.3
+11. 3GPP TS 38.214 v15.3
-9. 3GPP TS 38.321 v15.3
+12. 3GPP TS 38.321 v15.3
-10. 3GPP TS 38.331 v15.3
+13. 3GPP TS 38.331 v15.3
-11. 5G PHY FAPI Specification v1.0.5
+14. 5G PHY FAPI Specification v1.0.5
-12. 3GPP TS 28.541 Specfication V16.6
+15. 3GPP TS 28.541 Specfication V16.6
-13. O-RAN WG1.O1-Interface v04.00
+16. O-RAN WG1.O1-Interface v04.00
-14. O-RAN WG1.OAM-Architecture v04.00
+17. O-RAN WG1.OAM-Architecture v04.00
User Guide
***********
-This is the user guide for H release of O-DU/l2.
+This is the user guide for I release of O-DU/l2.
Follow installation-guide to get all the dependencies ready.
.. contents::
The call flow between O-DU High and CU Stub can be achieved by executing docker containers.
- Pull the last built docker images:
- - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:8.0.1
+ - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:9.0.1
- docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:
- Run CU Stub docker:
- docker run -it --privileged --net=host --entrypoint bash
- nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:8.0.1
+ nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:9.0.1
- ./cu_stub
- Run ODU docker:
- docker run -it --privileged --net=host --entrypoint bash
- nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:8.0.1
+ nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:9.0.1
- ./odu
.. figure:: O-DU_High_Low_Flow.PNG
:width: 600
- :alt: Figure 16 O-DU High - O-DU Low Message Flow Diagram
+ :alt: Figure 28 O-DU High - O-DU Low Message Flow Diagram
- Figure 16 - O-DU High - O-DU Low Message Flow Diagram
+ Figure 28 - O-DU High - O-DU Low Message Flow Diagram
Note: UL IQ-Sample request and response are needed by Intel O-DU Low in timer mode(testing mode) only. Code changes for
these are guarded under INTEL_TIMER_MODE flag which can be enabled using compilation option "PHY_MODE=TIMER", as
---
distribution_type: container
-container_release_tag: 8.0.1
+container_release_tag: 9.0.1
container_pull_registry: nexus.o-ran-sc.org:10004
container_push_registry: nexus.o-ran-sc.org:10002
project: o-du-l2
-ref: 2e1af025a72168244cc7d7697b069a26edd859e0
+ref:b0c4e8f48a66303433e9a57d7a470757c8030067
containers:
- name: o-du-l2
-version: 8.0.1
+version: 9.0.1
---
distribution_type: container
-container_release_tag: 8.0.1
+container_release_tag: 9.0.1
container_pull_registry: nexus.o-ran-sc.org:10004
container_push_registry: nexus.o-ran-sc.org:10002
project: o-du-l2
-ref: 2e1af025a72168244cc7d7697b069a26edd859e0
+ref:b0c4e8f48a66303433e9a57d7a470757c8030067
containers:
- name: o-du-l2-cu-stub
-version: 8.0.1
+version: 9.0.1
Code Review / o-du / l2.git / commitdiff
.PNG;h=65e225620b591a7311218c46716caef35cf303bc;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c){kind=link}
.PNG;h=f8b64ab7154e10960efd74c4f59ccfab48e4d812;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c){kind=link}
.PNG;h=43cb900884a42278d4afca407ccb59965dfa06d6;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c){kind=link}
.PNG;h=512bec851202793538c446c507140aae96a51432;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c){kind=link}