2e40e204dc4360173d893485228ee1d267f539d1
[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 |                                      |I5166fb1b6f04ed7e7d40344b21b0633259a  |
185 |                                      |26660                                 |
186 |                                      |                                      |
187 +--------------------------------------+--------------------------------------+
188 | **Release designation**              | F release                            |
189 |                                      |                                      |   
190 +--------------------------------------+--------------------------------------+
191 | **Release date**                     |2022-06-16                            |
192 |                                      |                                      |   
193 +--------------------------------------+--------------------------------------+
194 | **Purpose of the delivery**          | F release                            |
195 |                                      |                                      |   
196 +--------------------------------------+--------------------------------------+
197
198 e-release
199 ^^^^^^^^^^ 
200 +--------------------------------------+--------------------------------------+
201 | **Project**                          | ODUHIGH                              |
202 |                                      |                                      |
203 +--------------------------------------+--------------------------------------+
204 | **Repo/commit-ID**                   | o-du/l2/                             |
205 |                                      | I4b894c652ef3a3584670a9f26de87c2b2b3b|
206 |                                      | d8f2                                 |
207 +--------------------------------------+--------------------------------------+
208 | **Release designation**              | e-release                            |
209 |                                      |                                      |
210 +--------------------------------------+--------------------------------------+
211 | **Release date**                     | 2022-01-14                           |
212 |                                      |                                      |
213 +--------------------------------------+--------------------------------------+
214 | **Purpose of the delivery**          | e-release                            |
215 |                                      |                                      |
216 +--------------------------------------+--------------------------------------+
217
218 D
219 ^^^^^^ 
220 +--------------------------------------+--------------------------------------+
221 | **Project**                          | ODUHIGH                              |
222 |                                      |                                      |
223 +--------------------------------------+--------------------------------------+
224 | **Repo/commit-ID**                   | o-du/l2/                             |
225 |                                      | e8fdaea4192b41240b8c43f48adf92eed0c3 |
226 |                                      | b99e                                 |
227 +--------------------------------------+--------------------------------------+
228 | **Release designation**              | D Release                            |
229 |                                      |                                      |
230 +--------------------------------------+--------------------------------------+
231 | **Release date**                     | 2021-09-06                           |
232 |                                      |                                      |
233 +--------------------------------------+--------------------------------------+
234 | **Purpose of the delivery**          | D Release                            |
235 |                                      |                                      |
236 +--------------------------------------+--------------------------------------+
237
238 Cherry
239 ^^^^^^ 
240 +--------------------------------------+--------------------------------------+
241 | **Project**                          | ODUHIGH                              |
242 |                                      |                                      |
243 +--------------------------------------+--------------------------------------+
244 | **Repo/commit-ID**                   | o-du/l2/                             |
245 |                                      | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc|
246 |                                      | 4ff                                  |
247 |                                      |                                      |
248 +--------------------------------------+--------------------------------------+
249 | **Release designation**              | Cherry Release                       |
250 |                                      |                                      |
251 +--------------------------------------+--------------------------------------+
252 | **Release date**                     | 2020-12-04                           |
253 |                                      |                                      |
254 +--------------------------------------+--------------------------------------+
255 | **Purpose of the delivery**          | Cherry Release                       |
256 |                                      |                                      |
257 +--------------------------------------+--------------------------------------+
258
259 Bronze
260 ^^^^^^ 
261 +--------------------------------------+--------------------------------------+
262 | **Project**                          | ODUHIGH                              |
263 |                                      |                                      |
264 +--------------------------------------+--------------------------------------+
265 | **Repo/commit-ID**                   | o-du/l2/                             |
266 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
267 |                                      | 907                                  |
268 |                                      |                                      |
269 +--------------------------------------+--------------------------------------+
270 | **Release designation**              | Bronze Release                       |
271 |                                      |                                      |
272 +--------------------------------------+--------------------------------------+
273 | **Release date**                     | 2020-06-17                           |
274 |                                      |                                      |
275 +--------------------------------------+--------------------------------------+
276 | **Purpose of the delivery**          | Bronze Release                       |
277 |                                      |                                      |
278 +--------------------------------------+--------------------------------------+
279
280 Amber
281 ^^^^^
282 +--------------------------------------+--------------------------------------+
283 | **Project**                          | ODUHIGH                              |
284 |                                      |                                      |
285 +--------------------------------------+--------------------------------------+
286 | **Repo/commit-ID**                   | o-du/l2/                             |
287 |                                      | d349ae65e1495488772f87e5cfa1ae71d9eab|
288 |                                      | 075                                  |
289 |                                      |                                      |
290 +--------------------------------------+--------------------------------------+
291 | **Release designation**              | Amber Release                        |
292 |                                      |                                      |
293 +--------------------------------------+--------------------------------------+
294 | **Release date**                     | 2019-12-29                           |
295 |                                      |                                      |
296 +--------------------------------------+--------------------------------------+
297 | **Purpose of the delivery**          | Amber Release                        |
298 |                                      |                                      |
299 +--------------------------------------+--------------------------------------+
300
301
302
303 Feature Additions
304 ------------------
305
306 **JIRA BACK-LOG:**
307
308 F-release
309 ^^^^^^^^^^
310
311 +-----------------------------------------------+-----------------------------------------------+
312 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
313 |                                               |                                               |
314 +-----------------------------------------------+-----------------------------------------------+
315 | https://jira.o-ran-sc.org/browse/ODUHIGH-402  | Support for HARQ and scheduler enhancement to |
316 |                                               | prioritize retransmission                     |
317 +-----------------------------------------------+-----------------------------------------------+
318 | https://jira.o-ran-sc.org/browse/ODUHIGH-404  | Support for E2AP version 2.0                  | 
319 |                                               |                                               |
320 +-----------------------------------------------+-----------------------------------------------+
321 | https://jira.o-ran-sc.org/browse/ODUHIGH-405  | Support for Inter-DU Handover                 | 
322 |                                               |                                               |
323 +-----------------------------------------------+-----------------------------------------------+
324 | https://jira.o-ran-sc.org/browse/ODUHIGH-406  | Support for Idle Mode Paging                  | 
325 |                                               |                                               |
326 +-----------------------------------------------+-----------------------------------------------+
327 | https://jira.o-ran-sc.org/browse/ODUHIGH-429  | O1 Enhancements                               | 
328 |                                               |                                               |
329 +-----------------------------------------------+-----------------------------------------------+
330
331 e-release
332 ^^^^^^^^^^
333
334 +-----------------------------------------------+-----------------------------------------------+
335 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
336 |                                               |                                               |
337 +-----------------------------------------------+-----------------------------------------------+
338 | https://jira.o-ran-sc.org/browse/ODUHIGH-351  | Support for Multi bearers                     | 
339 |                                               |                                               |
340 +-----------------------------------------------+-----------------------------------------------+
341 | https://jira.o-ran-sc.org/browse/ODUHIGH-352  | Support for Multi UE                          |
342 |                                               |                                               |
343 +-----------------------------------------------+-----------------------------------------------+
344 | https://jira.o-ran-sc.org/browse/ODUHIGH-363  | Network Slicing support                       |
345 |                                               |                                               |
346 +-----------------------------------------------+-----------------------------------------------+
347 | https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
348 |                                               | meet flexible k0, k1 and k2 values            |
349 +-----------------------------------------------+-----------------------------------------------+
350 | https://jira.o-ran-sc.org/browse/ODUHIGH-361  | Support for cell configuration over O1        |
351 |                                               | interface                                     |
352 +-----------------------------------------------+-----------------------------------------------+
353 | https://jira.o-ran-sc.org/browse/ODUHIGH-395  | Optimization, scaling and rework              |
354 |                                               |                                               |
355 +-----------------------------------------------+-----------------------------------------------+
356
357 D
358 ^^^^^^^
359
360 +-----------------------------------------------+-----------------------------------------------+
361 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
362 |                                               |                                               |
363 +-----------------------------------------------+-----------------------------------------------+
364 | https://jira.o-ran-sc.org/browse/ODUHIGH-264  | Support for Mu1                               |
365 |                                               |                                               |
366 +-----------------------------------------------+-----------------------------------------------+
367 | https://jira.o-ran-sc.org/browse/ODUHIGH-265  | Support for 100 MHz                           |
368 |                                               |                                               |
369 +-----------------------------------------------+-----------------------------------------------+
370 | https://jira.o-ran-sc.org/browse/ODUHIGH-266  | Support for TDD mode                          |
371 |                                               |                                               |
372 +-----------------------------------------------+-----------------------------------------------+
373 | https://jira.o-ran-sc.org/browse/ODUHIGH-267  | Integration with O-DU Low in Radio mode       |
374 |                                               |                                               |
375 +-----------------------------------------------+-----------------------------------------------+
376 | https://jira.o-ran-sc.org/browse/ODUHIGH-268  | Integration with O-CU                         |
377 |                                               |                                               |
378 +-----------------------------------------------+-----------------------------------------------+
379 | https://jira.o-ran-sc.org/browse/ODUHIGH-269  | Support for E2E testing                       |
380 |                                               |                                               |
381 +-----------------------------------------------+-----------------------------------------------+
382 | https://jira.o-ran-sc.org/browse/ODUHIGH-299  | Closed Loop Automation use-case               |
383 |                                               |                                               |
384 +-----------------------------------------------+-----------------------------------------------+
385 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | Netconf session for O1 interface for CM       |
386 |                                               |                                               |
387 +-----------------------------------------------+-----------------------------------------------+
388 | https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
389 |                                               | meet flexible k0, k1 and k2 values            |
390 +-----------------------------------------------+-----------------------------------------------+
391
392 Cherry
393 ^^^^^^^
394
395 +-----------------------------------------------+-----------------------------------------------+
396 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
397 |                                               |                                               |
398 +-----------------------------------------------+-----------------------------------------------+
399 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
400 |                                               |                                               |
401 +-----------------------------------------------+-----------------------------------------------+
402 | https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
403 |                                               |                                               |
404 +-----------------------------------------------+-----------------------------------------------+
405 | https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
406 |                                               |                                               |
407 +-----------------------------------------------+-----------------------------------------------+
408 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
409 |                                               |                                               |
410 +-----------------------------------------------+-----------------------------------------------+
411 | https://jira.o-ran-sc.org/browse/ODUHIGH-184  | UE UL Data path                               |
412 |                                               |                                               |
413 +-----------------------------------------------+-----------------------------------------------+
414 | https://jira.o-ran-sc.org/browse/ODUHIGH-185  | UE DL Data path                               |
415 |                                               |                                               |
416 +-----------------------------------------------+-----------------------------------------------+
417 | https://jira.o-ran-sc.org/browse/ODUHIGH-186  | Applying 64 QAM Modulation in DL              |
418 |                                               |                                               |
419 +-----------------------------------------------+-----------------------------------------------+
420 | https://jira.o-ran-sc.org/browse/ODUHIGH-187  | Applying 16 QAM Modulation in UL              |
421 |                                               |                                               |
422 +-----------------------------------------------+-----------------------------------------------+
423 | https://jira.o-ran-sc.org/browse/ODUHIGH-190  | Integration with VIAVI Software               |
424 |                                               |                                               |
425 +-----------------------------------------------+-----------------------------------------------+
426 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
427 |                                               |                                               |
428 +-----------------------------------------------+-----------------------------------------------+
429 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
430 |                                               |                                               |
431 +-----------------------------------------------+-----------------------------------------------+
432
433 Previous Releases
434 ^^^^^^^^^^^^^^^^^^
435
436
437 +---------------------------------------------+-------------------------------------------------+
438 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
439 |                                             |                                                 |
440 +---------------------------------------------+-------------------------------------------------+
441 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
442 |                                             |                                                 |
443 +---------------------------------------------+-------------------------------------------------+
444 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
445 |                                             |                                                 |
446 +---------------------------------------------+-------------------------------------------------+
447 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
448 |                                             |                                                 |
449 +---------------------------------------------+-------------------------------------------------+
450 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
451 |                                             |                                                 |
452 +---------------------------------------------+-------------------------------------------------+
453 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
454 |                                             |                                                 |
455 +---------------------------------------------+-------------------------------------------------+
456 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
457 |                                             |                                                 |
458 +---------------------------------------------+-------------------------------------------------+
459 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
460 |                                             |                                                 |
461 +---------------------------------------------+-------------------------------------------------+
462
463 Bug Corrections
464 ----------------
465
466 **JIRA TICKETS:**
467
468 NA
469
470
471 Deliverables
472 -------------
473
474 Software Deliverables
475 ^^^^^^^^^^^^^^^^^^^^^^
476
477 This release contains O-DU High code, along with test code in the form of CU stub, RIC stub and phy stub.
478 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
479 All of the above can be found in the o-du/l2 repo.
480
481
482
483 Documentation Deliverables
484 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
485
486 This release contains 
487
488 - README with instruction to build and execute binaries.
489
490 - overview.rst
491
492 - release-notes.rst
493
494 - installation-guide.rst
495
496 - user-guide.rst
497
498 - api-docs.rst
499
500 - developer-guide.rst
501
502
503
504 Known Limitations, Issues and Workarounds
505 -----------------------------------------
506
507 System Limitations
508 ^^^^^^^^^^^^^^^^^^
509 - Current code contains support only for below configuration:
510
511    - [TDD] [Mu1] [100MHz]
512    - [FDD] [Mu0] [ 20MHz]
513    - Freuency Range = FR 1
514    - DL/UL Modulation = QPSK
515
516 - Current code is locally tested to support upto three UEs.
517
518 - NR-MAC supports Round Robin scheduling currently.
519
520 - Cell broadcast is for SSB and SIB1 only.
521
522 - FAPI files not in-line with SCF FAPI 1.0.5.
523   O-DU High currently compatible with FAPI files provided by Intel.
524
525 - Implementation of F1 reset is limited to intializing UE contexts.
526
527 - E2 interface is limited to Traffic Steering Usecase.
528
529 - 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.
530
531 - On the F1-U interface, UE, RB and tunnel configurations are static.
532
533 - Cell configuration is supported by CM on O1 interface. All other configurations are static.
534
535 - O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
536
537 - Netconf TLS connection is not supported
538
539 - Current code supports two Network Slices, One Default and other one Dedicated Slice.
540
541 - We have to manually download the 3GPP yang models and install.
542
543 Known Issues
544 ^^^^^^^^^^^^^
545
546 - PDSCH DMRS must not be interleaved with PDSCH allocations.
547
548 - PUSCH DMRS must not be interleaved with PUSCH allocations.
549
550 - Frequency domain allocation in DCI is a bit map where:
551
552      - As per spec : the most significant bit corresponds to the group of lowest frequency.
553      - As per L1 : the least significant bit corresponds to the lowest frequency group.
554
555 - Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
556
557 - Only mapping type = 1 (i.e. Type A) supported for PDSCH.
558
559 - L1 unable to process SIB1 with hardware accelerator enabled.
560
561 **JIRA TICKETS:**
562
563 NA
564
565
566 Workarounds
567 ^^^^^^^^^^^
568
569 O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
570
571
572
573 References
574 ----------
575 1. ORAN-WG8.AAD.0-v05.00.00
576
577 2. O-RAN.WG5.C.1-v05.00
578
579 3. ORAN WG3.E2AP v02.00
580
581 4. 3GPP 38.473-f60 v15.3
582
583 5. 3GPP TS 38.211 v15.3
584
585 6. 3GPP TS 38.212 v15.3
586
587 7. 3GPP TS 38.213 v15.3
588
589 8. 3GPP TS 38.214 v15.3
590
591 9. 3GPP TS 38.321 v15.3
592
593 10. 3GPP TS 38.331 v15.3
594
595 11. 5G PHY FAPI Specification v1.0.5
596
597 12. 3GPP TS 28.541 Specfication V16.6
598
599 13. O-RAN WG1.O1-Interface v04.00
600
601 14. O-RAN WG1.OAM-Architecture v04.00