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