[Epic-ID: ODUHIGH-406][Task-ID: ODUHIGH-452] Documentation for Idle Mode Paging
[o-du/l2.git] / docs / release-notes.rst
index 754edec..e5234b7 100644 (file)
@@ -3,10 +3,10 @@
 
 
 Release-Notes
-=============
+**************
 
 
-This document provides the release notes for Bronze Release of O-DU-L2.
+This document provides the release notes for D Release of O-DU-L2.
 
 .. contents::
    :depth: 3
@@ -20,8 +20,17 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 2020-12-04         | 3.0.0              | Radisys            | Cherry Release     |
-|                    |                    |                    |                    |
+| 2022-01-14         | 5.0.0              | Radisys,           | e-release          |
+|                    |                    | HCL Technologies   |                    |
+|                    |                    | Ltd.               |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-09-06         | 4.0.0              | Radisys,           | D Release          |
+|                    |                    | HCL Technologies   |                    |
+|                    |                    | Ltd.               |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-12-04         | 3.0.0              | Radisys,           | Cherry Release     |
+|                    |                    | HCL Technologies   |                    |
+|                    |                    | Ltd.               |                    |
 +--------------------+--------------------+--------------------+--------------------+
 | 2020-06-17         | 2.0.0              | Radisys            | Bronze Release     |
 |                    |                    |                    |                    |
@@ -34,6 +43,62 @@ Version history
 Summary
 -------
 
+F- release
+^^^^^^^^^^
+This release contains the following:
+
+ - Upgrade to E2AP version 2.0.
+ - Support for IDLE Mode Paging.
+
+e-release
+^^^^^^^^^^
+This release contains the following:
+
+ - Support for multiple bearers per UE
+
+ - Support for multiple UEs per cell. Maximum 3 UEs supported in this release.
+
+ - Enhancement of scheduler for round robin scheduling of UEs
+ - Enhancement of scheduler to allocate grid resources to UL/DL channels based on slice(RRM Policies), UE and logical channel configurations
+
+ - Support for Network slicing
+      
+      - Measures the Slice performance and periodically reports the slice performance statistics to O1.
+      - Adjusting/Improving Slice performance via Slice Reconfiguration with optimized resource quota from SMO.
+ - O1 Module
+
+      - Support for cell configuration over O1 interface.
+      - Support for RRM policy configuration over O1 interface.
+      - Support VES PM data stream for sending slice metrics parameters to SMO.
+
+D
+^^^^^^^^
+This release contains the following:
+
+ - UL/DL Data transmission on FDD/Mu0/20MHz.
+
+ - Support for static TDD at O-DU High on 100 MHz Bandwidth, numerology 1.
+
+ - Support for Closed Loop automation use case at O-DU High.
+
+ - O-DU low – O-DU high pairwise testing in Radio mode (Broadcast message successfully received at O-DU Low).
+
+ - O1 Module
+      
+      - Re-structure O1 module to run as a thread in ODU-High.
+      - CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
+      - VES PNF Registration.
+      - Support for Closed Loop Automation use-case.
+
+ - Maintenance release includes :
+      
+      - Memory handling optimization and fixes.
+      - Improvement in logging.
+      - K0, K1 and K2 configuration.
+      - Fixes in proccessing of RACH Indication and RAR.
+
 Cherry
 ^^^^^^^^
 This release contains the following:
@@ -96,15 +161,55 @@ This release contains the following:
 Release Data
 ------------
 
+e-release
+^^^^^^^^^^ 
++--------------------------------------+--------------------------------------+
+| **Project**                          | ODUHIGH                              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | o-du/l2/                             |
+|                                      | I4b894c652ef3a3584670a9f26de87c2b2b3b|
+|                                      | d8f2                                 |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | e-release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2022-01-14                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | e-release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+D
+^^^^^^ 
++--------------------------------------+--------------------------------------+
+| **Project**                          | ODUHIGH                              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | o-du/l2/                             |
+|                                      | e8fdaea4192b41240b8c43f48adf92eed0c3 |
+|                                      | b99e                                 |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | D Release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2021-09-06                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | D Release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
 Cherry
 ^^^^^^ 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | ODUHIGH                             |
+| **Project**                          | ODUHIGH                              |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Repo/commit-ID**                   | o-du/l2/                             |
-|                                      | 27d8d877e837c2879a452538cdbe81afe48be|
-|                                      | d62                                  |
+|                                      | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc|
+|                                      | 4ff                                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Release designation**              | Cherry Release                       |
@@ -113,14 +218,14 @@ Cherry
 | **Release date**                     | 2020-12-04                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Cherry Release                      |
+| **Purpose of the delivery**          | Cherry Release                       |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
 Bronze
 ^^^^^^ 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | ODUHIGH                             |
+| **Project**                          | ODUHIGH                              |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Repo/commit-ID**                   | o-du/l2/                             |
@@ -134,7 +239,7 @@ Bronze
 | **Release date**                     | 2020-06-17                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Bronze Release                      |
+| **Purpose of the delivery**          | Bronze Release                       |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -166,6 +271,81 @@ Feature Additions
 
 **JIRA BACK-LOG:**
 
+F-release
+^^^^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE**                            | **SLOGAN**                                    |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-404  | Support for E2AP version 2.0                  | 
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-406  | Support for Idle Mode Paging                  | 
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+
+e-release
+^^^^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE**                            | **SLOGAN**                                    |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-351  | Support for Multi bearers                     | 
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-352  | Support for Multi UE                          |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-363  | Network Slicing support                       |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
+|                                               | meet flexible k0, k1 and k2 values            |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-361  | Support for cell configuration over O1        |
+|                                               | interface                                     |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-395  | Optimization, scaling and rework              |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+
+D
+^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE**                            | **SLOGAN**                                    |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-264  | Support for Mu1                               |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-265  | Support for 100 MHz                           |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-266  | Support for TDD mode                          |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-267  | Integration with O-DU Low in Radio mode       |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-268  | Integration with O-CU                         |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-269  | Support for E2E testing                       |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-299  | Closed Loop Automation use-case               |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-196  | Netconf session for O1 interface for CM       |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
+|                                               | meet flexible k0, k1 and k2 values            |
++-----------------------------------------------+-----------------------------------------------+
+
 Cherry
 ^^^^^^^
 
