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