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