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 Create new netconf user (login with root user and run following commands)
41 $adduser --system netconf && \
42 echo "netconf:netconf!" | chpasswd
44 $mkdir -p /home/netconf/.ssh && \
46 ssh-keygen -t dsa -P '' -f /home/netconf/.ssh/id_dsa && \
47 cat /home/netconf/.ssh/id_dsa.pub > /home/netconf/.ssh/authorized_keys
48 Install netconf packages.
50 $chmod +x install_lib.sh
53 2. Start Netopeer2-server:
55 $./netopeer-server.sh start
57 3. Install the yang modules
59 $sysrepoctl -i o-ran-sc-odu-alarm-v1.yang
60 $sysrepoctl -i o-ran-sc-odu-interface-v1.yang
62 4. Configure the startup IP and Port configurations for DU, CU and RIC
66 Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
67 Then load the configuration in the sysrepo running datastore using the command below
69 $sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1
71 5. Configure the netconf server details for VES PNF Event
75 Open the netconfConfig.xml and edit the desired MAC address, IP, Port, Username and Password for VES PNF Registration.
77 6. Configure the VES server details to send VES Events
81 Open the vesConfig.xml and edit the desired IP, Port, Username and Password to send VES Event.
84 D. How to Clean and Build:
85 --------------------------
86 1. Building ODU binary:
89 b. Building ODU binary
90 make odu MACHINE=BIT64 MODE=FDD
91 c. Cleaning ODU binary
92 make clean_odu MACHINE=BIT64 MODE=FDD
94 2. Building CU Stub binary:
97 b. Building CU Stub binary
98 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
99 c. Cleaning CU Stub binary
100 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
102 3. Building RIC Stub binary:
105 b. Building RIC Stub binary
106 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
107 c. Cleaning RIC Stub binary
108 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
110 4. Cleaning ODU, CU Stub and RIC Stub:
114 E. How to Clean and Build with O1 interface enabled (Requires pre-requisite steps in section C)
115 ------------------------------------------------------------------------------------------------
117 1. Building ODU binary:
120 b. Building ODU binary
121 make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
122 c. Cleaning ODU binary
123 make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
125 2. Building CU Stub binary:
128 b. Building CU Stub binary
129 make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
130 c. Cleaning CU Stub binary
131 make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
133 3. Building RIC Stub binary:
136 b. Building RIC Stub binary
137 make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
138 c. Cleaning RIC Stub binary
139 make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
141 4. Cleaning ODU, CU Stub and RIC Stub:
147 1. Assign virtual IP addresses as follows:
148 a. ifconfig <interface name>:ODU "192.168.130.81"
149 b. ifconfig <interface name>:CU_STUB "192.168.130.82"
150 c. ifconfig <interface name>:RIC_STUB "192.168.130.80"
152 PS: If O1 interface is enabled, IP should match those configured in step C.4.
155 a. CU execution folder:
157 b. Run CU Stub binary:
161 a. RIC execution folder:
163 b. Run RIC Stub binary:
167 a. DU execution folder:
172 PS: CU stub and RIC stub must be run (in no particular sequence) before ODU
175 G. How to test with Intel L1:
176 -----------------------------
180 a. Create folder l2/src/wls_lib. Copy wls_lib.h from <intel_directory>/phy/wls_lib/ to l2/src/wls_lib.
181 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.
182 rte_branch_prediction.h
187 rte_pci_dev_feature_defs.h
197 make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD
199 2. Build CU Stub and RIC Stub:
200 a. Execute steps in sections D.2 and D.3.
204 a. Setup environment:
205 cd <intel_directory>/phy/
208 cd <intel_directory>/FlexRAN/l1/bin/nr5g/gnb/l1
209 To run in timer mode : ./l1.sh -e
210 L1 is up when console prints follow:
212 Non BBU threads in application
213 ===========================================================================================================
214 nr5g_gnb_phy2mac_api_proc_stats_thread: [PID: 8659] binding on [CPU 0] [PRIO: 0] [POLICY: 1]
215 wls_rx_handler (non-rt): [PID: 8663] binding on [CPU 0]
216 ===========================================================================================================
218 PHY>welcome to application console
220 2. Execute FAPI Translator:
221 a. Setup environment:
222 cd <intel_directory>/phy/
224 b. Run FAPI translator binary:
225 cd <intel_directory>/phy/fapi_5g/bin/
226 ./oran_5g_fapi --cfg=oran_5g_fapi.cfg
228 3. Execute CU Stub and RIC Stub:
229 a. Run steps in sections E.1-E.3
232 a. DU execution folder
234 b. Export WLS library path
235 export LD_LIBRARY_PATH=<intel_directory>/phy/wls_lib/lib:$LD_LIBRARY_PATH
240 H. How to execute the Health Check : get alarm-list
241 ----------------------------------------------------
245 1. Start Netconf netopeer client
247 2. Connect to the server with
252 3. Send a Netconf get request for alarms xpath
254 Here are the steps as executed in the terminal
257 > connect --login netconf
258 Interactive SSH Authentication
261 > get --filter-xpath /o-ran-sc-odu-alarm-v1:odu/alarms
263 <odu xmlns="urn:o-ran:odu:alarm:1.0">
266 <alarm-id>1009</alarm-id>
267 <alarm-text>cell id [1] is up</alarm-text>
268 <severity>2</severity>
269 <status>Active</status>
270 <additional-info>cell UP</additional-info>
275 The XML output is a list of active alarms in the O-DU High system.