-Directory Structure :
----------------------
+A. 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
+ b. odu : contains main makefile to generate an executable binary
+ c. scripts: contains scripts for logging, installing netconf libraries and starting netopeer server
+ d. config : contains the configuration files
+ e. yang : contains the YANG modules
2. l2/docs/ : contains README and other configuration files for building docs
-2. l2/src/ : contains layer specific source code
+3. l2/src/ : contains layer specific source code
a. 5gnrmac : MAC source code
- b. 5gnrrlc : RLC 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
+ i. o1 : o1 module
-Pre-requisite for Compilation :
--------------------------------
+B. Pre-requisite for Compilation :
+----------------------------------
1. Linux 32-bit/64-bit machine
2. GCC version 4.6.3 and above
+3. Install LKSCTP
+ a. On Ubuntu : sudo apt-get install -y libsctp-dev
+ b. On CentOS : sudo yum install -y lksctp-tools-devel
+4. Install PCAP:
+ a. On ubuntu : sudo apt-get install -y libpcap-dev
+ b. On CentOS : sudo yum install -y libpcap-devel
-How to Clean and Build:
------------------------
+C. Pre-requisite for O1 Interface (Required only if run with O1 interface enabled)
+-----------------------------------------------------------------------------------
+1. Setup netconf server
+
+ Create new netconf user (login with root user and run following commands)
+ $adduser --system netconf && \
+ echo "netconf:netconf" | chpasswd
+
+ $mkdir -p /home/netconf/.ssh && \
+ ssh-keygen -A && \
+ ssh-keygen -t dsa -P '' -f /home/netconf/.ssh/id_dsa && \
+ cat /home/netconf/.ssh/id_dsa.pub > /home/netconf/.ssh/authorized_keys
+ Install netconf packages.
+ $cd l2/build/scripts
+ $chmod +x install_lib.sh
+ $ ./install_lib.sh -c
+
+2. Start Netopeer2-server:
+ $cd l2/build/scripts
+ $./netopeer-server.sh start
+
+3. Install the yang modules
+ $cd l2/build/yang
+ $sysrepoctl -i o-ran-sc-odu-alarm-v1.yang
+ $sysrepoctl -i o-ran-sc-odu-interface-v1.yang
+
+4. Configure the startup IP and Port configurations for DU, CU and RIC
+
+ $cd l2/build/config
+
+ Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
+ Then load the configuration in the sysrepo running datastore using the command below
+
+ $sysrepocfg --import=startup_config.xml --datastore running --module o-ran-sc-odu-interface-v1
+
+
+D. How to Clean and Build:
+--------------------------
1. Building ODU binary:
a. Build folder
cd l2/build/odu
c. Cleaning CU Stub binary
make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
-2. Building RIC Stub binary:
+3. Building RIC Stub binary:
a. Build folder
cd l2/build/odu
b. Building RIC Stub binary
c. Cleaning RIC Stub binary
make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
-4. Cleaning ODU and CU Stub
- make clean_all MACHINE=BIT64 MODE=FDD
+4. Cleaning ODU, CU Stub and RIC Stub:
+ make clean_all
+
+
+E. How to Clean and Build with O1 interface enabled (Requires pre-requisite steps in section C)
+------------------------------------------------------------------------------------------------
+
+1. Building ODU binary:
+ a. Build folder
+ cd l2/build/odu
+ b. Building ODU binary
+ make odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+ c. Cleaning ODU binary
+ make clean_odu MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
+2. Building CU Stub binary:
+ a. Build folder
+ cd l2/build/odu
+ b. Building CU Stub binary
+ make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+ c. Cleaning CU Stub binary
+ make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
+3. Building RIC Stub binary:
+ a. Build folder
+ cd l2/build/odu
+ b. Building RIC Stub binary
+ make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+ c. Cleaning RIC Stub binary
+ make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD O1_ENABLE=YES
+
+4. Cleaning ODU, CU Stub and RIC Stub:
+ make clean_all
+
-How to execute:
----------------
+F. How to execute:
+------------------
1. Assign virtual IP addresses as follows:
- ifconfig <interface name>:ODU "10.0.2.20"
- ifconfig <interface name>:CU_STUB "10.0.2.25"
- ifconfig <interface name>:RIC_STUB "10.0.2.30"
-
-2. CU execution folder:
- cd l2/bin/cu_stub
-
-3. Run CU Stub binary:
- ./cu_stub
-
-4. RIC execution folder:
- cd l2/bin/ric_stub
-
-5. Run RIC Stub binary:
- ./ric_stub
-
-4. DU execution folder:
- cd l2/bin/odu
-
-5. Run ODU binary:
- ./odu
-
-PS: CU stub and RIC stub must be run first
+ a. ifconfig <interface name>:ODU "192.168.130.81"
+ b. ifconfig <interface name>:CU_STUB "192.168.130.82"
+ c. ifconfig <interface name>:RIC_STUB "192.168.130.80"
+
+PS: If O1 interface is enabled, IP should match those configured in step C.4.
+
+2. Execute CU Stub:
+ a. CU execution folder:
+ cd l2/bin/cu_stub
+ b. Run CU Stub binary:
+ ./cu_stub
+
+3. Execute RIC Stub:
+ a. RIC execution folder:
+ cd l2/bin/ric_stub
+ b. Run RIC Stub binary:
+ ./ric_stub
+
+4. Execute DU:
+ a. DU execution folder:
+ cd l2/bin/odu
+ b. Run ODU binary:
+ ./odu
+
+PS: CU stub and RIC stub must be run (in no particular sequence) before ODU
+
+
+G. How to test with Intel L1:
+-----------------------------
+
+I. Compilation
+ 1. Build ODU :
+ a. Create folder l2/src/wls_lib. Copy wls_lib.h from <intel_directory>/phy/wls_lib/ to l2/src/wls_lib.
+ 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.
+ rte_branch_prediction.h
+ rte_common.h
+ rte_config.h
+ rte_dev.h
+ rte_log.h
+ rte_pci_dev_feature_defs.h
+ rte_bus.h
+ rte_compat.h
+ rte_debug.h
+ rte_eal.h
+ rte_os.h
+ rte_per_lcore.h
+ c. Build folder
+ cd l2/build/odu
+ d. Build ODU Binary:
+ make odu PHY=INTEL_L1 PHY_MODE=TIMER MACHINE=BIT64 MODE=FDD
+
+ 2. Build CU Stub and RIC Stub:
+ a. Execute steps in sections D.2 and D.3.
+
+II. Execution
+ 1. Execute L1:
+ a. Setup environment:
+ cd <intel_directory>/phy/
+ source ./setupenv.sh
+ b. Run L1 binary :
+ cd <intel_directory>/FlexRAN/l1/bin/nr5g/gnb/l1
+ To run in timer mode : ./l1.sh -e
+ L1 is up when console prints follow:
+
+ Non BBU threads in application
+ ===========================================================================================================
+ nr5g_gnb_phy2mac_api_proc_stats_thread: [PID: 8659] binding on [CPU 0] [PRIO: 0] [POLICY: 1]
+ wls_rx_handler (non-rt): [PID: 8663] binding on [CPU 0]
+ ===========================================================================================================
+
+ PHY>welcome to application console
+
+ 2. Execute FAPI Translator:
+ a. Setup environment:
+ cd <intel_directory>/phy/
+ source ./setupenv.sh
+ b. Run FAPI translator binary:
+ cd <intel_directory>/phy/fapi_5g/bin/
+ ./oran_5g_fapi --cfg=oran_5g_fapi.cfg
+
+ 3. Execute CU Stub and RIC Stub:
+ a. Run steps in sections E.1-E.3
+
+ 4. Execute DU:
+ a. DU execution folder
+ cd l2/bin/odu
+ b. Export WLS library path
+ export LD_LIBRARY_PATH=<intel_directory>/phy/wls_lib/lib:$LD_LIBRARY_PATH
+ c. Run ODU binary
+ ./odu
+
+
+H. How to execute the Health Check : get alarm-list
+----------------------------------------------------
+
+ Steps:
+
+ 1. Start Netconf netopeer client
+
+ 2. Connect to the server with
+
+ user: netconf
+ pwd: netconf
+
+ 3. Send a Netconf get request for alarms xpath
+
+ Here are the steps as executed in the terminal
+
+ $netopeer2-cli
+ > connect --login netconf
+ Interactive SSH Authentication
+ Type your password:
+ Password:
+ > get --filter-xpath /o-ran-sc-odu-alarm-v1:odu/alarms
+ DATA
+ <odu xmlns="urn:o-ran:odu:alarm:1.0">
+ <alarms>
+ <alarm>
+ <alarm-id>1009</alarm-id>
+ <alarm-text>cell id [1] is up</alarm-text>
+ <severity>2</severity>
+ <status>Active</status>
+ <additional-info>cell UP</additional-info>
+ </alarm>
+ </alarms>
+ </odu>
+
+ The XML output is a list of active alarms in the O-DU High system.
+
Code Review / o-du / l2.git / blobdiff