yigid/openairinterface5g
1
0
Fork 0
mirror of https://gitlab.eurecom.fr/oai/openairinterface5g.git synced 2026-07-13 04:30:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(episys): Convert README text files to markdown files

Browse Source 
- Include functions/file_names in backticks for readability
     - Include the images directly inside the document (rather than plain image file name)
     - Give relevant spacing if required
This commit is contained in:
Shubhika Garg
2026-01-20 12:07:37 +01:00
parent 87410b1d25
commit 4d5f9d3cb3
2 changed files with 35 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/episys/lte_mode_l2_emulator/README.txt → doc/episys/lte_mode_l2_emulator/README.md
View File

@@ -3,17 +3,21 @@ user to run multiple UEs in separate Linux processes/machines/VMs/etc. They use
entity between the UE(s) and eNB. The UEs use nFAPI to communicate with the eNB. The
nFAPI interface allows us to run in an emulated layer 2 mode, meaning that we are bypassing
the layer 1 (PHY) functionality. Because we are bypassing the PHY layer,
channel modeling capabilties have been added in the LTE UE phy_stub_ue.c file. To understand
the interfaces between the different components associated with LTE mode, the image
functional_diagram_proxy_lte.png has been provided.
channel modeling capabilties have been added in the LTE UE `phy_stub_ue.c` file. To understand
the interfaces between the different components associated with LTE mode, the following image
has been provided.
![Functional diagram - LTE](../functional_diagram_proxy_lte.png)
This functionality allows the user to plug in their own channel model and emulate the packet dropping procedure
in real time. The channel modeling has not been provided by EpiSci, but the OAI code
base already has some BLER curves available for use. The channel modeling functionality
that is included in the phy_stub_ue.c file only includes the downlink channel modeling.
that is included in the `phy_stub_ue.c` file only includes the downlink channel modeling.
Any uplink channel modeling must be conducted in some sort of proxy, which would sit
between the UEs and eNB. (A description of the downlink channel modeling is shown in the
Channel_Abstraction_UE_Handling_LTE.PNG image).
image below).
![Downlink Channel Modeling](../Channel_Abstraction_UE_Handling_LTE.PNG)
The updates to the OAI code base removed some latent bugs, added multi-UE scalability,
and were tested with a standard bypass proxy between the UE(s) and eNB. The bypass proxy is
@@ -24,16 +28,18 @@ of underlying radios. The features added in the L2 Emulator Mode for LTE are:
- Ease of use of gprof and address sanitizer for debugging purposes
- Updated json files to allow for GDB, real-time debugging capabilities
- Updated logging features to minimally log only key connection milestones. This improves scalability of multiple UEs.
The logging mechanism described here is located in the log.c and log.h files. The LOG_MINIMAL
function allows us to remove most OAI logging and includes LOG_A(...) logs and above. The LOG_A
The logging mechanism described here is located in the `log.c` and `log.h` files. The LOG_MINIMAL
function allows us to remove most OAI logging and includes `LOG_A(...)` logs and above. The LOG_A
logs were chosen as analysis logs to meet EpiSci's internal testing procedure. The LOG_As
only include logs that are considered to be milestones in a given test. For example, a
log indicating that the RACH procedure has been completed for LTE. To select full logging,
set LOG_MINIMAL = 0 in the log.h file.
log indicating that the RACH procedure has been completed for LTE. To select full logging,
set `LOG_MINIMAL = 0` in the `log.h` file.
- Updated logging to include time stamp for timing analysis
- Updated memory allocation procedures to correct size requirements
- Added debugging features to handle signal terminations
- nfapi.c pullarray8 fix invalid pointer math
- `nfapi.c` `pullarray8` fix invalid pointer math
- Overlapping destination and source memory in memcpy, so updated to memmove to check for this bug
- Advanced error checking mechanisms in critical pack and unpack functions
- Created option for CPU assignment to UE to improve scalability
@@ -41,8 +47,8 @@ set LOG_MINIMAL = 0 in the log.h file.
- Updated random value seeds to minimize probability of error in generation of random values
- Enables capability round robin scheduler if desired
- Enables capability real time scheduler if desired
- Added new standalone functions to the UE phy-layer (phy_stub_ue.c) to incorporate individual UE entities
- Updated sending and packing functions in UE (lte_ue.c) to incorporate new standalone changes
- Added new standalone functions to the UE phy-layer (`phy_stub_ue.c`) to incorporate individual UE entities
- Updated sending and packing functions in UE (`lte_ue.c`) to incorporate new standalone changes
- Incorporated semaphores to control timing of incoming downlink packets
- Implemented new queuing system to handle message exchange from UE to eNB and vice versa
- Updated global value in nFAPI for size of subframe

