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