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