doc/guides/rel_notes/release_21_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.02
   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_21_02.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 new ethdev API for PMD power management.**
  59
  60   Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
  61   ``rte_power_monitor()`` to enable automatic power management for PMDs.
  62
  63 * **Added Ethernet PMD power management helper API.**
  64
  65   A new helper API has been added to make using Ethernet PMD power management
  66   easier for the user: ``rte_power_ethdev_pmgmt_queue_enable()``. Three power
  67   management schemes are supported initially:
  68
  69   * Power saving based on UMWAIT instruction (x86 only)
  70   * Power saving based on ``rte_pause()`` (generic) or TPAUSE instruction (x86 only)
  71   * Power saving based on frequency scaling through the ``librte_power`` library
  72
  73 * **Added GENEVE TLV option in rte_flow.**
  74
  75   Added support for matching and raw encap/decap of GENEVE TLV option.
  76
  77 * **Added support of modify field action in the flow API.**
  78
  79   Added modify action support to perform various operations on
  80   any arbitrary header field (as well as mark, metadata or tag values):
  81   ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``.
  82   Supported operations are: overwriting a field with the content from
  83   another field, addition and subtraction using an immediate value.
  84
  85 * **Updated Broadcom bnxt driver.**
  86
  87   Updated the Broadcom bnxt driver with fixes and improvements, including:
  88
  89   * Added support for Stingray2 device.
  90
  91 * **Updated Cisco enic driver.**
  92
  93   * Added support for 64B completion queue entries
  94
  95 * **Updated Intel ice driver.**
  96
  97   Updated the Intel ice driver with new features and improvements, including:
  98
  99   * Added Double VLAN support for DCF switch QinQ filtering.
 100   * Added support for UDP dynamic port assignment for eCPRI tunnel in DCF.
 101
 102 * **Updated Intel iavf driver.**
 103
 104   Updated iavf PMD with new features and improvements, including:
 105
 106   * Added support for FDIR/RSS packet steering for eCPRI flow.
 107   * Added support for FDIR TCP/UDP pattern without input set.
 108
 109 * **Updated Mellanox mlx5 driver.**
 110
 111   Updated the Mellanox mlx5 driver with new features and improvements, including:
 112
 113   * Introduced basic support on Windows.
 114   * Added GTP PDU session container matching and raw encap/decap.
 115   * Added support for RSS action in the sample sub-actions list.
 116   * Added support for E-Switch mirroring and jump action in the same flow.
 117   * Added support to handle modify action in correct order regarding the
 118     mirroring action on E-Switch.
 119   * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or
 120     egress flow groups greater than 0 and for any transfer flow group.
 121   * Added support for the Tx mbuf fast free offload.
 122
 123 * **Updated Wangxun txgbe driver.**
 124
 125   Updated the Wangxun txgbe driver with new features and improvements, including:
 126
 127   * Add support for generic flow API.
 128   * Add support for traffic manager.
 129   * Add support for IPsec.
 130
 131 * **Updated GSO support.**
 132
 133   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 134
 135 * **Added enqueue & dequeue callback APIs for cryptodev library.**
 136
 137   Cryptodev library is added with enqueue & dequeue callback APIs to
 138   enable applications to add/remove user callbacks which gets called
 139   for every enqueue/dequeue operation.
 140
 141 * **Updated the OCTEON TX2 crypto PMD.**
 142
 143   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 144     ESN and anti-replay support.
 145   * Updated the OCTEON TX2 crypto PMD with CN98xx support.
 146   * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
 147     PMD lookaside protocol offload for IPsec.
 148   * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
 149     crypto PMD lookaside protocol offload for IPsec.
 150
 151 * **Added mlx5 compress PMD.**
 152
 153   Added a new compress PMD driver for Bluefield 2 adapters.
 154
 155   See the :doc:`../compressdevs/mlx5` for more details.
 156
 157 * **Added support for build-time checking of header includes.**
 158
 159   A new build option ``check_includes`` has been added, which, when enabled,
 160   will perform build-time checking on DPDK public header files, to ensure none
 161   are missing dependent header includes. This feature, disabled by default, is
 162   intended for use by developers contributing to the DPDK SDK itself, and is
 163   integrated into the build scripts and automated CI for patch contributions.
 164
 165
 166 Removed Items
 167 -------------
 168
 169 .. This section should contain removed items in this release. Sample format:
 170
 171    * Add a short 1-2 sentence description of the removed item
 172      in the past tense.
 173
 174    This section is a comment. Do not overwrite or remove it.
 175    Also, make sure to start the actual text at the margin.
 176    =======================================================
 177
 178 * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
 179   ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
 180   ``ninja install`` action and are renamed to ``ethdev_driver.h``,
 181   ``ethdev_vdev.h`` and ``ethdev_pci.h`` respectively in the source tree, to
 182   reflect the fact that they are non-public headers.
 183
 184 * The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h``
 185   and ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK
 186   ``ninja install`` action and are renamed to ``eventdev_pmd.h``,
 187   ``eventdev_pmd_vdev.h`` and ``eventdev_pmd_pci.h`` respectively in the source
 188   tree, to reflect the fact that they are non-public headers.
 189
 190 * Removed support for NetXtreme devices belonging to ``BCM573xx and
 191   BCM5740x`` families. Specifically the support for the following Broadcom
 192   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 193   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 194
 195 * The ``check-includes.sh`` script for checking DPDK header files has been
 196   removed, being replaced by the ``check_includes`` build option described
 197   above.
 198
 199
 200 API Changes
 201 -----------
 202
 203 .. This section should contain API changes. Sample format:
 204
 205    * sample: Add a short 1-2 sentence description of the API change
 206      which was announced in the previous releases and made in this release.
 207      Start with a scope label like "ethdev:".
 208      Use fixed width quotes for ``function_names`` or ``struct_names``.
 209      Use the past tense.
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =======================================================
 214
 215 * config: Removed the old macros, included in ``rte_config.h``,
 216   to indicate which DPDK libraries and drivers are built.
 217   The new macros are generated by meson in a standardized format:
 218   ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
 219   the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
 220   and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
 221
 222 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
 223   for adding enqueue and dequeue callbacks.
 224
 225
 226 ABI Changes
 227 -----------
 228
 229 .. This section should contain ABI changes. Sample format:
 230
 231    * sample: Add a short 1-2 sentence description of the ABI change
 232      which was announced in the previous releases and made in this release.
 233      Start with a scope label like "ethdev:".
 234      Use fixed width quotes for ``function_names`` or ``struct_names``.
 235      Use the past tense.
 236
 237    This section is a comment. Do not overwrite or remove it.
 238    Also, make sure to start the actual text at the margin.
 239    =======================================================
 240
 241 * No ABI change that would break compatibility with 20.11.
 242
 243
 244 Known Issues
 245 ------------
 246
 247 .. This section should contain new known issues in this release. Sample format:
 248
 249    * **Add title in present tense with full stop.**
 250
 251      Add a short 1-2 sentence description of the known issue
 252      in the present tense. Add information on any known workarounds.
 253
 254    This section is a comment. Do not overwrite or remove it.
 255    Also, make sure to start the actual text at the margin.
 256    =======================================================
 257
 258
 259 Tested Platforms
 260 ----------------
 261
 262 .. This section should contain a list of platforms that were tested
 263    with this release.
 264
 265    The format is:
 266
 267    * <vendor> platform with <vendor> <type of devices> combinations
 268
 269      * List of CPU
 270      * List of OS
 271      * List of devices
 272      * Other relevant details...
 273
 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    =======================================================