Merge remote-tracking branch 'origin/update_readme' into develop_integration_w14

openair1/PHY/INIT/README.txt

@@ -2,4 +2,6 @@ This directory contains files related to initialization of variables/structures
 
 init_top.c : initialize top-level variables and signal buffers, FFT twiddle factors, etc.
 lte_init.c : LTE specific initlization routines (DLSCH/ULSCH signal buffers for RX, data buffers for TX, etc.)
-init.c     : non-LTE initialization routines (to be removed)
+lte_param_init.c: used only in unitary simulations. initializes the global variables eNB and UE.
+lte_parms.c: contains init_frame_parms to initialize frame parameters structure
+

openair1/README.TXT

 This folder contains the software for the device driver of CBMIMO1 and the physical layer signal processing.
 
-
-|-- ARCH   	    	   // contains drivers for hardware
-|   |-- CBMIMO1		   // contains everything related to CBMIMO1
-|   |   `-- DEVICE_DRIVER  
-|   |       |-- Makefile             // main Makefile used to compile the driver; usually invoked from the top level Makefile
-|   |       |-- cbmimo1_device.c     // main file for device driver (initializes the card, bigphys, main variables)
-|   |       |-- cbmimo1_device.h
-|   |       |-- cbmimo1_dma.c
-|   |       |-- cbmimo1_fileops.c    // file that processes IOCTL commands coming from the userspace control utility (USERSPACE_TOOLS/OPENAIR_RF/)
-|   |       |-- cbmimo1_generate_fs4.c   // generates test signals (DEBUGGING)
-|   |       |-- cbmimo1_generate_ofdm.c  // generates test signals (DEBUGGING)
-|   |       |-- cbmimo1_get_frame.c      // code to grab a frame from the card
-|   |       |-- cbmimo1_init.c		 // code to set up the registers of the card
-|   |       |-- cbmimo1_pci.h
-|   |       |-- cbmimo1_proc.c           // generates the proc entries /proc/openair1/bch_stats and /proc/openair1/openair1_state 
-|   |       |-- cbmimo1_rf_cntl.c	 // controls the RF chipset on the card
-|   |       |-- cbmimo1_test.c
-|   |       |-- from_grlib_softconfig.h
-|   |       |-- from_grlib_softregs.h
-|   |       |-- defs.h
-|   |       |-- extern.h
-|   |       `-- vars.h
-|   |-- COMMON		   // common for all hardware (mainly bigphys)
-|   |-- EXPRESS_MIMO	   // contains everything related to EXPRESS MIMO
-|-- DOCS		   // Documentation
-|   |-- DOXYGEN		   // Automaitcally generated DOXYGEN documentation in latex and html
-|   `-- PAPERS		   // papers related to openair1
-|-- EMOS		   // this contains everything related to Eurecom MIMO Openair Sounder (EMOS)
-|   |-- DOC		   
-|   |-- DUMP		   // program that dumps channel estimate to disk using a FIFO
-|   |-- GUI		   
-|   |-- MATLAB		   // Matlab code to process measurements
-|   |-- SIM		   // EMOS simulator (for DEBUGGING)
-|   `-- UTIL
-|-- MAC_INTERFACE	   // interface with MAC layer (in openair2)
 |-- PHY			   // contains all signal processing related to physical layer (used in real-time AND simulation)
 
 General remarks: every directory contains at least defs.h (for declaration of structure and functions), vars.h (for definitions of variables), and extern.h (variables are defined only once in cbmimo1_device.c (for real-time HW operation) or a top-level simulation (in SIMULATION/xxx), if variables are needed in another file, use extern.h)
@@ -57,17 +22,19 @@ General remarks: every directory contains at least defs.h (for declaration of st
 |   |-- spec_defs_top.h
 |   |-- types.h
 |   `-- vars.h		  
-|-- SCHED		  // schedules the different PHY functions according to the nodes role (CH=BS, MR=UE)
+|-- SCHED		  // schedules the different PHY functions according to the nodes role 
 |   |-- defs.h
 |   |-- extern.h
-|   |-- phy_procedures.c         // non-LTE PHY procedures this is used in synchronized mode to schedule the slot processing
 |   |-- phy_procedures_emos.c    // non-LTE PHY procedures for EMOS
 |   |-- phy_procedures_emos.h
 |   |-- phy_procedures_lte_eNb.c // LTE PHY procedures for eNB (from 36-213) 
 |   |-- phy_procedures_lte_ue.c  // LTE PHY procedures for UE (from 36-213)
+|   |-- phy_procedures_lte_common.c  // LTE PHY procedures common for UE and eNB (from 36-213)
+|   |-- phy_mac_stub.c  //MAC stub that generates channels when used in phy-test-mode
+|   |-- pucch_pc.c // power control for PUCCH
+|   |-- pusch_pc.c // power control for PUSCH
+|   |-- srs_pc.c // power control for SRS
 |   |-- rt_compat.h
-|   |-- sched.c		  // contains the top level scheduler (only for CBMIMO1 HW)
-|   |-- sched_lte.c	  // same as sched.c for LTE (only for CBMIMO1 HW)
 |   `-- vars.h
 |-- SIMULATION		 // contains simulation routines to test PHY
 |   |-- LTE_PHY          // LTE simulation testbenches for unitary simulation of transport/physical channels
@@ -76,17 +43,9 @@ General remarks: every directory contains at least defs.h (for declaration of st
 |   |   |-- dlsim.c         // PDSCH simulation testbench
 |   |   |-- ulsim.c         // PUSCH simulation testbench
 |   |   |-- pucchsim.c      // PUCCH simulation testbench
-|   |-- LTE_PHY_L2       // LTE simulation testbench for full system simulation (PHY,MAC,RLC,RRC,PDCP)
-|   `-- TOOLS
 |   |-- RF
-|-- USERSPACE_TOOLS     // tools that run in userspace (not kernel)
-|   |-- OCTAVE
-|   |   |-- AGILE_RF_TOOLS // octave tools to test agile RF  
-|   |   |-- CBMIMO1_TOOLS // octave interface for CBMIMO1
-|   |   |-- GPIB       // octave tools to control signal generator (used for calibration)
-|   |   `-- PHY_SIM    // octave implementation of sync
-|   |-- OPENAIR_RF     // tool to interface with the device driver using IOCTL
-|   |-- SCOPE	       // tool to visualize data from PHY (channel estimates, IQ plots, etc.). Communicates with kernel module using shared memory.
-|   `-- SENSING        // tools related to sensing
+|   |-- ETH_TRANSPORT
+|   `-- TOOLS
+