doc/guides/rel_notes/release_20_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.11
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_20_11.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  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.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  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      =======================================================
  57
  58 * **Added write combining store APIs.**
  59
  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.
  64
  65 * **Added prefetch with intention to write APIs.**
  66
  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.
  70
  71 * **Added the rte_cldemote API.**
  72
  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
  78   architectures.
  79
  80 * **Added support for limiting maximum SIMD bitwidth.**
  81
  82   Added a new EAL config setting ``max_simd_bitwidth`` to limit the vector
  83   path selection at runtime. This value can be set by apps using the
  84   ``rte_vect_set_max_simd_bitwidth`` function, or by the user with EAL flag
  85   ``--force-max-simd-bitwidth``.
  86
  87 * **Added zero copy APIs for rte_ring.**
  88
  89   For rings with producer/consumer in ``RTE_RING_SYNC_ST``, ``RTE_RING_SYNC_MT_HTS``
  90   modes, these APIs split enqueue/dequeue operation into three phases
  91   (enqueue/dequeue start, copy data to/from ring, enqueue/dequeue finish).
  92   Along with the advantages of the peek APIs, these provide the ability to
  93   copy the data to the ring memory directly without the need for temporary
  94   storage.
  95
  96 * **Updated CRC modules of the net library.**
  97
  98   * Added runtime selection of the optimal architecture-specific CRC path.
  99   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
 100     using the AVX512 and VPCLMULQDQ instruction sets.
 101
 102 * **Introduced extended buffer description for receiving.**
 103
 104   Added the extended Rx buffer description for Rx queue setup routine
 105   providing the individual settings for each Rx segment with maximal size,
 106   buffer offset and memory pool to allocate data buffers from.
 107
 108 * **Added the FEC API, for a generic FEC query and config.**
 109
 110   Added the FEC API which provides functions for query FEC capabilities and
 111   current FEC mode from device. Also, API for configuring FEC mode is also provided.
 112
 113 * **Added thread safety to rte_flow functions.**
 114
 115   Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
 116   whether PMD supports thread safe operations. If PMD doesn't set the flag,
 117   rte_flow API level functions will protect the flow operations with mutex.
 118
 119 * **Added flow-based traffic sampling support.**
 120
 121   Added new action: ``RTE_FLOW_ACTION_TYPE_SAMPLE`` to duplicate the matching
 122   packets with specified ratio, and apply with own set of actions with a fate
 123   action. When the ratio is set to 1 then the packets will be 100% mirrored.
 124
 125 * **Added support of shared action in flow API.**
 126
 127   Added shared action support to utilize single flow action in multiple flow
 128   rules. An update of shared action configuration alters the behavior of all
 129   flow rules using it.
 130
 131   * Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
 132     as flow action.
 133   * Added new flow APIs to create/update/destroy/query shared action.
 134
 135 * **Flow rules allowed to use private PMD items / actions.**
 136
 137   * Flow rule verification was updated to accept private PMD
 138     items and actions.
 139
 140 * **Added generic API to offload tunneled traffic and restore missed packet.**
 141
 142   * Added a new hardware independent helper to flow API that
 143     offloads tunneled traffic and restores missed packets.
 144
 145 * **Updated the ethdev library to support hairpin between two ports.**
 146
 147   New APIs are introduced to support binding / unbinding 2 ports hairpin.
 148   Hairpin Tx part flow rules can be inserted explicitly.
 149   New API is added to get the hairpin peer ports list.
 150
 151 * **Updated Broadcom bnxt driver.**
 152
 153   Updated the Broadcom bnxt driver with new features and improvements, including:
 154
 155   * Added support for 200G PAM4 link speed.
 156   * Added support for RSS hash level selection.
 157   * Updated HWRM structures to 1.10.1.70 version.
 158   * Added TRUFLOW support for Stingray devices.
 159   * Added support for representors on MAIA cores of SR.
 160   * Added support for VXLAN decap offload using rte_flow.
 161
 162 * **Updated Cisco enic driver.**
 163
 164   * Added support for VF representors with single-queue Tx/Rx and flow API
 165   * Added support for egress PORT_ID action
 166   * Added support for non-zero priorities for group 0 flows
 167   * Added support for VXLAN decap combined with VLAN pop
 168
 169 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
 170
 171   Added the FEC PMD which provides functions for query FEC capabilities and
 172   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
 173
 174 * **Updated Intel iavf driver.**
 175
 176   * Added support of AVX512 instructions in Rx and Tx path.
 177
 178 * **Updated Intel ice driver.**
 179
 180   * Used write combining stores.
 181   * Added ACL filter support for Intel DCF.
 182
 183 * **Updated Mellanox mlx5 driver.**
 184
 185   Updated Mellanox mlx5 driver with new features and improvements, including:
 186
 187   * Added support for matching on fragmented/non-fragmented IPv4/IPv6 packets.
 188   * Updated the supported timeout for Age action to the maximal value supported
 189     by rte_flow API.
 190   * Added support of Age action query.
 191
 192 * **Updated Solarflare network PMD.**
 193
 194   Updated the Solarflare ``sfc_efx`` driver with changes including:
 195
 196   * Added SR-IOV PF support
 197   * Added Alveo SN1000 SmartNICs (EF100 architecture) support including
 198     flow API transfer rules for switch HW offload
 199
 200 * **Added Wangxun txgbe PMD.**
 201
 202   Added a new PMD driver for Wangxun 10 Gigabit Ethernet NICs.
 203
 204   See the :doc:`../nics/txgbe` for more details.
 205
 206 * **Updated Virtio driver.**
 207
 208   * Added support for Vhost-vDPA backend to Virtio-user PMD.
 209   * Changed default link speed to unknown.
 210   * Added support for 200G link speed.
 211
 212 * **Updated Intel i40e driver.**
 213
 214   Updated the Intel i40e driver to use write combining stores.
 215
 216 * **Updated Intel ixgbe driver.**
 217
 218   Updated the Intel ixgbe driver to use write combining stores.
 219
 220 * **Updated Intel qat driver.**
 221
 222   Updated the Intel qat driver to use write combining stores.
 223
 224 * **Updated Memif PMD.**
 225
 226   * Added support for abstract socket address.
 227   * Changed default socket address type to abstract.
 228
 229 * **Added Ice Lake (Gen4) support for Intel NTB.**
 230
 231   Added NTB device support (4th generation) for Intel Ice Lake platform.
 232
 233 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
 234
 235   For VxLAN packets, added inner UDP/IPv4 support.
 236   For non-VxLAN packets, added UDP/IPv4 support.
 237
 238 * **Extended flow-perf application.**
 239
 240   * Started supporting user order instead of bit mask:
 241     Now the user can create any structure of rte_flow
 242     using flow performance application with any order,
 243     moreover the app also now starts to support inner
 244     items matching as well.
 245   * Added header modify actions.
 246   * Added flag action.
 247   * Added raw encap/decap actions.
 248   * Added VXLAN encap/decap actions.
 249   * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
 250   * Added option to set port mask for insertion/deletion:
 251     ``--portmask=N``
 252     where N represents the hexadecimal bitmask of ports used.
 253
 254 * **Added raw data-path APIs for cryptodev library.**
 255
 256   Cryptodev is added with raw data-path APIs to accelerate external
 257   libraries or applications which need to avail fast cryptodev
 258   enqueue/dequeue operations but does not necessarily depends on
 259   mbufs and cryptodev operation mempools.
 260
 261 * **Updated the aesni_mb crypto PMD.**
 262
 263   * Added support for AES-ECB 128, 192 and 256.
 264   * Added support for ZUC-EEA3/EIA3 algorithms.
 265   * Added support for SNOW3G-UEA2/UIA2 algorithms.
 266   * Added support for KASUMI-F8/F9 algorithms.
 267   * Added support for Chacha20-Poly1305.
 268   * Added support for AES-256 CCM algorithm.
 269
 270 * **Updated the aesni_gcm crypto PMD.**
 271
 272   * Added SGL support for AES-GMAC.
 273
 274 * **Added Broadcom BCMFS symmetric crypto PMD.**
 275
 276   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
 277   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
 278
 279 * **Updated DPAA2_SEC crypto PMD.**
 280
 281   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
 282   * Added support for non-HMAC auth algorithms
 283     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
 284
 285 * **Updated Marvell NITROX symmetric crypto PMD.**
 286
 287   * Added AES-GCM support.
 288   * Added cipher only offload support.
 289
 290 * **Updated the OCTEON TX2 crypto PMD.**
 291
 292   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 293     IPv6 support.
 294
 295 * **Updated QAT crypto PMD.**
 296
 297   * Added Raw Data-path APIs support.
 298
 299 * **Added Intel ACC100 bbdev PMD.**
 300
 301   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
 302   also known as Mount Bryce.  See the
 303   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
 304
 305 * **Updated rte_security library to support SDAP.**
 306
 307   ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
 308   5G NR processing of SDAP header in PMDs.
 309
 310 * **Added Marvell OCTEON TX2 regex PMD.**
 311
 312   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
 313
 314   See the :doc:`../regexdevs/octeontx2` for more details.
 315
 316 * **Updated Software Eventdev driver.**
 317
 318   Added performance tuning arguments to allow tuning the scheduler for
 319   better throughtput in high core count use cases.
 320
 321 * **Added a new driver for the Intel Dynamic Load Balancer v1.0 device.**
 322
 323   Added the new ``dlb`` eventdev driver for the Intel DLB V1.0 device. See the
 324   :doc:`../eventdevs/dlb` eventdev guide for more details on this new driver.
 325
 326 * **Added a new driver for the Intel Dynamic Load Balancer v2.0 device.**
 327
 328   Added the new ``dlb2`` eventdev driver for the Intel DLB V2.0 device. See the
 329   :doc:`../eventdevs/dlb2` eventdev guide for more details on this new driver.
 330
 331 * **Updated ioat rawdev driver**
 332
 333   The ioat rawdev driver has been updated and enhanced. Changes include:
 334
 335   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
 336     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
 337   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
 338     where the hardware fills an area of memory with a repeating pattern.
 339   * Added a per-device configuration flag to disable management
 340     of user-provided completion handles.
 341   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
 342     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
 343     to better reflect the APIs' purposes, and remove the implication that
 344     they are limited to copy operations only.
 345     [Note: The old API is still provided but marked as deprecated in the code]
 346   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
 347     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
 348     and is clearer as there is no ambiguity as to whether the flag should be
 349     set on the last operation before the fence or the first operation after it.
 350
 351 * **Updated the pipeline library for alignment with the P4 language.**
 352
 353   Added new Software Switch (SWX) pipeline type that provides more
 354   flexibility through API and feature alignment with the P4 language.
 355
 356   * The packet headers, meta-data, actions, tables and pipelines are
 357     dynamically defined instead of selected from pre-defined set.
 358   * The actions and the pipeline are defined with instructions.
 359   * Extern objects and functions can be plugged into the pipeline.
 360   * Transaction-oriented table updates.
 361
 362 * **Add new AVX512 specific classify algorithms for ACL library.**
 363
 364   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
 365     which can process up to 16 flows in parallel. Requires AVX512 support.
 366
 367   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
 368     which can process up to 32 flows in parallel. Requires AVX512 support.
 369
 370 * **Added AVX512 lookup implementation for FIB.**
 371
 372   Added a AVX512 lookup functions implementation into FIB and FIB6 libraries.
 373
 374 * **Added support to update subport bandwidth dynamically.**
 375
 376    * Added new API ``rte_sched_port_subport_profile_add`` to add new
 377      subport bandwidth profile to subport porfile table at runtime.
 378
 379    * Added support to update subport rate dynamically.
 380
 381 * **Updated FIPS validation sample application.**
 382
 383   * Added scatter gather support.
 384   * Added NIST GCMVS complaint GMAC test method support.
 385
 386 * **Updated l3wfd-acl sample application.**
 387
 388   * Added new optional parameter ``--eth-dest`` for the ``l3fwd-acl`` to allow
 389     the user to specify the destination mac address for each ethernet port
 390     used.
 391   * Replaced ``--scalar`` command-line option with ``--alg=<value>``, to allow
 392     the user to select the desired classify method.
 393
 394 * **Updated vhost sample application.**
 395
 396   Added vhost asynchronous APIs support, which demonstrated how the application
 397   leverage IOAT DMA channel with vhost asynchronous APIs.
 398   See the :doc:`../sample_app_ug/vhost` for more details.
 399
 400
 401 Removed Items
 402 -------------
 403
 404 .. This section should contain removed items in this release. Sample format:
 405
 406    * Add a short 1-2 sentence description of the removed item
 407      in the past tense.
 408
 409    This section is a comment. Do not overwrite or remove it.
 410    Also, make sure to start the actual text at the margin.
 411    =======================================================
 412
 413 * build: Support for the Make build system was removed for compiling DPDK,
 414   Meson is now the primary build system.
 415   Sample applications can still be built with Make standalone, using pkg-config.
 416
 417 * vhost: Dequeue zero-copy support has been removed.
 418
 419 * kernel: The module ``igb_uio`` has been moved to the git repository
 420   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
 421
 422 * Removed Python 2 support since it was EOL'd in January 2020.
 423
 424 * Removed TEP termination sample application.
 425
 426
 427 API Changes
 428 -----------
 429
 430 .. This section should contain API changes. Sample format:
 431
 432    * sample: Add a short 1-2 sentence description of the API change
 433      which was announced in the previous releases and made in this release.
 434      Start with a scope label like "ethdev:".
 435      Use fixed width quotes for ``function_names`` or ``struct_names``.
 436      Use the past tense.
 437
 438    This section is a comment. Do not overwrite or remove it.
 439    Also, make sure to start the actual text at the margin.
 440    =======================================================
 441
 442 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
 443   The information provided by these macros is available through standard
 444   compiler macros.
 445
 446 * eal: Replaced the function ``rte_get_master_lcore()`` to
 447   ``rte_get_main_lcore()``. The old function is deprecated.
 448
 449   The iterator for worker lcores is also changed:
 450   ``RTE_LCORE_FOREACH_SLAVE`` is replaced with
 451   ``RTE_LCORE_FOREACH_WORKER``.
 452
 453 * eal: The ``rte_logs`` struct and global symbol was made private
 454   and is no longer part of the API.
 455
 456 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
 457   used it.
 458
 459 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
 460   and are removed in this release.
 461
 462 * mem: Removed the unioned field ``phys_addr`` from
 463   the structures ``rte_memseg`` and ``rte_memzone``.
 464   The field ``iova`` is remaining from the old unions.
 465
 466 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
 467   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
 468   The field ``iova`` is remaining from the old unions.
 469   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
 470   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
 471
 472 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
 473   and the macros ``rte_pktmbuf_mtophys*``.
 474   The same functionality is still available with the functions and macros
 475   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
 476
 477 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
 478   The field ``buf_iova`` is remaining from the old union.
 479
 480 * mbuf: Removed the unioned field ``refcnt_atomic`` from
 481   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
 482   The field ``refcnt`` is remaining from the old unions.
 483
 484 * mbuf: Removed the unioned fields ``userdata`` and ``udata64``
 485   from the structure ``rte_mbuf``. It is replaced with dynamic fields.
 486
 487 * mbuf: Removed the field ``seqn`` from the structure ``rte_mbuf``.
 488   It is replaced with dynamic fields.
 489
 490 * mbuf: Removed the field ``timestamp`` from the structure ``rte_mbuf``.
 491   It is replaced with the dynamic field RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
 492   which was previously used only for Tx.
 493
 494 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
 495   replaced with a private enum in the PCI subsystem.
 496
 497 * pci: Removed the PCI resources map API from the public API
 498   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
 499   PCI bus driver along with the PCI resources lists and associated structures
 500   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
 501   ``mapped_pci_res_list``).
 502
 503 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
 504   structure as it gave no useful abstracted information to the applications.
 505
 506 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
 507
 508 * ethdev: Renamed basic statistics per queue. An underscore is inserted
 509   between the queue number and the rest of the xstat name:
 510
 511   * ``rx_qN*`` -> ``rx_qN_*``
 512   * ``tx_qN*`` -> ``tx_qN_*``
 513
 514 * ethdev: Added capability to query age flow action.
 515
 516 * ethdev: Changed ``rte_eth_dev_stop`` return value from ``void`` to
 517   ``int`` to provide a way to report various error conditions.
 518
 519 * ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
 520
 521 * ethdev: Renamed internal functions:
 522
 523   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
 524   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
 525
 526 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
 527   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
 528   As the data of ``uint8_t`` will be truncated when queue number under
 529   a TC is greater than 256.
 530
 531 * vhost: Moved vDPA APIs from experimental to stable.
 532
 533 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
 534   instead of ``rte_vhost_driver_start`` by crypto applications.
 535
 536 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
 537   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
 538
 539 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
 540   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
 541   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
 542   are removed to avoid future ABI breakage while adding new algorithms.
 543
 544 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
 545   ``rte_cryptodev_scheduler_slave_detach`` and
 546   ``rte_cryptodev_scheduler_slaves_get`` to
 547   ``rte_cryptodev_scheduler_worker_attach``,
 548   ``rte_cryptodev_scheduler_worker_detach`` and
 549   ``rte_cryptodev_scheduler_workers_get`` accordingly.
 550
 551 * scheduler: Renamed the configuration value
 552   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
 553   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
 554
 555 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
 556   ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
 557   to support SDAP.
 558
 559 * security: The API ``rte_security_session_create`` is updated to take two
 560   mempool objects one for session and other for session private data.
 561   So the application need to create two mempools and get the size of session
 562   private data using API ``rte_security_session_get_size`` for private session
 563   mempool.
 564
 565 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
 566   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 567
 568 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
 569   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
 570   ``rte_fpga_lte_fec_conf``.
 571
 572 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
 573   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
 574   ``rte_fpga_5gnr_fec_conf``.
 575
 576 * rawdev: Added a structure size parameter to the functions
 577   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
 578   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
 579   allowing limited driver type-checking and ABI compatibility.
 580
 581 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
 582   and the function ``rte_rawdev_queue_conf_get()``
 583   from ``void`` to ``int`` allowing the return of error codes from drivers.
 584
 585 * rawdev: The running of a drivers ``selftest()`` function can now be done
 586   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
 587   command now calls the self-test function for each rawdev found on the
 588   system, and does not require a specific command per device type.
 589   Following this change, the ``ioat_rawdev_autotest`` command has been
 590   removed as no longer needed.
 591
 592 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
 593   ``rte_ioat_completed_copies()`` functions have been renamed to
 594   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
 595
 596 * stack: the experimental tag has been dropped from the stack library, and its
 597   interfaces are considered stable as of DPDK 20.11.
 598
 599 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
 600
 601 * gso: Changed ``rte_gso_segment`` behaviour and return value:
 602
 603   * ``pkt`` is not saved to ``pkts_out[0]`` if not GSOed.
 604   * Return 0 instead of 1 for the above case.
 605   * ``pkt`` is not freed, no matter whether it is GSOed, leaving to the caller.
 606
 607 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
 608   This enum value was not used inside DPDK, while it prevented to add new
 609   classify algorithms without causing an ABI breakage.
 610
 611 * sched: Added ``subport_profile_id`` as argument
 612   to function ``rte_sched_subport_config``.
 613
 614 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
 615   from ``struct rte_sched_subport_params``.
 616
 617
 618 ABI Changes
 619 -----------
 620
 621 .. This section should contain ABI changes. Sample format:
 622
 623    * sample: Add a short 1-2 sentence description of the ABI change
 624      which was announced in the previous releases and made in this release.
 625      Start with a scope label like "ethdev:".
 626      Use fixed width quotes for ``function_names`` or ``struct_names``.
 627      Use the past tense.
 628
 629    This section is a comment. Do not overwrite or remove it.
 630    Also, make sure to start the actual text at the margin.
 631    =======================================================
 632
 633 * eal: Removed the not implemented function ``rte_dump_registers()``.
 634
 635 * ``ethdev`` changes
 636
 637   * Following device operation function pointers moved
 638     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
 639
 640     * ``eth_rx_queue_count_t       rx_queue_count;``
 641     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
 642     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
 643     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
 644
 645   * ``struct eth_dev_ops`` is no more accessible by applications,
 646     which was already internal data structure.
 647
 648   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
 649
 650   * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
 651     A set of additional values added to struct, indicating the existence of
 652     every defined extension header type.
 653     Applications should use the new values for identification of existing
 654     extensions in the packet header.
 655
 656   * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
 657     to provide extended description of the receiving buffer.
 658
 659   * ``struct rte_eth_hairpin_conf`` has two new members:
 660
 661     * ``uint32_t tx_explicit:1;``
 662     * ``uint32_t manual_bind:1;``
 663
 664   * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
 665     indicating that packet header contains at least one VLAN.
 666
 667   * Added new field ``has_more_vlan`` to structure
 668     ``rte_flow_item_vlan``, indicating that packet header contains
 669     at least one more VLAN, after this VLAN.
 670
 671 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
 672   and future extensions:
 673
 674   * ``rte_event_dev_info``
 675   * ``rte_event_dev_config``
 676   * ``rte_event_port_conf``
 677
 678 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
 679
 680 * lpm: Removed fields other than ``tbl24`` and ``tbl8`` from the struct
 681   ``rte_lpm``. The removed fields were made internal.
 682
 683
 684 Known Issues
 685 ------------
 686
 687 .. This section should contain new known issues in this release. Sample format:
 688
 689    * **Add title in present tense with full stop.**
 690
 691      Add a short 1-2 sentence description of the known issue
 692      in the present tense. Add information on any known workarounds.
 693
 694    This section is a comment. Do not overwrite or remove it.
 695    Also, make sure to start the actual text at the margin.
 696    =======================================================
 697
 698
 699 Tested Platforms
 700 ----------------
 701
 702 .. This section should contain a list of platforms that were tested
 703    with this release.
 704
 705    The format is:
 706
 707    * <vendor> platform with <vendor> <type of devices> combinations
 708
 709      * List of CPU
 710      * List of OS
 711      * List of devices
 712      * Other relevant details...
 713
 714    This section is a comment. Do not overwrite or remove it.
 715    Also, make sure to start the actual text at the margin.
 716    =======================================================