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 * **Updated the Intel ice driver.**
61 Updated the Intel ice driver with new features and improvements, including:
63 * Added support for device-specific DDP package loading.
65 * **Added Marvell NITROX symmetric crypto PMD.**
67 Added a symmetric crypto PMD for Marvell NITROX V security processor.
68 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
70 * **Updated NXP crypto PMDs for PDCP support.**
72 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
73 Support is added for all sequence number sizes for control and user plane.
74 Test application is updated for unit testing.
76 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
78 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
79 QuickAssist Technology C4xxx). It is automatically chosen instead of the
80 classic 2-pass mode when running on QAT GEN3, significantly improving
81 the performance of AES GCM operations.
83 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
85 Added stateful decompression support in the Intel QuickAssist Technology PMD.
86 Please note that stateful compression is not supported.
92 .. This section should contain removed items in this release. Sample format:
94 * Add a short 1-2 sentence description of the removed item
97 This section is a comment. Do not overwrite or remove it.
98 Also, make sure to start the actual text at the margin.
99 =========================================================
101 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
102 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
103 hw-vlan-strip|hw-vlan-extend on|off”.
105 The testpmd commands set that can be used instead in order to enable or disable Rx
106 offloading on all Rx queues of a port is:
107 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
108 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
114 .. This section should contain API changes. Sample format:
116 * sample: Add a short 1-2 sentence description of the API change
117 which was announced in the previous releases and made in this release.
118 Start with a scope label like "ethdev:".
119 Use fixed width quotes for ``function_names`` or ``struct_names``.
122 This section is a comment. Do not overwrite or remove it.
123 Also, make sure to start the actual text at the margin.
124 =========================================================
126 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
127 ``int`` to provide a way to report various error conditions.
129 * ethdev: changed ``rte_eth_promiscuous_enable`` and
130 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
131 provide a way to report various error conditions.
133 * ethdev: changed ``rte_eth_allmulticast_enable`` and
134 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
135 provide a way to report various error conditions.
137 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
138 ``int`` to provide a way to report various error conditions.
140 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
141 return value from ``void`` to ``int`` to provide a way to report various
144 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
145 ``int`` to provide a way to report various error conditions.
147 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
148 ``int`` to provide a way to report various error conditions.
154 .. This section should contain ABI changes. Sample format:
156 * sample: Add a short 1-2 sentence description of the ABI change
157 which was announced in the previous releases and made in this release.
158 Start with a scope label like "ethdev:".
159 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 =========================================================
167 Shared Library Versions
168 -----------------------
170 .. Update any library version updated in this release
171 and prepend with a ``+`` sign, like this:
177 This section is a comment. Do not overwrite or remove it.
178 =========================================================
180 The libraries prepended with a plus sign were incremented in this version.
186 librte_bitratestats.so.2
189 librte_bus_fslmc.so.2
190 librte_bus_ifpga.so.2
193 librte_bus_vmbus.so.2
196 librte_compressdev.so.1
197 librte_cryptodev.so.8
198 librte_distributor.so.1
201 + librte_ethdev.so.13
203 librte_flow_classify.so.1
212 librte_latencystats.so.1
226 librte_pmd_ixgbe.so.2
227 librte_pmd_dpaa2_qdma.so.1
229 librte_pmd_softnic.so.1
230 librte_pmd_vhost.so.2
248 .. This section should contain new known issues in this release. Sample format:
250 * **Add title in present tense with full stop.**
252 Add a short 1-2 sentence description of the known issue
253 in the present tense. Add information on any known workarounds.
255 This section is a comment. Do not overwrite or remove it.
256 Also, make sure to start the actual text at the margin.
257 =========================================================
263 .. This section should contain a list of platforms that were tested
268 * <vendor> platform with <vendor> <type of devices> combinations
273 * Other relevant details...
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 =========================================================
279 * **Updated Mellanox mlx5 driver.**
281 Updated Mellanox mlx5 driver with new features and improvements, including:
283 * Added support for VLAN pop flow offload command.
284 * Added support for VLAN push flow offload command.
285 * Added support for VLAN set PCP offload command.
286 * Added support for VLAN set VID offload command.