543e93ff1d6d6c99d59e3a1ed469cb90a706f6b4
[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   * Added FDIR and RSS for GTPoGRE, support filter based on GTPU TEID/QFI,
74     outer most L3 or inner most l3/l4. 
75
76 * **Updated Intel ice driver.**
77
78   * In AVX2 code, added the new RX and TX paths to use the HW offload
79     features. When the HW offload features are configured to be used, the
80     offload paths are chosen automatically. In parallel the support for HW
81     offload features was removed from the legacy AVX2 paths.
82   * Added Tx QoS TC bandwidth configuration in DCF.
83
84 * **Added support for Marvell CN10K SoC ethernet device.**
85
86   * Added net/cnxk driver which provides the support for the integrated ethernet
87     device.
88
89 * **Updated Mellanox mlx5 driver.**
90
91   * Added Sub-Function support based on auxiliary bus.
92   * Added support for meter hierarchy.
93   * Added devargs options ``allow_duplicate_pattern``.
94   * Added matching on IPv4 Internet Header Length (IHL).
95   * Added support for matching on VXLAN header last 8-bits reserved field.
96   * Optimized multi-thread flow rule insertion rate.
97
98 * **Added Wangxun ngbe PMD.**
99
100   Added a new PMD driver for Wangxun 1 Gigabit Ethernet NICs.
101   See the :doc:`../nics/ngbe` for more details.
102
103 * **Updated Solarflare network PMD.**
104
105   Updated the Solarflare ``sfc_efx`` driver with changes including:
106
107   * Added COUNT action support for SN1000 NICs
108
109 * **Updated Intel QuickAssist crypto PMD.**
110
111   Added fourth generation of QuickAssist Technology(QAT) devices support.
112   Only symmetric crypto has been currently enabled, compression and asymmetric
113   crypto PMD will fail to create.
114
115 * **Added support for Marvell CNXK crypto driver.**
116
117   * Added cnxk crypto PMD which provides support for an integrated
118     crypto driver for CN9K and CN10K series of SOCs. Support for
119     symmetric crypto algorithms is added to both the PMDs.
120   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
121   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
122
123 * **Updated Marvell OCTEON TX crypto PMD.**
124
125   Added support for crypto adapter OP_FORWARD mode.
126
127 * **Added support for Nvidia crypto device driver.**
128
129   Added mlx5 crypto driver to support AES-XTS cipher operations.
130   The first device to support it is ConnectX-6.
131
132 * **Updated ISAL compress device PMD.**
133
134   The ISAL compress device PMD now supports Arm platforms.
135
136 * **Added Baseband PHY CNXK PMD.**
137
138   Added Baseband PHY PMD which allows to configure BPHY hardware block
139   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
140   usecases. Configuration happens via standard rawdev enq/deq operations. See
141   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
142
143 * **Added support for Marvell CN10K, CN9K, event Rx/Tx adapter.**
144
145   * Added Rx/Tx adapter support for event/cnxk when the ethernet device requested
146     is net/cnxk.
147   * Added support for event vectorization for Rx/Tx adapter.
148
149 * **Added cppc_cpufreq support to Power Management library.**
150
151   Added support for cppc_cpufreq driver which works on most arm64 platforms.
152
153 * **Added multi-queue support to Ethernet PMD Power Management**
154
155   The experimental PMD power management API now supports managing
156   multiple Ethernet Rx queues per lcore.
157
158
159 Removed Items
160 -------------
161
162 .. This section should contain removed items in this release. Sample format:
163
164    * Add a short 1-2 sentence description of the removed item
165      in the past tense.
166
167    This section is a comment. Do not overwrite or remove it.
168    Also, make sure to start the actual text at the margin.
169    =======================================================
170
171
172 API Changes
173 -----------
174
175 .. This section should contain API changes. Sample format:
176
177    * sample: Add a short 1-2 sentence description of the API change
178      which was announced in the previous releases and made in this release.
179      Start with a scope label like "ethdev:".
180      Use fixed width quotes for ``function_names`` or ``struct_names``.
181      Use the past tense.
182
183    This section is a comment. Do not overwrite or remove it.
184    Also, make sure to start the actual text at the margin.
185    =======================================================
186
187 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
188   truncation.
189
190 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
191   to use a callback mechanism.
192
193 * rte_power: The experimental PMD power management API is no longer considered
194   to be thread safe; all Rx queues affected by the API will now need to be
195   stopped before making any changes to the power management scheme.
196
197
198 ABI Changes
199 -----------
200
201 .. This section should contain ABI changes. Sample format:
202
203    * sample: Add a short 1-2 sentence description of the ABI change
204      which was announced in the previous releases and made in this release.
205      Start with a scope label like "ethdev:".
206      Use fixed width quotes for ``function_names`` or ``struct_names``.
207      Use the past tense.
208
209    This section is a comment. Do not overwrite or remove it.
210    Also, make sure to start the actual text at the margin.
211    =======================================================
212
213 * No ABI change that would break compatibility with 20.11.
214
215
216 Known Issues
217 ------------
218
219 .. This section should contain new known issues in this release. Sample format:
220
221    * **Add title in present tense with full stop.**
222
223      Add a short 1-2 sentence description of the known issue
224      in the present tense. Add information on any known workarounds.
225
226    This section is a comment. Do not overwrite or remove it.
227    Also, make sure to start the actual text at the margin.
228    =======================================================
229
230
231 Tested Platforms
232 ----------------
233
234 .. This section should contain a list of platforms that were tested
235    with this release.
236
237    The format is:
238
239    * <vendor> platform with <vendor> <type of devices> combinations
240
241      * List of CPU
242      * List of OS
243      * List of devices
244      * Other relevant details...
245
246    This section is a comment. Do not overwrite or remove it.
247    Also, make sure to start the actual text at the margin.
248    =======================================================