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 Arkville PMD driver.**
  69
  70   Updated Arkville net driver with new features and improvements, including:
  71
  72   * Generalized passing meta data between PMD and FPGA, allowing up to 20
  73     bytes of user specified information in RX and TX paths.
  74
  75   * Updated dynamic PMD extensions API using standardized names.
  76
  77   * Added support for new Atomic Rules PCI device IDs ``0x100f, 0x1010, 0x1017,
  78     0x1018, 0x1019``.
  79
  80 * **Updated Broadcom bnxt driver.**
  81
  82   * Updated HWRM structures to 1.10.2.15 version.
  83
  84 * **Updated Hisilicon hns3 driver.**
  85
  86   * Added support for module EEPROM dumping.
  87   * Added support for freeing Tx mbuf on demand.
  88   * Added support for copper port in Kunpeng930.
  89   * Added support for runtime config to select IO burst function.
  90   * Added support for outer UDP checksum in Kunpeng930.
  91   * Added support for query Tx descriptor status.
  92   * Added support for query Rx descriptor status.
  93
  94 * **Updated NXP DPAA driver.**
  95
  96   * Added support for shared ethernet interface.
  97   * Added support for external buffers in Tx.
  98
  99 * **Updated NXP DPAA2 driver.**
 100
 101   * Added support for traffic management.
 102   * Added support for configurable Tx confirmation.
 103   * Added support for external buffers in Tx.
 104
 105 * **Updated Wangxun txgbe driver.**
 106
 107   * Added support for txgbevf PMD.
 108
 109 * **Updated the AF_XDP driver.**
 110
 111   * Added support for preferred busy polling.
 112
 113 * **Updated testpmd.**
 114
 115   * Added a command line option to configure forced speed for Ethernet port.
 116     ``dpdk-testpmd -- --eth-link-speed N``
 117   * Added command to display Rx queue used descriptor count.
 118     ``show port (port_id) rxq (queue_id) desc used count``
 119
 120
 121 Removed Items
 122 -------------
 123
 124 .. This section should contain removed items in this release. Sample format:
 125
 126    * Add a short 1-2 sentence description of the removed item
 127      in 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
 134 API Changes
 135 -----------
 136
 137 .. This section should contain API changes. Sample format:
 138
 139    * sample: Add a short 1-2 sentence description of the API change
 140      which was announced in the previous releases and made in this release.
 141      Start with a scope label like "ethdev:".
 142      Use fixed width quotes for ``function_names`` or ``struct_names``.
 143      Use the past tense.
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =======================================================
 148
 149 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 150   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 151   and confusion with the transport layer security term.
 152
 153
 154 ABI Changes
 155 -----------
 156
 157 .. This section should contain ABI changes. Sample format:
 158
 159    * sample: Add a short 1-2 sentence description of the ABI change
 160      which was announced in the previous releases and made in this release.
 161      Start with a scope label like "ethdev:".
 162      Use fixed width quotes for ``function_names`` or ``struct_names``.
 163      Use the past tense.
 164
 165    This section is a comment. Do not overwrite or remove it.
 166    Also, make sure to start the actual text at the margin.
 167    =======================================================
 168
 169 * No ABI change that would break compatibility with 20.11.
 170
 171 * The experimental function ``rte_telemetry_legacy_register`` has been
 172   removed from the public API and is now an internal-only function. This
 173   function was already marked as internal in the API documentation for it,
 174   and was not for use by external applications.
 175
 176
 177 Known Issues
 178 ------------
 179
 180 .. This section should contain new known issues in this release. Sample format:
 181
 182    * **Add title in present tense with full stop.**
 183
 184      Add a short 1-2 sentence description of the known issue
 185      in the present tense. Add information on any known workarounds.
 186
 187    This section is a comment. Do not overwrite or remove it.
 188    Also, make sure to start the actual text at the margin.
 189    =======================================================
 190
 191
 192 Tested Platforms
 193 ----------------
 194
 195 .. This section should contain a list of platforms that were tested
 196    with this release.
 197
 198    The format is:
 199
 200    * <vendor> platform with <vendor> <type of devices> combinations
 201
 202      * List of CPU
 203      * List of OS
 204      * List of devices
 205      * Other relevant details...
 206
 207    This section is a comment. Do not overwrite or remove it.
 208    Also, make sure to start the actual text at the margin.
 209    =======================================================