doc: announce cryptodev driver interface as internal
[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   use cases. 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 * **Updated testpmd to log errors to stderr.**
174
175   Updated testpmd application to log errors and warnings to stderr
176   instead of stdout used before.
177
178
179 Removed Items
180 -------------
181
182 .. This section should contain removed items in this release. Sample format:
183
184    * Add a short 1-2 sentence description of the removed item
185      in the past tense.
186
187    This section is a comment. Do not overwrite or remove it.
188    Also, make sure to start the actual text at the margin.
189    =======================================================
190
191
192 API Changes
193 -----------
194
195 .. This section should contain API changes. Sample format:
196
197    * sample: Add a short 1-2 sentence description of the API change
198      which was announced in the previous releases and made in this release.
199      Start with a scope label like "ethdev:".
200      Use fixed width quotes for ``function_names`` or ``struct_names``.
201      Use the past tense.
202
203    This section is a comment. Do not overwrite or remove it.
204    Also, make sure to start the actual text at the margin.
205    =======================================================
206
207 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
208   truncation.
209
210 * eal: ``rte_bsf32_safe`` now takes a 32-bit value for its first argument.
211   This fixes warnings about loss of precision
212   when used with some compilers settings.
213
214 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
215   to use a callback mechanism.
216
217 * rte_power: The experimental PMD power management API is no longer considered
218   to be thread safe; all Rx queues affected by the API will now need to be
219   stopped before making any changes to the power management scheme.
220
221
222 ABI Changes
223 -----------
224
225 .. This section should contain ABI changes. Sample format:
226
227    * sample: Add a short 1-2 sentence description of the ABI change
228      which was announced in the previous releases and made in this release.
229      Start with a scope label like "ethdev:".
230      Use fixed width quotes for ``function_names`` or ``struct_names``.
231      Use the past tense.
232
233    This section is a comment. Do not overwrite or remove it.
234    Also, make sure to start the actual text at the margin.
235    =======================================================
236
237 * No ABI change that would break compatibility with 20.11.
238
239
240 Known Issues
241 ------------
242
243 .. This section should contain new known issues in this release. Sample format:
244
245    * **Add title in present tense with full stop.**
246
247      Add a short 1-2 sentence description of the known issue
248      in the present tense. Add information on any known workarounds.
249
250    This section is a comment. Do not overwrite or remove it.
251    Also, make sure to start the actual text at the margin.
252    =======================================================
253
254
255 Tested Platforms
256 ----------------
257
258 .. This section should contain a list of platforms that were tested
259    with this release.
260
261    The format is:
262
263    * <vendor> platform with <vendor> <type of devices> combinations
264
265      * List of CPU
266      * List of OS
267      * List of devices
268      * Other relevant details...
269
270    This section is a comment. Do not overwrite or remove it.
271    Also, make sure to start the actual text at the margin.
272    =======================================================
273
274 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
275
276   * CPU
277
278     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
279     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
280     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
281     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
282     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
283     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
284     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
285     * Intel\ |reg| Xeon\ |reg| Gold 6140M CPU @ 2.30GHz
286     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
287     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
288     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
289     * Intel\ |reg| Xeon\ |reg| Platinum 8180M CPU @ 2.50GHz
290     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
291
292   * OS:
293
294     * Fedora 34
295     * OpenWRT 19.07.4
296     * FreeBSD 12.1
297     * Red Hat Enterprise Linux Server release 8.3
298     * Suse 15 SP2
299     * Ubuntu 20.04
300     * Ubuntu 21.04
301
302   * NICs:
303
304     * Intel\ |reg| Ethernet Controller E810-C for SFP (4x25G)
305
306       * Firmware version: 3.10
307       * Device id (pf/vf): 8086:1593 / 8086:1889
308       * Driver version: 1.7.0 (ice)
309       * OS Default DDP: 1.3.27.0
310       * COMMS DDP: 1.3.31.0
311       * Wireless Edge DDP: 1.3.7.0
312
313     * Intel\ |reg| Ethernet Controller E810-C for QSFP (2x100G)
314
315       * Firmware version: 3.10
316       * Device id (pf/vf): 8086:1592 / 8086:1889
317       * Driver version: 1.7.0 (ice)
318       * OS Default DDP: 1.3.27.0
319       * COMMS DDP: 1.3.31.0
320       * Wireless Edge DDP: 1.3.7.0
321
322     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
323
324       * Firmware version: 0x61bf0001
325       * Device id (pf/vf): 8086:10fb / 8086:10ed
326       * Driver version: 5.1.0-k (ixgbe)
327
328     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
329
330       * Firmware version: 0x800003e7
331       * Device id (pf/vf): 8086:15ad / 8086:15a8
332       * Driver version: 5.1.0-k (ixgbe)
333
334     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
335
336       * Firmware version: 0x8000113b
337       * Device id (pf): 8086:1563
338       * Driver version: 5.11.3 (ixgbe)
339
340     * Intel\ |reg| Ethernet Controller 10-Gigabit X540-AT2
341
342       * Firmware version: 0x800005f9
343       * Device id (pf): 8086:1528
344       * Driver version: 4.18.0-305.7.1.el8_4.x86_64 (ixgbe)
345
346     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
347
348       * Firmware version: 8.30 0x8000a49d 1.2926.0
349       * Device id (pf/vf): 8086:1572 / 8086:154c
350       * Driver version: 2.15.9 (i40e)
351
352     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
353
354       * Firmware version: 5.30 0x80002a29 1.2926.0
355       * Device id (pf/vf): 8086:37d0 / 8086:37cd
356       * Driver version: 2.15.9 (i40e)
357
358     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
359
360       * Firmware version: 4.10 0x80001a7a 1.2154.0
361       * Device id (pf/vf): 8086:37d2 / 8086:37cd
362       * Driver version: 2.15.9 (i40e)
363
364     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
365
366       * Firmware version: 8.30 0x8000a485 1.2926.0
367       * Device id (pf/vf): 8086:158b / 8086:154c
368       * Driver version: 2.15.9 (i40e)
369
370     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
371
372       * Firmware version: 8.30 0x8000a4ae 1.2926.0
373       * Device id (pf/vf): 8086:1583 / 8086:154c
374       * Driver version: 2.15.9 (i40e)
375
376     * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
377
378       * Firmware version: 8.30 0x8000a489 1.2926.0
379       * Device id (pf): 8086:15ff
380       * Driver version: 2.15.9 (i40e)
381
382 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
383
384   * CPU:
385
386     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
387     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
388     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
389     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
390     * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
391     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
392     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v3 @ 2.30GHz
393     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
394     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
395     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
396
397   * OS:
398
399     * Red Hat Enterprise Linux release 8.2 (Ootpa)
400     * Red Hat Enterprise Linux Server release 7.8 (Maipo)
401     * Red Hat Enterprise Linux Server release 7.6 (Maipo)
402     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
403     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
404     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
405     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
406     * Ubuntu 20.04
407     * Ubuntu 18.04
408     * Ubuntu 16.04
409     * SUSE Enterprise Linux 15 SP2
410     * SUSE Enterprise Linux 12 SP4
411
412   * OFED:
413
414     * MLNX_OFED 5.4-1.0.3.0 and above
415     * MLNX_OFED 5.3-1.0.0.1
416
417   * upstream kernel:
418
419     * Linux 5.14.0-rc3 and above
420
421   * rdma-core:
422
423     * rdma-core-36.0 and above
424
425   * NICs:
426
427     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
428
429       * Host interface: PCI Express 3.0 x8
430       * Device ID: 15b3:1007
431       * Firmware version: 2.42.5000
432
433     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
434
435       * Host interface: PCI Express 3.0 x8
436       * Device ID: 15b3:1007
437       * Firmware version: 2.42.5000
438
439     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
440
441       * Host interface: PCI Express 3.0 x8
442       * Device ID: 15b3:1015
443       * Firmware version: 14.31.1014 and above
444
445     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
446
447       * Host interface: PCI Express 3.0 x8
448       * Device ID: 15b3:1015
449       * Firmware version: 14.31.1014 and above
450
451     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
452
453       * Host interface: PCI Express 3.0 x16
454       * Device ID: 15b3:1017
455       * Firmware version: 16.31.1014 and above
456
457     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
458
459       * Host interface: PCI Express 3.0 x16
460       * Device ID: 15b3:1017
461       * Firmware version: 16.31.1014 and above
462
463     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
464
465       * Host interface: PCI Express 3.0 x16
466       * Device ID: 15b3:1017
467       * Firmware version: 16.31.1014 and above
468
469     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
470
471       * Host interface: PCI Express 4.0 x16
472       * Device ID: 15b3:1019
473       * Firmware version: 16.31.1014 and above
474
475     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
476
477       * Host interface: PCI Express 4.0 x16
478       * Device ID: 15b3:101d
479       * Firmware version: 22.31.1014 and above
480
481     * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
482
483       * Host interface: PCI Express 4.0 x8
484       * Device ID: 15b3:101f
485       * Firmware version: 26.31.1014 and above
486
487 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
488
489   * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
490
491     * Host interface: PCI Express 3.0 x16
492     * Device ID: 15b3:a2d6
493     * Firmware version: 24.31.1014 and above
494
495   * Embedded software:
496
497     * CentOS Linux release 7.6.1810 (AltArch)
498     * MLNX_OFED 5.4-1.0.3.0 and above
499     * DPDK application running on Arm cores