Merge "Documentation updates"
[o-du/l2.git] / docs / release-notes.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 Release-Notes
6 =============
7
8
9 This document provides the release notes for Bronze Release of O-DU-L2.
10
11 .. contents::
12    :depth: 3
13    :local:
14
15
16 Version history
17 ---------------
18
19 +--------------------+--------------------+--------------------+--------------------+
20 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
21 |                    |                    |                    |                    |
22 +--------------------+--------------------+--------------------+--------------------+
23 | 2020-12-04         | 3.0.0              | Radisys            | Cherry Release     |
24 |                    |                    |                    |                    |
25 +--------------------+--------------------+--------------------+--------------------+
26 | 2020-06-17         | 2.0.0              | Radisys            | Bronze Release     |
27 |                    |                    |                    |                    |
28 +--------------------+--------------------+--------------------+--------------------+
29 | 2019-12-29         | 1.0.0              | Radisys            | Amber Release      |
30 |                    |                    |                    |                    |
31 +--------------------+--------------------+--------------------+--------------------+
32
33
34 Summary
35 -------
36
37 Cherry
38 ^^^^^^^^
39 This release contains the following:
40
41 - Implementation of UE attach signalling procedure on single carrier.
42   All message exchanges within O-DU High are in line with WG8 AAD spec.
43
44 - Enhancements to F1-C interface as required for UE attach procedure.
45
46 - Enhancements to FAPI interface towards O-DU Low as required for UE attach procedure.
47
48 - Support for all short PRACH formats.
49
50 - Integration of FAPI P5 messages with Intel's O-DU Low in Timer mode.
51
52 - Code support for alignment with latest FAPI interface files from Intel.
53
54 - Implementation of O1 interface.
55
56 - Partial implementation of Health Check use-case with get-Alarm list API.
57
58
59 Bronze
60 ^^^^^^^^
61 This release contains the following:
62
63 - Enhancements to F1-C interface for UE attach procedure.
64
65 - Implementation of F1-U interface.
66
67 - Implementation of E2 interface.
68
69 - Support for traffic steering usecase.
70
71 - Support for single carrier.
72
73 - Implementation of basic scheduler.
74
75 - Implementation of Cell broadcast procedure.
76
77 - Implementation of UE procedure till msg-4 for single UE. Complete testing of these messages is in progress.
78
79 - Implementation of FAPI interface towards O-DU Low using WLS.
80
81 - Partial implementation of RLC layer interfaces towards upper and lower layers
82   conforming to AAD spec.
83
84
85 Amber
86 ^^^^^
87 This release contains the following:
88
89 - O-DU layer intilaizations
90
91 - Implementation of F1-C interface
92
93 - Exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
94
95
96 Release Data
97 ------------
98
99 Cherry
100 ^^^^^^ 
101 +--------------------------------------+--------------------------------------+
102 | **Project**                          | ODUHIGH                              |
103 |                                      |                                      |
104 +--------------------------------------+--------------------------------------+
105 | **Repo/commit-ID**                   | o-du/l2/                             |
106 |                                      | 27d8d877e837c2879a452538cdbe81afe48be|
107 |                                      | d62                                  |
108 |                                      |                                      |
109 +--------------------------------------+--------------------------------------+
110 | **Release designation**              | Cherry Release                       |
111 |                                      |                                      |
112 +--------------------------------------+--------------------------------------+
113 | **Release date**                     | 2020-12-04                           |
114 |                                      |                                      |
115 +--------------------------------------+--------------------------------------+
116 | **Purpose of the delivery**          | Cherry Release                       |
117 |                                      |                                      |
118 +--------------------------------------+--------------------------------------+
119
120 Bronze
121 ^^^^^^ 
122 +--------------------------------------+--------------------------------------+
123 | **Project**                          | ODUHIGH                              |
124 |                                      |                                      |
125 +--------------------------------------+--------------------------------------+
126 | **Repo/commit-ID**                   | o-du/l2/                             |
127 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
128 |                                      | 907                                  |
129 |                                      |                                      |
130 +--------------------------------------+--------------------------------------+
131 | **Release designation**              | Bronze Release                       |
132 |                                      |                                      |
133 +--------------------------------------+--------------------------------------+
134 | **Release date**                     | 2020-06-17                           |
135 |                                      |                                      |
136 +--------------------------------------+--------------------------------------+
137 | **Purpose of the delivery**          | Bronze Release                       |
138 |                                      |                                      |
139 +--------------------------------------+--------------------------------------+
140
141 Amber
142 ^^^^^
143 +--------------------------------------+--------------------------------------+
144 | **Project**                          | ODUHIGH                              |
145 |                                      |                                      |
146 +--------------------------------------+--------------------------------------+
147 | **Repo/commit-ID**                   | o-du/l2/                             |
148 |                                      | d349ae65e1495488772f87e5cfa1ae71d9eab|
149 |                                      | 075                                  |
150 |                                      |                                      |
151 +--------------------------------------+--------------------------------------+
152 | **Release designation**              | Amber Release                        |
153 |                                      |                                      |
154 +--------------------------------------+--------------------------------------+
155 | **Release date**                     | 2019-12-29                           |
156 |                                      |                                      |
157 +--------------------------------------+--------------------------------------+
158 | **Purpose of the delivery**          | Amber Release                        |
159 |                                      |                                      |
160 +--------------------------------------+--------------------------------------+
161
162
163
164 Feature Additions
165 ------------------
166
167 **JIRA BACK-LOG:**
168
169 Cherry
170 ^^^^^^^
171
172 +-----------------------------------------------+-----------------------------------------------+
173 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
174 |                                               |                                               |
175 +-----------------------------------------------+-----------------------------------------------+
176 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
177 |                                               |                                               |
178 +-----------------------------------------------+-----------------------------------------------+
179 | https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
180 |                                               |                                               |
181 +-----------------------------------------------+-----------------------------------------------+
182 | https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
183 |                                               |                                               |
184 +-----------------------------------------------+-----------------------------------------------+
185 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
186 |                                               |                                               |
187 +-----------------------------------------------+-----------------------------------------------+
188 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
189 |                                               |                                               |
190 +-----------------------------------------------+-----------------------------------------------+
191 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
192 |                                               |                                               |
193 +-----------------------------------------------+-----------------------------------------------+
194
195 Previous Releases
196 ^^^^^^^^^^^^^^^^^^
197
198
199 +---------------------------------------------+-------------------------------------------------+
200 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
201 |                                             |                                                 |
202 +---------------------------------------------+-------------------------------------------------+
203 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
204 |                                             |                                                 |
205 +---------------------------------------------+-------------------------------------------------+
206 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
207 |                                             |                                                 |
208 +---------------------------------------------+-------------------------------------------------+
209 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
210 |                                             |                                                 |
211 +---------------------------------------------+-------------------------------------------------+
212 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
213 |                                             |                                                 |
214 +---------------------------------------------+-------------------------------------------------+
215 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
216 |                                             |                                                 |
217 +---------------------------------------------+-------------------------------------------------+
218 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
219 |                                             |                                                 |
220 +---------------------------------------------+-------------------------------------------------+
221 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
222 |                                             |                                                 |
223 +---------------------------------------------+-------------------------------------------------+
224
225 Bug Corrections
226 ----------------
227
228 **JIRA TICKETS:**
229
230 NA
231
232
233 Deliverables
234 -------------
235
236 Software Deliverables
237 ^^^^^^^^^^^^^^^^^^^^^^
238
239 This release contains O-DU High code, along with test code in the form of CU stub, RIC stub and phy stub.
240 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
241 All of the above can be found in the o-du/l2 repo.
242
243
244
245 Documentation Deliverables
246 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
247
248 This release contains 
249
250 - README with instruction to build and execute binaries.
251
252 - overview.rst
253
254 - release-notes.rst
255
256
257
258 Known Limitations, Issues and Workarounds
259 -----------------------------------------
260
261 System Limitations
262 ^^^^^^^^^^^^^^^^^^
263 - Current code contains support for below configuration:
264
265    Duplex mode = FDD
266
267    Freuency Range = FR 1
268
269    numerology = 0
270
271    bandwidth = 20 MHz
272
273    DL/UL Modulation = QPSK
274
275    single HARQ transmission
276
277    single UE.
278
279 - This release implements a basic scheduler with fixed scheduling for single UE.
280
281 - Cell broadcast is for SSB and SIB1 only.
282
283 - FAPI files not in-line with SCF FAPI 1.0.5.
284   O-DU High currently compatible with FAPI files provided by Intel.
285
286 - Implementation of F1 reset is limited to intializing UE contexts.
287
288 - E2 interface is limited to Traffic Steering Usecase.
289
290 - Forming of RIC event trigger definition, RIC indication header and RIC indication message is unclear in the E2AP draft spec versions. Therefore, implementation does not contain accurate values. Contents of RIC indication message are mocked and triggered just once.
291
292 - On the F1-U interface, UE, RB and tunnel configurations are static.
293
294 - System runs on preconfigured values due to absence of CM support on O1 interface.
295
296 - O-DU High has not been integrated with O-DU Low and O-CU.
297
298 Known Issues
299 ^^^^^^^^^^^^^
300 None
301
302 **JIRA TICKETS:**
303
304 NA
305
306
307 Workarounds
308 ^^^^^^^^^^^
309
310 O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
311
312
313
314 References
315 ----------
316 1. ORAN-WG8.AAD.0-v02.05.00
317
318 2. ORAN WG3.E2AP v01.00
319
320 3. ORAN WG3.E2SM v01.00
321
322 4. 3GPP 38.473-f60 v15.3
323
324 5. 3GPP TS 38.211 v15.3
325
326 6. 3GPP TS 38.212 v15.3
327
328 7. 3GPP TS 38.213 v15.3
329
330 8. 3GPP TS 38.214 v15.3
331
332 9. 3GPP TS 38.321 v15.3
333
334 10. 3GPP TS 38.331 v15.3
335
336 11. 5G PHY FAPI Specification v1.0.5
337