FAPI TM, WLS_LIB and ODULOW documentation
[o-du/phy.git] / docs / Sample-Application_fh.rst
1 ..    Copyright (c) 2019 Intel
2 ..
3 ..  Licensed under the Apache License, Version 2.0 (the "License");
4 ..  you may not use this file except in compliance with the License.
5 ..  You may obtain a copy of the License at
6 ..
7 ..      http://www.apache.org/licenses/LICENSE-2.0
8 ..
9 ..  Unless required by applicable law or agreed to in writing, software
10 ..  distributed under the License is distributed on an "AS IS" BASIS,
11 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 ..  See the License for the specific language governing permissions and
13 ..  limitations under the License.
14
15 .. |br| raw:: html
16
17    <br />
18
19 Sample Application
20 ==================
21
22 .. contents::
23     :depth: 3
24     :local:
25
26 Figure 25 illustrates a sample xRAN application.
27
28 .. image:: images/Sample-Application.jpg
29   :width: 600
30   :alt: Figure 25. Sample Application
31
32 Figure 25. Sample Application
33
34 The sample application was created to execute test scenarios with
35 features of the xRAN library and test external API as well as timing.
36 The sample application is named sample-app, and depending on
37 configuration file settings can act as O-DU or simplified simulation of
38 O-RU. The first O-DU should be run on the machine that acts as O-DU and
39 the second as O-RU. Both machines are connected via ETH. The sample
40 application on both sides executes using a constant configuration |br|
41 according to settings in corresponding config files
42 (./app/usecase/mu0_10mhz/config_file_o_du.dat and |br|
43 ./app/usecase/mu0_10mhz/config_file_o_ru.dat) and uses binary files
44 (ant.bin) with IQ samples as input. Multiple-use |br| 
45 cases for different
46 numerologies and different BW are available as examples. Configuration
47 files provide descriptions of each |br|
48 parameter and in general, those are
49 related to M-plane level settings as per the ORAN Fronthaul
50 specification.
51
52 From the start of the process, the application (O-DU) sends DL packets
53 for the U-plane and C-plane and receives U-plane UL packets.
54 Synchronization of O-DU and O-RU sides is achieved via IEEE 1588.
55
56 U-plane packets for UL and DL direction are constructed the same way
57 except for the direction field.
58
59 The several default configurations used with the sample app for v20.02
60 release are:
61
62 1 Cell mmWave 100MHz TDD DDDS:
63
64
65 -  Numerology 3 (mmWave)
66
67 -  TTI period 125 µs
68
69 -  100 Mhz Bandwidth: 792 subcarriers (all 66 RB utilized at all times)
70
71 -  4x4 MIMO
72
73 -  No beamforming
74
75 -  1 Component carrier
76
77 -  Jumbo Frame for Ethernet (up to 9728 bytes)
78
79 -  Front haul throughput ~11.5 Gbps.
80
81 12 Cells Sub6 10MHz FDD:
82
83
84 -  Numerology 0 (Sub-6)
85
86 -  TTI period 1000 µs
87
88 -  10Mhz Bandwidth: 624 subcarriers (all 52 RB utilized at all times)
89
90 -  4x4 MIMO
91
92 -  No beamforming
93
94 -  12 Component carrier
95
96 -  Jumbo Frame for Ethernet (up to 9728 bytes)
97
98 -  Front haul throughput ~13.7Gbps.
99
100 1 Cell Sub6 100MHz TDD:
101
102
103 -  Numerology 1 (Sub-6)
104
105 -  TTI period 500us
106
107 -  100Mhz Bandwidth: 3276 subcarriers (all 273RB utilized at all times)
108
109 -  4x4 MIMO
110
111 -  No beamforming
112
113 -  1 Component carrier
114
115 -  Jumbo Frame for Ethernet (up to 9728 bytes)
116
117 -  Front haul throughput ~11.7 Gbps.
118
119 .. _cell-sub6-100mhz-tdd-1:
120
121 1 Cell Sub6 100MHz TDD:
122
123
124 -  Numerology 1 (Sub-6)
125
126 -  TTI period 500 µs
127
128 -  100 Mhz Bandwidth: 3276 subcarriers (all 273RB utilized at all
129    times). 8 UEs per TTI per layer
130
131 -  8DL /4UL MIMO Layers
132
133 -  Digital beamforming with 32T32R
134
135 -  1 Component carrier
136
137 -  Jumbo Frame for Ethernet (up to 9728 bytes)
138
139 -  Front haul throughput ~23.5 Gbps.
140
141 Other configurations can be constructed by modifying config files
142 (please see app/usecase/)
143
144
145