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