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_08.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 the EAL Pseudo-random Number Generator.**
59 The lrand48()-based rte_rand() function is replaced with a
60 DPDK-native combined Linear Feedback Shift Register (LFSR)
61 pseudo-random number generator (PRNG).
63 This new PRNG implementation is multi-thread safe, provides
64 higher-quality pseudo-random numbers (including full 64 bit
65 support) and improved performance.
67 In addition, <rte_random.h> is extended with a new function
68 rte_rand_max() which supplies unbiased, bounded pseudo-random
71 * **Updated the bnxt PMD.**
73 Updated the bnxt PMD. The major enhancements include:
75 * Performance optimizations in non-vector Tx path
76 * Added support for SSE vector mode
77 * Updated HWRM API to version 1.10.0.74
79 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
81 Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
82 of Ethernet controllers. These controllers support link speeds up to
83 200Gbps, 50G PAM-4, and PCIe 4.0.
85 * **Added hinic PMD.**
87 Added the new ``hinic`` net driver for Huawei Intelligent PCIE Network
88 Adapters based on the Huawei Ethernet Controller Hi1822.
89 See the :doc:`../nics/hinic` guide for more details on this new driver.
91 * **Updated the ice driver.**
93 Updated ice driver with new features and improvements, including:
95 * Enabled Tx outer/inner L3/L4 checksum offload.
96 * Enabled generic filter framework and supported switch filter.
97 * Supported UDP tunnel port add.
99 * **Updated Solarflare network PMD.**
101 Updated the Solarflare ``sfc_efx`` driver with changes including:
103 * Added support for Rx interrupts.
105 * **Added memif PMD.**
107 Added the new Shared Memory Packet Interface (``memif``) PMD.
108 See the :doc:`../nics/memif` guide for more details on this new driver.
110 * **Updated the AF_XDP PMD.**
112 Updated the AF_XDP PMD. The new features include:
114 * Enabled zero copy through mbuf's external memory mechanism to achieve
116 * Added multi-queue support to allow one af_xdp vdev with multiple netdev
118 * Enabled need_wakeup feature which can provide efficient support for case
119 that application and driver executing on the same core.
121 * **Updated telemetry library for global metrics support.**
123 Updated ``librte_telemetry`` to fetch the global metrics from the
124 ``librte_metrics`` library.
126 * **Added new telemetry mode for l3fwd-power application.**
128 Added telemetry mode to l3fwd-power application to report
129 application level busyness, empty and full polls of rte_eth_rx_burst().
135 .. This section should contain removed items in this release. Sample format:
137 * Add a short 1-2 sentence description of the removed item
140 This section is a comment. Do not overwrite or remove it.
141 Also, make sure to start the actual text at the margin.
142 =========================================================
144 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
146 * build: armv8 crypto extension is disabled.
152 .. This section should contain API changes. Sample format:
154 * sample: Add a short 1-2 sentence description of the API change
155 which was announced in the previous releases and made in this release.
156 Start with a scope label like "ethdev:".
157 Use fixed width quotes for ``function_names`` or ``struct_names``.
160 This section is a comment. Do not overwrite or remove it.
161 Also, make sure to start the actual text at the margin.
162 =========================================================
164 * The network structures, definitions and functions have
165 been prefixed by ``rte_`` to resolve conflicts with libc headers.
167 * malloc: The function ``rte_malloc_set_limit`` was never implemented
168 is deprecated and will be removed in a future release.
170 * eventdev: No longer marked as experimental.
172 The eventdev functions are no longer marked as experimental, and have
173 become part of the normal DPDK API and ABI. Any future ABI changes will be
174 announced at least one release before the ABI change is made. There are no
175 ABI breaking changes planned.
181 .. This section should contain ABI changes. Sample format:
183 * sample: Add a short 1-2 sentence description of the ABI change
184 which was announced in the previous releases and made in this release.
185 Start with a scope label like "ethdev:".
186 Use fixed width quotes for ``function_names`` or ``struct_names``.
189 This section is a comment. Do not overwrite or remove it.
190 Also, make sure to start the actual text at the margin.
191 =========================================================
193 * eventdev: Event based Rx adapter callback
195 The mbuf pointer array in the event eth Rx adapter callback
196 has been replaced with an event array. Using
197 an event array allows the application to change attributes
198 of the events enqueued by the SW adapter.
200 The callback can drop packets and populate
201 a callback argument with the number of dropped packets.
202 Add a Rx adapter stats field to keep track of the total
203 number of dropped packets.
206 Shared Library Versions
207 -----------------------
209 .. Update any library version updated in this release
210 and prepend with a ``+`` sign, like this:
216 This section is a comment. Do not overwrite or remove it.
217 =========================================================
219 The libraries prepended with a plus sign were incremented in this version.
225 librte_bitratestats.so.2
228 librte_bus_fslmc.so.2
229 librte_bus_ifpga.so.2
232 librte_bus_vmbus.so.2
235 librte_compressdev.so.1
236 librte_cryptodev.so.7
237 librte_distributor.so.1
241 + librte_eventdev.so.7
242 librte_flow_classify.so.1
251 librte_latencystats.so.1
265 librte_pmd_ixgbe.so.2
266 librte_pmd_dpaa2_qdma.so.1
268 librte_pmd_softnic.so.1
269 librte_pmd_vhost.so.2
287 .. This section should contain new known issues in this release. Sample format:
289 * **Add title in present tense with full stop.**
291 Add a short 1-2 sentence description of the known issue
292 in the present tense. Add information on any known workarounds.
294 This section is a comment. Do not overwrite or remove it.
295 Also, make sure to start the actual text at the margin.
296 =========================================================
302 .. This section should contain a list of platforms that were tested
307 * <vendor> platform with <vendor> <type of devices> combinations
312 * Other relevant details...
314 This section is a comment. Do not overwrite or remove it.
315 Also, make sure to start the actual text at the margin.
316 =========================================================