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

doc: make clone instructions/issues/mailing lists/tags point to Github

Browse Source 
- make internal links relative where applicable
- delete link to the wiki, as the documentation is in the main repo, not
  the wiki
- remove some "example in oai code" as the examples either don't exist,
  or are not in that place, and we can reasonably expect people to grep

Signed-off-by: Robert Schmidt <robert.schmidt@openairinterface.org>
This commit is contained in:
Robert Schmidt
2026-06-04 10:14:15 +02:00
parent 00e7cd49fa
commit 438de535fa
46 changed files with 74 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CHANGELOG.md
View File

@@ -2,7 +2,7 @@
# RELEASE NOTES: # # RELEASE NOTES: #
## [v2.4.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.4.0) -> December 2025. ## ## [v2.4.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v2.4.0) -> December 2025. ##
General new features and improvements (both RAN and UE): General new features and improvements (both RAN and UE):
- Rework LDPC BBdev/AAL interface and support both AMD T2/Intel vRAN Boost - Rework LDPC BBdev/AAL interface and support both AMD T2/Intel vRAN Boost
@@ -68,7 +68,7 @@ Configuration file changes:
should be removed should be removed
- `MACRLCs.[0].stats_max_ue` has been added - `MACRLCs.[0].stats_max_ue` has been added
## [v2.3.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.3.0) -> July 2025. ## ## [v2.3.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v2.3.0) -> July 2025. ##
General new features and improvements (both RAN and UE): General new features and improvements (both RAN and UE):
- Preliminary support for RedCap UEs - Preliminary support for RedCap UEs
@@ -114,7 +114,7 @@ nrUE changes:
Regression: Regression:
- Multiple BWPs do not work reliably on gNB; use tag 2025.w17 - Multiple BWPs do not work reliably on gNB; use tag 2025.w17
## [v2.2.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.2.0) -> November 2024. ## ## [v2.2.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v2.2.0) -> November 2024. ##
General 5G improvements (both gNB and UE): General 5G improvements (both gNB and UE):
- Make standalone mode (SA) the default (see [`RUNMODEM.md`](doc/RUNMODEM.md)) - Make standalone mode (SA) the default (see [`RUNMODEM.md`](doc/RUNMODEM.md))
@@ -170,7 +170,7 @@ General 5G improvements (both gNB and UE):
This release also includes many fixes and documentation updates. See This release also includes many fixes and documentation updates. See
`doc/README.md` in the repository for an overview of documentation. `doc/README.md` in the repository for an overview of documentation.
## [v2.1.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.1.0) -> February 2024. ## ## [v2.1.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v2.1.0) -> February 2024. ##
This release improves existing 5G support and adds various new features. This release improves existing 5G support and adds various new features.
@@ -197,7 +197,7 @@ interoperability is under testing.
This release also includes many fixes and documentation updates. This release also includes many fixes and documentation updates.
## [v2.0.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.0.0) -> August 2023. ## ## [v2.0.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v2.0.0) -> August 2023. ##
This release adds support for 5G and maintains previous features: This release adds support for 5G and maintains previous features:
* 5G SA in gNB * 5G SA in gNB
@@ -226,11 +226,11 @@ This release adds support for 5G and maintains previous features:
For more information on supported features, please refer to the [feature set](doc/FEATURE_SET.md). For more information on supported features, please refer to the [feature set](doc/FEATURE_SET.md).
## [v1.2.1](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.2.1) -> February 2020. ## ## [v1.2.1](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.2.1) -> February 2020. ##
* Bug fix for mutex lock for wake-up signal * Bug fix for mutex lock for wake-up signal
## [v1.2.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.2.0) -> January 2020. ## ## [v1.2.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.2.0) -> January 2020. ##
This version adds the following implemented features: This version adds the following implemented features:
@@ -246,11 +246,11 @@ This version also has an improved code quality:
* Better Test Coverage in Continuous Integration: * Better Test Coverage in Continuous Integration:
- Initial framework to do long-run testing at R2LAB - Initial framework to do long-run testing at R2LAB
## [v1.1.1](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.1.1) -> November 2019. ## ## [v1.1.1](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.1.1) -> November 2019. ##
- Bug fix in the TDD Fair Round-Robin scheduler - Bug fix in the TDD Fair Round-Robin scheduler
## [v1.1.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.1.0) -> July 2019. ## ## [v1.1.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.1.0) -> July 2019. ##
This version adds the following implemented features: This version adds the following implemented features:
@@ -282,19 +282,19 @@ This version has an improved code quality:
- Multi-RRU TDD mode - Multi-RRU TDD mode
- X2 Handover in FDD mode - X2 Handover in FDD mode
## [v1.0.3](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.0.3) -> June 2019. ## ## [v1.0.3](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.0.3) -> June 2019. ##
- Bug fix for LimeSuite v19.04.0 API - Bug fix for LimeSuite v19.04.0 API
## [v1.0.2](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.0.2) -> February 2019. ## ## [v1.0.2](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.0.2) -> February 2019. ##
- Full OAI support for 3.13.1 UHD - Full OAI support for 3.13.1 UHD
## [v1.0.1](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.0.1) -> February 2019. ## ## [v1.0.1](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.0.1) -> February 2019. ##
- Bug fix for the UE L1 simulator. - Bug fix for the UE L1 simulator.
## [v1.0.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.0.0) -> January 2019. ## ## [v1.0.0](https://github.com/duranta-project/openairinterface5g/releases/tag/v1.0.0) -> January 2019. ##
This version first implements the architectural split described in the following picture. This version first implements the architectural split described in the following picture.

2
charts/physims-4g/Chart.yaml
View File

@@ -31,7 +31,7 @@ keywords:
- 5G - 5G
sources: sources:
- https://gitlab.eurecom.fr/oai/openairinterface5g - https://github.com/duranta-project/openairinterface5g
maintainers: maintainers:
- name: OPENAIRINTERFACE - name: OPENAIRINTERFACE

2
charts/physims-4g/charts/physims.4g/Chart.yaml
View File

@@ -30,7 +30,7 @@ keywords:
- 4G - 4G
sources: sources:
- https://gitlab.eurecom.fr/oai/openairinterface5g - https://github.com/duranta-project/openairinterface5g
maintainers: maintainers:
- name: OPENAIRINTERFACE - name: OPENAIRINTERFACE

