Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
openairinterface5G
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
oai
openairinterface5G
Merge requests
!2037
integration_2023_w13
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
integration_2023_w13
integration_2023_w13
into
develop
Overview
11
Commits
60
Pipelines
0
Changes
2
All threads resolved!
Hide all comments
Merged
Robert Schmidt
requested to merge
integration_2023_w13
into
develop
2 years ago
Overview
11
Commits
60
Pipelines
0
Changes
2
All threads resolved!
Hide all comments
Expand
!1945 (merged)
Free RNTI related structures at PHY after UE disconnection
!2011 (merged)
Creation of new pipeline LTE-TDD-2x2-container
!1854 (merged)
Handle reconfigurationWithSync
!2019 (merged)
bugfix: LDPC decoding in the gNB: clear d properly
!2038 (merged)
Fix DL 2x2 errors
!2039 (merged)
Adding test-case in XML to reset USRP in LTE-TDD pipeline
!2008 (merged)
Implement NR-UE Deregistration procedure
!2023 (merged)
Rework PDCP OAI API to allow custom SRB data forwarding (e.g., in F1)
!2015 (merged)
Update documentation: CI, general README.md, overview of doc README, various improvements
Edited
2 years ago
by
Robert Schmidt
0
0
Merge request reports
Viewing commit
e4143ded
Prev
Next
Show latest version
2 files
+
124
−
50
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
2
Search (e.g. *.vue) (Ctrl+P)
e4143ded
Update main README and overview of documentation
· e4143ded
Robert Schmidt
authored
2 years ago
doc/README.md
0 → 100644
+
102
−
0
Options
<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
Loading