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 and PF.
  61   * Supported sub-function and multi-host in representor syntax::
  62
  63       representor=#            [0,2-4]      /* Legacy VF compatible.         */
  64       representor=[[c#]pf#]vf# c1pf2vf3     /* VF 3 on PF 2 of controller 1. */
  65       representor=[[c#]pf#]sf# sf[0,2-1023] /* 1023 SFs.                     */
  66       representor=[c#]pf#      c2pf[0,1]    /* 2 PFs on controller 2.        */
  67
  68 * **Updated Broadcom bnxt driver.**
  69
  70   * Updated HWRM structures to 1.10.2.15 version.
  71
  72 * **Updated Hisilicon hns3 driver.**
  73
  74   * Added support for module EEPROM dumping.
  75   * Added support for freeing Tx mbuf on demand.
  76   * Added support for copper port in Kunpeng930.
  77
  78 * **Updated NXP DPAA driver.**
  79
  80   * Added support for shared ethernet interface.
  81   * Added support for external buffers in Tx.
  82
  83 * **Updated NXP DPAA2 driver.**
  84
  85   * Added support for traffic management.
  86   * Added support for configurable Tx confirmation.
  87   * Added support for external buffers in Tx.
  88
  89 * **Updated Wangxun txgbe driver.**
  90
  91   * Added support for txgbevf PMD.
  92
  93 * **Updated the AF_XDP driver.**
  94
  95   * Added support for preferred busy polling.
  96
  97 * **Updated testpmd.**
  98
  99   * Added a command line option to configure forced speed for Ethernet port.
 100     ``dpdk-testpmd -- --eth-link-speed N``
 101   * Added command to display Rx queue used descriptor count.
 102     ``show port (port_id) rxq (queue_id) desc used count``
 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
 118 API Changes
 119 -----------
 120
 121 .. This section should contain API changes. Sample format:
 122
 123    * sample: Add a short 1-2 sentence description of the API 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 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 134   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 135   and confusion with the transport layer security term.
 136
 137
 138 ABI Changes
 139 -----------
 140
 141 .. This section should contain ABI changes. Sample format:
 142
 143    * sample: Add a short 1-2 sentence description of the ABI change
 144      which was announced in the previous releases and made in this release.
 145      Start with a scope label like "ethdev:".
 146      Use fixed width quotes for ``function_names`` or ``struct_names``.
 147      Use the past tense.
 148
 149    This section is a comment. Do not overwrite or remove it.
 150    Also, make sure to start the actual text at the margin.
 151    =======================================================
 152
 153 * No ABI change that would break compatibility with 20.11.
 154
 155 * The experimental function ``rte_telemetry_legacy_register`` has been
 156   removed from the public API and is now an internal-only function. This
 157   function was already marked as internal in the API documentation for it,
 158   and was not for use by external applications.
 159
 160
 161 Known Issues
 162 ------------
 163
 164 .. This section should contain new known issues in this release. Sample format:
 165
 166    * **Add title in present tense with full stop.**
 167
 168      Add a short 1-2 sentence description of the known issue
 169      in the present tense. Add information on any known workarounds.
 170
 171    This section is a comment. Do not overwrite or remove it.
 172    Also, make sure to start the actual text at the margin.
 173    =======================================================
 174
 175
 176 Tested Platforms
 177 ----------------
 178
 179 .. This section should contain a list of platforms that were tested
 180    with this release.
 181
 182    The format is:
 183
 184    * <vendor> platform with <vendor> <type of devices> combinations
 185
 186      * List of CPU
 187      * List of OS
 188      * List of devices
 189      * Other relevant details...
 190
 191    This section is a comment. Do not overwrite or remove it.
 192    Also, make sure to start the actual text at the margin.
 193    =======================================================