1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 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_02.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 Wait Until Equal API.**
61 A new API has been added to wait for a memory location to be updated with a
62 16-bit, 32-bit, 64-bit value.
64 * **Updated rte_flow api to support L2TPv3 over IP flows.**
66 Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
68 * **Added IONIC net PMD.**
70 Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
71 See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
73 * **Updated Broadcom bnxt driver**
75 Updated Broadcom bnxt driver with new features and improvements, including:
77 * Added support for MARK action.
79 * **Updated Hisilicon hns3 driver.**
81 Updated Hisilicon hns3 driver with new features and improvements, including:
83 * Added support for Rx interrupt.
84 * Added support setting VF MAC address by PF driver.
86 * **Updated the Intel ice driver.**
88 Updated the Intel ice driver with new features and improvements, including:
90 * Added support for MAC rules on specific port.
91 * Added support for MAC/VLAN with TCP/UDP in switch rule.
92 * Added support for 1/10G device.
93 * Added support for API rte_eth_tx_done_cleanup.
95 * **Updated Intel iavf driver.**
97 Updated iavf PMD with new features and improvements, including:
99 * Added more supported device IDs.
100 * Updated virtual channel to latest AVF spec.
102 * **Updated the Intel ixgbe driver.**
104 * Added support for API rte_eth_tx_done_cleanup.
105 * Added support setting VF MAC address by PF driver.
106 * Added support for setting the link to specific speed.
108 * **Updated Intel i40e driver.**
110 Updated i40e PMD with new features and improvements, including:
112 * Added support for L2TPv3 over IP profiles which can be programmed by the
113 dynamic device personalization (DDP) process.
114 * Added support for ESP-AH profiles which can be programmed by the
115 dynamic device personalization (DDP) process.
116 * Added PF support Malicious Device Drive event catch and notify.
117 * Added LLDP support.
118 * Extended PHY access AQ cmd.
119 * Added support for reading LPI counters.
120 * Added support for Energy Efficient Ethernet.
121 * Added support for API rte_eth_tx_done_cleanup.
122 * Added support for VF multiple queues interrupt.
123 * Added support for setting the link to specific speed.
125 * **Updated Mellanox mlx5 driver.**
127 Updated Mellanox mlx5 driver with new features and improvements, including:
129 * Added support for RSS using L3/L4 source/destination only.
130 * Added support for matching on GTP tunnel header item.
131 * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
133 * **Add new vDPA PMD based on Mellanox devices**
135 Added a new Mellanox vDPA (``mlx5_vdpa``) PMD.
136 See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
138 * **Added support for virtio-PMD notification data.**
140 Added support for virtio-PMD notification data so that the driver
141 passes extra data (besides identifying the virtqueue) in its device
142 notifications, expanding the notifications to include the avail index and
143 avail wrap counter (When split ring is used, the avail wrap counter is not
144 included in the notification data).
146 * **Updated testpmd application.**
148 Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
151 * **Added algorithms to cryptodev API.**
153 * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
154 asymmetric crypto library specifications.
155 * ECPM (Elliptic Curve Point Multiplication) is added to
156 asymmetric crypto library specifications.
158 * **Added synchronous Crypto burst API.**
160 A new API is introduced in crypto library to handle synchronous cryptographic
161 operations allowing to achieve performance gain for cryptodevs which use
162 CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
163 cryptodev is provided. The IPsec example application and ipsec library itself
164 were changed to allow utilization of this new feature.
166 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
168 Added handling of mixed algorithms in encrypted digest hash-cipher
169 (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
170 ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
171 Such algorithm combinations are not supported on GEN1/GEN2 hardware
172 and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
174 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
176 Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
177 a single queue-pair all enqueues to the TX queue must be done from one thread
178 and all dequeues from the RX queue must be done from one thread, but enqueues
179 and dequeues may be done in different threads.).
181 * **Updated the ZUC PMD.**
183 * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
184 library (minimum version required 0.53).
185 * Removed dynamic library limitation, so PMD can be built as a shared
188 * **Updated the KASUMI PMD.**
190 * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
191 library (minimum version required 0.53).
193 * **Updated the SNOW3G PMD.**
195 * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
196 library (minimum version required 0.53).
198 * **Changed armv8 crypto PMD external dependency.**
200 armv8 crypto PMD now depends on Arm crypto library, and Marvell's
201 armv8 crypto library is not used anymore. Library name is changed
202 from armv8_crypto to AArch64crypto.
204 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
206 Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
207 applications would be able to offload entire IPsec offload to the hardware.
208 For the configured sessions, hardware will do the lookup and perform
209 decryption and IPsec transformation. For the outbound path, application
210 can submit a plain packet to the PMD, and it would be sent out on wire
211 after doing encryption and IPsec transformation of the packet.
213 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
215 Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
216 See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
218 * **Added event mode to l3fwd sample application.**
220 Add event device support for ``l3fwd`` sample application. It demonstrates
221 usage of poll and event mode IO mechanism under a single application.
223 * **Added cycle-count mode to the compression performance tool.**
225 Enhanced the compression performance tool by adding a cycle-count mode
226 which can be used to help measure and tune hardware and software PMDs.
232 .. This section should contain removed items in this release. Sample format:
234 * Add a short 1-2 sentence description of the removed item
237 This section is a comment. Do not overwrite or remove it.
238 Also, make sure to start the actual text at the margin.
239 =========================================================
241 * **Disabled building all the Linux kernel modules by default.**
243 In order to remove the build time dependency with Linux kernel,
244 the Technical Board decided to disable all the kernel modules
245 by default from 20.02 version.
247 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
249 The internal tail write coalescing feature was removed as not compatible with
250 dual-thread feature. It was replaced with a threshold feature. At busy times
251 if only a small number of packets can be enqueued, each enqueue causes
252 an expensive MMIO write. These MMIO write occurrences can be optimised by using
253 the new threshold parameter on process start. Please see qat documentation for
260 .. This section should contain API changes. Sample format:
262 * sample: Add a short 1-2 sentence description of the API change
263 which was announced in the previous releases and made in this release.
264 Start with a scope label like "ethdev:".
265 Use fixed width quotes for ``function_names`` or ``struct_names``.
268 This section is a comment. Do not overwrite or remove it.
269 Also, make sure to start the actual text at the margin.
270 =========================================================
276 .. This section should contain ABI changes. Sample format:
278 * sample: Add a short 1-2 sentence description of the ABI change
279 which was announced in the previous releases and made in this release.
280 Start with a scope label like "ethdev:".
281 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
294 .. This section should contain new known issues in this release. Sample format:
296 * **Add title in present tense with full stop.**
298 Add a short 1-2 sentence description of the known issue
299 in the present tense. Add information on any known workarounds.
301 This section is a comment. Do not overwrite or remove it.
302 Also, make sure to start the actual text at the margin.
303 =========================================================
309 .. This section should contain a list of platforms that were tested
314 * <vendor> platform with <vendor> <type of devices> combinations
319 * Other relevant details...
321 This section is a comment. Do not overwrite or remove it.
322 Also, make sure to start the actual text at the margin.
323 =========================================================