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 Intel iavf driver.**
  95
  96   Updated the Intel iavf driver with new features and improvements, including:
  97
  98   * Added flow filter to support GTPU inner L3/L4 fields matching.
  99
 100 * **Updated NXP DPAA driver.**
 101
 102   * Added support for shared ethernet interface.
 103   * Added support for external buffers in Tx.
 104
 105 * **Updated NXP DPAA2 driver.**
 106
 107   * Added support for traffic management.
 108   * Added support for configurable Tx confirmation.
 109   * Added support for external buffers in Tx.
 110
 111 * **Updated Wangxun txgbe driver.**
 112
 113   * Added support for txgbevf PMD.
 114   * Support device arguments to handle AN training for backplane NICs.
 115
 116 * **Enabled vmxnet3 PMD on Windows.**
 117
 118 * **Updated the AF_XDP driver.**
 119
 120   * Added support for preferred busy polling.
 121
 122 * **Updated testpmd.**
 123
 124   * Added a command line option to configure forced speed for Ethernet port.
 125     ``dpdk-testpmd -- --eth-link-speed N``
 126   * Added command to display Rx queue used descriptor count.
 127     ``show port (port_id) rxq (queue_id) desc used count``
 128
 129
 130 Removed Items
 131 -------------
 132
 133 .. This section should contain removed items in this release. Sample format:
 134
 135    * Add a short 1-2 sentence description of the removed item
 136      in the past tense.
 137
 138    This section is a comment. Do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =======================================================
 141
 142
 143 API Changes
 144 -----------
 145
 146 .. This section should contain API changes. Sample format:
 147
 148    * sample: Add a short 1-2 sentence description of the API change
 149      which was announced in the previous releases and made in this release.
 150      Start with a scope label like "ethdev:".
 151      Use fixed width quotes for ``function_names`` or ``struct_names``.
 152      Use the past tense.
 153
 154    This section is a comment. Do not overwrite or remove it.
 155    Also, make sure to start the actual text at the margin.
 156    =======================================================
 157
 158 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 159   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 160   and confusion with the transport layer security term.
 161
 162 * pci: The value ``PCI_ANY_ID`` is marked as deprecated
 163   and can be replaced with ``RTE_PCI_ANY_ID``.
 164
 165
 166 ABI Changes
 167 -----------
 168
 169 .. This section should contain ABI changes. Sample format:
 170
 171    * sample: Add a short 1-2 sentence description of the ABI change
 172      which was announced in the previous releases and made in this release.
 173      Start with a scope label like "ethdev:".
 174      Use fixed width quotes for ``function_names`` or ``struct_names``.
 175      Use the past tense.
 176
 177    This section is a comment. Do not overwrite or remove it.
 178    Also, make sure to start the actual text at the margin.
 179    =======================================================
 180
 181 * No ABI change that would break compatibility with 20.11.
 182
 183 * The experimental function ``rte_telemetry_legacy_register`` has been
 184   removed from the public API and is now an internal-only function. This
 185   function was already marked as internal in the API documentation for it,
 186   and was not for use by external applications.
 187
 188
 189 Known Issues
 190 ------------
 191
 192 .. This section should contain new known issues in this release. Sample format:
 193
 194    * **Add title in present tense with full stop.**
 195
 196      Add a short 1-2 sentence description of the known issue
 197      in the present tense. Add information on any known workarounds.
 198
 199    This section is a comment. Do not overwrite or remove it.
 200    Also, make sure to start the actual text at the margin.
 201    =======================================================
 202
 203
 204 Tested Platforms
 205 ----------------
 206
 207 .. This section should contain a list of platforms that were tested
 208    with this release.
 209
 210    The format is:
 211
 212    * <vendor> platform with <vendor> <type of devices> combinations
 213
 214      * List of CPU
 215      * List of OS
 216      * List of devices
 217      * Other relevant details...
 218
 219    This section is a comment. Do not overwrite or remove it.
 220    Also, make sure to start the actual text at the margin.
 221    =======================================================