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 Marvell NITROX symmetric crypto PMD.**
61 Added a symmetric crypto PMD for Marvell NITROX V security processor.
62 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
64 * **Updated NXP crypto PMDs for PDCP support.**
66 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
67 Support is added for all sequence number sizes for control and user plane.
68 Test application is updated for unit testing.
70 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
72 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
73 QuickAssist Technology C4xxx). It is automatically chosen instead of the
74 classic 2-pass mode when running on QAT GEN3, significantly improving
75 the performance of AES GCM operations.
77 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
79 Added stateful decompression support in the Intel QuickAssist Technology PMD.
80 Please note that stateful compression is not supported.
86 .. This section should contain removed items in this release. Sample format:
88 * Add a short 1-2 sentence description of the removed item
91 This section is a comment. Do not overwrite or remove it.
92 Also, make sure to start the actual text at the margin.
93 =========================================================
95 * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
96 “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
97 hw-vlan-strip|hw-vlan-extend on|off”.
99 The testpmd commands set that can be used instead in order to enable or disable Rx
100 offloading on all Rx queues of a port is:
101 "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
102 timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
108 .. This section should contain API changes. Sample format:
110 * sample: Add a short 1-2 sentence description of the API change
111 which was announced in the previous releases and made in this release.
112 Start with a scope label like "ethdev:".
113 Use fixed width quotes for ``function_names`` or ``struct_names``.
116 This section is a comment. Do not overwrite or remove it.
117 Also, make sure to start the actual text at the margin.
118 =========================================================
124 .. This section should contain ABI changes. Sample format:
126 * sample: Add a short 1-2 sentence description of the ABI change
127 which was announced in the previous releases and made in this release.
128 Start with a scope label like "ethdev:".
129 Use fixed width quotes for ``function_names`` or ``struct_names``.
132 This section is a comment. Do not overwrite or remove it.
133 Also, make sure to start the actual text at the margin.
134 =========================================================
137 Shared Library Versions
138 -----------------------
140 .. Update any library version updated in this release
141 and prepend with a ``+`` sign, like this:
147 This section is a comment. Do not overwrite or remove it.
148 =========================================================
150 The libraries prepended with a plus sign were incremented in this version.
156 librte_bitratestats.so.2
159 librte_bus_fslmc.so.2
160 librte_bus_ifpga.so.2
163 librte_bus_vmbus.so.2
166 librte_compressdev.so.1
167 librte_cryptodev.so.8
168 librte_distributor.so.1
173 librte_flow_classify.so.1
182 librte_latencystats.so.1
196 librte_pmd_ixgbe.so.2
197 librte_pmd_dpaa2_qdma.so.1
199 librte_pmd_softnic.so.1
200 librte_pmd_vhost.so.2
218 .. This section should contain new known issues in this release. Sample format:
220 * **Add title in present tense with full stop.**
222 Add a short 1-2 sentence description of the known issue
223 in the present tense. Add information on any known workarounds.
225 This section is a comment. Do not overwrite or remove it.
226 Also, make sure to start the actual text at the margin.
227 =========================================================
233 .. This section should contain a list of platforms that were tested
238 * <vendor> platform with <vendor> <type of devices> combinations
243 * Other relevant details...
245 This section is a comment. Do not overwrite or remove it.
246 Also, make sure to start the actual text at the margin.
247 =========================================================
249 * **Updated Mellanox mlx5 driver.**
251 Updated Mellanox mlx5 driver with new features and improvements, including:
253 * Added support for VLAN pop flow offload command.
254 * Added support for VLAN push flow offload command.
255 * Added support for VLAN set PCP offload command.
256 * Added support for VLAN set VID offload command.