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