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