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 KNI module and PMD.**
59 Updated the KNI kernel module to set the max_mtu according to the given
60 initial MTU size. Without it, the maximum MTU was 1500.
62 Updated the KNI PMD driver to set the mbuf_size and MTU based on
63 the given mb-pool. This provide the ability to pass jumbo frames
64 if the mb-pool contains suitable buffers' size.
66 * **Updated Solarflare network PMD.**
68 Updated the sfc_efx driver including the following changes:
70 * Added support for Rx descriptor status and related API in a secondary
72 * Added support for Tx descriptor status API in a secondary process.
73 * Added support for RSS RETA and hash configuration get API in a secondary
75 * Added support for Rx packet types list in a secondary process.
77 * **Updated Mellanox drivers.**
79 New features and improvements were done in mlx4 and mlx5 PMDs:
81 * Added firmware version reading.
83 * **Renamed avf to iavf.**
85 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
86 which includes the directory name, lib name, filenames, makefile, docs,
87 macros, functions, structs and any other strings in the code.
89 * **Updated the enic driver.**
91 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
92 inner packet matching.
93 * Added limited support for RAW.
94 * Added limited support for RSS.
95 * Added limited support for PASSTHRU.
97 * **Updated the ixgbe driver.**
101 * Added promiscuous mode support.
103 * **Updated the ice driver.**
105 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
106 * Added package download support.
107 * Added Safe Mode support.
109 * **Updated the QuickAssist Technology PMD.**
111 Added support for AES-XTS with 128 and 256 bit AES keys.
113 * **Updated the IPsec library.**
115 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
116 support. The related ipsec-secgw test scripts have been added.
118 * **Updated the testpmd application.**
120 Improved testpmd application performance on ARM platform. For ``macswap``
121 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
127 .. This section should contain removed items in this release. Sample format:
129 * Add a short 1-2 sentence description of the removed item
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 =========================================================
140 .. This section should contain API changes. Sample format:
142 * sample: Add a short 1-2 sentence description of the API change
143 which was announced in the previous releases and made in this release.
144 Start with a scope label like "ethdev:".
145 Use fixed width quotes for ``function_names`` or ``struct_names``.
148 This section is a comment. Do not overwrite or remove it.
149 Also, make sure to start the actual text at the margin.
150 =========================================================
152 * eal: the type of the ``attr_value`` parameter of the function
153 ``rte_service_attr_get()`` has been changed
154 from ``uint32_t *`` to ``uint64_t *``.
156 * vfio: Functions ``rte_vfio_container_dma_map`` and
157 ``rte_vfio_container_dma_unmap`` have been extended with an option to
158 request mapping or un-mapping to the default vfio container fd.
164 .. This section should contain ABI changes. Sample format:
166 * sample: Add a short 1-2 sentence description of the ABI change
167 which was announced in the previous releases and made in this release.
168 Start with a scope label like "ethdev:".
169 Use fixed width quotes for ``function_names`` or ``struct_names``.
172 This section is a comment. Do not overwrite or remove it.
173 Also, make sure to start the actual text at the margin.
174 =========================================================
176 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
177 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
178 defined as cache-line aligned that caused unintended changes in
179 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
180 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
181 layout and alignment.
184 Shared Library Versions
185 -----------------------
187 .. Update any library version updated in this release
188 and prepend with a ``+`` sign, like this:
194 This section is a comment. Do not overwrite or remove it.
195 =========================================================
197 The libraries prepended with a plus sign were incremented in this version.
203 librte_bitratestats.so.2
206 librte_bus_fslmc.so.2
207 librte_bus_ifpga.so.2
210 librte_bus_vmbus.so.2
213 librte_compressdev.so.1
214 + librte_cryptodev.so.7
215 librte_distributor.so.1
220 librte_flow_classify.so.1
228 librte_latencystats.so.1
242 librte_pmd_ixgbe.so.2
243 librte_pmd_dpaa2_qdma.so.1
245 librte_pmd_softnic.so.1
246 librte_pmd_vhost.so.2
262 .. This section should contain new known issues in this release. Sample format:
264 * **Add title in present tense with full stop.**
266 Add a short 1-2 sentence description of the known issue
267 in the present tense. Add information on any known workarounds.
269 This section is a comment. Do not overwrite or remove it.
270 Also, make sure to start the actual text at the margin.
271 =========================================================
273 * **No software AES-XTS implementation.**
275 There are currently no cryptodev software PMDs available which implement
276 support for the AES-XTS algorithm, so this feature can only be used
277 if compatible hardware and an associated PMD is available.
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 =========================================================