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 * **Updated NXP crypto PMDs for PDCP support.**
111 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
112 Support is added for all sequence number sizes for control and user plane.
113 Test application is updated for unit testing.
115 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
117 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
118 QuickAssist Technology C4xxx). It is automatically chosen instead of the
119 classic 2-pass mode when running on QAT GEN3, significantly improving
120 the performance of AES GCM operations.
122 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
124 Added stateful decompression support in the Intel QuickAssist Technology PMD.
125 Please note that stateful compression is not supported.
127 * **Introduced FIFO for NTB PMD.**
129 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
130 packet based processing.
132 * **Added eBPF JIT support for arm64.**
134 Added eBPF JIT support for arm64 architecture to improve the eBPF program
141 .. This section should contain removed items in this release. Sample format:
143 * Add a short 1-2 sentence description of the removed item
146 This section is a comment. Do not overwrite or remove it.
147 Also, make sure to start the actual text at the margin.
148 =========================================================
150 * Removed duplicated set of commands for Rx offload configuration from testpmd::
152 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
153 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
155 The testpmd commands set that can be used instead
156 in order to enable or disable Rx offloading on all Rx queues of a port is::
158 port config <port_id> rx_offload crc_strip|scatter|
159 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
160 vlan_strip|vlan_filter|vlan_extend on|off
166 .. This section should contain API changes. Sample format:
168 * sample: Add a short 1-2 sentence description of the API change
169 which was announced in the previous releases and made in this release.
170 Start with a scope label like "ethdev:".
171 Use fixed width quotes for ``function_names`` or ``struct_names``.
174 This section is a comment. Do not overwrite or remove it.
175 Also, make sure to start the actual text at the margin.
176 =========================================================
178 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
179 ``int`` to provide a way to report various error conditions.
181 * ethdev: changed ``rte_eth_promiscuous_enable`` and
182 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
183 provide a way to report various error conditions.
185 * ethdev: changed ``rte_eth_allmulticast_enable`` and
186 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
187 provide a way to report various error conditions.
189 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
190 ``int`` to provide a way to report various error conditions.
192 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
193 return value from ``void`` to ``int`` to provide a way to report various
196 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
197 ``int`` to provide a way to report various error conditions.
199 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
200 ``int`` to provide a way to report various error conditions.
202 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
203 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
204 has been introduced in this release is used when used when all the packets
205 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
211 .. This section should contain ABI changes. Sample format:
213 * sample: Add a short 1-2 sentence description of the ABI change
214 which was announced in the previous releases and made in this release.
215 Start with a scope label like "ethdev:".
216 Use fixed width quotes for ``function_names`` or ``struct_names``.
219 This section is a comment. Do not overwrite or remove it.
220 Also, make sure to start the actual text at the margin.
221 =========================================================
224 Shared Library Versions
225 -----------------------
227 .. Update any library version updated in this release
228 and prepend with a ``+`` sign, like this:
234 This section is a comment. Do not overwrite or remove it.
235 =========================================================
237 The libraries prepended with a plus sign were incremented in this version.
243 librte_bitratestats.so.2
246 librte_bus_fslmc.so.2
247 librte_bus_ifpga.so.2
250 librte_bus_vmbus.so.2
253 librte_compressdev.so.1
254 librte_cryptodev.so.8
255 librte_distributor.so.1
258 + librte_ethdev.so.13
259 + librte_eventdev.so.8
260 librte_flow_classify.so.1
269 librte_latencystats.so.1
283 librte_pmd_ixgbe.so.2
284 librte_pmd_dpaa2_qdma.so.1
286 librte_pmd_softnic.so.1
287 librte_pmd_vhost.so.2
305 .. This section should contain new known issues in this release. Sample format:
307 * **Add title in present tense with full stop.**
309 Add a short 1-2 sentence description of the known issue
310 in the present tense. Add information on any known workarounds.
312 This section is a comment. Do not overwrite or remove it.
313 Also, make sure to start the actual text at the margin.
314 =========================================================
320 .. This section should contain a list of platforms that were tested
325 * <vendor> platform with <vendor> <type of devices> combinations
330 * Other relevant details...
332 This section is a comment. Do not overwrite or remove it.
333 Also, make sure to start the actual text at the margin.
334 =========================================================
336 * **Updated Mellanox mlx5 driver.**
338 Updated Mellanox mlx5 driver with new features and improvements, including:
340 * Added support for VLAN pop flow offload command.
341 * Added support for VLAN push flow offload command.
342 * Added support for VLAN set PCP offload command.
343 * Added support for VLAN set VID offload command.