1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_19_05.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
31 Add a short 1-2 sentence description in the past tense.
32 The description should be enough to allow someone scanning
33 the release notes to understand the new feature.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significant)
53 This section is a comment. Do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
57 * **Updated Solarflare network PMD.**
59 Updated the sfc_efx driver including the following changes:
61 * Added support for Rx descriptor status and related API in a secondary
63 * Added support for Tx descriptor status API in a secondary process.
64 * Added support for RSS RETA and hash configuration get API in a secondary
66 * Added support for Rx packet types list in a secondary process.
68 * **Updated Mellanox drivers.**
70 New features and improvements were done in mlx4 and mlx5 PMDs:
72 * Added firmware version reading.
74 * **Renamed avf to iavf.**
76 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
77 which includes the directory name, lib name, filenames, makefile, docs,
78 macros, functions, structs and any other strings in the code.
80 * **Updated the enic driver.**
82 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
83 inner packet matching.
84 * Added limited support for RAW.
85 * Added limited support for RSS.
86 * Added limited support for PASSTHRU.
88 * **Updated the ixgbe driver.**
92 * Added promiscuous mode support.
94 * **Updated the QuickAssist Technology PMD.**
96 Added support for AES-XTS with 128 and 256 bit AES keys.
98 * **Updated the IPsec library.**
100 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
101 support. The related ipsec-secgw test scripts have been added.
103 * **Updated the testpmd application.**
105 Improved testpmd application performance on ARM platform. For ``macswap``
106 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
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 =========================================================
125 .. This section should contain API changes. Sample format:
127 * sample: Add a short 1-2 sentence description of the API change
128 which was announced in the previous releases and made in this release.
129 Start with a scope label like "ethdev:".
130 Use fixed width quotes for ``function_names`` or ``struct_names``.
133 This section is a comment. Do not overwrite or remove it.
134 Also, make sure to start the actual text at the margin.
135 =========================================================
137 * eal: the type of the ``attr_value`` parameter of the function
138 ``rte_service_attr_get()`` has been changed
139 from ``uint32_t *`` to ``uint64_t *``.
145 .. This section should contain ABI changes. Sample format:
147 * sample: Add a short 1-2 sentence description of the ABI change
148 which was announced in the previous releases and made in this release.
149 Start with a scope label like "ethdev:".
150 Use fixed width quotes for ``function_names`` or ``struct_names``.
153 This section is a comment. Do not overwrite or remove it.
154 Also, make sure to start the actual text at the margin.
155 =========================================================
157 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
158 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
159 defined as cache-line aligned that caused unintended changes in
160 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
161 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
162 layout and alignment.
165 Shared Library Versions
166 -----------------------
168 .. Update any library version updated in this release
169 and prepend with a ``+`` sign, like this:
175 This section is a comment. Do not overwrite or remove it.
176 =========================================================
178 The libraries prepended with a plus sign were incremented in this version.
184 librte_bitratestats.so.2
187 librte_bus_fslmc.so.2
188 librte_bus_ifpga.so.2
191 librte_bus_vmbus.so.2
194 librte_compressdev.so.1
195 + librte_cryptodev.so.7
196 librte_distributor.so.1
201 librte_flow_classify.so.1
209 librte_latencystats.so.1
223 librte_pmd_ixgbe.so.2
224 librte_pmd_dpaa2_qdma.so.1
226 librte_pmd_softnic.so.1
227 librte_pmd_vhost.so.2
243 .. This section should contain new known issues in this release. Sample format:
245 * **Add title in present tense with full stop.**
247 Add a short 1-2 sentence description of the known issue
248 in the present tense. Add information on any known workarounds.
250 This section is a comment. Do not overwrite or remove it.
251 Also, make sure to start the actual text at the margin.
252 =========================================================
254 * **No software AES-XTS implementation.**
256 There are currently no cryptodev software PMDs available which implement
257 support for the AES-XTS algorithm, so this feature can only be used
258 if compatible hardware and an associated PMD is available.
264 .. This section should contain a list of platforms that were tested
269 * <vendor> platform with <vendor> <type of devices> combinations
274 * Other relevant details...
276 This section is a comment. Do not overwrite or remove it.
277 Also, make sure to start the actual text at the margin.
278 =========================================================