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 GENEVE TLV option in rte_flow.**
  64
  65   Added support for matching and raw encap/decap of GENEVE TLV option.
  66
  67 * **Added support of modify field action in the flow API.**
  68
  69   Added modify action support to perform various operations on
  70   any arbitrary header field (as well as mark, metadata or tag values):
  71   ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``.
  72   Supported operations are: overwriting a field with the content from
  73   another field, addition and subtraction using an immediate value.
  74
  75 * **Updated Broadcom bnxt driver.**
  76
  77   Updated the Broadcom bnxt driver with fixes and improvements, including:
  78
  79   * Added support for Stingray2 device.
  80
  81 * **Updated Cisco enic driver.**
  82
  83   * Added support for 64B completion queue entries
  84
  85 * **Updated Mellanox mlx5 driver.**
  86
  87   Updated the Mellanox mlx5 driver with new features and improvements, including:
  88
  89   * Introduced basic support on Windows.
  90   * Added GTP PDU session container matching and raw encap/decap.
  91   * Added support for RSS action in the sample sub-actions list.
  92
  93 * **Updated Wangxun txgbe driver.**
  94
  95   Updated the Wangxun txgbe driver with new features and improvements, including:
  96
  97   * Add support for generic flow API.
  98   * Add support for traffic manager.
  99   * Add support for IPsec.
 100
 101 * **Updated GSO support.**
 102
 103   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 104
 105 * **Added enqueue & dequeue callback APIs for cryptodev library.**
 106
 107   Cryptodev library is added with enqueue & dequeue callback APIs to
 108   enable applications to add/remove user callbacks which gets called
 109   for every enqueue/dequeue operation.
 110
 111 * **Updated the OCTEON TX2 crypto PMD.**
 112
 113   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 114     ESN and anti-replay support.
 115   * Updated the OCTEON TX2 crypto PMD with CN98xx support.
 116   * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
 117     PMD lookaside protocol offload for IPsec.
 118   * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
 119     crypto PMD lookaside protocol offload for IPsec.
 120
 121
 122 Removed Items
 123 -------------
 124
 125 .. This section should contain removed items in this release. Sample format:
 126
 127    * Add a short 1-2 sentence description of the removed item
 128      in the past tense.
 129
 130    This section is a comment. Do not overwrite or remove it.
 131    Also, make sure to start the actual text at the margin.
 132    =======================================================
 133
 134 * Removed support for NetXtreme devices belonging to ``BCM573xx and
 135   BCM5740x`` families. Specifically the support for the following Broadcom
 136   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 137   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 138
 139 API Changes
 140 -----------
 141
 142 .. This section should contain API changes. Sample format:
 143
 144    * sample: Add a short 1-2 sentence description of the API change
 145      which was announced in the previous releases and made in this release.
 146      Start with a scope label like "ethdev:".
 147      Use fixed width quotes for ``function_names`` or ``struct_names``.
 148      Use the past tense.
 149
 150    This section is a comment. Do not overwrite or remove it.
 151    Also, make sure to start the actual text at the margin.
 152    =======================================================
 153
 154 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
 155   for adding enqueue and dequeue callbacks.
 156
 157
 158 ABI Changes
 159 -----------
 160
 161 .. This section should contain ABI changes. Sample format:
 162
 163    * sample: Add a short 1-2 sentence description of the ABI change
 164      which was announced in the previous releases and made in this release.
 165      Start with a scope label like "ethdev:".
 166      Use fixed width quotes for ``function_names`` or ``struct_names``.
 167      Use 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 * No ABI change that would break compatibility with 20.11.
 174
 175
 176 Known Issues
 177 ------------
 178
 179 .. This section should contain new known issues in this release. Sample format:
 180
 181    * **Add title in present tense with full stop.**
 182
 183      Add a short 1-2 sentence description of the known issue
 184      in the present tense. Add information on any known workarounds.
 185
 186    This section is a comment. Do not overwrite or remove it.
 187    Also, make sure to start the actual text at the margin.
 188    =======================================================
 189
 190
 191 Tested Platforms
 192 ----------------
 193
 194 .. This section should contain a list of platforms that were tested
 195    with this release.
 196
 197    The format is:
 198
 199    * <vendor> platform with <vendor> <type of devices> combinations
 200
 201      * List of CPU
 202      * List of OS
 203      * List of devices
 204      * Other relevant details...
 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    =======================================================