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 * **Updated the OCTEON TX2 crypto PMD.**
  80
  81   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
  82     ESN and anti-replay support.
  83
  84
  85 Removed Items
  86 -------------
  87
  88 .. This section should contain removed items in this release. Sample format:
  89
  90    * Add a short 1-2 sentence description of the removed item
  91      in the past tense.
  92
  93    This section is a comment. Do not overwrite or remove it.
  94    Also, make sure to start the actual text at the margin.
  95    =======================================================
  96
  97 * Removed support for NetXtreme devices belonging to ``BCM573xx and
  98   BCM5740x`` families. Specifically the support for the following Broadcom
  99   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
 100   ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
 101
 102 API Changes
 103 -----------
 104
 105 .. This section should contain API changes. Sample format:
 106
 107    * sample: Add a short 1-2 sentence description of the API change
 108      which was announced in the previous releases and made in this release.
 109      Start with a scope label like "ethdev:".
 110      Use fixed width quotes for ``function_names`` or ``struct_names``.
 111      Use 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
 118 ABI Changes
 119 -----------
 120
 121 .. This section should contain ABI changes. Sample format:
 122
 123    * sample: Add a short 1-2 sentence description of the ABI change
 124      which was announced in the previous releases and made in this release.
 125      Start with a scope label like "ethdev:".
 126      Use fixed width quotes for ``function_names`` or ``struct_names``.
 127      Use the past tense.
 128
 129    This section is a comment. Do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =======================================================
 132
 133 * No ABI change that would break compatibility with 20.11.
 134
 135
 136 Known Issues
 137 ------------
 138
 139 .. This section should contain new known issues in this release. Sample format:
 140
 141    * **Add title in present tense with full stop.**
 142
 143      Add a short 1-2 sentence description of the known issue
 144      in the present tense. Add information on any known workarounds.
 145
 146    This section is a comment. Do not overwrite or remove it.
 147    Also, make sure to start the actual text at the margin.
 148    =======================================================
 149
 150
 151 Tested Platforms
 152 ----------------
 153
 154 .. This section should contain a list of platforms that were tested
 155    with this release.
 156
 157    The format is:
 158
 159    * <vendor> platform with <vendor> <type of devices> combinations
 160
 161      * List of CPU
 162      * List of OS
 163      * List of devices
 164      * Other relevant details...
 165
 166    This section is a comment. Do not overwrite or remove it.
 167    Also, make sure to start the actual text at the margin.
 168    =======================================================