* INTC Contribution to the O-RAN F Release for O-DU Low
[o-du/phy.git] / docs / fapi_5g_tm_rel-notes.rst
1 ..    Copyright (c) 2019-2022 Intel
2 ..
3 ..  Licensed under the Apache License, Version 2.0 (the "License");
4 ..  you may not use this file except in compliance with the License.
5 ..  You may obtain a copy of the License at
6 ..
7 ..      http://www.apache.org/licenses/LICENSE-2.0
8 ..
9 ..  Unless required by applicable law or agreed to in writing, software
10 ..  distributed under the License is distributed on an "AS IS" BASIS,
11 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 ..  See the License for the specific language governing permissions and
13 ..  limitations under the License.
14
15
16 .. |br| raw:: html
17
18    <br />
19    
20 ORAN 5G FAPI TM Release Notes
21 =============================
22
23 Version FAPI TM oran_f_release_v1.0, June 2022
24 ----------------------------------------------
25
26 * Support of oneAPI compiler
27
28 * Support for additional features not properly defined in the SCF 5G FAPI 2.0 specs has been added by
29   means of vendor specific fields. (FlexRAN 22.11 compatible).
30   
31 Version FAPI TM oran_e_maintenance_release_v1.0, Mar 2022
32 ---------------------------------------------------------
33
34 * Increased test coverage. Now DL, UL, FD, URLLC and Massive MIMO use cases are supported.
35 * Support for features not properly defined in the SCF 5G FAPI 2.0 specs has been added by
36   means of vendor specific fields.
37   
38 Version FAPI TM oran_release_bronze_v1.1, Aug 2020
39 ------------------------------------------------------
40
41 * Increased test coverage. All supported DL, UL and FD standard MIMO cases are validated
42 * Support for carrier aggregation
43 * Support for API ordering
44 * Support for handling Intel proprietary PHY shutdown message in radio mode
45 * FAPI TM latency measurement
46 * Bug fixes
47 * Feedback provided to SCF on parameter gaps identified in SCF 5G FAPI specification dated March 2020
48 * This version of the 5G FAPI TM incorporates the changes that were provided to the SCF.
49
50
51 Version FAPI TM oran_release_bronze_v1.0, May 2020
52 ------------------------------------------------------
53 * First release of the 5G FAPI TM to ORAN in support of the Bronze Release
54 * This version supports 5G only
55 * PARAM.config and PARAM.resp are not supported
56 * ERROR.ind relies on the L1 support for error detection as the 5G FAPI TM \
57   only enforces security checks and |br|
58   integrity checks to avoid DOS attacks but \
59   it doesn't perform full validation of the input parameters for compliance to
60   the standard
61 * Deviations from the March version of the SCF 5G FAPI document have been \
62   implemented in order to deal with |br|
63   limitations and ommisions found in the
64   current SCF document, these differences are being provided to the SCF for
65   the next document update. The 5G FAPI implementation is defined in the file
66   fapi_interface.h
67 * Multi-user MIMO, Beamforming, Precoding and URLLC are not supported in the
68   current implementation as they |br|
69   require additional alignment between the SCF
70   P19 and the ORAN
71 * The option for the MAC layer doing the full generation of the PBCH payload is not supported in this release and it will be added in the maintainance release cycle.