Added code for MAC-PHY interface, DU_APP, F1AP, SCTP and CU stub
[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    b. scripts : contains scripts required for compilation
8         
9 2. 5gnr_opensource/src/ : contains layer specific source code
10    a. 5gnrmac : MAC source code
11    b.   5gnrrlc : RLC source code
12    c. cm : common, environment and interface files
13    d. cu_app : Stub code for CU
14    e. du_app : DU application and F1 code 
15    f. mt : wrapper functions over OS
16    g. phy_stub : Stub code for Physical layer
17    h. rlog : logging module
18
19
20 Pre-requisite for Compilation :
21 1. Linux 32-bit/64-bit machine
22 2. GCC version 4.6.3 and above
23 3. Copy ASN code generated for F1 messages into 5gnr_opensource/src/du_app/F1AP/asn/
24
25 How to Compile :
26 1. cd 5gnr_opensource/build/odu
27 2. To clean and compile: make clean_all odu  MACHINE=BIT64 TEXT_LOG=YES
28 3. To clean only, run command : make clean_all MACHINE=BIT64 TEXT_LOG=YES
29
30 Executable binary generated : 5gnr_opensource/build/odu/obj/odu