First round of documentation cleanup for oran_e_maintenance_release_v1.0
[o-du/phy.git] / docs / overview1.rst
index abb4c79..e425df7 100644 (file)
@@ -1,4 +1,4 @@
-..    Copyright (c) 2019 Intel
+..    Copyright (c) 2019-2022 Intel
 ..
 ..  Licensed under the Apache License, Version 2.0 (the "License");
 ..  you may not use this file except in compliance with the License.
@@ -23,10 +23,8 @@ O-DU Low Project Introduction
     :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 \
+The O-DU low project focus on the baseband PHY Reference Design, which uses Xeon® series Processor with Intel Architecture. This 5GNR Reference PHY consists of a L1 binary \
+and three kinds of interfaces which are validated on a 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 \ 
@@ -63,102 +61,226 @@ 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                            |
-+--------+------------------------------------------------------------+
++---------+-----------------------------------------------------------+
+| Term    | Description                                               |
++=========+===========================================================+
+| 5G NR   | Fifth Generation New Radio                                |
++---------+-----------------------------------------------------------+
+| ACS     | Access Control system                                     |
++---------+-----------------------------------------------------------+
+| API     | Application Programming Interface                         |
++---------+-----------------------------------------------------------+
+| BOM     | Bill of Materials                                         |
++---------+-----------------------------------------------------------+
+| CP      | Cyclic Prefix                                             |
++---------+-----------------------------------------------------------+
+| DDP     | Dynamic Device Personalization                            |
++---------+-----------------------------------------------------------+
+| DPDK    | Data Plane Development Kit                                |
++---------+-----------------------------------------------------------+
+| eAxC    | Extended Antenna Carrier                                  |
++---------+-----------------------------------------------------------+
+| eCPRI   | Enhanced Common Public Radio Interface                    |
++---------+-----------------------------------------------------------+
+| eNB     | Enode B                                                   |
++---------+-----------------------------------------------------------+
+| ETH     | Ethernet                                                  |
++---------+-----------------------------------------------------------+
+| FCS     | Frame Check Sequence                                      |
++---------+-----------------------------------------------------------+
+| FEC     | Forward Error Correction                                  |
++---------+-----------------------------------------------------------+
+| FFT     | Fast Fourier Transform                                    |
++---------+-----------------------------------------------------------+
+| FH      | Front Haul                                                |
++---------+-----------------------------------------------------------+
+| gNB     | Next-generation NodeB also named as Base Station          |
++---------+-----------------------------------------------------------+
+| GNSS    | Global Navigation Satellite System                        |
++---------+-----------------------------------------------------------+
+| GPS     | Global Positioning System                                 |
++---------+-----------------------------------------------------------+
+| HARQ    | Hybrid Automatic Repeat Request                           |
++---------+-----------------------------------------------------------+
+| HW      | Hardware                                                  |
++---------+-----------------------------------------------------------+
+| IFG     | Interframe Gap                                            |
++---------+-----------------------------------------------------------+
+| IFFT    | Inverse Fast Fourier Transform                            |
++---------+-----------------------------------------------------------+
+| IoT     | Inter-Operability Testing                                 |
++---------+-----------------------------------------------------------+
+| IQ      | In-band and Quadrature                                    |
++---------+-----------------------------------------------------------+
+| LAA     | License Assisted Access                                   |
++---------+-----------------------------------------------------------+
+| LTE     | Long Term Evolution                                       |
++---------+-----------------------------------------------------------+
+| MAC     | Media Access Control                                      |
++---------+-----------------------------------------------------------+
+| MEC     | Mobile Edge Computing                                     |
++---------+-----------------------------------------------------------+
+| M-Plane | Management Plane                                          |
++---------+-----------------------------------------------------------+
+| mmWave  | Millimeter Wave                                           |
++---------+-----------------------------------------------------------+
+| 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).                                              |
++---------+-----------------------------------------------------------+
+| OWD     | One Way Delay                                             |
++---------+-----------------------------------------------------------+
+| PDCCH   | Physical Downlink Control Channel                         |
++---------+-----------------------------------------------------------+
+| PDSCH   | Physical Downlink Shared Channel                          |
++---------+-----------------------------------------------------------+
+| PHC     | Physical Hardware Clock                                   |
++---------+-----------------------------------------------------------+
+| PHP     | Hypetext Preprocessor                                     |
++---------+-----------------------------------------------------------+
+| PMD     | Poll Mode Driver                                          |
++---------+-----------------------------------------------------------+
+| POSIX   | Portable Operating System Interface                       |
++---------+-----------------------------------------------------------+
+| PRACH   | Physical Random Access Channel                            |
++---------+-----------------------------------------------------------+
+| PRB     | Physical Resource Block                                   |
++---------+-----------------------------------------------------------+
+| PRTC    | Protected Real Time Clock                                 |
++---------+-----------------------------------------------------------+
+| 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                                          |
++---------+-----------------------------------------------------------+
+| RLC     | Radio Link Control                                        |
++---------+-----------------------------------------------------------+
+| RoE     | Radio over Ethernet                                       |
++---------+-----------------------------------------------------------+
+| RT      | Real Time                                                 |
++---------+-----------------------------------------------------------+
+| RTE     | Real Time Environment                                     |
++---------+-----------------------------------------------------------+
+| RSS     | Receive Side Scaling                                      |
++---------+-----------------------------------------------------------+
+| RU      | Radio Unit                                                |
++---------+-----------------------------------------------------------+
+| SR-IOV  | Single Root Input/Output Virtualization                   |
++---------+-----------------------------------------------------------+
+| SW      | Software                                                  |
++---------+-----------------------------------------------------------+
+| SyncE   | Synchronous Ethernet                                      |
++---------+-----------------------------------------------------------+
+| TDD     | Time Division Duplex                                      |
++---------+-----------------------------------------------------------+
+| ToS     | Top of the Second                                         |
++---------+-----------------------------------------------------------+
+| TSC     | Time Stamp Counter                                        |
++---------+-----------------------------------------------------------+
+| TTI     | Transmission Time Interval                                |
++---------+-----------------------------------------------------------+
+| UE      | User Equipment                                            |
++---------+-----------------------------------------------------------+
+| UL      | Uplink                                                    |
++---------+-----------------------------------------------------------+
+| VF      | Virtual Function                                          |
++---------+-----------------------------------------------------------+
+| VIM     | Virtual Infrastructure Manager                            |
++---------+-----------------------------------------------------------+
+| VLAN    | Virtual Local Area Network                                |
++---------+-----------------------------------------------------------+
+| VM      | Virtual Machine                                           |
++---------+-----------------------------------------------------------+
+| WLS     | Wireless Subsystem Interface                              |
++---------+-----------------------------------------------------------+
+| xRAN    | Extensible Radio Access Network                           |
++---------+-----------------------------------------------------------+
 
 Reference Documents
 -------------------
 
 Table 2. Reference Documents
 
