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 * **Added Stack API.**
59 Added a new stack API for configuration and use of a bounded stack of
60 pointers. The API provides MT-safe push and pop operations that can operate
61 on one or more pointers per operation.
63 The library supports two stack implementations: standard (lock-based) and lock-free.
64 The lock-free implementation is currently limited to x86-64 platforms.
66 * **Added Lock-Free Stack Mempool Handler.**
68 Added a new lock-free stack handler, which uses the newly added stack
71 * **Updated KNI module and PMD.**
73 Updated the KNI kernel module to set the max_mtu according to the given
74 initial MTU size. Without it, the maximum MTU was 1500.
76 Updated the KNI PMD driver to set the mbuf_size and MTU based on
77 the given mb-pool. This provide the ability to pass jumbo frames
78 if the mb-pool contains suitable buffers' size.
80 * **Updated Solarflare network PMD.**
82 Updated the sfc_efx driver including the following changes:
84 * Added support for Rx descriptor status and related API in a secondary
86 * Added support for Tx descriptor status API in a secondary process.
87 * Added support for RSS RETA and hash configuration get API in a secondary
89 * Added support for Rx packet types list in a secondary process.
90 * Added Tx prepare to do Tx offloads checks.
91 * Added support for VXLAN and GENEVE encapsulated TSO.
93 * **Updated Mellanox drivers.**
95 New features and improvements were done in mlx4 and mlx5 PMDs:
97 * Added firmware version reading.
99 * **Renamed avf to iavf.**
101 Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
102 which includes the directory name, lib name, filenames, makefile, docs,
103 macros, functions, structs and any other strings in the code.
105 * **Updated the enic driver.**
107 * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
108 inner packet matching.
109 * Added limited support for RAW.
110 * Added limited support for RSS.
111 * Added limited support for PASSTHRU.
113 * **Updated the ixgbe driver.**
117 * Added promiscuous mode support.
119 * **Updated the ice driver.**
121 * Added support of SSE and AVX2 instructions in Rx and Tx paths.
122 * Added package download support.
123 * Added Safe Mode support.
124 * Supported RSS for UPD/TCP/SCTP+IPV4/IPV6 packets.
126 * **Updated the QuickAssist Technology PMD.**
128 Added support for AES-XTS with 128 and 256 bit AES keys.
130 * **Updated AESNI-MB PMD.**
132 Added support for out-of-place operations.
134 * **Updated the IPsec library.**
136 The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
137 support. The related ipsec-secgw test scripts have been added.
139 * **Updated the testpmd application.**
141 Improved testpmd application performance on ARM platform. For ``macswap``
142 forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
148 .. This section should contain removed items in this release. Sample format:
150 * Add a short 1-2 sentence description of the removed item
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 =========================================================
161 .. This section should contain API changes. Sample format:
163 * sample: Add a short 1-2 sentence description of the API change
164 which was announced in the previous releases and made in this release.
165 Start with a scope label like "ethdev:".
166 Use fixed width quotes for ``function_names`` or ``struct_names``.
169 This section is a comment. Do not overwrite or remove it.
170 Also, make sure to start the actual text at the margin.
171 =========================================================
173 * eal: the type of the ``attr_value`` parameter of the function
174 ``rte_service_attr_get()`` has been changed
175 from ``uint32_t *`` to ``uint64_t *``.
177 * vfio: Functions ``rte_vfio_container_dma_map`` and
178 ``rte_vfio_container_dma_unmap`` have been extended with an option to
179 request mapping or un-mapping to the default vfio container fd.
185 .. This section should contain ABI changes. Sample format:
187 * sample: Add a short 1-2 sentence description of the ABI change
188 which was announced in the previous releases and made in this release.
189 Start with a scope label like "ethdev:".
190 Use fixed width quotes for ``function_names`` or ``struct_names``.
193 This section is a comment. Do not overwrite or remove it.
194 Also, make sure to start the actual text at the margin.
195 =========================================================
197 * ethdev: Additional fields in rte_eth_dev_info.
199 The ``rte_eth_dev_info`` structure has had two extra fields
200 added: ``min_mtu`` and ``max_mtu``. Each of these are of type ``uint16_t``.
201 The values of these fields can be set specifically by the PMD drivers as
202 supported values can vary from device to device.
204 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
205 included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
206 defined as cache-line aligned that caused unintended changes in
207 ``rte_crypto_op`` structure layout and alignment. Remove cache-line
208 alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
209 layout and alignment.
212 Shared Library Versions
213 -----------------------
215 .. Update any library version updated in this release
216 and prepend with a ``+`` sign, like this:
222 This section is a comment. Do not overwrite or remove it.
223 =========================================================
225 The libraries prepended with a plus sign were incremented in this version.
231 librte_bitratestats.so.2
234 librte_bus_fslmc.so.2
235 librte_bus_ifpga.so.2
238 librte_bus_vmbus.so.2
241 librte_compressdev.so.1
242 + librte_cryptodev.so.7
243 librte_distributor.so.1
246 + librte_ethdev.so.12
248 librte_flow_classify.so.1
257 librte_latencystats.so.1
271 librte_pmd_ixgbe.so.2
272 librte_pmd_dpaa2_qdma.so.1
274 librte_pmd_softnic.so.1
275 librte_pmd_vhost.so.2
292 .. This section should contain new known issues in this release. Sample format:
294 * **Add title in present tense with full stop.**
296 Add a short 1-2 sentence description of the known issue
297 in the present tense. Add information on any known workarounds.
299 This section is a comment. Do not overwrite or remove it.
300 Also, make sure to start the actual text at the margin.
301 =========================================================
303 * **No software AES-XTS implementation.**
305 There are currently no cryptodev software PMDs available which implement
306 support for the AES-XTS algorithm, so this feature can only be used
307 if compatible hardware and an associated PMD is available.
313 .. This section should contain a list of platforms that were tested
318 * <vendor> platform with <vendor> <type of devices> combinations
323 * Other relevant details...
325 This section is a comment. Do not overwrite or remove it.
326 Also, make sure to start the actual text at the margin.
327 =========================================================