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 H release o-du/l2.
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15
  16 Introduction
  17 -----------------
  18 This document tabulates the APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of
  19 ODU-High and their functionality.
  20 These are in line with ORAN-WG8.AAD-v7.00.00, hereafter referred to as AAD Spec.
  21
  22 Note: DU APP module consist functionality related to F1 Handler and O1 Handler
  23
  24 API Table
  25 -----------
  26 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
  27 | Interface  |    API                        | Status          | Section   | Remark                                  |
  28 +============+===============================+=================+===========+=========================================+
  29 |            |Cell Configuration             | Aligned         |11.2.1.1   |                                         |
  30 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  31 |            |Slice Configuration            | Aligned         |11.2.1.2   |                                         |
  32 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  33 |            |Bring Cell Up                  | Additional API  |           |Notify DU to bring specific cell up      |
  34 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  35 |**SMO-OAM** |Bring Cell Down                | Additional API  |           |Notify DU to bring specific cell down    |
  36 |& **DU APP**+-------------------------------+-----------------+-----------+-----------------------------------------+
  37 |            |Slice PM                       | Additional API  |           |DU APP sends PM for all Slices every 60s |
  38 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  39 |            |Raise Cell Alarm               | Additional API  |           |DU APP alarms during cell state change   |
  40 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  41 |            |Set the cell operational state | Additional API  |           |DU APP inform cell state[ACTIVE/INACTIVE]|
  42 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
  43 |            |DL Transfer                    | Aligned         |11.2.3.1   |                                         |
  44 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  45 |            |UL Transfer                    | Aligned         |11.2.3.2   |                                         |
  46 | **RLC**    +-------------------------------+-----------------+-----------+-----------------------------------------+
  47 | & **MAC**  |Schedule Result Reporting(DL)  | Aligned         |11.2.3.3   |                                         |
  48 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  49 |            |Buffer Status Report(UL)       | Aligned         |11.2.3.4   |                                         |
  50 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
  51 |            |Air Interface Time             | Aligned         |11.2.4.1.1 |                                         |
  52 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  53 |            |Cell Configuration Request     | Aligned         |11.2.4.2.1 |                                         |
  54 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  55 |            |Cell Delete Request            | Aligned         |11.2.4.2.2 |                                         |
  56 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  57 |            |Slice Configuration Request    | Aligned         |11.2.4.2.3 |                                         |
  58 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  59 |            |Slice Reconfiguration Request  | Aligned         |11.2.4.2.4 |                                         |
  60 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  61 |            |Add UE Configuration Request   | Aligned         |11.2.4.2.5 |                                         |
  62 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  63 |            |UE Reconfiguration Request     | Aligned         |11.2.4.2.6 |                                         |
  64 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  65 |            |Delete UE Request              | Aligned         |11.2.4.2.7 |                                         |
  66 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  67 |            |DL HARQ Indication             | Aligned         |11.2.4.2.8 |                                         |
  68 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  69 |            |UL Harq Indication(CRC)        | Aligned         |11.2.4.2.9 |                                         |
  70 | **MAC** to +-------------------------------+-----------------+-----------+-----------------------------------------+
  71 |  **SCH**   |UL Channel Quality Information | Not Implemented |11.2.4.2.10|                                         |
  72 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  73 |            |DL Channel Quality Information | Not Impelemented|11.2.4.2.11|                                         |
  74 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  75 |            |RACH Indication Contents       | Aligned         |11.2.4.2.12|                                         |
  76 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  77 |            |Paging Indication Contents     | Aligned         |11.2.4.2.13|                                         |
  78 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  79 |            |RACH Resource Request          | Aligned         |11.2.4.2.14|                                         |
  80 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  81 |            |RACH Resource Release          | Aligned         |11.2.4.2.15|                                         |
  82 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  83 |            |DL RLC Buffer Status Info      | Aligned         |11.2.4.2.16|                                         |
  84 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  85 |            |Scheduling Request Indication  | Aligned         |11.2.4.2.17|                                         |
  86 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  87 |            |UL Buffer Status Report Ind    | Aligned         |11.2.4.2.18|                                         |
  88 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  89 |            |Power Headroom Indication      | Aligned         |11.2.4.2.19|                                         |
  90 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
  91 |            |Cell Configuration Response    | Aligned         |11.2.4.3.1 |                                         |
  92 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  93 |            |Cell Delete Response           | Aligned         |11.2.4.3.2 |                                         |
  94 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  95 |            |Slice Configuration Response   | Aligned         |11.2.4.3.3 |                                         |
  96 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  97 |            |Slice ReConfiguration Response | Aligned         |11.2.4.3.4 |                                         |
  98 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
  99 |            |UE Configuration Response      | Aligned         |11.2.4.3.5 |                                         |
 100 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 101 |            |UE ReConfiguration Response    | Aligned         |11.2.4.3.6 |                                         |
 102 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 103 |            |UE Delete Response             | Aligned         |11.2.4.3.7 |                                         |
 104 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 105 | **SCH** to |DL Scheduling Information      | Aligned         |11.2.4.3.8 |                                         |
 106 |    **MAC** +-------------------------------+-----------------+-----------+-----------------------------------------+
 107 |            |UL Scheduling Information      | Aligned         |11.2.4.3.9 |                                         |
 108 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 109 |            |RAR Information                | Not Required    |11.2.4.3.10|Included in DL Scheduling Info           |
 110 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 111 |            |Downlink Control Channel Info  | Not Required    |11.2.4.3.11|Included in DL Scheduling Info           |
 112 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 113 |            |Downlink Broadcast Allocation  | Not Required    |11.2.4.3.12|Included in DL Scheduling Info           |
 114 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 115 |            |Downlink Paging Allocation     | Aligned         |11.2.4.3.13|                                         |
 116 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 117 |            |HARQ Process Release           | Additional API  |           |SCH indicates MAC to release a HARQ      |
 118 |            |                               |                 |           |process in case a positive acknowledement|
 119 |            |                               |                 |           |is received or achieved maximum retrans. |
 120 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 121 |            |RACH Resource Response         | Additional API  |           |Response to RACH Resource Request for    |
 122 |            |                               |                 |           |dedicated resource for CF-RA             |
 123 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
 124 |            |Cell Start                     | Aligned         |1.1.1.1    |                                         |
 125 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 126 |            |Cell Stop                      | Aligned         |1.1.1.2    |                                         |
 127 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 128 |            |Cell Configuration Request     | Additional API  |           |Configures cell information at MAC.      |
 129 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 130 |            |Cell Configuration Response    | Additional API  |           |Response to cell Cfg Req from DUAPP      |
 131 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 132 |            |Cell Delete Request            | Additional API  |           |Deletes cell information at MAC.         |
 133 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 134 |            |Cell Delete Response           | Additional API  |           |Response to Cell Del request from DU APP |
 135 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 136 |            |Slice Configuration Request    | Additional API  |           |Configures Slice at MAC                  |
 137 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 138 |            |Slice ReConfiguration Request  | Additional API  |           |ReConfigures Slice at MAC                |
 139 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 140 |            |Slice Configuration Response   | Additional API  |           |Response to Slice Cfg req from DU APP    |
 141 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 142 |            |Slice ReConfiguration Response | Additional API  |           |Response to Slice ReCfg req from DU APP  |
 143 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 144 |**DU APP**  |UE Create Request              | Aligned         |1.1.1.3    |                                         |
 145 | & **MAC**  +-------------------------------+-----------------+-----------+-----------------------------------------+
 146 |            |UE Create Response             | Aligned         |1.1.1.4    |                                         |
 147 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 148 |            |UE Reconfiguration Request     | Aligned         |1.1.1.5    |                                         |
 149 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 150 |            |UE Reconfiguration Response    | Aligned         |1.1.1.6    |                                         |
 151 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 152 |            |UE Delete Request              | Aligned         |1.1.1.7    |                                         |
 153 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 154 |            |UE Delete Response             | Aligned         |1.1.1.8    |                                         |
 155 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 156 |            |RACH Resource Request          | Aligned         |1.1.1.9    |                                         |
 157 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 158 |            |RACH Resource Response         | Aligned         |1.1.1.10   |                                         |
 159 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 160 |            |RACH Resource Release          | Aligned         |1.1.1.11   |                                         |
 161 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 162 |            |UE Reset Request               | Not Implemented |1.1.1.12   |                                         |
 163 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 164 |            |UE Reset Response              | Not Implemented |1.1.1.13   |                                         |
 165 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 166 |            |UE Sync Status Indication      | Not Implemented |1.1.1.14   |                                         |
 167 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 168 |            |UL CCCH Indication             | Aligned         |1.1.1.15   |                                         |
 169 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 170 |            |DL CCCH Indication             | Aligned         |1.1.1.16   |                                         |
 171 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 172 |            |DL PCCH Indication             | Aligned         |1.1.1.17   |                                         |
 173 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 174 |            |DL Broadcast Request           | Not Implemented |1.1.1.18   |                                         |
 175 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 176 |            |Slot Indication                | Additional API  |           |Indication about the ongoing SFN and     |
 177 |            |                               |                 |           | Slot information to DU APP              |
 178 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
 179 |            |UE Create                      | Aligned         |11.2.5.1   |                                         |
 180 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 181 |            |UE Create Response             | Aligned         |11.2.5.2   |                                         |
 182 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 183 |            |UE Reconfiguration             | Aligned         |11.2.5.3   |                                         |
 184 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 185 |            |UE Reconfiguration Response    | Aligned         |11.2.5.4   |                                         |
 186 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 187 |            |UE Delete                      | Aligned         |11.2.5.5   |                                         |
 188 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 189 |            |UE Delete Response             | Aligned         |11.2.5.6   |                                         |
 190 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 191 |            |DL-RRC Message Transfer        | Aligned         |11.2.5.7   |                                         |
 192 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 193 |            |UL-RRC Message Transfer        | Aligned         |11.2.5.8   |                                         |
 194 |**DU APP**  +-------------------------------+-----------------+-----------+-----------------------------------------+
 195 |  & **RLC** |UL-RRC Message Delivery Report | Aligned         |11.2.5.9   |                                         |
 196 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 197 |            |RLC Max Retransmission Reached | Not Implemented |11.2.5.10  |                                         |
 198 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 199 |            |UL-RLC Re-establishment Request| Not Implemented |11.2.5.11  |                                         |
 200 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 201 |            |UL-RLC Re-establshment Response| Not Implemented |11.2.5.12  |                                         |
 202 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 203 |            |DL RRC Message Response        | Additional API  |           |Informs DU APP if a DL RRC Message was   |
 204 |            |                               |                 |           |successfuly procesed at RLC & sent to MAC|
 205 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 206 |            |DL User Data                   | Additional API  |           |DL user data exchanged from DUAPP to RLC |
 207 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 208 |            |UL User Data                   | Additional API  |           |UL user data exchanged from RLC to DUAPP |
 209 |            +-------------------------------+-----------------+-----------+-----------------------------------------+
 210 |            |Slice Performance Metrics      | Additional API  |           |Performance Metrics informed to DUAPP    |
 211 |            |                               |                 |           |every 60sec for every slice configured   |
 212 +------------+-------------------------------+-----------------+-----------+-----------------------------------------+
 213