6a902ef9acfff3646cfefb0deb0fdfc3c6f59cf0
[dpdk.git] / doc / guides / rel_notes / release_21_08.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2021 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 21.08
7 ==================
8
9 .. **Read this first.**
10
11    The text in the sections below explains how to update the release notes.
12
13    Use proper spelling, capitalization and punctuation in all sections.
14
15    Variable and config names should be quoted as fixed width text:
16    ``LIKE_THIS``.
17
18    Build the docs and view the output file to ensure the changes are correct::
19
20       make doc-guides-html
21       xdg-open build/doc/html/guides/rel_notes/release_21_08.html
22
23
24 New Features
25 ------------
26
27 .. This section should contain new features added in this release.
28    Sample format:
29
30    * **Add a title in the past tense with a full stop.**
31
32      Add a short 1-2 sentence description in the past tense.
33      The description should be enough to allow someone scanning
34      the release notes to understand the new feature.
35
36      If the feature adds a lot of sub-features you can use a bullet list
37      like this:
38
39      * Added feature foo to do something.
40      * Enhanced feature bar to do something else.
41
42      Refer to the previous release notes for examples.
43
44      Suggested order in release notes items:
45      * Core libs (EAL, mempool, ring, mbuf, buses)
46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
47        - ethdev (lib, PMDs)
48        - cryptodev (lib, PMDs)
49        - eventdev (lib, PMDs)
50        - etc
51      * Other libs
52      * Apps, Examples, Tools (if significant)
53
54      This section is a comment. Do not overwrite or remove it.
55      Also, make sure to start the actual text at the margin.
56      =======================================================
57
58 * **Added auxiliary bus support.**
59
60   Auxiliary bus provides a way to split function into child-devices
61   representing sub-domains of functionality. Each auxiliary device
62   represents a part of its parent functionality.
63
64 * **Added XZ compressed firmware support.**
65
66   Using ``rte_firmware_read``, a driver can now handle XZ compressed firmware
67   in a transparent way, with EAL uncompressing using libarchive if this library
68   is available when building DPDK.
69
70 * **Updated Intel iavf driver.**
71
72   * Added Tx QoS VF queue TC mapping.
73
74 * **Updated Intel ice driver.**
75
76   * In AVX2 code, added the new RX and TX paths to use the HW offload
77     features. When the HW offload features are configured to be used, the
78     offload paths are chosen automatically. In parallel the support for HW
79     offload features was removed from the legacy AVX2 paths.
80   * Added Tx QoS TC bandwidth configuration in DCF.
81
82 * **Added support for Marvell CN10K SoC ethernet device.**
83
84   * Added net/cnxk driver which provides the support for the integrated ethernet
85     device.
86
87 * **Updated Mellanox mlx5 driver.**
88
89   * Added support for meter hierarchy.
90   * Added devargs options ``allow_duplicate_pattern``.
91
92 * **Added support for Marvell CNXK crypto driver.**
93
94   * Added cnxk crypto PMD which provides support for an integrated
95     crypto driver for CN9K and CN10K series of SOCs. Support for
96     symmetric crypto algorithms is added to both the PMDs.
97   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
98   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
99
100 * **Updated Marvell OCTEON TX crypto PMD.**
101
102   Added support for crypto adapter OP_FORWARD mode.
103
104 * **Added Baseband PHY CNXK PMD.**
105
106   Added Baseband PHY PMD which allows to configure BPHY hardware block
107   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
108   usecases. Configuration happens via standard rawdev enq/deq operations. See
109   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
110
111 * **Added cppc_cpufreq support to Power Management library.**
112
113   Added support for cppc_cpufreq driver which works on most arm64 platforms.
114
115 * **Added multi-queue support to Ethernet PMD Power Management**
116
117   The experimental PMD power management API now supports managing
118   multiple Ethernet Rx queues per lcore.
119
120
121 Removed Items
122 -------------
123
124 .. This section should contain removed items in this release. Sample format:
125
126    * Add a short 1-2 sentence description of the removed item
127      in the past tense.
128
129    This section is a comment. Do not overwrite or remove it.
130    Also, make sure to start the actual text at the margin.
131    =======================================================
132
133
134 API Changes
135 -----------
136
137 .. This section should contain API changes. Sample format:
138
139    * sample: Add a short 1-2 sentence description of the API change
140      which was announced in the previous releases and made in this release.
141      Start with a scope label like "ethdev:".
142      Use fixed width quotes for ``function_names`` or ``struct_names``.
143      Use the past tense.
144
145    This section is a comment. Do not overwrite or remove it.
146    Also, make sure to start the actual text at the margin.
147    =======================================================
148
149 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
150   truncation.
151
152 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
153   to use a callback mechanism.
154
155 * rte_power: The experimental PMD power management API is no longer considered
156   to be thread safe; all Rx queues affected by the API will now need to be
157   stopped before making any changes to the power management scheme.
158
159
160 ABI Changes
161 -----------
162
163 .. This section should contain ABI changes. Sample format:
164
165    * sample: Add a short 1-2 sentence description of the ABI change
166      which was announced in the previous releases and made in this release.
167      Start with a scope label like "ethdev:".
168      Use fixed width quotes for ``function_names`` or ``struct_names``.
169      Use the past tense.
170
171    This section is a comment. Do not overwrite or remove it.
172    Also, make sure to start the actual text at the margin.
173    =======================================================
174
175 * No ABI change that would break compatibility with 20.11.
176
177
178 Known Issues
179 ------------
180
181 .. This section should contain new known issues in this release. Sample format:
182
183    * **Add title in present tense with full stop.**
184
185      Add a short 1-2 sentence description of the known issue
186      in the present tense. Add information on any known workarounds.
187
188    This section is a comment. Do not overwrite or remove it.
189    Also, make sure to start the actual text at the margin.
190    =======================================================
191
192
193 Tested Platforms
194 ----------------
195
196 .. This section should contain a list of platforms that were tested
197    with this release.
198
199    The format is:
200
201    * <vendor> platform with <vendor> <type of devices> combinations
202
203      * List of CPU
204      * List of OS
205      * List of devices
206      * Other relevant details...
207
208    This section is a comment. Do not overwrite or remove it.
209    Also, make sure to start the actual text at the margin.
210    =======================================================