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 Cherry 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-v2.05.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       b. Schedule Result Reporting (DL) : Reports DL schedule result to RLC as per Section 9.2.1.3 of the AAD Spec
  38
  39 2. MAC-Scheduler Interface
  40
  41    - AAD Spec : section 9.2.2
  42
  43    A. MAC to Scheduler
  44
  45       a. Air Interface Time : Sends timing information over air interface in terms of SFN and slo, as per Section
  46          9.2.2.1.1 of the AAD Spec
  47
  48       b. Cell Configuration Request : MAC provides SCH the cell configuration as per Section 9.2.2.2.1 of the AAD Spec
  49
  50       c. Add UE Configuration Request : MAC provides SCH the configuration/capabilities of a UE as per Section 9.2.2.2.3
  51          of the AAD Spec
  52
  53       d. Modify UE Reconfiguration Request : MAC provides SCH the re-configuration of UE, also used to
  54          add/release/modify existing bearers, as per Section 9.2.2.2.4 of the AAD Spec
  55
  56       e. RACH Indication : MAC receives the RACH Indication and share the contents with SCH as per Section 9.2.2.2.10 of
  57          the AAD Spec
  58
  59       f. DL RLC Buffer Status Information : Reports data volume per LC when it is received at MAC as per Section
  60          9.2.2.2.14 of the AAD Spec
  61
  62       g. UL Buffer Status Report Indication : On reception and decoding of received BSR from the UE, MAC provides SCH
  63          buffer status report for UL scheduling, as per Section 9.2.2.2.16 of the AAD Spec
  64
  65    B. Scheduler to MAC
  66
  67       a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.2.3.1 of the
  68          AAD Spec
  69
  70       b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.2.3.3 of the
  71          AAD Spec
  72
  73       c. DL Scheduling Information - Provides scheduling information for a given slot for downlink data, as per Section
  74          9.2.2.3.5 of the AAD spec.
  75
  76       d. UL Scheduling Information - Provides scheduled information for MAC to form the UL_TTI.request towards O-DU Low,
  77          as per Section 9.2.2.3.6 of the AAD Spec.
  78
  79       e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.2.3.7 of
  80          the AAD Spec.
  81
  82       f. Downlink Control Channel Information - Provides DCI scheduling information for a given slot on PDCCH, as per
  83          Section 9.2.2.3.8 of the AAD Spec
  84
  85       g. Downlink Broadcast Allocation - Provides DCI and DL data scheduling information for SIB1 for a given slot for
  86          Broadcast Channel, as per Section 9.2.2.3.9 of the AAD Spec.
  87
  88 3. DU APP - MAC Interface
  89
  90    - AAD Spec : section 9.2.3
  91
  92    A. DU APP to MAC
  93
  94       a. Cell Start - Commands MAC to start cell at L1 and to start broadcasting system information, as per Section
  95          9.2.3.1 of the AAD Spec.
  96
  97       b. UE Create Request - Adds UE information at MAC as per Section 9.2.3.3 of the AAD Spec.
  98
  99       c. UE Reconfiguration Request - Reconfigure UE information for a UE already added at MAC, as per Section 9.2.3.5
 100          of the AAD Spec.
 101
 102       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.
 103
 104    B. MAC to DU APP
 105
 106       a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.3.4 of the AAD Spec.
 107
 108       b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.3.6 of the
 109          AAD Spec.
 110
 111       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.
 112
 113 4. DU APP - RLC Interface
 114
 115    - AAD Spec : section 9.2.4
 116
 117    A. DU APP to RLC
 118
 119       a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.4.1 of the AAD Spec.
 120
 121       b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.4.1
 122          of the AAD Spec.
 123
 124       c. DL RRC Message Transfer - Requests RLC to deliver RRC message from CU to the UE, as per Section 9.2.4.3 of the
 125          AAD Spec.
 126
 127    B. RLC to DU APP
 128
 129       a. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.4.4 of the AAD spec.
 130
 131       b. RRC Message Delivery Report - Informs DU Manager on failed/successful delivery of a DL RRC message to UE, as
 132          per Section 9.2.4.5 of the AAD Spec.
 133
 134 Additional APIs
 135 ----------------
 136
 137 1. DU APP - MAC Interface
 138
 139    A. DU APP to MAC
 140
 141       a. Cell Configuration Request - Configures cell information at MAC
 142
 143    B. MAC to DU APP
 144
 145       a. Cell Configuration Response - Response to Cell Configuration Request from DU APP
 146
 147 2. DU APP - RLC Interface
 148
 149    A. RLC to DU APP
 150
 151       a. UE Create Response - Response to UE Create Request from DU APP
 152
 153       b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP
 154
 155       c. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
 156