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_19_11.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 Lock-free Stack for aarch64.**
61 The lock-free stack implementation is enabled for aarch64 platforms.
63 * **Added Hisilicon hns3 PMD.**
65 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
66 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
67 See the :doc:`../nics/hns3` guide for more details on this new driver.
69 * **Updated the Intel e1000 driver.**
71 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
73 * **Updated the Intel ixgbe driver.**
75 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
77 * **Updated the Intel i40e driver.**
79 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
81 * **Updated the Intel fm10k driver.**
83 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
85 * **Updated the Intel ice driver.**
87 Updated the Intel ice driver with new features and improvements, including:
89 * Added support for device-specific DDP package loading.
90 * Added support for handling Receive Flex Descriptor.
91 * Added support for protocol extraction on per Rx queue.
92 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
94 * **Added cryptodev asymmetric session-less operation.**
96 Added session-less option to cryptodev asymmetric structure. It works the same
97 way as symmetric crypto, corresponding xform is used directly by the crypto op.
99 * **Added Marvell NITROX symmetric crypto PMD.**
101 Added a symmetric crypto PMD for Marvell NITROX V security processor.
102 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
104 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
106 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
107 Supports RSA and modexp operations.
109 * **Added Marvell OCTEON TX2 crypto PMD**
111 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
113 See :doc:`../cryptodevs/octeontx2` for more details
115 * **Updated NXP crypto PMDs for PDCP support.**
117 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
118 Support is added for all sequence number sizes for control and user plane.
119 Test application is updated for unit testing.
121 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
123 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
124 QuickAssist Technology C4xxx). It is automatically chosen instead of the
125 classic 2-pass mode when running on QAT GEN3, significantly improving
126 the performance of AES GCM operations.
128 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
130 * Added support for asymmetric session-less operations.
132 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
134 Added stateful decompression support in the Intel QuickAssist Technology PMD.
135 Please note that stateful compression is not supported.
137 * **Added external buffers support for dpdk-test-compress-perf tool.**
139 Added a command line option to dpdk-test-compress-perf tool to allocate
140 and use memory zones as external buffers instead of keeping the data directly
143 * **Updated the IPSec library.**
145 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
146 introduced to evaluate and perform custom functional and performance tests
147 for IPsec SAD implementation.
149 * **Introduced FIFO for NTB PMD.**
151 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
152 packet based processing.
154 * **Added eBPF JIT support for arm64.**
156 Added eBPF JIT support for arm64 architecture to improve the eBPF program
163 .. This section should contain removed items in this release. Sample format:
165 * Add a short 1-2 sentence description of the removed item
168 This section is a comment. Do not overwrite or remove it.
169 Also, make sure to start the actual text at the margin.
170 =========================================================
172 * Removed duplicated set of commands for Rx offload configuration from testpmd::
174 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
175 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
177 The testpmd commands set that can be used instead
178 in order to enable or disable Rx offloading on all Rx queues of a port is::
180 port config <port_id> rx_offload crc_strip|scatter|
181 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
182 vlan_strip|vlan_filter|vlan_extend on|off
188 .. This section should contain API changes. Sample format:
190 * sample: Add a short 1-2 sentence description of the API change
191 which was announced in the previous releases and made in this release.
192 Start with a scope label like "ethdev:".
193 Use fixed width quotes for ``function_names`` or ``struct_names``.
196 This section is a comment. Do not overwrite or remove it.
197 Also, make sure to start the actual text at the margin.
198 =========================================================
200 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
201 ``int`` to provide a way to report various error conditions.
203 * ethdev: changed ``rte_eth_promiscuous_enable`` and
204 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
205 provide a way to report various error conditions.
207 * ethdev: changed ``rte_eth_allmulticast_enable`` and
208 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
209 provide a way to report various error conditions.
211 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
212 ``int`` to provide a way to report various error conditions.
214 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
215 return value from ``void`` to ``int`` to provide a way to report various
218 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
219 ``int`` to provide a way to report various error conditions.
221 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
222 ``int`` to provide a way to report various error conditions.
224 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
225 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
226 has been introduced in this release is used when used when all the packets
227 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
233 .. This section should contain ABI changes. Sample format:
235 * sample: Add a short 1-2 sentence description of the ABI change
236 which was announced in the previous releases and made in this release.
237 Start with a scope label like "ethdev:".
238 Use fixed width quotes for ``function_names`` or ``struct_names``.
241 This section is a comment. Do not overwrite or remove it.
242 Also, make sure to start the actual text at the margin.
243 =========================================================
246 Shared Library Versions
247 -----------------------
249 .. Update any library version updated in this release
250 and prepend with a ``+`` sign, like this:
256 This section is a comment. Do not overwrite or remove it.
257 =========================================================
259 The libraries prepended with a plus sign were incremented in this version.
265 librte_bitratestats.so.2
268 librte_bus_fslmc.so.2
269 librte_bus_ifpga.so.2
272 librte_bus_vmbus.so.2
275 librte_compressdev.so.1
276 librte_cryptodev.so.8
277 librte_distributor.so.1
280 + librte_ethdev.so.13
281 + librte_eventdev.so.8
282 librte_flow_classify.so.1
291 librte_latencystats.so.1
305 librte_pmd_ixgbe.so.2
306 librte_pmd_dpaa2_qdma.so.1
308 librte_pmd_softnic.so.1
309 librte_pmd_vhost.so.2
327 .. This section should contain new known issues in this release. Sample format:
329 * **Add title in present tense with full stop.**
331 Add a short 1-2 sentence description of the known issue
332 in the present tense. Add information on any known workarounds.
334 This section is a comment. Do not overwrite or remove it.
335 Also, make sure to start the actual text at the margin.
336 =========================================================
342 .. This section should contain a list of platforms that were tested
347 * <vendor> platform with <vendor> <type of devices> combinations
352 * Other relevant details...
354 This section is a comment. Do not overwrite or remove it.
355 Also, make sure to start the actual text at the margin.
356 =========================================================
358 * **Updated Mellanox mlx5 driver.**
360 Updated Mellanox mlx5 driver with new features and improvements, including:
362 * Added support for VLAN pop flow offload command.
363 * Added support for VLAN push flow offload command.
364 * Added support for VLAN set PCP offload command.
365 * Added support for VLAN set VID offload command.