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 Marvell NITROX symmetric crypto PMD.**
96 Added a symmetric crypto PMD for Marvell NITROX V security processor.
97 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
99 * **Updated NXP crypto PMDs for PDCP support.**
101 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
102 Support is added for all sequence number sizes for control and user plane.
103 Test application is updated for unit testing.
105 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
107 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
108 QuickAssist Technology C4xxx). It is automatically chosen instead of the
109 classic 2-pass mode when running on QAT GEN3, significantly improving
110 the performance of AES GCM operations.
112 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
114 Added stateful decompression support in the Intel QuickAssist Technology PMD.
115 Please note that stateful compression is not supported.
117 * **Introduced FIFO for NTB PMD.**
119 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
120 packet based processing.
122 * **Added eBPF JIT support for arm64.**
124 Added eBPF JIT support for arm64 architecture to improve the eBPF program
131 .. This section should contain removed items in this release. Sample format:
133 * Add a short 1-2 sentence description of the removed item
136 This section is a comment. Do not overwrite or remove it.
137 Also, make sure to start the actual text at the margin.
138 =========================================================
140 * Removed duplicated set of commands for Rx offload configuration from testpmd::
142 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
143 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
145 The testpmd commands set that can be used instead
146 in order to enable or disable Rx offloading on all Rx queues of a port is::
148 port config <port_id> rx_offload crc_strip|scatter|
149 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
150 vlan_strip|vlan_filter|vlan_extend on|off
156 .. This section should contain API changes. Sample format:
158 * sample: Add a short 1-2 sentence description of the API change
159 which was announced in the previous releases and made in this release.
160 Start with a scope label like "ethdev:".
161 Use fixed width quotes for ``function_names`` or ``struct_names``.
164 This section is a comment. Do not overwrite or remove it.
165 Also, make sure to start the actual text at the margin.
166 =========================================================
168 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
169 ``int`` to provide a way to report various error conditions.
171 * ethdev: changed ``rte_eth_promiscuous_enable`` and
172 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
173 provide a way to report various error conditions.
175 * ethdev: changed ``rte_eth_allmulticast_enable`` and
176 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
177 provide a way to report various error conditions.
179 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
180 ``int`` to provide a way to report various error conditions.
182 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
183 return value from ``void`` to ``int`` to provide a way to report various
186 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
187 ``int`` to provide a way to report various error conditions.
189 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
190 ``int`` to provide a way to report various error conditions.
192 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
193 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
194 has been introduced in this release is used when used when all the packets
195 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
201 .. This section should contain ABI changes. Sample format:
203 * sample: Add a short 1-2 sentence description of the ABI change
204 which was announced in the previous releases and made in this release.
205 Start with a scope label like "ethdev:".
206 Use fixed width quotes for ``function_names`` or ``struct_names``.
209 This section is a comment. Do not overwrite or remove it.
210 Also, make sure to start the actual text at the margin.
211 =========================================================
214 Shared Library Versions
215 -----------------------
217 .. Update any library version updated in this release
218 and prepend with a ``+`` sign, like this:
224 This section is a comment. Do not overwrite or remove it.
225 =========================================================
227 The libraries prepended with a plus sign were incremented in this version.
233 librte_bitratestats.so.2
236 librte_bus_fslmc.so.2
237 librte_bus_ifpga.so.2
240 librte_bus_vmbus.so.2
243 librte_compressdev.so.1
244 librte_cryptodev.so.8
245 librte_distributor.so.1
248 + librte_ethdev.so.13
249 + librte_eventdev.so.8
250 librte_flow_classify.so.1
259 librte_latencystats.so.1
273 librte_pmd_ixgbe.so.2
274 librte_pmd_dpaa2_qdma.so.1
276 librte_pmd_softnic.so.1
277 librte_pmd_vhost.so.2
295 .. This section should contain new known issues in this release. Sample format:
297 * **Add title in present tense with full stop.**
299 Add a short 1-2 sentence description of the known issue
300 in the present tense. Add information on any known workarounds.
302 This section is a comment. Do not overwrite or remove it.
303 Also, make sure to start the actual text at the margin.
304 =========================================================
310 .. This section should contain a list of platforms that were tested
315 * <vendor> platform with <vendor> <type of devices> combinations
320 * Other relevant details...
322 This section is a comment. Do not overwrite or remove it.
323 Also, make sure to start the actual text at the margin.
324 =========================================================
326 * **Updated Mellanox mlx5 driver.**
328 Updated Mellanox mlx5 driver with new features and improvements, including:
330 * Added support for VLAN pop flow offload command.
331 * Added support for VLAN push flow offload command.
332 * Added support for VLAN set PCP offload command.
333 * Added support for VLAN set VID offload command.