Merge remote-tracking branch 'origin/doc-ci' into integration_2023_w13

README.md

@@ -4,8 +4,12 @@
 
 <p align="center">
     <a href="https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-OAI--Public--V1.1-blue" alt="License"></a>
-    <a href="https://releases.ubuntu.com/18.04/"><img src="https://img.shields.io/badge/OS-Ubuntu18-Green" alt="Supported OS"></a>
-    <a href="https://www.redhat.com/en/enterprise-linux-8"><img src="https://img.shields.io/badge/OS-RHEL8-Green" alt="Supported OS"></a>
+    <a href="https://releases.ubuntu.com/18.04/"><img src="https://img.shields.io/badge/OS-Ubuntu18-Green" alt="Supported OS Ubuntu 18"></a>
+    <a href="https://releases.ubuntu.com/20.04/"><img src="https://img.shields.io/badge/OS-Ubuntu20-Green" alt="Supported OS Ubuntu 20"></a>
+    <a href="https://releases.ubuntu.com/22.04/"><img src="https://img.shields.io/badge/OS-Ubuntu22-Green" alt="Supported OS Ubuntu 22"></a>
+    <a href="https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux"><img src="https://img.shields.io/badge/OS-RHEL8-Green" alt="Supported OS RHEL8"></a>
+    <a href="https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux"><img src="https://img.shields.io/badge/OS-RHEL9-Green" alt="Supported OS RELH9"></a>
+    <a href="https://getfedora.org/en/workstation/"><img src="https://img.shields.io/badge/OS-Fedore37-Green" alt="Supported OS Fedora 37"></a>
 </p>
 
 <p align="center">
@@ -13,10 +17,10 @@
 </p>
 
 <p align="center">
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-enb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-enb?label=eNB%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-lte-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-lte-ue?label=LTE-UE%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-gnb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-gnb?label=gNB%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-nr-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-nr-ue?label=NR-UE%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-gnb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-gnb?label=gNB%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-nr-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-nr-ue?label=NR-UE%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-enb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-enb?label=eNB%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-lte-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-lte-ue?label=LTE-UE%20docker%20pulls"></a>
 </p>
 
 # OpenAirInterface License #
@@ -32,12 +36,12 @@ Please see [NOTICE](NOTICE.md) file for third party software that is included in
 
 # Where to Start #
 
+ *  [General overview of documentation](./doc/README.md)
  *  [The implemented features](./doc/FEATURE_SET.md)
  *  [How to build](./doc/BUILD.md)
  *  [How to run the modems](./doc/RUNMODEM.md)
 
-More information and documentation can be found in the [doc folder](./doc).
-Unfortunately, not all information is available there, and information for
+Not all information is available in a central place, and information for
 specific sub-systems might be available in the corresponding sub-directories.
 To find all READMEs, this command might be handy:
 
@@ -51,52 +55,20 @@ The OpenAirInterface (OAI) software is composed of the following parts:
 
 ```
 openairinterface5g
+├── charts
 ├── ci-scripts        : Meta-scripts used by the OSA CI process. Contains also configuration files used day-to-day by CI.
+├── CMakeLists.txt    : Top-level CMakeLists.txt for building
 ├── cmake_targets     : Build utilities to compile (simulation, emulation and real-time platforms), and generated build files.
-├── common            : Some common OAI utilities, other tools can be found at openair2/UTILS.
-├── doc               : Contains an up-to-date feature set list and starting tutorials.
-├── executables       : Top-level executable source files.
-├── LICENSE           : License file.
+├── common            : Some common OAI utilities, some other tools can be found at openair2/UTILS.
+├── doc               : Documentation
+├── docker            : Dockerfiles to build for Ubuntu and RHEL
+├── executables       : Top-level executable source files (gNB, eNB, ...)
 ├── maketags          : Script to generate emacs tags.
-├── nfapi             : Contains the NFAPI code. A local Readme file provides more details.
+├── nfapi             : (n)FAPI code for MAC-PHY interface
 ├── openair1          : 3GPP LTE Rel-10/12 PHY layer / 3GPP NR Rel-15 layer. A local Readme file provides more details.
-│   ├── PHY
-│   ├── SCHED
-│   ├── SCHED_NBIOT
-│   ├── SCHED_NR
-│   ├── SCHED_NR_UE
-│   ├── SCHED_UE
-│   └── SIMULATION    : PHY RF simulation.
 ├── openair2          : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP + LTE Rel-14 M2AP implementation. Also 3GPP NR Rel-15 RLC/MAC/PDCP/RRC/X2AP.
-│   ├── COMMON
-│   ├── DOCS
-│   ├── ENB_APP
-│   ├── F1AP
-│   ├── GNB_APP
-│   ├── LAYER2/RLC/   : with the following subdirectories: UM_v9.3.0, TM_v9.3.0, and AM_v9.3.0.
-│   ├── LAYER2/PDCP/PDCP_v10.1.0
-│   ├── M2AP
-│   ├── MCE_APP
-│   ├── NETWORK_DRIVER
-│   ├── NR_PHY_INTERFACE
-│   ├── NR_UE_PHY_INTERFACE
-│   ├── PHY_INTERFACE
-│   ├── RRC
-│   ├── UTIL
-│   └── X2AP
 ├── openair3          : 3GPP LTE Rel10 for S1AP, NAS GTPV1-U for both ENB and UE.
-│   ├── COMMON
-│   ├── DOCS
-│   ├── GTPV1-U
-│   ├── M3AP
-│   ├── MME_APP
-│   ├── NAS
-│   ├── S1AP
-│   ├── SCTP
-│   ├── SECU
-│   ├── TEST
-│   ├── UDP
-│   └── UTILS
-├── radio             : drivers for various radios such as USRP, AW2S, RFsim, ...
-└── targets           : Top-level wrappers for unitary simulation for PHY channels, system-level emulation (eNB-UE with and without S1), and realtime eNB and UE and RRH GW.
+├── openshift         : OpenShift helm charts for some deployment options of OAI
+├── radio             : Drivers for various radios such as USRP, AW2S, RFsim, ...
+└── targets           : Some configuration files; only historical relevance, and might be deleted in the future
 ```

ci-scripts/cls_containerize.py

@@ -1559,17 +1559,6 @@ class Containerize():
 			mySSH.close()
 		if svrName == 'nepes':
 			mySSH.open(ipAddr, userName, password)
-			# Check if route to porcepix epc exists: not necessary, is on same host
-			#mySSH.command('ip route | grep --colour=never "192.168.61.192/26"', '\$', 10)
-			#result = re.search('172.21.16.136', mySSH.getBefore())
-			#if result is None:
-			#	mySSH.command('echo ' + password + ' | sudo -S ip route add 192.168.61.192/26 via 172.21.16.136 dev enp0s31f6', '\$', 10)
-			# Check if X2 route to obelix enb exists: not necessary, gnb is on ofqot
-			#mySSH.command('ip route | grep --colour=never "192.168.68.128/26"', '\$', 10)
-			#result = re.search('172.21.16.128', mySSH.getBefore())
-			#if result is None:
-			#	mySSH.command('echo ' + password + ' | sudo -S ip route add 192.168.68.128/26 via 172.21.16.128 dev enp0s31f6', '\$', 10)
-			# Check if forwarding is enabled
 			# Check if route to ofqot gnb exists
 			mySSH.command('ip route | grep --colour=never "192.168.68.192/26"', '\$', 10)
 			result = re.search('172.21.16.109', mySSH.getBefore())

doc/BUILD.md

@@ -14,13 +14,13 @@
 
 This page is valid on tags starting from **`2019.w09`**.
 
-# Soft Modem Build Script
+# Overview
 
