Doc changes for F release O1 enhancements
[o-du/l2.git] / 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 e-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    B. Scheduler to MAC
81
82       a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.3.3.1 of the AAD Spec
83
84       b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.3.3.6 of the AAD Spec
85
86       c. DL Scheduling Information - Provides scheduling information for a given slot for downlink data, as per Section
87          9.2.3.3.8 of the AAD spec.
88     
89       d. UL Scheduling Information - Provides scheduled information for MAC to form the UL_TTI.request towards O-DU Low,
90          as per Section 9.2.3.3.9 of the AAD Spec.
91
92       e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.3.3.10 of the AAD Spec.
93
94       f. Downlink Control Channel Information - Provides DCI scheduling information for a given slot on PDCCH, as per
95          Section 9.2.3.3.11 of the AAD Spec
96
97       g. Downlink Broadcast Allocation - Provides DCI and DL data scheduling information for SIB1 for a given slot for
98          Broadcast Channel, as per Section 9.2.3.3.12 of the AAD Spec.
99
100       h. UE Delete Response - Response to UE delete request from MAC, as per Section 9.2.3.3.7
101
102       i. Cell Delete Response - Response to Cell delete request from MAC, as per Section 9.2.3.3.2
103
104       j. Slice Configuration Response : Response to Slice Configuration request from MAC, as per Section 9.2.3.3.3 of the AAD Spec
105          
106       k. Slice Reconfiguration Response : Response to Slice Reconfiguration request from MAC, as per Section 9.2.3.3.4 of the AAD Spec
107
108       l. Downlink Paging Allocation :  Provides DCI and DL data scheduling information for any Paging queued for a given slot 
109          for Paging Channel, as per Section 9.2.3.3.13 of the AAD Spec.
110
111
112 3. DU APP - MAC Interface
113
114    - AAD Spec : section 9.2.4
115
116    A. DU APP to MAC
117    
118       a. Cell Start - Commands MAC to start cell at L1 and to start broadcasting system information, as per Section
119          9.2.4.1 of the AAD Spec.
120
121       b. UE Create Request - Adds UE information at MAC as per Section 9.2.4.3 of the AAD Spec.
122
123       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.
124
125       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.
126
127       e. Cell Stop - Commands MAC to stop cell at L1, as per Section 9.2.4.2 of the AAD spec.
128
129       f. UE Delete Request - Deletes UE information at MAC as per Section 9.2.4.7  of the AAD Spec.
130
131       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.
132       
133
134    B. MAC to DU APP
135
136       a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.4.4 of the AAD Spec.
137
138       b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.4.6 of the
139          AAD Spec.
140
141       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.
142
143       d. UE Delete Response - Response to UE Delete Request from DU Manager as per Section 9.2.4.8 of the AAD Spec.
144       
145 4. DU APP - RLC Interface
146    
147    - AAD Spec : section 9.2.5
148
149    A. DU APP to RLC
150
151       a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.5.1 of the AAD Spec.
152
153       b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.5.3 of the AAD Spec.
154
155       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.
156
157       d. UE Delete Request - Deletes UE associated RLC entity and related information as per Section 9.2.5.5 of the  AAD Spec.
158
159    B. RLC to DU APP
160
161       a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.5.3
162
163       b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.5.4
164
165       c. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.5.8 of the AAD spec.
166
167       d. RRC Message Delivery Report - Informs DU Manager on failed/successful delivery of a DL RRC message to UE, as
168          per Section 9.2.5.9 of the AAD Spec.
169
170       e. UE Delete Response - Response to UE Delete Request from DU APP, as per section 9.2.5.6
171
172 5. SMO-OAM - DU APP
173
174    - AAD Spec: Section 9.2.1
175
176    A. SMO-OAM to DU APP
177
178       a. Cell Configuration - Sends Basic Cell Configurations to DU APP as per Section 9.2.1.1
179       
180       b. Slice Configuration - Sends Slice Configurations to DU APP as per Section 9.2.1.2
181
182 Additional APIs
183 ----------------
184
185 1. DU APP - MAC Interface
186
187    A. DU APP to MAC
188      
189       a. Cell Configuration Request - Configures cell information at MAC.
190
191       b. Cell Delete Request - Deletes cell information at MAC.
192       
193       c. Slice Configuration Request : Triggers Slice Configuration request once received from O1 towards MAC.
194          
195       d. Slice Reconfiguration Request : Triggers Slice Reconfiguration request once received from O1 towards MAC. 
196
197    B. MAC to DU APP
198
199       a. Cell Configuration Response - Response to Cell Configuration Request from DU APP
200
201       b. Cell Delete Response - Response to Cell Delet request from DU APP
202       
203       c. Slice Configuration Respone :  Response to Slice Configuration request from DU Manager.
204          
205       d. Slice Reconfiguration Request : Response to Slice Reconfiguration request from DU Manager.
206
207       e. Slot Indication : Indication about the ongoing SFN and Slot information to DU APP.
208
209 2. DU APP - RLC Interface
210
211    A. RLC to DU APP
212
213       a. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
214
215       b. Slice Performance Metrics - Sends PM to DU APP every 60sec for every Slice configured.
216
217
218 3. DU APP - SMO-OAM
219
220    a. Bring cell up - Informs DU to bring a specific cell up
221
222    b. Bring cell down - Informs DU to bring specific cell up
223
224    c. Set the cell operational state - Sets the cell state to ACTIVE/INACTIVE
225
226    d. Raise a cell alarm - Raise an alarm when the cell is ACTIVE/INACTIVE
227
228    e. Slice PM - DU APP sends PM for all Slices in 60sec duration.
229