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) compression PMD.**
130 Added stateful decompression support in the Intel QuickAssist Technology PMD.
131 Please note that stateful compression is not supported.
133 * **Added external buffers support for dpdk-test-compress-perf tool.**
135 Added a command line option to dpdk-test-compress-perf tool to allocate
136 and use memory zones as external buffers instead of keeping the data directly
139 * **Updated the IPSec library.**
141 Added SA Database API to ``librte_ipsec``.
143 * **Introduced FIFO for NTB PMD.**
145 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
146 packet based processing.
148 * **Added eBPF JIT support for arm64.**
150 Added eBPF JIT support for arm64 architecture to improve the eBPF program
157 .. This section should contain removed items in this release. Sample format:
159 * Add a short 1-2 sentence description of the removed item
162 This section is a comment. Do not overwrite or remove it.
163 Also, make sure to start the actual text at the margin.
164 =========================================================
166 * Removed duplicated set of commands for Rx offload configuration from testpmd::
168 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
169 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
171 The testpmd commands set that can be used instead
172 in order to enable or disable Rx offloading on all Rx queues of a port is::
174 port config <port_id> rx_offload crc_strip|scatter|
175 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
176 vlan_strip|vlan_filter|vlan_extend on|off
182 .. This section should contain API changes. Sample format:
184 * sample: Add a short 1-2 sentence description of the API change
185 which was announced in the previous releases and made in this release.
186 Start with a scope label like "ethdev:".
187 Use fixed width quotes for ``function_names`` or ``struct_names``.
190 This section is a comment. Do not overwrite or remove it.
191 Also, make sure to start the actual text at the margin.
192 =========================================================
194 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
195 ``int`` to provide a way to report various error conditions.
197 * ethdev: changed ``rte_eth_promiscuous_enable`` and
198 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
199 provide a way to report various error conditions.
201 * ethdev: changed ``rte_eth_allmulticast_enable`` and
202 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
203 provide a way to report various error conditions.
205 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
206 ``int`` to provide a way to report various error conditions.
208 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
209 return value from ``void`` to ``int`` to provide a way to report various
212 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
213 ``int`` to provide a way to report various error conditions.
215 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
216 ``int`` to provide a way to report various error conditions.
218 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
219 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
220 has been introduced in this release is used when used when all the packets
221 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
227 .. This section should contain ABI changes. Sample format:
229 * sample: Add a short 1-2 sentence description of the ABI change
230 which was announced in the previous releases and made in this release.
231 Start with a scope label like "ethdev:".
232 Use fixed width quotes for ``function_names`` or ``struct_names``.
235 This section is a comment. Do not overwrite or remove it.
236 Also, make sure to start the actual text at the margin.
237 =========================================================
240 Shared Library Versions
241 -----------------------
243 .. Update any library version updated in this release
244 and prepend with a ``+`` sign, like this:
250 This section is a comment. Do not overwrite or remove it.
251 =========================================================
253 The libraries prepended with a plus sign were incremented in this version.
259 librte_bitratestats.so.2
262 librte_bus_fslmc.so.2
263 librte_bus_ifpga.so.2
266 librte_bus_vmbus.so.2
269 librte_compressdev.so.1
270 librte_cryptodev.so.8
271 librte_distributor.so.1
274 + librte_ethdev.so.13
275 + librte_eventdev.so.8
276 librte_flow_classify.so.1
285 librte_latencystats.so.1
299 librte_pmd_ixgbe.so.2
300 librte_pmd_dpaa2_qdma.so.1
302 librte_pmd_softnic.so.1
303 librte_pmd_vhost.so.2
321 .. This section should contain new known issues in this release. Sample format:
323 * **Add title in present tense with full stop.**
325 Add a short 1-2 sentence description of the known issue
326 in the present tense. Add information on any known workarounds.
328 This section is a comment. Do not overwrite or remove it.
329 Also, make sure to start the actual text at the margin.
330 =========================================================
336 .. This section should contain a list of platforms that were tested
341 * <vendor> platform with <vendor> <type of devices> combinations
346 * Other relevant details...
348 This section is a comment. Do not overwrite or remove it.
349 Also, make sure to start the actual text at the margin.
350 =========================================================
352 * **Updated Mellanox mlx5 driver.**
354 Updated Mellanox mlx5 driver with new features and improvements, including:
356 * Added support for VLAN pop flow offload command.
357 * Added support for VLAN push flow offload command.
358 * Added support for VLAN set PCP offload command.
359 * Added support for VLAN set VID offload command.