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 Direct Rule support in Direct Verbs flow driver.
152 * Added support of per-process device registers, reserving identical VA space
153 is not needed anymore.
154 * Added E-Switch support in Direct Verbs flow driver.
156 * **Renamed avf to iavf.**
158 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
159 which includes the directory name, lib name, filenames, makefile, docs,
160 macros, functions, structs and any other strings in the code.
162 * **Updated the enic driver.**
164 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
165 inner packet matching.
166 * Added limited support for RAW.
167 * Added limited support for RSS.
168 * Added limited support for PASSTHRU.
170 * **Updated the ixgbe driver.**
174 * Added promiscuous mode support.
176 * **Updated the ice driver.**
178 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
179 * Added package download support.
180 * Added Safe Mode support.
181 * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
183 * **Updated the i40e driver.**
187 * Added support for VXLAN-GPE packet.
188 * Added support for VXLAN-GPE classification.
190 * **Updated the ENETC driver.**
194 * Added physical addressing mode support
195 * Added SXGMII interface support
196 * Added basic statistics support
197 * Added promiscuous and allmulticast mode support
198 * Added MTU update support
199 * Added jumbo frame support
200 * Added queue start/stop
201 * Added CRC offload support
202 * Added Rx checksum offload validation support
204 * **Updated the atlantic PMD.**
206 Added MACSEC hardware offload experimental API.
208 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
210 Simplified and made more robust QAT compressdev PMD's handling of SGLs with
211 more than 16 segments.
213 * **Updated the QuickAssist Technology (QAT) symmetric crypto PMD.**
215 Added support for AES-XTS with 128 and 256 bit AES keys.
217 * **Added Intel QuickAssist Technology PMD for asymmetric crypto.**
219 A new QAT Crypto PMD has been added, which provides asymmetric cryptography
220 algorithms, in this release modular exponentiation and modular multiplicative
221 inverse algorithms were added.
223 * **Updated AESNI-MB PMD.**
225 Added support for out-of-place operations.
227 * **Updated the IPsec library.**
229 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
230 support. The related ipsec-secgw test scripts have been added.
232 * **Updated the testpmd application.**
234 Improved testpmd application performance on ARM platform. For ``macswap``
235 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
237 * **Updated power management library.**
239 Added support for Intel Speed Select Technology - Base Frequency (SST-BF).
240 ``rte_power_get_capabilities`` now has a bit in it's returned mask
241 indicating it's a high frequency core.
243 * **Updated distributor sample application.**
245 Added support for Intel SST-BF feature so that the distributor core is
246 pinned to a high frequency core if available.
252 .. This section should contain removed items in this release. Sample format:
254 * Add a short 1-2 sentence description of the removed item
257 This section is a comment. Do not overwrite or remove it.
258 Also, make sure to start the actual text at the margin.
259 =========================================================
265 .. This section should contain API changes. Sample format:
267 * sample: Add a short 1-2 sentence description of the API change
268 which was announced in the previous releases and made in this release.
269 Start with a scope label like "ethdev:".
270 Use fixed width quotes for ``function_names`` or ``struct_names``.
273 This section is a comment. Do not overwrite or remove it.
274 Also, make sure to start the actual text at the margin.
275 =========================================================
277 * eal: the type of the ``attr_value`` parameter of the function
278 ``rte_service_attr_get()`` has been changed
279 from ``uint32_t *`` to ``uint64_t *``.
281 * meter: replace ``enum rte_meter_color`` in meter library with new
282 ``rte_color`` definition added in 19.02. To consolidate mulitple color
283 definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
284 replacements with rte_color values are done.
286 * vfio: Functions ``rte_vfio_container_dma_map`` and
287 ``rte_vfio_container_dma_unmap`` have been extended with an option to
288 request mapping or un-mapping to the default vfio container fd.
290 * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions
291 have been modified to be thread safe.
293 * timer: Functions have been introduced that allow multiple instances of the
294 timer lists to be created, and they are now allocated in shared memory. New
295 functions allow particular timer lists to be selected when timers are being
296 started, stopped, and managed.
302 .. This section should contain ABI changes. Sample format:
304 * sample: Add a short 1-2 sentence description of the ABI change
305 which was announced in the previous releases and made in this release.
306 Start with a scope label like "ethdev:".
307 Use fixed width quotes for ``function_names`` or ``struct_names``.
310 This section is a comment. Do not overwrite or remove it.
311 Also, make sure to start the actual text at the margin.
312 =========================================================
314 * ethdev: Additional fields in rte_eth_dev_info.
316 The ``rte_eth_dev_info`` structure has had two extra fields
317 added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
318 The values of these fields can be set specifically by the PMD drivers as
319 supported values can vary from device to device.
321 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
322 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
323 defined as cache-line aligned that caused unintended changes in
324 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
325 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
326 layout and alignment.
328 * timer: ``rte_timer_subsystem_init`` now returns success or failure to reflect
329 whether it was able to allocate memory.
332 Shared Library Versions
333 -----------------------
335 .. Update any library version updated in this release
336 and prepend with a ``+`` sign, like this:
342 This section is a comment. Do not overwrite or remove it.
343 =========================================================
345 The libraries prepended with a plus sign were incremented in this version.
351 librte_bitratestats.so.2
354 librte_bus_fslmc.so.2
355 librte_bus_ifpga.so.2
358 librte_bus_vmbus.so.2
361 librte_compressdev.so.1
362 + librte_cryptodev.so.7
363 librte_distributor.so.1
366 + librte_ethdev.so.12
368 librte_flow_classify.so.1
377 librte_latencystats.so.1
391 librte_pmd_ixgbe.so.2
392 librte_pmd_dpaa2_qdma.so.1
394 librte_pmd_softnic.so.1
395 librte_pmd_vhost.so.2
413 .. This section should contain new known issues in this release. Sample format:
415 * **Add title in present tense with full stop.**
417 Add a short 1-2 sentence description of the known issue
418 in the present tense. Add information on any known workarounds.
420 This section is a comment. Do not overwrite or remove it.
421 Also, make sure to start the actual text at the margin.
422 =========================================================
424 * **On x86 platforms, AVX512 support is disabled with binutils 2.31**
426 Because a defect in binutils 2.31 AVX512 support is disabled.
427 DPDK defect: https://bugs.dpdk.org/show_bug.cgi?id=249
428 GCC defect: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90028
430 * **No software AES-XTS implementation.**
432 There are currently no cryptodev software PMDs available which implement
433 support for the AES-XTS algorithm, so this feature can only be used
434 if compatible hardware and an associated PMD is available.
440 .. This section should contain a list of platforms that were tested
445 * <vendor> platform with <vendor> <type of devices> combinations
450 * Other relevant details...
452 This section is a comment. Do not overwrite or remove it.
453 Also, make sure to start the actual text at the margin.
454 =========================================================
456 * Intel(R) platforms with Mellanox(R) NICs combinations
460 * Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz
461 * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
462 * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
463 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
464 * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
465 * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
466 * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
470 * Red Hat Enterprise Linux Server release 7.6 (Maipo)
471 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
472 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
473 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
474 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
479 * SUSE Linux Enterprise Server 15
481 * MLNX_OFED: 4.5-1.0.1.0
482 * MLNX_OFED: 4.6-1.0.1.1
486 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
488 * Host interface: PCI Express 3.0 x8
489 * Device ID: 15b3:1007
490 * Firmware version: 2.42.5000
492 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
494 * Host interface: PCI Express 3.0 x8
495 * Device ID: 15b3:1013
496 * Firmware version: 12.25.1020 and above
498 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
500 * Host interface: PCI Express 3.0 x8
501 * Device ID: 15b3:1013
502 * Firmware version: 12.25.1020 and above
504 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
506 * Host interface: PCI Express 3.0 x8
507 * Device ID: 15b3:1013
508 * Firmware version: 12.25.1020 and above
510 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
512 * Host interface: PCI Express 3.0 x8
513 * Device ID: 15b3:1013
514 * Firmware version: 12.25.1020 and above
516 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
518 * Host interface: PCI Express 3.0 x8
519 * Device ID: 15b3:1013
520 * Firmware version: 12.25.1020 and above
522 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
524 * Host interface: PCI Express 3.0 x16
525 * Device ID: 15b3:1013
526 * Firmware version: 12.25.1020 and above
528 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
530 * Host interface: PCI Express 3.0 x8
531 * Device ID: 15b3:1013
532 * Firmware version: 12.25.1020 and above
534 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
536 * Host interface: PCI Express 3.0 x8
537 * Device ID: 15b3:1013
538 * Firmware version: 12.25.1020 and above
540 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
542 * Host interface: PCI Express 3.0 x16
543 * Device ID: 15b3:1013
544 * Firmware version: 12.25.1020 and above
545 * Firmware version: 12.25.1020 and above
547 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
549 * Host interface: PCI Express 3.0 x16
550 * Device ID: 15b3:1013
551 * Firmware version: 12.25.1020 and above
553 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
555 * Host interface: PCI Express 3.0 x16
556 * Device ID: 15b3:1013
557 * Firmware version: 12.25.1020 and above
559 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
561 * Host interface: PCI Express 3.0 x8
562 * Device ID: 15b3:1015
563 * Firmware version: 14.25.1020 and above
565 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
567 * Host interface: PCI Express 3.0 x8
568 * Device ID: 15b3:1015
569 * Firmware version: 14.25.1020 and above
571 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
573 * Host interface: PCI Express 3.0 x16
574 * Device ID: 15b3:1017
575 * Firmware version: 16.25.1020 and above
577 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
579 * Host interface: PCI Express 4.0 x16
580 * Device ID: 15b3:1019
581 * Firmware version: 16.25.1020 and above
583 * Arm platforms with Mellanox(R) NICs combinations
587 * Qualcomm Arm 1.1 2500MHz
591 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
595 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
597 * Host interface: PCI Express 3.0 x8
598 * Device ID: 15b3:1015
599 * Firmware version: 14.24.0220
601 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
603 * Host interface: PCI Express 3.0 x16
604 * Device ID: 15b3:1017
605 * Firmware version: 16.24.0220
607 * Mellanox(R) BlueField SmartNIC
609 * Mellanox(R) BlueField SmartNIC MT416842 (2x25G)
611 * Host interface: PCI Express 3.0 x16
612 * Device ID: 15b3:a2d2
613 * Firmware version: 18.25.1010
615 * SoC Arm cores running OS:
617 * CentOS Linux release 7.4.1708 (AltArch)
618 * MLNX_OFED 4.6-1.0.0.0
620 * DPDK application running on Arm cores inside SmartNIC
622 * IBM Power 9 platforms with Mellanox(R) NICs combinations
626 * POWER9 2.2 (pvr 004e 1202) 2300MHz
630 * Ubuntu 18.04.1 LTS (Bionic Beaver)
634 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
636 * Host interface: PCI Express 3.0 x16
637 * Device ID: 15b3:1017
638 * Firmware version: 16.24.1000
642 * MLNX_OFED_LINUX-4.6-1.0.1.0