[Epic-ID: ODUHIGH-462][Task-ID: ODUHIGH-482] G release documentation 25/10025/5
authorlal.harshita <Harshita.Lal@radisys.com>
Thu, 8 Dec 2022 10:36:08 +0000 (16:06 +0530)
committerlal.harshita <Harshita.Lal@radisys.com>
Thu, 15 Dec 2022 06:09:43 +0000 (11:39 +0530)
Signed-off-by: lal.harshita <Harshita.Lal@radisys.com>
Change-Id: I05aa5e6890842c41ebed3f7bd07b07708bbaaf34
Signed-off-by: lal.harshita <Harshita.Lal@radisys.com>
13 files changed:
container-tag.yaml
docs/Discontinuous_reception.PNG [new file with mode: 0644]
docs/Drx_Dl_Harq_Retransmission_Timer.png [new file with mode: 0644]
docs/Drx_Onduration_Inactive_ShortCycle_Timer.png [new file with mode: 0644]
docs/Drx_Ul_Harq_Retransmission_Timer.png [new file with mode: 0644]
docs/api-docs.rst
docs/developer-guide.rst
docs/installation-guide.rst
docs/overview.rst
docs/release-notes.rst
docs/user-guide.rst
releases/container-release-o-du-l2
releases/container-release-o-du-l2-cu-stub

index fe0dfef..ef4304f 100644 (file)
@@ -1,4 +1,4 @@
 # The Jenkins job requires a tag to build the Docker image.
 # Global-JJB script assumes this file is in the repo root.
 ---
-tag: 6.0.4
+tag: 7.0.1
diff --git a/docs/Discontinuous_reception.PNG b/docs/Discontinuous_reception.PNG
new file mode 100644 (file)
index 0000000..0c664cf
Binary files /dev/null and b/docs/Discontinuous_reception.PNG differ
diff --git a/docs/Drx_Dl_Harq_Retransmission_Timer.png b/docs/Drx_Dl_Harq_Retransmission_Timer.png
new file mode 100644 (file)
index 0000000..7742ced
Binary files /dev/null and b/docs/Drx_Dl_Harq_Retransmission_Timer.png differ
diff --git a/docs/Drx_Onduration_Inactive_ShortCycle_Timer.png b/docs/Drx_Onduration_Inactive_ShortCycle_Timer.png
new file mode 100644 (file)
index 0000000..34334e3
Binary files /dev/null and b/docs/Drx_Onduration_Inactive_ShortCycle_Timer.png differ
diff --git a/docs/Drx_Ul_Harq_Retransmission_Timer.png b/docs/Drx_Ul_Harq_Retransmission_Timer.png
new file mode 100644 (file)
index 0000000..86339f8
Binary files /dev/null and b/docs/Drx_Ul_Harq_Retransmission_Timer.png differ
index 16323d8..9cbbff6 100644 (file)
@@ -6,7 +6,7 @@
 API-Docs
 **********
 
-This is the API-docs for F release o-du/l2.
+This is the API-docs for G release o-du/l2.
 
 .. contents::
    :depth: 3
@@ -89,6 +89,9 @@ API Functions
       p. UL HARQ CRC Indication : MAC receives CRC Indication from PHY and forwards the decoded results to SCH as per Section 
          9.2.3.2.9 of the AAD Spec.
 
+      q. Scheduling Request Indication : MAC indicates to scheduler through this API when UE has to be scheduled for uplink 
+         grant as per Spec 9.2.3.2.17 of the AAD Spec.
+
    B. Scheduler to MAC
 
       a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.3.3.1 of the AAD Spec.
@@ -120,6 +123,7 @@ API Functions
       l. Downlink Paging Allocation :  Provides DCI and DL data scheduling information for any Paging queued for a given slot 
          for Paging Channel, as per Section 9.2.3.3.13 of the AAD Spec.
 
+      m. Ue Configuration Response : Response to UE reconfiguration request from MAC, as per Section 9.2.3.3.5 of the AAD Spec.
 
 3. DU APP - MAC Interface
 
@@ -175,7 +179,7 @@ API Functions
 
    B. RLC to DU APP
 
-      a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.5.3 of the AAD Spec.
+      a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.5.2 of the AAD Spec.
 
       b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.5.4 of the AAD Spec.
 
