Merge "Cleanup of all f1ap messages"
[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 Bronze 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 | 2019-10-29         | 0.1.0              | Radisys            | Amber Release      |
24 |                    |                    |                    |                    |
25 +--------------------+--------------------+--------------------+--------------------+
26 | 2020-06-17         | 0.2.0              | Radisys            | Bronze Release     |
27 |                    |                    |                    |                    |
28 +--------------------+--------------------+--------------------+--------------------+
29
30
31 Summary
32 -------
33
34 Bronze
35 ^^^^^^^^
36 This release contains the following:
37 - Enhancements to F1-C interface for UE attach procedure.
38
39 - Implementation of F1-U interface.
40
41 - Implementation of E2 interface.
42
43 - Support for traffic steering usecase.
44
45 - Support for single carrier.
46
47 - Implementation of basic scheduler.
48
49 - Implementation of Cell broadcast procedure.
50
51 - Implementation of UE procedure till msg-4 for single UE. Complete testing of these messages is in progress.
52
53 - Implementation of FAPI interface towards O-DU Low using WLS.
54
55 - Partial implementation of RLC layer interfaces towards upper and lower layers
56   conforming to AAD spec.
57
58
59 Release Data
60 ------------
61 +--------------------------------------+--------------------------------------+
62 | **Project**                          | ODUHIGH                              |
63 |                                      |                                      |
64 +--------------------------------------+--------------------------------------+
65 | **Repo/commit-ID**                   | o-du/l2/                             |
66 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
67 |                                      | 907                                  |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70 | **Release designation**              | Bronze Release                       |
71 |                                      |                                      |
72 +--------------------------------------+--------------------------------------+
73 | **Release date**                     | 2020-06-17                           |
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76 | **Purpose of the delivery**          | Bronze Release                       |
77 |                                      |                                      |
78 +--------------------------------------+--------------------------------------+
79
80
81
82 Feature Additions
83 ^^^^^^^^^^^^^^^^^
84
85 **JIRA BACK-LOG:**
86
87 +---------------------------------------------+--------------------------------------+
88 | **JIRA REFERENCE**                          | **SLOGAN**                           |
89 |                                             |                                      |
90 +---------------------------------------------+--------------------------------------+
91 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                     |
92 |                                             |                                      |
93 +---------------------------------------------+--------------------------------------+
94 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                  |
95 |                                             |                                      |
96 +---------------------------------------------+--------------------------------------+
97 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                    |
98 |                                             |                                      |
99 +---------------------------------------------+--------------------------------------+
100 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure             |
101 |                                             |                                      |
102 +---------------------------------------------+--------------------------------------+
103 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4       |
104 |                                             |                                      |
105 +---------------------------------------------+--------------------------------------+
106 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation        |
107 |                                             |                                      |
108 +---------------------------------------------+--------------------------------------+
109 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements     |
110 |                                             |                                      |
111 +---------------------------------------------+--------------------------------------+
112
113 Bug Corrections
114 ^^^^^^^^^^^^^^^
115
116 **JIRA TICKETS:**
117
118 NA
119
120
121 Deliverables
122 ^^^^^^^^^^^^
123
124 Software Deliverables
125 +++++++++++++++++++++
126
127 This release contains O-DU code, along with test code as part of CU stub, RIC stub and phy stub.
128 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
129 All of the above can be found in the o-du/l2 repo.
130
131
132
133 Documentation Deliverables
134 ++++++++++++++++++++++++++
135
136 This release contains 
137 - README with instruction to build and execute binaries.
138
139 - overview.rst
140
141 - release-notes.rst
142
143
144
145 Known Limitations, Issues and Workarounds
146 -----------------------------------------
147
148 System Limitations
149 ^^^^^^^^^^^^^^^^^^
150 - Current code contains support for below configuration:
151
152    Duplex mode = FDD
153
154    Freuency Range = FR 1
155
156    numerology = 0
157
158    bandwidth = 20 MHz
159
160    DL/UL Modulation = QPSK
161
162    single HARQ transmission
163
164 - Support for single UE.
165
166 - Cell broadcast is for SSB and SIB1 only.
167
168 - This release implements a basic scheduler with fixed scheduling.
169
170 - E2 interface is limited to Traffic Steering Usecase.
171
172 - 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.
173
174 - On the F1-U interface, UE, RB and tunnel configurations are static.
175
176 - System runs on preconfigured values due to absence of O1 interface.
177
178 - O-DU High has not been integrated with O-DU Low and O-CU.
179
180
181 Known Issues
182 ^^^^^^^^^^^^
183 None
184
185 **JIRA TICKETS:**
186
187 NA
188
189
190 Workarounds
191 ^^^^^^^^^^^
192
193 NA
194
195
196
197 References
198 ----------
199 1. ORAN-WG8.AAD.0-v02.05.00
200
201 2. ORAN WG3.E2AP v01.00
202
203 3. ORAN WG3.E2SM v01.00
204
205 4. 3GPP 38.473-f60 v15.3
206
207 5. 3GPP TS 38.211 v15.3
208
209 6. 3GPP TS 38.212 v15.3
210
211 7. 3GPP TS 38.213 v15.3
212
213 8. 3GPP TS 38.214 v15.3
214
215 9. 3GPP TS 38.321 v15.3
216
217 10. 3GPP TS 38.331 v15.3
218
219 11. 5G PHY FAPI Specification v1.0.5
220