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