Update for docs
[o-du/phy.git] / docs / overview1.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 O-DU Low Project Introduction
20 ================================
21
22 .. contents::
23     :depth: 3
24     :local:
25
26 The O-DU low project focus on the baseband PHY Reference Design, which uses Xeon® series Processor with Intel |br|
27 Architecture. This 5GNR Reference PHY consists of a L1 binary \
28 and three kinds of interfaces which are validated on a |br|
29 Intel® Xeon® SkyLake / CascadeLake platforms and demonstrates the capabilities of the software running different \
30 5GNR L1 features. It implements the relevant functions described in [3GPP TS 38.211, 212, 213, 214 and 215].
31  
32 The L1 has three \ 
33 interfaces to communicate with other network functions as described below:
34
35 * Interface between L1 and Front Haul, it adopts the WG4 specification for the CUS plane communication. 
36
37 * Interface between O-DU Low and O-DU High, it adopts the FAPI interface according to the WG8 AAL specification.
38
39 * Interface between O-DU Low and accelerator, DPDK BBDev was adopted as original contribution, it will follow the WG6 definition after the WG6 specification is finalized. 
40
41 The following figure shows the ORAN O-CU, O-DU and O-RU blocks for a gNB implemetation. The O-DU Low projects implements the FAPI interface by a 5G FAPI TM module, the OFH-U and OFH-C
42 by means of the FHI Library and the functionality of the High-PHY and a test MAC are available through github in the form of a binary blob for the current release. For the details refer to the Running L1 and Testmac section of this document 
43
44
45 .. image:: images/ORAN_OCU_ODU_ORU.jpg
46    :width: 600
47    :alt: Figure1.Oran OCU ODU and ORU Block Diagram
48    
49 Scope
50 -----
51
52 In this O-DU Low document, the details on how the build the modules supporting each interface, how to run the L1 and associated components, the architecture for each
53 interface implementation and the release notes that describe each component release details are provided.
54
55 Intended Audience
56 -------------------
57
58 The intended audience for this document are software engineers and system architects who design and develop |br|
59 5G systems using the O-RAN Specifications.
60
61 Terminology
62 -------------
63
64 Table 1. Terminology
65
66 +--------+------------------------------------------------------------+
67 | Term   | Description                                                |
68 +--------+------------------------------------------------------------+
69 | 5G NR  | Fifth Generation New Radio                                 |
70 +--------+------------------------------------------------------------+
71 | BOM    | Bill of Materials                                          |
72 +--------+------------------------------------------------------------+
73 | CP     | Cyclic Prefix                                              |
74 +--------+------------------------------------------------------------+
75 | DPDK   | Data Plane Development Kit                                 |
76 +--------+------------------------------------------------------------+
77 | gNB    | Next-generation NodeB also named as Base Station           |
78 +--------+------------------------------------------------------------+
79 | HARQ   | Hybrid Automatic Repeat Request                            |
80 +--------+------------------------------------------------------------+
81 | HW     | Hardware                                                   |
82 +--------+------------------------------------------------------------+
83 | IOT    | Inter-Operability Testing                                  |
84 +--------+------------------------------------------------------------+
85 | IQ     | In-band and Quadrature                                     |
86 +--------+------------------------------------------------------------+
87 | NIC    | Network Interface Controller                               |
88 +--------+------------------------------------------------------------+
89 | O-DU   | O-RAN Distributed Unit: a logical node hosting             |
90 |        | RLC/MAC/High-PHY layers based on a lower layer functional  |
91 |        | split.                                                     |
92 +--------+------------------------------------------------------------+
93 | O-RU   | O-RAN Radio Unit: a logical node hosting Low-PHY layer and |
94 |        | RF processing based on a lower layer functional split.     |
95 |        | This is similar to 3GPP’s “TRP” or “RRH” but more specific |
96 |        | in including the Low-PHY layer (FFT/IFFT, PRACH            |
97 |        | extraction).                                               |
98 +--------+------------------------------------------------------------+
99 | PDCCH  | Physical Downlink Control Channel                          |
100 +--------+------------------------------------------------------------+
101 | PDSCH  | Physical Downlink Shared Channel                           |
102 +--------+------------------------------------------------------------+
103 | PRACH  | Physical Random Access Channel                             |
104 +--------+------------------------------------------------------------+
105 | PUCCH  | Physical Uplink Control Channel                            |
106 +--------+------------------------------------------------------------+
107 | PUSCH  | Physical Uplink Shared Channel                             |
108 +--------+------------------------------------------------------------+
109 | PTP    | Precision Time Protocol                                    |
110 +--------+------------------------------------------------------------+
111 | RA     | Random Access                                              |
112 +--------+------------------------------------------------------------+
113 | RAN    | Radio Access Network                                       |
114 +--------+------------------------------------------------------------+
115 | RB     | Resource Block                                             |
116 +--------+------------------------------------------------------------+
117 | RE     | Resource Element                                           |
118 +--------+------------------------------------------------------------+
119 | RU     | Radio Unit                                                 |
120 +--------+------------------------------------------------------------+
121 | SR-IOV | Single Root Input/Output Virtualization                    |
122 +--------+------------------------------------------------------------+
123 | SW     | Software                                                   |
124 +--------+------------------------------------------------------------+
125 | ToS    | Top of the Second                                          |
126 +--------+------------------------------------------------------------+
127 | UE     | User Equipment                                             |
128 +--------+------------------------------------------------------------+
129 | UL     | Uplink                                                     |
130 +--------+------------------------------------------------------------+
131 | VIM    | Virtual Infrastructure Manager                             |
132 +--------+------------------------------------------------------------+
133 | VLAN   | Virtual Local Area Network                                 |
134 +--------+------------------------------------------------------------+
135 | xRAN   | Extensible Radio Access Network                            |
136 +--------+------------------------------------------------------------+
137
138 Reference Documents
139 -------------------
140
141 Table 2. Reference Documents
142
143 +----------------------------------+--------------------------------------------------------------------------------+
144 | Document or Reference            | Document No./                                                                  |
145 |                                  | Location                                                                       |
146 +----------------------------------+--------------------------------------------------------------------------------+
147 | 3GPP\* specification series      | http://www.3gpp.org/DynaReport/38-series.htm                                   |
148 +----------------------------------+----------------------------------+---------------------------------------------+
149 | Wolf Pass Server Documentation   | https://ark.intel.com/products/codename/80739/Wolf-Pass                        |
150 +----------------------------------+----------------------------------+---------------------------------------------+
151 | *Intel® C++ Compiler             | https://software.intel.com/en-us/system-studio/choose-download                 |
152 | system Studio XE*                |                                                                                |
153 +----------------------------------+--------------------------------------------------------------------------------+
154 | DPDK documentation               | http://dpdk.org/doc/guides/                                                    |
155 +----------------------------------+--------------------------------------------------------------------------------+
156 | O-RAN Fronthaul Working Group    | https://www.o-ran.org/specifications                                           |
157 | Control, User and                |                                                                                |
158 | Synchronization Plane            |                                                                                |
159 | Specification                    |                                                                                |
160 | (ORAN-WG4.CUS.0-v02.00)          |                                                                                |
161 +----------------------------------+--------------------------------------------------------------------------------+
162
163
164