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 drivers.**
133 New features and improvements were done in mlx4 and mlx5 PMDs:
135 * Added firmware version reading.
137 * **Renamed avf to iavf.**
139 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
140 which includes the directory name, lib name, filenames, makefile, docs,
141 macros, functions, structs and any other strings in the code.
143 * **Updated the enic driver.**
145 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
146 inner packet matching.
147 * Added limited support for RAW.
148 * Added limited support for RSS.
149 * Added limited support for PASSTHRU.
151 * **Updated the ixgbe driver.**
155 * Added promiscuous mode support.
157 * **Updated the ice driver.**
159 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
160 * Added package download support.
161 * Added Safe Mode support.
162 * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
164 * **Updated the i40e driver.**
168 * Added support for VXLAN-GPE packet.
169 * Added support for VXLAN-GPE classification.
171 * **Updated the ENETC driver.**
175 * Added physical addressing mode support
176 * Added SXGMII interface support
177 * Added basic statistics support
178 * Added promiscuous and allmulticast mode support
179 * Added MTU update support
180 * Added jumbo frame support
181 * Added queue start/stop
182 * Added CRC offload support
183 * Added Rx checksum offload validation support
185 * **Updated the atlantic PMD.**
187 Added MACSEC hardware offload experimental API.
189 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
191 Simplified and made more robust QAT compressdev PMD's handling of SGLs with
192 more than 16 segments.
194 * **Updated the QuickAssist Technology (QAT) symmetric crypto PMD.**
196 Added support for AES-XTS with 128 and 256 bit AES keys.
198 * **Added Intel QuickAssist Technology PMD for asymmetric crypto.**
200 A new QAT Crypto PMD has been added, which provides asymmetric cryptography
201 algorithms, in this release modular exponentiation and modular multiplicative
202 inverse algorithms were added.
204 * **Updated AESNI-MB PMD.**
206 Added support for out-of-place operations.
208 * **Updated the IPsec library.**
210 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
211 support. The related ipsec-secgw test scripts have been added.
213 * **Updated the testpmd application.**
215 Improved testpmd application performance on ARM platform. For ``macswap``
216 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
218 * **Updated power management library.**
220 Added support for Intel Speed Select Technology - Base Frequency (SST-BF).
221 ``rte_power_get_capabilities`` now has a bit in it's returned mask
222 indicating it's a high frequency core.
224 * **Updated distributor sample application.**
226 Added support for Intel SST-BF feature so that the distributor core is
227 pinned to a high frequency core if available.
233 .. This section should contain removed items in this release. Sample format:
235 * Add a short 1-2 sentence description of the removed item
238 This section is a comment. Do not overwrite or remove it.
239 Also, make sure to start the actual text at the margin.
240 =========================================================
246 .. This section should contain API changes. Sample format:
248 * sample: Add a short 1-2 sentence description of the API change
249 which was announced in the previous releases and made in this release.
250 Start with a scope label like "ethdev:".
251 Use fixed width quotes for ``function_names`` or ``struct_names``.
254 This section is a comment. Do not overwrite or remove it.
255 Also, make sure to start the actual text at the margin.
256 =========================================================
258 * eal: the type of the ``attr_value`` parameter of the function
259 ``rte_service_attr_get()`` has been changed
260 from ``uint32_t *`` to ``uint64_t *``.
262 * meter: replace ``enum rte_meter_color`` in meter library with new
263 ``rte_color`` definition added in 19.02. To consolidate mulitple color
264 definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
265 replacements with rte_color values are done.
267 * vfio: Functions ``rte_vfio_container_dma_map`` and
268 ``rte_vfio_container_dma_unmap`` have been extended with an option to
269 request mapping or un-mapping to the default vfio container fd.
271 * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions
272 have been modified to be thread safe.
274 * timer: Functions have been introduced that allow multiple instances of the
275 timer lists to be created, and they are now allocated in shared memory. New
276 functions allow particular timer lists to be selected when timers are being
277 started, stopped, and managed.
283 .. This section should contain ABI changes. Sample format:
285 * sample: Add a short 1-2 sentence description of the ABI change
286 which was announced in the previous releases and made in this release.
287 Start with a scope label like "ethdev:".
288 Use fixed width quotes for ``function_names`` or ``struct_names``.
291 This section is a comment. Do not overwrite or remove it.
292 Also, make sure to start the actual text at the margin.
293 =========================================================
295 * ethdev: Additional fields in rte_eth_dev_info.
297 The ``rte_eth_dev_info`` structure has had two extra fields
298 added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
299 The values of these fields can be set specifically by the PMD drivers as
300 supported values can vary from device to device.
302 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
303 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
304 defined as cache-line aligned that caused unintended changes in
305 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
306 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
307 layout and alignment.
309 * timer: ``rte_timer_subsystem_init`` now returns success or failure to reflect
310 whether it was able to allocate memory.
313 Shared Library Versions
314 -----------------------
316 .. Update any library version updated in this release
317 and prepend with a ``+`` sign, like this:
323 This section is a comment. Do not overwrite or remove it.
324 =========================================================
326 The libraries prepended with a plus sign were incremented in this version.
332 librte_bitratestats.so.2
335 librte_bus_fslmc.so.2
336 librte_bus_ifpga.so.2
339 librte_bus_vmbus.so.2
342 librte_compressdev.so.1
343 + librte_cryptodev.so.7
344 librte_distributor.so.1
347 + librte_ethdev.so.12
349 librte_flow_classify.so.1
358 librte_latencystats.so.1
372 librte_pmd_ixgbe.so.2
373 librte_pmd_dpaa2_qdma.so.1
375 librte_pmd_softnic.so.1
376 librte_pmd_vhost.so.2
394 .. This section should contain new known issues in this release. Sample format:
396 * **Add title in present tense with full stop.**
398 Add a short 1-2 sentence description of the known issue
399 in the present tense. Add information on any known workarounds.
401 This section is a comment. Do not overwrite or remove it.
402 Also, make sure to start the actual text at the margin.
403 =========================================================
405 * **On x86 platforms, AVX512 support is disabled with binutils 2.31**
407 Because a defect in binutils 2.31 AVX512 support is disabled.
408 DPDK defect: https://bugs.dpdk.org/show_bug.cgi?id=249
409 GCC defect: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90028
411 * **No software AES-XTS implementation.**
413 There are currently no cryptodev software PMDs available which implement
414 support for the AES-XTS algorithm, so this feature can only be used
415 if compatible hardware and an associated PMD is available.
421 .. This section should contain a list of platforms that were tested
426 * <vendor> platform with <vendor> <type of devices> combinations
431 * Other relevant details...
433 This section is a comment. Do not overwrite or remove it.
434 Also, make sure to start the actual text at the margin.
435 =========================================================