Commit Graph

55 Commits

Author SHA1 Message Date
Robert Schmidt
076c722eb9 build_oai UHD source installation: default to UHD v4.8
Use the current OAI CI default UHD version. Update the documentation to
show how to install a recent version.

Signed-off-by: Robert Schmidt <robert.schmidt@openairinterface.org>
2026-05-21 15:21:21 +02:00
Robert Schmidt
19e3cbd66a Extend UHD patch to v4.9/v4.10, remove sed
The existing patch (generated through sed) works also in UHD versions
beyond 4.8, so allow to use that.

Further, since sed is confusing, store the patch directly. Update the
dockerfiles so that docker copies the right file for UHD 4.8.

Signed-off-by: Robert Schmidt <robert.schmidt@openairinterface.org>
2026-05-21 15:21:20 +02:00
Robert Schmidt
dd3490714c Reorganize BUILD.md: cmake first, describe how to build all targets 2026-03-30 21:20:43 +02:00
Robert Schmidt
8107939f08 Change OAI license to CSSL v1.0 (and others)
- all RAN code, CI code, configuration files, dockerfiles, in CSSL v1.0
- all deployment code (openshift, charts, ancillary files like shell
  scripts), in MIT
- documentation in CC-BY-4.0
- exceptions might apply and are listed in NOTICE
- there is a new LICENSES folder with all licenses
- CONTRIBUTIONS.md has been updated accordingly