-The OAI EPC is developed in a distinct project with it's own [documentation](https://github.com/OPENAIRINTERFACE/openair-epc-fed/wiki) , it is not described here.
+The [OAI EPC](https://github.com/OPENAIRINTERFACE/openair-epc-fed/blob/master/docs/DEPLOY_HOME_MAGMA_MME.md) and [OAI 5GC](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed/-/blob/master/docs/DEPLOY_HOME.md) are developed in distinct projects with their own documentation and are not further described here.
 
 OAI softmodem sources, which aim to implement 3GPP compliant UEs, eNodeB and gNodeB can be downloaded from the Eurecom [gitlab repository](./GET_SOURCES.md).
 
-Sources come with a build script [build_oai](../cmake_targets/build_oai) located at the root of the `openairinterface5g/cmake_targets` directory. This script is developed to build the oai binaries (executables,shared libraries) for different hardware platforms, and use cases. 
+Sources come with a build script [build_oai](../cmake_targets/build_oai) located at the root of the `openairinterface5g/cmake_targets` directory. This script is developed to build the oai binaries (executables,shared libraries) for different hardware platforms, and use cases.
 
 The main oai binaries, which are tested by the Continuous Integration process are:
 
@@ -28,36 +28,57 @@ The main oai binaries, which are tested by the Continuous Integration process ar
 -  The 5G UE: `nr-uesoftmodem`
 -  The LTE eNodeB: `lte-softmodem`
 -  The 5G gNodeB: `nr-softmodem`
+-  The 5G CU-UP: `nr-cuup`
 -  The LTE PHY simulators: `dlsim` and `ulsim`
--  The 5G PHY simulators: `nr_dlschsim` `nr_dlsim`   `nr_pbchsim` `nr_pucchsim` `nr_ulschsim` `nr_ulsim` `polartest` `smallblocktest`
-   `ulsim` `ldpctest`
+-  The 5G PHY simulators: `nr_dlschsim`, `nr_dlsim`, `nr_pbchsim`, `nr_pucchsim`, `nr_ulschsim`, `nr_ulsim`, `polartest`, `smallblocktest`, `nr _ulsim`, `ldpctest`
 
 Running the  [build_oai](../cmake_targets/build_oai) script also generates some utilities required to build and/or run the oai softmodem binaries:
 
-- `conf2uedata`: a binary used to build the UE data from a configuration file. The created file emulates the sim card  of a 3GPP compliant phone.
-- `nvram`: a binary used to build UE (IMEI...) and EMM (IMSI, registered PLMN) non volatile data. 
-- `rb_tool`: radio bearer utility 
-- `genids` T Tracer utility, used at build time to generate T_IDs.h include file. This binary is located in the [T Tracer source file directory](../common/utils/T) .
+- `conf2uedata`: a binary used to build the (4G) UE data from a configuration file. The created file emulates the sim card  of a 3GPP compliant phone.
+- `nvram`: a binary used to build (4G) UE (IMEI...) and EMM (IMSI, registered PLMN) non volatile data.
+- `rb_tool`: radio bearer utility for (4G) UE
+- `genids` T Tracer utility, used at build time to generate `T_IDs.h` include file. This binary is located in the [T Tracer source file directory](../common/utils/T) .
 
-The build system for OAI uses [cmake](https://cmake.org/) which is a  tool to generate makefiles. The `build_oai` script is a wrapper using cmake, make and standard linux shell commands to ease the oai build and use . The file describing how to build the executables from source files is the [CMakeLists.txt](../CMakeLists.txt), it is used as input by cmake to generate the makefiles.
+The build system for OAI uses [cmake](https://cmake.org/) which is a  tool to generate makefiles. The `build_oai` script is a wrapper using `cmake` and `make`/`ninja` to ease the oai build and use. It logs the `cmake` and `ninja`/`make` commands it executes. The file describing how to build the executables from source files is the [CMakeLists.txt](../CMakeLists.txt), it is used as input by cmake to generate the makefiles.
 
 The oai softmodem supports many use cases, and new ones are regularly added. Most of them are accessible using the configuration file or the command line options and continuous effort is done to avoid introducing build options as it makes tests and usage more complicated than run-time options. The following functionalities, originally requiring a specific build are now accessible by configuration or command line options:
 
 - s1, noS1
 - all simulators as the rfsimulator, the L2 simulator, with exception of PHY simulators, which are distinct executables. 
 
+# Running `build_oai`
 
-Calling the `build_oai` script with the -h option gives the list of all available options, but a process to simplify and check the requirements of all these options is on-going. Check the [table](BUILD.md "# `build_oai` options") At the end of this page to know the status of `buid_oai` options which are not described hereafter.
+## List of options
 
-# Building PHY Simulators
+Calling the `build_oai` script with the `-h` option gives the list of all available options. A number of important ones:
 
-The PHY layer simulators (LTE and NR) can be built as follows:  
+- The `-I` option is to install pre-requisites, you only need it the first time you build the softmodem or when some oai dependencies have changed.
+- The `-w` option is to select the radio head support you want to include in your build. Radio head support is provided via a shared library, which is called the "oai device" The build script creates a soft link from `liboai_device.so` to the true device which will be used at run-time (here the USRP one, `liboai_usrpdevif.so`). The RF simulator[RF simulator](../radio/rfsimulator/README.md) is implemented as a specific device replacing RF hardware, it can be specifically built using `-w SIMU` option, but is also built during any softmodem build.
+- `--eNB` is to build the `lte-softmodem` executable and all required shared libraries
+- `--gNB` is to build the `nr-softmodem` and `nr-cuup` executables and all required shared libraries
+- `--UE` is to build the `lte-uesoftmodem` executable and all required shared libraries
+- `--nrUE` is to build the `nr-uesoftmodem` executable and all required shared libraries
+- `--ninja` is to use the `ninja` build tool, which speeds up compilation.
+- `-c` is to clean the workspace and force a complete rebuild.
 
+## Installing dependencies
+
+Install all dependencies by issuing the `-I` option. To install furthermore libraries for optional libraries, use the `--install-optional-packages` option. The `-I` option will also install dependencies for an SDR when paired with `-w`. For instance, in order to install all dependencies and the ones for USRP, run:
+
+```bash
+cd openairinterface5g/cmake_targets/
+./build_oai -I --install-optional-packages -w USRP
 ```
-cd <your oai installation directory>/openairinterface5g/
-source oaienv
-cd cmake_targets/
-./build_oai -I --phy_simulators
+
+Note the section on installing UHD further down for more information.
+
+## Building PHY Simulators
+
+The PHY layer simulators (LTE and NR) can be built as follows:  
+
+```bash
+cd openairinterface5g/cmake_targets/
+./build_oai --phy_simulators
 ```
 
 After completing the build, the binaries are available in the `cmake_targets/ran_build/build` directory.
@@ -68,20 +89,11 @@ Detailed information about these simulators can be found [in this dedicated page
 
 After downloading the source files, a single build command can be used to get the binaries supporting all the oai softmodem use cases (UE and [eg]NodeB):
 
-```
-cd <your oai installation directory>/openairinterface5g/
-source oaienv
-cd cmake_targets/
-./build_oai -I -w USRP --eNB --UE --nrUE --gNB
+```bash
+cd openairinterface5g/cmake_targets/
+./build_oai -w USRP --eNB --UE --nrUE --gNB
 ```
 
-- The `-I` option is to install pre-requisites, you only need it the first time you build the softmodem or when some oai dependencies have changed.
-- The `-w` option is to select the radio head support you want to include in your build. Radio head support is provided via a shared library, which is called the "oai device" The build script creates a soft link from `liboai_device.so` to the true device which will be used at run-time (here the USRP one,`liboai_usrpdevif.so` . USRP is the only hardware tested today in the Continuous Integration process. The RF simulator[RF simulator](../radio/rfsimulator/README.md) is implemented as a specific device replacing RF hardware, it can be specifically built using `-w SIMU` option, but is also built during any softmodem build.
-- `--eNB` is to build the `lte-softmodem` executable and all required shared libraries
-- `--gNB` is to build the `nr-softmodem` executable and all required shared libraries
-- `--UE` is to build the `lte-uesoftmodem` executable and all required shared libraries
-- `--nrUE` is to build the `nr-uesoftmodem` executable and all required shared libraries
-
 You can build any oai softmodem executable separately, you may not need all of them depending on your oai usage.
 
 After completing the build, the binaries are available in the `cmake_targets/ran_build/build` directory.
@@ -118,35 +130,56 @@ See:
 * `cmake_targets/tools/uhd-4.x-tdd-patch.diff`
 * `cmake_targets/tools/build_helper` --> function `install_usrp_uhd_driver_from_source`
 
-# Building Optional Binaries
-
-## Telnet Server
-
-The telnet server can be built  with the `--build-lib telnetsrv` option, after building the softmodem or while building it.
-
-`./build_oai -I -w USRP --eNB --UE --build-lib telnetsrv`
-
-or
-
-`./build_oai  --build-lib telnetsrv`
-
-You can get documentation about the telnet server  [here](common/utils/telnetsrv/DOC/telnetsrv.md)
+## Building Optional Binaries
 
+There are a number of optional libraries that can be built in support of the
+RAN, such as telnet, scopes, offloading libraries, etc.
 
+Using the help option of the build script you can get the list of available optional libraries.
 
-## Other optional libraries
+```bash
+./build_oai --build-lib all # build all
+./build_oai --build-lib telnet  # build only telnet
+./build_oai --build-lib "telnet enbscope uescope nrscope nrqtscope"
+./build_oai --build-lib telnet --build-lib nrqtscope
+```
 
-Using the help option of the build script you can get the list of available optional libraries. Those which haven't been mentioned above are known to need more tests and documentation. 
+The following libraries are build in CI and should always work: `telnet`,
+`enbscope`, `uescope`, `nrscope`, `nrqtscope`.
 
-`./build_oai  --build-lib all` will build all available optional libraries.
+Some libraries have further dependencies and might not build on every system:
+- `enbscope`, `uescope`, `nrscope`: libforms/X
+- `nrqtscope`: Qt5
+- `ldpc_cuda`: CUDA
+- `ldpc_t1`: DPDK and VVDN T1
+- `websrv`: npm and others
 
-# `build_oai` options
+# Running `cmake` directly
 
-Please run `./build_oai -h` to get a list of available options.
+`build_oai` is a wrapper on top of `cmake`. It is therefore possible to run `cmake` directly. An example using `ninja`: to build all "main targets" for 5G, excluding additional libraries:
+```
+cd openairinterface5g
+mkdir build && cd build
+cmake .. -GNinja && ninja nr-softmodem nr-uesoftmodem nr-cuup params_libconfig coding rfsimulator ldpc
+```
 
-[oai wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
+To build additional libraries, e.g., telnet, do the following:
+```bash
+cmake .. -GNinja -DENABLE_TELNETSRV=ON && ninja telnetsrv
+```
 
-[oai softmodem features](FEATURE_SET.md)
+A list of all libraries can be seen using `ccmake ..` or `cmake-gui ..`.
 
-[running the oai softmodem ](RUNMODEM.md)
+It is currently not possible to build all targets in the form of `cmake ..
+-GNinja && ninja`: currently, SDRs are always exposed, even if you don't have
+the dependencies, and some targets are simply broken. Again, `build_oai` list
+all targets that it builds, and you can use them with `ninja`
 
+The default target directory of `build_oai` is the following, for historical reasons:
+```bash
+cd openairinterface5g/cmake_targets/ran_build/build
+cmake ../../.. -GNinja
+ccmake ../../..
+cmake-gui ../../..
+```
+You can of course use all standard cmake/ninja/make commands in this directory.

doc/GET_SOURCES.md

@@ -25,7 +25,7 @@ git config --global user.email "Your email address"
 
 ## In order to clone the Git repository (for OAI Users without login to gitlab server)
 
-Cloning RAN repository (eNB RAN + UE RAN):
+Cloning RAN repository:
 
 ```shell
 git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
@@ -35,22 +35,18 @@ git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git
 
 Please send email to [contact@openairinterface.org](mailto:contact@openairinterface.org) to be added to the repository
 as a developer (only important for users who want to commit code to the repository). If
-you do not have account on gitlab.eurecom.fr, please register yourself to gitlab.eurecom.fr and provide the identifiant in the email.
+you do not have account on gitlab.eurecom.fr, please register yourself to gitlab.eurecom.fr and provide the login name in the email.
 
-# Which branch to checkout?
-
-On the RAN side:
-
-* **master**: This branch is targeted for the user community. Since January 2019, it is also subject to a Continuous Integration process. The update frequency is about once every 2-3 months. We are also performing bug fixes on this branch.
-* **develop**: This branch contains recent commits that are tested on our CI test bench. The update frequency is about once a week.
+More information can be found in [a separate page](../CONTRIBUTING.md).
 
-Please see the work flow and policies page:
+# Which branch to checkout?
 
-https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home
+`develop`: contains recent commits that are tested on our CI test bench. The update frequency is about once a week. 5G is only in this branch. It is the recommended  and default branch.
+`master`: contains a stable version of 4G, and will be updated in the future with 5G.
 
-you can find the latest stable tag release here:
+Please see the work flow and policies page: https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home
 
-https://gitlab.eurecom.fr/oai/openairinterface5g/tags
+You can find the latest stable tag release here: https://gitlab.eurecom.fr/oai/openairinterface5g/tags
 
 The tag naming conventions are:
 
@@ -60,4 +56,3 @@ The tag naming conventions are:
 - On `develop` branch **`yyyy`.w`xx`**
   * `yyyy` is the calendar year
   * `xx` the week number within the year
-

doc/README.md

+<table style="border-collapse: collapse; border: none;">
+  <tr style="border-collapse: collapse; border: none;">
+    <td style="border-collapse: collapse; border: none;">
+      <a href="http://www.openairinterface.org/">
+         <img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
+         </img>
+      </a>
+    </td>
+    <td style="border-collapse: collapse; border: none; vertical-align: center;">
+      <b><font size = "5">OpenAirInterface documentation overview</font></b>
+    </td>
+  </tr>
+</table>
+
+[[_TOC_]]
+
+# General
+
+- [FEATURE_SET.md](./FEATURE_SET.md): lists supported features
+- [GET_SOURCES.md](./GET_SOURCES.md): how to download the sources
+- [BUILD.md](./BUILD.md): how to build the sources
+- [clang-format.md](./clang-format.md): how to format the code
+
+There is some general information in the [OpenAirInterface Gitlab Wiki](https://gitlab.eurecom.fr/oai/openairinterface5g/-/wikis/home)
+
+# Tutorials
+
+- Step-by-step tutorials to set up 5G:
+  * [OAI 5GC](./NR_SA_Tutorial_OAI_CN5G.md)
+  * [OAI gNB with COTS UE](./NR_SA_Tutorial_COTS_UE.md)
+  * [OAI NR-UE](./NR_SA_Tutorial_OAI_nrUE.md)
+- [RUNMODEM.md](./RUNMODEM.md): Generic information on how to
+  * Run simulators
+  * Run with hardware
+  * Specific OAI modes (phy-test, do-ra, noS1)
+  * (5G) Using SDAP and custom DRBs
+  * IF setups and arbitrary frequencies
+  * MIMO
+- [How to run a 5G-SA setup](./TESTING_5GSA_setup.md)
+- [How to run a 5G-NSA setup](./TESTING_GNB_W_COTS_UE.md)
+- [How to run a 4G setup using L1 simulator](./L1SIM.md) _Note: we recommend the RFsimulator_
+- [How to use the L2 simulator](./L2NFAPI.md)
+- [How to use multiple BWPs](./RUN_NR_multiple_BWPs.md)
+- [How to run OAI-VNF and OAI-PNF](./RUN_NR_NFAPI.md) _Note: does not work currently_
+- [How to use the positioning reference signal (PRS)](./RUN_NR_PRS.md)
+- [How to use device-to-device communication (D2D, 4G)](./d2d_emulator_setup.txt)
+
+Legacy unmaintained files:
+- `L2NFAPI_NOS1.md`, `L2NFAPI_S1.md`: old L2simulator, not valid anymore
+- `SystemX-tutorial-design.md`
+- `UL_MIMO.txt`
+
+# Designs
+
+- General software architecture notes: [SW_archi.md](./SW_archi.md)
+- [Information on E1](./E1-design.md)
+- [Information on F1](./F1-design.md)
+- [Information on how NR nFAPI works](./NR_NFAPI_archi.md)
+- [Flow graph of the L1 in gNB](SW-archi-graph.md)
+- [L1 threads in NR-UE](./nr-ue-design.md)
+
+Legacy unmaintained files:
+- 5Gnas.md
+
+# Building and running from images
+
+- [How to build images](../docker/README.md)
+- [How to run 5G with the RFsimulator from images](../ci-scripts/yaml_files/5g_rfsimulator/README.md)
+- [How to run 4G with the RFsimulator from images](../ci-scripts/yaml_files/4g_rfsimulator_fdd_05MHz/README.md)
+- [How to run 5G with the L2simulator from images](../ci-scripts/yaml_files/5g_l2sim_tdd/README.md)
+- [How to run images in OpenShift](../openshift/README.md)
+
+# Libraries
+
+## General
+
+- The [T tracer](https://gitlab.eurecom.fr/oai/openairinterface5g/-/wikis/T/): a generic tracing tool (VCD, Wireshark, GUI, to save for later, ...)
+- [OPT](../openair2/UTIL/OPT/README.txt): how to trace to wireshark
+- The [configuration module](../common/config/DOC/config.md)
+- The [logging module](../common/utils/LOG/DOC/log.md)
+- The [shared object loader](../common/utils/DOC/loader.md)
+- The [threadpool](../common/utils/threadPool/thread-pool.md) used in L1
+
+## SDRs
+
+Some directories under `radio` contain READMEs:
+
+- [RFsimulator](../radio/rfsimulator/README.md)
+- [USRP](../radio/USRP/README.md)
+- [BladeRF](../radio/BLADERF/README)
+- [IQPlayer](../radio/iqplayer/DOC/iqrecordplayer_usage.md)
+
+The other SDRs (AW2S, LimeSDR, ...) have no READMEs.
+
+## Special-purpose libraries
+
+- OAI comes with an integrated [telnet server](../common/utils/telnetsrv/DOC/telnethelp.md) to monitor and control
+- OAI comes with an integrated [web server](../common/utils/websrv/DOC/websrv.md)
+
+# CI
+
+- [TESTBenches.md](./TESTBenches.md) lists the CI setup and links to pipelines

doc/RUNMODEM.md

@@ -7,89 +7,113 @@
       </a>
     </td>
     <td style="border-collapse: collapse; border: none; vertical-align: center;">
-      <b><font size = "5">Running OAI Softmodem</font></b>
+      <b><font size = "5">Running OAI Softmodems</font></b>
     </td>
   </tr>
 </table>
 
 After you have [built the softmodem executables](BUILD.md) you can set your default directory  to the build directory `cmake_targets/ran_build/build/` and start testing some use cases. Below, the description of the different oai functionalities should help you choose the oai configuration that suits your need. 
 
-# RF Simulator
+[[_TOC_]]
 
-The rf simulator is a oai device replacing the radio heads (for example the USRP device). It allows connecting the oai UE (LTE or 5G) and respectively the oai eNodeB or gNodeB through a network interface carrying the time-domain samples, getting rid of over the air unpredictable perturbations. This is the ideal tool to check signal processing algorithms and protocols implementation.  The rf simulator has some preliminary support for channel modeling.
+# Simulators
+
+## RFsimulator
+
+The RF simulator is an OAI device replacing the radio heads (for example the USRP device). It allows connecting the oai UE (LTE or 5G) and respectively the oai eNodeB or gNodeB through a network interface carrying the time-domain samples, getting rid of over the air unpredictable perturbations. This is the ideal tool to check signal processing algorithms and protocols implementation.  The rf simulator has some preliminary support for channel modeling.
 
 It is planned to enhance this simulator with the following functionalities:
 
-- Support for multiple UE connections,each UE being a `lte-uesoftmodem` or `nr_uesoftmodem` instance.
 - Support for multiple eNodeB's or gNodeB's for hand-over tests
 
-   This is an easy use-case to setup and test, as no specific hardware is required. The [rfsimulator page](../radio/rfsimulator/README.md ) contains the detailed documentation.
+This is an easy use-case to setup and test, as no specific hardware is required. The [rfsimulator page](../radio/rfsimulator/README.md ) contains the detailed documentation.
 
-# L2 nFAPI Simulator
+## L2 nFAPI Simulator
 
 This simulator connects a eNodeB  and UEs through a nfapi interface, short-cutting the L1 layer. The objective of this simulator is to allow multi UEs simulation, with a large number of UEs (ideally up to 255 ) .Here to ease the platform setup, UEs are simulated via a single `lte-uesoftmodem` instance. Today the CI tests just with one UE and architecture has to be reviewed to allow a number of UE above about 16. This work is on-going.
 
 As for the rf simulator, no specific hardware is required. The [L2 nfapi simulator page](L2NFAPI.md) contains the detailed documentation.
 
-# L1 Simulator
+## L1 Simulator
+
+**This information might be outdated. We recommend to use the RFsimulator as
+shown above.**
 
 The L1 simulator is using the ethernet fronthaul protocol, as used to connect a RRU and a RAU to connect UEs and a eNodeB. UEs are simulated in a single `lte-uesoftmodem` process, as for the nfapi simulator. 
 
 The [L1 simulator page](L1SIM.md) contains the detailed documentation.
 
-## noS1 mode
-
-The noS1 mode is now available via the `--noS1`command line option. It can be used with simulators, described above, or when using oai with true RF boards. Only the oai UE can be connected to the oai eNodeB in noS1 mode.
-
-By default the noS1 mode is using linux tun interfaces to send or receive ip packets to/from the linux ip stack. using the `--nokrnmod 0`option you can enforce kernel modules instead of tun.
-
-noS1 code has been revisited, it has been tested with the rf simulator, and tun interfaces. More tests are on going and CI will soon include noS1 tests.
-
 # Running with a true radio head
 
-oai supports [number of deployment](FEATURE_SET.md) model, the following are tested in the CI:
+OAI supports different radio heads, the following are tested in the CI:
 
-1.  [Monolithic eNodeB](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/HowToConnectCOTSUEwithOAIeNBNew) where the whole signal processing is performed in a single process
-2. if4p5 mode, where frequency domain samples are carried over ethernet, from the RRU which implement part of L1(FFT,IFFT,part of PRACH),  to a RAU
+1. [Monolithic eNodeB](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/HowToConnectCOTSUEwithOAIeNBNew) where the whole signal processing is performed in a single process
+2. IF4P5 mode, where frequency domain samples are carried over ethernet, from the RRU which implement part of L1(FFT,IFFT,part of PRACH),  to a RAU
+3. Monolithic gNodeB: see next section, or the [standalone tutorial](NR_SA_Tutorial_COTS_UE.md)
 
-# 5G NR
 
-As of February 2020, all 5G NR development is part of the develop branch (the branch develop-nr is no longer maintained). This also means that all new development will be merged into there once it passes all the CI. 
+# 5G NR
 
 ## NSA setup with COTS UE
 
 This setup requires an EPC, an OAI eNB and gNB, and a COTS Phone. A dedicated page describe the setup can be found [here](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home/gNB-COTS-UE-testing).
 
+### Launch eNB
+
+```bash
+sudo ./lte-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.tm1.50PRB.usrpb210.conf
+```
+
 ### Launch gNB
 
-```bash sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf```
+```bash
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf
+```
 
-### Launch eNB
+You should see the X2 messages in Wireshark and at the eNB.
 
-```bash sudo ./lte-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.tm1.50PRB.usrpb210.conf```
+## SA setup with OAI NR-UE
 
+The sa flag is used to run gNB in standalone mode.
 
+In order to run gNB and UE in standalone mode, the `--sa` flag is needed.
 
-## phy-test setup with OAI UE
+At the gNB the `--sa` flag does the following:
+- The RRC encodes SIB1 according to the configuration file and transmits it through NR-BCCH-DL-SCH.
 
-The OAI UE can also be used in front of a OAI gNB without the support of eNB or EPC. In this case both gNB and eNB need to be run with the --phy-test flag. At the gNB this flag does the following
- - it reads the RRC configuration from the configuration file
- - it encodes the RRCConfiguration and the RBconfig message and stores them in the binary files rbconfig.raw and reconfig.raw
- - the MAC uses a pre-configured allocation of PDSCH and PUSCH with randomly generated payload
+At the UE the --sa flag will:
+- Decode SIB1 and starts the 5G NR Initial Access Procedure for SA:
+  1) 5G-NR RRC Connection Setup
+  2) NAS Authentication and Security
+  3) 5G-NR AS Security Procedure
+  4) 5G-NR RRC Reconfiguration
+  5) Start Downlink and Uplink Data Transfer
 
-At the UE the --phy-test flag will
- - read the binary files rbconfig.raw and reconfig.raw from the current directory (a different directory can be specified with the flag --rrc_config_path) and process them.
+Command line parameters for UE in --sa mode:
+- `-C` : downlink carrier frequency in Hz (default value 0)
+- `--CO` : uplink frequency offset for FDD in Hz (default value 0)
+- `--numerology` : numerology index (default value 1)
+- `-r` : bandwidth in terms of RBs (default value 106)
+- `--band` : NR band number (default value 78)
+- `--ssb` : SSB start subcarrier (default value 512)
 
+You can run this, using USRPs, on two separate machines:
 
-### Launch gNB
+```
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.conf --gNBs.[0].min_rxtxtime 6 --sa
+sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --ssb 516 --sa
+```
 
-```bash sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --phy-test```
+With the RF simulator (on the same machine):
 
-In phy-test mode it is possible to mimic the reception of UE Capabilities at gNB by passing through the command line parameter `--uecap_file` the location and file name of the input UE Capability file, e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml`
+```bash
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.conf --gNBs.[0].min_rxtxtime 6 --rfsim --sa
+sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --ssb 516 --rfsim --sa
+```
 
-### Launch UE in another window
+Additionally, at UE side `--uecap_file` option can be used to pass the UE Capabilities input file (path location + filename), e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml`
 
-```bash sudo ./nr-uesoftmodem --phy-test [--rrc_config_path ../../../ci-scripts/rrc-files]```
+## Some useful NR-UE parameters
 
 Some other useful paramters of the UE are
 
@@ -98,88 +122,66 @@ Some other useful paramters of the UE are
  - --clock-source: sets the clock-source (internal or external). 
  - --time-source: sets the time-source (internal or external). 
 
-## noS1 setup with OAI UE
-
-Instead of randomly generated payload, in the phy-test mode we can also inject/receive user-plane traffic over a TUN interface. This is the so-called noS1 mode. 
-
-This setup is described in the [rfsimulator page](../radio/rfsimulator/README.md#5g-case). In theory this should also work with the real hardware target although this has yet to be tested.
-
-## do-ra setup with OAI
-
-The do-ra flag is used to ran the NR Random Access procedures in contention-free mode. Currently OAI implements the RACH process from Msg1 to Msg3. 
 
-In order to run the RA, the following flag is needed for both the gNB and the UE:
+# Specific OAI modes
 
-`--do-ra`
-
-### Run OAI in do-ra mode
-
-From the `cmake_targets/ran_build/build` folder:
-
-gNB on machine 1:
-
-`sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --do-ra`
-
-In do-ra mode it is possible to mimic the reception of UE Capabilities at gNB by passing through the command line parameter `--uecap_file` the location and file name of the input UE Capability file, e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml`
-
-UE on machine 2:
-
-`sudo ./nr-uesoftmodem --do-ra`
+## phy-test setup with OAI UE
 
-With the RF simulator (on the same machine):
+The OAI UE can also be used in front of a OAI gNB without the support of eNB or EPC. In this case both gNB and eNB need to be run with the --phy-test flag. At the gNB this flag does the following
+ - it reads the RRC configuration from the configuration file
+ - it encodes the RRCConfiguration and the RBconfig message and stores them in the binary files rbconfig.raw and reconfig.raw
+ - the MAC uses a pre-configured allocation of PDSCH and PUSCH with randomly generated payload
 
-`sudo RFSIMULATOR=gnb ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --do-ra --rfsim --parallel-config PARALLEL_SINGLE_THREAD`
+At the UE the --phy-test flag will
+ - read the binary files rbconfig.raw and reconfig.raw from the current directory (a different directory can be specified with the flag --rrc_config_path) and process them.
 
-`sudo RFSIMULATOR=127.0.0.1 ./nr-uesoftmodem --do-ra --rfsim --parallel-config PARALLEL_SINGLE_THREAD`
 
-## SA setup with OAI
+```bash
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --phy-test
+```
 
-The sa flag is used to run gNB in standalone mode.
+In phy-test mode it is possible to mimic the reception of UE Capabilities at gNB by passing through the command line parameter `--uecap_file` the location and file name of the input UE Capability file, e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml` (1 layer) or `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports2.xml` (2 layers).
 
-In order to run gNB and UE in standalone mode, the following flag is needed:
+```bash
+sudo ./nr-uesoftmodem --phy-test [--rrc_config_path ../../../ci-scripts/rrc-files]
+```
 
-`--sa`
+You need to provide `--rrc_config_path` if you don't start the UE after the gNB
+in the same directory.
 
-At the gNB the --sa flag does the following:
-- The RRC encodes SIB1 according to the configuration file and transmits it through NR-BCCH-DL-SCH.
+## noS1 setup with OAI UE
 
-At the UE the --sa flag will:
-- Decode SIB1 and starts the 5G NR Initial Access Procedure for SA:
-  1) 5G-NR RRC Connection Setup
-  2) NAS Authentication and Security
-  3) 5G-NR AS Security Procedure
-  4) 5G-NR RRC Reconfiguration
-  5) Start Downlink and Uplink Data Transfer
+Instead of randomly generated payload, in the phy-test mode we can also inject/receive user-plane traffic over a TUN interface. This is the so-called noS1 mode. 
 
