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