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
 118 * **Updated Wangxun txgbe driver.**
 119
 120   Updated the Wangxun txgbe driver with new features and improvements, including:
 121
 122   * Add support for generic flow API.
 123   * Add support for traffic manager.
 124   * Add support for IPsec.
 125
 126 * **Updated GSO support.**
 127
 128   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 129
 130 * **Added enqueue & dequeue callback APIs for cryptodev library.**
 131
 132   Cryptodev library is added with enqueue & dequeue callback APIs to
 133   enable applications to add/remove user callbacks which gets called
 134   for every enqueue/dequeue operation.
 135
 136 * **Updated the OCTEON TX2 crypto PMD.**
 137
 138   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 139     ESN and anti-replay support.
 140   * Updated the OCTEON TX2 crypto PMD with CN98xx support.
 141   * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
 142     PMD lookaside protocol offload for IPsec.
 143   * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
 144     crypto PMD lookaside protocol offload for IPsec.
 145
 146 * **Added mlx5 compress PMD.**
 147
 148   Added a new compress PMD driver for Bluefield 2 adapters.
 149
 150   See the :doc:`../compressdevs/mlx5` for more details.
 151
 152 * **Added support for build-time checking of header includes.**
 153
 154   A new build option ``check_includes`` has been added, which, when enabled,
 155   will perform build-time checking on DPDK public header files, to ensure none
 156   are missing dependent header includes. This feature, disabled by default, is
 157   intended for use by developers contributing to the DPDK SDK itself, and is
 158   integrated into the build scripts and automated CI for patch contributions.
 159
 160
 161 Removed Items
 162 -------------
 163
 164 .. This section should contain removed items in this release. Sample format:
 165
 166    * Add a short 1-2 sentence description of the removed item
 167      in the past tense.
 168
 169    This section is a comment. Do not overwrite or remove it.
 170    Also, make sure to start the actual text at the margin.
 171    =======================================================
 172
 173 * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
 174   ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
 175   ``ninja install`` action and are renamed to ``ethdev_driver.h``,
 176   ``ethdev_vdev.h`` and ``ethdev_pci.h`` respectively in the source tree, to
 177   reflect the fact that they are non-public headers.
 178
 179 * The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h``
 180   and ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK
 181   ``ninja install`` action and are renamed to ``eventdev_pmd.h``,
 182   ``eventdev_pmd_vdev.h`` and ``eventdev_pmd_pci.h`` respectively in the source
 183   tree, to reflect the fact that they are non-public headers.
 184
 185 * Removed support for NetXtreme devices belonging to ``BCM573xx and
 186   BCM5740x`` families. Specifically the support for the following Broadcom
 187   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 188   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 189
 190 * The ``check-includes.sh`` script for checking DPDK header files has been
 191   removed, being replaced by the ``check_includes`` build option described
 192   above.
 193
 194
 195 API Changes
 196 -----------
 197
 198 .. This section should contain API changes. Sample format:
 199
 200    * sample: Add a short 1-2 sentence description of the API change
 201      which was announced in the previous releases and made in this release.
 202      Start with a scope label like "ethdev:".
 203      Use fixed width quotes for ``function_names`` or ``struct_names``.
 204      Use the past tense.
 205
 206    This section is a comment. Do not overwrite or remove it.
 207    Also, make sure to start the actual text at the margin.
 208    =======================================================
 209
 210 * config: Removed the old macros, included in ``rte_config.h``,
 211   to indicate which DPDK libraries and drivers are built.
 212   The new macros are generated by meson in a standardized format:
 213   ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
 214   the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
 215   and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
 216
 217 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
 218   for adding enqueue and dequeue callbacks.
 219
 220
 221 ABI Changes
 222 -----------
 223
 224 .. This section should contain ABI changes. Sample format:
 225
 226    * sample: Add a short 1-2 sentence description of the ABI change
 227      which was announced in the previous releases and made in this release.
 228      Start with a scope label like "ethdev:".
 229      Use fixed width quotes for ``function_names`` or ``struct_names``.
 230      Use the past tense.
 231
 232    This section is a comment. Do not overwrite or remove it.
 233    Also, make sure to start the actual text at the margin.
 234    =======================================================
 235
 236 * No ABI change that would break compatibility with 20.11.
 237
 238
 239 Known Issues
 240 ------------
 241
 242 .. This section should contain new known issues in this release. Sample format:
 243
 244    * **Add title in present tense with full stop.**
 245
 246      Add a short 1-2 sentence description of the known issue
 247      in the present tense. Add information on any known workarounds.
 248
 249    This section is a comment. Do not overwrite or remove it.
 250    Also, make sure to start the actual text at the margin.
 251    =======================================================
 252
 253
 254 Tested Platforms
 255 ----------------
 256
 257 .. This section should contain a list of platforms that were tested
 258    with this release.
 259
 260    The format is:
 261
 262    * <vendor> platform with <vendor> <type of devices> combinations
 263
 264      * List of CPU
 265      * List of OS
 266      * List of devices
 267      * Other relevant details...
 268
 269    This section is a comment. Do not overwrite or remove it.
 270    Also, make sure to start the actual text at the margin.
 271    =======================================================