Files
openairinterface5g/doc
Robert Schmidt 7227cfb320 Merge remote-tracking branch 'origin/n2-handover' into integration_2025_w38 (!3334)
N2 handover

This MR introduces full support for N2 handover, covering handover
decision, preparation, execution, and notification between source and
target NG-RAN nodes.

Key features:

1. Handover Decision & Preparation:
  - Implement N2 handover decision based on UE measurement reports.
  - Generate the Handover Preparation Information message, including
    RRCReconfiguration.
  - Send Handover Required message from the source NG-RAN to the AMF.
2. Handover Execution:
  - Decode and handle the Handover Request on the target NG-RAN.
  - Process the Handover Command on the source gNB, triggering
    RRCReconfiguration.
  - Initiate Handover Notify after successful completion.
3 NGAP & RRC Enhancements:
  - Implement NGAP encoding/decoding functions for Handover Required,
    Handover Request, Handover Command, Handover Failure, and Handover
    Notify (3GPP TS 38.413).
  - Adds NG-RAN Status Transfer support (UL/DL) for PDCP COUNT
    preservation during mobility:
    - support for NGAP Uplink and Downlink RAN Status Transfer messages
      (TS 38.413 §9.2.3.13-14) to enable proper PDCP COUNT value
      transfer during handover or recovery: NGAP encoding/decoding for
      RAN Status Transfer, PDCP helpers to extract and apply COUNT (HFN
      + SN) per DRB. This aligns with TS 38.300 §9.2.3.2.1 and TS 23.502
      §4.9.1.3.3, ensuring PDCP status preservation in AM.
4. Testing:
  - Introduce a Telnet command to manually trigger N2 handover using UE
    ID and neighbor PCI.
  - Add configuration file for testing N2 handover with a target gNB.
2025-09-18 11:57:44 +02:00
..
2021-10-27 22:36:33 +00:00
2025-09-18 11:54:19 +02:00
2025-04-14 11:39:08 +02:00
2025-08-05 18:38:16 +02:00
2025-08-11 17:11:21 +02:00
2022-09-29 10:03:28 +02:00
2025-04-18 09:02:54 +02:00
2021-12-07 13:47:15 +08:00

OpenAirInterface documentation overview

This is the general overview page of the OpenAirInterface documentation.
This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries.

IMPORTANT NOTE:
Before reading this documentation, we strongly advise you to keep your own repository rebased on develop or at least to checkout the documentation on the version of the repository you are using.
Then the documentation will better reflect the features available in your repository so that you may avoid some errors.
Beware if you previously pulled the develop branch that your repository may be now behind develop.

[[TOC]]

General

There is some general information in the OpenAirInterface Gitlab Wiki

Tutorials

Legacy unmaintained files:

Designs

Building and running from images

Libraries

General

Radios

Some directories under radio contain READMEs:

The other SDRs (AW2S, LimeSDR, ...) have no READMEs.

Special-purpose libraries

  • OAI has two scopes: one based on Xforms and one based on imgui, described in this README
  • OAI comes with an integrated telnet server to monitor and control
  • OAI comes with an integrated web server

Testing

  • UnitTests.md explains the unit testing setup
  • Component tests are under tests/. Currently, there is a simple CU-UP tester, see the corresponding README.md.
  • TESTBenches.md lists the CI setup and links to pipelines
  • The CI setup uses a custom framework to run end-to-end tests.

Developer tools

  • formatting is a clang-format error detection tool
  • iwyu is a tool to detect #include errors
  • docker-dev-env is a ubuntu24 docker development environment