index c5f3364..2340191 100644 (file)
@@ -26,9 +26,9 @@ O-DU High uses C languages. The coding guidelines followed are:
 
 .. figure:: LicHeader.jpg
   :width: 600
-  :alt: Figure 8 License Header and Footer
+  :alt: Figure 16 License Header and Footer
 
-  Figure 8 : License Header and Footer
+  Figure 16 : License Header and Footer
 
 O-DU High code
 ---------------
@@ -280,9 +280,9 @@ Here,
 
 .. figure:: ModeofCommunication.jpg
    :width: 600
-   :alt: Figure 9 Mode of communication between O-DU High entities
+   :alt: Figure 17 Mode of communication between O-DU High entities
 
-   Figure 9: Mode of communication between O-DU High entities
+   Figure 17: Mode of communication between O-DU High entities
 
 Steps of Communication
 ++++++++++++++++++++++
@@ -344,9 +344,9 @@ Below figure summarized the above steps of intra O-DU High communication
 
 .. figure:: StepsOfCommunication.jpg
    :width: 600
-   :alt: Figure 10 Communication between entities
+   :alt: Figure 18 Communication between entities
 
-   Figure 10: Steps of Communication between O-DU High entities
+   Figure 18: Steps of Communication between O-DU High entities
 
 
 Communication with Intel O-DU Low
index 3a74891..43f8cc2 100644 (file)
@@ -18,6 +18,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2022-12-15         |  5.0.0             |  Radisys,          |  G release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2022-06-16         |  4.0.0             |  Radisys,          |  F release         |
 |                    |                    |  HCL Technologies  |                    |
 |                    |                    |  Ltd.              |                    |
index 3578092..54dae01 100644 (file)
@@ -1,12 +1,13 @@
 .. 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
------------------------
+**********************
 
 O-DU implements the functional blocks of L2 layer of a 5G NR protocol stack in SA(StandAlone) mode.
 These layers primarily include NR MAC, NR Scheduler and NR RLC layers.
@@ -19,6 +20,7 @@ O-DU modules are developed as shown in the below diagram.
 
   Figure 1 - O-DU High Architecture Diagram
 
+==============================
 O-DU High Thread Architecture
 ==============================
 
@@ -42,11 +44,13 @@ level as follows:
 
 - 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:
 
@@ -74,7 +78,8 @@ DU App submodules are 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).
 
@@ -82,7 +87,8 @@ 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.
 Functions of the 5G NR MAC module are as follows:
@@ -97,12 +103,13 @@ Functions of the 5G NR MAC module are as follows:
 
 
 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
@@ -126,9 +133,9 @@ O1 architecture has following components:
 
 - Netopeer server: Serves the northbound SMO/OAM Netconf requests.
 
-
-O-DU-High Interfaces
---------------------
+**********************
+O-DU High Interfaces
+**********************
 
 This section describes the other modules that O-DU High interfaces with, as shown in below diagram.
 
@@ -227,12 +234,13 @@ As shown in Figure 3, O-DU High interfaces with the following modules:
 
 
 
+***********************
 O-DU High functionality
------------------------
-
+***********************
 
+===============================
 Cell Up and Broadcast Procedure
-================================
+===============================
 
 This section describes the cell-up procedure within O-DU High.
 
@@ -276,10 +284,9 @@ As seen in the Figure 4,
 - 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 
 
@@ -335,6 +342,7 @@ Figure 5 below depicts the above call flow, inclusive of all interfaces:
 
   - RRC Release
 
+================================
 Closed Loop Automation Procedure
 ================================
 
@@ -361,7 +369,7 @@ 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
 ===================================
 
@@ -370,7 +378,7 @@ This section describes the *Health Status Retrieval* scenario of O-DU High healt
 
 .. figure:: ODU-O1-GetAlarmListFlow.jpg
   :width: 869
-  :alt: Figure 6 O1 get alarm-list flow  
+  :alt: Figure 7 O1 get alarm-list flow  
 
   Figure 7 - O1 get alarm-list flow
 
@@ -386,9 +394,9 @@ As seen in the Figure 7,
 
 - 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.
 
@@ -413,9 +421,9 @@ As seen in the Figure 8,
 
 - 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.
 
@@ -438,8 +446,9 @@ As seen in the Figure 9,
 
 - 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.
 
