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 Intel ice driver.**
  86
  87   * Added Double VLAN support for DCF switch QinQ filtering.
  88
  89 * **Updated Mellanox mlx5 driver.**
  90
  91   Updated the Mellanox mlx5 driver with new features and improvements, including:
  92
  93   * Introduced basic support on Windows.
  94   * Added GTP PDU session container matching and raw encap/decap.
  95   * Added support for RSS action in the sample sub-actions list.
  96
  97 * **Updated Wangxun txgbe driver.**
  98
  99   Updated the Wangxun txgbe driver with new features and improvements, including:
 100
 101   * Add support for generic flow API.
 102   * Add support for traffic manager.
 103   * Add support for IPsec.
 104
 105 * **Updated GSO support.**
 106
 107   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 108
 109 * **Added enqueue & dequeue callback APIs for cryptodev library.**
 110
 111   Cryptodev library is added with enqueue & dequeue callback APIs to
 112   enable applications to add/remove user callbacks which gets called
 113   for every enqueue/dequeue operation.
 114
 115 * **Updated the OCTEON TX2 crypto PMD.**
 116
 117   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
 118     ESN and anti-replay support.
 119   * Updated the OCTEON TX2 crypto PMD with CN98xx support.
 120   * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
 121     PMD lookaside protocol offload for IPsec.
 122   * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
 123     crypto PMD lookaside protocol offload for IPsec.
 124
 125
 126 Removed Items
 127 -------------
 128
 129 .. This section should contain removed items in this release. Sample format:
 130
 131    * Add a short 1-2 sentence description of the removed item
 132      in the past tense.
 133
 134    This section is a comment. Do not overwrite or remove it.
 135    Also, make sure to start the actual text at the margin.
 136    =======================================================
 137
 138 * Removed support for NetXtreme devices belonging to ``BCM573xx and
 139   BCM5740x`` families. Specifically the support for the following Broadcom
 140   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 141   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 142
 143 API Changes
 144 -----------
 145
 146 .. This section should contain API changes. Sample format:
 147
 148    * sample: Add a short 1-2 sentence description of the API change
 149      which was announced in the previous releases and made in this release.
 150      Start with a scope label like "ethdev:".
 151      Use fixed width quotes for ``function_names`` or ``struct_names``.
 152      Use the past tense.
 153
 154    This section is a comment. Do not overwrite or remove it.
 155    Also, make sure to start the actual text at the margin.
 156    =======================================================
 157
 158 * config: Removed the old macros, included in ``rte_config.h``,
 159   to indicate which DPDK libraries and drivers are built.
 160   The new macros are generated by meson in a standardized format:
 161   ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
 162   the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
 163   and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
 164
 165 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
 166   for adding enqueue and dequeue callbacks.
 167
 168
 169 ABI Changes
 170 -----------
 171
 172 .. This section should contain ABI changes. Sample format:
 173
 174    * sample: Add a short 1-2 sentence description of the ABI change
 175      which was announced in the previous releases and made in this release.
 176      Start with a scope label like "ethdev:".
 177      Use fixed width quotes for ``function_names`` or ``struct_names``.
 178      Use the past tense.
 179
 180    This section is a comment. Do not overwrite or remove it.
 181    Also, make sure to start the actual text at the margin.
 182    =======================================================
 183
 184 * No ABI change that would break compatibility with 20.11.
 185
 186
 187 Known Issues
 188 ------------
 189
 190 .. This section should contain new known issues in this release. Sample format:
 191
 192    * **Add title in present tense with full stop.**
 193
 194      Add a short 1-2 sentence description of the known issue
 195      in the present tense. Add information on any known workarounds.
 196
 197    This section is a comment. Do not overwrite or remove it.
 198    Also, make sure to start the actual text at the margin.
 199    =======================================================
 200
 201
 202 Tested Platforms
 203 ----------------
 204
 205 .. This section should contain a list of platforms that were tested
 206    with this release.
 207
 208    The format is:
 209
 210    * <vendor> platform with <vendor> <type of devices> combinations
 211
 212      * List of CPU
 213      * List of OS
 214      * List of devices
 215      * Other relevant details...
 216
 217    This section is a comment. Do not overwrite or remove it.
 218    Also, make sure to start the actual text at the margin.
 219    =======================================================