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::
22 xdg-open build/doc/html/guides/rel_notes/release_20_08.html
28 .. This section should contain new features added in this release.
31 * **Add a title in the past tense with a full stop.**
33 Add a short 1-2 sentence description in the past tense.
34 The description should be enough to allow someone scanning
35 the release notes to understand the new feature.
37 If the feature adds a lot of sub-features you can use a bullet list
40 * Added feature foo to do something.
41 * Enhanced feature bar to do something else.
43 Refer to the previous release notes for examples.
45 Suggested order in release notes items:
46 * Core libs (EAL, mempool, ring, mbuf, buses)
47 * Device abstraction libs and PMDs
49 - cryptodev (lib, PMDs)
50 - eventdev (lib, PMDs)
53 * Apps, Examples, Tools (if significant)
55 This section is a comment. Do not overwrite or remove it.
56 Also, make sure to start the actual text at the margin.
57 =========================================================
59 * **Added non-EAL threads registration API.**
61 Added a new API to register non-EAL threads as lcores. This can be used by
62 applications to have its threads known to DPDK without suffering from the
63 non-EAL previous limitations in terms of performance.
65 * **rte_*mb APIs are updated to use the DMB instruction for ARMv8.**
67 ARMv8 memory model has been strengthened to require other-multi-copy
68 atomicity. This allows for using the DMB instruction instead of DSB for IO
69 barriers. The rte_*mb APIs, for ARMv8 platforms, have changed to use the DMB
70 instruction to reflect this.
72 * **Added support for RTS and HTS modes into mempool ring driver.**
74 Added the ability to select new ring synchronisation modes:
75 ``relaxed tail sync (ring_mt_rts)`` and ``head/tail sync (ring_mt_hts)``
76 via the mempool ops API.
78 * **Added the support for vfio-pci new VF token interface.**
80 From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created
81 VFs, where it uses a shared VF token (UUID) to represent the collaboration
82 between PF and VFs. The DPDK PCI driver has been updated to gain the access
83 to the PF and VFs devices by appending the VF token parameter.
85 * **Added the RegEx Library, a generic RegEx service library.**
87 Added the RegEx library which provides an API for offload of regular
88 expressions search operations to hardware or software accelerator devices.
90 Added Mellanox RegEx PMD, allowing to offload RegEx searches.
92 * **Added vhost async data path APIs.**
94 4 new APIs have been added to enable vhost async data path, including:
96 * Async device channel register/unregister APIs.
97 * Async packets enqueue/completion APIs (only split ring was implemented).
99 * **Added vDPA device APIs to query virtio queue statistics.**
101 Added new vDPA APIs to query virtio queue statistics, to get their names and
104 * **Updated Mellanox mlx5 vDPA driver.**
106 Updated Mellanox mlx5 vDPA driver with new features, including:
108 * Added support for virtio queue statistics.
109 * Added support for MTU update.
111 * **Added eCPRI protocol support in rte_flow.**
113 The ``ECPRI`` item has been added to support eCPRI packet offloading for
116 * **Introduced send packet scheduling based on timestamps.**
118 Added a new mbuf dynamic field and flag to provide a timestamp on which
119 packet transmitting can be synchronized. A device Tx offload flag has been
120 added to indicate the PMD supports send scheduling.
122 * **Updated PCAP driver.**
124 Updated PCAP driver with new features and improvements, including:
126 * Support software Tx nanosecond timestamps precision.
128 * **Updated Broadcom bnxt driver.**
130 Updated the Broadcom bnxt driver with new features and improvements, including:
132 * Added support for VF representors.
133 * Added support for multiple devices.
134 * Added support for new resource manager API.
135 * Added support for VXLAN encap/decap.
136 * Added support for rte_flow_query for COUNT action.
137 * Added support for rx_burst_mode_get and tx_burst_mode_get.
138 * Added vector mode support for ARM CPUs.
139 * Added support for VLAN push and pop actions.
140 * Added support for NAT action items.
141 * Added TruFlow hash API for common hash uses across TruFlow core functions.
143 * **Updated Cisco enic driver.**
145 * Added support for VLAN push and pop flow actions.
147 * **Updated Hisilicon hns3 driver.**
149 * Added support for 200G speed rate.
150 * Added support for copper media type.
151 * Added support for keeping CRC.
152 * Added support for LRO.
153 * Added support for setting VF PVID by PF driver.
155 * **Updated Intel ice driver.**
157 Updated the Intel ice driver with new features and improvements, including:
159 * Added support for DCF datapath configuration.
160 * Added support for more PPPoE packet type for switch filter.
161 * Added RSS support for IPv6 32bit, 48bit, 64bit prefix.
162 * Added RSS support for GTPU, L2TP, ESP, AH, PFCP and PPPoE.
163 * Added support for FDIR filter by GTPU outer IPv4 and IPv6.
165 * **Updated Intel iavf driver.**
167 Updated iavf PMD with new features and improvements, including:
169 * Added support for FDIR filter by GTPU outer IPv4 and IPv6.
170 * Added IPv6 RSS support for GTPU.
172 * **Updated Intel i40e driver.**
174 Updated i40e PMD with new features and improvements, including:
176 * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
177 * Re-implemented ``get_fdir_info`` and ``get_fdir_stat`` in private API.
178 * Re-implemented ``set_gre_key_len`` in private API.
179 * Added support for flow query RSS.
181 * **Updated Intel ixgbe driver.**
183 Updated the Intel ixgbe driver with new features and improvements, including:
185 * Re-implemented ``get_fdir_info`` and ``get_fdir_stat`` in private API.
187 * **Updated Marvell octeontx2 ethdev PMD.**
189 Updated Marvell octeontx2 driver with cn98xx support.
191 * **Updated Mellanox mlx5 net driver and common layer.**
193 Updated Mellanox mlx5 driver with new features and improvements, including:
195 * Added mlx5 PCI layer to share a PCI device among multiple PMDs.
196 * Added support for eCPRI protocol offloading.
197 * Added devargs options ``reclaim_mem_mode``, ``sys_mem_en``,
198 ``lacp_by_user`` and ``decap_en``.
200 * **Updated NXP dpaa ethdev PMD.**
202 Updated the NXP dpaa ethdev with new features and improvements, including:
204 * Added support for link status and interrupt.
205 * Added support to use datapath APIs from non-EAL pthread.
207 * **Updated NXP dpaa2 ethdev PMD.**
209 Updated the NXP dpaa2 ethdev with new features and improvements, including:
211 * Added support to use datapath APIs from non-EAL pthread.
212 * Added support for dynamic flow management.
214 * **Added DOCSIS protocol to rte_security.**
216 Added support for combined crypto and CRC operations for the DOCSIS protocol
217 to ``rte_security`` API.
219 * **Updated the AESNI MB crypto PMD.**
221 Added support for lookaside protocol offload for DOCSIS through the
222 ``rte_security`` API.
224 * **Updated the QuickAssist Technology (QAT) PMD.**
226 * Added support for lookaside protocol offload in QAT crypto PMD
227 for DOCSIS through the ``rte_security`` API.
228 * Added Chacha20-Poly1305 AEAD algorithm in QAT crypto PMD.
229 * Improved handling of multi process in QAT crypto and compression PMDs.
230 * Added support for Intel GEN2 QuickAssist device 200xx
231 (PF device id 0x18ee, VF device id 0x18ef).
233 * **Updated the OCTEON TX2 crypto PMD.**
235 * Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
237 * Updated the OCTEON TX2 crypto PMD to support ``rte_security`` lookaside
238 protocol offload for IPsec.
240 * **Added support for BPF_ABS/BPF_IND load instructions.**
242 Added support for two BPF non-generic instructions:
243 ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
244 which are used to access packet data in a safe manner. Currently JIT support
245 for these instructions is implemented for x86 only.
247 * **Added new testpmd forward mode.**
249 Added new ``5tswap`` forward mode to testpmd.
250 the ``5tswap`` swaps source and destination in layers 2,3,4
251 for ipv4 and ipv6 in L3 and UDP and TCP in L4.
253 * **Added flow performance test application.**
255 Added new application to test ``rte_flow`` performance, including:
257 * Measure ``rte_flow`` insertion rate.
258 * Measure ``rte_flow`` deletion rate.
259 * Dump ``rte_flow`` memory consumption.
260 * Measure packet per second forwarding.
262 * **Added --portmap command line parameter to l2fwd example.**
264 Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
265 pass forwarding port details.
266 See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
267 details of this parameter usage.
269 * **Updated ipsec-secgw sample application.**
271 Added ``rte_flow`` based rules, which allows hardware parsing and steering
272 of ingress packets to specific NIC queues.
273 See the :doc:`../sample_app_ug/ipsec_secgw` for more details.
279 .. This section should contain removed items in this release. Sample format:
281 * Add a short 1-2 sentence description of the removed item
284 This section is a comment. Do not overwrite or remove it.
285 Also, make sure to start the actual text at the margin.
286 =========================================================
288 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
294 .. This section should contain API changes. Sample format:
296 * sample: Add a short 1-2 sentence description of the API change
297 which was announced in the previous releases and made in this release.
298 Start with a scope label like "ethdev:".
299 Use fixed width quotes for ``function_names`` or ``struct_names``.
302 This section is a comment. Do not overwrite or remove it.
303 Also, make sure to start the actual text at the margin.
304 =========================================================
306 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
308 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
309 queue and not per device, a qid parameter was added to the arguments list.
315 .. This section should contain ABI changes. Sample format:
317 * sample: Add a short 1-2 sentence description of the ABI change
318 which was announced in the previous releases and made in this release.
319 Start with a scope label like "ethdev:".
320 Use fixed width quotes for ``function_names`` or ``struct_names``.
323 This section is a comment. Do not overwrite or remove it.
324 Also, make sure to start the actual text at the margin.
325 =========================================================
327 * No ABI change that would break compatibility with 19.11.
333 .. This section should contain new known issues in this release. Sample format:
335 * **Add title in present tense with full stop.**
337 Add a short 1-2 sentence description of the known issue
338 in the present tense. Add information on any known workarounds.
340 This section is a comment. Do not overwrite or remove it.
341 Also, make sure to start the actual text at the margin.
342 =========================================================
344 * **mlx5 PMD does not work on Power 9 with OFED 5.1-0.6.6.0.**
346 Consider using the newer OFED releases, the previous
347 OFED 5.0-2.1.8.0, or upstream rdma-core library v29 and above.
353 .. This section should contain a list of platforms that were tested
358 * <vendor> platform with <vendor> <type of devices> combinations
363 * Other relevant details...
365 This section is a comment. Do not overwrite or remove it.
366 Also, make sure to start the actual text at the margin.
367 =========================================================
369 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
373 * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
374 * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
375 * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
376 * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
377 * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
378 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
379 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
380 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
381 * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
382 * Intel\ |reg| Xeon\ |reg| Gold 5218N CPU @ 2.30GHz
383 * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
384 * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
385 * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
386 * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
396 * Red Hat Enterprise Linux Server release 8.2
404 * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
406 * Firmware version: 0x61bf0001
407 * Device id (pf/vf): 8086:10fb / 8086:10ed
408 * Driver version: 5.7.1 (ixgbe)
410 * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
412 * Firmware version: 0x800003e7
413 * Device id (pf/vf): 8086:15ad / 8086:15a8
414 * Driver version: 5.1.0-k (ixgbe)
416 * Intel\ |reg| Corporation Ethernet Controller 10G X550T
418 * Firmware version: 0x80000482
419 * Device id (pf): 8086:1563
420 * Driver version: 5.7.1 (ixgbe)
422 * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
424 * Firmware version: 7.20 0x800079e8 1.2585.0
425 * Device id (pf/vf): 8086:1572 / 8086:154c
426 * Driver version: 2.12.6 (i40e)
428 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
430 * Firmware version: 4.11 0x80001def 1.1999.0
431 * Device id (pf/vf): 8086:37d0 / 8086:37cd
432 * Driver version: 2.12.6 (i40e)
434 * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
436 * Firmware version: 4.10 0x80001a7a
437 * Device id (pf/vf): 8086:37d2 / 8086:37cd
438 * Driver version: 2.12.6 (i40e)
440 * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
442 * Firmware version: 7.30 0x800080a2 1.2658.0
443 * Device id (pf/vf): 8086:158b / 8086:154c
444 * Driver version: 2.12.6 (i40e)
446 * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
448 * Firmware version: 7.30 0x800080ab 1.2658.0
449 * Device id (pf/vf): 8086:1583 / 8086:154c
450 * Driver version: 2.12.6 (i40e)
452 * Intel\ |reg| Corporation I350 Gigabit Network Connection
454 * Firmware version: 1.63, 0x80000cbc
455 * Device id (pf/vf): 8086:1521 / 8086:1520
456 * Driver version: 5.4.0-k (igb)
458 * Intel\ |reg| Corporation I210 Gigabit Network Connection
460 * Firmware version: 3.25, 0x800006eb
461 * Device id (pf): 8086:1533
462 * Driver version: 5.4.0-k (igb)
464 * Intel\ |reg| Ethernet Controller 10-Gigabit X540-AT2
466 * Firmware version: 0x800005f9
467 * Device id (pf): 8086:1528
468 * Driver version: 5.1.0-k (ixgbe)
470 * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
472 * Firmware version: 7.30 0x80008061 1.2585.0
473 * Device id (pf): 8086:15ff
474 * Driver version: 2.12.6(i40e)
476 * Intel\ |reg| platforms with Mellanox\ |reg| NICs combinations
480 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
481 * Intel\ |reg| Xeon\ |reg| CPU E5-2697A v4 @ 2.60GHz
482 * Intel\ |reg| Xeon\ |reg| CPU E5-2697 v3 @ 2.60GHz
483 * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
484 * Intel\ |reg| Xeon\ |reg| CPU E5-2670 0 @ 2.60GHz
485 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v4 @ 2.20GHz
486 * Intel\ |reg| Xeon\ |reg| CPU E5-2640 @ 2.50GHz
487 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 0 @ 2.00GHz
488 * Intel\ |reg| Xeon\ |reg| CPU E5-2620 v4 @ 2.10GHz
492 * Red Hat Enterprise Linux release 8.2 (Ootpa)
493 * Red Hat Enterprise Linux Server release 7.8 (Maipo)
494 * Red Hat Enterprise Linux Server release 7.6 (Maipo)
495 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
496 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
497 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
498 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
502 * SUSE Enterprise Linux 15 SP2
503 * SUSE Enterprise Linux 12 SP4
507 * MLNX_OFED 5.0-2.1.8.0
508 * MLNX_OFED 5.1-0.6.6.0 and above
512 * Linux 5.8.0-rc6 and above
516 * rdma-core-30.0-1 and above
520 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCC_Ax (2x40G)
522 * Host interface: PCI Express 3.0 x8
523 * Device ID: 15b3:1007
524 * Firmware version: 2.42.5000
526 * Mellanox\ |reg| ConnectX\ |reg|-3 Pro 40G MCX354A-FCCT (2x40G)
528 * Host interface: PCI Express 3.0 x8
529 * Device ID: 15b3:1007
530 * Firmware version: 2.42.5000
532 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
534 * Host interface: PCI Express 3.0 x8
535 * Device ID: 15b3:1015
536 * Firmware version: 14.28.1002 and above
538 * Mellanox\ |reg| ConnectX\ |reg|-4 Lx 50G MCX4131A-GCAT (1x50G)
540 * Host interface: PCI Express 3.0 x8
541 * Device ID: 15b3:1015
542 * Firmware version: 14.28.1002 and above
544 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX516A-CCAT (2x100G)
546 * Host interface: PCI Express 3.0 x16
547 * Device ID: 15b3:1017
548 * Firmware version: 16.28.1002 and above
550 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
552 * Host interface: PCI Express 3.0 x16
553 * Device ID: 15b3:1017
554 * Firmware version: 16.28.1002 and above
556 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-EDAT (2x100G)
558 * Host interface: PCI Express 3.0 x16
559 * Device ID: 15b3:1017
560 * Firmware version: 16.28.1002 and above
562 * Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
564 * Host interface: PCI Express 4.0 x16
565 * Device ID: 15b3:1019
566 * Firmware version: 16.28.1002 and above
568 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
570 * Host interface: PCI Express 4.0 x16
571 * Device ID: 15b3:101d
572 * Firmware version: 22.28.1002 and above
574 * Mellanox\ |reg| BlueField\ |reg| SmartNIC
576 * Mellanox\ |reg| BlueField\ |reg| 2 SmartNIC MT41686 - MBF2H332A-AEEOT (2x25G)
578 * Host interface: PCI Express 3.0 x16
579 * Device ID: 15b3:a2d2
580 * Firmware version: 24.28.1002
584 * CentOS Linux release 7.6.1810 (AltArch)
585 * MLNX_OFED 5.1-0.6.2
586 * DPDK application running on Arm cores
588 * IBM Power 9 platforms with Mellanox\ |reg| NICs combinations
592 * POWER9 2.2 (pvr 004e 1202) 2300MHz
596 * Red Hat Enterprise Linux Server release 7.6
600 * Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
602 * Host interface: PCI Express 4.0 x16
603 * Device ID: 15b3:1017
604 * Firmware version: 16.28.1002
606 * Mellanox\ |reg| ConnectX\ |reg|-6 Dx 100G MCX623106AN-CDAT (2x100G)
608 * Host interface: PCI Express 4.0 x16
609 * Device ID: 15b3:101d
610 * Firmware version: 22.28.1002
614 * MLNX_OFED 5.0-2.1.8.0
616 * Intel\ |reg| platforms with Broadcom\ |reg| NICs combinations
620 * Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz
621 * Intel\ |reg| Xeon\ |reg| CPU E5-2667 v3 @ 3.20GHz
622 * Intel\ |reg| Xeon\ |reg| CPU E5-2650 v2 @ 2.60GHz
623 * Intel\ |reg| Xeon\ |reg| Gold 6142 CPU @ 2.60GHz
624 * Intel\ |reg| Xeon\ |reg| Silver 4110 CPU @ 2.10GHz
628 * Red Hat Enterprise Linux Server release 8.1
629 * Red Hat Enterprise Linux Server release 7.6
630 * Red Hat Enterprise Linux Server release 7.5
641 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P225p (2x25G)
643 * Host interface: PCI Express 3.0 x8
644 * Firmware version: 214.4.81.0 and above
646 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
648 * Host interface: PCI Express 3.0 x16
649 * Firmware version: 216.4.259.0 and above
651 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
653 * Host interface: PCI Express 3.0 x16
654 * Firmware version: 216.1.259.0 and above
656 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P425p (4x25G)
658 * Host interface: PCI Express 4.0 x16
659 * Firmware version: 216.1.259.0 and above
661 * Broadcom\ |reg| NetXtreme-E\ |reg| Series P2100G (2x100G)
663 * Host interface: PCI Express 4.0 x16
664 * Firmware version: 216.1.259.0 and above
666 * Broadcom\ |reg| NetXtreme-S\ |reg| Series SmartNIC
668 * Broadcom\ |reg| NetXtreme-S\ |reg| Series PS225-H16 SmartNIC (2x25G)
670 * Host interface: PCI Express 3.0 x8
671 * Firmware version: 217.0.59.0
675 * Broadcom Yocto Linux
676 * Kernel version: 4.14.174
677 * DPDK application running on 8 Arm Cortex-A72 cores