docs/fapi_5g_tm_overview.rst

   1 ..    Copyright (c) 2020 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 .. |br| raw:: html
  17
  18    <br />
  19
  20 O-RAN FAPI 5G TM Introduction
  21 =============================
  22
  23 .. contents::
  24     :depth: 3
  25     :local:
  26
  27 The ORAN FAPI 5G Translator Module (TM) is a standalone application that communicates with the ODU-High using the 5G FAPI protocol defined
  28 by the Small Cell Forum and communicates with the ODU Low using the Intel L2-L1 API using the Wireless Subsystem Interface
  29 Library (WLS) to handle the shared memory and buffer management required by the |br|
  30 Interfaces. In addition the ORAN 5G FAPI TM requires the
  31 Data Plane Design Kit (DPDK) which is integrated with the WLS Library.
  32
  33 Table 1. Terminology
  34
  35 +----------+----------------------------------------------------------+
  36 | Term     | Description                                              |
  37 +----------+----------------------------------------------------------+
  38 | API      | Application Platform Interface                           |
  39 +----------+----------------------------------------------------------+
  40 | BBU      | Baseband Unit                                            |
  41 +----------+----------------------------------------------------------+
  42 | CORESET  | Control Resource Set                                     |
  43 +----------+----------------------------------------------------------+
  44 | DOS      | Denial of Service Attack                                 |
  45 +----------+----------------------------------------------------------+
  46 | DPDK     | Data Plane Design Kit                                    |
  47 +----------+----------------------------------------------------------+
  48 | eNb      | Enode B                                                  |
  49 +----------+----------------------------------------------------------+
  50 | EPC      | Evolved Packet Core                                      |
  51 +----------+----------------------------------------------------------+
  52 | EVM      | Error Vector magnitude                                   |
  53 +----------+----------------------------------------------------------+
  54 | FAPI     | Functional Application Platform Interface                |
  55 +----------+----------------------------------------------------------+
  56 | gNB      | Next generation eNB or g Node B                          |
  57 +----------+----------------------------------------------------------+
  58 | IQ       | In-phase and in-quadrature                               |
  59 +----------+----------------------------------------------------------+
  60 | ISA      | Intel Software Architecture i.e. AVX2, AVX256, AVX512    |
  61 +----------+----------------------------------------------------------+
  62 | MAC      | Medium Access Control                                    |
  63 +----------+----------------------------------------------------------+
  64 | MIB      | Master Information Block                                 |
  65 +----------+----------------------------------------------------------+
  66 | nFAPI    | Network FAPI (Between VNF(L2/L3) and PNF(L1))            |
  67 +----------+----------------------------------------------------------+
  68 | PDU      | Protocol Data Unit                                       |
  69 +----------+----------------------------------------------------------+
  70 | PHY      | Physical Layer Processing                                |
  71 +----------+----------------------------------------------------------+
  72 | PMD      | Poll Mode Driver                                         |
  73 +----------+----------------------------------------------------------+
  74 | PNF      | Physical Network Function                                |
  75 +----------+----------------------------------------------------------+
  76 | PSS      | Primary Synchronization Signal                           |
  77 +----------+----------------------------------------------------------+
  78 | QPSK     | Quadrature Phase Shift Keying                            |
  79 +----------+----------------------------------------------------------+
  80 | RAN      | Radio Access Network                                     |
  81 +----------+----------------------------------------------------------+
  82 | RE       | Radio Equipment                                          |
  83 +----------+----------------------------------------------------------+
  84 | REC      | Radio Equipment Control                                  |
  85 +----------+----------------------------------------------------------+
  86 | ROE      | Radio Over Ethernet                                      |
  87 +----------+----------------------------------------------------------+
  88 | RX or Rx | Receive                                                  |
  89 +----------+----------------------------------------------------------+
  90 | SCF      | Small Cell Forum                                         |
  91 +----------+----------------------------------------------------------+
  92 | SFN      | System Frame Number ∈ {0,…,1023}                         |
  93 +----------+----------------------------------------------------------+
  94 | SIB      | System Information Block                                 |
  95 +----------+----------------------------------------------------------+
  96 | SSS      | Secondary Synchronization Signal                         |
  97 +----------+----------------------------------------------------------+
  98 | TLV      | Type Length Value                                        |
  99 +----------+----------------------------------------------------------+
 100 | TX or Tx | Transmit                                                 |
 101 +----------+----------------------------------------------------------+
 102 | U-Plane  | User Plane                                               |
 103 +----------+----------------------------------------------------------+
 104 | URLLC    | Ultra Reliable Low Latency Coding                        |
 105 +----------+----------------------------------------------------------+
 106 | VNF      | Virtual Network Function                                 |
 107 +----------+----------------------------------------------------------+
 108 | WLS      | Wireless Subsystem Interface                             |
 109 +----------+----------------------------------------------------------+
 110 | WLS_DPDK | WLS that uses DPDK functions instead of accessing kernel |
 111 |          | functions                                                |
 112 +----------+----------------------------------------------------------+
 113
 114
 115 Reference Documents
 116 -------------------
 117
 118 Table 2. Reference Documents
 119
 120 +-------------------------------------+-------------------------------+
 121 | Document                            | Document                      |
 122 |                                     | No./Location                  |
 123 +-------------------------------------+-------------------------------+
 124 | 1) FlexRAN 5G New Radio Reference   | CDI 603575   Intel Corp.      |
 125 |    Solution L1-L2 API Specification |                               |
 126 |    July 2019                        |                               |
 127 +-------------------------------------+-------------------------------+
 128 | 2) 5G FAPI:PHY API Specification,   | 222.10.02/ smallcellforum.org |
 129 |    Version 1.0.5, March 2020        |                               |
 130 +-------------------------------------+-------------------------------+
 131
 132
 133 Translator Module Top Level Design
 134 ==================================
 135
 136 The following diagram illustrates the different functions and components
 137 used by this module and how it interconnects to the L2 and L1 layers.
 138
 139 Figure 1. ORAN 5G FAPI Translator Module Top Level Architecture
 140
 141
 142 .. image:: images/fapi_tm_architecture.jpg
 143   :width: 900
 144   :alt: Figure 1. ORAN 5G FAPI TM
 145
 146 Figure 1. ORAN 5G FAPI TM Top Level Diagram
 147
 148 The Translator Module consists of the following functions:
 149
 150 -  A 5G FAPI Parser facing the L2 interface.
 151
 152 -  An Inter API Mapper and Logic.
 153
 154 -  An Intel API Parser facing the L1 interface.
 155
 156 -  WLS dpdk based library supporting 2 instances.