@@ -447,7 +456,7 @@ This section describes the handling of inter-DU handover of a UE within O-DU Hig
    :width: 600
    :alt: Inter-DU Handover withing O-CU
  
-   Figure 9 -  Inter_DU Handover call flow
+   Figure 10 -  Inter_DU Handover call flow
 
 Assumption: UE is RRC connected with DU and PDU data session is active.
 
@@ -483,9 +492,58 @@ Assumption: UE is RRC connected with DU and PDU data session is active.
 
 - The source O-DU responds to O-CU with UE CONTEXT RELEASE COMPLETE message.
 
+=============================
+Discontinuous reception (DRX)
+=============================
+
+This section describes the Discontinuous reception (DRX) feature within O-DU High.
+
+
+.. figure:: Discontinuous_reception.PNG
+  :width: 600
+  :alt: Discontinuous reception flow
+
+  Figure 11 -  Discontinuous reception flow
+
+- The connected mode DRX is used to improve UE's battery power consumption. This allows UE to be active for a certain amount of time to monitor PDCCH. UE shall become active or inactive based on the DRX timers. 
+
+- When UE is created at O-DU during RRC connection setup procedure, DU APP forwards the default DRX configurationĀ to MAC, who then passes it to SCH as part of UE configuration request. SCH stores these configuration and will use it to calculate the start time and expiry time of various DRX timers. But these timers will only start after UE is RRC connected.
+
+- O-DU may receive modified DRX-configuration in UE CONTEXT SETUP REQUEST from O-CU. DU APP forwards it to MAC who forwards it to SCH as part of UE reconfiguration request. In this case, SCH will stop all DRX timers, re-calculate the start time and expiry time of various timers based on  updated configuration and restart the drx-onDurationTimer. 
+
+- Along with long cycle, DRX in O-DU high also supports short cycle which is enabled if short cycle configuration is recived in UE CONTEXT SETUP REQUEST. 
+
+- DRX timers supported in ODU-High are drx-onDurationTimer, drx-InactivityTimer, drx-ShortCycleTimer, drx-HARQ-RTT-TimerDL, drx-RetransmissionTimerDL, drx-HARQ-RTT-TimerUL and drx-RetransmissionTimerUL. 
+
+- UE is active when any of the following timers is running: drx-onDurationTimer, drx-InactivityTimer, drx-RetransmissionTimerDL or drx-RetransmissionTimerUL, else the UE is considered as inactive.
+
+- Initially, drx-onDurationTimer is started based on long cycle length. While drx-onDurationTimer or drx-InactivityTimer are running, UE becomes active to monitor PDCCH and send data in UL/DL. When drx-InactivityTimer expires, drx-ShortCycleTimer starts. While drx-ShortCycleTimer is running, drx-onDurationTimer is started based on short cycle length. Once drx-ShortCycleTimer expires, long cycle length is used again. Refer to figure 12 below for detailed working of these timers.
+
+.. figure:: Drx_Onduration_Inactive_ShortCycle_Timer.png
+  :width: 600
+  :alt: onDurationTimer,InactivityTimer,ShortCycleTimer flow
+
+  Figure 12 -  onDurationTimer,InactivityTimer,ShortCycleTimer flow
+
+- If HARQ is received/sent, drx-HARQ-RTT-TimerDL or drx-HARQ-RTT-TimerUL is started. On its expiry drx-RetransmissionTimerDL or drx-RetransmissionTimerUL will start. While it is running, UE becomes active for retransmission of data in DL/UL. Refer to figure 13 and 14 below for detailed working of these timers.
+
+.. figure:: Drx_Dl_Harq_Retransmission_Timer.png
+  :width: 600
+  :alt: HARQ-RTT-TimerDL, RetransmissionTimerDL flow
+
+  Figure 13 - DL Harq Retransmission Timers flow
+
+.. figure:: Drx_Ul_Harq_Retransmission_Timer.png
+  :width: 600
+  :alt: HARQ-RTT-TimerUL, RetransmissionTimerUL flow
+
+  Figure 14 - UL Harq Retransmission Timers flow
+
+- 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. 
 
+***********************
 OSC Testcases Supported
------------------------
+***********************
 
 The O-DU High partially supports below use-cases:
 
