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 * **Added prefetch with intention to write APIs.**
67 Added new prefetch function variants e.g. ``rte_prefetch0_write``,
68 which allow the programmer to prefetch a cache line and also indicate
69 the intention to write.
71 * **Updated CRC modules of the net library.**
73 * Added runtime selection of the optimal architecture-specific CRC path.
74 * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
75 using the AVX512 and VPCLMULQDQ instruction sets.
77 * **Added the FEC API, for a generic FEC query and config.**
79 Added the FEC API which provides functions for query FEC capabilities and
80 current FEC mode from device. Also, API for configuring FEC mode is also provided.
82 * **Updated Broadcom bnxt driver.**
84 Updated the Broadcom bnxt driver with new features and improvements, including:
86 * Added support for 200G PAM4 link speed.
87 * Added support for RSS hash level selection.
88 * Updated HWRM structures to 1.10.1.70 version.
90 * **Updated Cisco enic driver.**
92 * Added support for VF representors with single-queue Tx/Rx and flow API
93 * Added support for egress PORT_ID action
94 * Added support for non-zero priorities for group 0 flows
95 * Added support for VXLAN decap combined with VLAN pop
97 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
99 Added the FEC PMD which provides functions for query FEC capabilities and
100 current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
102 * **Updated Solarflare network PMD.**
104 Updated the Solarflare ``sfc_efx`` driver with changes including:
106 * Added SR-IOV PF support
108 * **Updated Virtio driver.**
110 * Added support for Vhost-vDPA backend to Virtio-user PMD.
111 * Changed default link speed to unknown.
112 * Added support for 200G link speed.
114 * **Updated Intel i40e driver.**
116 Updated the Intel i40e driver to use write combining stores.
118 * **Updated Intel ixgbe driver.**
120 Updated the Intel ixgbe driver to use write combining stores.
122 * **Updated Intel ice driver.**
124 Updated the Intel ice driver to use write combining stores.
126 * **Updated Intel qat driver.**
128 Updated the Intel qat driver to use write combining stores.
130 * **Added Ice Lake (Gen4) support for Intel NTB.**
132 Added NTB device support (4th generation) for Intel Ice Lake platform.
134 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
136 For VxLAN packets, added inner UDP/IPv4 support.
137 For non-VxLAN packets, added UDP/IPv4 support.
139 * **Extended flow-perf application.**
141 * Started supporting user order instead of bit mask:
142 Now the user can create any structure of rte_flow
143 using flow performance application with any order,
144 moreover the app also now starts to support inner
145 items matching as well.
146 * Added header modify actions.
148 * Added raw encap/decap actions.
149 * Added VXLAN encap/decap actions.
150 * Added ICMP and ICMP6 matching items.
151 * Added option to set port mask for insertion/deletion:
153 where N represents the hexadecimal bitmask of ports used.
155 * **Added support for AES-ECB in aesni_mb crypto PMD.**
157 * Added support for AES-ECB 128, 192 and 256 in aesni_mb PMD.
159 * **Updated Marvell NITROX symmetric crypto PMD.**
161 * Added AES-GCM support.
162 * Added cipher only offload support.
164 * **Updated the OCTEON TX2 crypto PMD.**
166 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
169 * **Added Intel ACC100 bbdev PMD.**
171 Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
172 also known as Mount Bryce. See the
173 :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
175 * **Added Marvell OCTEON TX2 regex PMD.**
177 Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
179 See the :doc:`../regexdevs/octeontx2` for more details.
181 * **Updated ioat rawdev driver**
183 The ioat rawdev driver has been updated and enhanced. Changes include:
185 * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
186 For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
187 * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
188 where the hardware fills an area of memory with a repeating pattern.
189 * Added a per-device configuration flag to disable management
190 of user-provided completion handles.
191 * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
192 and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
193 to better reflect the APIs' purposes, and remove the implication that
194 they are limited to copy operations only.
195 [Note: The old API is still provided but marked as deprecated in the code]
196 * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
197 This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
198 and is clearer as there is no ambiguity as to whether the flag should be
199 set on the last operation before the fence or the first operation after it.
201 * **Updated the pipeline library for alignment with the P4 language.**
203 Added new Software Switch (SWX) pipeline type that provides more
204 flexibility through API and feature alignment with the P4 language.
206 * The packet headers, meta-data, actions, tables and pipelines are
207 dynamically defined instead of selected from pre-defined set.
208 * The actions and the pipeline are defined with instructions.
209 * Extern objects and functions can be plugged into the pipeline.
210 * Transaction-oriented table updates.
212 * **Add new AVX512 specific classify algorithms for ACL library.**
214 * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
215 which can process up to 16 flows in parallel. Requires AVX512 support.
217 * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
218 which can process up to 32 flows in parallel. Requires AVX512 support.
220 * **Added support to update subport bandwidth dynamically.**
222 * Added new API ``rte_sched_port_subport_profile_add`` to add new
223 subport bandwidth profile to subport porfile table at runtime.
225 * Added support to update subport rate dynamically.
231 .. This section should contain removed items in this release. Sample format:
233 * Add a short 1-2 sentence description of the removed item
236 This section is a comment. Do not overwrite or remove it.
237 Also, make sure to start the actual text at the margin.
238 =======================================================
240 * vhost: Dequeue zero-copy support has been removed.
242 * kernel: The module ``igb_uio`` has been moved to the git repository
243 ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
245 * Removed Python 2 support since it was EOL'd in January 2020.
250 .. This section should contain API changes. Sample format:
252 * sample: Add a short 1-2 sentence description of the API change
253 which was announced in the previous releases and made in this release.
254 Start with a scope label like "ethdev:".
255 Use fixed width quotes for ``function_names`` or ``struct_names``.
258 This section is a comment. Do not overwrite or remove it.
259 Also, make sure to start the actual text at the margin.
260 =======================================================
262 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
263 The information provided by these macros is available through standard
266 * eal: The ``rte_logs`` struct and global symbol was made private
267 and is no longer part of the API.
269 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
272 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
273 and are removed in this release.
275 * mem: Removed the unioned field ``phys_addr`` from
276 the structures ``rte_memseg`` and ``rte_memzone``.
277 The field ``iova`` is remaining from the old unions.
279 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
280 the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
281 The field ``iova`` is remaining from the old unions.
282 The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
283 while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
285 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
286 and the macros ``rte_pktmbuf_mtophys*``.
287 The same functionality is still available with the functions and macros
288 having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
290 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
291 The field ``buf_iova`` is remaining from the old union.
293 * mbuf: Removed the unioned field ``refcnt_atomic`` from
294 the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
295 The field ``refcnt`` is remaining from the old unions.
297 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
298 replaced with a private enum in the PCI subsystem.
300 * pci: Removed the PCI resources map API from the public API
301 (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
302 PCI bus driver along with the PCI resources lists and associated structures
303 (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
304 ``mapped_pci_res_list``).
306 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
307 structure as it gave no useful abstracted information to the applications.
309 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
311 * Renamed internal ethdev APIs:
313 * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
314 * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
316 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
317 ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
318 As the data of ``uint8_t`` will be truncated when queue number under
319 a TC is greater than 256.
321 * vhost: Moved vDPA APIs from experimental to stable.
323 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
324 ``rte_cryptodev_scheduler_slave_detach`` and
325 ``rte_cryptodev_scheduler_slaves_get`` to
326 ``rte_cryptodev_scheduler_worker_attach``,
327 ``rte_cryptodev_scheduler_worker_detach`` and
328 ``rte_cryptodev_scheduler_workers_get`` accordingly.
330 * scheduler: Renamed the configuration value
331 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
332 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
334 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
335 subsequently moved ``rte_ipsec`` lib from experimental to stable.
337 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
338 ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
339 ``rte_fpga_lte_fec_conf``.
341 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
342 ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
343 ``rte_fpga_5gnr_fec_conf``.
345 * rawdev: Added a structure size parameter to the functions
346 ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
347 ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
348 allowing limited driver type-checking and ABI compatibility.
350 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
351 and the function ``rte_rawdev_queue_conf_get()``
352 from ``void`` to ``int`` allowing the return of error codes from drivers.
354 * rawdev: The running of a drivers ``selftest()`` function can now be done
355 using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
356 command now calls the self-test function for each rawdev found on the
357 system, and does not require a specific command per device type.
358 Following this change, the ``ioat_rawdev_autotest`` command has been
359 removed as no longer needed.
361 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
362 ``rte_ioat_completed_copies()`` functions have been renamed to
363 ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
365 * stack: the experimental tag has been dropped from the stack library, and its
366 interfaces are considered stable as of DPDK 20.11.
368 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
370 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
371 This enum value was not used inside DPDK, while it prevented to add new
372 classify algorithms without causing an ABI breakage.
374 * sched: Added ``subport_profile_id`` as argument
375 to function ``rte_sched_subport_config``.
377 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
378 from ``struct rte_sched_subport_params``.
384 .. This section should contain ABI changes. Sample format:
386 * sample: Add a short 1-2 sentence description of the ABI change
387 which was announced in the previous releases and made in this release.
388 Start with a scope label like "ethdev:".
389 Use fixed width quotes for ``function_names`` or ``struct_names``.
392 This section is a comment. Do not overwrite or remove it.
393 Also, make sure to start the actual text at the margin.
394 =======================================================
396 * eal: Removed the not implemented function ``rte_dump_registers()``.
400 * Following device operation function pointers moved
401 from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
403 * ``eth_rx_queue_count_t rx_queue_count;``
404 * ``eth_rx_descriptor_done_t rx_descriptor_done;``
405 * ``eth_rx_descriptor_status_t rx_descriptor_status;``
406 * ``eth_tx_descriptor_status_t tx_descriptor_status;``
408 * ``struct eth_dev_ops`` is no more accessible by applications,
409 which was already internal data structure.
411 * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
413 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
419 .. This section should contain new known issues in this release. Sample format:
421 * **Add title in present tense with full stop.**
423 Add a short 1-2 sentence description of the known issue
424 in the present tense. Add information on any known workarounds.
426 This section is a comment. Do not overwrite or remove it.
427 Also, make sure to start the actual text at the margin.
428 =======================================================
434 .. This section should contain a list of platforms that were tested
439 * <vendor> platform with <vendor> <type of devices> combinations
444 * Other relevant details...
446 This section is a comment. Do not overwrite or remove it.
447 Also, make sure to start the actual text at the margin.
448 =======================================================