doc: consolidate VFIO content on Linux drivers page
[dpdk.git] / doc / guides / rel_notes / release_22_03.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2021 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 22.03
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       ninja -C build doc
21       xdg-open build/doc/guides/html/rel_notes/release_22_03.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 ability to reuse hugepages in Linux.**
59
60   It is possible to reuse files in hugetlbfs to speed up hugepage mapping,
61   which may be useful for fast restart and large allocations.
62   The new mode is activated with ``--huge-unlink=never``
63   and has security implications, refer to the user and programmer guides.
64
65 * **Added functions to calculate UDP/TCP checksum in mbuf.**
66
67   * Added the following functions to calculate UDP/TCP checksum of packets
68     which can be over multi-segments:
69     - ``rte_ipv4_udptcp_cksum_mbuf()``
70     - ``rte_ipv4_udptcp_cksum_mbuf_verify()``
71     - ``rte_ipv6_udptcp_cksum_mbuf()``
72     - ``rte_ipv6_udptcp_cksum_mbuf_verify()``
73
74 * **Added functions to configure flow engine.**
75
76   * Added ``rte_flow_configure`` API to configure flow management
77     engine, allowing to pre-allocate some resources for better performance.
78     Added ``rte_flow_info_get`` API to retrieve available resources.
79
80   * Added ``rte_flow_template_table_create`` API to group flow rules
81     with the same flow attributes and common matching patterns and actions
82     defined by ``rte_flow_pattern_template_create`` and
83     ``rte_flow_actions_template_create`` respectively.
84     Corresponding functions to destroy these entities are:
85     ``rte_flow_template_table_destroy``, ``rte_flow_pattern_template_destroy``
86     and ``rte_flow_actions_template_destroy``.
87
88 * **Added functions for asynchronous flow rules creation/destruction.**
89
90   * Added ``rte_flow_async_create`` and ``rte_flow_async_destroy`` API
91     to enqueue flow creaion/destruction operations asynchronously as well as
92     ``rte_flow_pull`` to poll and retrieve results of these operations and
93     ``rte_flow_push`` to push all the in-flight operations to the NIC.
94
95   * Added asynchronous API for indirect actions management:
96     ``rte_flow_async_action_handle_create``,
97     ``rte_flow_async_action_handle_destroy`` and
98     ``rte_flow_async_action_handle_update``.
99
100 * **Added rte_flow support for matching GRE optional fields.**
101
102   Added ``gre_option`` item in rte_flow to support checksum/key/sequence
103   matching in GRE packets.
104
105 * **Added new RSS offload types for L2TPv2 in RSS flow.**
106
107   Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
108   input set for RSS.
109
110 * **Added IP reassembly Ethernet offload API, to get and set config.**
111
112   Added IP reassembly offload APIs which provide functions to query IP
113   reassembly capabilities, to set configuration and to get currently set
114   reassembly configuration.
115
116 * **Added an API to enable queue based priority flow ctrl(PFC).**
117
118   New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
119   ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
120
121 * **Added a private dump API, to dump private info from device.**
122
123   Added the private dump API which provides querying private info from device.
124   There exists many private properties in different PMD drivers.
125   The information of these properties is important for debug.
126   As the information is private, a dump function is introduced.
127
128 * **Updated AF_XDP PMD**
129
130   * Added support for libxdp >=v1.2.2.
131   * Re-enabled secondary process support. RX/TX is not supported.
132
133 * **Updated Amazon ENA PMD.**
134
135   The new driver version (v2.6.0) introduced bug fixes and improvements, including:
136
137   * Added new checksum related xstats: ``l3_csum_bad``, ``l4_csum_bad`` and
138     ``l4_csum_good``.
139   * Added support for the link status configuration.
140   * Added optimized memcpy support for the ARM platforms.
141   * Added ENA admin queue support for the MP applications.
142   * Added free Tx mbuf on demand feature support.
143   * Added ``rte_eth_xstats_get_names_by_id`` API support.
144   * Added ``miss_txc_to`` device argument for setting the Tx completion timeout.
145
146 * **Updated Cisco enic driver.**
147
148   * Added rte_flow support for matching GENEVE packets.
149   * Added rte_flow support for matching eCPRI packets.
150
151 * **Updated Intel iavf driver.**
152
153   * Added L2TPv2 (include PPP over L2TPv2) RSS support based on outer
154     MAC src/dst address and L2TPv2 session ID.
155   * Added L2TPv2 (include PPP over L2TPv2) FDIR support based on outer
156     MAC src/dst address and L2TPv2 session ID.
157   * Added PPPoL2TPv2oUDP FDIR distribute packets based on inner IP
158     src/dst address and UDP/TCP src/dst port.
159
160 * **Updated Marvell cnxk ethdev PMD.**
161
162   * Added queue based priority flow control support for CN9K & CN10K.
163   * Added support for IP reassembly for inline inbound IPsec packets.
164   * Added support for packet marking in traffic manager.
165   * Added support for CNF95xx B0 variant SoC.
166
167 * **Updated Mellanox mlx5 driver.**
168
169   * Supported ConnectX-7 capability to schedule traffic sending on timestamp.
170   * Added WQE based hardware steering support with ``rte_flow_async`` API.
171   * Added steering for external Rx queue created outside the PMD.
172   * Added GRE optional fields matching.
173
174 * **Updated Wangxun ngbe driver.**
175
176   * Added support for devices of custom PHY interfaces.
177     - M88E1512 PHY connects to RJ45
178     - M88E1512 PHY connects to RGMII combo
179     - YT8521S PHY connects to SFP
180   * Added LED OEM support.
181
182 * **Updated Wangxun txgbe driver.**
183
184   * Added LED OEM support.
185
186 * **Added an API for private user data in asymmetric crypto session.**
187
188   An API was added to get/set an asymmetric crypto session's user data.
189
190 * **Updated Marvell cnxk crypto PMD.**
191
192   * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
193   * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
194   * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
195   * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
196   * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
197   * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
198   * Added AES-CMAC support in CN9K & CN10K.
199   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
200
201 * **Updated Intel QuickAssist Technology crypto PMD.**
202
203   * Added support for CPM2.0b (4942) devices.
204   * Added ECDSA algorithm support.
205   * Added ECPM algorithm support.
206
207 * **Added an API to retrieve event port id of ethdev Rx adapter.**
208
209   The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
210
211 * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.**
212
213   * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD.
214
215 * **Added CNXK GPIO PMD.**
216
217   Added a new rawdevice PMD which allows to manage userspace GPIOs and install
218   custom GPIO interrupt handlers which bypass kernel. This is especially useful
219   for applications, that besides providing standard dataplane functionality
220   want to have fast and low latency access to GPIO pin state.
221
222   See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
223   driver.
224
225 * **Updated testpmd.**
226
227   * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
228     to support software UDP/TCP checksum over multiple segments.
229
230 * **Added crypto producer mode in test-eventdev.**
231
232   * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD
233     modes of event crypto adapter.
234
235
236 Removed Items
237 -------------
238
239 .. This section should contain removed items in this release. Sample format:
240
241    * Add a short 1-2 sentence description of the removed item
242      in the past tense.
243
244    This section is a comment. Do not overwrite or remove it.
245    Also, make sure to start the actual text at the margin.
246    =======================================================
247
248 * **Removed experimental performance thread example application.**
249
250
251 API Changes
252 -----------
253
254 .. This section should contain API changes. Sample format:
255
256    * sample: Add a short 1-2 sentence description of the API change
257      which was announced in the previous releases and made in this release.
258      Start with a scope label like "ethdev:".
259      Use fixed width quotes for ``function_names`` or ``struct_names``.
260      Use the past tense.
261
262    This section is a comment. Do not overwrite or remove it.
263    Also, make sure to start the actual text at the margin.
264    =======================================================
265
266 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
267   ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
268   ``rte_ipv6_udptcp_cksum_mbuf_verify()``
269
270 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
271   which are kept for backward compatibility, are marked as deprecated.
272
273 * cryptodev: The asymmetric session handling was modified to use a single
274   mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
275   to create a mempool with element size big enough to hold the generic asymmetric
276   session header, max size for a device private session data, and user data size.
277   The session structure was moved to ``cryptodev_pmd.h``,
278   hiding it from applications.
279   The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
280   is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
281   return an integer value to indicate initialisation errors.
282
283
284 ABI Changes
285 -----------
286
287 .. This section should contain ABI changes. Sample format:
288
289    * sample: Add a short 1-2 sentence description of the ABI change
290      which was announced in the previous releases and made in this release.
291      Start with a scope label like "ethdev:".
292      Use fixed width quotes for ``function_names`` or ``struct_names``.
293      Use the past tense.
294
295    This section is a comment. Do not overwrite or remove it.
296    Also, make sure to start the actual text at the margin.
297    =======================================================
298
299 * No ABI change that would break compatibility with 21.11.
300
301
302 Known Issues
303 ------------
304
305 .. This section should contain new known issues in this release. Sample format:
306
307    * **Add title in present tense with full stop.**
308
309      Add a short 1-2 sentence description of the known issue
310      in the present tense. Add information on any known workarounds.
311
312    This section is a comment. Do not overwrite or remove it.
313    Also, make sure to start the actual text at the margin.
314    =======================================================
315
316
317 Tested Platforms
318 ----------------
319
320 .. This section should contain a list of platforms that were tested
321    with this release.
322
323    The format is:
324
325    * <vendor> platform with <vendor> <type of devices> combinations
326
327      * List of CPU
328      * List of OS
329      * List of devices
330      * Other relevant details...
331
332    This section is a comment. Do not overwrite or remove it.
333    Also, make sure to start the actual text at the margin.
334    =======================================================
335
336    * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
337
338      * CPU
339
340        * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
341        * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
342        * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
343        * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
344        * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
345        * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
346        * Intel\ |reg| Xeon\ |reg| Gold 6140M CPU @ 2.30GHz
347        * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
348        * Intel\ |reg| Xeon\ |reg| Gold 6348 CPU @ 2.60GHz
349        * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
350        * Intel\ |reg| Xeon\ |reg| Platinum 8180M CPU @ 2.50GHz
351        * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
352        * Intel\ |reg| Xeon\ |reg| Platinum 8380 CPU @ 2.30GHz
353
354      * OS:
355
356        * Fedora 35
357        * OpenWRT 21.02.1
358        * FreeBSD 13.0
359        * Red Hat Enterprise Linux Server release 8.4
360        * Red Hat Enterprise Linux Server release 8.5
361        * Suse 15 SP3
362        * Ubuntu 20.04.3
363        * Ubuntu 21.10
364
365      * NICs:
366
367        * Intel\ |reg| Ethernet Controller E810-C for SFP (4x25G)
368
369          * Firmware version: 3.22 0x8000d83c 1.3146.0
370          * Device id (pf/vf): 8086:1593 / 8086:1889
371          * Driver version: 1.8.3_2_g5c2ff303 (ice)
372          * OS Default DDP: 1.3.28.0
373          * COMMS DDP: 1.3.35.0
374          * Wireless Edge DDP: 1.3.8.0
375
376        * Intel\ |reg| Ethernet Controller E810-C for QSFP (2x100G)
377
378          * Firmware version: 3.20 0x8000d83e 1.3146.0
379          * Device id (pf/vf): 8086:1592 / 8086:1889
380          * Driver version: 1.8.3_2_g5c2ff303 (ice)
381          * OS Default DDP: 1.3.28.0
382          * COMMS DDP: 1.3.35.0
383          * Wireless Edge DDP: 1.3.8.0
384
385        * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
386
387          * Firmware version: 0x61bf0001
388          * Device id (pf/vf): 8086:10fb / 8086:10ed
389          * Driver version(in-tree): 5.1.0-k (ixgbe)
390          * Driver version(out-tree): 5.13.4 (ixgbe)
391
392        * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
393
394          * Firmware version(PF): 8.30 0x8000a49d 1.2926.0
395          * Firmware version(VF): 8.50 0x8000b6d9 1.3082.0
396          * Device id (pf/vf): 8086:1572 / 8086:154c
397          * Driver version: 2.17.15 (i40e)
398
399        * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (2x10G)
400
401          * Firmware version: 5.50 0x80003327 1.3082.0
402          * Device id (pf/vf): 8086:37d0 / 8086:37cd
403          * Driver version(out-tree): 2.17.15 (i40e)
404          * Driver version(in-tree): 2.8.20-k (i40e)
405
406        * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T
407
408          * Firmware version: 5.50 0x800032e0 1.2935.0
409          * Device id (pf/vf): 8086:37d2 / 8086:37cd
410          * Driver version(out-tree): 2.17.15 (i40e)
411          * Driver version(in-tree): 2.8.20-k (i40e)
412
413        * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
414
415          * Firmware version(PF): 8.30 0x8000a483 1.2926.0
416          * Firmware version(VF): 8.50 0x8000b703 1.3082.0
417          * Device id (pf/vf): 8086:158b / 8086:154c
418          * Driver version: 2.17.15 (i40e)
419
420        * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
421
422          * Firmware version(PF): 8.30 0x8000a4ae 1.2926.0
423          * Firmware version(VF): 8.50 0x8000b6c7 1.3082.0
424          * Device id (pf/vf): 8086:1583 / 8086:154c
425          * Driver version: 2.17.15 (i40e)
426
427        * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
428
429          * Firmware version: 8.30 0x8000a489 1.2879.0
430          * Device id (pf): 8086:15ff
431          * Driver version: 2.17.15 (i40e)
432
433 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
434
435   * CPU:
436
437     * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
438     * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
439     * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
440     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
441     * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
442     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
443     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v3 @ 2.30GHz
444     * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
445     * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
446     * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
447
448   * OS:
449
450     * Red Hat Enterprise Linux release 8.2 (Ootpa)
451     * Red Hat Enterprise Linux Server release 7.8 (Maipo)
452     * Red Hat Enterprise Linux Server release 7.6 (Maipo)
453     * Red Hat Enterprise Linux Server release 7.5 (Maipo)
454     * Red Hat Enterprise Linux Server release 7.4 (Maipo)
455     * Red Hat Enterprise Linux Server release 7.3 (Maipo)
456     * Red Hat Enterprise Linux Server release 7.2 (Maipo)
457     * Ubuntu 20.04
458     * Ubuntu 18.04
459     * Ubuntu 16.04
460     * SUSE Enterprise Linux 15 SP2
461     * SUSE Enterprise Linux 12 SP4
462
463   * OFED:
464
465     * MLNX_OFED 5.5-1.0.3.2 and above
466     * MLNX_OFED 5.4-3.1.0.0
467
468   * upstream kernel:
469
470     * Linux 5.17.0-rc4 and above
471
472   * rdma-core:
473
474     * rdma-core-39.0 and above
475
476   * NICs:
477
478     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
479
480       * Host interface: PCI Express 3.0 x8
481       * Device ID: 15b3:1007
482       * Firmware version: 2.42.5000
483
484     * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
485
486       * Host interface: PCI Express 3.0 x8
487       * Device ID: 15b3:1007
488       * Firmware version: 2.42.5000
489
490     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
491
492       * Host interface: PCI Express 3.0 x8
493       * Device ID: 15b3:1015
494       * Firmware version: 14.32.1010 and above
495
496     * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
497
498       * Host interface: PCI Express 3.0 x8
499       * Device ID: 15b3:1015
500       * Firmware version: 14.32.1010 and above
501
502     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
503
504       * Host interface: PCI Express 3.0 x16
505       * Device ID: 15b3:1017
506       * Firmware version: 16.32.1010 and above
507
508     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
509
510       * Host interface: PCI Express 3.0 x16
511       * Device ID: 15b3:1017
512       * Firmware version: 16.32.1010 and above
513
514     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
515
516       * Host interface: PCI Express 3.0 x16
517       * Device ID: 15b3:1017
518       * Firmware version: 16.32.1010 and above
519
520     * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
521
522       * Host interface: PCI Express 4.0 x16
523       * Device ID: 15b3:1019
524       * Firmware version: 16.32.1010 and above
525
526     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
527
528       * Host interface: PCI Express 4.0 x16
529       * Device ID: 15b3:101d
530       * Firmware version: 22.32.1010 and above
531
532     * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
533
534       * Host interface: PCI Express 4.0 x8
535       * Device ID: 15b3:101f
536       * Firmware version: 26.32.1010 and above
537
538 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
539
540   * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
541
542     * Host interface: PCI Express 3.0 x16
543     * Device ID: 15b3:a2d6
544     * Firmware version: 24.32.2004 and above
545
546   * Embedded software:
547
548     * Ubuntu 20.04.3
549     * MLNX_OFED 5.5-2.1.7.0 and above
550     * DPDK application running on Arm cores
551
552 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
553
554   * CPU:
555
556     * POWER9 2.2 (pvr 004e 1202)
557
558   * OS:
559
560     * Red Hat Enterprise Linux Server release 8.2
561
562   * NICs:
563
564     * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
565
566       * Host interface: PCI Express 4.0 x16
567       * Device ID: 15b3:1017
568       * Firmware version: 16.32.1010
569
570     * Mellanox\ |reg| ConnectX\ |reg|-6 Dx 100G MCX623106AN-CDAT (2x100G)
571
572       * Host interface: PCI Express 4.0 x16
573       * Device ID: 15b3:101d
574       * Firmware version: 22.32.1010
575
576   * OFED:
577
578     * MLNX_OFED 5.5-1.0.3.2