1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_19_05.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
31 Add a short 1-2 sentence description in the past tense.
32 The description should be enough to allow someone scanning
33 the release notes to understand the new feature.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significant)
53 This section is a comment. Do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
57 * **Added new armv8 machine targets:**
59 * BlueField (Mellanox)
63 * **Introduced Windows Support.**
65 Added Windows support to build Hello World sample application.
67 * **Added Stack API.**
69 Added a new stack API for configuration and use of a bounded stack of
70 pointers. The API provides MT-safe push and pop operations that can operate
71 on one or more pointers per operation.
73 The library supports two stack implementations: standard (lock-based) and lock-free.
74 The lock-free implementation is currently limited to x86-64 platforms.
76 * **Added Lock-Free Stack Mempool Handler.**
78 Added a new lock-free stack handler, which uses the newly added stack
81 * **Added RCU library.**
83 Added RCU library supporting quiescent state based memory reclamation method.
84 This library helps identify the quiescent state of the reader threads so
85 that the writers can free the memory associated with the lock free data
88 * **Updated KNI module and PMD.**
90 Updated the KNI kernel module to set the max_mtu according to the given
91 initial MTU size. Without it, the maximum MTU was 1500.
93 Updated the KNI PMD driver to set the mbuf_size and MTU based on
94 the given mb-pool. This provide the ability to pass jumbo frames
95 if the mb-pool contains suitable buffers' size.
97 * **Added the AF_XDP PMD.**
99 Added a Linux-specific PMD driver for AF_XDP, it can create the AF_XDP socket
100 and bind it to a specific netdev queue, it allows a DPDK application to send
101 and receive raw packets through the socket which would bypass the kernel
102 network stack to achieve high performance packet processing.
104 * **Added a net PMD NFB.**
106 Added the new ``nfb`` net driver for Netcope NFB cards. See
107 the :doc:`../nics/nfb` NIC guide for more details on this new driver.
109 * **Added IPN3KE net PMD.**
111 Added the new ``ipn3ke`` net driver for IntelĀ® FPGA PAC(Programmable
112 Acceleration Card) N3000. See the :doc:`../nics/ipn3ke` NIC guide for more
113 details on this new driver.
115 Aside from this, ifpga_rawdev is also updated to support IntelĀ® FPGA PAC
116 N3000 with SPI interface access, I2C Read/Write and Ethernet PHY configuration.
118 * **Updated Solarflare network PMD.**
120 Updated the sfc_efx driver including the following changes:
122 * Added support for Rx descriptor status and related API in a secondary
124 * Added support for Tx descriptor status API in a secondary process.
125 * Added support for RSS RETA and hash configuration get API in a secondary
127 * Added support for Rx packet types list in a secondary process.
128 * Added Tx prepare to do Tx offloads checks.
129 * Added support for VXLAN and GENEVE encapsulated TSO.
131 * **Updated Mellanox mlx4 driver.**
133 New features and improvements were done:
135 * Added firmware version reading.
136 * Added support for secondary process.
137 * Added support of per-process device registers, reserving identical VA space
138 is not needed anymore.
139 * Added support for multicast address list interface
141 * **Updated Mellanox mlx5 driver.**
143 New features and improvements were done:
145 * Added firmware version reading.
146 * Added support of new naming scheme of representor.
147 * Added support for new PCI device DMA map/unmap API.
148 * Added support for multiport InfiniBand device.
149 * Added control of excessive memory pinning by kernel.
150 * Added support of DMA memory registration by secondary process.
151 * Added support of per-process device registers, reserving identical VA space
152 is not needed anymore.
153 * Added support for jump action for both E-Switch and NIC.
154 * Added Support for multiple rte_flow groups in NIC steering.
155 * Flow engine re-designed to support large scale deployments. this includes:
156 * Support millions of offloaded flow rules.
157 * Fast flow insertion and deletion up to 1M flow update per second.
159 * **Renamed avf to iavf.**
161 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
162 which includes the directory name, lib name, filenames, makefile, docs,
163 macros, functions, structs and any other strings in the code.
165 * **Updated the enic driver.**
167 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
168 inner packet matching.
169 * Added limited support for RAW.
170 * Added limited support for RSS.
171 * Added limited support for PASSTHRU.
173 * **Updated the ixgbe driver.**
177 * Added promiscuous mode support.
179 * **Updated the ice driver.**
181 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
182 * Added package download support.
183 * Added Safe Mode support.
184 * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
186 * **Updated the i40e driver.**
190 * Added support for VXLAN-GPE packet.
191 * Added support for VXLAN-GPE classification.
193 * **Updated the ENETC driver.**
197 * Added physical addressing mode support
198 * Added SXGMII interface support
199 * Added basic statistics support
200 * Added promiscuous and allmulticast mode support
201 * Added MTU update support
202 * Added jumbo frame support
203 * Added queue start/stop
204 * Added CRC offload support
205 * Added Rx checksum offload validation support
207 * **Updated the atlantic PMD.**
209 Added MACSEC hardware offload experimental API.
211 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
213 Simplified and made more robust QAT compressdev PMD's handling of SGLs with
214 more than 16 segments.
216 * **Updated the QuickAssist Technology (QAT) symmetric crypto PMD.**
218 Added support for AES-XTS with 128 and 256 bit AES keys.
220 * **Added Intel QuickAssist Technology PMD for asymmetric crypto.**
222 A new QAT Crypto PMD has been added, which provides asymmetric cryptography
223 algorithms, in this release modular exponentiation and modular multiplicative
224 inverse algorithms were added.
226 * **Updated AESNI-MB PMD.**
228 Added support for out-of-place operations.
230 * **Updated the IPsec library.**
232 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
233 support. The related ipsec-secgw test scripts have been added.
235 * **Updated the testpmd application.**
237 Improved testpmd application performance on ARM platform. For ``macswap``
238 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
240 * **Updated power management library.**
242 Added support for Intel Speed Select Technology - Base Frequency (SST-BF).
243 ``rte_power_get_capabilities`` now has a bit in it's returned mask
244 indicating it's a high frequency core.
246 * **Updated distributor sample application.**
248 Added support for Intel SST-BF feature so that the distributor core is
249 pinned to a high frequency core if available.
255 .. This section should contain removed items in this release. Sample format:
257 * Add a short 1-2 sentence description of the removed item
260 This section is a comment. Do not overwrite or remove it.
261 Also, make sure to start the actual text at the margin.
262 =========================================================
268 .. This section should contain API changes. Sample format:
270 * sample: Add a short 1-2 sentence description of the API change
271 which was announced in the previous releases and made in this release.
272 Start with a scope label like "ethdev:".
273 Use fixed width quotes for ``function_names`` or ``struct_names``.
276 This section is a comment. Do not overwrite or remove it.
277 Also, make sure to start the actual text at the margin.
278 =========================================================
280 * eal: the type of the ``attr_value`` parameter of the function
281 ``rte_service_attr_get()`` has been changed
282 from ``uint32_t *`` to ``uint64_t *``.
284 * meter: replace ``enum rte_meter_color`` in meter library with new
285 ``rte_color`` definition added in 19.02. To consolidate mulitple color
286 definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
287 replacements with rte_color values are done.
289 * vfio: Functions ``rte_vfio_container_dma_map`` and
290 ``rte_vfio_container_dma_unmap`` have been extended with an option to
291 request mapping or un-mapping to the default vfio container fd.
293 * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions
294 have been modified to be thread safe.
296 * timer: Functions have been introduced that allow multiple instances of the
297 timer lists to be created, and they are now allocated in shared memory. New
298 functions allow particular timer lists to be selected when timers are being
299 started, stopped, and managed.
305 .. This section should contain ABI changes. Sample format:
307 * sample: Add a short 1-2 sentence description of the ABI change
308 which was announced in the previous releases and made in this release.
309 Start with a scope label like "ethdev:".
310 Use fixed width quotes for ``function_names`` or ``struct_names``.
313 This section is a comment. Do not overwrite or remove it.
314 Also, make sure to start the actual text at the margin.
315 =========================================================
317 * ethdev: Additional fields in rte_eth_dev_info.
319 The ``rte_eth_dev_info`` structure has had two extra fields
320 added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
321 The values of these fields can be set specifically by the PMD drivers as
322 supported values can vary from device to device.
324 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
325 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
326 defined as cache-line aligned that caused unintended changes in
327 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
328 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
329 layout and alignment.
331 * timer: ``rte_timer_subsystem_init`` now returns success or failure to reflect
332 whether it was able to allocate memory.
335 Shared Library Versions
336 -----------------------
338 .. Update any library version updated in this release
339 and prepend with a ``+`` sign, like this:
345 This section is a comment. Do not overwrite or remove it.
346 =========================================================
348 The libraries prepended with a plus sign were incremented in this version.
354 librte_bitratestats.so.2
357 librte_bus_fslmc.so.2
358 librte_bus_ifpga.so.2
361 librte_bus_vmbus.so.2
364 librte_compressdev.so.1
365 + librte_cryptodev.so.7
366 librte_distributor.so.1
369 + librte_ethdev.so.12
371 librte_flow_classify.so.1
380 librte_latencystats.so.1
394 librte_pmd_ixgbe.so.2
395 librte_pmd_dpaa2_qdma.so.1
397 librte_pmd_softnic.so.1
398 librte_pmd_vhost.so.2
416 .. This section should contain new known issues in this release. Sample format:
418 * **Add title in present tense with full stop.**
420 Add a short 1-2 sentence description of the known issue
421 in the present tense. Add information on any known workarounds.
423 This section is a comment. Do not overwrite or remove it.
424 Also, make sure to start the actual text at the margin.
425 =========================================================
427 * **On x86 platforms, AVX512 support is disabled with binutils 2.31**
429 Because a defect in binutils 2.31 AVX512 support is disabled.
430 DPDK defect: https://bugs.dpdk.org/show_bug.cgi?id=249
431 GCC defect: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90028
433 * **No software AES-XTS implementation.**
435 There are currently no cryptodev software PMDs available which implement
436 support for the AES-XTS algorithm, so this feature can only be used
437 if compatible hardware and an associated PMD is available.
443 .. This section should contain a list of platforms that were tested
448 * <vendor> platform with <vendor> <type of devices> combinations
453 * Other relevant details...
455 This section is a comment. Do not overwrite or remove it.
456 Also, make sure to start the actual text at the margin.
457 =========================================================
459 * Intel(R) platforms with Intel(R) NICs combinations
463 * Intel(R) Atom(TM) CPU C3758 @ 2.20GHz
464 * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
465 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
466 * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
467 * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz
468 * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz
469 * Intel(R) Xeon(R) Gold 6139 CPU @ 2.30GHz
479 * Red Hat Enterprise Linux Server release 7.4
480 * Red Hat Enterprise Linux Server release 7.5
481 * Red Hat Enterprise Linux Server release 7.6
493 * Intel(R) 82599ES 10 Gigabit Ethernet Controller
495 * Firmware version: 0x61bf0001
496 * Device id (pf/vf): 8086:10fb / 8086:10ed
497 * Driver version: 5.2.3 (ixgbe)
499 * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
501 * Firmware version: 0x800003e7
502 * Device id (pf/vf): 8086:15ad / 8086:15a8
503 * Driver version: 4.4.6 (ixgbe)
505 * Intel Corporation Ethernet Controller 10G X550T
507 * Firmware version: 0x80000482
508 * Device id (pf): 8086:1563
509 * Driver version: 5.1.0-k(ixgbe)
511 * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
513 * Firmware version: 6.80 0x80003cc1
514 * Device id (pf/vf): 8086:1572 / 8086:154c
515 * Driver version: 2.7.29 (i40e)
517 * Intel(R) Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
519 * Firmware version: 3.33 0x80000fd5 0.0.0
520 * Device id (pf/vf): 8086:37d0 / 8086:37cd
521 * Driver version: 2.7.29 (i40e)
523 * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
525 * Firmware version: 6.80 0x80003d05
526 * Device id (pf/vf): 8086:158b / 8086:154c
527 * Driver version: 2.7.29 (i40e)
529 * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
531 * Firmware version: 6.80 0x80003cfb
532 * Device id (pf/vf): 8086:1583 / 8086:154c
533 * Driver version: 2.7.29 (i40e)
535 * Intel(R) Corporation I350 Gigabit Network Connection
537 * Firmware version: 1.63, 0x80000dda
538 * Device id (pf/vf): 8086:1521 / 8086:1520
539 * Driver version: 5.4.0-k (igb)
541 * Intel Corporation I210 Gigabit Network Connection
543 * Firmware version: 3.25, 0x800006eb, 1.1824.0
544 * Device id (pf): 8086:1533
545 * Driver version: 5.4.0-k(igb)
547 * Intel(R) platforms with Mellanox(R) NICs combinations
551 * Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz
552 * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
553 * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
554 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
555 * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
556 * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
557 * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
561 * Red Hat Enterprise Linux Server release 7.6 (Maipo)
562 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
563 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
564 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
565 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
570 * SUSE Linux Enterprise Server 15
572 * MLNX_OFED: 4.5-1.0.1.0
573 * MLNX_OFED: 4.6-1.0.1.1
577 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
579 * Host interface: PCI Express 3.0 x8
580 * Device ID: 15b3:1007
581 * Firmware version: 2.42.5000
583 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
585 * Host interface: PCI Express 3.0 x8
586 * Device ID: 15b3:1013
587 * Firmware version: 12.25.1020 and above
589 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
591 * Host interface: PCI Express 3.0 x8
592 * Device ID: 15b3:1013
593 * Firmware version: 12.25.1020 and above
595 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
597 * Host interface: PCI Express 3.0 x8
598 * Device ID: 15b3:1013
599 * Firmware version: 12.25.1020 and above
601 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
603 * Host interface: PCI Express 3.0 x8
604 * Device ID: 15b3:1013
605 * Firmware version: 12.25.1020 and above
607 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
609 * Host interface: PCI Express 3.0 x8
610 * Device ID: 15b3:1013
611 * Firmware version: 12.25.1020 and above
613 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
615 * Host interface: PCI Express 3.0 x16
616 * Device ID: 15b3:1013
617 * Firmware version: 12.25.1020 and above
619 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
621 * Host interface: PCI Express 3.0 x8
622 * Device ID: 15b3:1013
623 * Firmware version: 12.25.1020 and above
625 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
627 * Host interface: PCI Express 3.0 x8
628 * Device ID: 15b3:1013
629 * Firmware version: 12.25.1020 and above
631 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
633 * Host interface: PCI Express 3.0 x16
634 * Device ID: 15b3:1013
635 * Firmware version: 12.25.1020 and above
636 * Firmware version: 12.25.1020 and above
638 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
640 * Host interface: PCI Express 3.0 x16
641 * Device ID: 15b3:1013
642 * Firmware version: 12.25.1020 and above
644 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
646 * Host interface: PCI Express 3.0 x16
647 * Device ID: 15b3:1013
648 * Firmware version: 12.25.1020 and above
650 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
652 * Host interface: PCI Express 3.0 x8
653 * Device ID: 15b3:1015
654 * Firmware version: 14.25.1020 and above
656 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
658 * Host interface: PCI Express 3.0 x8
659 * Device ID: 15b3:1015
660 * Firmware version: 14.25.1020 and above
662 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
664 * Host interface: PCI Express 3.0 x16
665 * Device ID: 15b3:1017
666 * Firmware version: 16.25.1020 and above
668 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
670 * Host interface: PCI Express 4.0 x16
671 * Device ID: 15b3:1019
672 * Firmware version: 16.25.1020 and above
674 * Arm platforms with Mellanox(R) NICs combinations
678 * Qualcomm Arm 1.1 2500MHz
682 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
686 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
688 * Host interface: PCI Express 3.0 x8
689 * Device ID: 15b3:1015
690 * Firmware version: 14.24.0220
692 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
694 * Host interface: PCI Express 3.0 x16
695 * Device ID: 15b3:1017
696 * Firmware version: 16.24.0220
698 * Mellanox(R) BlueField SmartNIC
700 * Mellanox(R) BlueField SmartNIC MT416842 (2x25G)
702 * Host interface: PCI Express 3.0 x16
703 * Device ID: 15b3:a2d2
704 * Firmware version: 18.25.1010
706 * SoC Arm cores running OS:
708 * CentOS Linux release 7.4.1708 (AltArch)
709 * MLNX_OFED 4.6-1.0.0.0
711 * DPDK application running on Arm cores inside SmartNIC
713 * IBM Power 9 platforms with Mellanox(R) NICs combinations
717 * POWER9 2.2 (pvr 004e 1202) 2300MHz
721 * Ubuntu 18.04.1 LTS (Bionic Beaver)
725 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
727 * Host interface: PCI Express 3.0 x16
728 * Device ID: 15b3:1017
729 * Firmware version: 16.24.1000
733 * MLNX_OFED_LINUX-4.6-1.0.1.0