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 Hisilicon hns3 driver.**
  96
  97   * Added support for traffic management
  98
  99 * **Updated Intel ice driver.**
 100
 101   Updated the Intel ice driver with new features and improvements, including:
 102
 103   * Added Double VLAN support for DCF switch QinQ filtering.
 104   * Added support for UDP dynamic port assignment for eCPRI tunnel in DCF.
 105
 106 * **Updated Intel iavf driver.**
 107
 108   Updated iavf PMD with new features and improvements, including:
 109
 110   * Added support for FDIR/RSS packet steering for eCPRI flow.
 111   * Added support for FDIR TCP/UDP pattern without input set.
 112
 113 * **Updated Mellanox mlx5 driver.**
 114
 115   Updated the Mellanox mlx5 driver with new features and improvements, including:
 116
 117   * Introduced basic support on Windows.
 118   * Added GTP PDU session container matching and raw encap/decap.
 119   * Added support for RSS action in the sample sub-actions list.
 120   * Added support for E-Switch mirroring and jump action in the same flow.
 121   * Added support to handle modify action in correct order regarding the
 122     mirroring action on E-Switch.
 123   * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or
 124     egress flow groups greater than 0 and for any transfer flow group.
 125   * Added support for the Tx mbuf fast free offload.
 126   * Added support for flow modify field action.
 127
 128 * **Updated the Pensando ionic driver.**
 129
 130   Updated the Pensando ionic driver with new features and improvements, including:
 131
 132   * Fixed bugs related to link autonegotiation.
 133   * Fixed bugs related to port start/stop and queue start/stop.
 134   * Added support for probing the supported queue versions. Note that
 135     extremely old (pre-1.0) firmware will no longer be usable with the PMD.
 136   * Removed unused code.
 137   * Reduced device startup time.
 138
 139 * **Updated Wangxun txgbe driver.**
 140
 141   Updated the Wangxun txgbe driver with new features and improvements, including:
 142
 143   * Add support for generic flow API.
 144   * Add support for traffic manager.
 145   * Add support for IPsec.
 146
 147 * **Updated GSO support.**
 148
 149   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 150
 151 * **Added enqueue & dequeue callback APIs for cryptodev library.**
 152
 153   Cryptodev library is added with enqueue & dequeue callback APIs to
 154   enable applications to add/remove user callbacks which gets called
 155   for every enqueue/dequeue operation.
 156
 157 * **Updated the OCTEON TX2 crypto PMD.**
 158
 159   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 160     ESN and anti-replay support.
 161   * Updated the OCTEON TX2 crypto PMD with CN98xx support.
 162   * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
 163     PMD lookaside protocol offload for IPsec.
 164   * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
 165     crypto PMD lookaside protocol offload for IPsec.
 166
 167 * **Added mlx5 compress PMD.**
 168
 169   Added a new compress PMD driver for Bluefield 2 adapters.
 170
 171   See the :doc:`../compressdevs/mlx5` for more details.
 172
 173 * **Added support for build-time checking of header includes.**
 174
 175   A new build option ``check_includes`` has been added, which, when enabled,
 176   will perform build-time checking on DPDK public header files, to ensure none
 177   are missing dependent header includes. This feature, disabled by default, is
 178   intended for use by developers contributing to the DPDK SDK itself, and is
 179   integrated into the build scripts and automated CI for patch contributions.
 180
 181
 182 Removed Items
 183 -------------
 184
 185 .. This section should contain removed items in this release. Sample format:
 186
 187    * Add a short 1-2 sentence description of the removed item
 188      in the past tense.
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =======================================================
 193
 194 * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
 195   ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
 196   ``ninja install`` action and are renamed to ``ethdev_driver.h``,
 197   ``ethdev_vdev.h`` and ``ethdev_pci.h`` respectively in the source tree, to
 198   reflect the fact that they are non-public headers.
 199
 200 * The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h``
 201   and ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK
 202   ``ninja install`` action and are renamed to ``eventdev_pmd.h``,
 203   ``eventdev_pmd_vdev.h`` and ``eventdev_pmd_pci.h`` respectively in the source
 204   tree, to reflect the fact that they are non-public headers.
 205
 206 * Removed support for NetXtreme devices belonging to ``BCM573xx and
 207   BCM5740x`` families. Specifically the support for the following Broadcom
 208   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 209   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 210
 211 * The ``check-includes.sh`` script for checking DPDK header files has been
 212   removed, being replaced by the ``check_includes`` build option described
 213   above.
 214
 215
 216 API Changes
 217 -----------
 218
 219 .. This section should contain API changes. Sample format:
 220
 221    * sample: Add a short 1-2 sentence description of the API change
 222      which was announced in the previous releases and made in this release.
 223      Start with a scope label like "ethdev:".
 224      Use fixed width quotes for ``function_names`` or ``struct_names``.
 225      Use the past tense.
 226
 227    This section is a comment. Do not overwrite or remove it.
 228    Also, make sure to start the actual text at the margin.
 229    =======================================================
 230
 231 * config: Removed the old macros, included in ``rte_config.h``,
 232   to indicate which DPDK libraries and drivers are built.
 233   The new macros are generated by meson in a standardized format:
 234   ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
 235   the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
 236   and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
 237
 238 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
 239   for adding enqueue and dequeue callbacks.
 240
 241
 242 ABI Changes
 243 -----------
 244
 245 .. This section should contain ABI changes. Sample format:
 246
 247    * sample: Add a short 1-2 sentence description of the ABI change
 248      which was announced in the previous releases and made in this release.
 249      Start with a scope label like "ethdev:".
 250      Use fixed width quotes for ``function_names`` or ``struct_names``.
 251      Use the past tense.
 252
 253    This section is a comment. Do not overwrite or remove it.
 254    Also, make sure to start the actual text at the margin.
 255    =======================================================
 256
 257 * No ABI change that would break compatibility with 20.11.
 258
 259
 260 Known Issues
 261 ------------
 262
 263 .. This section should contain new known issues in this release. Sample format:
 264
 265    * **Add title in present tense with full stop.**
 266
 267      Add a short 1-2 sentence description of the known issue
 268      in the present tense. Add information on any known workarounds.
 269
 270    This section is a comment. Do not overwrite or remove it.
 271    Also, make sure to start the actual text at the margin.
 272    =======================================================
 273
 274
 275 Tested Platforms
 276 ----------------
 277
 278 .. This section should contain a list of platforms that were tested
 279    with this release.
 280
 281    The format is:
 282
 283    * <vendor> platform with <vendor> <type of devices> combinations
 284
 285      * List of CPU
 286      * List of OS
 287      * List of devices
 288      * Other relevant details...
 289
 290    This section is a comment. Do not overwrite or remove it.
 291    Also, make sure to start the actual text at the margin.
 292    =======================================================