@@ -174,22 +354,37 @@ Cherry
 |                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
-|                                               |                                              |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats          |
-|                                               |                                              |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                         |
-|                                               |                                              |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
-|                                               |                                              |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-184  | UE UL Data path                               |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-185  | UE DL Data path                               |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-186  | Applying 64 QAM Modulation in DL              |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-187  | Applying 16 QAM Modulation in UL              |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-190  | Integration with VIAVI Software               |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
-|                                               |                                              |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
-|                                               |                                              |
+|                                               |                                               |
 +-----------------------------------------------+-----------------------------------------------+
 
 Previous Releases
@@ -200,26 +395,26 @@ Previous Releases
 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
 |                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-1  |        F1-C enhancement                                |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-5  |        F1-U implementation                             |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-11 |        E2 implementation                               |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-9  |        Cell broadcast procedure                        |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-10 |        UE attach procedure till msg-4                  |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-8  |        FAPI interface implementation                   |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
-| https://jira.o-ran-sc.org/browse/ODUHIGH-27 |        RLC layer interface enhancements                |
-|                                             |                                                |
+| https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
+|                                             |                                                 |
 +---------------------------------------------+-------------------------------------------------+
 
 Bug Corrections
@@ -253,30 +448,31 @@ This release contains
 
 - release-notes.rst
 
+- installation-guide.rst
 
+- user-guide.rst
 
-Known Limitations, Issues and Workarounds
------------------------------------------
-
-System Limitations
-^^^^^^^^^^^^^^^^^^
-- Current code contains support for below configuration:
+- api-docs.rst
 
-   Duplex mode = FDD
+- developer-guide.rst
 
-   Freuency Range = FR 1
 
-   numerology = 0
 
-   bandwidth = 20 MHz
+Known Limitations, Issues and Workarounds
+-----------------------------------------
 
-   DL/UL Modulation = QPSK
+System Limitations
+^^^^^^^^^^^^^^^^^^
+- Current code contains support only for below configuration:
 
-   single HARQ transmission
+   - [TDD] [Mu1] [100MHz]
+   - [FDD] [Mu0] [ 20MHz]
+   - Freuency Range = FR 1
+   - DL/UL Modulation = QPSK
 
-   single UE.
+- Current code is locally tested to support upto three UEs.
 
-- This release implements a basic scheduler with fixed scheduling for single UE.
+- NR-MAC supports Round Robin scheduling currently.
 
 - Cell broadcast is for SSB and SIB1 only.
 
@@ -291,13 +487,33 @@ System Limitations
 
 - On the F1-U interface, UE, RB and tunnel configurations are static.
 
-- System runs on preconfigured values due to absence of CM support on O1 interface.
+- Cell configuration is supported by CM on O1 interface. All other configurations are static.
+
+- O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
+
+- Netconf TLS connection is not supported
 
-- O-DU High has not been integrated with O-DU Low and O-CU.
+- Current code supports two Network Slices, One Default and other one Dedicated Slice.
+
+- We have to manually download the 3GPP yang models and install.
 
 Known Issues
 ^^^^^^^^^^^^^
-None
+
+- PDSCH DMRS must not be interleaved with PDSCH allocations.
+
+- PUSCH DMRS must not be interleaved with PUSCH allocations.
+
+- Frequency domain allocation in DCI is a bit map where:
+
+     - As per spec : the most significant bit corresponds to the group of lowest frequency.
+     - As per L1 : the least significant bit corresponds to the lowest frequency group.
+
+- Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
+
+- Only mapping type = 1 (i.e. Type A) supported for PDSCH.
+
+- L1 unable to process SIB1 with hardware accelerator enabled.
 
 **JIRA TICKETS:**
 
@@ -313,25 +529,28 @@ O-DU High uses FAPI interface files provided by Intel and therefore, not complet
 
 References
 ----------
-1. ORAN-WG8.AAD.0-v02.05.00
+1. ORAN-WG8.AAD.0-v05.00.00
+
+2. ORAN WG3.E2AP v02.00
 
-2. ORAN WG3.E2AP v01.00
+3. 3GPP 38.473-f60 v15.3
 
-3. ORAN WG3.E2SM v01.00
+4. 3GPP TS 38.211 v15.3
 
-4. 3GPP 38.473-f60 v15.3
+5. 3GPP TS 38.212 v15.3
 
-5. 3GPP TS 38.211 v15.3
+6. 3GPP TS 38.213 v15.3
 
-6. 3GPP TS 38.212 v15.3
+7. 3GPP TS 38.214 v15.3
 
-7. 3GPP TS 38.213 v15.3
+8. 3GPP TS 38.321 v15.3
 
-8. 3GPP TS 38.214 v15.3
+9. 3GPP TS 38.331 v15.3
 
-9. 3GPP TS 38.321 v15.3
+10. 5G PHY FAPI Specification v1.0.5
 
-10. 3GPP TS 38.331 v15.3
+11. 3GPP TS 28.541 Specfication V16.6
 
-11. 5G PHY FAPI Specification v1.0.5
+12. O-RAN WG1.O1-Interface v04.00
 
+13. O-RAN WG1.OAM-Architecture v04.00