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 ixgbe driver.**
71 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
73 * **Updated the Intel i40e driver.**
75 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
77 * **Updated the Intel fm10k driver.**
79 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
81 * **Updated the Intel ice driver.**
83 Updated the Intel ice driver with new features and improvements, including:
85 * Added support for device-specific DDP package loading.
86 * Added support for handling Receive Flex Descriptor.
87 * Added support for protocol extraction on per Rx queue.
88 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
90 * **Added Marvell NITROX symmetric crypto PMD.**
92 Added a symmetric crypto PMD for Marvell NITROX V security processor.
93 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
95 * **Updated NXP crypto PMDs for PDCP support.**
97 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
98 Support is added for all sequence number sizes for control and user plane.
99 Test application is updated for unit testing.
101 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
103 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
104 QuickAssist Technology C4xxx). It is automatically chosen instead of the
105 classic 2-pass mode when running on QAT GEN3, significantly improving
106 the performance of AES GCM operations.
108 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
110 Added stateful decompression support in the Intel QuickAssist Technology PMD.
111 Please note that stateful compression is not supported.
113 * **Added eBPF JIT support for arm64.**
115 Added eBPF JIT support for arm64 architecture to improve the eBPF program
122 .. This section should contain removed items in this release. Sample format:
124 * Add a short 1-2 sentence description of the removed item
127 This section is a comment. Do not overwrite or remove it.
128 Also, make sure to start the actual text at the margin.
129 =========================================================
131 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
132 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
133 hw-vlan-strip|hw-vlan-extend on|off”.
135 The testpmd commands set that can be used instead in order to enable or disable Rx
136 offloading on all Rx queues of a port is:
137 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
138 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
144 .. This section should contain API changes. Sample format:
146 * sample: Add a short 1-2 sentence description of the API change
147 which was announced in the previous releases and made in this release.
148 Start with a scope label like "ethdev:".
149 Use fixed width quotes for ``function_names`` or ``struct_names``.
152 This section is a comment. Do not overwrite or remove it.
153 Also, make sure to start the actual text at the margin.
154 =========================================================
156 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
157 ``int`` to provide a way to report various error conditions.
159 * ethdev: changed ``rte_eth_promiscuous_enable`` and
160 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
161 provide a way to report various error conditions.
163 * ethdev: changed ``rte_eth_allmulticast_enable`` and
164 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
165 provide a way to report various error conditions.
167 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
168 ``int`` to provide a way to report various error conditions.
170 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
171 return value from ``void`` to ``int`` to provide a way to report various
174 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
175 ``int`` to provide a way to report various error conditions.
177 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
178 ``int`` to provide a way to report various error conditions.
184 .. This section should contain ABI changes. Sample format:
186 * sample: Add a short 1-2 sentence description of the ABI change
187 which was announced in the previous releases and made in this release.
188 Start with a scope label like "ethdev:".
189 Use fixed width quotes for ``function_names`` or ``struct_names``.
192 This section is a comment. Do not overwrite or remove it.
193 Also, make sure to start the actual text at the margin.
194 =========================================================
197 Shared Library Versions
198 -----------------------
200 .. Update any library version updated in this release
201 and prepend with a ``+`` sign, like this:
207 This section is a comment. Do not overwrite or remove it.
208 =========================================================
210 The libraries prepended with a plus sign were incremented in this version.
216 librte_bitratestats.so.2
219 librte_bus_fslmc.so.2
220 librte_bus_ifpga.so.2
223 librte_bus_vmbus.so.2
226 librte_compressdev.so.1
227 librte_cryptodev.so.8
228 librte_distributor.so.1
231 + librte_ethdev.so.13
233 librte_flow_classify.so.1
242 librte_latencystats.so.1
256 librte_pmd_ixgbe.so.2
257 librte_pmd_dpaa2_qdma.so.1
259 librte_pmd_softnic.so.1
260 librte_pmd_vhost.so.2
278 .. This section should contain new known issues in this release. Sample format:
280 * **Add title in present tense with full stop.**
282 Add a short 1-2 sentence description of the known issue
283 in the present tense. Add information on any known workarounds.
285 This section is a comment. Do not overwrite or remove it.
286 Also, make sure to start the actual text at the margin.
287 =========================================================
293 .. This section should contain a list of platforms that were tested
298 * <vendor> platform with <vendor> <type of devices> combinations
303 * Other relevant details...
305 This section is a comment. Do not overwrite or remove it.
306 Also, make sure to start the actual text at the margin.
307 =========================================================
309 * **Updated Mellanox mlx5 driver.**
311 Updated Mellanox mlx5 driver with new features and improvements, including:
313 * Added support for VLAN pop flow offload command.
314 * Added support for VLAN push flow offload command.
315 * Added support for VLAN set PCP offload command.
316 * Added support for VLAN set VID offload command.