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.
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# 5GS NAS Overview and OAI Implementation status
|
||||
|
||||
This document provides an overview of the 5G System Non-Access Stratum (5GS NAS) protocol as specified in 3GPP TS 24.501. It highlights key message types involved in Mobility and Session Management and explains how these are implemented within the OAI software stack. The document outlines the structure of the OAI codebase by detailing current support for encoding, decoding, and unit testing of specific NAS messages, and explains how the UE handles USIM simulation and message generation.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI - Aerial FAPI Split Tutorial
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI Build Procedures
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# SPDX-License-Identifier: LicenseRef-CSSL-1.0
|
||||
|
||||
add_boolean_option(GENERATE_DOXYGEN OFF "Generate source code doc using doxygen" OFF)
|
||||
|
||||
if(GENERATE_DOXYGEN)
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# E1AP Procedures
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# F1 split design
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# F1AP Messages Encoding & Decoding Library
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Feature Set
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
The OpenAirInterface software can be obtained from our gitLab server. You will
|
||||
need a git client to get the sources. The repository is used for main
|
||||
developments.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Open Air LTE Emulation
|
||||
|
||||
> **Note: Unless you know what you are doing, you likely do not need this!**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# L2 nFAPI Simulator Usage
|
||||
|
||||
## 4G L2 nFAPI simulator
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# L2 nFAPI Simulator (no S1 Mode / 2-host deployment)
|
||||
|
||||
> **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# L2 nFAPI Simulator (with S1 / 2-host deployment)
|
||||
|
||||
> **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI LDPC offload (O-RAN AAL/DPDK BBDEV)
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# LDPC offload with the XDMA driver
|
||||
|
||||
[TOC]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
This document describes the basic functioning of the 5G MAC scheduler,
|
||||
describes the periodic output, and explains
|
||||
out the various configuration options that influence its behavior.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# SmallCellForum 5G (n)FAPI split
|
||||
|
||||
This document describes the broad way in which the VNF and PNF work internally,
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI 5G NR SA tutorial with COTS UE
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI 5G NR SA tutorial: setting up OAI CN5G
|
||||
|
||||
**Table of Contents**
|
||||
@@ -73,4 +75,4 @@ Please check this link:
|
||||
|
||||
### 4.2 Testing with OAI nrUE
|
||||
Please check this link:
|
||||
[Testing with OAI gNB and OAI nrUE](NR_SA_Tutorial_OAI_nrUE.md)
|
||||
[Testing with OAI gNB and OAI nrUE](NR_SA_Tutorial_OAI_nrUE.md)
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI 5G NR SA tutorial to deploy multiple OAI nrUE
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI 5G NR SA tutorial with OAI nrUE
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OAI 7.2 Fronthaul Interface Tutorial
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OpenAirInterface documentation overview
|
||||
|
||||
This is the general overview page of the OpenAirInterface documentation.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
This document contains documentation for the 5G RRC layer, destined towards
|
||||
developers. It explains the basic working of the RRC, and various UE procedure
|
||||
schemes (connection, reestablishment, handover) including their interworking
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
This document describes the basic functioning of the 5G RRC layer, describes
|
||||
the periodic output, and explains the various configuration options that
|
||||
influence its behavior.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Running OAI 5G Softmodems
|
||||
|
||||
This document explains some options for running 5G executables.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Running NR PRS with OAI gNB and nrUE
|
||||
|
||||
This page is valid on tags starting from **`2022.w37`**.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
This document is a high-level overview over the L1 threading mechanism.
|
||||
|
||||
```mermaid
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
STATUS 2020/10/15 : added External Resources section and links
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# UpLink Multiple Input Multiple Output (UL MIMO)
|
||||
## What is UL MIMO ?
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Unit Testing in OAI
|
||||
|
||||
OpenAirInterface uses
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Implementation of Analog Beamforming
|
||||
|
||||
This document explains the implementation of analog beamforming in OAI codebase.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format our code.
|
||||
|
||||
## Integration into editors
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Contribution Guidelines and Coding Style for Developers
|
||||
|
||||
This document lays out the basic contribution policies for developers. It
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OpenAirInterface Cross-Compiler User Guide
|
||||
|
||||
This document explains how to build OAI for ARM64
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# How to use device-to-device communication (D2D, 4G)
|
||||
|
||||
---
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Synchronized Real-Time Data Recording Application
|
||||
|
||||
The Data Recording Application runs in parallel to the system components on one of the LINUX servers. It makes use of OAI T-tracer framework. It is able to communicate with the Base station (gNB) and User terminal (UE).
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# How to use sanitizers with OAI
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Documentation Best Practices
|
||||
|
||||
The following contribution guidelines ensure that all documentation in the
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Environment variables
|
||||
|
||||
OAI uses/supports a number of environment variables, documented in the following:
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
There are fundamental changes to the L2 emulation mechanism; these changes allow the
|
||||
user to run multiple UEs in separate Linux processes/machines/VMs/etc. They use a separate
|
||||
entity between the UE(s) and eNB. The UEs use nFAPI to communicate with the eNB. The
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
There are fundamental changes to the L2 emulation mechanism; these changes allow the
|
||||
user to run multiple UEs in separate Linux processes/machines/VMs/etc. They use a separate
|
||||
entity between the UE(s) and eNB/gNB. The UEs use nFAPI to communicate with the eNB/gNB. The
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# 5G gNB Frequency Configuration
|
||||
|
||||
Configuring the frequency settings for a 5G gNB involves specifying multiple parameters in the gNB configuration file. This guide outlines the necessary parameters and provides step-by-step instructions for configuration.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Handover Tutorial for OAI
|
||||
|
||||
This tutorial explains how to perform handovers. It covers both F1 handovers
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# I/Q record-replay
|
||||
## using the iq record-replay
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# FAPI/nFAPI split in OAI
|
||||
|
||||
This document describes the SmallCellForum (SCF) (n)FAPI split in 5G, i.e.,
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
## PHY and MAC Interface
|
||||
The PHY sends scheduling requests and data indication to MAC via `nr_ue_dl_indication` for DL path and `nr_ue_ul_indication()` for UL path and the MAC sends scheduling configuration to PHY via `nr_ue_scheduled_response()`. The following diagram shows the interaction for PDCCH and PDSCH reception.
|
||||
```mermaid
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# OpenAirInterface Packages
|
||||
|
||||
This document describes how to build Deb/RPM packages with OAI's build system, cmake.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Physical Simulators ("Physims") User Guide
|
||||
|
||||
This document provides an overview and usage guide for the **physical simulators**, also referred to as **unitary
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# The gNB RACH Processing
|
||||
|
||||
## 1. Collect I/Q Samples
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# System Requirements for Using OAI Stack
|
||||
|
||||
This document describes the minimal and performant system requirements for OpenAirInterface (OAI) 4G/5G software stack (UE and gNB stack). The information provided in this document is based on experimentation, if you have a feedback then open an issue or send an email on the mailing list.
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# SPDX-License-Identifier: LicenseRef-CSSL-1.0
|
||||
|
||||
Active_eNBs = ( "eNB-Eurecom-LTEBox");
|
||||
# Asn1_verbosity, choice in: none, info, annoying
|
||||
Asn1_verbosity = "none";
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
# SPDX-License-Identifier: LicenseRef-CSSL-1.0
|
||||
|
||||
Active_gNBs = ( "gNB-Eurecom-5GNRBox");
|
||||
# Asn1_verbosity, choice in: none, info, annoying
|
||||
Asn1_verbosity = "none";
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
# Time management module
|
||||
|
||||
[[_TOC_]]
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
||||
|
||||
This document outlines some information specific to system tuning for
|
||||
running all executables (`nr-softmodem`, `lte-softmodem`, `nr-uesoftmodem`,
|
||||
`lte-uesoftmodem`, `nr-cuup`, called softmodems for short in the following).
|
||||
|
||||
@@ -1,23 +1,4 @@
|
||||
################################################################################
|
||||
# Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
|
||||
# contributor license agreements. See the NOTICE file distributed with
|
||||
# this work for additional information regarding copyright ownership.
|
||||
# The OpenAirInterface Software Alliance licenses this file to You under
|
||||
# the OAI Public License, Version 1.1 (the "License"); you may not use this file
|
||||
# except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.openairinterface.org/?page_id=698
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#-------------------------------------------------------------------------------
|
||||
# For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
# contact@openairinterface.org
|
||||
################################################################################
|
||||
# SPDX-License-Identifier: LicenseRef-CSSL-1.0
|
||||
|
||||
# OAI CN Configuration File
|
||||
### This file can be used by all OAI NFs
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
#!/bin/bash
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
set -eo pipefail
|
||||
|
||||
if [ "$MYSQL_ROOT_PASSWORD" ] && [ -z "$MYSQL_USER" ] && [ -z "$MYSQL_PASSWORD" ]; then
|
||||
|
||||
Reference in New Issue
Block a user