doc/guides/rel_notes/release_21_05.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.05
   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_05.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 * **Enhanced ethdev representor syntax.**
  59
  60   * Introduced representor type of VF, SF.
  61   * Supported sub-function in representor syntax::
  62
  63       representor=#            [0,2-4]      /* Legacy VF compatible.         */
  64       representor=sf#          sf[0,2-1023] /* 1023 SFs.                     */
  65
  66 * **Updated Broadcom bnxt driver.**
  67
  68   * Updated HWRM structures to 1.10.2.15 version.
  69
  70 * **Updated Hisilicon hns3 driver.**
  71
  72   * Added support for module EEPROM dumping.
  73   * Added support for freeing Tx mbuf on demand.
  74   * Added support for copper port in Kunpeng930.
  75
  76 * **Updated NXP DPAA driver.**
  77
  78   * Added support for shared ethernet interface.
  79   * Added support for external buffers in Tx.
  80
  81 * **Updated NXP DPAA2 driver.**
  82
  83   * Added support for traffic management.
  84   * Added support for configurable Tx confirmation.
  85   * Added support for external buffers in Tx.
  86
  87 * **Updated Wangxun txgbe driver.**
  88
  89   * Added support for txgbevf PMD.
  90
  91 * **Updated the AF_XDP driver.**
  92
  93   * Added support for preferred busy polling.
  94
  95 * **Updated testpmd.**
  96
  97   * Added a command line option to configure forced speed for Ethernet port.
  98     ``dpdk-testpmd -- --eth-link-speed N``
  99   * Added command to display Rx queue used descriptor count.
 100     ``show port (port_id) rxq (queue_id) desc used count``
 101
 102
 103 Removed Items
 104 -------------
 105
 106 .. This section should contain removed items in this release. Sample format:
 107
 108    * Add a short 1-2 sentence description of the removed item
 109      in the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =======================================================
 114
 115
 116 API Changes
 117 -----------
 118
 119 .. This section should contain API changes. Sample format:
 120
 121    * sample: Add a short 1-2 sentence description of the API change
 122      which was announced in the previous releases and made in this release.
 123      Start with a scope label like "ethdev:".
 124      Use fixed width quotes for ``function_names`` or ``struct_names``.
 125      Use the past tense.
 126
 127    This section is a comment. Do not overwrite or remove it.
 128    Also, make sure to start the actual text at the margin.
 129    =======================================================
 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    =======================================================