docs/api-docs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5
   6 API-Docs
   7 **********
   8
   9 This is the API-docs for D relase o-du/l2.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15
  16 Introduction
  17 -----------------
  18 This document lists the APIs implemented between various modules of ODU-High and their functionality.
  19 These are in line with ORAN-WG8.AAD-v3.00.00, hereafter referred to as AAD Spec.
  20
  21 API Functions
  22 -------------
  23 1. RLC-MAC Interface
  24
  25    - AAD Spec : section 9.2.1
  26
  27    A. RLC to MAC
  28
  29       a. Data Transfer(DL) : Transfers DL data to MAC as per Section 9.2.1.1 of the AAD Spec
  30
  31       b. Buffer Status Reporting(DL) : Reports DL data volume pending in the RLC entity, as per Section 9.2.1.4 of the
  32          AAD Spec
  33
  34    B. MAC to RLC
  35
  36       a. Data Transfer(UL) : Transfers UL data to RLC as per Section 9.2.1.2 of the AAD Spec
  37
  38       b. Schedule Result Reporting (DL) : Reports DL schedule result to RLC as per Section 9.2.1.3 of the AAD Spec
  39
  40 2. MAC-Scheduler Interface
  41
  42    - AAD Spec : section 9.2.2
  43
  44    A. MAC to Scheduler
  45
  46       a. Air Interface Time : Sends timing information over air interface in terms of SFN and slo, as per Section
  47          9.2.2.1.1 of the AAD Spec
  48
  49       b. Cell Configuration Request : MAC provides SCH the cell configuration as per Section 9.2.2.2.1 of the AAD Spec
  50
  51       c. Add UE Configuration Request : MAC provides SCH the configuration/capabilities of a UE as per Section 9.2.2.2.3
  52          of the AAD Spec
  53
  54       d. Modify UE Reconfiguration Request : MAC provides SCH the re-configuration of UE, also used to
  55          add/release/modify existing bearers, as per Section 9.2.2.2.4 of the AAD Spec
  56
  57       e. RACH Indication : MAC receives the RACH Indication and share the contents with SCH as per Section 9.2.2.2.10 of
  58          the AAD Spec
  59
  60       f. DL RLC Buffer Status Information : Reports data volume per LC when it is received at MAC as per Section
  61          9.2.2.2.14 of the AAD Spec
  62
  63       g. UL Buffer Status Report Indication : On reception and decoding of received BSR from the UE, MAC provides SCH
  64          buffer status report for UL scheduling, as per Section 9.2.2.2.16 of the AAD Spec
  65
  66       h. UE Delete Request : MAC receives UE delete request and forwards the request to SCH as per Section 9.2.2.2.5
  67          of the AAD spec.
  68
  69       i. Cell Delete Request :  MAC receives UE delete request and forwards the request to SCH as per Section 9.2.2.2.2
  70          of the AAD spec.
  71
  72    B. Scheduler to MAC
  73
  74       a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.2.3.1 of the
  75          AAD Spec
  76
  77       b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.2.3.3 of the
  78          AAD Spec
  79
  80       c. DL Scheduling Information - Provides scheduling information for a given slot for downlink data, as per Section
  81          9.2.2.3.5 of the AAD spec.
  82
  83       d. UL Scheduling Information - Provides scheduled information for MAC to form the UL_TTI.request towards O-DU Low,
  84          as per Section 9.2.2.3.6 of the AAD Spec.
  85
  86       e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.2.3.7 of
  87          the AAD Spec.
  88
  89       f. Downlink Control Channel Information - Provides DCI scheduling information for a given slot on PDCCH, as per
  90          Section 9.2.2.3.8 of the AAD Spec
  91
  92       g. Downlink Broadcast Allocation - Provides DCI and DL data scheduling information for SIB1 for a given slot for
  93          Broadcast Channel, as per Section 9.2.2.3.9 of the AAD Spec.
  94
  95       h. UE Delete Response - Response to UE delete request from MAC, as per Section 9.2.2.3.4
  96
  97       i. Cell Delete Response - Response to Cell delete response from MAC, as per Section 9.2.2.3.2
  98
  99 3. DU APP - MAC Interface
 100
 101    - AAD Spec : section 9.2.3
 102
 103    A. DU APP to MAC
 104
 105       a. Cell Start - Commands MAC to start cell at L1 and to start broadcasting system information, as per Section
 106          9.2.3.1 of the AAD Spec.
 107
 108       b. UE Create Request - Adds UE information at MAC as per Section 9.2.3.3 of the AAD Spec.
 109
 110       c. UE Reconfiguration Request - Reconfigure UE information for a UE already added at MAC, as per Section 9.2.3.5
 111          of the AAD Spec.
 112
 113       d. DL CCCH Indication - Sends DL CCCH Message to MAC to be sent to UE, as per Section 9.2.3.16 of the AAD Spec.
 114
 115       e. Cell Stop - Commands MAC to stop cell at L1, as per Section 9.2.3.2 of the AAD spec.
 116
 117       f. UE Delete Request - Deletes UE information at MAC as per Section 9.2.3.7  of the AAD Spec.
 118
 119    B. MAC to DU APP
 120
 121       a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.3.4 of the AAD Spec.
 122
 123       b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.3.6 of the
 124          AAD Spec.
 125
 126       c. UL-CCCH Indication - Sends the UL CCCH Message received from UE to DU APP as per Section 9.2.3.15 of AAD Spec.
 127
 128       d. UE Delete Response - Response to UE Delete Request from DU Manager as per Section 9.2.3.8 of the AAD Spec.
 129
 130 4. DU APP - RLC Interface
 131
 132    - AAD Spec : section 9.2.4
 133
 134    A. DU APP to RLC
 135
 136       a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.4.1 of the AAD Spec.
 137
 138       b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.4.3
 139          of the AAD Spec.
 140
 141       c. DL RRC Message Transfer - Requests RLC to deliver RRC message from CU to the UE, as per Section 9.2.4.7 of the
 142          AAD Spec.
 143
 144       d. UE Delete Request - Deletes UE associated RLC entity and related information as per Section 9.2.4.5 of the
 145          AAD Spec.
 146
 147    B. RLC to DU APP
 148
 149       a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.4.3
 150
 151       b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.4.4
 152
 153       c. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.4.8 of the AAD spec.
 154
 155       d. RRC Message Delivery Report - Informs DU Manager on failed/successful delivery of a DL RRC message to UE, as
 156          per Section 9.2.4.9 of the AAD Spec.
 157
 158       e. UE Delete Response - Response to UE Delete Request from DU APP, as per section 9.2.4.6
 159
 160 Additional APIs
 161 ----------------
 162
 163 1. DU APP - MAC Interface
 164
 165    A. DU APP to MAC
 166
 167       a. Cell Configuration Request - Configures cell information at MAC
 168
 169       b. Cell Delete Request - Deletes cell information at MAC
 170
 171    B. MAC to DU APP
 172
 173       a. Cell Configuration Response - Response to Cell Configuration Request from DU APP
 174
 175       b. Cell Delete Response - Response to Cell Delet request from DU APP
 176
 177 2. DU APP - RLC Interface
 178
 179    A. RLC to DU APP
 180
 181       c. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
 182
 183 3. DU APP - O1 Interface
 184
 185    a. Bring cell up - Informs DU to bring a specific cell up
 186    b. Bring cell down - Informs DU to bring specific cell up
 187    c. Set the cell operational state - Sets the cell state to ACTIVE/INACTIVE
 188    d. Raise a cell alarm - Raise an alarm when the cell is ACTIVE/INACTIV