1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 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_20_08.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 non-EAL threads registration API.**
61 Added a new API to register non-EAL threads as lcores. This can be used by
62 applications to have its threads known of DPDK without suffering from the
63 non-EAL previous limitations in terms of performance.
65 * **rte_*mb APIs are updated to use DMB instruction for ARMv8.**
67 ARMv8 memory model has been strengthened to require other-multi-copy
68 atomicity. This allows for using DMB instruction instead of DSB for IO
69 barriers. rte_*mb APIs, for ARMv8 platforms, are changed to use DMB
70 instruction to reflect this.
72 * **Added the support for vfio-pci new VF token interface.**
74 From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
75 it uses a shared VF token (UUID) to represent the collaboration between PF
76 and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
77 by appending the VF token parameter.
79 * **Added the RegEx Library, a generic RegEx service library.**
81 Added the RegEx library which provides an API for offload of regular
82 expressions search operations to hardware or software accelerator devices.
84 * **Updated PCAP driver.**
86 Updated PCAP driver with new features and improvements, including:
88 * Support software Tx nanosecond timestamps precision.
90 * **Updated Broadcom bnxt driver.**
92 Updated the Broadcom bnxt driver with new features and improvements, including:
94 * Added support for VF representors.
95 * Added support for multiple devices.
96 * Added support for new resource manager API.
97 * Added support for VXLAN encap/decap.
98 * Added support for rte_flow_query for COUNT action.
99 * Added support for rx_burst_mode_get and tx_burst_mode_get.
101 * **Updated Mellanox mlx5 driver.**
103 Updated Mellanox mlx5 driver with new features and improvements, including:
105 * Added new PMD devarg ``reclaim_mem_mode``.
106 * Added new devarg ``lacp_by_user``.
108 * **Added vDPA device APIs to query virtio queue statistics.**
110 A new 3 APIs has been added to query virtio queue statistics, to get their
111 names and to reset them by a vDPA device.
113 * **Updated Mellanox mlx5 vDPA driver.**
115 Updated Mellanox mlx5 vDPA driver with new features, including:
117 * Added support for virtio queue statistics.
118 * Added support for MTU update.
120 * **Updated Marvell octeontx2 ethdev PMD.**
122 Updated Marvell octeontx2 driver with cn98xx support.
124 * **Updated the Intel ice driver.**
126 Updated the Intel ice driver with new features and improvements, including:
128 * Added support for DCF datapath configuration.
129 * Added support for more PPPoE packet type for switch filter.
131 * **Updated Intel i40e driver.**
133 Updated i40e PMD with new features and improvements, including:
135 * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
136 * Re-implemented get_fdir_info and get_fdir_stat in private API.
137 * Re-implemented set_gre_key_len in private API.
138 * Added support for flow query RSS.
140 * **Updated the Intel ixgbe driver.**
142 Updated the Intel ixgbe driver with new features and improvements, including:
144 * Re-implemented get_fdir_info and get_fdir_stat in private API.
146 * **Updated NXP dpaa ethdev PMD.**
148 Updated the NXP dpaa ethdev with new features and improvements, including:
150 * Added support for link status and interrupt
151 * Added support to use datapath APIs from non-EAL pthread
153 * **Updated NXP dpaa2 ethdev PMD.**
155 Updated the NXP dpaa2 ethdev with new features and improvements, including:
157 * Added support to use datapath APIs from non-EAL pthread
158 * Added support for dynamic flow management
160 * **Added DOCSIS protocol to rte_security.**
162 Added support for combined crypto and CRC operations for the DOCSIS protocol
163 to ``rte_security`` API.
165 * **Updated the AESNI MB crypto PMD.**
167 Added support for lookaside protocol offload for DOCSIS through the
168 ``rte_security`` API.
170 * **Updated the QuickAssist Technology (QAT) PMD.**
172 * Added support for lookaside protocol offload for DOCSIS through the
173 ``rte_security`` API.
174 * Added Chacha20-Poly1305 AEAD algorithm.
175 * Improved handling of multi process in QAT crypto and compression PMDs.
177 * **Updated the OCTEON TX2 crypto PMD.**
179 Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
181 * **Added support for BPF_ABS/BPF_IND load instructions.**
183 Added support for two BPF non-generic instructions:
184 ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
185 which are used to access packet data in a safe manner. Currently JIT support
186 for these instructions is implemented for x86 only.
188 * **Added flow performance test application.**
190 Added new application to test ``rte_flow`` performance, including:
192 * Measure ``rte_flow`` insertion rate.
193 * Measure ``rte_flow`` deletion rate.
194 * Dump ``rte_flow`` memory consumption.
195 * Measure packet per second forwarding.
197 * **Added --portmap command line parameter to l2fwd example.**
199 Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
200 pass forwarding port details.
201 See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
202 details of this parameter usage.
208 .. This section should contain removed items in this release. Sample format:
210 * Add a short 1-2 sentence description of the removed item
213 This section is a comment. Do not overwrite or remove it.
214 Also, make sure to start the actual text at the margin.
215 =========================================================
217 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
223 .. This section should contain API changes. Sample format:
225 * sample: Add a short 1-2 sentence description of the API change
226 which was announced in the previous releases and made in this release.
227 Start with a scope label like "ethdev:".
228 Use fixed width quotes for ``function_names`` or ``struct_names``.
231 This section is a comment. Do not overwrite or remove it.
232 Also, make sure to start the actual text at the margin.
233 =========================================================
235 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
237 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
238 queue and not per device, a qid parameter was added to the arguments list.
244 .. This section should contain ABI changes. Sample format:
246 * sample: Add a short 1-2 sentence description of the ABI change
247 which was announced in the previous releases and made in this release.
248 Start with a scope label like "ethdev:".
249 Use fixed width quotes for ``function_names`` or ``struct_names``.
252 This section is a comment. Do not overwrite or remove it.
253 Also, make sure to start the actual text at the margin.
254 =========================================================
256 * No ABI change that would break compatibility with 19.11.
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 =========================================================
277 .. This section should contain a list of platforms that were tested
282 * <vendor> platform with <vendor> <type of devices> combinations
287 * Other relevant details...
289 This section is a comment. Do not overwrite or remove it.
290 Also, make sure to start the actual text at the margin.
291 =========================================================