1 A. Directory Structure :
2 ------------------------
3 1. l2/build/ : contains files required to compile the code
4 a. common : contains individual module's makefile
5 b. odu : contains main makefile to generate an executable binary
6 c. scripts: contains scripts for logging, installing netconf libraries and starting netopeer server
7 d. config : contains the configuration files
8 e. yang : contains the YANG modules
10 2. l2/docs/ : contains README and other configuration files for building docs
12 3. l2/src/ : contains layer specific source code
13 a. 5gnrmac : MAC source code
14 b. 5gnrrlc : RLC source code
15 c. cm : common, environment and interface files
16 d. cu_stub : Stub code for CU
17 e. du_app : DU application and F1 code
18 f. mt : wrapper functions over OS
19 g. phy_stub : Stub code for Physical layer
20 h. rlog : logging module
24 B. Pre-requisite for Compilation :
25 ----------------------------------
26 1. Linux 32-bit/64-bit machine
27 2. GCC version 4.6.3 and above
29 a. On Ubuntu : sudo apt-get install -y libsctp-dev
30 b. On CentOS : sudo yum install -y lksctp-tools-devel
32 a. On ubuntu : sudo apt-get install -y libpcap-dev
33 b. On CentOS : sudo yum install -y libpcap-devel
36 C. Pre-requisite for O1 Interface (Required only if run with O1 interface enabled)
37 -----------------------------------------------------------------------------------
38 1. Setup netconf server
40 a. Add new netconf user (login with root user or use sudo and run following script)
42 $sudo ./add_netconf_user.sh
44 b. Install netconf packages.
45 $chmod +x install_lib_O1.sh
46 $sudo ./install_lib_O1.sh -c
48 2. Update the configuration according to your setup.
52 a. Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
53 b. Open the nacm_config.xml and edit the desired user name to provide the access to that user.
54 c. Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
55 d. Open the vesConfig.json and edit the details of VES collector.
56 e. Open the netconfConfig.json and edit the details of Netopeer server.
57 f. Install the yang modules and load initial configuration
62 3. Start Netopeer2-server:
64 $sudo ./netopeer-server.sh start
67 D. How to Clean and Build:
68 --------------------------
70 a. odu - Builds all components of ODU
71 b. cu_stub - Builds all CU Stub
72 c. ric_stub - Builds all RIC_Stub
73 d. clean_odu - clean up ODU
74 e. clean_cu - clean up CU Stub
75 f. clean_ric - clean up RIC Stub
76 g. clean_all - cleanup everything
78 i. MACHINE=BIT64/BIT32 - Specify underlying machine type. Default is BIT32
79 ii. NODE=TEST_STUB - Specify if it is a test node. Mandatory for cu_stub/ric_stub. Must not be used for odu
80 iii. MODE=FDD/TDD - Specify duplex mode. Default is FDD
81 iv. PHY=INTEL_L1 - Specify type of phy. If not specified, PHY stub is used
82 v. PHY_MODE=TIMER - Specify mode of phy. Used only if PHY=INTEL_L1. Default is radio mode
83 vi. O1_ENABLE=YES - Specify if O1 interface is enabled. If not specified, it is disabled
85 2. Building ODU binary:
88 b. Building ODU binary
89 make odu MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
90 c. Cleaning ODU binary
91 make clean_odu MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
93 3. Building CU Stub binary:
96 b. Building CU Stub binary
97 make cu_stub NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
98 c. Cleaning CU Stub binary
99 make clean_cu NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
101 4. Building RIC Stub binary:
104 b. Building RIC Stub binary
105 make ric_stub NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
106 c. Cleaning RIC Stub binary
107 make clean_ric NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
109 5. Cleaning ODU, CU Stub and RIC Stub:
113 E. How to Clean and Build with O1 interface enabled (Requires pre-requisite steps in section C)
114 ------------------------------------------------------------------------------------------------
116 1. Building ODU binary:
119 b. Building ODU binary
120 make odu MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
121 c. Cleaning ODU binary
122 make clean_odu MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
124 2. Building CU Stub binary:
127 b. Building CU Stub binary
128 make cu_stub NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
129 c. Cleaning CU Stub binary
130 make clean_cu NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
132 3. Building RIC Stub binary:
135 b. Building RIC Stub binary
136 make ric_stub NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
137 c. Cleaning RIC Stub binary
138 make clean_ric NODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h> O1_ENABLE=<refer section D.1.h>
140 4. Cleaning ODU, CU Stub and RIC Stub:
146 1. Assign virtual IP addresses as follows:
147 a. ifconfig <interface name>:ODU "192.168.130.81"
148 b. ifconfig <interface name>:CU_STUB "192.168.130.82"
149 c. ifconfig <interface name>:RIC_STUB "192.168.130.80"
151 PS: If O1 interface is enabled, IP should match those configured in step C.2.a.
154 a. CU execution folder:
156 b. Run CU Stub binary:
160 a. RIC execution folder:
162 b. Run RIC Stub binary:
166 a. DU execution folder:
171 PS: CU stub and RIC stub must be run (in no particular sequence) before ODU
174 G. How to test with Intel L1:
175 -----------------------------
179 a. Create folder l2/src/wls_lib. Copy wls_lib.h from <intel_directory>/phy/wls_lib/ to l2/src/wls_lib.
180 b. Create folder l2/src/dpdk_lib. Copy following files from <intel_directory>/dpdk-19.11/x86_64-native-linuxapp-gcc/include/ to l2/sr c/dpdk_lib.
181 rte_branch_prediction.h
186 rte_pci_dev_feature_defs.h
196 make odu PHY=<refer section D.1.h> PHY_MODE=<refer section D.1.h> MACHINE=<refer section D.1.h> MODE=<refer section D.1.h>
198 2. Build CU Stub and RIC Stub:
199 a. Execute steps in sections D.3 and D.4
202 1. Refer to below link for assumptions, dependencies, pre-requisites etc for ODU-Low execution
203 https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/latest/
206 a. Setup environment:
207 cd <intel_directory>/phy/
210 cd <intel_directory>/FlexRAN/l1/bin/nr5g/gnb/l1
212 i. In timer mode : ./l1.sh -e
213 ii. In radio mode : ./l1.sh -xran
214 L1 is up when console prints follow:
216 Non BBU threads in application
217 ===========================================================================================================
218 nr5g_gnb_phy2mac_api_proc_stats_thread: [PID: 8659] binding on [CPU 0] [PRIO: 0] [POLICY: 1]
219 wls_rx_handler (non-rt): [PID: 8663] binding on [CPU 0]
220 ===========================================================================================================
222 PHY>welcome to application console
224 3. Execute FAPI Translator:
225 a. Setup environment:
226 cd <intel_directory>/phy/
228 b. Run FAPI translator binary:
229 cd <intel_directory>/phy/fapi_5g/bin/
230 ./oran_5g_fapi --cfg=oran_5g_fapi.cfg
232 4. Execute CU Stub and RIC Stub:
233 a. Run steps in sections E.1-E.3
236 a. DU execution folder
238 b. Export WLS library path
239 export LD_LIBRARY_PATH=<intel_directory>/phy/wls_lib/lib:$LD_LIBRARY_PATH
244 H. How to execute the Health Check : get alarm-list
245 ----------------------------------------------------
249 1. Start Netconf netopeer client
251 2. Connect to the server with
256 3. Send a Netconf get request for alarms xpath
258 Here are the steps as executed in the terminal
261 > connect --login netconf
262 Interactive SSH Authentication
265 > get --filter-xpath /o-ran-sc-odu-alarm-v1:odu/alarms
267 <odu xmlns="urn:o-ran:odu:alarm:1.0">
270 <alarm-id>1009</alarm-id>
271 <alarm-text>cell id [1] is up</alarm-text>
272 <severity>2</severity>
273 <status>Active</status>
274 <additional-info>cell UP</additional-info>
279 The XML output is a list of active alarms in the O-DU High system.
282 G. Troubleshooting Netconf server issues
283 ----------------------------------------
284 In case the Netconf server and sysrepo breaks down, run the following steps:
287 $sudo ./troubleshoot_netconf.sh cleanup
288 execute section C.2.f, C.3 again