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=CU_STUB MACHINE=BIT64 MODE=FDD
  42    c. Cleaning CU Stub binary
  43          make clean_cu NODE=CU_STUB MACHINE=BIT64 MODE=FDD
  44
  45 3. Cleaning ODU and CU Stub
  46       make clean_all MACHINE=BIT64 MODE=FDD
  47
  48 How to execute:
  49 ---------------
  50 1. Assign virtual IP addresses as follows:
  51       ifconfig <interface name>:ODU "10.0.2.20"
  52       ifconfig <interface name>:CU_STUB "10.0.2.25"
  53
  54 2. CU execution folder:
  55       cd l2/bin/cu_stub
  56
  57 3. Run CU Stub binary:
  58       ./cu_stub -f ../config/ssi_mem
  59
  60 4. DU execution folder:
  61       cd l2/bin/odu
  62
  63 5. Run ODU binary:
  64       ./odu -f ../config/ssi_mem
  65
  66 PS: CU stub must be run first