Skip to content

O
OpenXG-RAN
Commit e58eb7ac authored by luis_pereira87's avatar luis_pereira87
Browse files
Options

Add automatic Table Of Contents

parent 18cdef95
Hide whitespace changes
Inline Side-by-side
Showing with 42 additions and 182 deletions
ci-scripts/doc/vm_based_simulator_build.md
View file @ e58eb7ac
...@@ -12,11 +12,9 @@ ...@@ -12,11 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Detailed Description](#2-detailed-description)
3. [Typical Usage](#3-typical-usage)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_check_build.md
View file @ e58eb7ac
...@@ -12,10 +12,9 @@ ...@@ -12,10 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Detailed Description](#2-detailed-description)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_create.md
View file @ e58eb7ac
...@@ -12,11 +12,9 @@ ...@@ -12,11 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Detailed Description](#2-detailed-description)
3. [Typical Usage](#3-typical-usage)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_destroy.md
View file @ e58eb7ac
...@@ -12,11 +12,9 @@ ...@@ -12,11 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Detailed Description](#2-detailed-description)
3. [Typical Usage](#3-typical-usage)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_env.md
View file @ e58eb7ac
...@@ -12,12 +12,9 @@ ...@@ -12,12 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Prerequisites](#2-prerequisites)
1. [uvtool installation](#21-uvtool-installation)
2. [apt-cacher-server installation](#22-apt-cacher-server-installation)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_main_scripts.md
View file @ e58eb7ac
...@@ -12,11 +12,9 @@ ...@@ -12,11 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Sub BASH scripts](#2-sub-bash-scripts)
3. [Main script features](#3-main-script-features)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_sources.md
View file @ e58eb7ac
...@@ -12,11 +12,9 @@ ...@@ -12,11 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Centralized Workspace](#2-centralized-workspace)
3. [Create the ZIP file](#3-create-the-zip-file)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/doc/vm_based_simulator_test.md
View file @ e58eb7ac
...@@ -12,14 +12,9 @@ ...@@ -12,14 +12,9 @@
</tr> </tr>
</table> </table>
## Table of Contents ## **Table of Contents**
1. [Introduction](#1-introduction) [[_TOC_]]
2. [Detailed Description](#2-detailed-description)
3. [Typical Usage](#3-typical-usage)
1. [Testing the physical simulators](#31-testing-the-physicals-simulators)
2. [Testing the RF simulator](#33-testing-the-rf-simulator)
3. [Testing the L2-nFAPI simulator](#33-testing-the-l2-nfapi-simulator)
# 1. Introduction # # 1. Introduction #
......
ci-scripts/yaml_files/4g_rfsimulator_fdd_05MHz/README.md
View file @ e58eb7ac
...@@ -14,20 +14,9 @@ ...@@ -14,20 +14,9 @@
This page is only valid for an `Ubuntu18` host. This page is only valid for an `Ubuntu18` host.
**TABLE OF CONTENTS** **Table of Contents**
1. [Retrieving the images on Docker-Hub](#1-retrieving-the-images-on-docker-hub) [[_TOC_]]
2. [Deploy containers](#2-deploy-containers)
1. [Deploy and Configure Cassandra Database](#21-deploy-and-configure-cassandra-database)
2. [Deploy OAI CN4G containers](#22-deploy-oai-cn4g-containers)
3. [Deploy OAI eNB in RF simulator mode](#23-deploy-oai-enb-in-rf-simulator-mode)
4. [Deploy OAI LTE UE in RF simulator mode](#24-deploy-oai-lte-ue-in-rf-simulator-mode)
3. [Check traffic](#3-check-traffic)
4. [Un-deployment](#4-un-deployment)
5. [Explanation on the configuration](#5-explanation-on-the-configuration)
1. [UE IMSI and Keys](#51-ue-imsi-and-keys)
2. [PLMN and TAI](#52-plmn-and-tai)
3. [Access to Internet](#53-access-to-internet)
# 1. Retrieving the images on Docker-Hub # # 1. Retrieving the images on Docker-Hub #
......
ci-scripts/yaml_files/5g_rfsimulator/README.md
View file @ e58eb7ac
...@@ -16,22 +16,9 @@ This page is only valid for an `Ubuntu18` host. ...@@ -16,22 +16,9 @@ This page is only valid for an `Ubuntu18` host.
**NOTE: this version (2022-01-27) has been updated for the `v1.3.0` version of the `OAI 5G CN`.** **NOTE: this version (2022-01-27) has been updated for the `v1.3.0` version of the `OAI 5G CN`.**
**TABLE OF CONTENTS** **Table of Contents**
1. [Retrieving the images on Docker-Hub](#1-retrieving-the-images-on-docker-hub) [[_TOC_]]
2. [Deploy containers](#2-deploy-containers)
1. [Deploy OAI 5G Core Network](#21-deploy-oai-5g-core-network)
2. [Deploy OAI gNB in RF simulator mode and in Standalone Mode](#22-deploy-oai-gnb-in-rf-simulator-mode-and-in-standalone-mode)
3. [Deploy OAI NR-UE in RF simulator mode and in Standalone Mode](#23-deploy-oai-nr-ue-in-rf-simulator-mode-and-in-standalone-mode)
4. [Deploy Second OAI NR-UE in RF simulator mode and in Standalone Mode](#24-deploy-second-oai-nr-ue-in-rf-simulator-mode-and-in-standalone-mode)
3. [Check traffic](#3-check-traffic)
1. [Check your Internet connectivity](#31-check-your-internet-connectivity)
2. [Start the iperf server inside the NR-UE container](#32-start-the-iperf-server-inside-the-nr-ue-container)
3. [Start the iperf client inside the ext-dn container](#33-start-the-iperf-client-inside-the-ext-dn-container)
4. [Un-deployment](#4-un-deployment)
5. [Explanations on the configuration in the docker-compose.yaml](##5-explanations-on-the-configuration-in-the-docker-composeyaml)
1. [Making the NR-UE connect to the core network](#51-making-the-nr-ue-connect-to-the-core-network)
2. [Making the gNB connect to the core network](#52-making-the-gnb-connect-to-the-core-network)
# 1. Retrieving the images on Docker-Hub # # 1. Retrieving the images on Docker-Hub #
......
doc/FEATURE_SET.md
View file @ e58eb7ac
**Table of Contents** **Table of Contents**
1. [Functional Split Architecture](#functional-split-architecture) [[_TOC_]]
2. [OpenAirInterface Block Diagram](#openairinterface-block-diagram)
2. [OpenAirInterface 4G-LTE eNB Feature Set](#openairinterface-4g-lte-enb-feature-set)
1. [eNB PHY Layer](#enb-phy-layer)
2. [eNB MAC Layer](#enb-mac-layer)
3. [eNB RLC Layer](#enb-rlc-layer)
4. [eNB PDCP Layer](#enb-pdcp-layer)
5. [eNB RRC Layer](#enb-rrc-layer)
6. [eNB X2AP](#enb-x2ap)
7. [eNB/MCE M2AP](#enbmce-m2ap)
8. [MCE/MME M3AP](#mcemme-m3ap)
3. [OpenAirInterface 4G-LTE UE Feature Set](#openairinterface-4g-lte-ue-feature-set)
1. [LTE UE PHY Layer](#lte-ue-phy-layer)
2. [LTE UE MAC Layer](#lte-ue-mac-layer)
3. [LTE UE RLC Layer](#lte-ue-rlc-layer)
4. [LTE UE PDCP Layer](#lte-ue-pdcp-layer)
5. [LTE UE RRC Layer](#lte-ue-rrc-layer)
4. [OpenAirInterface 5G-NR gNB Feature Set](#openairinterface-5g-nr-feature-set)
1. [General Parameters](#general-parameters)
2. [gNB Physical Layer](#gnb-phy-layer)
3. [gNB Higher Layers](#gnb-higher-layers)
5. [OpenAirInterface 5G-NR UE Feature Set](#openairinterface-5g-nr-ue-feature-set)
1. [UE Physical Layer](#ue-phy-layer)
2. [UE Higher Layers](#ue-higher-layers)
# Functional Split Architecture # # Functional Split Architecture #
......
doc/L1SIM.md
View file @ e58eb7ac
...@@ -14,13 +14,9 @@ ...@@ -14,13 +14,9 @@
This page is valid for the develop branch This page is valid for the develop branch
# Table of Contents: # **Table of Contents**
* [How to build the eNB and the UE](#build) [[_TOC_]]
* [How to run an eNB built with the noS1 option](#run-noS1-eNB)
* [How to run a UE built with the noS1 option](#run-noS1-UE)
* [Continuous Integration notes](#CInote)
* [How to ping an eNB from a UE and vice versa (with the noS1 option)](#noS1-pinging)
The old oaisim is dead! Long live oaisim! :) The old oaisim is dead! Long live oaisim! :)
......
doc/L2NFAPI_NOS1.md
View file @ e58eb7ac
...@@ -16,19 +16,9 @@ ...@@ -16,19 +16,9 @@
**2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.** **2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
## Table of Contents ## **Table of Contents**
1. [Environment](#1-environment) [[_TOC_]]
2. [Retrieve the OAI eNB-UE source code](#2-retrieve-the-oai-enb-ue-source-code)
3. [Setup of the USIM information in UE folder](#3-setup-of-the-usim-information-in-ue-folder)
4. [Setup of the Configuration files](#4-setup-of-the-configuration-files)
1. [The eNB Configuration file](#41-the-enb-configuration-file)
2. [The UE Configuration file](#42-the-ue-configuration-file)
5. [Build OAI UE and eNodeB](#5-build-oai-ue-and-enodeb)
6. [Start the eNB](#6-start-the-enb)
7. [Start the UE](#7-start-the-ue)
8. [Test with ping](#8-test-with-ping)
9. [Limitations](#9-limitations)
# 1. Environment # # 1. Environment #
......
doc/L2NFAPI_S1.md
View file @ e58eb7ac
...@@ -16,21 +16,9 @@ ...@@ -16,21 +16,9 @@
**2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.** **2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
## Table of Contents ## **Table of Contents**
1. [Environment](#1-environment) [[_TOC_]]
2. [Prepare the EPC](#2-prepare-the-epc)
3. [Retrieve the OAI eNB-UE source code](#3-retrieve-the-oai-enb-ue-source-code)
4. [Setup of the USIM information in UE folder](#4-setup-of-the-usim-information-in-ue-folder)
5. [Setup of the Configuration files](#5-setup-of-the-configuration-files)
1. [The eNB Configuration file](#51-the-enb-configuration-file)
2. [The UE Configuration file](#52-the-ue-configuration-file)
6. [Build OAI UE and eNodeB](#6-build-oai-ue-and-enodeb)
7. [Start EPC](#7-start-epc)
8. [Start the eNB](#8-start-the-enb)
9. [Start the UE](#9-start-the-ue)
10. [Test with ping](#10-test-with-ping)
11. [Limitations](#11-limitations)
# 1. Environment # # 1. Environment #
......
doc/NR_SA_CN5G_gNB_USRP_COTS_UE_Tutorial.md
View file @ e58eb7ac
...@@ -12,29 +12,9 @@ ...@@ -12,29 +12,9 @@
</tr> </tr>
</table> </table>
**TABLE OF CONTENTS** **Table of Contents**
1. [Scenario](#1-scenario)
2. [OAI CN5G](#2-oai-cn5g)
1. [OAI CN5G pre-requisites](#21-oai-cn5g-pre-requisites)
2. [OAI CN5G Setup](#22-oai-cn5g-setup)
3. [OAI CN5G Configuration files](#23-oai-cn5g-configuration-files)
4. [SIM Card](#24-sim-card)
3. [OAI gNB](#3-oai-gnb)
1. [OAI gNB pre-requisites](#31-oai-gnb-pre-requisites)
2. [Build OAI gNB](#32-build-oai-gnb)
3. [N300 Ethernet Tuning](#33-n300-ethernet-tuning)
4. [Run OAI CN5G and OAI gNB](#4-run-oai-cn5g-and-oai-gnb)
1. [Run OAI CN5G](#41-run-oai-cn5g)
2. [Run OAI gNB](#42-run-oai-gnb)
1. [USRP B210](#usrp-b210)
2. [USRP N300](#usrp-n300)
3. [USRP X300](#usrp-x300)
5. [Testing with QUECTEL RM500Q](#5-testing-with-quectel-rm500q)
1. [Setup QUECTEL](#51-setup-quectel)
2. [Ping test](#52-ping-test)
3. [Downlink iPerf test](#53-downlink-iperf-test)
[[_TOC_]]
# 1. Scenario # 1. Scenario
In this tutorial we describe how to configure and run a 5G end-to-end setup with OAI CN5G, OAI gNB and COTS UE. In this tutorial we describe how to configure and run a 5G end-to-end setup with OAI CN5G, OAI gNB and COTS UE.
......
doc/TESTBenches.md
View file @ e58eb7ac
## Table of Contents ## **Table of Contents**
1. [Machines](#machines) [[_TOC_]]
2. [Networked devices](#networked-devices)
3. [Testbenches](#testbenches)
4. [Pipelines](#pipelines)
## Machines ## Machines
......
doc/TESTING_5GSA_setup.md
View file @ e58eb7ac
...@@ -12,16 +12,9 @@ ...@@ -12,16 +12,9 @@
</tr> </tr>
</table> </table>
**TABLE OF CONTENTS** **Table of Contents**
1. [SA setup with COTS UE](#1--sa-setup-with-cots-ue) [[_TOC_]]
1. [gNB build and configuration](#11--gnb-build-and-configuration)
2. [OAI 5G Core Network installation and configuration](#12--oai-5g-core-network-installation-and-configuration)
3. [Execution of SA scenario](#13--execution-of-sa-scenario)
2. [SA Setup with OAI NR UE Softmodem](#2-sa-setup-with-oai-nr-ue-softmodem)
1. [Build and configuration](#21-build-and-configuration)
2. [OAI 5G Core Network installation and configuration](#22--oai-5g-core-network-installation-and-configuration)
3. [Execution of SA scenario](#23-execution-of-sa-scenario)
In the following tutorial we describe how to deploy configure and test the two SA OAI setups: In the following tutorial we describe how to deploy configure and test the two SA OAI setups:
......
doc/TESTING_GNB_W_COTS_UE.md
View file @ e58eb7ac
STATUS 2020/10/15 : added External Resources section and links STATUS 2020/10/15 : added External Resources section and links
**Table of Contents**
## Table of Contents ## [[_TOC_]]
1. [External Resources](#external-resources)
2. [Configuration Overview](#configuration-overview)
3. [SW Repository / Branch](#repository)
4. [Architecture Setup](#architecture-setup)
5. [Build / Install](#build-and-install)
6. [Run / Test](#run-and-test)
7. [Test case](#test-case)
8. [Log file monitoring](#log-file-monitoring)
9. [Required tools for debug](#required-tools-for-debug)
10. [Status of interoperability](#status-of-interoperability)
11. [CI integration](#ci-integration)
## External Resources ## External Resources
......
docker/README.md
View file @ e58eb7ac
...@@ -16,12 +16,7 @@ ...@@ -16,12 +16,7 @@
**Table of Contents** **Table of Contents**
1. [Build Strategy](#1-build-strategy) [[_TOC_]]
2. [File organization](#2-file-organization)
3. [Building using docker under Ubuntu 18.04](#3-building-using-docker-under-ubuntu-1804)
4. [Building using podman under Red Hat Entreprise Linux 8.2](#4-building-using-podman-under-red-hat-entreprise-linux-82)
5. [Running modems using docker under Ubuntu 18.04](#5-running-modems-using-docker-under-ubuntu-1804)
6. [Running modems using podman under Red Hat Entreprise Linux 8.2](#6-running-modems-using-podman-under-red-hat-entreprise-linux-82)
--- ---
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment