FAPI TM, WLS_LIB and ODULOW documentation
[o-du/phy.git] / docs / overview1.rst
diff --git a/docs/overview1.rst b/docs/overview1.rst
new file mode 100644 (file)
index 0000000..fecd348
--- /dev/null
@@ -0,0 +1,166 @@
+..    Copyright (c) 2019 Intel
+..
+..  Licensed under the Apache License, Version 2.0 (the "License");
+..  you may not use this file except in compliance with the License.
+..  You may obtain a copy of the License at
+..
+..      http://www.apache.org/licenses/LICENSE-2.0
+..
+..  Unless required by applicable law or agreed to in writing, software
+..  distributed under the License is distributed on an "AS IS" BASIS,
+..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+..  See the License for the specific language governing permissions and
+..  limitations under the License.
+
+.. |br| raw:: html
+
+   <br />
+
+O-DU Low Project Introduction
+================================
+
+.. contents::
+    :depth: 3
+    :local:
+
+The O-DU low project focus on the baseband PHY Reference Design, which uses Xeon® series Processor with Intel |br|
+Architecture. This 5GNR Reference PHY consists of a L1 binary \
+and three kinds of interfaces which are validated on a |br|
+Intel® Xeon® SkyLake / CascadeLake platforms and demonstrates the capabilities of the software running different \
+5GNR L1 features. It implements the relevant functions described in [3GPP TS 38.211, 212, 213, 214 and 215].
+The L1 has three \ 
+interfaces to communicate with other network functions as described below:
+
+* Interface between L1 and Front Haul, it adopts the WG4 specification for the CUS plane communication. 
+
+* Interface between O-DU Low and O-DU High, it adopts the FAPI interface according to the WG8 AAL specification.
+
+* 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. 
+
+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
+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 
+
+
+.. image:: images/ORAN_OCU_ODU_ORU.jpg
+   :width: 600
+   :alt: Figure1.Oran OCU ODU and ORU Block Diagram
+   
+Scope
+-----
+
+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
+interface implementation and the release notes that describe each component release details are provided.
+
+Intended Audience
+-------------------
+
+The intended audience for this document are software engineers and system architects who design and develop |br|
+5G systems using the O-RAN Specifications.
+
+Terminology
+-------------
+
+Table 1. Terminology
+
++--------+------------------------------------------------------------+
+| Term   | Description                                                |
++--------+------------------------------------------------------------+
+| 5G NR  | Fifth Generation New Radio                                 |
++--------+------------------------------------------------------------+
+| BOM    | Bill of Materials                                          |
++--------+------------------------------------------------------------+
+| CP     | Cyclic Prefix                                              |
++--------+------------------------------------------------------------+
+| DPDK   | Data Plane Development Kit                                 |
++--------+------------------------------------------------------------+
+| gNB    | Next-generation NodeB also named as Base Station           |
++--------+------------------------------------------------------------+
+| HARQ   | Hybrid Automatic Repeat Request                            |
++--------+------------------------------------------------------------+
+| HW     | Hardware                                                   |
++--------+------------------------------------------------------------+
+| IOT    | Inter-Operability Testing                                  |
++--------+------------------------------------------------------------+
+| IQ     | In-band and Quadrature                                     |
++--------+------------------------------------------------------------+
+| NIC    | Network Interface Controller                               |
++--------+------------------------------------------------------------+
+| O-DU   | O-RAN Distributed Unit: a logical node hosting             |
+|        | RLC/MAC/High-PHY layers based on a lower layer functional  |
+|        | split.                                                     |
++--------+------------------------------------------------------------+
+| O-RU   | O-RAN Radio Unit: a logical node hosting Low-PHY layer and |
+|        | RF processing based on a lower layer functional split.     |
+|        | This is similar to 3GPP’s “TRP” or “RRH” but more specific |
+|        | in including the Low-PHY layer (FFT/IFFT, PRACH            |
+|        | extraction).                                               |
++--------+------------------------------------------------------------+
+| PDCCH  | Physical Downlink Control Channel                          |
++--------+------------------------------------------------------------+
+| PDSCH  | Physical Downlink Shared Channel                           |
++--------+------------------------------------------------------------+
+| PRACH  | Physical Random Access Channel                             |
++--------+------------------------------------------------------------+
+| PUCCH  | Physical Uplink Control Channel                            |
++--------+------------------------------------------------------------+
+| PUSCH  | Physical Uplink Shared Channel                             |
++--------+------------------------------------------------------------+
+| PTP    | Precision Time Protocol                                    |
++--------+------------------------------------------------------------+
+| RA     | Random Access                                              |
++--------+------------------------------------------------------------+
+| RAN    | Radio Access Network                                       |
++--------+------------------------------------------------------------+
+| RB     | Resource Block                                             |
++--------+------------------------------------------------------------+
+| RE     | Resource Element                                           |
++--------+------------------------------------------------------------+
+| RU     | Radio Unit                                                 |
++--------+------------------------------------------------------------+
+| SR-IOV | Single Root Input/Output Virtualization                    |
++--------+------------------------------------------------------------+
+| SW     | Software                                                   |
++--------+------------------------------------------------------------+
+| ToS    | Top of the Second                                          |
++--------+------------------------------------------------------------+
+| UE     | User Equipment                                             |
++--------+------------------------------------------------------------+
+| UL     | Uplink                                                     |
++--------+------------------------------------------------------------+
+| VIM    | Virtual Infrastructure Manager                             |
++--------+------------------------------------------------------------+
+| VLAN   | Virtual Local Area Network                                 |
++--------+------------------------------------------------------------+
+| xRAN   | Extensible Radio Access Network                            |
++--------+------------------------------------------------------------+
+
+Reference Documents
+-------------------
+
+Table 2. Reference Documents
+
++----------------------------------+----------------------------------+
+| Document or Reference            | Document No./                    |
+|                                  | Location                         |
++----------------------------------+----------------------------------+
+| 3GPP\* specification series      | http://www.3                     |
+|                                  | gpp.org/DynaReport/38-series.htm |
++----------------------------------+----------------------------------+
+| Wolf Pass Server Documentation   | https://ark.intel.com/p          |
+|                                  | roducts/codename/80739/Wolf-Pass |
++----------------------------------+----------------------------------+
+| *Intel® C++ Compiler             |https://software.intel.com/en-us/ |
+| system Studio XE*                |system-studio/choose-download     |
++----------------------------------+----------------------------------+
+| DPDK documentation               | http://dpdk.org/doc/guides/      |
++----------------------------------+----------------------------------+
+| O-RAN Fronthaul Working Group    | `https://www.o-ran.org/          |
+| Control, User and                | specifications <https://         |
+| Synchronization Plane            | www.o-ran.org/specifications>`__ |
+| Specification                    |                                  |
+| (ORAN-WG4.CUS.0-v02.00)          |                                  |
++----------------------------------+----------------------------------+
+
+
+