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 * **Added support for meter PPS profile.**
  85
  86   Added packet mode in the meter profile parameters data structures
  87   to support metering traffic by packet per second (PPS),
  88   in addition to the initial bytes per second (BPS) mode (value 0).
  89
  90 * **Updated Arkville PMD driver.**
  91
  92   Updated Arkville net driver with new features and improvements, including:
  93
  94   * Generalized passing meta data between PMD and FPGA, allowing up to 20
  95     bytes of user specified information in RX and TX paths.
  96
  97   * Updated dynamic PMD extensions API using standardized names.
  98
  99   * Added support for new Atomic Rules PCI device IDs ``0x100f, 0x1010, 0x1017,
 100     0x1018, 0x1019``.
 101
 102 * **Updated Broadcom bnxt driver.**
 103
 104   * Updated HWRM structures to 1.10.2.15 version.
 105
 106 * **Updated Hisilicon hns3 driver.**
 107
 108   * Added support for module EEPROM dumping.
 109   * Added support for freeing Tx mbuf on demand.
 110   * Added support for copper port in Kunpeng930.
 111   * Added support for runtime config to select IO burst function.
 112   * Added support for outer UDP checksum in Kunpeng930.
 113   * Added support for query Tx descriptor status.
 114   * Added support for query Rx descriptor status.
 115   * Added support for IEEE 1588 PTP.
 116
 117 * **Updated Intel iavf driver.**
 118
 119   Updated the Intel iavf driver with new features and improvements, including:
 120
 121   * Added flow filter to support GTPU inner L3/L4 fields matching.
 122   * In AVX512 code, added the new RX and TX paths to use the HW offload
 123     features. When the HW offload features are configured to be used, the
 124     offload paths are chosen automatically. In parallel the support of HW
 125     offload features was removed from the legacy AVX512 paths.
 126
 127 * **Updated Intel ice driver.**
 128
 129   * Added Intel ice support on Windows.
 130   * Added GTPU TEID support for DCF switch filter.
 131   * Added flow priority support for DCF switch filter.
 132
 133 * **Updated Marvell OCTEON TX2 ethdev driver.**
 134
 135   * Added support for flow action port id.
 136
 137 * **Updated Mellanox mlx5 driver.**
 138
 139   Updated the Mellanox mlx5 driver with new features and improvements, including:
 140
 141   * Added support for VXLAN and NVGRE encap as sample actions.
 142   * Support push VLAN on ingress traffic and pop VLAN on egress traffic in E-Switch mode.
 143
 144 * **Updated NXP DPAA driver.**
 145
 146   * Added support for shared ethernet interface.
 147   * Added support for external buffers in Tx.
 148
 149 * **Updated NXP DPAA2 driver.**
 150
 151   * Added support for traffic management.
 152   * Added support for configurable Tx confirmation.
 153   * Added support for external buffers in Tx.
 154
 155 * **Updated Wangxun txgbe driver.**
 156
 157   * Added support for txgbevf PMD.
 158   * Support device arguments to handle AN training for backplane NICs.
 159
 160 * **Enabled vmxnet3 PMD on Windows.**
 161
 162 * **Updated the AF_XDP driver.**
 163
 164   * Added support for preferred busy polling.
 165
 166 * **Added support of multiple data-units in cryptodev API.**
 167
 168   The cryptodev library has been enhanced to allow operations on multiple
 169   data-units for AES-XTS algorithm, the data-unit length should be set in the
 170   transformation. A capability for it was added too.
 171
 172 * **Added a cryptodev feature flag to support cipher wrapped keys.**
 173
 174   A new feature flag has been added to allow application to provide
 175   cipher wrapped keys in session xforms.
 176
 177 * **Updated the OCTEON TX crypto PMD.**
 178
 179   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX crypto PMD.
 180
 181 * **Updated the OCTEON TX2 crypto PMD.**
 182
 183   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX2 crypto PMD.
 184   * Added support in lookaside protocol offload mode for IPsec with
 185     UDP encapsulation support for NAT Traversal.
 186   * Added support in lookaside protocol offload mode for IPsec with
 187     IPv4 transport mode.
 188
 189 * **Updated Mellanox RegEx PMD.**
 190
 191   * Added support for multi-segments mbuf.
 192
 193 * **Introduced period timer mode in eventdev timer adapter.**
 194
 195   * Added support for periodic timer mode in eventdev timer adapter.
 196   * Added support for periodic timer mode in octeontx2 event device driver.
 197
 198 * **Added event device vector capability.**
 199
 200   * Added ``rte_event_vector`` data structure which is capable of holding
 201     multiple ``uintptr_t`` of the same flow thereby allowing applications
 202     to vectorize their pipelines and also reduce the complexity of pipelining
 203     the events across multiple stages.
 204   * This also reduced the scheduling overhead on a event device.
 205
 206 * **Updated testpmd.**
 207
 208   * Added a command line option to configure forced speed for Ethernet port.
 209     ``dpdk-testpmd -- --eth-link-speed N``
 210   * Added command to display Rx queue used descriptor count.
 211     ``show port (port_id) rxq (queue_id) desc used count``
 212   * Added command to dump internal representation information of single flow.
 213     ``flow dump (port_id) rule (rule_id)``
 214
 215 * **Added support for the FIB lookup method in the l3fwd example app.**
 216
 217   Previously the l3fwd sample app only supported LPM and EM lookup methods,
 218   the app now supports the Forwarding Information Base (FIB) lookup method.
 219
 220 * **Updated ipsec-secgw sample application.**
 221
 222   * Updated the ``ipsec-secgw`` sample application with UDP encapsulation
 223     support for NAT Traversal.
 224
 225 * **Enhanced crypto adapter forward mode.**
 226
 227   * Added ``rte_event_crypto_adapter_enqueue()`` API to enqueue events to crypto
 228     adapter if forward mode is supported by driver.
 229   * Added support for crypto adapter forward mode in octeontx2 event and crypto
 230     device driver.
 231
 232
 233 Removed Items
 234 -------------
 235
 236 .. This section should contain removed items in this release. Sample format:
 237
 238    * Add a short 1-2 sentence description of the removed item
 239      in the past tense.
 240
 241    This section is a comment. Do not overwrite or remove it.
 242    Also, make sure to start the actual text at the margin.
 243    =======================================================
 244
 245 * Removed support for Intel DLB V1 hardware. This is not a broad market device,
 246   and existing customers already obtain the source code directly from Intel.
 247
 248
 249 API Changes
 250 -----------
 251
 252 .. This section should contain API changes. Sample format:
 253
 254    * sample: Add a short 1-2 sentence description of the API change
 255      which was announced in the previous releases and made in this release.
 256      Start with a scope label like "ethdev:".
 257      Use fixed width quotes for ``function_names`` or ``struct_names``.
 258      Use the past tense.
 259
 260    This section is a comment. Do not overwrite or remove it.
 261    Also, make sure to start the actual text at the margin.
 262    =======================================================
 263
 264 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 265   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 266   and confusion with the transport layer security term.
 267
 268 * pci: The value ``PCI_ANY_ID`` is marked as deprecated
 269   and can be replaced with ``RTE_PCI_ANY_ID``.
 270
 271 * ethdev: Added a ``rte_flow`` pointer parameter to the function
 272   ``rte_flow_dev_dump()`` allowing dump for single flow.
 273
 274 * cryptodev: The experimental raw data path API for dequeue
 275   ``rte_cryptodev_raw_dequeue_burst`` got a new parameter
 276   ``max_nb_to_dequeue`` to provide flexible control on dequeue.
 277
 278
 279 ABI Changes
 280 -----------
 281
 282 .. This section should contain ABI changes. Sample format:
 283
 284    * sample: Add a short 1-2 sentence description of the ABI change
 285      which was announced in the previous releases and made in this release.
 286      Start with a scope label like "ethdev:".
 287      Use fixed width quotes for ``function_names`` or ``struct_names``.
 288      Use the past tense.
 289
 290    This section is a comment. Do not overwrite or remove it.
 291    Also, make sure to start the actual text at the margin.
 292    =======================================================
 293
 294 * No ABI change that would break compatibility with 20.11.
 295
 296 * The experimental function ``rte_telemetry_legacy_register`` has been
 297   removed from the public API and is now an internal-only function. This
 298   function was already marked as internal in the API documentation for it,
 299   and was not for use by external applications.
 300
 301
 302 Known Issues
 303 ------------
 304
 305 .. This section should contain new known issues in this release. Sample format:
 306
 307    * **Add title in present tense with full stop.**
 308
 309      Add a short 1-2 sentence description of the known issue
 310      in the present tense. Add information on any known workarounds.
 311
 312    This section is a comment. Do not overwrite or remove it.
 313    Also, make sure to start the actual text at the margin.
 314    =======================================================
 315
 316
 317 Tested Platforms
 318 ----------------
 319
 320 .. This section should contain a list of platforms that were tested
 321    with this release.
 322
 323    The format is:
 324
 325    * <vendor> platform with <vendor> <type of devices> combinations
 326
 327      * List of CPU
 328      * List of OS
 329      * List of devices
 330      * Other relevant details...
 331
 332    This section is a comment. Do not overwrite or remove it.
 333    Also, make sure to start the actual text at the margin.
 334    =======================================================