Release A code commit
[o-du/l2.git] / README
1 Directory Structure :
2
3 1. 5gnr_opensource/build/ : contains files required to compile the code
4    a. common : contains individual module's makefile
5    b. config : contains SSI memory configuration
6    c. odu    : contains main makefile to generate an executable binary
7         
8 2. 5gnr_opensource/src/ : contains layer specific source code
9    a. 5gnrmac  : MAC source code
10    b.   5gnrrlc  : RLC source code
11    c. cm       : common, environment and interface files
12    d. cu_stub  : Stub code for CU
13    e. du_app   : DU application and F1 code 
14    f. mt       : wrapper functions over OS
15    g. phy_stub : Stub code for Physical layer
16    h. rlog     : logging module
17
18
19 Pre-requisite for Compilation :
20 1. Linux 32-bit/64-bit machine
21 2. GCC version 4.6.3 and above
22
23 How to Compile:
24 1. cd 5gnr_opensource/build/odu
25 2. To clean and compile: 
26     a. DU : make clean_all odu  MACHINE=BIT64 TEXT_LOG=YES MODE=FDD
27     b. CU : make clean_cu cu_stub MACHINE=BIT64 TEXT_LOG=YES MODE=FDD 
28
29 How to execute:
30 1. DU :
31     a. cd 5gnr_opensource/build/odu/bin/odu
32     b. ./odu -f ../config/ssi_mem
33 2. CU :
34     a. cd 5gnr_opensource/build/odu/bin/cu_stub
35     b. ./cu_stub -f ../config/ssi_mem
36