2
charts/physims-5g/Chart.yaml
View File

@@ -31,7 +31,7 @@ keywords:
- 5G - 5G
sources: sources:
- https://gitlab.eurecom.fr/oai/openairinterface5g - https://github.com/duranta-project/openairinterface5g
maintainers: maintainers:
- name: OPENAIRINTERFACE - name: OPENAIRINTERFACE

2
charts/physims-5g/charts/physims.5g/Chart.yaml
View File

@@ -30,7 +30,7 @@ keywords:
- 5G - 5G
sources: sources:
- https://gitlab.eurecom.fr/oai/openairinterface5g - https://github.com/duranta-project/openairinterface5g
maintainers: maintainers:
- name: OPENAIRINTERFACE - name: OPENAIRINTERFACE

2
ci-scripts/tests/deployment.py
View File

@@ -136,7 +136,7 @@ class TestDeploymentMethods(unittest.TestCase):
def test_create_workspace(self): def test_create_workspace(self):
self.cont.workspace = tempfile.mkdtemp() self.cont.workspace = tempfile.mkdtemp()
self.cont.repository = "https://gitlab.eurecom.fr/oai/openairinterface5g.git" self.cont.repository = "https://github.com/duranta-project/openairinterface5g.git"
self.cont.branch = "develop" self.cont.branch = "develop"
ws = self.cont.Create_Workspace(self.node, self.html) ws = self.cont.Create_Workspace(self.node, self.html)
with cls_cmd.LocalCmd() as cmd: with cls_cmd.LocalCmd() as cmd:

4
ci-scripts/tests/test-runner/run.sh
View File

@@ -8,13 +8,13 @@ rm -f ${file}
cd ../../ cd ../../
python3 main.py \ python3 main.py \
--mode=InitiateHtml \ --mode=InitiateHtml \
--repository=https://gitlab.eurecom.fr/oai/openairinterface5g.git \ --repository=https://github.com/duranta-project/openairinterface5g.git \
--branch=${branch} \ --branch=${branch} \
--XMLTestFile=tests/test-runner/test.xml --XMLTestFile=tests/test-runner/test.xml
python3 main.py \ python3 main.py \
--mode=TesteNB \ --mode=TesteNB \
--repository=https://gitlab.eurecom.fr/oai/openairinterface5g.git \ --repository=https://github.com/duranta-project/openairinterface5g.git \
--branch=${branch} \ --branch=${branch} \
--ranAllowMerge=true \ --ranAllowMerge=true \
--targetBranch=develop \ --targetBranch=develop \

1
cmake_targets/tools/build_helper
View File

