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 * **Added Stack API.**
65 Added a new stack API for configuration and use of a bounded stack of
66 pointers. The API provides MT-safe push and pop operations that can operate
67 on one or more pointers per operation.
69 The library supports two stack implementations: standard (lock-based) and lock-free.
70 The lock-free implementation is currently limited to x86-64 platforms.
72 * **Added Lock-Free Stack Mempool Handler.**
74 Added a new lock-free stack handler, which uses the newly added stack
77 * **Added RCU library.**
79 Added RCU library supporting quiescent state based memory reclamation method.
80 This library helps identify the quiescent state of the reader threads so
81 that the writers can free the memory associated with the lock free data
84 * **Updated KNI module and PMD.**
86 Updated the KNI kernel module to set the max_mtu according to the given
87 initial MTU size. Without it, the maximum MTU was 1500.
89 Updated the KNI PMD driver to set the mbuf_size and MTU based on
90 the given mb-pool. This provide the ability to pass jumbo frames
91 if the mb-pool contains suitable buffers' size.
93 * **Added the AF_XDP PMD.**
95 Added a Linux-specific PMD driver for AF_XDP, it can create the AF_XDP socket
96 and bind it to a specific netdev queue, it allows a DPDK application to send
97 and receive raw packets through the socket which would bypass the kernel
98 network stack to achieve high performance packet processing.
100 * **Added a net PMD NFB.**
102 Added the new ``nfb`` net driver for Netcope NFB cards. See
103 the :doc:`../nics/nfb` NIC guide for more details on this new driver.
105 * **Added IPN3KE net PMD.**
107 Added the new ``ipn3ke`` net driver for IntelĀ® FPGA PAC(Programmable
108 Acceleration Card) N3000. See the :doc:`../nics/ipn3ke` NIC guide for more
109 details on this new driver.
111 Aside from this, ifpga_rawdev is also updated to support IntelĀ® FPGA PAC
112 N3000 with SPI interface access, I2C Read/Write and Ethernet PHY configuration.
114 * **Updated Solarflare network PMD.**
116 Updated the sfc_efx driver including the following changes:
118 * Added support for Rx descriptor status and related API in a secondary
120 * Added support for Tx descriptor status API in a secondary process.
121 * Added support for RSS RETA and hash configuration get API in a secondary
123 * Added support for Rx packet types list in a secondary process.
124 * Added Tx prepare to do Tx offloads checks.
125 * Added support for VXLAN and GENEVE encapsulated TSO.
127 * **Updated Mellanox drivers.**
129 New features and improvements were done in mlx4 and mlx5 PMDs:
131 * Added firmware version reading.
133 * **Renamed avf to iavf.**
135 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
136 which includes the directory name, lib name, filenames, makefile, docs,
137 macros, functions, structs and any other strings in the code.
139 * **Updated the enic driver.**
141 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
142 inner packet matching.
143 * Added limited support for RAW.
144 * Added limited support for RSS.
145 * Added limited support for PASSTHRU.
147 * **Updated the ixgbe driver.**
151 * Added promiscuous mode support.
153 * **Updated the ice driver.**
155 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
156 * Added package download support.
157 * Added Safe Mode support.
158 * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
160 * **Updated the i40e driver.**
164 * Added support for VXLAN-GPE packet.
165 * Added support for VXLAN-GPE classification.
167 * **Updated the ENETC driver.**
171 * Added physical addressing mode support
172 * Added SXGMII interface support
173 * Added basic statistics support
174 * Added promiscuous and allmulticast mode support
175 * Added MTU update support
176 * Added jumbo frame support
177 * Added queue start/stop
178 * Added CRC offload support
179 * Added Rx checksum offload validation support
181 * **Updated the atlantic PMD.**
183 Added MACSEC hardware offload experimental API.
185 * **Updated the QuickAssist Technology PMD.**
187 Added support for AES-XTS with 128 and 256 bit AES keys.
189 * **Added Intel QuickAssist Technology PMD for asymmetric crypto.**
191 A new QAT Crypto PMD has been added, which provides asymmetric cryptography
192 algorithms, in this release modular exponentiation and modular multiplicative
193 inverse algorithms were added.
195 * **Updated AESNI-MB PMD.**
197 Added support for out-of-place operations.
199 * **Updated the IPsec library.**
201 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
202 support. The related ipsec-secgw test scripts have been added.
204 * **Updated the testpmd application.**
206 Improved testpmd application performance on ARM platform. For ``macswap``
207 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
209 * **Updated power management library.**
211 Added support for Intel Speed Select Technology - Base Frequency (SST-BF).
212 ``rte_power_get_capabilities`` now has a bit in it's returned mask
213 indicating it's a high frequency core.
215 * **Updated distributor sample application.**
217 Added support for Intel SST-BF feature so that the distributor core is
218 pinned to a high frequency core if available.
224 .. This section should contain removed items in this release. Sample format:
226 * Add a short 1-2 sentence description of the removed item
229 This section is a comment. Do not overwrite or remove it.
230 Also, make sure to start the actual text at the margin.
231 =========================================================
237 .. This section should contain API changes. Sample format:
239 * sample: Add a short 1-2 sentence description of the API change
240 which was announced in the previous releases and made in this release.
241 Start with a scope label like "ethdev:".
242 Use fixed width quotes for ``function_names`` or ``struct_names``.
245 This section is a comment. Do not overwrite or remove it.
246 Also, make sure to start the actual text at the margin.
247 =========================================================
249 * eal: the type of the ``attr_value`` parameter of the function
250 ``rte_service_attr_get()`` has been changed
251 from ``uint32_t *`` to ``uint64_t *``.
253 * meter: replace ``enum rte_meter_color`` in meter library with new
254 ``rte_color`` definition added in 19.02. To consolidate mulitple color
255 definitions replicated at many places such as: rte_mtr.h, rte_tm.h,
256 replacements with rte_color values are done.
258 * vfio: Functions ``rte_vfio_container_dma_map`` and
259 ``rte_vfio_container_dma_unmap`` have been extended with an option to
260 request mapping or un-mapping to the default vfio container fd.
262 * power: ``rte_power_set_env`` and ``rte_power_unset_env`` functions
263 have been modified to be thread safe.
269 .. This section should contain ABI changes. Sample format:
271 * sample: Add a short 1-2 sentence description of the ABI change
272 which was announced in the previous releases and made in this release.
273 Start with a scope label like "ethdev:".
274 Use fixed width quotes for ``function_names`` or ``struct_names``.
277 This section is a comment. Do not overwrite or remove it.
278 Also, make sure to start the actual text at the margin.
279 =========================================================
281 * ethdev: Additional fields in rte_eth_dev_info.
283 The ``rte_eth_dev_info`` structure has had two extra fields
284 added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
285 The values of these fields can be set specifically by the PMD drivers as
286 supported values can vary from device to device.
288 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
289 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
290 defined as cache-line aligned that caused unintended changes in
291 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
292 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
293 layout and alignment.
296 Shared Library Versions
297 -----------------------
299 .. Update any library version updated in this release
300 and prepend with a ``+`` sign, like this:
306 This section is a comment. Do not overwrite or remove it.
307 =========================================================
309 The libraries prepended with a plus sign were incremented in this version.
315 librte_bitratestats.so.2
318 librte_bus_fslmc.so.2
319 librte_bus_ifpga.so.2
322 librte_bus_vmbus.so.2
325 librte_compressdev.so.1
326 + librte_cryptodev.so.7
327 librte_distributor.so.1
330 + librte_ethdev.so.12
332 librte_flow_classify.so.1
341 librte_latencystats.so.1
355 librte_pmd_ixgbe.so.2
356 librte_pmd_dpaa2_qdma.so.1
358 librte_pmd_softnic.so.1
359 librte_pmd_vhost.so.2
377 .. This section should contain new known issues in this release. Sample format:
379 * **Add title in present tense with full stop.**
381 Add a short 1-2 sentence description of the known issue
382 in the present tense. Add information on any known workarounds.
384 This section is a comment. Do not overwrite or remove it.
385 Also, make sure to start the actual text at the margin.
386 =========================================================
388 * **On x86 platforms, AVX512 support is disabled with binutils 2.31**
390 Because a defect in binutils 2.31 AVX512 support is disabled.
391 DPDK defect: https://bugs.dpdk.org/show_bug.cgi?id=249
392 GCC defect: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90028
394 * **No software AES-XTS implementation.**
396 There are currently no cryptodev software PMDs available which implement
397 support for the AES-XTS algorithm, so this feature can only be used
398 if compatible hardware and an associated PMD is available.
404 .. This section should contain a list of platforms that were tested
409 * <vendor> platform with <vendor> <type of devices> combinations
414 * Other relevant details...
416 This section is a comment. Do not overwrite or remove it.
417 Also, make sure to start the actual text at the margin.
418 =========================================================