-Command line parameters for UE in --sa mode:
-- `C` : downlink carrier frequency in Hz (default value 0)
-- `CO` : uplink frequency offset for FDD in Hz (default value 0)
-- `numerology` : numerology index (default value 1)
-- `r` : bandwidth in terms of RBs (default value 106)
-- `band` : NR band number (default value 78)
-- `s` : SSB start subcarrier (default value 512)
+This setup is described in the [rfsimulator page](../radio/rfsimulator/README.md#5g-case). In theory this should also work with the real hardware target although this has yet to be tested.
 
-### Run OAI in SA mode
+## do-ra setup with OAI
 
-From the `cmake_targets/ran_build/build` folder:
+The do-ra flag is used to ran the NR Random Access procedures in contention-free mode. Currently OAI implements the RACH process from Msg1 to Msg3. 
 
-gNB on machine 1:
+In order to run the RA, the `--do-ra` flag is needed for both the gNB and the UE.
 
-`sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.conf --gNBs.[0].min_rxtxtime 6 --sa`
+In do-ra mode it is possible to mimic the reception of UE Capabilities at gNB by passing through the command line parameter `--uecap_file` the location and file name of the input UE Capability file, e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml`
 
-UE on machine 2:
+To run using the RFsimulator:
 
-`sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --ssb 516 --sa`
+```bash
+sudo RFSIMULATOR=gnb ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --do-ra --rfsim --parallel-config PARALLEL_SINGLE_THREAD
+sudo RFSIMULATOR=127.0.0.1 ./nr-uesoftmodem --do-ra --rfsim --parallel-config PARALLEL_SINGLE_THREAD
+```
 
-With the RF simulator (on the same machine):
+Using USRPs:
 
-`sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.conf --gNBs.[0].min_rxtxtime 6 --rfsim --sa`
+```bash
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf --do-ra
+```
 
-`sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --ssb 516 --rfsim --sa`
+On a separate machine:
 
-where `-r` sets the transmission bandwidth configuration in terms of RBs, `-C` sets the downlink carrier frequency and `--ssb` sets the SSB start subcarrier.
+```bash
+sudo ./nr-uesoftmodem --do-ra
+```
 
-Additionally, at UE side `--uecap_file` option can be used to pass the UE Capabilities input file (path location + filename), e.g. `--uecap_file ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/uecap_ports1.xml`
 
 ### Run OAI with SDAP & Custom DRBs
 
@@ -208,17 +210,14 @@ Accordingly, the following parameters must be configured in the RUs section of t
 
 The following example uses DL frequency 2169.080 MHz and UL frequency offset -400 MHz, with a configuration file for band 66 (FDD) at gNB side.
 
-From the `cmake_targets/ran_build/build` folder:
-
-gNB on machine 1:
-
-`sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band66.tm1.106PRB.usrpx300.conf`
+On two separate machines with USRPs, run:
 
-UE on machine 2:
+```
+sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band66.tm1.106PRB.usrpx300.conf
+sudo ./nr-uesoftmodem --if_freq 2169080000 --if_freq_off -400000000
+```
 
-`sudo ./nr-uesoftmodem --if_freq 2169080000 --if_freq_off -400000000`
-
-# MIMO configuration
+# 5G gNB MIMO configuration
 
 In order to enable DL-MIMO in OAI 5G softmodem, the prerequisite is to have `do_CSIRS = 1` in the configuration file. This allows the gNB to schedule CSI reference signal and to acquire from the UE CSI measurements to be able to schedule DLSCH with MIMO.
 
@@ -246,10 +245,3 @@ Finally the number of TX physical antenna in the RU part of the configuration fi
 # Additional links
 
 [Selecting an alternative ldpc implementation at run time](../openair1/PHY/CODING/DOC/LDPCImplementation.md)
-
-[oai wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
-
-[oai softmodem features](FEATURE_SET.md)
-
-[oai softmodem build procedure](BUILD.md)
-

doc/TESTBenches.md

@@ -6,25 +6,25 @@
 
 | Machine       | IP address      | Lockable Resource     | Function           | Connected devices                                     |
 | ------------- | --------------- | --------------------- | ------------------ | ----------------------------------------------------- |
-| asterix       | 172.21.16.127   | CI-Asterix-Usage      | gNB (n78)          | 173.21.19.14                                          |
-| obelix        | 172.21.16.128   | CI-Obelix-Usage       | eNB (n40, n78), nrUE | 172.21.19.13, X300 (192.168.60.2), B200mini (30C51EB) |
-| porcepix      | 172.21.16.136   | CI-NSA-MiniBench      | Executor, EPC, 5GC | --                                                    |
-| nrmodule2     | 172.21.16.139   | CI-NSA-MiniBench      | Quectel            | Quectel module                                        |
-| nepes         | 172.21.16.137   | CI-NSA-MiniBench      | gNB (n78)          | B200mini (30C51D4)                                    |
+| asterix       | 172.21.16.127   | CI-Asterix-Usage      | gNB (n78)          | 172.21.19.14                                          |
+| obelix        | 172.21.16.128   | CI-Obelix-Usage       | eNB (n40, n78), nrUE | 172.21.19.13, X300 (192.168.60.2)                   |
+| porcepix      | 172.21.16.136   | CI-Porcepix           | Executor, EPC, 5GC | --                                                    |
+| nrmodule2     | 172.21.16.139   | CI-NrModule2          | Quectel            | Quectel module                                        |
+| nepes         | 172.21.16.137   | CI-Nepes              | gNB (n78), EPC/5GC | B200mini (30C51EB)                                    |
+| ofqot         | 172.21.16.109   | CI-Ofqot              | gNB (n78)          | B200mini (30C51D4)                                    |
+| idefix        | 172.21.16.135   | CI-Idefix             | Quectel            | Quectel module                                        |
 | caracal       | 172.21.16.132   | CI-Caracal            | gNB/phytest        | N300 (192.168.10.2)                                   |
-| idefix        | 172.21.16.135   | CI-NSA-MiniBench      | Quectel            | Quectel module                                        |
 | amariue       | 172.21.16.144   | CI-Amarisoft-UE-Usage | nrUE               | Amarisoft UE simulator                                |
-| bellatrix     | 192.168.117.115 | CI-RAN-VM-Deployment  | Executor           | --                                                    |
-| nano          | 172.21.18.48    | CI-Bench-1-Phones     | EPC, adb           | 2x COTS (adb)                                         |
-| hutch         | 172.21.18.46    | CI-Bench-1-Phones     | eNB (B7)           | B200mini (30C5239)                                    |
-| starsky       | 172.21.18.45    | CI-Bench-1-Phones     | eNB (B40)          | b200mini (30A3E3C)                                    |
-| carabe        | 172.21.18.47    | CI-Bench-2-OAI-Phone  | UE (B7UE)          | B200mini (30AE8C9)                                    |
+| manarola      | 172.21.8.116    | _None_                | gNB                | AW2S                                                  |
+| nano          | 172.21.18.48    | CI-Nano-Legacy-EPC    | Executor, EPC, adb | 2x COTS (adb)                                         |
+| hutch         | 172.21.18.46    | CI-Hutch-Legacy-FDD-eNB | eNB (B7)           | B200mini (30C5239)                                  |
+| starsky       | 172.21.18.45    | CI-Starsky-Legacy-TDD-eNB       | eNB (B40)  | b200mini (30A3E3C)                                  |
+| carabe        | 172.21.18.47    | CI-Carabe-Legacy-FDD-OAI-LTE-UE | UE (B7UE)  | B200mini (30AE8C9)                                  |
+| nokiabox      | 172.21.19.39    | _None_                | gNB (Nokia), 5GC   | _Nokia RF integrated_                                 |
 
 Note: The available resources, and their current usage, is indicated here:
 - [Lockable resources of jenkins-oai](https://jenkins-oai.eurecom.fr/lockable-resources/):
   "New" Jenkins, i.e., with RAN-Container-Parent
-- [Lockable resources of open5glab jenkins](https://open5glab.eurecom.fr:8083/jenkins/lockable-resources/):
-  "Old" Jenkins, i.e., with RAN-CI-Develop
 
 ## Networked devices
 
@@ -35,37 +35,39 @@ Note: The available resources, and their current usage, is indicated here:
 
 ## Testbenches
 
-### OTA Testbench
+### 5G OTA Testbench
 
-**Purpose**: Over-the-air 4G/5G (NSA/SA) tests
-
-Note: obelix and porcepix are both used in the OTA testbench and the 5G
-NSA/Faraday Cage testbench!
+**Purpose**: Over-the-air 4G/5G (NSA/SA) tests, performance tests
 
 ![5G OTA Testbench](testbenches_doc_resources/5g-ota-bench.png)
 
 [PDF version](testbenches_doc_resources/5g-ota-bench.pdf) | [LaTeX/TikZ version](testbenches_doc_resources/5g-ota-bench.tex) if you want to modify to reflect your setup
 
-### 5G NSA/Faraday Cage Testbench
 
-**Purpose**: Faraday cage 5G tests
+### 5G NSA/Faraday Cage Testbench
 
-Note: obelix and porcepix are both used in the OTA testbench and the 5G
-NSA/Faraday Cage testbench!
+**Purpose**: Faraday cage 5G tests, functional tests
 
 ![5G NSA/Faraday Cage Testbench](testbenches_doc_resources/5g-nsa-faraday-bench.png)
 
 [PDF version](testbenches_doc_resources/5g-nsa-faraday-bench.pdf) | [LaTeX/TikZ version](testbenches_doc_resources/5g-nsa-faraday-bench.tex) if you want to modify to reflect your setup
 
+### 5G AW2S Testbench
+
+**Purpose**: AW2S tests with Amarisoft
+
+Picture: TBD
+
+
 ### 4G Testbench(es)
 
 **Purpose**: 4G/LTE testbenches
 
-
 ![4G Faraday Cage Testbench](testbenches_doc_resources/4g-faraday-bench.png)
 
 [PDF version](testbenches_doc_resources/4g-faraday-bench.pdf) | [LaTeX/TikZ version](testbenches_doc_resources/4g-faraday-bench.tex) if you want to modify to reflect your setup
 
+
 ## Pipelines
 
 ### [RAN-Container-Parent](https://jenkins-oai.eurecom.fr/job/RAN-Container-Parent/)
@@ -76,53 +78,48 @@ Webhook
 - [RAN-cppcheck](https://jenkins-oai.eurecom.fr/job/RAN-cppcheck/1664/)
   - obelix
   - performs static code analysis, currently not actively enforced
-- [RAN-gNB-nrUE-MONO-TDD-Band78-N300](https://jenkins-oai.eurecom.fr/job/RAN-gNB-nrUE-MONO-TDD-Band78-N300/)
+- [RAN-gNB-N300-Timing-Phytest-LDPC](https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-gNB-N300-Timing-Phytest-LDPC/)
   - caracal + N310
-  - pure performance test through phy-test scheduler, see command line for more
-    details
+  - pure performance test through phy-test scheduler, see command line for more details
 - [RAN-L2-Sim-Test-5G](https://jenkins-oai.eurecom.fr/job/RAN-L2-Sim-Test-4G/)
   - obelix (eNB, 1x UE, OAI EPC)
   - L2simulator: skips physical layer and uses proxy between eNB and UE
 - [RAN-L2-Sim-Test-5G](https://jenkins-oai.eurecom.fr/job/RAN-L2-Sim-Test-5G/)
   - obelix (gNB, 1x UE, OAI 5GC)
-  - L2simulator: skips physical layer and uses proxy between gNB and UE,
-    currently only ping
+  - L2simulator: skips physical layer and uses proxy between gNB and UE, currently only ping
+- [RAN-LTE-FDD-LTEBOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-LTE-FDD-LTEBOX-Container/)
+  - hutch + B210, nano w/ ltebox + 2x UE
+  - tests RRC inactivity timers, different bandwidths
+- [RAN-LTE-TDD-2x2-Container](https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-LTE-TDD-2x2-Container/)
+  - obelix + N310, porcepix, quectel
+  - TM1 and TM2 test
+- [RAN-LTE-TDD-LTEBOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-LTE-TDD-LTEBOX-Container/)
+  - starsky + B210, nano w/ ltebox + 2x UE
+  - TM1 over bandwidths 5, 10, 20 MHz in Band 40, default scheduler for 20 MHz
 - [RAN-NSA-B200-Module-LTEBOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-NSA-B200-Module-LTEBOX-Container/)
-  - obelix + B200, nepes + B200, idefix + Quectel, porcepix w/ ltebox
+  - nepes + B200 (eNB), ofqot + B200 (gNB), idefix + Quectel, nepes w/ ltebox
   - basic NSA test
-- [RAN-SA-B200-Module-SABOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-SA-B200-Module-SABOX-Container/)
-  - obelix + B200, nepes + B200, idefix + Quectel, porcepix w/ sabox
-  - basic SA test (40 MHz TDD)
 - [RAN-PhySim-Cluster](https://jenkins-oai.eurecom.fr/job/RAN-PhySim-Cluster/)
-  - poseidon (jumphost, `Asterix-OC-oaicicd-session` resource), tests in
-    OpenShift Cluster
+  - cluster (`Asterix-OC-oaicicd-session` resource), tests in OpenShift Cluster
   - unitary simulators (`nr_dlsim`, etc.)
 - [RAN-RF-Sim-Test-4G](https://jenkins-oai.eurecom.fr/job/RAN-RF-Sim-Test-4G/)
-  - obelix (eNB, 1x UE, OAI EPC)
+  - obelix (eNB, lteUE, OAI EPC)
   - uses RFsimulator, for FDD 5, 10, 20MHz with core, 5MHz noS1
 - [RAN-RF-Sim-Test-5G](https://jenkins-oai.eurecom.fr/job/RAN-RF-Sim-Test-5G/)
-  - obelix (gNB, 2x UE, OAI 5GC)
+  - obelix (gNB, nrUE, OAI 5GC)
   - uses RFsimulator, TDD 40MHz, FDD 40MHz, F1 split
 - [RAN-RHEL8-Cluster-Image-Builder](https://jenkins-oai.eurecom.fr/job/RAN-RHEL8-Cluster-Image-Builder/)
-  - poseidon (jumphost, `Asterix-OC-oaicicd-session` resource): RHEL 8 image
-    build using the OpenShift Cluster
-- [RAN-Ubuntu18-Image-Builder](https://jenkins-oai.eurecom.fr/job/RAN-Ubuntu18-Image-Builder/)
-  - obelix: Ubuntu 18 image build using docker
-- [RAN-LTE-TDD-2x2-Container](https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-LTE-TDD-2x2-Container/)
-  - obelix + N310, porcepix, quectel
-  - TM1 and TM2 test 
+  - cluster (`Asterix-OC-oaicicd-session` resource): RHEL 8 image build using the OpenShift Cluster
+- [RAN-SA-B200-Module-SABOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-SA-B200-Module-SABOX-Container/)
+  - ofqot + B200, idefix + Quectel, nepes w/ sabox
+  - basic SA test (20 MHz TDD), F1, reestablishment, ...
+- [RAN-Ubuntu20-Image-Builder](https://jenkins-oai.eurecom.fr/job/RAN-Ubuntu18-Image-Builder/)
+  - obelix: Ubuntu 20 image build using docker (Note: builds U20 images while pipeline is named U18!)
 
-### [RAN-CI-NSA-Trigger](https://jenkins-oai.eurecom.fr/view/RAN/job/RAN-CI-NSA-Trigger/)
+### RAN-CI-NSA-Trigger
 
-**Purpose**: longer-running over-the-air LTE, NSA, and SA tests, triggered
-through cron job at midnight
+***DEFUNCT***: longer-running over-the-air LTE, NSA, and SA tests. To be integrated into RAN-Container-Parent.
 
-- [RAN-LTE-2x2-Module-OAIEPC](https://jenkins-oai.eurecom.fr/job/RAN-LTE-2x2-Module-OAIEPC/)
-  - obelix + N310, nrmodule2 + Quectel, porcepix w/ Magma EPC
-  - LTE 2x2 test with TM1 and TM2
-- [RAN-NSA-B200-Module-LTEBOX](https://jenkins-oai.eurecom.fr/job/RAN-NSA-B200-Module-LTEBOX/)
-  - obelix + B200 (eNB), nepes + B200 (gNB), idefix + Quectel, porcepix w/ ltebox
-  - Note: like [RAN-NSA-B200-Module-LTEBOX-Container](https://jenkins-oai.eurecom.fr/job/RAN-NSA-B200-Module-LTEBOX-Container/) above, but compiled/run from source
 - [RAN-NSA-2x2-Module-OAIEPC](https://jenkins-oai.eurecom.fr/job/RAN-NSA-2x2-Module-OAIEPC/)
   - obelix + N310 (eNB), asterix + N310 (gNB), nrmodule2 + Quectel, porcepix w/ Magma EPC
   - LTE 2x2 and NR 2x2 (non-standalone)
@@ -136,32 +133,22 @@ through cron job at midnight
   - asterix + N310, amariue (1x UE), porcepix w/ OAI 5GC
   - Amarisoft UE simulator: expected to be increased to more UEs
 
-### [RAN-CI-develop](https://open5glab.eurecom.fr:8083/jenkins/job/RAN-CI-develop/)
+### RAN-CI-develop
 
-**Purpose**: automatically triggered tests, mostly 4G, to be phased out and
+***DEFUNCT***: automatically triggered tests, mostly 4G, to be phased out and
 integrated into RAN-Container-Parent
 
-runs tests:
-- bellatrix: runs 4G/5G simulators directly (eNB + 1x UE + (opt.) OAI EPC, gNB + 1x UE in "noS1")
-
-triggers pipelines:
-- [eNB-CI-FDD-Band7-B210](https://open5glab.eurecom.fr:8083/jenkins/job/eNB-CI-FDD-Band7-B210/)
-  - hutch + B210, nano w/ ltebox + 2x UE
-  - tests T tracer, RRC inactivity timers, different bandwidths
-- [eNB-CI-IF4p5-FDD-Band7-B210](https://open5glab.eurecom.fr:8083/jenkins/job/eNB-CI-IF4p5-FDD-Band7-B210/)
+The following defunct pipelines remain to be integrated into RAN-Container-Parent:
+- eNB-CI-IF4p5-FDD-Band7-B210
   - hutch + B210, nano w/ ltebox + 2x UE
   - tests IF4.5 split over bandwidths 5, 10, 20 MHz in Band 7
-- [eNB-CI-IF4p5-TDD-Band40-B210](https://open5glab.eurecom.fr:8083/jenkins/job/eNB-CI-IF4p5-TDD-Band40-B210/)
+- eNB-CI-IF4p5-TDD-Band40-B210
   - starsky + B210, nano w/ ltebox + 2x UE
   - tests IF4.5 split over bandwidths 5, 10, 20 MHz in Band 40
-- [eNB-CI-TDD-Band40-B210](https://open5glab.eurecom.fr:8083/jenkins/job/eNB-CI-TDD-Band40-B210/)
-  - starsky + B210, nano w/ ltebox + 2x UE
-  - T tracer, TM1 over bandwidths 5, 10, 20 MHz in Band 40, default scheduler
-    for 20 MHz
-- [eNB-UE-CI-MONO-FDD-Band7-B200](https://open5glab.eurecom.fr:8083/jenkins/job/eNB-UE-CI-MONO-FDD-Band7-B200/)
+- eNB-UE-CI-MONO-FDD-Band7-B200
   - hutch + B210 (eNB), carabe + B210 (4G UE), nano w/ ltebox
   - tests OAI 4G for 5 MHz/TM1 with both CN and in noS1 model, MBMS; known to
     be unstable
-- [UE-CI-FDD-Band20-B200](https://open5glab.eurecom.fr:8083/jenkins/job/UE-CI-FDD-Band20-B200/)
+- UE-CI-FDD-Band20-B200
   - starsky + B210 (sniffer)
   - Sniff MIB + SIB1 of Orange, SFR

doc/TESTING_GNB_W_COTS_UE.md

@@ -395,18 +395,3 @@ The following parts have been validated with FR1 COTS UE:
     DL traffic : 3Mbps  
     UL traffic : 1Mbps  
     some packet losses might still occur even in ideal channel conditions  
-
-
-## CI integration  
-The automation scripts are available on ILIADE.  
-The end-to-end test is integrated in the CI flow in a semi-automated manner, comprising 3 steps:  
-- update a YAML file comprising the IT resources definition, branch and commit number the test has to run on   
-- run the python script that generates the test from the YAML file  
-```
-python3 obj_build_from_yaml.py py_params_template.yaml fr1.sh
-```
-- run the test (fr1.sh)
-
-At the date of writing, the test comprises the deployment of the components (epc, eNB, gNB, cots ue) and the execution of 2 pings procedures (20 pings in 20sec, then 5 pings in 1sec)  
-
-This automation is run for every integration branch to be merged into develop.

doc/testbenches_doc_resources/5g-nsa-faraday-bench.tex

@@ -15,27 +15,24 @@
 
   \node[faraday, label={[anchor=south east]above right:Faraday cage}] (faraday) {};
 
-  \node[above left=0cm and 2.8cm of faraday, label=above:obelix] (obelix)
+  \node[above left=-0.50cm and 2.8cm of faraday, label=above:nepes] (nepes)
     {\includegraphics[width=1.2cm]{server}};
-  \node[right=0.3cm of obelix, label=above:B200-mini] (b210o)
-    {\includegraphics[width=1.2cm]{b200-mini}} edge (obelix);
+  \node[right=0.3cm of nepes, label=above:B200-mini] (b210o)
+    {\includegraphics[width=1.2cm]{b200-mini}} edge (nepes);
   \node[below right=0.35cm of faraday.north west] (anto)
     {\includegraphics[width=0.3cm]{antenna}};
   \draw (b210o) -| node [pos=0.2, duplexer] {B7} (anto);
 
-  \node[below left=0cm and 2.8cm of faraday, label=above:nepes] (nepes)
+  \node[below left=-0.50cm and 2.8cm of faraday, label=below:ofqot] (ofqot)
     {\includegraphics[width=1.2cm]{server}};
-  \node[right=0.3cm of nepes, label=above:B200-mini] (b210n)
-    {\includegraphics[width=1.2cm]{b200-mini}} edge (nepes);
-  \draw (obelix) -- (b210o);
+  \node[right=0.3cm of ofqot, label=above:B200-mini] (b210n)
+    {\includegraphics[width=1.2cm]{b200-mini}} edge (ofqot);
+  \draw (nepes) -- (b210o);
   \node[above right=0.35cm of faraday.south west] (antn)
     {\includegraphics[width=0.3cm]{antenna}};
   \draw (b210n) -| node [pos=0.2, duplexer] {n78} (antn);
 
-  \node[left=5cm of faraday, label=above:porcepix] (porcepix)
-    {\includegraphics[width=1.2cm]{server}};
-  \draw (obelix) -- (porcepix);
-  \draw (nepes) -- (porcepix);
+  \draw (nepes) -- (ofqot);
 
   \node[right=1.5cm of faraday, label=above:RM500Q-GL] (quectel)
     {\includegraphics[height=1.2cm]{quectel}};

doc/testbenches_doc_resources/5g-ota-bench.tex

@@ -16,7 +16,7 @@
   \node[label=above:porcepix] (porcepix)
     {\includegraphics[width=1.2cm]{server}};
 
-  \node[above right=1cm and 2cm of porcepix, label=above:asterix] (asterix)
+  \node[above right=-0.4cm and 2cm of porcepix, label=above:asterix] (asterix)
     {\includegraphics[width=1.2cm]{server}}
     edge (porcepix);
   \node[right=0.3cm of asterix, label=above:N310] (n310a)
@@ -27,7 +27,7 @@
   \node[above right=-0.1cm and 0.35cm of b78o.east] (anto2)
     {\includegraphics[width=0.3cm]{antenna}} edge (b78o);
 
-  \node[right=2cm of porcepix, label=above:obelix] (obelix)
+  \node[below right=-0.4cm and 2cm of porcepix, label=above:obelix] (obelix)
     {\includegraphics[width=1.2cm]{server}}
     edge (porcepix);
   \node[above right=-0.5cm and 0.3cm of obelix, label=above:N310] (n310o)
@@ -45,7 +45,7 @@
   \node[above right=-0.1cm and 0.35cm of b78o.east] (anto2)
     {\includegraphics[width=0.3cm]{antenna}} edge (b78o);
 
-  \node[above right=-1.3cm and 5.0cm of n310a.east, label=above:RM500Q-GL] (quectel)
+  \node[above right=-0.5cm and 5.0cm of n310o.east, label=above:RM500Q-GL] (quectel)
     {\includegraphics[height=1.2cm]{quectel}};
   \node[above left=-0.1cm and 0.8cm of quectel.west] (aq2)
     {\includegraphics[width=0.3cm]{antenna}} edge (quectel);
@@ -59,10 +59,5 @@
     {\includegraphics[width=1.2cm]{server}}
     edge (quectel);
 
-  \node[above right=-0.3cm and 5.0cm of x310o.east, label=above:amariue] (amariue)
-    {\includegraphics[height=1.2cm]{server}};
-  \node[left=0.8cm of amariue.west] (aa1)
-    {\includegraphics[width=0.3cm]{antenna}} edge (amariue);
-
 \end{tikzpicture}
 \end{document}