First round of documentation cleanup for oran_e_maintenance_release_v1.0
[o-du/phy.git] / docs / Assumptions_Dependencies.rst
1 ..    Copyright (c) 2019-2022 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
16 Assumptions, Dependencies, and Constraints
17 ==========================================
18
19 .. contents::
20     :depth: 3
21     :local:
22
23 This chapter contains limitations on the scope of the document.
24
25 Assumptions
26 -----------
27
28 An L1 with a proprietary interface and a testmac supporting the FAPI interface are available through the Open Source Community(OSC) github in binary blob form and with the reference
29 files that support the tests required for the current O-RAN Release. The required header files that are needed to build the 5G FAPI TM and to run validation tests and to integrate with the O-DU
30 High to check network functionality are available from the same site.
31 The L1 App and Testmac repository is at https://github.com/intel/FlexRAN/
32
33
34 Requirements
35 ------------
36 * Only Xeon® series Processor with Intel Architecture are supported and the platform should be either Intel® Xeon® SkyLake or CascadeLake with at least 2.0 GHz core frequency.
37 * FPGA/ASIC card for FEC acceleration that is compliant with the BBDev framework and interface. Only needed to run high throughput cases with the HW FEC card assistance.
38 * Bios setting steps and options may have differences, however at least you should have the same Bios setting as decribed in the README.md file available at https://github.com/intel/FlexRAN Bios settings section.
39 * Running with FH requires PTP for Linux\* version 2.0 (or later) to be installed to provide IEEE 1588 synchronization.
40
41
42 Dependencies
43 ------------
44
45 O-RAN library implementation depends on the Data Plane Development Kit
46 (DPDK v20.11.1).
47
48 DPDK v20.11.1 should be patched with corresponding DPDK patch provided
49 with FlexRAN release (see *Table 1*, FlexRAN Reference Solution Software
50 Release Notes)
51
52 Intel® C++ Compiler v19.0.3 is used.
53
54 -  Optionally Octave v3.8.2 can be used to generate reference IQ samples (octave-3.8.2-20.el7.x86_64).
55
56 Constraints
57 -----------
58
59 This release has been designed and implemented to support the following
60 numerologies defined in the 3GPP specifications for LTE and 5GNR (refer
61 to *Table 2*):
62
63 5G NR
64 ~~~~~
65
66 Category A support:
67
68 -  Numerology 0 with bandwidth 5/10/20 MHz with up to 12 cells in 2x2 antenna configuration
69 -  Numerology 0 with bandwidth 40 MHz with 1 cell.
70
71 -  Numerology 1 with bandwidth 20/40 MHz with 1 cell and URLLC use cases for 40 MHz
72 -  Numerology 1 with bandwidth 100 MHz with up to 16 cells
73
74 -  Numerology 3 with bandwidth 100 MHz with up to 3 cells
75
76 Category B support:
77
78 Numerology 1 with bandwidth 100 MHz where the antenna panel is up to
79 64T64R with up to 3 cells.
80
81 LTE
82 ~~~
83
84 Category A support:
85
86 Bandwidth 5/10/20 MHz with up to 12 cells
87
88 Category B support:
89
90 Bandwidth 5/10/20 MHz for 1 cell
91
92 The feature set of O-RAN protocol should be aligned with Radio Unit
93 (O-RU) implementation. Inter-operability testing (IoT) is required to
94 confirm the correctness of functionality on both sides. The exact
95 feature set supported is described in Chapter *4.0* *Transport Layer and
96 O-RAN Fronthaul Protocol Implementation* of this document.
97
98 -
99