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 i40e driver.**
71 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
73 * **Updated the Intel fm10k driver.**
75 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
77 * **Updated the Intel ice driver.**
79 Updated the Intel ice driver with new features and improvements, including:
81 * Added support for device-specific DDP package loading.
82 * Added support for handling Receive Flex Descriptor.
83 * Added support for protocol extraction on per Rx queue.
85 * **Added Marvell NITROX symmetric crypto PMD.**
87 Added a symmetric crypto PMD for Marvell NITROX V security processor.
88 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
90 * **Updated NXP crypto PMDs for PDCP support.**
92 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
93 Support is added for all sequence number sizes for control and user plane.
94 Test application is updated for unit testing.
96 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
98 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
99 QuickAssist Technology C4xxx). It is automatically chosen instead of the
100 classic 2-pass mode when running on QAT GEN3, significantly improving
101 the performance of AES GCM operations.
103 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
105 Added stateful decompression support in the Intel QuickAssist Technology PMD.
106 Please note that stateful compression is not supported.
112 .. This section should contain removed items in this release. Sample format:
114 * Add a short 1-2 sentence description of the removed item
117 This section is a comment. Do not overwrite or remove it.
118 Also, make sure to start the actual text at the margin.
119 =========================================================
121 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
122 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
123 hw-vlan-strip|hw-vlan-extend on|off”.
125 The testpmd commands set that can be used instead in order to enable or disable Rx
126 offloading on all Rx queues of a port is:
127 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
128 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
134 .. This section should contain API changes. Sample format:
136 * sample: Add a short 1-2 sentence description of the API change
137 which was announced in the previous releases and made in this release.
138 Start with a scope label like "ethdev:".
139 Use fixed width quotes for ``function_names`` or ``struct_names``.
142 This section is a comment. Do not overwrite or remove it.
143 Also, make sure to start the actual text at the margin.
144 =========================================================
146 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
147 ``int`` to provide a way to report various error conditions.
149 * ethdev: changed ``rte_eth_promiscuous_enable`` and
150 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
151 provide a way to report various error conditions.
153 * ethdev: changed ``rte_eth_allmulticast_enable`` and
154 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
155 provide a way to report various error conditions.
157 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
158 ``int`` to provide a way to report various error conditions.
160 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
161 return value from ``void`` to ``int`` to provide a way to report various
164 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
165 ``int`` to provide a way to report various error conditions.
167 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
168 ``int`` to provide a way to report various error conditions.
174 .. This section should contain ABI changes. Sample format:
176 * sample: Add a short 1-2 sentence description of the ABI change
177 which was announced in the previous releases and made in this release.
178 Start with a scope label like "ethdev:".
179 Use fixed width quotes for ``function_names`` or ``struct_names``.
182 This section is a comment. Do not overwrite or remove it.
183 Also, make sure to start the actual text at the margin.
184 =========================================================
187 Shared Library Versions
188 -----------------------
190 .. Update any library version updated in this release
191 and prepend with a ``+`` sign, like this:
197 This section is a comment. Do not overwrite or remove it.
198 =========================================================
200 The libraries prepended with a plus sign were incremented in this version.
206 librte_bitratestats.so.2
209 librte_bus_fslmc.so.2
210 librte_bus_ifpga.so.2
213 librte_bus_vmbus.so.2
216 librte_compressdev.so.1
217 librte_cryptodev.so.8
218 librte_distributor.so.1
221 + librte_ethdev.so.13
223 librte_flow_classify.so.1
232 librte_latencystats.so.1
246 librte_pmd_ixgbe.so.2
247 librte_pmd_dpaa2_qdma.so.1
249 librte_pmd_softnic.so.1
250 librte_pmd_vhost.so.2
268 .. This section should contain new known issues in this release. Sample format:
270 * **Add title in present tense with full stop.**
272 Add a short 1-2 sentence description of the known issue
273 in the present tense. Add information on any known workarounds.
275 This section is a comment. Do not overwrite or remove it.
276 Also, make sure to start the actual text at the margin.
277 =========================================================
283 .. This section should contain a list of platforms that were tested
288 * <vendor> platform with <vendor> <type of devices> combinations
293 * Other relevant details...
295 This section is a comment. Do not overwrite or remove it.
296 Also, make sure to start the actual text at the margin.
297 =========================================================
299 * **Updated Mellanox mlx5 driver.**
301 Updated Mellanox mlx5 driver with new features and improvements, including:
303 * Added support for VLAN pop flow offload command.
304 * Added support for VLAN push flow offload command.
305 * Added support for VLAN set PCP offload command.
306 * Added support for VLAN set VID offload command.