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 support for RTS and HTS modes into mempool ring driver.**
74 Added ability to select new ring synchronisation modes:
75 ``relaxed tail sync (ring_mt_rts)`` and ``head/tail sync (ring_mt_hts)``
78 * **Added the support for vfio-pci new VF token interface.**
80 From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
81 it uses a shared VF token (UUID) to represent the collaboration between PF
82 and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
83 by appending the VF token parameter.
85 * **Added the RegEx Library, a generic RegEx service library.**
87 Added the RegEx library which provides an API for offload of regular
88 expressions search operations to hardware or software accelerator devices.
90 Added Mellanox RegEx PMD, allowing to offload RegEx searches.
92 * **Added vhost async data path APIs.**
94 4 new APIs have been added to enable vhost async data path, including:
96 * Async device channel register/unregister APIs
97 * Async packets enqueue/completion APIs (only split ring was implemented)
99 * **Added eCPRI protocol support in rte_flow.**
101 The ``ECPRI`` item has been added to support eCPRI packet offloading for
104 * **Introduced send packet scheduling on the timestamps.**
106 Added the new mbuf dynamic field and flag to provide timestamp on what packet
107 transmitting can be synchronized. The device Tx offload flag is added to
108 indicate the PMD supports send scheduling.
110 * **Updated PCAP driver.**
112 Updated PCAP driver with new features and improvements, including:
114 * Support software Tx nanosecond timestamps precision.
116 * **Updated Broadcom bnxt driver.**
118 Updated the Broadcom bnxt driver with new features and improvements, including:
120 * Added support for VF representors.
121 * Added support for multiple devices.
122 * Added support for new resource manager API.
123 * Added support for VXLAN encap/decap.
124 * Added support for rte_flow_query for COUNT action.
125 * Added support for rx_burst_mode_get and tx_burst_mode_get.
126 * Added vector mode support for ARM CPUs.
127 * Added support for VLAN push and pop actions.
128 * Added support for NAT action items.
129 * Added TruFlow hash API for common hash uses across TruFlow core functions.
131 * **Updated Cisco enic driver.**
133 * Added support for VLAN push and pop flow actions.
135 * **Updated Hisilicon hns3 driver.**
137 * Added support for 200G speed rate.
138 * Added support for copper media type.
139 * Added support for keeping CRC.
140 * Added support for LRO.
141 * Added support for setting VF PVID by PF driver.
143 * **Updated Mellanox mlx5 net driver and common layer.**
145 Updated Mellanox mlx5 driver with new features and improvements, including:
147 * Added mlx5 PCI layer to share a PCI device among multiple PMDs.
148 * Added new PMD devarg ``reclaim_mem_mode``.
149 * Added new devarg ``lacp_by_user``.
150 * Added support for eCPRI protocol offloading.
152 * **Added vDPA device APIs to query virtio queue statistics.**
154 A new 3 APIs has been added to query virtio queue statistics, to get their
155 names and to reset them by a vDPA device.
157 * **Updated Mellanox mlx5 vDPA driver.**
159 Updated Mellanox mlx5 vDPA driver with new features, including:
161 * Added support for virtio queue statistics.
162 * Added support for MTU update.
164 * **Updated Marvell octeontx2 ethdev PMD.**
166 Updated Marvell octeontx2 driver with cn98xx support.
168 * **Updated the Intel ice driver.**
170 Updated the Intel ice driver with new features and improvements, including:
172 * Added support for DCF datapath configuration.
173 * Added support for more PPPoE packet type for switch filter.
175 * **Updated Intel i40e driver.**
177 Updated i40e PMD with new features and improvements, including:
179 * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
180 * Re-implemented get_fdir_info and get_fdir_stat in private API.
181 * Re-implemented set_gre_key_len in private API.
182 * Added support for flow query RSS.
184 * **Updated the Intel ixgbe driver.**
186 Updated the Intel ixgbe driver with new features and improvements, including:
188 * Re-implemented get_fdir_info and get_fdir_stat in private API.
190 * **Updated NXP dpaa ethdev PMD.**
192 Updated the NXP dpaa ethdev with new features and improvements, including:
194 * Added support for link status and interrupt
195 * Added support to use datapath APIs from non-EAL pthread
197 * **Updated NXP dpaa2 ethdev PMD.**
199 Updated the NXP dpaa2 ethdev with new features and improvements, including:
201 * Added support to use datapath APIs from non-EAL pthread
202 * Added support for dynamic flow management
204 * **Added DOCSIS protocol to rte_security.**
206 Added support for combined crypto and CRC operations for the DOCSIS protocol
207 to ``rte_security`` API.
209 * **Updated the AESNI MB crypto PMD.**
211 Added support for lookaside protocol offload for DOCSIS through the
212 ``rte_security`` API.
214 * **Updated the QuickAssist Technology (QAT) PMD.**
216 * Added support for lookaside protocol offload in QAT crypto PMD
217 for DOCSIS through the ``rte_security`` API.
218 * Added Chacha20-Poly1305 AEAD algorithm in QAT crypto PMD.
219 * Improved handling of multi process in QAT crypto and compression PMDs.
220 * Added support for Intel GEN2 QuickAssist device 200xx
221 (PF Did 0x18ee, VF Did 0x18ef).
223 * **Updated the OCTEON TX2 crypto PMD.**
225 * Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
227 * Updated the OCTEON TX2 crypto PMD to support ``rte_security`` lookaside
228 protocol offload for IPsec.
230 * **Added support for BPF_ABS/BPF_IND load instructions.**
232 Added support for two BPF non-generic instructions:
233 ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
234 which are used to access packet data in a safe manner. Currently JIT support
235 for these instructions is implemented for x86 only.
237 * **Added new testpmd forward mode.**
239 Added new ``5tswap`` forward mode to testpmd.
240 the ``5tswap`` swaps source and destination in layers 2,3,4
241 for ipv4 and ipv6 in L3 and UDP and TCP in L4.
243 * **Added flow performance test application.**
245 Added new application to test ``rte_flow`` performance, including:
247 * Measure ``rte_flow`` insertion rate.
248 * Measure ``rte_flow`` deletion rate.
249 * Dump ``rte_flow`` memory consumption.
250 * Measure packet per second forwarding.
252 * **Added --portmap command line parameter to l2fwd example.**
254 Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
255 pass forwarding port details.
256 See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
257 details of this parameter usage.
259 * **Updated ipsec-secgw sample application.**
261 Added ``rte_flow`` based rules, which allows hardware parsing and steering
262 of ingress packets to specific NIC queues.
263 See the :doc:`../sample_app_ug/ipsec_secgw` for more details.
269 .. This section should contain removed items in this release. Sample format:
271 * Add a short 1-2 sentence description of the removed item
274 This section is a comment. Do not overwrite or remove it.
275 Also, make sure to start the actual text at the margin.
276 =========================================================
278 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
284 .. This section should contain API changes. Sample format:
286 * sample: Add a short 1-2 sentence description of the API change
287 which was announced in the previous releases and made in this release.
288 Start with a scope label like "ethdev:".
289 Use fixed width quotes for ``function_names`` or ``struct_names``.
292 This section is a comment. Do not overwrite or remove it.
293 Also, make sure to start the actual text at the margin.
294 =========================================================
296 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
298 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
299 queue and not per device, a qid parameter was added to the arguments list.
305 .. This section should contain ABI changes. Sample format:
307 * sample: Add a short 1-2 sentence description of the ABI change
308 which was announced in the previous releases and made in this release.
309 Start with a scope label like "ethdev:".
310 Use fixed width quotes for ``function_names`` or ``struct_names``.
313 This section is a comment. Do not overwrite or remove it.
314 Also, make sure to start the actual text at the margin.
315 =========================================================
317 * No ABI change that would break compatibility with 19.11.
323 .. This section should contain new known issues in this release. Sample format:
325 * **Add title in present tense with full stop.**
327 Add a short 1-2 sentence description of the known issue
328 in the present tense. Add information on any known workarounds.
330 This section is a comment. Do not overwrite or remove it.
331 Also, make sure to start the actual text at the margin.
332 =========================================================
338 .. This section should contain a list of platforms that were tested
343 * <vendor> platform with <vendor> <type of devices> combinations
348 * Other relevant details...
350 This section is a comment. Do not overwrite or remove it.
351 Also, make sure to start the actual text at the margin.
352 =========================================================