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 * **Added phase-fair lock.**
  59
  60   Phase-fair lock provides fairness guarantees.
  61   It has two ticket pools, one for readers and one for writers.
  62
  63 * **Added support for Marvell CN10K SoC drivers.**
  64
  65   Added Marvell CN10K SoC support. Marvell CN10K SoC are based on Octeon 10
  66   family of ARM64 processors with ARM Neoverse N2 core with accelerators for
  67   packet processing, timers, cryptography, etc.
  68
  69   * Added common/cnxk driver consisting of common API to be used by
  70     net, crypto and event PMD's.
  71   * Added mempool/cnxk driver which provides the support for the integrated
  72     mempool device.
  73
  74 * **Enhanced ethdev representor syntax.**
  75
  76   * Introduced representor type of VF, SF and PF.
  77   * Supported sub-function and multi-host in representor syntax::
  78
  79       representor=#            [0,2-4]      /* Legacy VF compatible.         */
  80       representor=[[c#]pf#]vf# c1pf2vf3     /* VF 3 on PF 2 of controller 1. */
  81       representor=[[c#]pf#]sf# sf[0,2-1023] /* 1023 SFs.                     */
  82       representor=[c#]pf#      c2pf[0,1]    /* 2 PFs on controller 2.        */
  83
  84 * **Updated Arkville PMD driver.**
  85
  86   Updated Arkville net driver with new features and improvements, including:
  87
  88   * Generalized passing meta data between PMD and FPGA, allowing up to 20
  89     bytes of user specified information in RX and TX paths.
  90
  91   * Updated dynamic PMD extensions API using standardized names.
  92
  93   * Added support for new Atomic Rules PCI device IDs ``0x100f, 0x1010, 0x1017,
  94     0x1018, 0x1019``.
  95
  96 * **Updated Broadcom bnxt driver.**
  97
  98   * Updated HWRM structures to 1.10.2.15 version.
  99
 100 * **Updated Hisilicon hns3 driver.**
 101
 102   * Added support for module EEPROM dumping.
 103   * Added support for freeing Tx mbuf on demand.
 104   * Added support for copper port in Kunpeng930.
 105   * Added support for runtime config to select IO burst function.
 106   * Added support for outer UDP checksum in Kunpeng930.
 107   * Added support for query Tx descriptor status.
 108   * Added support for query Rx descriptor status.
 109   * Added support for IEEE 1588 PTP.
 110
 111 * **Updated Intel iavf driver.**
 112
 113   Updated the Intel iavf driver with new features and improvements, including:
 114
 115   * Added flow filter to support GTPU inner L3/L4 fields matching.
 116
 117 * **Updated Intel ice driver.**
 118
 119   * Added Intel ice support on Windows.
 120
 121 * **Updated Marvell OCTEON TX2 ethdev driver.**
 122
 123   * Added support for flow action port id.
 124
 125 * **Updated Mellanox mlx5 driver.**
 126
 127   Updated the Mellanox mlx5 driver with new features and improvements, including:
 128
 129   * Added support for VXLAN and NVGRE encap as sample actions.
 130   * Support push VLAN on ingress traffic and pop VLAN on egress traffic in E-Switch mode.
 131
 132 * **Updated NXP DPAA driver.**
 133
 134   * Added support for shared ethernet interface.
 135   * Added support for external buffers in Tx.
 136
 137 * **Updated NXP DPAA2 driver.**
 138
 139   * Added support for traffic management.
 140   * Added support for configurable Tx confirmation.
 141   * Added support for external buffers in Tx.
 142
 143 * **Updated Wangxun txgbe driver.**
 144
 145   * Added support for txgbevf PMD.
 146   * Support device arguments to handle AN training for backplane NICs.
 147
 148 * **Enabled vmxnet3 PMD on Windows.**
 149
 150 * **Updated the AF_XDP driver.**
 151
 152   * Added support for preferred busy polling.
 153
 154 * **Added support of multiple data-units in cryptodev API.**
 155
 156   The cryptodev library has been enhanced to allow operations on multiple
 157   data-units for AES-XTS algorithm, the data-unit length should be set in the
 158   transformation. A capability for it was added too.
 159
 160 * **Added a cryptodev feature flag to support cipher wrapped keys.**
 161
 162   A new feature flag has been added to allow application to provide
 163   cipher wrapped keys in session xforms.
 164
 165 * **Updated the OCTEON TX crypto PMD.**
 166
 167   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX crypto PMD.
 168
 169 * **Updated the OCTEON TX2 crypto PMD.**
 170
 171   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX2 crypto PMD.
 172   * Added support in lookaside protocol offload mode for IPsec with
 173     UDP encapsulation support for NAT Traversal.
 174   * Added support in lookaside protocol offload mode for IPsec with
 175     IPv4 transport mode.
 176
 177 * **Updated Mellanox RegEx PMD.**
 178
 179   * Added support for multi-segments mbuf.
 180
 181 * **Introduced period timer mode in eventdev timer adapter.**
 182
 183   * Added support for periodic timer mode in eventdev timer adapter.
 184   * Added support for periodic timer mode in octeontx2 event device driver.
 185
 186 * **Added event device vector capability.**
 187
 188   * Added ``rte_event_vector`` data structure which is capable of holding
 189     multiple ``uintptr_t`` of the same flow thereby allowing applications
 190     to vectorize their pipelines and also reduce the complexity of pipelining
 191     the events across multiple stages.
 192   * This also reduced the scheduling overhead on a event device.
 193
 194 * **Updated testpmd.**
 195
 196   * Added a command line option to configure forced speed for Ethernet port.
 197     ``dpdk-testpmd -- --eth-link-speed N``
 198   * Added command to display Rx queue used descriptor count.
 199     ``show port (port_id) rxq (queue_id) desc used count``
 200
 201 * **Updated ipsec-secgw sample application.**
 202
 203   * Updated the ``ipsec-secgw`` sample application with UDP encapsulation
 204     support for NAT Traversal.
 205
 206
 207 Removed Items
 208 -------------
 209
 210 .. This section should contain removed items in this release. Sample format:
 211
 212    * Add a short 1-2 sentence description of the removed item
 213      in the past tense.
 214
 215    This section is a comment. Do not overwrite or remove it.
 216    Also, make sure to start the actual text at the margin.
 217    =======================================================
 218
 219 * Removed support for Intel DLB V1 hardware. This is not a broad market device,
 220   and existing customers already obtain the source code directly from Intel.
 221
 222
 223 API Changes
 224 -----------
 225
 226 .. This section should contain API changes. Sample format:
 227
 228    * sample: Add a short 1-2 sentence description of the API change
 229      which was announced in the previous releases and made in this release.
 230      Start with a scope label like "ethdev:".
 231      Use fixed width quotes for ``function_names`` or ``struct_names``.
 232      Use the past tense.
 233
 234    This section is a comment. Do not overwrite or remove it.
 235    Also, make sure to start the actual text at the margin.
 236    =======================================================
 237
 238 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 239   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 240   and confusion with the transport layer security term.
 241
 242 * pci: The value ``PCI_ANY_ID`` is marked as deprecated
 243   and can be replaced with ``RTE_PCI_ANY_ID``.
 244
 245 * cryptodev: The experimental raw data path API for dequeue
 246   ``rte_cryptodev_raw_dequeue_burst`` got a new parameter
 247   ``max_nb_to_dequeue`` to provide flexible control on dequeue.
 248
 249
 250 ABI Changes
 251 -----------
 252
 253 .. This section should contain ABI changes. Sample format:
 254
 255    * sample: Add a short 1-2 sentence description of the ABI change
 256      which was announced in the previous releases and made in this release.
 257      Start with a scope label like "ethdev:".
 258      Use fixed width quotes for ``function_names`` or ``struct_names``.
 259      Use the past tense.
 260
 261    This section is a comment. Do not overwrite or remove it.
 262    Also, make sure to start the actual text at the margin.
 263    =======================================================
 264
 265 * No ABI change that would break compatibility with 20.11.
 266
 267 * The experimental function ``rte_telemetry_legacy_register`` has been
 268   removed from the public API and is now an internal-only function. This
 269   function was already marked as internal in the API documentation for it,
 270   and was not for use by external applications.
 271
 272
 273 Known Issues
 274 ------------
 275
 276 .. This section should contain new known issues in this release. Sample format:
 277
 278    * **Add title in present tense with full stop.**
 279
 280      Add a short 1-2 sentence description of the known issue
 281      in the present tense. Add information on any known workarounds.
 282
 283    This section is a comment. Do not overwrite or remove it.
 284    Also, make sure to start the actual text at the margin.
 285    =======================================================
 286
 287
 288 Tested Platforms
 289 ----------------
 290
 291 .. This section should contain a list of platforms that were tested
 292    with this release.
 293
 294    The format is:
 295
 296    * <vendor> platform with <vendor> <type of devices> combinations
 297
 298      * List of CPU
 299      * List of OS
 300      * List of devices
 301      * Other relevant details...
 302
 303    This section is a comment. Do not overwrite or remove it.
 304    Also, make sure to start the actual text at the margin.
 305    =======================================================