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