3e9039a3143ba00f0b3c4e1783107485746de20e
[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 This document provides the release notes for F Release of O-DU-L2.
9
10 .. contents::
11    :depth: 3
12    :local:
13
14
15 Version history
16 ---------------
17
18 +--------------------+--------------------+--------------------+--------------------+
19 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
20 |                    |                    |                    |                    |
21 +--------------------+--------------------+--------------------+--------------------+
22 |2022-06-16          | 6.0.0              | Radisys,           | F release          |
23 |                    |                    | HCL Technologies   |                    |
24 |                    |                    | Ltd.               |                    |
25 +--------------------+--------------------+--------------------+--------------------+
26 | 2022-01-14         | 5.0.0              | Radisys,           | e-release          |
27 |                    |                    | HCL Technologies   |                    |
28 |                    |                    | Ltd.               |                    |
29 +--------------------+--------------------+--------------------+--------------------+
30 | 2021-09-06         | 4.0.0              | Radisys,           | D Release          |
31 |                    |                    | HCL Technologies   |                    |
32 |                    |                    | Ltd.               |                    |
33 +--------------------+--------------------+--------------------+--------------------+
34 | 2020-12-04         | 3.0.0              | Radisys,           | Cherry Release     |
35 |                    |                    | HCL Technologies   |                    |
36 |                    |                    | Ltd.               |                    |
37 +--------------------+--------------------+--------------------+--------------------+
38 | 2020-06-17         | 2.0.0              | Radisys            | Bronze Release     |
39 |                    |                    |                    |                    |
40 +--------------------+--------------------+--------------------+--------------------+
41 | 2019-12-29         | 1.0.0              | Radisys            | Amber Release      |
42 |                    |                    |                    |                    |
43 +--------------------+--------------------+--------------------+--------------------+
44
45
46 Summary
47 -------
48
49 F- release
50 ^^^^^^^^^^
51 This release contains the following:
52
53  - HARQ framework support and scheduler enhancement to prioritize retransmission
54
55  - Upgrade to E2AP version 2.0
56
57  - Support for IDLE Mode Paging
58
59  - Mobility mode Support (Intra-CU handover)
60
61
62  - O1 Module
63
64       - Alarm notification for cell down. 
65       - Added support for standard defined VES format in alarm notification and PM messages.
66
67 e-release
68 ^^^^^^^^^^
69 This release contains the following:
70
71  - Support for multiple bearers per UE
72
73  - Support for multiple UEs per cell. Maximum 3 UEs supported in this release.
74
75  - Enhancement of scheduler for round robin scheduling of UEs
76  
77  - Enhancement of scheduler to allocate grid resources to UL/DL channels based on slice(RRM Policies), UE and logical channel configurations
78
79  - Support for Network slicing
80       
81       - Measures the Slice performance and periodically reports the slice performance statistics to O1.
82       - Adjusting/Improving Slice performance via Slice Reconfiguration with optimized resource quota from SMO.
83  
84  - O1 Module
85
86       - Support for cell configuration over O1 interface.
87       - Support for RRM policy configuration over O1 interface.
88       - Support VES PM data stream for sending slice metrics parameters to SMO.
89
90 D
91 ^^^^^^^^
92 This release contains the following:
93
94  - UL/DL Data transmission on FDD/Mu0/20MHz.
95
96  - Support for static TDD at O-DU High on 100 MHz Bandwidth, numerology 1.
97
98  - Support for Closed Loop automation use case at O-DU High.
99
100  - O-DU low – O-DU high pairwise testing in Radio mode (Broadcast message successfully received at O-DU Low).
101
102  - O1 Module
103       
104       - Re-structure O1 module to run as a thread in ODU-High.
105       - CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
106       - VES PNF Registration.
107       - Support for Closed Loop Automation use-case.
108
109  - Maintenance release includes :
110       
111       - Memory handling optimization and fixes.
112       - Improvement in logging.
113       - K0, K1 and K2 configuration.
114       - Fixes in proccessing of RACH Indication and RAR.
115
116 Cherry
117 ^^^^^^^^
118 This release contains the following:
119
120 - Implementation of UE attach signalling procedure on single carrier.
121   All message exchanges within O-DU High are in line with WG8 AAD spec.
122
123 - Enhancements to F1-C interface as required for UE attach procedure.
124
125 - Enhancements to FAPI interface towards O-DU Low as required for UE attach procedure.
126
127 - Support for all short PRACH formats.
128
129 - Integration of FAPI P5 messages with Intel's O-DU Low in Timer mode.
130
131 - Code support for alignment with latest FAPI interface files from Intel.
132
133 - Implementation of O1 interface.
134
135 - Partial implementation of Health Check use-case with get-Alarm list API.
136
137
138 Bronze
139 ^^^^^^^^
140 This release contains the following:
141
142 - Enhancements to F1-C interface for UE attach procedure.
143
144 - Implementation of F1-U interface.
145
146 - Implementation of E2 interface.
147
148 - Support for traffic steering usecase.
149
150 - Support for single carrier.
151
152 - Implementation of basic scheduler.
153
154 - Implementation of Cell broadcast procedure.
155
156 - Implementation of UE procedure till msg-4 for single UE. Complete testing of these messages is in progress.
157
158 - Implementation of FAPI interface towards O-DU Low using WLS.
159
160 - Partial implementation of RLC layer interfaces towards upper and lower layers
161   conforming to AAD spec.
162
163
164 Amber
165 ^^^^^
166 This release contains the following:
167
168 - O-DU layer intilaizations
169
170 - Implementation of F1-C interface
171
172 - Exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
173
174
175 Release Data
176 ------------
177 F release
178 ^^^^^^^^^^
179 +--------------------------------------+--------------------------------------+
180 | **Project**                          | ODUHIGH                              |
181 |                                      |                                      |   
182 +--------------------------------------+--------------------------------------+
183 | **Repo/commit-ID**                   |o-du/l2/                              |
184 |                                      |I2eeed74163fe985e6421ea563c5170f8cf81 |
185 |                                      |7e6d                                  |
186 +--------------------------------------+--------------------------------------+
187 | **Release designation**              | F release                            |
188 |                                      |                                      |   
189 +--------------------------------------+--------------------------------------+
190 | **Release date**                     |2022-06-16                            |
191 |                                      |                                      |   
192 +--------------------------------------+--------------------------------------+
193 | **Purpose of the delivery**          | F release                            |
194 |                                      |                                      |   
195 +--------------------------------------+--------------------------------------+
196
197 e-release
198 ^^^^^^^^^^ 
199 +--------------------------------------+--------------------------------------+
200 | **Project**                          | ODUHIGH                              |
201 |                                      |                                      |
202 +--------------------------------------+--------------------------------------+
203 | **Repo/commit-ID**                   | o-du/l2/                             |
204 |                                      | I4b894c652ef3a3584670a9f26de87c2b2b3b|
205 |                                      | d8f2                                 |
206 +--------------------------------------+--------------------------------------+
207 | **Release designation**              | e-release                            |
208 |                                      |                                      |
209 +--------------------------------------+--------------------------------------+
210 | **Release date**                     | 2022-01-14                           |
211 |                                      |                                      |
212 +--------------------------------------+--------------------------------------+
213 | **Purpose of the delivery**          | e-release                            |
214 |                                      |                                      |
215 +--------------------------------------+--------------------------------------+
216
217 D
218 ^^^^^^ 
219 +--------------------------------------+--------------------------------------+
220 | **Project**                          | ODUHIGH                              |
221 |                                      |                                      |
222 +--------------------------------------+--------------------------------------+
223 | **Repo/commit-ID**                   | o-du/l2/                             |
224 |                                      | e8fdaea4192b41240b8c43f48adf92eed0c3 |
225 |                                      | b99e                                 |
226 +--------------------------------------+--------------------------------------+
227 | **Release designation**              | D Release                            |
228 |                                      |                                      |
229 +--------------------------------------+--------------------------------------+
230 | **Release date**                     | 2021-09-06                           |
231 |                                      |                                      |
232 +--------------------------------------+--------------------------------------+
233 | **Purpose of the delivery**          | D Release                            |
234 |                                      |                                      |
235 +--------------------------------------+--------------------------------------+
236
237 Cherry
238 ^^^^^^ 
239 +--------------------------------------+--------------------------------------+
240 | **Project**                          | ODUHIGH                              |
241 |                                      |                                      |
242 +--------------------------------------+--------------------------------------+
243 | **Repo/commit-ID**                   | o-du/l2/                             |
244 |                                      | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc|
245 |                                      | 4ff                                  |
246 |                                      |                                      |
247 +--------------------------------------+--------------------------------------+
248 | **Release designation**              | Cherry Release                       |
249 |                                      |                                      |
250 +--------------------------------------+--------------------------------------+
251 | **Release date**                     | 2020-12-04                           |
252 |                                      |                                      |
253 +--------------------------------------+--------------------------------------+
254 | **Purpose of the delivery**          | Cherry Release                       |
255 |                                      |                                      |
256 +--------------------------------------+--------------------------------------+
257
258 Bronze
259 ^^^^^^ 
260 +--------------------------------------+--------------------------------------+
261 | **Project**                          | ODUHIGH                              |
262 |                                      |                                      |
263 +--------------------------------------+--------------------------------------+
264 | **Repo/commit-ID**                   | o-du/l2/                             |
265 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
266 |                                      | 907                                  |
267 |                                      |                                      |
268 +--------------------------------------+--------------------------------------+
269 | **Release designation**              | Bronze Release                       |
270 |                                      |                                      |
271 +--------------------------------------+--------------------------------------+
272 | **Release date**                     | 2020-06-17                           |
273 |                                      |                                      |
274 +--------------------------------------+--------------------------------------+
275 | **Purpose of the delivery**          | Bronze Release                       |
276 |                                      |                                      |
277 +--------------------------------------+--------------------------------------+
278
279 Amber
280 ^^^^^
281 +--------------------------------------+--------------------------------------+
282 | **Project**                          | ODUHIGH                              |
283 |                                      |                                      |
284 +--------------------------------------+--------------------------------------+
285 | **Repo/commit-ID**                   | o-du/l2/                             |
286 |                                      | d349ae65e1495488772f87e5cfa1ae71d9eab|
287 |                                      | 075                                  |
288 |                                      |                                      |
289 +--------------------------------------+--------------------------------------+
290 | **Release designation**              | Amber Release                        |
291 |                                      |                                      |
292 +--------------------------------------+--------------------------------------+
293 | **Release date**                     | 2019-12-29                           |
294 |                                      |                                      |
295 +--------------------------------------+--------------------------------------+
296 | **Purpose of the delivery**          | Amber Release                        |
297 |                                      |                                      |
298 +--------------------------------------+--------------------------------------+
299
300
301
302 Feature Additions
303 ------------------
304
305 **JIRA BACK-LOG:**
306
307 F-release
308 ^^^^^^^^^^
309
310 +-----------------------------------------------+-----------------------------------------------+
311 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
312 |                                               |                                               |
313 +-----------------------------------------------+-----------------------------------------------+
314 | https://jira.o-ran-sc.org/browse/ODUHIGH-402  | Support for HARQ and scheduler enhancement to |
315 |                                               | prioritize retransmission                     |
316 +-----------------------------------------------+-----------------------------------------------+
317 | https://jira.o-ran-sc.org/browse/ODUHIGH-404  | Support for E2AP version 2.0                  | 
318 |                                               |                                               |
319 +-----------------------------------------------+-----------------------------------------------+
320 | https://jira.o-ran-sc.org/browse/ODUHIGH-405  | Support for Inter-DU Handover                 | 
321 |                                               |                                               |
322 +-----------------------------------------------+-----------------------------------------------+
323 | https://jira.o-ran-sc.org/browse/ODUHIGH-406  | Support for Idle Mode Paging                  | 
324 |                                               |                                               |
325 +-----------------------------------------------+-----------------------------------------------+
326 | https://jira.o-ran-sc.org/browse/ODUHIGH-429  | O1 Enhancements                               | 
327 |                                               |                                               |
328 +-----------------------------------------------+-----------------------------------------------+
329
330 e-release
331 ^^^^^^^^^^
332
333 +-----------------------------------------------+-----------------------------------------------+
334 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
335 |                                               |                                               |
336 +-----------------------------------------------+-----------------------------------------------+
337 | https://jira.o-ran-sc.org/browse/ODUHIGH-351  | Support for Multi bearers                     | 
338 |                                               |                                               |
339 +-----------------------------------------------+-----------------------------------------------+
340 | https://jira.o-ran-sc.org/browse/ODUHIGH-352  | Support for Multi UE                          |
341 |                                               |                                               |
342 +-----------------------------------------------+-----------------------------------------------+
343 | https://jira.o-ran-sc.org/browse/ODUHIGH-363  | Network Slicing support                       |
344 |                                               |                                               |
345 +-----------------------------------------------+-----------------------------------------------+
346 | https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
347 |                                               | meet flexible k0, k1 and k2 values            |
348 +-----------------------------------------------+-----------------------------------------------+
349 | https://jira.o-ran-sc.org/browse/ODUHIGH-361  | Support for cell configuration over O1        |
350 |                                               | interface                                     |
351 +-----------------------------------------------+-----------------------------------------------+
352 | https://jira.o-ran-sc.org/browse/ODUHIGH-395  | Optimization, scaling and rework              |
353 |                                               |                                               |
354 +-----------------------------------------------+-----------------------------------------------+
355
356 D
357 ^^^^^^^
358
359 +-----------------------------------------------+-----------------------------------------------+
360 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
361 |                                               |                                               |
362 +-----------------------------------------------+-----------------------------------------------+
363 | https://jira.o-ran-sc.org/browse/ODUHIGH-264  | Support for Mu1                               |
364 |                                               |                                               |
365 +-----------------------------------------------+-----------------------------------------------+
366 | https://jira.o-ran-sc.org/browse/ODUHIGH-265  | Support for 100 MHz                           |
367 |                                               |                                               |
368 +-----------------------------------------------+-----------------------------------------------+
369 | https://jira.o-ran-sc.org/browse/ODUHIGH-266  | Support for TDD mode                          |
370 |                                               |                                               |
371 +-----------------------------------------------+-----------------------------------------------+
372 | https://jira.o-ran-sc.org/browse/ODUHIGH-267  | Integration with O-DU Low in Radio mode       |
373 |                                               |                                               |
374 +-----------------------------------------------+-----------------------------------------------+
375 | https://jira.o-ran-sc.org/browse/ODUHIGH-268  | Integration with O-CU                         |
376 |                                               |                                               |
377 +-----------------------------------------------+-----------------------------------------------+
378 | https://jira.o-ran-sc.org/browse/ODUHIGH-269  | Support for E2E testing                       |
379 |                                               |                                               |
380 +-----------------------------------------------+-----------------------------------------------+
381 | https://jira.o-ran-sc.org/browse/ODUHIGH-299  | Closed Loop Automation use-case               |
382 |                                               |                                               |
383 +-----------------------------------------------+-----------------------------------------------+
384 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | Netconf session for O1 interface for CM       |
385 |                                               |                                               |
386 +-----------------------------------------------+-----------------------------------------------+
387 | https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
388 |                                               | meet flexible k0, k1 and k2 values            |
389 +-----------------------------------------------+-----------------------------------------------+
390
391 Cherry
392 ^^^^^^^
393
394 +-----------------------------------------------+-----------------------------------------------+
395 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
396 |                                               |                                               |
397 +-----------------------------------------------+-----------------------------------------------+
398 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
399 |                                               |                                               |
400 +-----------------------------------------------+-----------------------------------------------+
401 | https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
402 |                                               |                                               |
403 +-----------------------------------------------+-----------------------------------------------+
404 | https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
405 |                                               |                                               |
406 +-----------------------------------------------+-----------------------------------------------+
407 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
408 |                                               |                                               |
409 +-----------------------------------------------+-----------------------------------------------+
410 | https://jira.o-ran-sc.org/browse/ODUHIGH-184  | UE UL Data path                               |
411 |                                               |                                               |
412 +-----------------------------------------------+-----------------------------------------------+
413 | https://jira.o-ran-sc.org/browse/ODUHIGH-185  | UE DL Data path                               |
414 |                                               |                                               |
415 +-----------------------------------------------+-----------------------------------------------+
416 | https://jira.o-ran-sc.org/browse/ODUHIGH-186  | Applying 64 QAM Modulation in DL              |
417 |                                               |                                               |
418 +-----------------------------------------------+-----------------------------------------------+
419 | https://jira.o-ran-sc.org/browse/ODUHIGH-187  | Applying 16 QAM Modulation in UL              |
420 |                                               |                                               |
421 +-----------------------------------------------+-----------------------------------------------+
422 | https://jira.o-ran-sc.org/browse/ODUHIGH-190  | Integration with VIAVI Software               |
423 |                                               |                                               |
424 +-----------------------------------------------+-----------------------------------------------+
425 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
426 |                                               |                                               |
427 +-----------------------------------------------+-----------------------------------------------+
428 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
429 |                                               |                                               |
430 +-----------------------------------------------+-----------------------------------------------+
431
432 Previous Releases
433 ^^^^^^^^^^^^^^^^^^
434
435
436 +---------------------------------------------+-------------------------------------------------+
437 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
438 |                                             |                                                 |
439 +---------------------------------------------+-------------------------------------------------+
440 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
441 |                                             |                                                 |
442 +---------------------------------------------+-------------------------------------------------+
443 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
444 |                                             |                                                 |
445 +---------------------------------------------+-------------------------------------------------+
446 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
447 |                                             |                                                 |
448 +---------------------------------------------+-------------------------------------------------+
449 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
450 |                                             |                                                 |
451 +---------------------------------------------+-------------------------------------------------+
452 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
453 |                                             |                                                 |
454 +---------------------------------------------+-------------------------------------------------+
455 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
456 |                                             |                                                 |
457 +---------------------------------------------+-------------------------------------------------+
458 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
459 |                                             |                                                 |
460 +---------------------------------------------+-------------------------------------------------+
461
462 Bug Corrections
463 ----------------
464
465 **JIRA TICKETS:**
466
467 NA
468
469
470 Deliverables
471 -------------
472
473 Software Deliverables
474 ^^^^^^^^^^^^^^^^^^^^^^
475
476 This release contains O-DU High code, along with test code in the form of CU stub, RIC stub and phy stub.
477 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
478 All of the above can be found in the o-du/l2 repo.
479
480
481
482 Documentation Deliverables
483 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
484
485 This release contains 
486
487 - README with instruction to build and execute binaries.
488
489 - overview.rst
490
491 - release-notes.rst
492
493 - installation-guide.rst
494
495 - user-guide.rst
496
497 - api-docs.rst
498
499 - developer-guide.rst
500
501
502
503 Known Limitations, Issues and Workarounds
504 -----------------------------------------
505
506 System Limitations
507 ^^^^^^^^^^^^^^^^^^
508 - Current code contains support only for below configuration:
509
510    - [TDD] [Mu1] [100MHz]
511    - [FDD] [Mu0] [ 20MHz]
512    - Freuency Range = FR 1
513    - DL/UL Modulation = QPSK
514
515 - Current code is locally tested to support upto three UEs.
516
517 - NR-MAC supports Round Robin scheduling currently.
518
519 - Cell broadcast is for SSB and SIB1 only.
520
521 - FAPI files not in-line with SCF FAPI 1.0.5.
522   O-DU High currently compatible with FAPI files provided by Intel.
523
524 - Implementation of F1 reset is limited to intializing UE contexts.
525
526 - E2 interface is limited to Traffic Steering Usecase.
527
528 - 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.
529
530 - On the F1-U interface, UE, RB and tunnel configurations are static.
531
532 - Cell configuration is supported by CM on O1 interface. All other configurations are static.
533
534 - O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
535
536 - Netconf TLS connection is not supported
537
538 - Current code supports two Network Slices, One Default and other one Dedicated Slice.
539
540 - We have to manually download the 3GPP yang models and install.
541
542 Known Issues
543 ^^^^^^^^^^^^^
544
545 - PDSCH DMRS must not be interleaved with PDSCH allocations.
546
547 - PUSCH DMRS must not be interleaved with PUSCH allocations.
548
549 - Frequency domain allocation in DCI is a bit map where:
550
551      - As per spec : the most significant bit corresponds to the group of lowest frequency.
552      - As per L1 : the least significant bit corresponds to the lowest frequency group.
553
554 - Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
555
556 - Only mapping type = 1 (i.e. Type A) supported for PDSCH.
557
558 - L1 unable to process SIB1 with hardware accelerator enabled.
559
560 **JIRA TICKETS:**
561
562 NA
563
564
565 Workarounds
566 ^^^^^^^^^^^
567
568 O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
569
570
571
572 References
573 ----------
574 1. ORAN-WG8.AAD.0-v05.00.00
575
576 2. O-RAN.WG5.C.1-v05.00
577
578 3. ORAN WG3.E2AP v02.00
579
580 4. 3GPP 38.473-f60 v15.3
581
582 5. 3GPP TS 38.211 v15.3
583
584 6. 3GPP TS 38.212 v15.3
585
586 7. 3GPP TS 38.213 v15.3
587
588 8. 3GPP TS 38.214 v15.3
589
590 9. 3GPP TS 38.321 v15.3
591
592 10. 3GPP TS 38.331 v15.3
593
594 11. 5G PHY FAPI Specification v1.0.5
595
596 12. 3GPP TS 28.541 Specfication V16.6
597
598 13. O-RAN WG1.O1-Interface v04.00
599
600 14. O-RAN WG1.OAM-Architecture v04.00