README

   1 Directory Structure :
   2
   3 1. 5gnr_opensource/lte_enb/build/ : contains files required to compile the code
   4    a. common : contains individual module's makefile
   5    b. scripts : contains scripts and final makefile used to compile all layers using makefiles in common directory
   6
   7 2. 5gnr_opensource/lte_enb/src/ : contains layer specific source code
   8    a. 5gnrpdcp : PDCP source code
   9    b.   5gnrrlc : RLC source code
  10    c. 5gnrmac : MAC source code
  11    d. cm : common, environment and interface files
  12    e. mt : wrapper functions over OS
  13    f. rlog : logging module
  14
  15
  16 Pre-requisite for Compilation :
  17 1. Linux 32-bit/64-bit machine
  18 2. GCC version 4.6.3 and above
  19
  20
  21 How to Compile :
  22 1. cd 5gnr_opensource/lte_enb/build/scripts/
  23 2. Run script to clean and compile: ./build_5gnr.sh
  24 3. To clean only, run command : make clean_all
  25
  26 Compilation Error :
  27 Any compilation error will be reported in file : 5gnr_opensource/lte_enb/build/scripts/err
  28
  29 Generated Libraries :
  30 Path : 5gnr_opensource/lte_enb/libs/
  31 1. librg.a : MAC library
  32 2. libkw.a : RLC library
  33 3. libpj.a : PDCP library
  34
  35 Generated Object Files :
  36 Path : 5gnr_opensource/lte_enb/build/scripts/obj/
  37 1. rg* : Object files for MAC. The prefix 'rg' refers to MAC files and functions.
  38 2. kw* : Object files for RLC. The prefix 'kw' refers to RLC files and functions.
  39 3. pj* : Object files for PDCP. The prefix 'pj' refers to PDCP files and functions.