From: lal.harshita Date: Thu, 30 Jun 2022 06:50:39 +0000 (+0530) Subject: F-Release Document Update X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=o-du%2Fl2.git;a=commitdiff_plain;h=7a62df669e493c0d9bc6e83e57ae271607547bab F-Release Document Update Signed-off-by: lal.harshita Change-Id: I5166fb1b6f04ed7e7d40344b21b0633259a26660 Signed-off-by: lal.harshita --- diff --git a/container-tag.yaml b/container-tag.yaml index d99778a31..9506801cc 100644 --- a/container-tag.yaml +++ b/container-tag.yaml @@ -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.2 +tag: 6.0.3 diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 18e68a08b..c5f3364ae 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -357,7 +357,7 @@ the following APIs for communication. 1. **WLS_Open** - *void\* WLS_Open(const char \*ifacename, unsigned int mode, unsigned long long nWlsMemorySize)* + *void\* WLS_Open(const char \*ifacename, unsigned int mode, uint64_t \*nWlsMacMemorySize, uint64_t \*nWlsPhyMemorySize)* a. Description @@ -368,6 +368,8 @@ the following APIs for communication. - ifacename - pointer to string with device driver name (/dev/wls) - mode - mode of operation (Master or Slave). Here, O-DU High acts as MASTER. + - nWlsMacMemorySize - returns the value of WLS MAC memory Size as O-DU High acts as MASTER + - nWlsPhyMemorySize - returns the value of WLS PHY memory Size as O-DU High acts as MASTER c. Returns pointer handle to WLS interface for future use by WLS functions diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 2c5b1baf8..aced1ed4b 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -1,24 +1,18 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. contents:: - :depth: 3 - :local: - O-DU High Installation Guide ***************************** -Abstract -======== - This document describes how to install O-DU High, it's dependencies and required system resources. .. contents:: :depth: 3 :local: -Version history +Version history +--------------- +--------------------+--------------------+--------------------+--------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -45,7 +39,7 @@ Version history Introduction -============ +------------ This document describes the hardware and software requirements along with guidelines on how to install O-DU High. @@ -53,13 +47,13 @@ The audience of this document is assumed to have good knowledge in RAN concepts Preface -======= +------- O-DU High images can be built using the source code or corresponding docker images can be downloaded. Hardware requirements -===================== +--------------------- Following minimum hardware requirements must be met for installation of O-DU High @@ -84,12 +78,12 @@ Following minimum hardware requirements must be met for installation of O-DU Hig Software installation and deployment -========================================== +------------------------------------- This section describes the installation of the O-DU High on the reference hardware. Libraries ----------- +========= Following libraries are required to compile and execute O-DU High: @@ -112,7 +106,7 @@ Following libraries are required to compile and execute O-DU High: Cloning code --------------- +============ - Create a folder to clone the O-DU High code into. The folder is hereafter referred to as . @@ -122,8 +116,8 @@ Cloning code Setting up Netconf server (Only if O1 interface enabled) --------------------------------------------------------- - +======================================================== + Following steps are required to compile and run ODU with O1 interface enabled. - Create a new netconf user @@ -178,7 +172,7 @@ Setting up Netconf server (Only if O1 interface enabled) Compilation ------------- +=========== - Build O-DU High: @@ -226,7 +220,7 @@ Compilation Compilation with O1 interface enabled --------------------------------------- +===================================== - Build O-DU High: diff --git a/docs/overview.rst b/docs/overview.rst index 1698f409e..35780920a 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -6,7 +6,7 @@ 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. @@ -20,7 +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 -------------------------------- +============================== 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 @@ -43,7 +43,7 @@ level as follows: - Thread 8: O1 O-DU High Modules --------------------------- +================= DU APP ^^^^^^^^^^^^^^^^^^ @@ -97,7 +97,7 @@ 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. @@ -128,8 +128,7 @@ O1 architecture has following components: O-DU-High Interfaces -====================== - +-------------------- This section describes the other modules that O-DU High interfaces with, as shown in below diagram. @@ -229,11 +228,11 @@ 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. @@ -279,7 +278,7 @@ As seen in the Figure 4, UE Related Procedure ------------------------ +==================== The O-DU High supports @@ -337,7 +336,7 @@ Figure 5 below depicts the above call flow, inclusive of all interfaces: - RRC Release Closed Loop Automation Procedure ------------------------------------ +================================ This section describes the closed loop automation procedure within O-DU High. @@ -364,7 +363,7 @@ This section describes the closed loop automation procedure within O-DU High. 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. @@ -389,7 +388,7 @@ As seen in the Figure 7, Network Slicing procedure --------------------------- +========================= This section describes the Network Slicing feature within O-DU High. @@ -416,8 +415,7 @@ As seen in the Figure 8, Idle Mode Paging procedure ---------------------------- - +=========================== This section describes the Idle Mode Paging procedure within O-DU High. @@ -441,7 +439,7 @@ 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. @@ -487,7 +485,7 @@ Assumption: UE is RRC connected with DU and PDU data session is active. OSC Testcases Supported -========================= +----------------------- The O-DU High partially supports below use-cases: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 5d78a4782..2e40e204d 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -181,8 +181,8 @@ F release | | | +--------------------------------------+--------------------------------------+ | **Repo/commit-ID** |o-du/l2/ | -| |I6058cf6966e75f31aa568ba5030c16d2723 | -| |515eb | +| |I5166fb1b6f04ed7e7d40344b21b0633259a | +| |26660 | | | | +--------------------------------------+--------------------------------------+ | **Release designation** | F release | diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 19437b9a9..a73501cc3 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -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.2 - - docker pull nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.2 + - 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 - 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.2 + nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2-cu-stub:6.0.3 - ./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.2 + nexus3.o-ran-sc.org:10004/o-ran-sc/o-du-l2:6.0.3 - ./odu diff --git a/releases/container-release-o-du-l2 b/releases/container-release-o-du-l2 index c195a822f..a7e43b0af 100644 --- a/releases/container-release-o-du-l2 +++ b/releases/container-release-o-du-l2 @@ -1,11 +1,11 @@ --- distribution_type: container -container_release_tag: 6.0.2 +container_release_tag: 6.0.3 container_pull_registry: nexus.o-ran-sc.org:10004 container_push_registry: nexus.o-ran-sc.org:10002 project: o-du-l2 -ref: 16d167817574850a75f64df4579e896d3ab2af47 +ref: c15c9bf54ea369c1281d4f75967b5cd71c2c3bb8 containers: - name: o-du-l2 -version: 6.0.2 +version: 6.0.3 diff --git a/releases/container-release-o-du-l2-cu-stub b/releases/container-release-o-du-l2-cu-stub index 9335cda6d..23971ebcb 100644 --- a/releases/container-release-o-du-l2-cu-stub +++ b/releases/container-release-o-du-l2-cu-stub @@ -1,11 +1,11 @@ --- distribution_type: container -container_release_tag: 6.0.2 +container_release_tag: 6.0.3 container_pull_registry: nexus.o-ran-sc.org:10004 container_push_registry: nexus.o-ran-sc.org:10002 project: o-du-l2 -ref: 16d167817574850a75f64df4579e896d3ab2af47 +ref: c15c9bf54ea369c1281d4f75967b5cd71c2c3bb8 containers: - name: o-du-l2-cu-stub -version: 6.0.2 +version: 6.0.3