30
doc/episys/nsa_mode_l2_emulator/README.txt → doc/episys/nsa_mode_l2_emulator/README.md
View File

@@ -3,17 +3,21 @@ user to run multiple UEs in separate Linux processes/machines/VMs/etc. They use
entity between the UE(s) and eNB/gNB. The UEs use nFAPI to communicate with the eNB/gNB. The
nFAPI interface allows us to run in an emulated L2 mode, meaning that we are bypassing
the layer 1 (PHY) layer functionality. Becasue we are bypassing the PHY layer, special
channel modeling capabilty has been added in the LTE UE phy_stub_ue.c file. To understand
the interfaces between the different components associated with NSA mode, the image
functional_diagram_proxy_nsa.png has been provided.
channel modeling capabilty has been added in the LTE UE `phy_stub_ue.c` file. To understand
the interfaces between the different components associated with NSA mode, the following image
has been provided.
![Functional diagram - NSA](../functional_diagram_proxy_nsa.png)
This functionality allows the user to plug in their own channel model and emulate the packet dropping procedure
in real time. The channel modeling has not been provided by EpiSci, but the OAI code
base already has some BLER curves available for use. The chanel modeling functionality
that is included in the phy_stub_ue.c file only includes the downlink channel modeling.
that is included in the `phy_stub_ue.c` file only includes the downlink channel modeling.
Any uplink channel modeling must be conducted in some sort of proxy, which would sit
between the UEs and eNB/gNB. (A description of the downlink channel modeling is shown in the
Channel_Abstraction_UE_Handling_LTE.PNG image).
image below).
![Downlink Channel Modeling](../Channel_Abstraction_UE_Handling_LTE.PNG)
The updates to the OAI code base removed some latent bugs, added multi-UE scalability,
and were tested with a standard bypass proxy between the UE(s) and eNB/gNB. The bypass proxy is
@@ -24,16 +28,16 @@ of underlying radios. The added features to the OAI code base are listed below.
- Ease of use of gprof and address sanitizer for debugging purposes
- Updated json files to allow for GDB, real-time debugging capabilities
- Updated logging features to minimally log only key connection milestones. This improves scalability of multiple UEs.
The logging mechanism described here is located in the log.c and log.h files. The LOG_MINIMAL
function allows us to remove most logs and include LOG_A(...) logs and above. The LOG_A
The logging mechanism described here is located in the `log.c` and `log.h` files. The `LOG_MINIMAL`
function allows us to remove most logs and include LOG_A(...) logs and above. The `LOG_A`
logs were chosen as analysis logs to meet EpiSci's internal testing procedure. The LOG_As
only include logs that are considered to be milestones in a given test. For example, a
log indicating that the CFRA procedure has been completed for NSA mode. To revert to full logging,
set LOG_MINIMAL = 0 in the log.h file.
log indicating that the CFRA procedure has been completed for NSA mode. To revert to full logging,
set `LOG_MINIMAL = 0` in the `log.h` file.
- Updated logging to include time stamp for timing analysis
- Updated memory allocation procedures to correct size requirements
- Added debugging features to handle signal terminations
- nfapi.c pullarray8 fix invalid pointer math
- `nfapi.c` `pullarray8` fix invalid pointer math
- Overlapping destination and source memory in memcpy, so updated to memmove to check for this bug
- Advanced error checking mechanisms in critical pack and unpack functions
- Created option for CPU assignment to UE to improve scalability
@@ -41,8 +45,8 @@ set LOG_MINIMAL = 0 in the log.h file.
- Updated random value seeds to minimize probability of error in generation of random values
- Enables capability round robin scheduler if desired
- Enables capability real time scheduler if desired
- Added new standalone functions to the UE phy-layer (phy_stub_ue.c) to incorporate individual UE entities
- Updated sending and packing functions in UE (lte_ue.c) to incorporate new standalone changes
- Added new standalone functions to the UE phy-layer (`phy_stub_ue.c`) to incorporate individual UE entities
- Updated sending and packing functions in UE (`lte_ue.c`) to incorporate new standalone changes
- Incorporated semaphores to control timing of incoming downlink packets
- Implemented new queuing system to handle message exchange from UE to eNB and vice versa
- Updated global value in nFAPI for size of subframe
@@ -84,7 +88,7 @@ NSA mode establishment includes the following steps:
**Test Setup:**
For launching the multi-UE for NSA mode, there is a provided test script in the
public EpiSci GitHub multi-ue-proxy repository. However, a brief outline of the
[public EpiSci GitHub multi-ue-proxy](https://github.com/EpiSci/oai-lte-5g-multi-ue-proxy) repository. However, a brief outline of the
test set up is included below.
If running multiple NSA UEs in a single machine, you will need to launch