From 1c3c58075627a7996bef7a0120b6e9e4ce2dba90 Mon Sep 17 00:00:00 2001 From: Balaji Shankaran Date: Wed, 30 Oct 2019 13:35:42 +0530 Subject: [PATCH] Release A documents update Change-Id: Ie53114d61aef2b28916846cdd5706fce9b481837 Signed-off-by: Balaji Shankaran --- README | 36 -------------------- docs/README | 64 +++++++++++++++++++++++++++++++++++ docs/release-notes.rst | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 155 insertions(+), 36 deletions(-) delete mode 100644 README create mode 100644 docs/README create mode 100644 docs/release-notes.rst diff --git a/README b/README deleted file mode 100644 index 1ec374403..000000000 --- a/README +++ /dev/null @@ -1,36 +0,0 @@ -Directory Structure : - -1. 5gnr_opensource/build/ : contains files required to compile the code - a. common : contains individual module's makefile - b. config : contains SSI memory configuration - c. odu : contains main makefile to generate an executable binary - -2. 5gnr_opensource/src/ : contains layer specific source code - a. 5gnrmac : MAC source code - b. 5gnrrlc : RLC source code - c. cm : common, environment and interface files - d. cu_stub : Stub code for CU - e. du_app : DU application and F1 code - f. mt : wrapper functions over OS - g. phy_stub : Stub code for Physical layer - h. rlog : logging module - - -Pre-requisite for Compilation : -1. Linux 32-bit/64-bit machine -2. GCC version 4.6.3 and above - -How to Compile: -1. cd 5gnr_opensource/build/odu -2. To clean and compile: - a. DU : make clean_all odu MACHINE=BIT64 TEXT_LOG=YES MODE=FDD - b. CU : make clean_cu cu_stub MACHINE=BIT64 TEXT_LOG=YES MODE=FDD - -How to execute: -1. DU : - a. cd 5gnr_opensource/build/odu/bin/odu - b. ./odu -f ../config/ssi_mem -2. CU : - a. cd 5gnr_opensource/build/odu/bin/cu_stub - b. ./cu_stub -f ../config/ssi_mem - diff --git a/docs/README b/docs/README new file mode 100644 index 000000000..91d4f148b --- /dev/null +++ b/docs/README @@ -0,0 +1,64 @@ +Directory Structure : +--------------------- +1. l2/build/ : contains files required to compile the code + a. common : contains individual module's makefile + b. config : contains SSI memory configuration + c. odu : contains main makefile to generate an executable binary + +2. l2/src/ : contains layer specific source code + a. 5gnrmac : MAC source code + b. 5gnrrlc : RLC source code + c. cm : common, environment and interface files + d. cu_stub : Stub code for CU + e. du_app : DU application and F1 code + f. mt : wrapper functions over OS + g. phy_stub : Stub code for Physical layer + h. rlog : logging module + + +Pre-requisite for Compilation : +------------------------------- +1. Linux 32-bit/64-bit machine +2. GCC version 4.6.3 and above + + +How to Clean and Build: +----------------------- +1. Building ODU binary: + a. Build folder + cd l2/build/odu + b. Building ODU binary + make odu MACHINE=BIT64 MODE=FDD + c. Cleaning ODU binary + make clean_odu MACHINE=BIT64 MODE=FDD + +2. Building CU Stub binary: + a. Build folder + cd l2/build/odu + b. Building CU Stub binary + make cu_stub MACHINE=BIT64 MODE=FDD + c. Cleaning CU Stub binary + make clean_cu MACHINE=BIT64 MODE=FDD + +3. Cleaning ODU and CU Stub + make clean_all MACHINE=BIT64 MODE=FDD + +How to execute: +--------------- +1. Assign virtual IP addresses as follows: + ifconfig :ODU "10.0.2.20" + ifconfig :CU_STUB "10.0.2.25" + +2. CU execution folder: + cd l2/bin/cu_stub + +3. Run CU Stub binary: + ./cu_stub -f ../config/ssi_mem + +4. DU execution folder: + cd l2/bin/odu + +5. Run ODU binary: + ./odu -f ../config/ssi_mem + +PS: CU stub must be run first diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 000000000..237a71aa3 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,91 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +This document provides the release notes for of . + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 20XX-10-29 | 0.1.0 | Radisys | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +======= + +This release contains exchange of F1 Setup Request, F1 Setup Response, GNB DU +Config Update and GNB DU Config Update ACK between the ODU and CU STUB. + + + + +Release Data +============ + + +: + ++--------------------------------------+--------------------------------------+ +| **Project** | ODUHIGH | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | o-du/l2/ | +| | d349ae65e1495488772f87e5cfa1ae71d9eab| +| 075 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Release A | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2019-18-10 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | Release A | +| | | ++--------------------------------------+--------------------------------------+ + + + + +Deliverables +---------------- + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^^^ + +This release contains ODU code, instructions to build and execute ODU and CU +Stub binaries. +All of the above can be found in the o-du/l2 repo. + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Thsi release contains a README folder with instruction to build and execute +binaries. + + +Known Limitations, Issues and Workarounds +========================================= + +NA + + + +References +========== +1. 3GPP release doc 38473-f60 +2. ORAN-WG8.AAD.0-v01.00.10 + + + -- 2.16.6