-+----------------------------------+--------------------------------------------------------------------------------+
-| Document or Reference            | Document No./                                                                  |
-|                                  | Location                                                                       |
-+----------------------------------+--------------------------------------------------------------------------------+
-| 3GPP\* specification series      | http://www.3gpp.org/DynaReport/38-series.htm                                   |
-+----------------------------------+----------------------------------+---------------------------------------------+
-| Wolf Pass Server Documentation   | https://ark.intel.com/products/codename/80739/Wolf-Pass                        |
-+----------------------------------+----------------------------------+---------------------------------------------+
-| *Intel® C++ Compiler             | https://software.intel.com/en-us/system-studio/choose-download                 |
-| system Studio XE*                |                                                                                |
-+----------------------------------+--------------------------------------------------------------------------------+
-| DPDK documentation               | http://dpdk.org/doc/guides/                                                    |
-+----------------------------------+--------------------------------------------------------------------------------+
-| O-RAN Fronthaul Working Group    | https://www.o-ran.org/specifications                                           |
-| Control, User and                |                                                                                |
-| Synchronization Plane            |                                                                                |
-| Specification                    |                                                                                |
-| (ORAN-WG4.CUS.0-v02.00)          |                                                                                |
-+----------------------------------+--------------------------------------------------------------------------------+
++----------------------------------+-------------------------------------+
+| Document                         | Document                            |
+|                                  | No./Location                        |
++==================================+=====================================+
+|| *FlexRAN Reference Solution*    | 575822                              |
+|| *Software Release Notes*        |                                     |
++----------------------------------+-------------------------------------+
+|| *FlexRAN Reference Solution L1* | 571741                              |
+|| *XML Configuration User Guide*  |                                     |
++----------------------------------+-------------------------------------+
+|| *FlexRAN Reference Solution LTE*| 571742                              |
+|| *eNB L2-L1 Application*         |                                     |
+|| *Programming Interface [API]*   |                                     |
+|| *Specification*                 |                                     |
++----------------------------------+-------------------------------------+
+|| *FlexRAN Reference Solution*    | 576423                              |
+|| *L2-L1 nFAPI Specification*     |                                     |
++----------------------------------+-------------------------------------+
+|| *FlexRAN and Mobile Edge*       | 575891                              |
+|| *Compute(MEC) Platform*         |                                     |
+|| *Setup Guide*                   |                                     |
++----------------------------------+-------------------------------------+
+|| *FlexRAN 5G NR Reference*       | 603577                              |
+|| *Solution RefPHY (Doxygen).*    |                                     |
++----------------------------------+-------------------------------------+
+|| *Intel® Ethernet Controller*    | 617015                              |
+|| *E810*                          |                                     |
+|                                  |                                     |
+|| *Dynamic Device*                |                                     |
+|| *Personalization (DDP)*         |                                     |
+|| *Technology Guide*              |                                     |
++----------------------------------+-------------------------------------+
+| *3GPP\* specification series*    | https://www.3gpp.org/specifications |
+|                                  |                                     |
++----------------------------------+-------------------------------------+
+| *Wolf Pass Server Documentation* |                                     |
++----------------------------------+-------------------------------------+
+| *Intel® C++ Compiler in Intel®   |                                     |
+| Parallel Studio XE*              |                                     |
++----------------------------------+-------------------------------------+
+| *DPDK documentation*             | https://core.dpdk.org/doc/          |
++----------------------------------+-------------------------------------+
+|| *O-RAN Fronthaul Working Group* | https://www.o-ran.org/specifications|
+|| *Control, User and*             |                                     |
+|| *Synchronization Plane*         |                                     |
+|| *Specification*                 |                                     |
+|| *(ORAN-WG4.CUS.0-v04.00)*       |                                     |
++----------------------------------+-------------------------------------+
+| *ORAN Specifications*            | https://www.o-ran.org/specifications|
+|                                  |                                     |
++----------------------------------+-------------------------------------+
+|| *IEEE-1588-2008 IEEE Standard*  | https://standards.ieee.org/         |
+|| *for a Precision Clock*         | standard/1588-2008.html             |
+|| *Synchronization Protocol for*  |                                     |
+|| *Networked Measurement and*     |                                     |
+|| *Control Systems*               |                                     |
++----------------------------------+-------------------------------------+
+|| *eCPRI Specification V2.0*      || https://www.networkdatapedia.com// |
+|| *Interface Specification*       || post/2019/10/05/capturing-/        |
+|                                  || packets-through-ecpri-v20/         |
+|                                  || -which-enables-5g                  |
+|                                  |                                     |
++----------------------------------+-------------------------------------+