9df3eb7b9b01c95ffc9aeb9995f50769cfe1343d
[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-07-07         | 4.0.0              | Radisys,           | D Release          |
24 |                    |                    | HCL Technologies   |                    |
25 |                    |                    | Ltd.               |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27 | 2020-12-04         | 3.0.0              | Radisys,           | Cherry Release     |
28 |                    |                    | HCL Technologies   |                    |
29 |                    |                    | Ltd.               |                    |
30 +--------------------+--------------------+--------------------+--------------------+
31 | 2020-06-17         | 2.0.0              | Radisys            | Bronze Release     |
32 |                    |                    |                    |                    |
33 +--------------------+--------------------+--------------------+--------------------+
34 | 2019-12-29         | 1.0.0              | Radisys            | Amber Release      |
35 |                    |                    |                    |                    |
36 +--------------------+--------------------+--------------------+--------------------+
37
38
39 Summary
40 -------
41
42 D
43 ^^^^^^^^
44 This release contains the following:
45
46  - UL/DL Data transmission on FDD/Mu0/20MHz.
47
48  - Support for static TDD at O-DU High on 100 MHz Bandwidth, numerology 1.
49
50  - Support for Closed Loop automation use case at O-DU High.
51
52  - O-DU low – O-DU high pairwise testing in Radio mode (Broadcast message successfully received at O-DU Low).
53
54  - O1 Module
55       Re-structure O1 module to run as a thread in ODU-High.
56
57       CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
58
59       VES PNF Registration.
60
61       Support for Closed Loop Automation use-case.
62
63 Cherry
64 ^^^^^^^^
65 This release contains the following:
66
67 - Implementation of UE attach signalling procedure on single carrier.
68   All message exchanges within O-DU High are in line with WG8 AAD spec.
69
70 - Enhancements to F1-C interface as required for UE attach procedure.
71
72 - Enhancements to FAPI interface towards O-DU Low as required for UE attach procedure.
73
74 - Support for all short PRACH formats.
75
76 - Integration of FAPI P5 messages with Intel's O-DU Low in Timer mode.
77
78 - Code support for alignment with latest FAPI interface files from Intel.
79
80 - Implementation of O1 interface.
81
82 - Partial implementation of Health Check use-case with get-Alarm list API.
83
84
85 Bronze
86 ^^^^^^^^
87 This release contains the following:
88
89 - Enhancements to F1-C interface for UE attach procedure.
90
91 - Implementation of F1-U interface.
92
93 - Implementation of E2 interface.
94
95 - Support for traffic steering usecase.
96
97 - Support for single carrier.
98
99 - Implementation of basic scheduler.
100
101 - Implementation of Cell broadcast procedure.
102
103 - Implementation of UE procedure till msg-4 for single UE. Complete testing of these messages is in progress.
104
105 - Implementation of FAPI interface towards O-DU Low using WLS.
106
107 - Partial implementation of RLC layer interfaces towards upper and lower layers
108   conforming to AAD spec.
109
110
111 Amber
112 ^^^^^
113 This release contains the following:
114
115 - O-DU layer intilaizations
116
117 - Implementation of F1-C interface
118
119 - Exchange of F1 Setup Request, F1 Setup Response, GNB DU Config Update and GNB DU Config Update ACK between the ODU and CU STUB.
120
121
122 Release Data
123 ------------
124
125 D
126 ^^^^^^ 
127 +--------------------------------------+--------------------------------------+
128 | **Project**                          | ODUHIGH                              |
129 |                                      |                                      |
130 +--------------------------------------+--------------------------------------+
131 | **Repo/commit-ID**                   | o-du/l2/                             |
132 |                                      | 108f702c6ad76cba45a8bcabec8bf82a07bdb|
133 |                                      | c71                                  |
134 |                                      |                                      |
135 +--------------------------------------+--------------------------------------+
136 | **Release designation**              | D Release                            |
137 |                                      |                                      |
138 +--------------------------------------+--------------------------------------+
139 | **Release date**                     | 2021-07-07                           |
140 |                                      |                                      |
141 +--------------------------------------+--------------------------------------+
142 | **Purpose of the delivery**          | D Release                            |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145
146 Cherry
147 ^^^^^^ 
148 +--------------------------------------+--------------------------------------+
149 | **Project**                          | ODUHIGH                              |
150 |                                      |                                      |
151 +--------------------------------------+--------------------------------------+
152 | **Repo/commit-ID**                   | o-du/l2/                             |
153 |                                      | fc0bcf28e944ae7ba2423ad3c9a5c794df2dc|
154 |                                      | 4ff                                  |
155 |                                      |                                      |
156 +--------------------------------------+--------------------------------------+
157 | **Release designation**              | Cherry Release                       |
158 |                                      |                                      |
159 +--------------------------------------+--------------------------------------+
160 | **Release date**                     | 2020-12-04                           |
161 |                                      |                                      |
162 +--------------------------------------+--------------------------------------+
163 | **Purpose of the delivery**          | Cherry Release                       |
164 |                                      |                                      |
165 +--------------------------------------+--------------------------------------+
166
167 Bronze
168 ^^^^^^ 
169 +--------------------------------------+--------------------------------------+
170 | **Project**                          | ODUHIGH                              |
171 |                                      |                                      |
172 +--------------------------------------+--------------------------------------+
173 | **Repo/commit-ID**                   | o-du/l2/                             |
174 |                                      | 27844f9c01c08472b86b1a75adaed0e450a88|
175 |                                      | 907                                  |
176 |                                      |                                      |
177 +--------------------------------------+--------------------------------------+
178 | **Release designation**              | Bronze Release                       |
179 |                                      |                                      |
180 +--------------------------------------+--------------------------------------+
181 | **Release date**                     | 2020-06-17                           |
182 |                                      |                                      |
183 +--------------------------------------+--------------------------------------+
184 | **Purpose of the delivery**          | Bronze Release                       |
185 |                                      |                                      |
186 +--------------------------------------+--------------------------------------+
187
188 Amber
189 ^^^^^
190 +--------------------------------------+--------------------------------------+
191 | **Project**                          | ODUHIGH                              |
192 |                                      |                                      |
193 +--------------------------------------+--------------------------------------+
194 | **Repo/commit-ID**                   | o-du/l2/                             |
195 |                                      | d349ae65e1495488772f87e5cfa1ae71d9eab|
196 |                                      | 075                                  |
197 |                                      |                                      |
198 +--------------------------------------+--------------------------------------+
199 | **Release designation**              | Amber Release                        |
200 |                                      |                                      |
201 +--------------------------------------+--------------------------------------+
202 | **Release date**                     | 2019-12-29                           |
203 |                                      |                                      |
204 +--------------------------------------+--------------------------------------+
205 | **Purpose of the delivery**          | Amber Release                        |
206 |                                      |                                      |
207 +--------------------------------------+--------------------------------------+
208
209
210
211 Feature Additions
212 ------------------
213
214 **JIRA BACK-LOG:**
215
216 D
217 ^^^^^^^
218
219 +-----------------------------------------------+-----------------------------------------------+
220 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
221 |                                               |                                               |
222 +-----------------------------------------------+-----------------------------------------------+
223 | https://jira.o-ran-sc.org/browse/ODUHIGH-264  | Support for Mu1                               |
224 |                                               |                                               |
225 +-----------------------------------------------+-----------------------------------------------+
226 | https://jira.o-ran-sc.org/browse/ODUHIGH-265  | Support for 100 MHz                           |
227 |                                               |                                               |
228 +-----------------------------------------------+-----------------------------------------------+
229 | https://jira.o-ran-sc.org/browse/ODUHIGH-266  | Support for TDD mode                          |
230 |                                               |                                               |
231 +-----------------------------------------------+-----------------------------------------------+
232 | https://jira.o-ran-sc.org/browse/ODUHIGH-267  | Integration with O-DU Low in Radio mode       |
233 |                                               |                                               |
234 +-----------------------------------------------+-----------------------------------------------+
235 | https://jira.o-ran-sc.org/browse/ODUHIGH-268  | Integration with O-CU                         |
236 |                                               |                                               |
237 +-----------------------------------------------+-----------------------------------------------+
238 | https://jira.o-ran-sc.org/browse/ODUHIGH-269  | Support for E2E testing                       |
239 |                                               |                                               |
240 +-----------------------------------------------+-----------------------------------------------+
241 | https://jira.o-ran-sc.org/browse/ODUHIGH-299  | Closed Loop Automation use-case               |
242 |                                               |                                               |
243 +-----------------------------------------------+-----------------------------------------------+
244 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | Netconf session for O1 interface for CM       |
245 |                                               |                                               |
246 +-----------------------------------------------+-----------------------------------------------+
247
248 Cherry
249 ^^^^^^^
250
251 +-----------------------------------------------+-----------------------------------------------+
252 | **JIRA REFERENCE**                            | **SLOGAN**                                    |
253 |                                               |                                               |
254 +-----------------------------------------------+-----------------------------------------------+
255 | https://jira.o-ran-sc.org/browse/ODUHIGH-10   | UE attach procedure with basic scheduling     |
256 |                                               |                                               |
257 +-----------------------------------------------+-----------------------------------------------+
258 | https://jira.o-ran-sc.org/browse/ODUHIGH-188  | Support for all short PRACH formats           |
259 |                                               |                                               |
260 +-----------------------------------------------+-----------------------------------------------+
261 | https://jira.o-ran-sc.org/browse/ODUHIGH-191  | Explore O1 interface                          |
262 |                                               |                                               |
263 +-----------------------------------------------+-----------------------------------------------+
264 | https://jira.o-ran-sc.org/browse/ODUHIGH-189  | Integration with O-DU Low                     |
265 |                                               |                                               |
266 +-----------------------------------------------+-----------------------------------------------+
267 | https://jira.o-ran-sc.org/browse/ODUHIGH-184  | UE UL Data path                               |
268 |                                               |                                               |
269 +-----------------------------------------------+-----------------------------------------------+
270 | https://jira.o-ran-sc.org/browse/ODUHIGH-185  | UE DL Data path                               |
271 |                                               |                                               |
272 +-----------------------------------------------+-----------------------------------------------+
273 | https://jira.o-ran-sc.org/browse/ODUHIGH-186  | Applying 64 QAM Modulation in DL              |
274 |                                               |                                               |
275 +-----------------------------------------------+-----------------------------------------------+
276 | https://jira.o-ran-sc.org/browse/ODUHIGH-187  | Applying 16 QAM Modulation in UL              |
277 |                                               |                                               |
278 +-----------------------------------------------+-----------------------------------------------+
279 | https://jira.o-ran-sc.org/browse/ODUHIGH-190  | Integration with VIAVI Software               |
280 |                                               |                                               |
281 +-----------------------------------------------+-----------------------------------------------+
282 | https://jira.o-ran-sc.org/browse/ODUHIGH-214  | get-AlarmList implementation on O1 interface  |
283 |                                               |                                               |
284 +-----------------------------------------------+-----------------------------------------------+
285 | https://jira.o-ran-sc.org/browse/ODUHIGH-196  | CM Support on O1 interface                    |
286 |                                               |                                               |
287 +-----------------------------------------------+-----------------------------------------------+
288
289 Previous Releases
290 ^^^^^^^^^^^^^^^^^^
291
292
293 +---------------------------------------------+-------------------------------------------------+
294 | **JIRA REFERENCE**                          | **SLOGAN**                                      |
295 |                                             |                                                 |
296 +---------------------------------------------+-------------------------------------------------+
297 | https://jira.o-ran-sc.org/browse/ODUHIGH-1  | F1-C enhancement                                |
298 |                                             |                                                 |
299 +---------------------------------------------+-------------------------------------------------+
300 | https://jira.o-ran-sc.org/browse/ODUHIGH-5  | F1-U implementation                             |
301 |                                             |                                                 |
302 +---------------------------------------------+-------------------------------------------------+
303 | https://jira.o-ran-sc.org/browse/ODUHIGH-11 | E2 implementation                               |
304 |                                             |                                                 |
305 +---------------------------------------------+-------------------------------------------------+
306 | https://jira.o-ran-sc.org/browse/ODUHIGH-9  | Cell broadcast procedure                        |
307 |                                             |                                                 |
308 +---------------------------------------------+-------------------------------------------------+
309 | https://jira.o-ran-sc.org/browse/ODUHIGH-10 | UE attach procedure till msg-4                  |
310 |                                             |                                                 |
311 +---------------------------------------------+-------------------------------------------------+
312 | https://jira.o-ran-sc.org/browse/ODUHIGH-8  | FAPI interface implementation                   |
313 |                                             |                                                 |
314 +---------------------------------------------+-------------------------------------------------+
315 | https://jira.o-ran-sc.org/browse/ODUHIGH-27 | RLC layer interface enhancements                |
316 |                                             |                                                 |
317 +---------------------------------------------+-------------------------------------------------+
318
319 Bug Corrections
320 ----------------
321
322 **JIRA TICKETS:**
323
324 NA
325
326
327 Deliverables
328 -------------
329
330 Software Deliverables
331 ^^^^^^^^^^^^^^^^^^^^^^
332
333 This release contains O-DU High code, along with test code in the form of CU stub, RIC stub and phy stub.
334 Instructions to build and execute ODU, CU and RIC stub binaries are also present.
335 All of the above can be found in the o-du/l2 repo.
336
337
338
339 Documentation Deliverables
340 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
341
342 This release contains 
343
344 - README with instruction to build and execute binaries.
345
346 - overview.rst
347
348 - release-notes.rst
349
350 - installation-guide.rst
351
352 - user-guide.rst
353
354 - api-docs.rst
355
356 - developer-guide.rst
357
358
359
360 Known Limitations, Issues and Workarounds
361 -----------------------------------------
362
363 System Limitations
364 ^^^^^^^^^^^^^^^^^^
365 - Current code contains support only for below configuration:
366
367    [TDD] [Mu1] [100MHz]
368
369    [FDD] [Mu0] [ 20MHz]
370
371    Freuency Range = FR 1
372
373    DL/UL Modulation = QPSK
374
375    single UE.
376
377 - This release implements a basic scheduler with fixed scheduling for single UE.
378
379 - Cell broadcast is for SSB and SIB1 only.
380
381 - FAPI files not in-line with SCF FAPI 1.0.5.
382   O-DU High currently compatible with FAPI files provided by Intel.
383
384 - Implementation of F1 reset is limited to intializing UE contexts.
385
386 - E2 interface is limited to Traffic Steering Usecase.
387
388 - 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.
389
390 - On the F1-U interface, UE, RB and tunnel configurations are static.
391
392 - System runs on preconfigured values due to absence of CM support on O1 interface.
393
394 - O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
395
396 - Netconf TLS connection is not supported
397
398 Known Issues
399 ^^^^^^^^^^^^^
400
401 - PDSCH DMRS must not be interleaved with PDSCH allocations.
402
403 - PUSCH DMRS must not be interleaved with PUSCH allocations.
404
405 - Frequency domain allocation in DCI is a bit map where:
406
407      As per spec : the most significant bit corresponds to the group of lowest frequency.
408
409      As per L1 : the least significant bit corresponds to the lowest frequency group.
410
411 - Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
412
413 - Only mapping type = 1 (i.e. Type A) supported for PDSCH.
414
415 - L1 unable to process SIB1 with hardware accelerator enabled.
416
417 **JIRA TICKETS:**
418
419 NA
420
421
422 Workarounds
423 ^^^^^^^^^^^
424
425 O-DU High uses FAPI interface files provided by Intel and therefore, not completely in-line with SCF FAPI 1.0.5.
426
427
428
429 References
430 ----------
431 1. ORAN-WG8.AAD.0-v02.05.00
432
433 2. ORAN WG3.E2AP v01.00
434
435 3. ORAN WG3.E2SM v01.00
436
437 4. 3GPP 38.473-f60 v15.3
438
439 5. 3GPP TS 38.211 v15.3
440
441 6. 3GPP TS 38.212 v15.3
442
443 7. 3GPP TS 38.213 v15.3
444
445 8. 3GPP TS 38.214 v15.3
446
447 9. 3GPP TS 38.321 v15.3
448
449 10. 3GPP TS 38.331 v15.3
450
451 11. 5G PHY FAPI Specification v1.0.5
452