TESTING_GNB_W_COTS_UE.md 9.54 KB
Newer Older
Remi Hardy's avatar
Remi Hardy committed
1
STATUS 2020/06/26 : information is up to date, but under continuous improvement
Remi Hardy's avatar
Remi Hardy committed
2

Remi Hardy's avatar
Remi Hardy committed
3 4 5 6 7 8 9 10 11 12 13 14 15
## Table of Contents ##

1.   [Configuration Overview](#configuration-overview)
2.   [SW Repository / Branch](#repository)
3.   [Architecture Setup](#architecture-setup)
4.   [Build / Install](#build-and-install)
5.   [Run / Test](#run-and-test)
6.   [Test case](#test-case)
7.   [Log file monitoring](#log-file-monitoring)
6.   [Required tools for debug](#required-tools-for-debug)
7.   [Status of interoperability](#status-of-interoperability) 

## Configuration Overview
Remi Hardy's avatar
Remi Hardy committed
16 17 18 19 20 21

* Non Standalone (NSA) configuration  : initial Control Plane established between UE and RAN eNB, then User Plane established between UE and gNB, Core network is 4G based supporting rel 15

* Commercial UE: Oppo Reno 5G
* OAI Software Defined gNB and eNB
* eNB RF front end: USRP (ETTUS) B200 Mini or B210
Remi Hardy's avatar
Remi Hardy committed
22
* gNB RF front end: USRP (ETTUS) B200 Mini or B210 (N310 will be needed for MIMO and wider BW's)
Remi Hardy's avatar
Remi Hardy committed
23 24 25 26 27
* 5G TDD duplexing mode
* 5G FR1 Band n78 (3.5 GHz)
* BW: 40MHz
* Antenna scheme: SISO

Remi Hardy's avatar
Remi Hardy committed
28
## Repository
Remi Hardy's avatar
Remi Hardy committed
29 30 31 32 33

https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop

## Architecture Setup

Remi Hardy's avatar
Remi Hardy committed
34
The scheme below depicts our typical setup:
Remi Hardy's avatar
Remi Hardy committed
35

Remi Hardy's avatar
Remi Hardy committed
36
![image info](./testing_gnb_w_cots_ue_resources/oai_fr1_setup.jpg)
Remi Hardy's avatar
Remi Hardy committed
37

Remi Hardy's avatar
Remi Hardy committed
38 39 40
The photo depicts the FR1 setup part of the scheme above:  


Remi Hardy's avatar
Remi Hardy committed
41
![image info](./testing_gnb_w_cots_ue_resources/oai_fr1_lab.jpg)
Remi Hardy's avatar
Remi Hardy committed
42

Remi Hardy's avatar
Remi Hardy committed
43
## Build and Install
Remi Hardy's avatar
Remi Hardy committed
44 45 46 47

General guidelines for building :
See https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/doc/BUILD.md#building-ues-enodeb-and-gnodeb-executables

Remi Hardy's avatar
Remi Hardy committed
48
- **EPC**
Remi Hardy's avatar
Remi Hardy committed
49 50 51 52

for reference:
https://github.com/OPENAIRINTERFACE/openair-epc-fed/blob/master-documentation/docs/DEPLOY_HOME.md

Remi Hardy's avatar
Remi Hardy committed
53

Remi Hardy's avatar
Remi Hardy committed
54

Remi Hardy's avatar
Remi Hardy committed
55
- **eNB**
Remi Hardy's avatar
Remi Hardy committed
56 57

```
Remi Hardy's avatar
Remi Hardy committed
58
sudo 
Remi Hardy's avatar
Remi Hardy committed
59 60
```

Remi Hardy's avatar
Remi Hardy committed
61
- **gNB**
Remi Hardy's avatar
Remi Hardy committed
62 63

```
Remi Hardy's avatar
Remi Hardy committed
64
sudo 
Remi Hardy's avatar
Remi Hardy committed
65 66
```

Remi Hardy's avatar
Remi Hardy committed
67
## Configuration Files
Remi Hardy's avatar
Remi Hardy committed
68

Remi Hardy's avatar
Remi Hardy committed
69 70
Each component (EPC, eNB, gNB) has its own configuration file.  
These config files are passed as arguments of the run command line, using the option -O \<conf file\>
Remi Hardy's avatar
Remi Hardy committed
71

Remi Hardy's avatar
Remi Hardy committed
72 73
Some config examples can be found in the following folder:  
https://gitlab.eurecom.fr/oai/openairinterface5g/-/tree/develop/targets/PROJECTS/GENERIC-LTE-EPC/CONF
Remi Hardy's avatar
Remi Hardy committed
74

Remi Hardy's avatar
Remi Hardy committed
75 76
TO DO : attach base confif files

Remi Hardy's avatar
Remi Hardy committed
77
These files have to be updated manually to set the IP addresses and frequency.  
Remi Hardy's avatar
Remi Hardy committed
78

Remi Hardy's avatar
Remi Hardy committed
79 80 81 82 83 84 85 86 87 88
1- In the **eNB configuration file** :
- look for MME IP address, and update the **ipv4 field** with the IP address of the **EPC** server
```
    ////////// MME parameters:
    mme_ip_address      = ( { ipv4       = "**YOUR_EPC_IP_ADDR**";
                              ipv6       = "192:168:30::17";
                              active     = "yes";
                              preference = "ipv4";
                            }
                          );
Remi Hardy's avatar
Remi Hardy committed
89 90

```
Remi Hardy's avatar
Remi Hardy committed
91 92

- look for S1 IP address, and update the **3 fields below** with the IP address of the **eNB** server  
Remi Hardy's avatar
Remi Hardy committed
93
```
Remi Hardy's avatar
Remi Hardy committed
94 95 96 97 98 99 100 101 102 103
    NETWORK_INTERFACES :
    {
        ENB_INTERFACE_NAME_FOR_S1_MME            = "eth0";
        ENB_IPV4_ADDRESS_FOR_S1_MME              = "**YOUR_ENB_IP_ADDR**";
        ENB_INTERFACE_NAME_FOR_S1U               = "eth0";
        ENB_IPV4_ADDRESS_FOR_S1U                 = "**YOUR_ENB_IP_ADDR**";
        ENB_PORT_FOR_S1U                         = 2152; # Spec 2152
        ENB_IPV4_ADDRESS_FOR_X2C                 = "**YOUR_ENB_IP_ADDR**";
        ENB_PORT_FOR_X2C                         = 36422; # Spec 36422
    };
Remi Hardy's avatar
Remi Hardy committed
104

Remi Hardy's avatar
Remi Hardy committed
105
```
Remi Hardy's avatar
Remi Hardy committed
106

Remi Hardy's avatar
Remi Hardy committed
107 108 109 110 111 112 113 114 115 116 117 118
2- In the **gNB configuration file** :
- look for MME IP address, and update the **ipv4 field** with the IP address of the **EPC** server
```
    ////////// MME parameters:
    mme_ip_address      = ( { ipv4       = "**YOUR_EPC_IP_ADDR**";
                              ipv6       = "192:168:30::17";
                              active     = "yes";
                              preference = "ipv4";
                            }
                          );
```
- look for X2 IP address, and update the **4 fields** with the IP address of the **eNB** server (notice : even if -in principle- S1 MME is not required for gNB setting)
Remi Hardy's avatar
Remi Hardy committed
119
```
Remi Hardy's avatar
Remi Hardy committed
120

Remi Hardy's avatar
Remi Hardy committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
    ///X2
    enable_x2 = "yes";
    t_reloc_prep      = 1000;      /* unit: millisecond */
    tx2_reloc_overall = 2000;      /* unit: millisecond */
    target_enb_x2_ip_address      = (
                                     { ipv4       = "**YOUR_ENB_IP_ADDR**";
                                       ipv6       = "192:168:30::17";
                                       preference = "ipv4";
                                     }
                                    );

    NETWORK_INTERFACES :
    {

        GNB_INTERFACE_NAME_FOR_S1_MME            = "eth0";
        GNB_IPV4_ADDRESS_FOR_S1_MME              = "**YOUR_ENB_IP_ADDR**";
        GNB_INTERFACE_NAME_FOR_S1U               = "eth0";
        GNB_IPV4_ADDRESS_FOR_S1U                 = "**YOUR_ENB_IP_ADDR**";
        GNB_PORT_FOR_S1U                         = 2152; # Spec 2152
        GNB_IPV4_ADDRESS_FOR_X2C                 = "**YOUR_ENB_IP_ADDR**";
        GNB_PORT_FOR_X2C                         = 36422; # Spec 36422
    };

    
Remi Hardy's avatar
Remi Hardy committed
145 146 147 148
```



Remi Hardy's avatar
Remi Hardy committed
149
3- The frequency setting requires a manual update in the .C and in the gNB conf file:
Remi Hardy's avatar
Remi Hardy committed
150 151


Remi Hardy's avatar
Remi Hardy committed
152 153 154 155 156 157 158
In the C file **openair2/RRC/LTE/rrc_eNB.c:3217**  
set the nrarfcn to the same value as absoluteFrequencySSB in the **gNB config file**, that is **641272** in the example below 

C file :
```
MeasObj2->measObject.choice.measObjectNR_r15.carrierFreq_r15 =641272;
```
Remi Hardy's avatar
Remi Hardy committed
159

Remi Hardy's avatar
Remi Hardy committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
gNB config file :

```
    # absoluteFrequencySSB is the central frequency of SSB 
    absoluteFrequencySSB                                          = 641272; 
    dl_frequencyBand                                                 = 78;
    # the carrier frequency is assumed to be in the middle of the carrier, i.e. dl_absoluteFrequencyPointA_kHz + dl_carrierBandwidth*12*SCS_kHz/2
    dl_absoluteFrequencyPointA                                       = 640000;
    #scs-SpecificCarrierList
    dl_offstToCarrier                                              = 0;
    # subcarrierSpacing
    # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120  
    dl_subcarrierSpacing                                           = 1;
    dl_carrierBandwidth                                            = 106;
```


Remi Hardy's avatar
Remi Hardy committed
177
## Run and Test
Remi Hardy's avatar
Remi Hardy committed
178

Remi Hardy's avatar
Remi Hardy committed
179 180 181 182 183 184 185 186 187 188
The order to run the different components is important:  
1- first, CN  
2- then, eNB  
3- then, gNB  
4- finally, switch UE from airplane mode OFF to ON  

It is recommended to redirect the run commands to the same log file (fur further analysis and debug), using ```| tee **YOUR_LOG_FILE**``` especially for eNB and gNB.  
It is not very useful for the CN.  

The test takes typically a few seconds, max 10-15 seconds. If it takes more than 30 seconds, there is a problem. 
Remi Hardy's avatar
Remi Hardy committed
189 190 191 192 193 194 195 196 197 198

- **EPC** (on EPC host):

for reference:
https://github.com/OPENAIRINTERFACE/openair-epc-fed/blob/master-documentation/docs/DEPLOY_HOME.md



- **eNB** (on the eNB host):

Remi Hardy's avatar
Remi Hardy committed
199 200 201 202 203 204
Execute: 
```
~/openairinterface5g/cmake_targets/ran_build/build$ sudo ./lte-softmodem -O **YOUR_ENB_CONF_FILE** | tee **YOUR_LOG_FILE**

```

Remi Hardy's avatar
Remi Hardy committed
205
For example:
Remi Hardy's avatar
Remi Hardy committed
206
```
Remi Hardy's avatar
Remi Hardy committed
207
~/openairinterface5g/cmake_targets/ran_build/build$ sudo ./lte-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.band7.tm1.50PRB.usrpb210.conf | tee mylogfile.log
Remi Hardy's avatar
Remi Hardy committed
208
```
Remi Hardy's avatar
Remi Hardy committed
209 210


Remi Hardy's avatar
Remi Hardy committed
211

Remi Hardy's avatar
Remi Hardy committed
212
- **gNB** (on the gNB host)
Remi Hardy's avatar
Remi Hardy committed
213

Remi Hardy's avatar
Remi Hardy committed
214 215 216 217 218 219 220

Execute: 
```
~/openairinterface5g/cmake_targets/ran_build/build$ sudo ./nr-softmodem -O **YOUR_GNB_CONF_FILE** | tee **YOUR_LOG_FILE**

```

Remi Hardy's avatar
Remi Hardy committed
221
For example:
Remi Hardy's avatar
Remi Hardy committed
222
```
Remi Hardy's avatar
Remi Hardy committed
223
~/openairinterface5g/cmake_targets/ran_build/build$ sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-LTE-EPC/CONF/gnb.band78.tm1.106PRB.usrpn300.conf | tee mylogfile.log
Remi Hardy's avatar
Remi Hardy committed
224
```
Remi Hardy's avatar
Remi Hardy committed
225 226


Remi Hardy's avatar
Remi Hardy committed
227 228
## Test Case

Remi Hardy's avatar
Remi Hardy committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
The test case corresponds to the UE attachement, that is the UE connection and its initial access in 5G, as depicted below:

**Source** : https://www.sharetechnote.com/html/5G/5G_LTE_Interworking.html  

![image info](./testing_gnb_w_cots_ue_resources/attach_signaling_scheme.jpg)

The test reaches step **12. E-RAB modifcation confirmation** , eventhough not all the messages will appear in the log file. 

## Log file monitoring

From the log file that is generated, we can monitor several important steps, to assess that the test was successful:

Step **6. Random Access Procedure** is successfully reached when the following messages are shown:  
[X2AP ... Received elements for X2P]  
...  
[LSCH received ok]  

The next message to check is:  
[DCI type I payload] indicating some DL traffic for signaling  

Eventually, step **12. E-RAB Modification Confirmation** is successfully reached when the following message is visible:  
[E-RAB Modification Confirmation], the message is properly received but not treated.  

Remi Hardy's avatar
Remi Hardy committed
252

Remi Hardy's avatar
Remi Hardy committed
253
TO DO : attach typical succcessful log file as example, add snaps of msg
Remi Hardy's avatar
Remi Hardy committed
254

Remi Hardy's avatar
Remi Hardy committed
255
## Required tools for debug
Remi Hardy's avatar
Remi Hardy committed
256

Remi Hardy's avatar
Remi Hardy committed
257 258 259
- **Wireshark** to trace X2AP and S1AP protocols  
- **Ttracer** for 5G messages  
- **GDB debugger** to check function calls  
Remi Hardy's avatar
Remi Hardy committed
260 261


Remi Hardy's avatar
Remi Hardy committed
262
## Status of interoperability
Remi Hardy's avatar
Remi Hardy committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288

The following parts have been validated with FR1 COTS UE:

- Phone accepts the configurtion provided by OAI eNB:  
    this validates RRC and X2AP  

- Successful Random Access Procedure:  
    PRACH is correctly decoded at gNB  
    Phone correctly receives and decodes msg2 (NR PDCCH Format 1_0 and NR PDSCH)  
    msg3  is transmitted to gNB according to the configuration sent in msg2, and received correctly at gNB    

- Successful path switch of user plane traffic from 4G to 5G cell (E-RAB modification message):  
   this validates S1AP  

- Downlink traffic:  
    PDCCH DCI format 1_1 and correponding PDSCH are decoded correctlyby the phone  
    ACK/NACK (PUCCH format 0) are successfully received at gNB  

- On going:  
    validation of HARQ procedures  
    Integration with higher layers to replace dummy data with real traffic  
    
- Known limitations as of May 2020:  
    only dummy DL traffic  
    no UL traffic  
    no end-to-end traffic possible  
Remi Hardy's avatar
Remi Hardy committed
289 290