@@ -465,7 +465,6 @@ install_asn1c_from_source(){
echo_info "\nInstalling ASN1." echo_info "\nInstalling ASN1."
$SUDO $INSTALLER -y install bison flex $SUDO $INSTALLER -y install bison flex
$SUDO rm -rf /tmp/asn1c $SUDO rm -rf /tmp/asn1c
# GIT_SSL_NO_VERIFY=true git clone https://gitlab.eurecom.fr/oai/asn1c.git /tmp/asn1c
git clone https://github.com/mouse07410/asn1c /tmp/asn1c git clone https://github.com/mouse07410/asn1c /tmp/asn1c
cd /tmp/asn1c cd /tmp/asn1c
#git checkout vlm_master #git checkout vlm_master

2
common/config/DOC/config.md
View File

@@ -9,5 +9,3 @@ The configuration module provides an api that other oai components can use to ge
* [runtime usage](config/rtusage.md) * [runtime usage](config/rtusage.md)
* [developer usage](config/devusage.md) * [developer usage](config/devusage.md)
* [module architecture](config/arch.md) * [module architecture](config/arch.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

6
common/config/DOC/config/devusage.md
View File

@@ -14,9 +14,9 @@ As a developer you may need to look at these sections:
Whatever your need is, configuration module usage examples can be found in oai sources: Whatever your need is, configuration module usage examples can be found in oai sources:
* complex example, using all the configuration module functionalities, including parameter checking: * complex example, using all the configuration module functionalities, including parameter checking:
[NB-IoT configuration code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/ENB_APP/NB_IoT_config.c) and [NB-IoT configuration include file](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/ENB_APP/NB_IoT_paramdef.h) [NB-IoT configuration code](../../../../openair2/ENB_APP/NB_IoT_config.c) and [NB-IoT configuration include file](../../../../openair2/ENB_APP/NB_IoT_paramdef.h)
* very simple example, just reading a parameter set corresponding to a dedicated section: the telnetsrv_autoinit function in [common/utils/telnetsrv/telnetsrv.c, around line 726](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv.c#L726) * very simple example, just reading a parameter set corresponding to a dedicated section: the telnetsrv_autoinit function in [common/utils/telnetsrv/telnetsrv.c, around line 726](../../../../common/utils/telnetsrv/telnetsrv.c)
* an example with run-time definition of parameters, in the logging sub-system: the log_getconfig function at the top of [openair2/UTIL/LOG/log.c](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/UTIL/LOG/log.c) * an example with run-time definition of parameters, in the logging sub-system: the log_getconfig function at the top of [openair2/UTIL/LOG/log.c](../../../../common/utils/LOG/log.c)
[Configuration module home](../config.md) [Configuration module home](../config.md)

2
common/config/DOC/config/devusage/addaparam.md
View File

@@ -82,7 +82,7 @@ for(int i=0 ; i < sizeof(someoptions)/sizeof(paramdesc_t) ; i ++) {
} }
.... ....
``` ```
When you need a specific verification algorithm, you can provide your own verification function and use it in place of the available ones, in the `checkedparam_t` union. If no existing structure definition match your need, you can enhance the configuration module. You then have to add a new verification function in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_userapi.c and add a new structure definition in the `checkedparam_t` type defined in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h When you need a specific verification algorithm, you can provide your own verification function and use it in place of the available ones, in the `checkedparam_t` union. If no existing structure definition match your need, you can enhance the configuration module. You then have to add a new verification function in ../../../../../common/config/config_userapi.c and add a new structure definition in the `checkedparam_t` type defined in ../../../../../common/config/config_paramdesc.h
[Configuration module developer main page](../../config/devusage.md) [Configuration module developer main page](../../config/devusage.md)
[Configuration module home](../../config.md) [Configuration module home](../../config.md)

2
common/config/DOC/config/devusage/api.md
View File

@@ -45,7 +45,7 @@ int config_libconfig_getlist(paramlist_def_t *ParamList, paramdef_t *params, int
## utility functions and macros ## utility functions and macros
The configuration module also defines APIs to access the `paramdef_t` and `configmodule_interface_t` fields. They are listed in the configuration module [include file `common/config/config_userapi.h`](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_userapi.h) The configuration module also defines APIs to access the `paramdef_t` and `configmodule_interface_t` fields. They are listed in the configuration module [include file `common/config/config_userapi.h`](../../../../common/config/config_userapi.h)
[Configuration module developer main page](../../config/devusage.md) [Configuration module developer main page](../../config/devusage.md)
[Configuration module home](../../config.md) [Configuration module home](../../config.md)

6
common/config/DOC/config/devusage/struct.md
View File

@@ -1,7 +1,7 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 --> <!-- SPDX-License-Identifier: CC-BY-4.0 -->
# `paramdef_t`structure # `paramdef_t`structure
It is defined in include file [ common/config/config_paramdesc.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h#L103). This structure is used by developers to describe parameters and by the configuration module to return parameters value. A pointer to a `paramdef_t` array is passed to `config_get` and `config_getlist` calls to instruct the configuration module what parameters it should read. It is defined in include file [ common/config/config_paramdesc.h ](../../../../../common/config/config_paramdesc.h#L103). This structure is used by developers to describe parameters and by the configuration module to return parameters value. A pointer to a `paramdef_t` array is passed to `config_get` and `config_getlist` calls to instruct the configuration module what parameters it should read.
| Fields | Description | I/O | | Fields | Description | I/O |
|:-----------|:------------------------------------------------------------------|----:| |:-----------|:------------------------------------------------------------------|----:|
@@ -32,7 +32,7 @@ It is defined in include file [ common/config/config_paramdesc.h ](https://gitla
# `paramlist_def_t`structure # `paramlist_def_t`structure
It is defined in include file [ common/config/config_paramdesc.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h#L160). It is defined in include file [ common/config/config_paramdesc.h ](../../../../../common/config/config_paramdesc.h#L160).
It is used as an argument to `config_getlist` calls, to get values of multiple occurrences of group of parameters. It is used as an argument to `config_getlist` calls, to get values of multiple occurrences of group of parameters.
| Fields | Description | I/O | | Fields | Description | I/O |
@@ -42,7 +42,7 @@ It is used as an argument to `config_getlist` calls, to get values of multiple o
| `numelt` | Number of items in the `paramarray` field | O | | `numelt` | Number of items in the `paramarray` field | O |
# `checkedparam_t` union # `checkedparam_t` union
It is defined in include file [ common/config/config_paramdesc.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h#L62). It is defined in include file [ common/config/config_paramdesc.h ](../../../../../common/config/config_paramdesc.h#L62).
This union of structures is used to provide a parameter checking mechanism. Each `paramdef_t` instance may include a pointer to a `checkedparam_t`structure which is then used by the configuration module to check the value it got from the config source. This union of structures is used to provide a parameter checking mechanism. Each `paramdef_t` instance may include a pointer to a `checkedparam_t`structure which is then used by the configuration module to check the value it got from the config source.
Each structure in the union provides one parameter verification method, which returns `-1` when the verification fails. Currently the following structures are defined in the `checkedparam_t` union: Each structure in the union provides one parameter verification method, which returns `-1` when the verification fails. Currently the following structures are defined in the `checkedparam_t` union:

2
common/utils/DOC/loader.md
View File

@@ -15,5 +15,3 @@ The main drawback is a performance cost at init time, when loading libraries.
* [runtime usage](loader/rtusage.md) * [runtime usage](loader/rtusage.md)
* [developer usage](loader/devusage.md) * [developer usage](loader/devusage.md)
* [module architecture](loader/arch.md) * [module architecture](loader/arch.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

6
common/utils/DOC/loader/arch.md
View File

@@ -2,8 +2,8 @@
# loader source files # loader source files
The oai shared library loader is implemented in two source files, located in [common/utils](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils) The oai shared library loader is implemented in two source files, located in `common/utils/`:
1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation 1. [load_module_shlib.c](../../load_module_shlib.c) contains the loader implementation
1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. 1. [load_module_shlib.h](../../load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes.
[loader home page](../loader.md) [loader home page](../loader.md)

2
common/utils/DOC/loader/devusage/api.md
View File

@@ -1,6 +1,6 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 --> <!-- SPDX-License-Identifier: CC-BY-4.0 -->
Loader API is defined in the [common/utils/load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/load_module_shlib.h) include file. Loader API is defined in the [common/utils/load_module_shlib.h](../../load_module_shlib.h) include file.
```c ```c
int load_module_shlib(char *modname,loader_shlibfunc_t *farray, int numf) int load_module_shlib(char *modname,loader_shlibfunc_t *farray, int numf)
``` ```

2
common/utils/DOC/loader/devusage/struct.md
View File

@@ -1,7 +1,7 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 --> <!-- SPDX-License-Identifier: CC-BY-4.0 -->
# `loader_shlibfunc_t`structure # `loader_shlibfunc_t`structure
It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/load_module_shlib.h#L38). This structure is used to list the symbols that should be searched by the loader when calling the `load_module_shlib` function. It is defined in include file [ common/util/load_module_shlib.h ](../../load_module_shlib.h#L38). This structure is used to list the symbols that should be searched by the loader when calling the `load_module_shlib` function.
| Fields | Description | I/O | | Fields | Description | I/O |
|:-----------|:------------------------------------------------------------------|----:| |:-----------|:------------------------------------------------------------------|----:|

15
common/utils/LOG/DOC/addconsoletrace.md
View File

@@ -22,7 +22,7 @@ these macros are used in place of the printf C function. The additionnal ***comp
| LOG_D | D | 4 | debug | | LOG_D | D | 4 | debug |
| LOG_T | T | 5 | trace | | LOG_T | T | 5 | trace |
component list is defined as an `enum` in [log.h](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/LOG/log.h). A new component can be defined by adding an item in this type, it must also be defined in the T tracer [T_messages.txt ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/T/T_messages.txt). component list is defined as an `enum` in [log.h](../log.h). A new component can be defined by adding an item in this type, it must also be defined in the T tracer [T_messages.txt ](../../T/T_messages.txt).
Most oai sources are including LOG macros. Most oai sources are including LOG macros.
@@ -42,7 +42,6 @@ if ( LOG_DEBUGFLAG(<flag>) {
...................... ......................
} }
``` ```
[example in oai code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/LTE_TRANSPORT/ulsch_demodulation.c#L396)
#### memory dump macros #### memory dump macros
```C ```C
@@ -60,7 +59,6 @@ LOG_M(.............
log_dump(... log_dump(...
} }
[example in oai code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/LTE_TRANSPORT/prach.c#L205)
#### matlab format dump #### matlab format dump
```C ```C
LOG_M(file, vector, data, len, dec, format) LOG_M(file, vector, data, len, dec, format)
@@ -74,8 +72,7 @@ LOG_M(file, vector, data, len, dec, format)
| dec| int | length of each data item.Interpretation depends on format| | dec| int | length of each data item.Interpretation depends on format|
|format| int | defines the type of data to be dumped| |format| int | defines the type of data to be dumped|
This macro can be used to dump a buffer in a format that can be used for analyze via tools like matlab or octave. **It must be surrounded by LOG_DEBUGFLAG or LOG_DUMPFLAG macros, to prevent the dump to be built unconditionally.** The LOG_M macro points to the `write_file_matlab` function implemented in [log.c](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/LOG/log.c). **This function should be revisited for more understandable implementation and ease of use (format parameter ???)** This macro can be used to dump a buffer in a format that can be used for analyze via tools like matlab or octave. **It must be surrounded by LOG_DEBUGFLAG or LOG_DUMPFLAG macros, to prevent the dump to be built unconditionally.** The LOG_M macro points to the `write_file_matlab` function implemented in [log.c](../log.c). **This function should be revisited for more understandable implementation and ease of use (format parameter ???)**
[example in oai code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/LTE_TRANSPORT/prach.c#L205)
#### hexadecimal format dump #### hexadecimal format dump
```C ```C
@@ -86,15 +83,14 @@ dumps a memory region if the corresponding debug flag `f` is set as explained he
|argument| type| description | |argument| type| description |
|:-----------|:-------|-----------------:| |:-----------|:-------|-----------------:|
| c | int, component id (in `comp_name_t` enum)| used to print the message, as specified by the s and x arguments | | c | int, component id (in `comp_name_t` enum)| used to print the message, as specified by the s and x arguments |
|f |int |flag used to filter the dump depending on the logs configuration. flag list is defined by the LOG_MASKMAP_INIT macro in [log.h](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/LOG/log.h) | |f |int |flag used to filter the dump depending on the logs configuration. flag list is defined by the LOG_MASKMAP_INIT macro in [log.h](../log.h) |
|b| void *| pointer to the memory to be dumpped | |b| void *| pointer to the memory to be dumpped |
|s | int | length of the data to be dumpped in char| |s | int | length of the data to be dumpped in char|
| x...| printf format and arguments| text string to be printed at the top of the dump| | x...| printf format and arguments| text string to be printed at the top of the dump|
This macro can be used to conditionaly dump a buffer, bytes by bytes, giving the integer value of each byte in hexadecimal form. This macro can be used to conditionaly dump a buffer, bytes by bytes, giving the integer value of each byte in hexadecimal form.
[example in oai code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/RRC/LTE/rrc_eNB.c#L1181)
This macro points to the `log_dump` function, implemented in [log.c](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/LOG/log.c). This function can also dump buffers containing `double` data via the LOG_UDUMPMSG macro This macro points to the `log_dump` function, implemented in [log.c](../log.c). This function can also dump buffers containing `double` data via the LOG_UDUMPMSG macro
```C ```C
LOG_UDUMPMSG(c, b, s, f, x...) LOG_UDUMPMSG(c, b, s, f, x...)
@@ -107,8 +103,5 @@ LOG_UDUMPMSG(c, b, s, f, x...)
|f| int | format of dumped data LOG_DUMP_CHAR or LOG_DUMP_DOUBLE| |f| int | format of dumped data LOG_DUMP_CHAR or LOG_DUMP_DOUBLE|
| x...| printf format and arguments| text string to be printed at the top of the dump| | x...| printf format and arguments| text string to be printed at the top of the dump|
[example in oai code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/SIMULATION/LTE_PHY/dlsim.c#L1974)
[logging facility developer main page](devusage.md) [logging facility developer main page](devusage.md)
[logging facility main page](log.md) [logging facility main page](log.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

1
common/utils/LOG/DOC/arch.md
View File

@@ -11,4 +11,3 @@ The logging facility doesn't create any thread, all api's are executed in the co
Data used by the logging utility are defined by the `log_t` structure which is allocated at init time, when calling the `logInit` function. Data used by the logging utility are defined by the `log_t` structure which is allocated at init time, when calling the `logInit` function.
[logging facility main page](log.md) [logging facility main page](log.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

3
common/utils/LOG/DOC/configurelog.md
View File

@@ -39,7 +39,7 @@ CLEAR_LOG_DUMP(flag)
``` ```
These macros are used to set or clear the corresponding bit flag, trigerring the activation or un-activation of conditional code or memory dumps generation. These macros are used to set or clear the corresponding bit flag, trigerring the activation or un-activation of conditional code or memory dumps generation.
Example of using the logging utility APIs can be found, for initialization and cleanup, in [lte-softmodem.c](../../../../targets/RT/USER/lte-softmodem.c) and in the [telnet server log command implementation](../../telnetsrv/telnetsrv_proccmd.c) for a complete access to the logging facility features. Example of using the logging utility APIs can be found, for initialization and cleanup, in [lte-softmodem.c](../../../../executables/lte-softmodem.c) and in the [telnet server log command implementation](../../telnetsrv/telnetsrv_proccmd.c) for a complete access to the logging facility features.
#### components and debug flags definitions #### components and debug flags definitions
@@ -48,4 +48,3 @@ To add a flag than can then be used for adding conditional code or memory dumps
[logging facility developer main page](devusage.md) [logging facility developer main page](devusage.md)
[logging facility main page](log.md) [logging facility main page](log.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
common/utils/LOG/DOC/log.md
View File

@@ -18,5 +18,3 @@ By default, this facility is included at build-time and activated at run-time. T
* [developer usage](devusage.md) * [developer usage](devusage.md)
* [module architecture](arch.md) * [module architecture](arch.md)
* [lttng usage](lttng_logs.md) * [lttng usage](lttng_logs.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

1
common/utils/LOG/DOC/rtusage.md
View File

@@ -276,4 +276,3 @@ The telnet server includes a `log` command which can be used to dymically modify
[telnet server ***softmodem log*** commands](../../telnetsrv/DOC/telnetlog.md) [telnet server ***softmodem log*** commands](../../telnetsrv/DOC/telnetlog.md)
[logging facility main page](log.md) [logging facility main page](log.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
common/utils/telnetsrv/DOC/telnetaddcmd.md
View File

@@ -2,7 +2,7 @@
# code example of adding a command to the telnet server # code example of adding a command to the telnet server
The following example is extracted from [the oai `openair1/PHY/CODING/coding_load.c` file](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c). The following example is extracted from [the oai `openair1/PHY/CODING/coding_load.c` file](../../../../openair1/PHY/CODING/coding_load.c).
```c ```c
/* /*

2
common/utils/telnetsrv/DOC/telnetarch.md
View File

@@ -21,7 +21,7 @@ The telnet server provides an API which can be used by any oai component to add
# telnet server source files # telnet server source files
telnet server source files are located in [common/utils/telnetsrv](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/telnetsrv) telnet server source files are located in `common/utils/telnetsrv/`
1. [telnetsrv.c](../telnetsrv.c) contains the telnet server implementation, including the implementation of the `telnet` CLI command. This implementation is compatible with all softmodem executables and is in charge of loading any additional `libtelnetsrv_<app> .so` containing code specific to the running executables. 1. [telnetsrv.c](../telnetsrv.c) contains the telnet server implementation, including the implementation of the `telnet` CLI command. This implementation is compatible with all softmodem executables and is in charge of loading any additional `libtelnetsrv_<app> .so` containing code specific to the running executables.
1. [telnetsrv.h](../telnetsrv.h) is the telnet server include file containing both private and public data type definitions. It also contains API prototypes for functions that are used to register a new command in the server. 1. [telnetsrv.h](../telnetsrv.h) is the telnet server include file containing both private and public data type definitions. It also contains API prototypes for functions that are used to register a new command in the server.

1
common/utils/telnetsrv/DOC/telnetlog.md
View File

@@ -92,4 +92,3 @@ Connection closed by foreign host.
[oai telnetserver home](telnetsrv.md) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage.md) [oai telnetserver usage home](telnetusage.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
common/utils/telnetsrv/DOC/telnetsrv.md
View File

@@ -6,5 +6,3 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It
* [Adding commands to the oai telnet server](telnetaddcmd.md) * [Adding commands to the oai telnet server](telnetaddcmd.md)
* [telnet server architecture ](telnetarch.md) * [telnet server architecture ](telnetarch.md)
* [on the telnet O1 module](telneto1.md) * [on the telnet O1 module](telneto1.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
common/utils/websrv/DOC/websrv.md
View File

@@ -5,5 +5,3 @@ The oai web server is an optional monitoring and debugging tool. Purpose is to g
* [Using the web server](websrvuse.md) * [Using the web server](websrvuse.md)
* [enhancing the webserver](websrvdev.md) * [enhancing the webserver](websrvdev.md)
* [web server architecture ](websrvarch.md) * [web server architecture ](websrvarch.md)
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

17
doc/Aerial_FAPI_Split_Tutorial.md
View File

@@ -20,7 +20,7 @@ The hardware on which we have tried this tutorial:
- These are not minimum hardware requirements. This is the configuration of our - These are not minimum hardware requirements. This is the configuration of our
servers. The NIC card should support hardware PTP time stamping. servers. The NIC card should support hardware PTP time stamping.
- Starting from tag - Starting from tag
[2025.w13](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/2025.w13?ref_type=tags) [2025.w13](https://github.com/duranta-project/openairinterface5g/releases/tag/2025.w13)
of OAI, we are only testing with the Grace Hopper server. of OAI, we are only testing with the Grace Hopper server.
PTP enabled switches and grandmaster clock we have tested with: PTP enabled switches and grandmaster clock we have tested with:
@@ -60,7 +60,7 @@ To set up the L1 and install the components manually refer to this [instructions
**Note**: **Note**:
- To configure the Gigabyte server please refer to these - To configure the Gigabyte server please refer to these
[instructions](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/2025.w13/doc/Aerial_FAPI_Split_Tutorial.md) [instructions](https://github.com/duranta-project/openairinterface5g/blob/2025.w13/doc/Aerial_FAPI_Split_Tutorial.md)
- The last release to support the Gigabyte server is **Aerial CUDA-Accelerated - The last release to support the Gigabyte server is **Aerial CUDA-Accelerated
RAN 24-1**. RAN 24-1**.
@@ -183,7 +183,7 @@ WantedBy=multi-user.target
If it's not already cloned, the first step is to clone OAI repository If it's not already cloned, the first step is to clone OAI repository
```bash ```bash
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g/ cd ~/openairinterface5g/
``` ```
@@ -224,8 +224,7 @@ With the nvIPC sources in the project directory, the L2 docker image can be buil
In order to build the target image (`oai-gnb-aerial`), first you should build a In order to build the target image (`oai-gnb-aerial`), first you should build a
common shared image (`ran-base`). For more information about `docker build` common shared image (`ran-base`). For more information about `docker build`
files please refer to this files please refer to this [tutorial](../docker/README.md)
[tutorial](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/ARC1.7_integration/docker/README.md?ref_type=heads)
```bash ```bash
~$ cd ~/openairinterface5g/ ~$ cd ~/openairinterface5g/
@@ -238,21 +237,19 @@ files please refer to this
### Adapt the OAI-gNB configuration file to your system/workspace ### Adapt the OAI-gNB configuration file to your system/workspace
Edit the [OAI gNB configuration file](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/ci-scripts/conf_files/gnb-vnf.sa.band78.273prb.aerial.conf?ref_type=heads) Edit the [OAI gNB configuration file](../ci-scripts/conf_files/gnb-vnf.sa.band78.273prb.aerial.conf)
and check the following parameters: and check the following parameters:
* `gNBs` section * `gNBs` section
* The PLMN section shall match the one defined in the AMF * The PLMN section shall match the one defined in the AMF
* To calculate the `absoluteFrequencySSB` and `dl_absoluteFrequencyPointA`, * To calculate the `absoluteFrequencySSB` and `dl_absoluteFrequencyPointA`,
please follow these please follow these [instructions](./gNB_frequency_setup.md)
[instructions](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/gNB_frequency_setup.md)
* `amf_ip_address` shall be the correct AMF IP address in your system * `amf_ip_address` shall be the correct AMF IP address in your system
* `GNB_IPV4_ADDRESS_FOR_NG_AMF` shall match your DU N2 interface IP address * `GNB_IPV4_ADDRESS_FOR_NG_AMF` shall match your DU N2 interface IP address
* `GNB_IPV4_ADDRESS_FOR_NGU` shall match your DU N3 interface IP address * `GNB_IPV4_ADDRESS_FOR_NGU` shall match your DU N3 interface IP address
The default amf_ip_address:ipv4 value is 192.168.70.132, when installing the The default amf_ip_address:ipv4 value is 192.168.70.132, when installing the
CN5G following [this CN5G following [this tutorial](./NR_SA_Tutorial_OAI_CN5G.md)
tutorial](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_OAI_CN5G.md)
Both `GNB_IPV4_ADDRESS_FOR_NG_AMF` and `GNB_IPV4_ADDRESS_FOR_NGU` need to be Both `GNB_IPV4_ADDRESS_FOR_NG_AMF` and `GNB_IPV4_ADDRESS_FOR_NGU` need to be
set to the IP address of the NIC referenced previously. set to the IP address of the NIC referenced previously.

3
doc/FEATURE_SET.md
View File

@@ -694,9 +694,6 @@ The NAS layer is based on **3GPP 24.301** and implements the following functions
- EMM attach/detach, authentication, tracking area update, and more - EMM attach/detach, authentication, tracking area update, and more
- ESM default/dedicated bearer, PDN connectivity, and more - ESM default/dedicated bearer, PDN connectivity, and more
[OAI wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
[OAI softmodem build procedure](BUILD.md) [OAI softmodem build procedure](BUILD.md)
[Running the OAI softmodem ](RUNMODEM.md) [Running the OAI softmodem ](RUNMODEM.md)

6
doc/GET_SOURCES.md
View File

@@ -15,7 +15,7 @@ sudo apt-get install git
## Clone the Git repository (for OAI Users without login to gitlab server) ## Clone the Git repository (for OAI Users without login to gitlab server)
The [openairinterface5g repository](https://gitlab.eurecom.fr/oai/openairinterface5g.git) The [openairinterface5g repository](https://github.com/duranta-project/openairinterface5g.git)
holds the source code for the RAN (4G and 5G). holds the source code for the RAN (4G and 5G).
### All users, anonymous access ### All users, anonymous access
@@ -23,7 +23,7 @@ holds the source code for the RAN (4G and 5G).
Clone the RAN repository: Clone the RAN repository:
```shell ```shell
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git git clone https://github.com/duranta-project/openairinterface5g.git
``` ```
### For contributors ### For contributors
@@ -46,7 +46,7 @@ More information can be found in [the contributing page](../CONTRIBUTING.md).
recommended and default branch.** recommended and default branch.**
- `master`: contains a known stable version. - `master`: contains a known stable version.
You can find the latest stable tag release [here](https://gitlab.eurecom.fr/oai/openairinterface5g/tags). You can find the latest stable tag release [here](https://github.com/duranta-project/openairinterface5g/releases).
The tag naming conventions are: The tag naming conventions are:

6
doc/L2NFAPI_NOS1.md
View File

@@ -35,14 +35,14 @@ Please try to use the same commit ID on both eNB/UE hosts.
```bash ```bash
$ ssh sudousername@machineB $ ssh sudousername@machineB
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git enb_folder git clone https://github.com/duranta-project/openairinterface5g.git enb_folder
cd enb_folder cd enb_folder
git checkout develop git checkout develop
``` ```
```bash ```bash
$ ssh sudousername@machineC $ ssh sudousername@machineC
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ue_folder git clone https://github.com/duranta-project/openairinterface5g.git ue_folder
cd ue_folder cd ue_folder
git checkout develop git checkout develop
``` ```
@@ -315,8 +315,6 @@ iperf -c 10.0.1.1 -u -t 30 -b 2M -i 1 -fm -B 10.0.1.2 -p 5002
---- ----
[oai wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
[oai softmodem features](FEATURE_SET.md) [oai softmodem features](FEATURE_SET.md)
[oai softmodem build procedure](BUILD.md) [oai softmodem build procedure](BUILD.md)

6
doc/L2NFAPI_S1.md
View File

@@ -40,14 +40,14 @@ Please try to use the same commit ID on both eNB/UE hosts.
```bash ```bash
$ ssh sudousername@machineB $ ssh sudousername@machineB
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git enb_folder git clone https://github.com/duranta-project/openairinterface5g.git enb_folder
cd enb_folder cd enb_folder
git checkout develop git checkout develop
``` ```
```bash ```bash
$ ssh sudousername@machineC $ ssh sudousername@machineC
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ue_folder git clone https://github.com/duranta-project/openairinterface5g.git ue_folder
cd ue_folder cd ue_folder
git checkout develop git checkout develop
``` ```
@@ -295,8 +295,6 @@ iperf operations can also be performed.
---- ----
[oai wiki home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
[oai softmodem features](FEATURE_SET.md) [oai softmodem features](FEATURE_SET.md)
[oai softmodem build procedure](BUILD.md) [oai softmodem build procedure](BUILD.md)

4
doc/LDPC_OFFLOAD_SETUP.md
View File

@@ -182,12 +182,12 @@ Baseband devices using DPDK-compatible driver
## Building OAI with ORAN-AAL ## Building OAI with ORAN-AAL
OTA deployment is precisely described in the following tutorial: OTA deployment is precisely described in the following tutorial:
- [NR_SA_Tutorial_COTS_UE](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_COTS_UE.md) - [NR_SA_Tutorial_COTS_UE](./NR_SA_Tutorial_COTS_UE.md)
Instead of section *3.2 Build OAI gNB* from the tutorial, run the following commands: Instead of section *3.2 Build OAI gNB* from the tutorial, run the following commands:
```bash ```bash
# Get openairinterface5g source code # Get openairinterface5g source code
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g cd ~/openairinterface5g
git checkout develop git checkout develop

2
doc/NR_SA_Tutorial_COTS_UE.md
View File

@@ -77,7 +77,7 @@ sudo uhd_images_downloader
```bash ```bash
# Get openairinterface5g source code # Get openairinterface5g source code
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g cd ~/openairinterface5g
git checkout develop git checkout develop

2
doc/NR_SA_Tutorial_OAI_nrUE.md
View File

@@ -63,7 +63,7 @@ sudo uhd_images_downloader
```bash ```bash
# Get openairinterface5g source code # Get openairinterface5g source code
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g cd ~/openairinterface5g
git checkout develop git checkout develop

10
doc/ORAN_FHI7.2_Tutorial.md
View File

@@ -400,7 +400,7 @@ sudo ninja deinstall -C build
Clone OAI code base in a suitable repository, here we are cloning in `~/openairinterface5g` directory, Clone OAI code base in a suitable repository, here we are cloning in `~/openairinterface5g` directory,
```bash ```bash
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g/ cd ~/openairinterface5g/
``` ```
@@ -2084,7 +2084,7 @@ Compiled libraries:
#### Using build_oai script #### Using build_oai script
```bash ```bash
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g/cmake_targets/ cd ~/openairinterface5g/cmake_targets/
./build_oai -I # if you never installed OAI, use this command once before the next line ./build_oai -I # if you never installed OAI, use this command once before the next line
./build_oai --install-optional-packages # for pcre/libpcre3, libssh, and libxml2 library installation ./build_oai --install-optional-packages # for pcre/libpcre3, libssh, and libxml2 library installation
@@ -2095,7 +2095,7 @@ PKG_CONFIG_PATH=/opt/mplane-v2/lib/pkgconfig ./build_oai --gNB --ninja -t oran_f
#### Using cmake directly #### Using cmake directly
```bash ```bash
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git ~/openairinterface5g git clone https://github.com/duranta-project/openairinterface5g.git ~/openairinterface5g
cd ~/openairinterface5g/ cd ~/openairinterface5g/
mkdir build && cd build mkdir build && cd build
cmake .. -GNinja -DOAI_FHI72=ON -DOAI_FHI72_MPLANE=ON -Dxran_LOCATION=$HOME/phy/fhi_lib/lib cmake .. -GNinja -DOAI_FHI72=ON -DOAI_FHI72_MPLANE=ON -Dxran_LOCATION=$HOME/phy/fhi_lib/lib
@@ -3705,7 +3705,7 @@ sudo ./nr-softmodem -O <without-mplane-configuration file> --thread-pool <list o
## Contact in case of questions ## Contact in case of questions
You can ask your question on the [mailing lists](https://gitlab.eurecom.fr/oai/openairinterface5g/-/wikis/MailingList). You can ask your question on the [mailing lists](https://github.com/duranta-project/openairinterface5g/wiki/MailingList).
Your email should contain below information: Your email should contain below information:
@@ -3718,4 +3718,4 @@ Your email should contain below information:
- RU Vendor and Version. - RU Vendor and Version.
- In case your question is related to performance, include a small description of the machine (CPU, RAM and networking card) and diagram of your testing environment. - In case your question is related to performance, include a small description of the machine (CPU, RAM and networking card) and diagram of your testing environment.
- If you have any issues related to PTP or synchronization, then first check the section "Debugging PTP issues". Then share your problem with PTP version you are using, switch details and master clock. - If you have any issues related to PTP or synchronization, then first check the section "Debugging PTP issues". Then share your problem with PTP version you are using, switch details and master clock.
- Known/open issues are present on [GitLab](https://gitlab.eurecom.fr/oai/openairinterface5g/-/issues), so keep checking. - Known/open issues are present on [Github](https://github.com/duranta-project/openairinterface5g/issues), so keep checking.

2
doc/RUNMODEM.md
View File

@@ -263,7 +263,7 @@ Finally the number of TX physical antenna in the RU part of the configuration fi
It is possible to limit the number supported DL MIMO layers via RRC configuration, e.g. to a value lower than the number of logical antenna ports configured, by using the configuration file parameter `maxMIMO_layers`. It is possible to limit the number supported DL MIMO layers via RRC configuration, e.g. to a value lower than the number of logical antenna ports configured, by using the configuration file parameter `maxMIMO_layers`.
[Example of configuration file with parameters for 2-layer MIMO](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band77.fr1.273PRB.2x2.usrpn300.conf) [Example of configuration file with parameters for 2-layer MIMO](../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band77.fr1.273PRB.2x2.usrpn300.conf)
## IF (Intermediate Frequency) equipment ## IF (Intermediate Frequency) equipment

4
doc/TESTING_OAI_NSA_COTS_UE.md
View File

@@ -42,7 +42,7 @@ Our code might not work with all 5G phones yet, but we are constantly improving
## Repository ## Repository
[OAI](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop) [OAI](https://github.com/duranta-project/openairinterface5g)
## Architecture Setup ## Architecture Setup
@@ -58,7 +58,7 @@ The photo depicts the FR1 setup part of the scheme above:
## Build and Install ## Build and Install
General guidelines to build eNB and gNB : General guidelines to build eNB and gNB :
See [Building UE, eNB and gNb executables](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/doc/BUILD.md#building-ues-enodeb-and-gnodeb-executables) See [Building UE, eNB and gNb executables](./BUILD.md)
- **eNB** - **eNB**

10
doc/handover-tutorial.md
View File

@@ -8,9 +8,9 @@ This tutorial explains how to perform handovers. It covers both F1 handovers
This document assumes familiarity with the F1 split architecture and basic This document assumes familiarity with the F1 split architecture and basic
OAI knowledge. Please refer to the prerequisite documentation listed below: OAI knowledge. Please refer to the prerequisite documentation listed below:
- To run the [Core Network](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_OAI_CN5G.md) - To run the [Core Network](./NR_SA_Tutorial_OAI_CN5G.md)
- To run [OAI full stack with COTS UE](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_COTS_UE.md) - To run [OAI full stack with COTS UE](./NR_SA_Tutorial_COTS_UE.md)
- [F1 split design document](https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/F1AP/F1-design.md?ref_type=heads) - [F1 split design document](./F1AP/F1-design.md)
for details on the F1 architecture and the networking relationships between for details on the F1 architecture and the networking relationships between
the CU and the associated DUs. the CU and the associated DUs.
@@ -198,9 +198,9 @@ triggered:
- By connecting them to a GPS or an Octoclock to provide a common time and clock - By connecting them to a GPS or an Octoclock to provide a common time and clock
reference. reference.
- By synchronizing the RU hosts. - By synchronizing the RU hosts.
- By using Openairinterface starting tag [2025.w42](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/2025.w42?ref_type=tags) - By using Openairinterface starting tag [2025.w42](https://github.com/duranta-project/openairinterface5g/releases/tag/2025.w42)
(A fix was added to force the USRP to "use" the time/clock provided by the (A fix was added to force the USRP to "use" the time/clock provided by the
external source instead to its own master clock. for more info see [MR](https://gitlab.eurecom.fr/oai/openairinterface5g/-/merge_requests/3693)). external source instead to its own master clock.).
- Make sure that the UE sees both cells. For instance, you can switch to flight - Make sure that the UE sees both cells. For instance, you can switch to flight
mode, go closer to the other DU, and switch off flight mode -- the UE should mode, go closer to the other DU, and switch off flight mode -- the UE should
connect to that second DU. connect to that second DU.

2
doc/iqrecordplayer_usage.md
View File

@@ -70,5 +70,3 @@ options for replay mode are:
.................................. ..................................
.................................. ..................................
``` ```
[OAI Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
docker/README.md
View File

@@ -116,7 +116,7 @@ possibilities:
There are two shared images: one that has all dependencies, and a second that compiles all targets (eNB, gNB, [nr]UE). There are two shared images: one that has all dependencies, and a second that compiles all targets (eNB, gNB, [nr]UE).
```bash ```bash
git clone https://gitlab.eurecom.fr/oai/openairinterface5g.git git clone https://github.com/duranta-project/openairinterface5g.git
cd openairinterface5g cd openairinterface5g
# default branch is develop, to change use git checkout <BRANCH> # default branch is develop, to change use git checkout <BRANCH>
docker build --target ran-base --tag ran-base:latest --file docker/Dockerfile.base.ubuntu . docker build --target ran-base --tag ran-base:latest --file docker/Dockerfile.base.ubuntu .

2
nfapi/open-nFAPI/README.md
View File

@@ -135,4 +135,4 @@ Coverity runs on the coverity-scan branch. Changes must be merged to the coverit
## eNB Integration - Open Air Interface ## eNB Integration - Open Air Interface
The open-nFAPI implementation has been integrated with the Open Air Interface solution here (https://gitlab.eurecom.fr/oai/openairinterface5g) and is (at the time of writing) here (https://gitlab.eurecom.fr/daveprice/openairinterface5g/tree/nfapi-ru-rau-split). The open-nFAPI implementation is integrated with the source eNB implementation with any changes required applied as a patch on top of the baseline open-nFAPI library. Any extensions required must be implemented through the vendor extensions as specified by the Small Cell Forum documentation. Any integration wrapping of functionality must be done within the target environment as shown in the Open Air Interface implementation nfapi directory which is defined by the $NFAPI_DIR location at the top level. The open-nFAPI implementation has been integrated with OpenAirInterface. The open-nFAPI implementation is integrated with the source eNB implementation with any changes required applied as a patch on top of the baseline open-nFAPI library. Any extensions required must be implemented through the vendor extensions as specified by the Small Cell Forum documentation. Any integration wrapping of functionality must be done within the target environment as shown in the Open Air Interface implementation nfapi directory which is defined by the $NFAPI_DIR location at the top level.

2
openair1/PHY/CODING/DOC/LDPCImplementation.md
View File

@@ -99,5 +99,3 @@ Libraries implementing the LDPC algorithms must be named `libldpc<_version>.so`,
* `LDPCshutdown` implementing type `LDPC_shutdownfunc_t *` * `LDPCshutdown` implementing type `LDPC_shutdownfunc_t *`
* `LDPCdecoder` implementing type `LDPC_decoderfunc_t *` * `LDPCdecoder` implementing type `LDPC_decoderfunc_t *`
* `LDPCencoder` implementing type `LDPC_encoderfunc_t *` * `LDPCencoder` implementing type `LDPC_encoderfunc_t *`
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
openair1/PHY/TOOLS/readme.md
View File

@@ -69,7 +69,7 @@ Run with `--imscope` flag
## Reporting bugs and feature requests ## Reporting bugs and feature requests
Report bugs and feature requests on [gitlab](https://gitlab.eurecom.fr/oai/openairinterface5g/-/issues). There is two demo windows Report bugs and feature requests on [github](https://github.com/duranta-project/openairinterface5g/issues). There is two demo windows
enabled in the scope that showcase imgui/implot, if you find something of interest it can be implemented in the scope. enabled in the scope that showcase imgui/implot, if you find something of interest it can be implemented in the scope.
## Recording scope data and reviewing recorded IQ files ## Recording scope data and reviewing recorded IQ files

2
openair1/SIMULATION/TOOLS/DOC/channel_simulation.md
View File

@@ -248,5 +248,3 @@ channelmod modify 0 noise_power_dB 3
### rfsimu module ### rfsimu module
This module can be used to set a different channel model, e.g. `rfsimu setmodel AWGN`. This module can be used to set a different channel model, e.g. `rfsimu setmodel AWGN`.
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)

2
radio/iqplayer/DOC/iqrecordplayer_usage.md
View File

@@ -162,5 +162,3 @@ The replay feature is implemented as a oai device.
### iq's file format ### iq's file format
The recorder adds a header containing the device type, the bandwith and a format identifier. Using these information when replaying a file has not yet been implemented, so the player only supports USRP B2xx device and 40MHz bandwith 3/4 sampling. The recorder adds a header containing the device type, the bandwith and a format identifier. Using these information when replaying a file has not yet been implemented, so the player only supports USRP B2xx device and 40MHz bandwith 3/4 sampling.
[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)