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 Hisilicon hns3 PMD.**
61 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
62 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
63 See the :doc:`../nics/hns3` guide for more details on this new driver.
65 * **Updated the Intel e1000 driver.**
67 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
69 * **Updated the Intel ice driver.**
71 Updated the Intel ice driver with new features and improvements, including:
73 * Added support for device-specific DDP package loading.
74 * Added support for handling Receive Flex Descriptor.
75 * Added support for protocol extraction on per Rx queue.
77 * **Added Marvell NITROX symmetric crypto PMD.**
79 Added a symmetric crypto PMD for Marvell NITROX V security processor.
80 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
82 * **Updated NXP crypto PMDs for PDCP support.**
84 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
85 Support is added for all sequence number sizes for control and user plane.
86 Test application is updated for unit testing.
88 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
90 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
91 QuickAssist Technology C4xxx). It is automatically chosen instead of the
92 classic 2-pass mode when running on QAT GEN3, significantly improving
93 the performance of AES GCM operations.
95 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
97 Added stateful decompression support in the Intel QuickAssist Technology PMD.
98 Please note that stateful compression is not supported.
104 .. This section should contain removed items in this release. Sample format:
106 * Add a short 1-2 sentence description of the removed item
109 This section is a comment. Do not overwrite or remove it.
110 Also, make sure to start the actual text at the margin.
111 =========================================================
113 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
114 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
115 hw-vlan-strip|hw-vlan-extend on|off”.
117 The testpmd commands set that can be used instead in order to enable or disable Rx
118 offloading on all Rx queues of a port is:
119 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
120 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
126 .. This section should contain API changes. Sample format:
128 * sample: Add a short 1-2 sentence description of the API change
129 which was announced in the previous releases and made in this release.
130 Start with a scope label like "ethdev:".
131 Use fixed width quotes for ``function_names`` or ``struct_names``.
134 This section is a comment. Do not overwrite or remove it.
135 Also, make sure to start the actual text at the margin.
136 =========================================================
138 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
139 ``int`` to provide a way to report various error conditions.
141 * ethdev: changed ``rte_eth_promiscuous_enable`` and
142 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
143 provide a way to report various error conditions.
145 * ethdev: changed ``rte_eth_allmulticast_enable`` and
146 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
147 provide a way to report various error conditions.
149 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
150 ``int`` to provide a way to report various error conditions.
152 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
153 return value from ``void`` to ``int`` to provide a way to report various
156 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
157 ``int`` to provide a way to report various error conditions.
159 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
160 ``int`` to provide a way to report various error conditions.
166 .. This section should contain ABI changes. Sample format:
168 * sample: Add a short 1-2 sentence description of the ABI 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 =========================================================
179 Shared Library Versions
180 -----------------------
182 .. Update any library version updated in this release
183 and prepend with a ``+`` sign, like this:
189 This section is a comment. Do not overwrite or remove it.
190 =========================================================
192 The libraries prepended with a plus sign were incremented in this version.
198 librte_bitratestats.so.2
201 librte_bus_fslmc.so.2
202 librte_bus_ifpga.so.2
205 librte_bus_vmbus.so.2
208 librte_compressdev.so.1
209 librte_cryptodev.so.8
210 librte_distributor.so.1
213 + librte_ethdev.so.13
215 librte_flow_classify.so.1
224 librte_latencystats.so.1
238 librte_pmd_ixgbe.so.2
239 librte_pmd_dpaa2_qdma.so.1
241 librte_pmd_softnic.so.1
242 librte_pmd_vhost.so.2
260 .. This section should contain new known issues in this release. Sample format:
262 * **Add title in present tense with full stop.**
264 Add a short 1-2 sentence description of the known issue
265 in the present tense. Add information on any known workarounds.
267 This section is a comment. Do not overwrite or remove it.
268 Also, make sure to start the actual text at the margin.
269 =========================================================
275 .. This section should contain a list of platforms that were tested
280 * <vendor> platform with <vendor> <type of devices> combinations
285 * Other relevant details...
287 This section is a comment. Do not overwrite or remove it.
288 Also, make sure to start the actual text at the margin.
289 =========================================================
291 * **Updated Mellanox mlx5 driver.**
293 Updated Mellanox mlx5 driver with new features and improvements, including:
295 * Added support for VLAN pop flow offload command.
296 * Added support for VLAN push flow offload command.
297 * Added support for VLAN set PCP offload command.
298 * Added support for VLAN set VID offload command.