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 * **Added the rte_cldemote API.**
73 Added a hardware hint CLDEMOTE, which is similar to prefetch in reverse.
74 CLDEMOTE moves the cache line to the more remote cache, where it expects
75 sharing to be efficient. Moving the cache line to a level more distant from
76 the processor helps to accelerate core-to-core communication.
77 This API is specific to x86 and implemented as a stub for other
80 * **Updated CRC modules of the net library.**
82 * Added runtime selection of the optimal architecture-specific CRC path.
83 * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
84 using the AVX512 and VPCLMULQDQ instruction sets.
86 * **Added the FEC API, for a generic FEC query and config.**
88 Added the FEC API which provides functions for query FEC capabilities and
89 current FEC mode from device. Also, API for configuring FEC mode is also provided.
91 * **Added thread safety to rte_flow functions.**
93 Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
94 whether PMD supports thread safe operations. If PMD doesn't set the flag,
95 rte_flow API level functions will protect the flow operations with mutex.
97 * **Updated Broadcom bnxt driver.**
99 Updated the Broadcom bnxt driver with new features and improvements, including:
101 * Added support for 200G PAM4 link speed.
102 * Added support for RSS hash level selection.
103 * Updated HWRM structures to 1.10.1.70 version.
105 * **Updated Cisco enic driver.**
107 * Added support for VF representors with single-queue Tx/Rx and flow API
108 * Added support for egress PORT_ID action
109 * Added support for non-zero priorities for group 0 flows
110 * Added support for VXLAN decap combined with VLAN pop
112 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
114 Added the FEC PMD which provides functions for query FEC capabilities and
115 current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
117 * **Updated Solarflare network PMD.**
119 Updated the Solarflare ``sfc_efx`` driver with changes including:
121 * Added SR-IOV PF support
123 * **Updated Virtio driver.**
125 * Added support for Vhost-vDPA backend to Virtio-user PMD.
126 * Changed default link speed to unknown.
127 * Added support for 200G link speed.
129 * **Updated Intel i40e driver.**
131 Updated the Intel i40e driver to use write combining stores.
133 * **Updated Intel ixgbe driver.**
135 Updated the Intel ixgbe driver to use write combining stores.
137 * **Updated Intel ice driver.**
139 Updated the Intel ice driver to use write combining stores.
141 * **Updated Intel qat driver.**
143 Updated the Intel qat driver to use write combining stores.
145 * **Added Ice Lake (Gen4) support for Intel NTB.**
147 Added NTB device support (4th generation) for Intel Ice Lake platform.
149 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
151 For VxLAN packets, added inner UDP/IPv4 support.
152 For non-VxLAN packets, added UDP/IPv4 support.
154 * **Extended flow-perf application.**
156 * Started supporting user order instead of bit mask:
157 Now the user can create any structure of rte_flow
158 using flow performance application with any order,
159 moreover the app also now starts to support inner
160 items matching as well.
161 * Added header modify actions.
163 * Added raw encap/decap actions.
164 * Added VXLAN encap/decap actions.
165 * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
166 * Added option to set port mask for insertion/deletion:
168 where N represents the hexadecimal bitmask of ports used.
170 * **Added raw data-path APIs for cryptodev library.**
172 Cryptodev is added with raw data-path APIs to accelerate external
173 libraries or applications which need to avail fast cryptodev
174 enqueue/dequeue operations but does not necessarily depends on
175 mbufs and cryptodev operation mempools.
177 * **Updated the aesni_mb crypto PMD.**
179 * Added support for AES-ECB 128, 192 and 256.
180 * Added support for ZUC-EEA3/EIA3 algorithms.
181 * Added support for SNOW3G-UEA2/UIA2 algorithms.
182 * Added support for KASUMI-F8/F9 algorithms.
183 * Added support for Chacha20-Poly1305.
184 * Added support for AES-256 CCM algorithm.
186 * **Updated the aesni_gcm crypto PMD.**
188 * Added SGL support for AES-GMAC.
190 * **Added Broadcom BCMFS symmetric crypto PMD.**
192 Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
193 See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
195 * **Updated DPAA2_SEC crypto PMD.**
197 * Added DES-CBC support for cipher_only, chain and ipsec protocol.
198 * Added support for non-HMAC auth algorithms
199 (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
201 * **Updated Marvell NITROX symmetric crypto PMD.**
203 * Added AES-GCM support.
204 * Added cipher only offload support.
206 * **Updated the OCTEON TX2 crypto PMD.**
208 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
211 * **Updated QAT crypto PMD.**
213 * Added Raw Data-path APIs support.
215 * **Added Intel ACC100 bbdev PMD.**
217 Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
218 also known as Mount Bryce. See the
219 :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
221 * **Updated rte_security library to support SDAP.**
223 ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
224 5G NR processing of SDAP header in PMDs.
226 * **Added Marvell OCTEON TX2 regex PMD.**
228 Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
230 See the :doc:`../regexdevs/octeontx2` for more details.
232 * **Updated Software Eventdev driver.**
234 Added performance tuning arguments to allow tuning the scheduler for
235 better throughtput in high core count use cases.
237 * **Updated ioat rawdev driver**
239 The ioat rawdev driver has been updated and enhanced. Changes include:
241 * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
242 For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
243 * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
244 where the hardware fills an area of memory with a repeating pattern.
245 * Added a per-device configuration flag to disable management
246 of user-provided completion handles.
247 * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
248 and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
249 to better reflect the APIs' purposes, and remove the implication that
250 they are limited to copy operations only.
251 [Note: The old API is still provided but marked as deprecated in the code]
252 * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
253 This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
254 and is clearer as there is no ambiguity as to whether the flag should be
255 set on the last operation before the fence or the first operation after it.
257 * **Updated the pipeline library for alignment with the P4 language.**
259 Added new Software Switch (SWX) pipeline type that provides more
260 flexibility through API and feature alignment with the P4 language.
262 * The packet headers, meta-data, actions, tables and pipelines are
263 dynamically defined instead of selected from pre-defined set.
264 * The actions and the pipeline are defined with instructions.
265 * Extern objects and functions can be plugged into the pipeline.
266 * Transaction-oriented table updates.
268 * **Add new AVX512 specific classify algorithms for ACL library.**
270 * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
271 which can process up to 16 flows in parallel. Requires AVX512 support.
273 * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
274 which can process up to 32 flows in parallel. Requires AVX512 support.
276 * **Added support to update subport bandwidth dynamically.**
278 * Added new API ``rte_sched_port_subport_profile_add`` to add new
279 subport bandwidth profile to subport porfile table at runtime.
281 * Added support to update subport rate dynamically.
283 * **Updated FIPS validation sample application.**
285 * Added scatter gather support.
286 * Added NIST GCMVS complaint GMAC test method support.
292 .. This section should contain removed items in this release. Sample format:
294 * Add a short 1-2 sentence description of the removed item
297 This section is a comment. Do not overwrite or remove it.
298 Also, make sure to start the actual text at the margin.
299 =======================================================
301 * vhost: Dequeue zero-copy support has been removed.
303 * kernel: The module ``igb_uio`` has been moved to the git repository
304 ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
306 * Removed Python 2 support since it was EOL'd in January 2020.
311 .. This section should contain API changes. Sample format:
313 * sample: Add a short 1-2 sentence description of the API change
314 which was announced in the previous releases and made in this release.
315 Start with a scope label like "ethdev:".
316 Use fixed width quotes for ``function_names`` or ``struct_names``.
319 This section is a comment. Do not overwrite or remove it.
320 Also, make sure to start the actual text at the margin.
321 =======================================================
323 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
324 The information provided by these macros is available through standard
327 * eal: The ``rte_logs`` struct and global symbol was made private
328 and is no longer part of the API.
330 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
333 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
334 and are removed in this release.
336 * mem: Removed the unioned field ``phys_addr`` from
337 the structures ``rte_memseg`` and ``rte_memzone``.
338 The field ``iova`` is remaining from the old unions.
340 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
341 the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
342 The field ``iova`` is remaining from the old unions.
343 The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
344 while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
346 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
347 and the macros ``rte_pktmbuf_mtophys*``.
348 The same functionality is still available with the functions and macros
349 having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
351 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
352 The field ``buf_iova`` is remaining from the old union.
354 * mbuf: Removed the unioned field ``refcnt_atomic`` from
355 the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
356 The field ``refcnt`` is remaining from the old unions.
358 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
359 replaced with a private enum in the PCI subsystem.
361 * pci: Removed the PCI resources map API from the public API
362 (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
363 PCI bus driver along with the PCI resources lists and associated structures
364 (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
365 ``mapped_pci_res_list``).
367 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
368 structure as it gave no useful abstracted information to the applications.
370 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
372 * ethdev: Renamed basic statistics per queue. An underscore is inserted
373 between the queue number and the rest of the xstat name:
375 * ``rx_qN*`` -> ``rx_qN_*``
376 * ``tx_qN*`` -> ``tx_qN_*``
378 * ethdev: Renamed internal functions:
380 * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
381 * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
383 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
384 ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
385 As the data of ``uint8_t`` will be truncated when queue number under
386 a TC is greater than 256.
388 * vhost: Moved vDPA APIs from experimental to stable.
390 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
391 instead of ``rte_vhost_driver_start`` by crypto applications.
393 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
394 cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
396 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
397 ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
398 ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
399 are removed to avoid future ABI breakage while adding new algorithms.
401 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
402 ``rte_cryptodev_scheduler_slave_detach`` and
403 ``rte_cryptodev_scheduler_slaves_get`` to
404 ``rte_cryptodev_scheduler_worker_attach``,
405 ``rte_cryptodev_scheduler_worker_detach`` and
406 ``rte_cryptodev_scheduler_workers_get`` accordingly.
408 * scheduler: Renamed the configuration value
409 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
410 ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
412 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
413 ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
416 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
417 subsequently moved ``rte_ipsec`` lib from experimental to stable.
419 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
420 ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
421 ``rte_fpga_lte_fec_conf``.
423 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
424 ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
425 ``rte_fpga_5gnr_fec_conf``.
427 * rawdev: Added a structure size parameter to the functions
428 ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
429 ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
430 allowing limited driver type-checking and ABI compatibility.
432 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
433 and the function ``rte_rawdev_queue_conf_get()``
434 from ``void`` to ``int`` allowing the return of error codes from drivers.
436 * rawdev: The running of a drivers ``selftest()`` function can now be done
437 using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
438 command now calls the self-test function for each rawdev found on the
439 system, and does not require a specific command per device type.
440 Following this change, the ``ioat_rawdev_autotest`` command has been
441 removed as no longer needed.
443 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
444 ``rte_ioat_completed_copies()`` functions have been renamed to
445 ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
447 * stack: the experimental tag has been dropped from the stack library, and its
448 interfaces are considered stable as of DPDK 20.11.
450 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
452 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
453 This enum value was not used inside DPDK, while it prevented to add new
454 classify algorithms without causing an ABI breakage.
456 * sched: Added ``subport_profile_id`` as argument
457 to function ``rte_sched_subport_config``.
459 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
460 from ``struct rte_sched_subport_params``.
466 .. This section should contain ABI changes. Sample format:
468 * sample: Add a short 1-2 sentence description of the ABI change
469 which was announced in the previous releases and made in this release.
470 Start with a scope label like "ethdev:".
471 Use fixed width quotes for ``function_names`` or ``struct_names``.
474 This section is a comment. Do not overwrite or remove it.
475 Also, make sure to start the actual text at the margin.
476 =======================================================
478 * eal: Removed the not implemented function ``rte_dump_registers()``.
482 * Following device operation function pointers moved
483 from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
485 * ``eth_rx_queue_count_t rx_queue_count;``
486 * ``eth_rx_descriptor_done_t rx_descriptor_done;``
487 * ``eth_rx_descriptor_status_t rx_descriptor_status;``
488 * ``eth_tx_descriptor_status_t tx_descriptor_status;``
490 * ``struct eth_dev_ops`` is no more accessible by applications,
491 which was already internal data structure.
493 * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
495 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
496 and future extensions:
498 * ``rte_event_dev_info``
499 * ``rte_event_dev_config``
500 * ``rte_event_port_conf``
502 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
508 .. This section should contain new known issues in this release. Sample format:
510 * **Add title in present tense with full stop.**
512 Add a short 1-2 sentence description of the known issue
513 in the present tense. Add information on any known workarounds.
515 This section is a comment. Do not overwrite or remove it.
516 Also, make sure to start the actual text at the margin.
517 =======================================================
523 .. This section should contain a list of platforms that were tested
528 * <vendor> platform with <vendor> <type of devices> combinations
533 * Other relevant details...
535 This section is a comment. Do not overwrite or remove it.
536 Also, make sure to start the actual text at the margin.
537 =======================================================