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 F release 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-v5.00.00, hereafter referred to as AAD Spec.
  20
  21 Note: DU APP module consist functionality related to F1 Handler and O1 Handler
  22
  23 API Functions
  24 -------------
  25 1. RLC-MAC Interface
  26
  27    - AAD Spec : section 9.2.2
  28
  29    A. RLC to MAC
  30
  31       a. Data Transfer(DL) : Transfers DL data to MAC as per Section 9.2.2.1 of the AAD Spec
  32
  33       b. Buffer Status Reporting(DL) : Reports DL data volume pending in the RLC entity, as per Section 9.2.2.4 of the
  34          AAD Spec
  35
  36    B. MAC to RLC
  37
  38       a. Data Transfer(UL) : Transfers UL data to RLC as per Section 9.2.2.2 of the AAD Spec
  39
  40       b. Schedule Result Reporting (DL) : Reports DL schedule result to RLC as per Section 9.2.2.3 of the AAD Spec
  41
  42 2. MAC-Scheduler Interface
  43
  44    - AAD Spec : section 9.2.3
  45
  46    A. MAC to Scheduler
  47
  48       a. Air Interface Time : Sends timing information over air interface in terms of SFN and slo, as per Section
  49          9.2.3.1.1 of the AAD Spec.
  50
  51       b. Cell Configuration Request : MAC provides SCH the cell configuration as per Section 9.2.3.2.1 of the AAD Spec.
  52
  53       c. Add UE Configuration Request : MAC provides SCH the configuration/capabilities of a UE as per Section 9.2.3.2.5 of the AAD Spec.
  54
  55       d. Modify UE Reconfiguration Request : MAC provides SCH the re-configuration of UE, also used to
  56          add/release/modify existing bearers, as per Section 9.2.3.2.6 of the AAD Spec.
  57
  58       e. RACH Indication : MAC receives the RACH Indication and share the contents with SCH as per Section 9.2.3.2.12 of 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.3.2.16 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.3.2.18 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.3.2.7
  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.3.2.2
  70          of the AAD Spec.
  71
  72       j. Slice Configuration Request : MAC receives Slice Configuration request and forwards the request to SCH as per Section
  73          9.2.3.2.3 of the AAD Spec.
  74
  75       k. Slice Reconfiguration Request : MAC receives Slice Reconfiguration request and forwards the request to SCH as per
  76          Section 9.2.3.2.4 of the AAD Spec.
  77
  78       l. Paging Indication : MAC receives Paging Indication and forwards the trigger to SCH as per Section 9.2.3.2.13 of the AAD Spec.
  79
  80       m. RACH Resource Request : MAC receives RACH Resource Request for dedicated RACH resource allocation and forwards to SCH as per
  81          Section 9.2.3.2.14 of the AAD Spec.
  82
  83       n. RACH Resource Release : MAC receives RACH Resource Release from DU APP and forwards to SCH as per Section 9.2.3.2.15 of the
  84          AAD Spec.
  85
  86       o. DL HARQ Indication : MAC receives UCI Indication and forwards any DL HARQ feedback from UE to SCH as per Sectiion 9.2.3.2.8
  87          of the AAD spec.
  88
  89       p. UL HARQ CRC Indication : MAC receives CRC Indication from PHY and forwards the decoded results to SCH as per Section
  90          9.2.3.2.9 of the AAD Spec.
  91
  92    B. Scheduler to MAC
  93
  94       a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.3.3.1 of the AAD Spec.
  95
  96       b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.3.3.6 of the AAD Spec.
  97
  98       c. DL Scheduling Information - Provides scheduling information for a given slot for downlink data, as per Section
  99          9.2.3.3.8 of the AAD spec.
 100
 101       d. UL Scheduling Information - Provides scheduled information for MAC to form the UL_TTI.request towards O-DU Low,
 102          as per Section 9.2.3.3.9 of the AAD Spec.
 103
 104       e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.3.3.10 of the AAD Spec.
 105
 106       f. Downlink Control Channel Information - Provides DCI scheduling information for a given slot on PDCCH, as per
 107          Section 9.2.3.3.11 of the AAD Spec.
 108
 109       g. Downlink Broadcast Allocation - Provides DCI and DL data scheduling information for SIB1 for a given slot for
 110          Broadcast Channel, as per Section 9.2.3.3.12 of the AAD Spec.
 111
 112       h. UE Delete Response - Response to UE delete request from MAC, as per Section 9.2.3.3.7 of the AAD Spec.
 113
 114       i. Cell Delete Response - Response to Cell delete request from MAC, as per Section 9.2.3.3.2 of the AAD Spec.
 115
 116       j. Slice Configuration Response : Response to Slice Configuration request from MAC, as per Section 9.2.3.3.3 of the AAD Spec.
 117
 118       k. Slice Reconfiguration Response : Response to Slice Reconfiguration request from MAC, as per Section 9.2.3.3.4 of the AAD Spec.
 119
 120       l. Downlink Paging Allocation :  Provides DCI and DL data scheduling information for any Paging queued for a given slot
 121          for Paging Channel, as per Section 9.2.3.3.13 of the AAD Spec.
 122
 123
 124 3. DU APP - MAC Interface
 125
 126    - AAD Spec : section 9.2.4
 127
 128    A. DU APP to MAC
 129
 130       a. Cell Start - Commands MAC to start cell at L1 and to start broadcasting system information, as per Section
 131          9.2.4.1 of the AAD Spec.
 132
 133       b. UE Create Request - Adds UE information at MAC as per Section 9.2.4.3 of the AAD Spec.
 134
 135       c. UE Reconfiguration Request - Reconfigure UE information for a UE already added at MAC, as per Section 9.2.4.5 of the AAD Spec.
 136
 137       d. DL CCCH Indication - Sends DL CCCH Message to MAC to be sent to UE, as per Section 9.2.4.16 of the AAD Spec.
 138
 139       e. Cell Stop - Commands MAC to stop cell at L1, as per Section 9.2.4.2 of the AAD spec.
 140
 141       f. UE Delete Request - Deletes UE information at MAC as per Section 9.2.4.7  of the AAD Spec.
 142
 143       g. DL PCCH Indication - Sends DL PCCH Message to MAC for any Paging scheduled on a slot, as per Section 9.2.4.17 of the AAD Spec.
 144
 145       h. RACH Resource Request - Requests for dedicated RACH resources for CF-RA with a UE, as per Section 9.2.4.9 of the AAD Spec.
 146
 147       i. RACH Resource Release - Releases dedicated RACH resources allocated for a UE for CF-RA, as per Section 9.2.4.11 of the AAD Spec.
 148
 149    B. MAC to DU APP
 150
 151       a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.4.4 of the AAD Spec.
 152
 153       b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.4.6 of the
 154          AAD Spec.
 155
 156       c. UL-CCCH Indication - Sends the UL CCCH Message received from UE to DU APP as per Section 9.2.4.15 of AAD Spec.
 157
 158       d. UE Delete Response - Response to UE Delete Request from DU Manager as per Section 9.2.4.8 of the AAD Spec.
 159
 160       e. RACH Resource Response - Responds with dedicated resources allocated for CF-RA for a UE, as per Section 9.2.4.10 of the AAD Spec.
 161
 162 4. DU APP - RLC Interface
 163
 164    - AAD Spec : section 9.2.5
 165
 166    A. DU APP to RLC
 167
 168       a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.5.1 of the AAD Spec.
 169
 170       b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.5.3 of the AAD Spec.
 171
 172       c. DL RRC Message Transfer - Requests RLC to deliver RRC message from CU to the UE, as per Section 9.2.5.7 of the AAD Spec.
 173
 174       d. UE Delete Request - Deletes UE associated RLC entity and related information as per Section 9.2.5.5 of the  AAD Spec.
 175
 176    B. RLC to DU APP
 177
 178       a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.5.3 of the AAD Spec.
 179
 180       b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.5.4 of the AAD Spec.
 181
 182       c. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.5.8 of the AAD spec.
 183
 184       d. RRC Message Delivery Report - Informs DU Manager on failed/successful delivery of a DL RRC message to UE, as
 185          per Section 9.2.5.9 of the AAD Spec.
 186
 187       e. UE Delete Response - Response to UE Delete Request from DU APP, as per section 9.2.5.6 of the AAD Spec.
 188
 189 5. SMO-OAM - DU APP
 190
 191    - AAD Spec: Section 9.2.1
 192
 193    A. SMO-OAM to DU APP
 194
 195       a. Cell Configuration - Sends Basic Cell Configurations to DU APP as per Section 9.2.1.1 of the AAD Spec.
 196
 197       b. Slice Configuration - Sends Slice Configurations to DU APP as per Section 9.2.1.2 of the AAD Spec.
 198
 199 Additional APIs
 200 ----------------
 201
 202 1. DU APP - MAC Interface
 203
 204    A. DU APP to MAC
 205
 206       a. Cell Configuration Request - Configures cell information at MAC.
 207
 208       b. Cell Delete Request - Deletes cell information at MAC.
 209
 210       c. Slice Configuration Request : Triggers Slice Configuration request once received from O1 towards MAC.
 211
 212       d. Slice Reconfiguration Request : Triggers Slice Reconfiguration request once received from O1 towards MAC.
 213
 214    B. MAC to DU APP
 215
 216       a. Cell Configuration Response - Response to Cell Configuration Request from DU APP
 217
 218       b. Cell Delete Response - Response to Cell Delet request from DU APP
 219
 220       c. Slice Configuration Respone :  Response to Slice Configuration request from DU Manager.
 221
 222       d. Slice Reconfiguration Request : Response to Slice Reconfiguration request from DU Manager.
 223
 224       e. Slot Indication : Indication about the ongoing SFN and Slot information to DU APP.
 225
 226 2. DU APP - RLC Interface
 227
 228    A. RLC to DU APP
 229
 230       a. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
 231
 232       b. Slice Performance Metrics - Sends PM to DU APP every 60sec for every Slice configured.
 233
 234
 235 3. DU APP - SMO-OAM
 236
 237    a. Bring cell up - Informs DU to bring a specific cell up
 238
 239    b. Bring cell down - Informs DU to bring specific cell up
 240
 241    c. Set the cell operational state - Sets the cell state to ACTIVE/INACTIVE
 242
 243    d. Raise a cell alarm - Raise an alarm when the cell is ACTIVE/INACTIVE
 244
 245    e. Slice PM - DU APP sends PM for all Slices in 60sec duration.
 246
 247 4. MAC - SCH Interface
 248
 249    A. SCH to MAC
 250
 251       a. RACH Resource Response : Response to RACH Resource Request for dedicated resource for CF-RA
 252
 253       b. HARQ Process Release : SCH indicates MAC to release a HARQ process in case a positive acknowledement is received or maximum retransmissions are done already.