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::
21 xdg-open build/doc/html/guides/rel_notes/release_20_11.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Added write combining store APIs.**
60 Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs
61 that enable write combining stores (depending on architecture).
62 The functions are provided as a generic stubs and
63 x86 specific implementation.
65 * **Updated CRC modules of the net library.**
67 * Added runtime selection of the optimal architecture-specific CRC path.
68 * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
69 using the AVX512 and VPCLMULQDQ instruction sets.
71 * **Added the FEC API, for a generic FEC query and config.**
73 Added the FEC API which provides functions for query FEC capabilities and
74 current FEC mode from device. Also, API for configuring FEC mode is also provided.
76 * **Updated Broadcom bnxt driver.**
78 Updated the Broadcom bnxt driver with new features and improvements, including:
80 * Added support for 200G PAM4 link speed.
81 * Added support for RSS hash level selection.
82 * Updated HWRM structures to 1.10.1.70 version.
84 * **Updated Cisco enic driver.**
86 * Added support for VF representors with single-queue Tx/Rx and flow API
87 * Added support for egress PORT_ID action
88 * Added support for non-zero priorities for group 0 flows
89 * Added support for VXLAN decap combined with VLAN pop
91 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
93 Added the FEC PMD which provides functions for query FEC capabilities and
94 current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
96 * **Updated Solarflare network PMD.**
98 Updated the Solarflare ``sfc_efx`` driver with changes including:
100 * Added SR-IOV PF support
102 * **Updated Virtio driver.**
104 * Added support for Vhost-vDPA backend to Virtio-user PMD.
105 * Changed default link speed to unknown.
106 * Added support for 200G link speed.
108 * **Updated Intel i40e driver.**
110 Updated the Intel i40e driver to use write combining stores.
112 * **Updated Intel ixgbe driver.**
114 Updated the Intel ixgbe driver to use write combining stores.
116 * **Updated Intel ice driver.**
118 Updated the Intel ice driver to use write combining stores.
120 * **Updated Intel qat driver.**
122 Updated the Intel qat driver to use write combining stores.
124 * **Added Ice Lake (Gen4) support for Intel NTB.**
126 Added NTB device support (4th generation) for Intel Ice Lake platform.
128 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
130 For VxLAN packets, added inner UDP/IPv4 support.
131 For non-VxLAN packets, added UDP/IPv4 support.
133 * **Extended flow-perf application.**
135 * Started supporting user order instead of bit mask:
136 Now the user can create any structure of rte_flow
137 using flow performance application with any order,
138 moreover the app also now starts to support inner
139 items matching as well.
140 * Added header modify actions.
142 * Added raw encap/decap actions.
143 * Added VXLAN encap/decap actions.
144 * Added ICMP and ICMP6 matching items.
145 * Added option to set port mask for insertion/deletion:
147 where N represents the hexadecimal bitmask of ports used.
149 * **Added Marvell OCTEON TX2 regex PMD.**
151 Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
153 See the :doc:`../regexdevs/octeontx2` for more details.
155 * **Updated ioat rawdev driver**
157 The ioat rawdev driver has been updated and enhanced. Changes include:
159 * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
160 For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
161 * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
162 where the hardware fills an area of memory with a repeating pattern.
163 * Added a per-device configuration flag to disable management
164 of user-provided completion handles.
165 * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
166 and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
167 to better reflect the APIs' purposes, and remove the implication that
168 they are limited to copy operations only.
169 [Note: The old API is still provided but marked as deprecated in the code]
170 * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
171 This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
172 and is clearer as there is no ambiguity as to whether the flag should be
173 set on the last operation before the fence or the first operation after it.
175 * **Updated the pipeline library for alignment with the P4 language.**
177 Added new Software Switch (SWX) pipeline type that provides more
178 flexibility through API and feature alignment with the P4 language.
180 * The packet headers, meta-data, actions, tables and pipelines are
181 dynamically defined instead of selected from pre-defined set.
182 * The actions and the pipeline are defined with instructions.
183 * Extern objects and functions can be plugged into the pipeline.
184 * Transaction-oriented table updates.
186 * **Add new AVX512 specific classify algorithms for ACL library.**
188 * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
189 which can process up to 16 flows in parallel. Requires AVX512 support.
191 * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
192 which can process up to 32 flows in parallel. Requires AVX512 support.
198 .. This section should contain removed items in this release. Sample format:
200 * Add a short 1-2 sentence description of the removed item
203 This section is a comment. Do not overwrite or remove it.
204 Also, make sure to start the actual text at the margin.
205 =======================================================
207 * vhost: Dequeue zero-copy support has been removed.
209 * kernel: The module ``igb_uio`` has been moved to the git repository
210 ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
212 * Removed Python 2 support since it was EOL'd in January 2020.
217 .. This section should contain API changes. Sample format:
219 * sample: Add a short 1-2 sentence description of the API change
220 which was announced in the previous releases and made in this release.
221 Start with a scope label like "ethdev:".
222 Use fixed width quotes for ``function_names`` or ``struct_names``.
225 This section is a comment. Do not overwrite or remove it.
226 Also, make sure to start the actual text at the margin.
227 =======================================================
229 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
230 The information provided by these macros is available through standard
233 * eal: The ``rte_logs`` struct and global symbol was made private
234 and is no longer part of the API.
236 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
239 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
240 and are removed in this release.
242 * mem: Removed the unioned field ``phys_addr`` from
243 the structures ``rte_memseg`` and ``rte_memzone``.
244 The field ``iova`` is remaining from the old unions.
246 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
247 the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
248 The field ``iova`` is remaining from the old unions.
249 The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
250 while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
252 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
253 and the macros ``rte_pktmbuf_mtophys*``.
254 The same functionality is still available with the functions and macros
255 having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
257 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
258 The field ``buf_iova`` is remaining from the old union.
260 * mbuf: Removed the unioned field ``refcnt_atomic`` from
261 the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
262 The field ``refcnt`` is remaining from the old unions.
264 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
265 replaced with a private enum in the PCI subsystem.
267 * pci: Removed the PCI resources map API from the public API
268 (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
269 PCI bus driver along with the PCI resources lists and associated structures
270 (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
271 ``mapped_pci_res_list``).
273 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
274 structure as it gave no useful abstracted information to the applications.
276 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
278 * Renamed internal ethdev APIs:
280 * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
281 * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
283 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
284 ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
285 As the data of ``uint8_t`` will be truncated when queue number under
286 a TC is greater than 256.
288 * vhost: Moved vDPA APIs from experimental to stable.
290 * rawdev: Added a structure size parameter to the functions
291 ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
292 ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
293 allowing limited driver type-checking and ABI compatibility.
295 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
296 and the function ``rte_rawdev_queue_conf_get()``
297 from ``void`` to ``int`` allowing the return of error codes from drivers.
299 * rawdev: The running of a drivers ``selftest()`` function can now be done
300 using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
301 command now calls the self-test function for each rawdev found on the
302 system, and does not require a specific command per device type.
303 Following this change, the ``ioat_rawdev_autotest`` command has been
304 removed as no longer needed.
306 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
307 ``rte_ioat_completed_copies()`` functions have been renamed to
308 ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
310 * stack: the experimental tag has been dropped from the stack library, and its
311 interfaces are considered stable as of DPDK 20.11.
313 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
315 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
316 This enum value was not used inside DPDK, while it prevented to add new
317 classify algorithms without causing an ABI breakage.
323 .. This section should contain ABI changes. Sample format:
325 * sample: Add a short 1-2 sentence description of the ABI change
326 which was announced in the previous releases and made in this release.
327 Start with a scope label like "ethdev:".
328 Use fixed width quotes for ``function_names`` or ``struct_names``.
331 This section is a comment. Do not overwrite or remove it.
332 Also, make sure to start the actual text at the margin.
333 =======================================================
337 * Following device operation function pointers moved
338 from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
340 * ``eth_rx_queue_count_t rx_queue_count;``
341 * ``eth_rx_descriptor_done_t rx_descriptor_done;``
342 * ``eth_rx_descriptor_status_t rx_descriptor_status;``
343 * ``eth_tx_descriptor_status_t tx_descriptor_status;``
345 * ``struct eth_dev_ops`` is no more accessible by applications,
346 which was already internal data structure.
348 * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
350 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
356 .. This section should contain new known issues in this release. Sample format:
358 * **Add title in present tense with full stop.**
360 Add a short 1-2 sentence description of the known issue
361 in the present tense. Add information on any known workarounds.
363 This section is a comment. Do not overwrite or remove it.
364 Also, make sure to start the actual text at the margin.
365 =======================================================
371 .. This section should contain a list of platforms that were tested
376 * <vendor> platform with <vendor> <type of devices> combinations
381 * Other relevant details...
383 This section is a comment. Do not overwrite or remove it.
384 Also, make sure to start the actual text at the margin.
385 =======================================================