1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
21 xdg-open build/doc/html/guides/rel_notes/release_21_02.html
25 A **dependency** has been added for building DPDK on Linux or FreeBSD:
26 the Python module **pyelftools** (version **0.22** or greater),
27 often packaged as python3-pyelftools, is required.
29 If not available as a distribution package, it can be installed with::
31 pip3 install pyelftools
37 .. This section should contain new features added in this release.
40 * **Add a title in the past tense with a full stop.**
42 Add a short 1-2 sentence description in the past tense.
43 The description should be enough to allow someone scanning
44 the release notes to understand the new feature.
46 If the feature adds a lot of sub-features you can use a bullet list
49 * Added feature foo to do something.
50 * Enhanced feature bar to do something else.
52 Refer to the previous release notes for examples.
54 Suggested order in release notes items:
55 * Core libs (EAL, mempool, ring, mbuf, buses)
56 * Device abstraction libs and PMDs
58 - cryptodev (lib, PMDs)
59 - eventdev (lib, PMDs)
62 * Apps, Examples, Tools (if significant)
64 This section is a comment. Do not overwrite or remove it.
65 Also, make sure to start the actual text at the margin.
66 =======================================================
68 * **Added new ethdev API for PMD power management.**
70 Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
71 ``rte_power_monitor()`` to enable automatic power management for PMDs.
73 * **Added Ethernet PMD power management helper API.**
75 A new helper API has been added to make using Ethernet PMD power management
76 easier for the user: ``rte_power_ethdev_pmgmt_queue_enable()``. Three power
77 management schemes are supported initially:
79 * Power saving based on UMWAIT instruction (x86 only)
80 * Power saving based on ``rte_pause()`` (generic) or TPAUSE instruction (x86 only)
81 * Power saving based on frequency scaling through the ``librte_power`` library
83 * **Added GENEVE TLV option in rte_flow.**
85 Added support for matching and raw encap/decap of GENEVE TLV option.
87 * **Added support for Modify field action in the flow API.**
89 Added "modify" action support to rte_flow to perform various operations on
90 any arbitrary header field (as well as mark, metadata or tag values):
91 ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``.
92 Supported operations are: overwriting a field with the content from
93 another field, addition and subtraction using an immediate value.
95 * **Updated Broadcom bnxt driver.**
97 Updated the Broadcom bnxt driver with fixes and improvements, including:
99 * Added support for Stingray2 device.
101 * **Updated Cisco enic driver.**
103 * Added support for 64B completion queue entries.
105 * **Updated Hisilicon hns3 driver.**
107 * Added support for traffic management.
109 * **Updated Intel i40e driver.**
111 * Added Intel i40e support on Windows.
113 * **Updated Intel ice driver.**
115 Updated the Intel ice driver with new features and improvements, including:
117 * Added Double VLAN support for DCF switch QinQ filtering.
118 * Added support for UDP dynamic port assignment for eCPRI tunnels in DCF.
120 * **Updated Intel iavf driver.**
122 Updated iavf PMD with new features and improvements, including:
124 * Added support for FDIR/RSS packet steering for eCPRI flow.
125 * Added support for FDIR TCP/UDP pattern without input set.
127 * **Updated Mellanox mlx5 driver.**
129 Updated the Mellanox mlx5 driver with new features and improvements, including:
131 * Introduced basic support on Windows.
132 * Added GTP PDU session container matching and raw encap/decap.
133 * Added support for a RSS action in the sample sub-actions list.
134 * Added support for E-Switch mirroring and jump action in the same flow.
135 * Added support to handle the modify action in correct order regarding the
136 mirroring action on E-Switch.
137 * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or
138 egress flow groups greater than 0 and for any transfer flow group.
139 * Added support for the Tx mbuf fast free offload.
140 * Added support for flow modify field action.
141 * Added support for flow integrity item.
143 * **Updated the Pensando ionic driver.**
145 Updated the Pensando ionic driver with new features and improvements, including:
147 * Fixed bugs related to link autonegotiation.
148 * Fixed bugs related to port start/stop and queue start/stop.
149 * Added support for probing the supported queue versions. Note that
150 extremely old (pre-1.0) firmware will no longer be usable with the PMD.
151 * Removed unused code.
152 * Reduced device startup time.
154 * **Updated Wangxun txgbe driver.**
156 Updated the Wangxun txgbe driver with new features and improvements, including:
158 * Add support for generic flow API.
159 * Add support for traffic manager.
160 * Add support for IPsec.
162 * **Updated GSO support.**
164 * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
166 * **Added enqueue and dequeue callback APIs for cryptodev library.**
168 The Cryptodev library has been enhanced with enqueue and dequeue callback APIs to
169 enable applications to add/remove user callbacks which get called
170 for every enqueue/dequeue operation.
172 * **Updated the OCTEON TX2 crypto PMD.**
174 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
175 ESN and anti-replay support.
176 * Updated the OCTEON TX2 crypto PMD with CN98xx support.
177 * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
178 PMD lookaside protocol offload for IPsec.
179 * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
180 crypto PMD lookaside protocol offload for IPsec.
182 * **Added mlx5 compress PMD.**
184 Added a new compress PMD driver for Bluefield 2 adapters.
186 See the :doc:`../compressdevs/mlx5` for more details.
188 * **Added python script to run crypto perf tests and graph the results.**
190 A new Python script has been added to automate running crypto performance
191 tests and output graphed results to PDF files.
192 See the :doc:`../tools/cryptoperf` guide for more details.
194 * **Added Windows support to pmdinfogen.**
196 PMD information strings were added for Windows as well as for other OS.
197 Extracting them from Windows DLL is not yet supported.
198 The build-time tool pmdinfogen was rewritten in Python,
199 thus libelf dependency was replaced with pyelftools as new build dependency.
201 * **Added support for build-time checking of header includes.**
203 A new build option ``check_includes`` has been added, which, when enabled,
204 will perform build-time checking on DPDK public header files, to ensure none
205 are missing dependent header includes. This feature, disabled by default, is
206 intended for use by developers contributing to the DPDK SDK itself, and is
207 integrated into the build scripts and automated CI for patch contributions.
213 .. This section should contain removed items in this release. Sample format:
215 * Add a short 1-2 sentence description of the removed item
218 This section is a comment. Do not overwrite or remove it.
219 Also, make sure to start the actual text at the margin.
220 =======================================================
222 * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
223 ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
224 ``ninja install`` action and are renamed to ``ethdev_driver.h``,
225 ``ethdev_vdev.h`` and ``ethdev_pci.h`` respectively in the source tree, to
226 reflect the fact that they are non-public headers.
228 * The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h``
229 and ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK
230 ``ninja install`` action and are renamed to ``eventdev_pmd.h``,
231 ``eventdev_pmd_vdev.h`` and ``eventdev_pmd_pci.h`` respectively in the source
232 tree, to reflect the fact that they are non-public headers.
234 * Removed support for NetXtreme devices belonging to ``BCM573xx and
235 BCM5740x`` families. Specifically the support for the following Broadcom
236 PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
237 ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
239 * The ``check-includes.sh`` script for checking DPDK header files has been
240 removed, being replaced by the ``check_includes`` build option described
247 .. This section should contain API changes. Sample format:
249 * sample: Add a short 1-2 sentence description of the API change
250 which was announced in the previous releases and made in this release.
251 Start with a scope label like "ethdev:".
252 Use fixed width quotes for ``function_names`` or ``struct_names``.
255 This section is a comment. Do not overwrite or remove it.
256 Also, make sure to start the actual text at the margin.
257 =======================================================
259 * config: Removed the old macros, included in ``rte_config.h``,
260 to indicate which DPDK libraries and drivers are built.
261 The new macros are generated by meson in a standardized format:
262 ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
263 the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
264 and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
266 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
267 for adding enqueue and dequeue callbacks.
273 .. This section should contain ABI changes. Sample format:
275 * sample: Add a short 1-2 sentence description of the ABI change
276 which was announced in the previous releases and made in this release.
277 Start with a scope label like "ethdev:".
278 Use fixed width quotes for ``function_names`` or ``struct_names``.
281 This section is a comment. Do not overwrite or remove it.
282 Also, make sure to start the actual text at the margin.
283 =======================================================
285 * No ABI change that would break compatibility with 20.11.
287 * The experimental function ``rte_telemetry_init`` has been removed from the
288 public API and is now an internal-only function. Where telemetry library is
289 available, it is called automatically from ``rte_eal_init()`` and so no end
290 application need use it.
296 .. This section should contain a list of platforms that were tested
301 * <vendor> platform with <vendor> <type of devices> combinations
306 * Other relevant details...
308 This section is a comment. Do not overwrite or remove it.
309 Also, make sure to start the actual text at the margin.
310 =======================================================
312 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
316 * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
317 * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
318 * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
319 * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
320 * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
321 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
322 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
323 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
324 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
325 * Intel\ |reg| Xeon\ |reg| Gold 5218N CPU @ 2.30GHz
326 * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
327 * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
328 * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
329 * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
338 * Red Hat Enterprise Linux Server release 8.3
345 * Intel\ |reg| Ethernet Controller E810-C for SFP (4x25G)
347 * Firmware version: 2.40
348 * Device id (pf/vf): 8086:1593 / 8086:1889
349 * Driver version: 1.4.5 (ice)
350 * OS Default DDP: 1.3.21.0
351 * COMMS DDP: 1.3.25.0
352 * Wireless Edge DDP: 1.3.1.0
354 * Intel\ |reg| Ethernet Controller E810-C for QSFP (2x100G)
356 * Firmware version: 2.40
357 * Device id (pf/vf): 8086:1592 / 8086:1889
358 * Driver version: 1.4.5 (ice)
359 * OS Default DDP: 1.3.21.0
360 * COMMS DDP: 1.3.25.0
361 * Wireless Edge DDP: 1.3.1.0
363 * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
365 * Firmware version: 0x61bf0001
366 * Device id (pf/vf): 8086:10fb / 8086:10ed
367 * Driver version: 5.10.2 (ixgbe)
369 * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
371 * Firmware version: 0x800003e7
372 * Device id (pf/vf): 8086:15ad / 8086:15a8
373 * Driver version: 5.1.0-k (ixgbe)
375 * Intel\ |reg| Corporation Ethernet Controller 10G X550T
377 * Firmware version: 0x80000482
378 * Device id (pf): 8086:1563
379 * Driver version: 5.10.2 (ixgbe)
381 * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
383 * Firmware version: 8.00 0x80008b82 1.2766.0
384 * Device id (pf/vf): 8086:1572 / 8086:154c
385 * Driver version: 2.14.13 (i40e)
387 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
389 * Firmware version: 5.00 0x800023c3 1.2766.0
390 * Device id (pf/vf): 8086:37d0 / 8086:37cd
391 * Driver version: 2.14.13 (i40e)
393 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
395 * Firmware version: 4.10 0x80001a7a
396 * Device id (pf/vf): 8086:37d2 / 8086:37cd
397 * Driver version: 2.14.13 (i40e)
399 * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
401 * Firmware version: 8.00 0x80008c1a 1.2766.0
402 * Device id (pf/vf): 8086:158b / 8086:154c
403 * Driver version: 2.14.13 (i40e)
405 * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
407 * Firmware version: 8.00 0x80008b82 1.2766.0
408 * Device id (pf/vf): 8086:1583 / 8086:154c
409 * Driver version: 2.14.13 (i40e)
411 * Intel\ |reg| Corporation I350 Gigabit Network Connection
413 * Firmware version: 1.63, 0x80000cbc
414 * Device id (pf/vf): 8086:1521 / 8086:1520
415 * Driver version: 5.6.0-k (igb)
417 * Intel\ |reg| Corporation I210 Gigabit Network Connection
419 * Firmware version: 3.25, 0x800006eb
420 * Device id (pf): 8086:1533
421 * Driver version: 5.6.0-k (igb)
423 * Intel\ |reg| Ethernet Controller 10-Gigabit X540-AT2
425 * Firmware version: 0x800005f9
426 * Device id (pf): 8086:1528
427 * Driver version: 5.1.0-k (ixgbe)
429 * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
431 * Firmware version: 8.00 0x80008d10 1.2766.0
432 * Device id (pf): 8086:15ff
433 * Driver version: 2.14.13 (i40e)
435 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
439 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
440 * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
441 * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
442 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
443 * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
444 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
445 * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
446 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
447 * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
451 * Red Hat Enterprise Linux release 8.2 (Ootpa)
452 * Red Hat Enterprise Linux Server release 7.8 (Maipo)
453 * Red Hat Enterprise Linux Server release 7.6 (Maipo)
454 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
455 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
456 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
457 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
461 * SUSE Enterprise Linux 15 SP2
462 * SUSE Enterprise Linux 12 SP4
466 * MLNX_OFED 5.2-2.2.0.0 and above
467 * MLNX_OFED 5.1-2.5.8.0
471 * Linux 5.11.0-rc7 and above
475 * rdma-core-33.1-1 and above
479 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
481 * Host interface: PCI Express 3.0 x8
482 * Device ID: 15b3:1007
483 * Firmware version: 2.42.5000
485 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
487 * Host interface: PCI Express 3.0 x8
488 * Device ID: 15b3:1007
489 * Firmware version: 2.42.5000
491 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
493 * Host interface: PCI Express 3.0 x8
494 * Device ID: 15b3:1015
495 * Firmware version: 14.29.2002 and above
497 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
499 * Host interface: PCI Express 3.0 x8
500 * Device ID: 15b3:1015
501 * Firmware version: 14.29.2002 and above
503 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
505 * Host interface: PCI Express 3.0 x16
506 * Device ID: 15b3:1017
507 * Firmware version: 16.29.2002 and above
509 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
511 * Host interface: PCI Express 3.0 x16
512 * Device ID: 15b3:1017
513 * Firmware version: 16.29.2002 and above
515 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
517 * Host interface: PCI Express 3.0 x16
518 * Device ID: 15b3:1017
519 * Firmware version: 16.29.2002 and above
521 * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
523 * Host interface: PCI Express 4.0 x16
524 * Device ID: 15b3:1019
525 * Firmware version: 16.29.2002 and above
527 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
529 * Host interface: PCI Express 4.0 x16
530 * Device ID: 15b3:101d
531 * Firmware version: 22.29.2002 and above
533 * Mellanox\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
535 * Host interface: PCI Express 4.0 x8
536 * Device ID: 15b3:101f
537 * Firmware version: 26.29.2002 and above
539 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
541 * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
543 * Host interface: PCI Express 3.0 x16
544 * Device ID: 15b3:a2d2
545 * Firmware version: 24.29.2002 and above
549 * CentOS Linux release 7.6.1810 (AltArch)
550 * MLNX_OFED 5.2-2.2.0 and above
551 * DPDK application running on Arm cores
553 * Intel\ |reg| platforms with Broadcom\ |reg| NICs combinations
557 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
558 * Intel\ |reg| Xeon\ |reg| CPU E5-2667 v3 @ 3.20GHz
559 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v2 @ 2.60GHz
560 * Intel\ |reg| Xeon\ |reg| Gold 6142 CPU @ 2.60GHz
561 * Intel\ |reg| Xeon\ |reg| CPU E3-1270 v3 @ 3.50GHz
562 * Intel\ |reg| Xeon\ |reg| Gold 6134M CPU @ 3.20GHz
566 * Red Hat Enterprise Linux Server release 8.1
567 * Red Hat Enterprise Linux Server release 7.6
578 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P225p (2x25G)
580 * Host interface: PCI Express 3.0 x8
581 * Firmware version: 214.4.114.0 and above
583 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
585 * Host interface: PCI Express 3.0 x16
586 * Firmware version: 218.0.124.0 and above
588 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
590 * Host interface: PCI Express 3.0 x16
591 * Firmware version: 218.0.124.0 and above
593 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
595 * Host interface: PCI Express 4.0 x16
596 * Firmware version: 218.0.124.0 and above
598 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
600 * Host interface: PCI Express 4.0 x16
601 * Firmware version: 218.0.124.0 and above
603 * Broadcom\ |reg| NetXtreme-S\ |reg| Series SmartNIC
605 * Broadcom\ |reg| NetXtreme-S\ |reg| Series PS225-H16 SmartNIC (2x25G)
607 * Host interface: PCI Express 3.0 x8
608 * Firmware version: 218.1.143.0
612 * Broadcom Yocto Linux
613 * Kernel version: 4.14.196
614 * DPDK application running on 8 Arm Cortex-A72 cores
616 * NXP ARMv8 SoCs (with integrated NICs)
620 * LX2xxx, LS2xxx, LS10xx
622 * OS (based on NXP LSDK-20.04):
624 * Kernel version: 4.19.90
625 * Kernel version: 5.4.47