Jira reference updated in release notes
[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 D 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 | 2021-09-06         | 4.0.0              | Radisys,           | D Release          |
24 |                    |                    | HCL Technologies   |                    |
25 |                    |                    | Ltd.               |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27 | 2020-12-04         | 3.0.0              | Radisys,           | Cherry Release     |
28 |                    |                    | HCL Technologies   |                    |
29 |                    |                    | Ltd.               |                    |
30 +--------------------+--------------------+--------------------+--------------------+
31 | 2020-06-17         | 2.0.0              | Radisys            | Bronze Release     |
32 |                    |                    |                    |                    |
33 +--------------------+--------------------+--------------------+--------------------+
34 | 2019-12-29         | 1.0.0              | Radisys            | Amber Release      |
35 |                    |                    |                    |                    |
36 +--------------------+--------------------+--------------------+--------------------+
37
38
39 Summary
40 -------
41
42 D
43 ^^^^^^^^
44 This release contains the following:
45
46  - UL/DL Data transmission on FDD/Mu0/20MHz.
47
48  - Support for static TDD at O-DU High on 100 MHz Bandwidth, numerology 1.
49
50  - Support for Closed Loop automation use case at O-DU High.
51
52  - O-DU low – O-DU high pairwise testing in Radio mode (Broadcast message successfully received at O-DU Low).
53
54  - O1 Module
55       Re-structure O1 module to run as a thread in ODU-High.
56
57       CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
58
59       VES PNF Registration.
60
61       Support for Closed Loop Automation use-case.
62
63  - Maintenance release includes :
64
65       Memory handling optimization and fixes.
66
67       Improvement in logging.
68
69       K0, K1 and K2 configuration.
70       
71       Fixes in proccessing of RACH Indication and RAR.
72
73 Cherry
74 ^^^^^^^^
75 This release contains the following:
76
77 - Implementation of UE attach signalling procedure on single carrier.
78   All message exchanges within O-DU High are in line with WG8 AAD spec.
79
80 - Enhancements to F1-C interface as required for UE attach procedure.
81
82 - Enhancements to FAPI interface towards O-DU Low as required for UE attach procedure.
83
84 - Support for all short PRACH formats.
85
86 - Integration of FAPI P5 messages with Intel's O-DU Low in Timer mode.
87
88 - Code support for alignment with latest FAPI interface files from Intel.
89
90 - Implementation of O1 interface.
91
92 - Partial implementation of Health Check use-case with get-Alarm list API.
93
94
95 Bronze
96 ^^^^^^^^
97 This release contains the following:
98
99 - Enhancements to F1-C interface for UE attach procedure.
100
101 - Implementation of F1-U interface.
102
103 - Implementation of E2 interface.
104
105 - Support for traffic steering usecase.
106
107 - Support for single carrier.
108
109 - Implementation of basic scheduler.
110
111 - Implementation of Cell broadcast procedure.
112
113 - Implementation of UE procedure till msg-4 for single UE. Complete testing of these messages is in progress.
114
115 - Implementation of FAPI interface towards O-DU Low using WLS.
116
117 - Partial implementation of RLC layer interfaces towards upper and lower layers
118   conforming to AAD spec.
119
120
121 Amber
122 ^^^^^
123 This release contains the following:
124
125 - O-DU layer intilaizations
126
127 - Implementation of F1-C interface
128
129 - Exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
130
131
132 Release Data
133 ------------
134
135 D
136 ^^^^^^ 
137 +--------------------------------------+--------------------------------------+
138 | **Project**                          | ODUHIGH                              |
139 |                                      |                                      |
140 +--------------------------------------+--------------------------------------+
141 | **Repo/commit-ID**                   | o-du/l2/                             |
142 |                                      | e8fdaea4192b41240b8c43f48adf92eed0c3 |
143 |                                      | b99e                                 |
144 +--------------------------------------+--------------------------------------+
145 | **Release designation**              | D Release                            |
146 |                                      |                                      |
147 +--------------------------------------+--------------------------------------+
148 | **Release date**                     | 2021-09-06                           |
149 |                                      |                                      |
150 +--------------------------------------+--------------------------------------+
151 | **Purpose of the delivery**          | D Release                            |
152 |                                      |                                      |
153 +--------------------------------------+--------------------------------------+
154
155 Cherry
156 ^^^^^^ 
157 +--------------------------------------+--------------------------------------+
158 | **Project**                          | ODUHIGH                              |
159 |                                      |                                      |
160 +--------------------------------------+--------------------------------------+
161 | **Repo/commit-ID**                   | o-du/l2/                             |
162 |                                      | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc|
163 |                                      | 4ff                                  |
164 |                                      |                                      |
165 +--------------------------------------+--------------------------------------+
166 | **Release designation**              | Cherry Release                       |
167 |                                      |                                      |
168 +--------------------------------------+--------------------------------------+
169 | **Release date**                     | 2020-12-04                           |
170 |                                      |                                      |
171 +--------------------------------------+--------------------------------------+
172 | **Purpose of the delivery**          | Cherry Release                       |
173 |                                      |                                      |
174 +--------------------------------------+--------------------------------------+
175
176 Bronze
177 ^^^^^^ 
178 +--------------------------------------+--------------------------------------+
179 | **Project**                          | ODUHIGH                              |
180 |                                      |                                      |
181 +--------------------------------------+--------------------------------------+
182 | **Repo/commit-ID**                   | o-du/l2/                             |
183 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
184 |                                      | 907                                  |
185 |                                      |                                      |
186 +--------------------------------------+--------------------------------------+
187 | **Release designation**              | Bronze Release                       |
188 |                                      |                                      |
189 +--------------------------------------+--------------------------------------+
190 | **Release date**                     | 2020-06-17                           |
191 |                                      |                                      |
192 +--------------------------------------+--------------------------------------+
193 | **Purpose of the delivery**          | Bronze Release                       |
194 |                                      |                                      |
195 +--------------------------------------+--------------------------------------+
196
197 Amber
198 ^^^^^
199 +--------------------------------------+--------------------------------------+
200 | **Project**                          | ODUHIGH                              |
201 |                                      |                                      |
202 +--------------------------------------+--------------------------------------+
203 | **Repo/commit-ID**                   | o-du/l2/                             |
204 |                                      | d349ae65e1495488772f87e5cfa1ae71d9eab|
205 |                                      | 075                                  |
206 |                                      |                                      |
207 +--------------------------------------+--------------------------------------+
208 | **Release designation**              | Amber Release                        |
209 |                                      |                                      |
210 +--------------------------------------+--------------------------------------+
211 | **Release date**                     | 2019-12-29                           |
212 |                                      |                                      |
213 +--------------------------------------+--------------------------------------+
214 | **Purpose of the delivery**          | Amber Release                        |
215 |                                      |                                      |
216 +--------------------------------------+--------------------------------------+
217
218
219
220 Feature Additions
221 ------------------
222
223 **JIRA BACK-LOG:**
224
225 D
226 ^^^^^^^
227
228 +-----------------------------------------------+-----------------------------------------------+
229 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
230 |                                               |                                               |
231 +-----------------------------------------------+-----------------------------------------------+
232 | https://jira.o-ran-sc.org/browse/ODUHIGH-264  | Support for Mu1                               |
233 |                                               |                                               |
234 +-----------------------------------------------+-----------------------------------------------+
235 | https://jira.o-ran-sc.org/browse/ODUHIGH-265  | Support for 100 MHz                           |
236 |                                               |                                               |
237 +-----------------------------------------------+-----------------------------------------------+
238 | https://jira.o-ran-sc.org/browse/ODUHIGH-266  | Support for TDD mode                          |
239 |                                               |                                               |
240 +-----------------------------------------------+-----------------------------------------------+
241 | https://jira.o-ran-sc.org/browse/ODUHIGH-267  | Integration with O-DU Low in Radio mode       |
242 |                                               |                                               |
243 +-----------------------------------------------+-----------------------------------------------+
244 | https://jira.o-ran-sc.org/browse/ODUHIGH-268  | Integration with O-CU                         |
245 |                                               |                                               |
246 +-----------------------------------------------+-----------------------------------------------+
247 | https://jira.o-ran-sc.org/browse/ODUHIGH-269  | Support for E2E testing                       |
248 |                                               |                                               |
249 +-----------------------------------------------+-----------------------------------------------+
250 | https://jira.o-ran-sc.org/browse/ODUHIGH-299  | Closed Loop Automation use-case               |
251 |                                               |                                               |
252 +-----------------------------------------------+-----------------------------------------------+
253 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | Netconf session for O1 interface for CM       |
254 |                                               |                                               |
255 +-----------------------------------------------+-----------------------------------------------+
256 | https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
257 |                                               | meet flexible k0, k1 and k2 values            |
258 +-----------------------------------------------+-----------------------------------------------+
259
260 Cherry
261 ^^^^^^^
262
263 +-----------------------------------------------+-----------------------------------------------+
264 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
265 |                                               |                                               |
266 +-----------------------------------------------+-----------------------------------------------+
267 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
268 |                                               |                                               |
269 +-----------------------------------------------+-----------------------------------------------+
270 | https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
271 |                                               |                                               |
272 +-----------------------------------------------+-----------------------------------------------+
273 | https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
274 |                                               |                                               |
275 +-----------------------------------------------+-----------------------------------------------+
276 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
277 |                                               |                                               |
278 +-----------------------------------------------+-----------------------------------------------+
279 | https://jira.o-ran-sc.org/browse/ODUHIGH-184  | UE UL Data path                               |
280 |                                               |                                               |
281 +-----------------------------------------------+-----------------------------------------------+
282 | https://jira.o-ran-sc.org/browse/ODUHIGH-185  | UE DL Data path                               |
283 |                                               |                                               |
284 +-----------------------------------------------+-----------------------------------------------+
285 | https://jira.o-ran-sc.org/browse/ODUHIGH-186  | Applying 64 QAM Modulation in DL              |
286 |                                               |                                               |
287 +-----------------------------------------------+-----------------------------------------------+
288 | https://jira.o-ran-sc.org/browse/ODUHIGH-187  | Applying 16 QAM Modulation in UL              |
289 |                                               |                                               |
290 +-----------------------------------------------+-----------------------------------------------+
291 | https://jira.o-ran-sc.org/browse/ODUHIGH-190  | Integration with VIAVI Software               |
292 |                                               |                                               |
293 +-----------------------------------------------+-----------------------------------------------+
294 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
295 |                                               |                                               |
296 +-----------------------------------------------+-----------------------------------------------+
297 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
298 |                                               |                                               |
299 +-----------------------------------------------+-----------------------------------------------+
300
301 Previous Releases
302 ^^^^^^^^^^^^^^^^^^
303
304
305 +---------------------------------------------+-------------------------------------------------+
306 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
307 |                                             |                                                 |
308 +---------------------------------------------+-------------------------------------------------+
309 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
310 |                                             |                                                 |
311 +---------------------------------------------+-------------------------------------------------+
312 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
313 |                                             |                                                 |
314 +---------------------------------------------+-------------------------------------------------+
315 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
316 |                                             |                                                 |
317 +---------------------------------------------+-------------------------------------------------+
318 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
319 |                                             |                                                 |
320 +---------------------------------------------+-------------------------------------------------+
321 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
322 |                                             |                                                 |
323 +---------------------------------------------+-------------------------------------------------+
324 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
325 |                                             |                                                 |
326 +---------------------------------------------+-------------------------------------------------+
327 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
328 |                                             |                                                 |
329 +---------------------------------------------+-------------------------------------------------+
330
331 Bug Corrections
332 ----------------
333
334 **JIRA TICKETS:**
335
336 NA
337
338
339 Deliverables
340 -------------
341
342 Software Deliverables
343 ^^^^^^^^^^^^^^^^^^^^^^
344
345 This release contains O-DU High code, along with test code in the form of CU stub, RIC stub and phy stub.
346 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
347 All of the above can be found in the o-du/l2 repo.
348
349
350
351 Documentation Deliverables
352 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
353
354 This release contains 
355
356 - README with instruction to build and execute binaries.
357
358 - overview.rst
359
360 - release-notes.rst
361
362 - installation-guide.rst
363
364 - user-guide.rst
365
366 - api-docs.rst
367
368 - developer-guide.rst
369
370
371
372 Known Limitations, Issues and Workarounds
373 -----------------------------------------
374
375 System Limitations
376 ^^^^^^^^^^^^^^^^^^
377 - Current code contains support only for below configuration:
378
379    [TDD] [Mu1] [100MHz]
380
381    [FDD] [Mu0] [ 20MHz]
382
383    Freuency Range = FR 1
384
385    DL/UL Modulation = QPSK
386
387    single UE.
388
389 - This release implements a basic scheduler with fixed scheduling for single UE.
390
391 - Cell broadcast is for SSB and SIB1 only.
392
393 - FAPI files not in-line with SCF FAPI 1.0.5.
394   O-DU High currently compatible with FAPI files provided by Intel.
395
396 - Implementation of F1 reset is limited to intializing UE contexts.
397
398 - E2 interface is limited to Traffic Steering Usecase.
399
400 - 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.
401
402 - On the F1-U interface, UE, RB and tunnel configurations are static.
403
404 - System runs on preconfigured values due to absence of CM support on O1 interface.
405
406 - O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
407
408 - Netconf TLS connection is not supported
409
410 Known Issues
411 ^^^^^^^^^^^^^
412
413 - PDSCH DMRS must not be interleaved with PDSCH allocations.
414
415 - PUSCH DMRS must not be interleaved with PUSCH allocations.
416
417 - Frequency domain allocation in DCI is a bit map where:
418
419      As per spec : the most significant bit corresponds to the group of lowest frequency.
420
421      As per L1 : the least significant bit corresponds to the lowest frequency group.
422
423 - Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
424
425 - Only mapping type = 1 (i.e. Type A) supported for PDSCH.
426
427 - L1 unable to process SIB1 with hardware accelerator enabled.
428
429 **JIRA TICKETS:**
430
431 NA
432
433
434 Workarounds
435 ^^^^^^^^^^^
436
437 O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
438
439
440
441 References
442 ----------
443 1. ORAN-WG8.AAD.0-v02.05.00
444
445 2. ORAN WG3.E2AP v01.00
446
447 3. ORAN WG3.E2SM v01.00
448
449 4. 3GPP 38.473-f60 v15.3
450
451 5. 3GPP TS 38.211 v15.3
452
453 6. 3GPP TS 38.212 v15.3
454
455 7. 3GPP TS 38.213 v15.3
456
457 8. 3GPP TS 38.214 v15.3
458
459 9. 3GPP TS 38.321 v15.3
460
461 10. 3GPP TS 38.331 v15.3
462
463 11. 5G PHY FAPI Specification v1.0.5
464