For automated changes based on OAI PL v1.1:

    perl -i~ -0pe 's/\/\*.*Licensed to the OpenAirInterface.*openairinterface.org\n#?/\/*\n * SPDX-License-Identifier: LicenseRef-CSSL-1.0\n/s' **/*.{c,h,cpp}
    perl -i~ -0pe 's/\/\*.*Licensed to the OpenAirInterface.*openairinterface.org\n#?/\/*\n * SPDX-License-Identifier: LicenseRef-CSSL-1.0\n/s' **/*.ts
    perl -i~ -0pe 's/<!--.*Licensed to the OpenAirInterface.*openairinterface.org\n.*-->/<!-- SPDX-License-Identifier: LicenseRef-CSSL-1.0 -->/s' **/*.xml

The rest (cmake, files with missing license, cmake) manually.
2026-03-27 16:36:37 +01:00
Romain Beurdouche
3a92eed5b9 fix(build & doc): Remove remaining mentions of ldpc_cuda
* Option to build ldpc_cuda was remaining in the build script
* Build script option to build ldpc_cuda was still used in CI
* Mentions of ldpc_cuda were remaining in the documentation

Note: In the documentation, the example of ldpctest usage that was
loading ldpc_cuda was replaced by an example in which it is loading
ldpc_orig even though this is pointless as it makes ldpctest compare
ldpc_orig with ldpc_orig. On the other hand, it is the only library
other than the default ldpc that uses the former interface.
2026-03-23 13:56:46 +01:00
Shubhika Garg
17c6d0feb2 docs: replace HTML header with Markdown heading
- Removed HTML table and font tags for the OAI titles and replaced them with a clean Markdown H1 heading
      - Added missing # H1 headings in some files
2026-01-22 10:55:05 +01:00
Robert Schmidt
5c480ffd50 docs: Standardize documentation headings (remove multiple # H1)
- Remove multiple single top-level (# H1) headings per file
 - Use (# H2 and ###### H6) sub-headings for consistency
 - Remove any trailing # in the headings
 - This ensures proper table of contents rendering in MkDocs.

 - Also removed RUN_NR_multiple_BWPs.md as it is moved to MAC usage
2026-01-22 10:55:05 +01:00
Shubhika Garg
c0d0bab0d8 docs: standardize Markdown links to [Text](URL) format
- Fixed inconsistent or raw URL links across multiple documentation files
  - Ensure proper link formatting for Markdown rendering
2026-01-22 10:50:50 +01:00
Rakesh Mundlamuri
5d545a6cc5 Add srssim to the feature set 2026-01-09 20:49:46 +05:30
Robert Schmidt
c0d797ec0e Rename libldpc_t2 to libldpc_aal
Rename the library to reflect that it's more a generic AAL driver than
specifically for AAL. To this end, rename some documentation.

As of this commit, the options are still called nrLDPC_coding_t2. The
next commit will correct this.

Co-authored-by: Xin Zhe Khooi <khooixz@comp.nus.edu.sg>
2025-08-05 18:38:16 +02:00
Bartosz Podrygajlo
b69b4dc0f4 Add CMakePresets.json
Introduce CMakePresests.json which is a simple way to perform incremental build using cmake

New configure resets were added:
 - default: Configure compilation with default options
 - tests: Same as above but ENABLE_TESTS and SANITIZE_ADDRESS is ON

New build presets were added:
 - 5gdefault: Build the software for NR rfsimulator test
 - default: same as 5gdefault
 - 4gdefault: Build the software for LTE rfsimulator test
 - tests: build all unit tests

To configure using configuration preset:

`cmake --preset <preset_name>`

To build using a build preset:

`cmake --build --preset <preset_name>`
2024-10-11 09:12:49 +02:00
Bartosz Podrygajlo
bdc6df8c42 NR UE & gNB imscope.
A new phy scope based on ImGui and ImPlot. This scope uses a different concurrency model than previous
scopes.

The PHY thread writing the data first checks if the data is ready to be written. If its not, nothing is copied.
The GUI thread reads data if available and marks it ready to write. This makes sure that the PHY threads are not
busy copying data that would never be displayed.

Some of the scopes also have a freeze functionality that further limit the amount of data that needs to be copied
from PHY threads. If a scope is "frozen" it still allows the user to explore the data using plots zoom/pan functions
but doesn't cause PHY threads to perform extra writes on the displayed data.

A compile option was added to enable/disable the scope. Use cmake -DENABLE_IMSCOPE=ON to enable the scope.

Update CXX standard to 17; it is required by some libraries (e.g., dear imgui). The oldest gcc version in
use by a distribution supported is Ubuntu 20, which has gcc 9.4 with c++17 support.
2024-09-05 15:19:00 +02:00
Robert Schmidt
6b21dea1ee Remove legacy 4G kernel modules
I don't know about any user of the kernel modules. It is effectively
legacy code we carry around, for no good reason. Remove it for the
moment. If we ever need it, we can revert.
2024-08-01 18:22:46 +02:00
Thomas Schlichter
394431a594 remove nrqtscope 2024-07-13 11:22:36 +02:00
Robert Schmidt
760aee6d29 Correct link in build instructions 2024-06-26 09:18:18 +02:00
Guido Casati
763726185a Added documentation about sanitizers
- new file:   /doc/dev_tools/sanitizers.md
2024-01-25 17:12:31 +01:00
luis_pereira87
32f7f475e4 T2: update documentation and refactor ldpc-offload-enable 2023-12-21 11:22:00 +01:00
Jaroslava Fiedlerova
4defabeb8d Remove T1 decoding offload - remove from docu, remove T1 lib build from pipeline 2023-11-28 09:37:37 +01:00
Alexandre Ferrieux
08cfd560f2 Fix references to "telnet", it should be "telnetsrv". Otherwise build_oai fails with a very cryptic error message. 2023-09-21 21:09:20 +00:00
Tsung-Yu Chan
1f2098fcce feat / work with cross-compile
can compile the target ldpc_generators and generate_T with cross-compiler
2023-09-13 17:20:08 +02:00
Robert Schmidt
002fba1d39 BUILD.md: add asn1c instructions, add TOC, reorder dependencies before building 2023-06-02 13:17:59 +02:00
Robert Schmidt
a29e59b602 Update GET_SOURCES.md and BUILD.md 2023-03-31 17:07:28 +02:00
francescomani
e79b926905 rename sdr to radio 2022-10-19 17:42:26 +02:00
Robert Schmidt
d859ef7292 Add trailing .Rel15 of executables 2022-09-29 10:06:20 +02:00
Robert Schmidt
6160ab14be Remove targets/bin/ 2022-09-29 10:03:28 +02:00
francescomani
539563f03e moving targets/ARCH to sdr/ 2022-09-26 11:17:44 +02:00
Robert Schmidt
05242ea626 Merge remote-tracking branch 'origin/ci-legacy-4g-lte-bench-back-on' into integration_2022_wk38 2022-09-22 18:58:03 +02:00
Raphael Defosseux
4f29e64749 chore(ci): clarification on why we can/should install UHD from source
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2022-09-21 14:37:05 +02:00
Robert Schmidt
cdb18d38bf Move CMakeLists.txt into root 2022-09-19 17:29:42 +02:00
Raphael Defosseux
11315ef602 fix(build): automatically applying UHD TDD patch for LTE
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2022-09-09 14:35:54 +02:00
Manish
b37e5e552b help menu updated in document for native architecture.
Compilation steps corrected on Ubuntu 20.

Signed-off-by: Manish <Manish1.Kumar@amd.com>
2022-05-10 02:53:42 +00:00
Manish
8f64e6414c Build document updated for compilation on Ubuntu 20 using buil-oai
Signed-off-by: Manish <Manish1.Kumar@amd.com>
2022-03-29 04:22:54 +00:00
Laurent THOMAS
13a16bc29f remove separate dir from phy_simulators binaries and compile options 2022-01-24 14:59:12 +01:00
Raphael Defosseux
4b0633cf47 fix(build): enable build from source on a given version of UHD. For the moment, in all docker images, v3.15.0.0 is used
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2021-11-03 14:12:34 +01:00
Florian Kaltenberger
8c7749547a Update BUILD.md 2021-09-08 13:48:40 +00:00
Remi Hardy
97249354c3 Update BUILD.md 2020-12-04 10:08:37 +01:00
hardy
ebd7f50992 Merge remote-tracking branch 'origin/rh_ci_fr1' into integration_2020_wk37 2020-09-10 15:30:27 +02:00
Raphael Defosseux
128887b9bc DOC: replace obsolete links w/ correct ones
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2020-09-09 16:18:14 +02:00
Julio Renner
e3e84ca282 update conf2uedata 2020-08-24 02:21:03 +02:00
hardy
6d65930fd0 initial push to make branch visible 2020-06-22 15:20:38 +02:00
Raphael Defosseux
9b920255b3 DOC: added kernel headers install guidelines for CentOS / RHEL
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2020-01-22 22:53:34 +01:00
frtabu
22e45b8adf update doc/BUILD.md and doc/RUNMODEM.md to reflect develop/develop-nr merge and latest merge requests affecting the build procedure 2020-01-21 18:01:50 +01:00
yilmazt
54899a9be1 merge of develop&develop-nr 2019-09-12 16:02:36 +02:00
frtabu
3d66fbdb7a Documentation update and small allignement of build_oai script -w option with documentation 2019-08-21 11:17:37 +02:00
yilmazt
15df30545e converting 'lte_build_oai' to 'ran_buld' 2019-07-23 15:24:03 +02:00
Raphael Defosseux
4bf932d6bd DOC: added caution message about nasmesh
Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
2019-06-21 12:57:40 +02:00
Francois TABURET
55700fc99e Update BUILD.md 2019-05-24 10:31:42 +02:00
Francois TABURET
3b9fabe1b3 Update BUILD.md 2019-05-24 10:26:55 +02:00
Francois TABURET
fc86788a8e Update BUILD.md, fixing broken link, typo and clarifying some points 2019-05-24 10:18:10 +02:00
frtabu
f47f3f65ba More build_oai cleanup, add a generic option "--build-lib" to build optional shared libraries (telnet server for example) 2019-05-15 18:20:16 +02:00