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
This commit is contained in:
Robert Schmidt
committed by
Shubhika Garg
Shubhika Garg
parent
a9ba6290b9
commit
5c480ffd50
@@ -16,7 +16,7 @@
|
||||
|
||||
[[_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.
|
||||
|
||||
Minimum hardware requirements:
|
||||
@@ -44,15 +44,15 @@ Minimum hardware requirements:
|
||||
- Firmware version of Quectel MUST be equal or higher than **RM500QGLABR11A06M4G**
|
||||
|
||||
|
||||
# 2. OAI CN5G
|
||||
## 2. OAI CN5G
|
||||
|
||||
## 2.1 OAI CN5G pre-requisites
|
||||
### 2.1 OAI CN5G pre-requisites
|
||||
|
||||
Please install and configure OAI CN5G as described here:
|
||||
[OAI CN5G](NR_SA_Tutorial_OAI_CN5G.md)
|
||||
|
||||
|
||||
## 2.2 SIM Card
|
||||
### 2.2 SIM Card
|
||||
Program UICC/SIM Card with [Open Cells Project](https://open-cells.com/) programming tool [uicc-v3.3](https://open-cells.com/d5138782a8739209ec5760865b1e53b0/uicc-v3.3.tgz).
|
||||
|
||||
```bash
|
||||
@@ -60,11 +60,11 @@ sudo ./program_uicc --adm 12345678 --imsi 001010000000001 --isdn 00000001 --acc
|
||||
```
|
||||
|
||||
|
||||
# 3. OAI gNB
|
||||
## 3. OAI gNB
|
||||
|
||||
## 3.1 OAI gNB pre-requisites
|
||||
### 3.1 OAI gNB pre-requisites
|
||||
|
||||
### Build UHD from source
|
||||
#### Build UHD from source
|
||||
```bash
|
||||
# https://files.ettus.com/manual/page_build_guide.html
|
||||
sudo apt install -y autoconf automake build-essential ccache cmake cpufrequtils doxygen ethtool g++ git inetutils-tools libboost-all-dev libncurses-dev libusb-1.0-0 libusb-1.0-0-dev libusb-dev python3-dev python3-mako python3-numpy python3-requests python3-scipy python3-setuptools python3-ruamel.yaml
|
||||
@@ -83,7 +83,7 @@ sudo ldconfig
|
||||
sudo uhd_images_downloader
|
||||
```
|
||||
|
||||
## 3.2 Build OAI gNB
|
||||
### 3.2 Build OAI gNB
|
||||
|
||||
```bash
|
||||
# Get openairinterface5g source code
|
||||
@@ -100,42 +100,42 @@ cd ~/openairinterface5g/cmake_targets
|
||||
./build_oai -w USRP --ninja --gNB -C
|
||||
```
|
||||
|
||||
# 4. Run OAI CN5G and OAI gNB
|
||||
## 4. Run OAI CN5G and OAI gNB
|
||||
|
||||
## 4.1 Run OAI CN5G
|
||||
### 4.1 Run OAI CN5G
|
||||
|
||||
```bash
|
||||
cd ~/oai-cn5g
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## 4.2 Run OAI gNB
|
||||
### 4.2 Run OAI gNB
|
||||
|
||||
**Note:** From tag `2024.w45`, OAI gNB runs by default in standalone (SA) mode.
|
||||
In earlier versions the default mode was non-standalone (NSA).
|
||||
If you are using an earlier version than `2024.w45`, you should add the `--sa` argument to the sample commands below to obtain a correct behavior.
|
||||
|
||||
### USRP B210
|
||||
#### USRP B210
|
||||
```bash
|
||||
cd ~/openairinterface5g/cmake_targets/ran_build/build
|
||||
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.conf -E --continuous-tx
|
||||
```
|
||||
### USRP N300
|
||||
#### USRP N300
|
||||
```bash
|
||||
cd ~/openairinterface5g/cmake_targets/ran_build/build
|
||||
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band77.fr1.273PRB.2x2.usrpn300.conf --usrp-tx-thread-config 1
|
||||
```
|
||||
|
||||
### USRP X300
|
||||
#### USRP X300
|
||||
```bash
|
||||
cd ~/openairinterface5g/cmake_targets/ran_build/build
|
||||
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band77.fr1.273PRB.2x2.usrpn300.conf --usrp-tx-thread-config 1 -E --continuous-tx
|
||||
```
|
||||
|
||||
# 5. Run UE
|
||||
## 5.1 Testing with Quectel RM500Q
|
||||
## 5. Run UE
|
||||
### 5.1 Testing with Quectel RM500Q
|
||||
|
||||
### 5.1.1 Setup Quectel
|
||||
#### 5.1.1 Setup Quectel
|
||||
With [PuTTY](https://the.earth.li/~sgtatham/putty/latest/w64/putty.exe), send the following AT commands to the module using a serial interface (ex: COM2) at 115200 bps:
|
||||
```bash
|
||||
# MUST be sent at least once everytime there is a firmware upgrade!
|
||||
@@ -149,7 +149,7 @@ AT+CGPADDR=1
|
||||
AT+QPING=1,"openairinterface.org"
|
||||
```
|
||||
|
||||
### 5.1.2 Ping test
|
||||
#### 5.1.2 Ping test
|
||||
- UE host
|
||||
```bash
|
||||
ping 192.168.70.135 -t -S 12.1.1.2
|
||||
@@ -159,7 +159,7 @@ ping 192.168.70.135 -t -S 12.1.1.2
|
||||
docker exec -it oai-ext-dn ping 12.1.1.2
|
||||
```
|
||||
|
||||
### 5.1.3 Downlink iPerf test
|
||||
#### 5.1.3 Downlink iPerf test
|
||||
- UE host
|
||||
- Download iPerf for Microsoft Windows from [here](https://iperf.fr/download/windows/iperf-2.0.9-win64.zip).
|
||||
- Extract to Desktop and run with Command Prompt:
|
||||
@@ -173,11 +173,11 @@ iperf -s -u -i 1 -B 12.1.1.2
|
||||
docker exec -it oai-ext-dn iperf -u -t 86400 -i 1 -fk -B 192.168.70.135 -b 100M -c 12.1.1.2
|
||||
```
|
||||
|
||||
# 6. Advanced configurations (optional)
|
||||
## 6. Advanced configurations (optional)
|
||||
|
||||
See also the [dedicated document on performance tuning](./tuning_and_security.md).
|
||||
|
||||
## 6.1 USRP N300 and X300 Ethernet Tuning
|
||||
### 6.1 USRP N300 and X300 Ethernet Tuning
|
||||
|
||||
Please also refer to the official [USRP Host Performance Tuning Tips and Tricks](https://kb.ettus.com/USRP_Host_Performance_Tuning_Tips_and_Tricks) tuning guide.
|
||||
|
||||
@@ -199,12 +199,12 @@ sudo sysctl -w net.core.rmem_default=62500000
|
||||
sudo ethtool -G enp1s0f0 tx 4096 rx 4096
|
||||
```
|
||||
|
||||
## 6.2 Real-time performance workarounds
|
||||
### 6.2 Real-time performance workarounds
|
||||
- Enable Performance Mode `sudo cpupower idle-set -D 0`
|
||||
- If you get real-time problems on heavy UL traffic, reduce the maximum UL MCS using an additional command-line switch: `--MACRLCs.[0].ul_max_mcs 14`.
|
||||
- You can also reduce the number of LDPC decoder iterations, which will make the LDPC decoder take less time: `--L1s.[0].max_ldpc_iterations 4`.
|
||||
|
||||
## 6.3 Uplink issues related with noise on the DC carriers
|
||||
### 6.3 Uplink issues related with noise on the DC carriers
|
||||
|
||||
With devices like the USRP N300 and especially the X300, there is noise in the DC carriers: this can cause uplink PRBs that overlap with the DC carrier to experience interference and increased noise.
|
||||
|
||||
@@ -224,7 +224,7 @@ There are two main points to keep in mind:
|
||||
|
||||
The option `ul_prbblacklist` is more relevant when using high-bandwidth configurations (e.g., 100 MHz) with devices like the USRP N310 or X310: in this scenarios, `--tune-offset` could not be sufficient to get rid of the noisy PRBs in the center frequency entirely, because it is not possible to shift the DC carriers out of the bandwidth (tune offset shall be smaller than half the bandwidth of the board).
|
||||
|
||||
## 6.3.1 Tune offset
|
||||
### 6.3.1 Tune offset
|
||||
|
||||
The value passed to the command line option `--tune-offset <Hz>` will be calling an UHD API. It represents the LO offset frequency in Hz.
|
||||
The API (tune_request_t class) will send a frequency tuning request (`tx_tune_req`, `rx_tune_req`) to the USRP device, in order to configure the target baseband tx/rx frequency, therefore shifting the tx/rx signal spectrum.
|
||||
@@ -235,9 +235,9 @@ A visual representation of the impact of tune-offset with a 120 MHz bandwidth da
|
||||
|
||||
|
||||
|
||||
## 6.3.2 UL PRBs Blacklist
|
||||
### 6.3.2 UL PRBs Blacklist
|
||||
|
||||
To use this option, in the configuration file, e.g. 100 MHz bandwidth setup: `ul_prbblacklist = "135,136,137,138"`.
|
||||
|
||||
## 6.4 Lower latency on user plane
|
||||
### 6.4 Lower latency on user plane
|
||||
- To lower latency on the user plane, you can force the UE to be scheduled constantly in uplink: `--MACRLCs.[0].ulsch_max_frame_inactivity 0` .
|
||||
|
||||
Reference in New Issue
Block a user