index 015ecd4..b2e2ecc 100644 (file)
@@ -19,6 +19,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+|2022-12-15          | 7.0.0              | Radisys,           | G release          |
+|                    |                    | HCL Technologies   |                    |
+|                    |                    | Ltd.               |                    |
++--------------------+--------------------+--------------------+--------------------+
 |2022-06-16          | 6.0.0              | Radisys,           | F release          |
 |                    |                    | HCL Technologies   |                    |
 |                    |                    | Ltd.               |                    |
@@ -46,6 +50,22 @@ Version history
 Summary
 -------
 
+G- release
+^^^^^^^^^^
+This release contains the following:
+
+ - Improvement of code coverage
+
+ - Discontinuous reception (DRX)
+
+ - Alignment of O-DU high with the latest AAD WG8 specification (above 80% complaint)
+
+ - 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
+
 F- release
 ^^^^^^^^^^
 This release contains the following:
@@ -58,7 +78,6 @@ This release contains the following:
 
  - Mobility mode Support (Intra-CU handover)
 
-
  - O1 Module
 
       - Alarm notification for cell down. 
@@ -174,6 +193,27 @@ This release contains the following:
 
 Release Data
 ------------
+G release
+^^^^^^^^^^
++--------------------------------------+--------------------------------------+
+| **Project**                          | ODUHIGH                              |
+|                                      |                                      |   
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   |o-du/l2/                              |
+|                                      |I05aa5e6890842c41ebed3f7bd07b07708bbaa|
+|                                      |f34                                   |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | G release                            |
+|                                      |                                      |   
++--------------------------------------+--------------------------------------+
+| **Release date**                     |2022-12-05                            |
+|                                      |                                      |   
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | G release                            |
+|                                      |                                      |   
++--------------------------------------+--------------------------------------+
+
 F release
 ^^^^^^^^^^
 +--------------------------------------+--------------------------------------+
@@ -305,6 +345,26 @@ Feature Additions
 
 **JIRA BACK-LOG:**
 
+G-release
+^^^^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE**                            | **SLOGAN**                                    |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-461  | Improvement of code coverage                  |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-462  | Implementation of Discontinuous Reception(DRX)|
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-464  | Alignment to latest ORAN WG8 AAD specification|
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-475  | Integration of ODU-High with L1               |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+
 F-release
 ^^^^^^^^^^
 
index b24fb63..041c435 100644 (file)
@@ -4,7 +4,7 @@
 User Guide
 ***********
 
-This is the user guide for F release of O-DU/l2.
+This is the user guide for G release of O-DU/l2.
 Follow installation-guide to get all the dependencies ready.
 
 .. contents::
@@ -66,17 +66,17 @@ II. Execution - Using Docker Images
 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:6.0.3
-    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.3
+    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:7.0.1
+    -  docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:7.0.1
 
 - 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:6.0.3
+      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:7.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:6.0.3
+      nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:7.0.1
     - ./odu
 
 
@@ -197,9 +197,9 @@ Following diagram shows P5 messages exchanged with O-DU Low in timer mode.
 
 .. figure:: O-DU_High_Low_Flow.PNG
   :width: 600
-  :alt: Figure 7 O-DU High - O-DU Low Message Flow Diagram
+  :alt: Figure 15 O-DU High - O-DU Low Message Flow Diagram
 
-  Figure 7 - O-DU High - O-DU Low Message Flow Diagram
+  Figure 15 - 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
index 6a3e81e..ada028e 100644 (file)
@@ -1,11 +1,11 @@
 ---
 
 distribution_type: container
-container_release_tag: 6.0.4
+container_release_tag: 7.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: 7411f9b1a209bfc448ee27daacd5fa7fd51de301 
+ref: 61e1df96fd95b40357d5bf592ca8520a25859ff3 
 containers:
 - name: o-du-l2
-version: 6.0.4
+version: 7.0.1
index 0a27a7c..9f6d5d0 100644 (file)
@@ -1,11 +1,11 @@
 ---
 
 distribution_type: container
-container_release_tag: 6.0.4
+container_release_tag: 7.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: 7411f9b1a209bfc448ee27daacd5fa7fd51de301 
+ref: 61e1df96fd95b40357d5bf592ca8520a25859ff3 
 containers:
 - name: o-du-l2-cu-stub
-version: 6.0.4
+version: 7.0.1