docs/README

   1 Directory Structure :
   2 ---------------------
   3 1. l2/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. l2/docs/  : contains README and other configuration files for building docs
   9
  10 2. l2/src/ : contains layer specific source code
  11    a. 5gnrmac  : MAC source code
  12    b.   5gnrrlc  : RLC source code
  13    c. cm       : common, environment and interface files
  14    d. cu_stub  : Stub code for CU
  15    e. du_app   : DU application and F1 code
  16    f. mt       : wrapper functions over OS
  17    g. phy_stub : Stub code for Physical layer
  18    h. rlog     : logging module
  19
  20
  21 Pre-requisite for Compilation :
  22 -------------------------------
  23 1. Linux 32-bit/64-bit machine
  24 2. GCC version 4.6.3 and above
  25
  26
  27 How to Clean and Build:
  28 -----------------------
  29 1. Building ODU binary:
  30    a. Build folder
  31          cd l2/build/odu
  32    b. Building ODU binary
  33          make odu MACHINE=BIT64 MODE=FDD
  34    c. Cleaning ODU binary
  35          make clean_odu MACHINE=BIT64 MODE=FDD
  36
  37 2. Building CU Stub binary:
  38    a. Build folder
  39          cd l2/build/odu
  40    b. Building CU Stub binary
  41          make cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
  42    c. Cleaning CU Stub binary
  43          make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
  44
  45 2. Building RIC Stub binary:
  46    a. Build folder
  47          cd l2/build/odu
  48    b. Building RIC Stub binary
  49          make ric_stub NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
  50    c. Cleaning RIC Stub binary
  51          make clean_ric NODE=TEST_STUB MACHINE=BIT64 MODE=FDD
  52
  53 4. Cleaning ODU and CU Stub
  54       make clean_all MACHINE=BIT64 MODE=FDD
  55
  56 How to execute:
  57 ---------------
  58 1. Assign virtual IP addresses as follows:
  59       ifconfig <interface name>:ODU "10.0.2.20"
  60       ifconfig <interface name>:CU_STUB "10.0.2.25"
  61       ifconfig <interface name>:RIC_STUB "10.0.2.30"
  62
  63 2. CU execution folder:
  64       cd l2/bin/cu_stub
  65
  66 3. Run CU Stub binary:
  67       ./cu_stub
  68
  69 4. RIC execution folder:
  70       cd l2/bin/ric_stub
  71
  72 5. Run RIC Stub binary:
  73       ./ric_stub
  74
  75 4. DU execution folder:
  76       cd l2/bin/odu
  77
  78 5. Run ODU binary:
  79       ./odu
  80
  81 PS: CU stub and RIC stub must be run first