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