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
 123 * **Updated Intel ice driver.**
 124
 125   * Added Intel ice support on Windows.
 126
 127 * **Updated Marvell OCTEON TX2 ethdev driver.**
 128
 129   * Added support for flow action port id.
 130
 131 * **Updated Mellanox mlx5 driver.**
 132
 133   Updated the Mellanox mlx5 driver with new features and improvements, including:
 134
 135   * Added support for VXLAN and NVGRE encap as sample actions.
 136   * Support push VLAN on ingress traffic and pop VLAN on egress traffic in E-Switch mode.
 137
 138 * **Updated NXP DPAA driver.**
 139
 140   * Added support for shared ethernet interface.
 141   * Added support for external buffers in Tx.
 142
 143 * **Updated NXP DPAA2 driver.**
 144
 145   * Added support for traffic management.
 146   * Added support for configurable Tx confirmation.
 147   * Added support for external buffers in Tx.
 148
 149 * **Updated Wangxun txgbe driver.**
 150
 151   * Added support for txgbevf PMD.
 152   * Support device arguments to handle AN training for backplane NICs.
 153
 154 * **Enabled vmxnet3 PMD on Windows.**
 155
 156 * **Updated the AF_XDP driver.**
 157
 158   * Added support for preferred busy polling.
 159
 160 * **Added support of multiple data-units in cryptodev API.**
 161
 162   The cryptodev library has been enhanced to allow operations on multiple
 163   data-units for AES-XTS algorithm, the data-unit length should be set in the
 164   transformation. A capability for it was added too.
 165
 166 * **Added a cryptodev feature flag to support cipher wrapped keys.**
 167
 168   A new feature flag has been added to allow application to provide
 169   cipher wrapped keys in session xforms.
 170
 171 * **Updated the OCTEON TX crypto PMD.**
 172
 173   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX crypto PMD.
 174
 175 * **Updated the OCTEON TX2 crypto PMD.**
 176
 177   * Added support for DIGEST_ENCRYPTED mode in OCTEON TX2 crypto PMD.
 178   * Added support in lookaside protocol offload mode for IPsec with
 179     UDP encapsulation support for NAT Traversal.
 180   * Added support in lookaside protocol offload mode for IPsec with
 181     IPv4 transport mode.
 182
 183 * **Updated Mellanox RegEx PMD.**
 184
 185   * Added support for multi-segments mbuf.
 186
 187 * **Introduced period timer mode in eventdev timer adapter.**
 188
 189   * Added support for periodic timer mode in eventdev timer adapter.
 190   * Added support for periodic timer mode in octeontx2 event device driver.
 191
 192 * **Added event device vector capability.**
 193
 194   * Added ``rte_event_vector`` data structure which is capable of holding
 195     multiple ``uintptr_t`` of the same flow thereby allowing applications
 196     to vectorize their pipelines and also reduce the complexity of pipelining
 197     the events across multiple stages.
 198   * This also reduced the scheduling overhead on a event device.
 199
 200 * **Updated testpmd.**
 201
 202   * Added a command line option to configure forced speed for Ethernet port.
 203     ``dpdk-testpmd -- --eth-link-speed N``
 204   * Added command to display Rx queue used descriptor count.
 205     ``show port (port_id) rxq (queue_id) desc used count``
 206   * Added command to dump internal representation information of single flow.
 207     ``flow dump (port_id) rule (rule_id)``
 208
 209 * **Updated ipsec-secgw sample application.**
 210
 211   * Updated the ``ipsec-secgw`` sample application with UDP encapsulation
 212     support for NAT Traversal.
 213
 214
 215 Removed Items
 216 -------------
 217
 218 .. This section should contain removed items in this release. Sample format:
 219
 220    * Add a short 1-2 sentence description of the removed item
 221      in the past tense.
 222
 223    This section is a comment. Do not overwrite or remove it.
 224    Also, make sure to start the actual text at the margin.
 225    =======================================================
 226
 227 * Removed support for Intel DLB V1 hardware. This is not a broad market device,
 228   and existing customers already obtain the source code directly from Intel.
 229
 230
 231 API Changes
 232 -----------
 233
 234 .. This section should contain API changes. Sample format:
 235
 236    * sample: Add a short 1-2 sentence description of the API change
 237      which was announced in the previous releases and made in this release.
 238      Start with a scope label like "ethdev:".
 239      Use fixed width quotes for ``function_names`` or ``struct_names``.
 240      Use the past tense.
 241
 242    This section is a comment. Do not overwrite or remove it.
 243    Also, make sure to start the actual text at the margin.
 244    =======================================================
 245
 246 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
 247   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
 248   and confusion with the transport layer security term.
 249
 250 * pci: The value ``PCI_ANY_ID`` is marked as deprecated
 251   and can be replaced with ``RTE_PCI_ANY_ID``.
 252
 253 * ethdev: Added a ``rte_flow`` pointer parameter to the function
 254   ``rte_flow_dev_dump()`` allowing dump for single flow.
 255
 256 * cryptodev: The experimental raw data path API for dequeue
 257   ``rte_cryptodev_raw_dequeue_burst`` got a new parameter
 258   ``max_nb_to_dequeue`` to provide flexible control on dequeue.
 259
 260
 261 ABI Changes
 262 -----------
 263
 264 .. This section should contain ABI changes. Sample format:
 265
 266    * sample: Add a short 1-2 sentence description of the ABI change
 267      which was announced in the previous releases and made in this release.
 268      Start with a scope label like "ethdev:".
 269      Use fixed width quotes for ``function_names`` or ``struct_names``.
 270      Use the past tense.
 271
 272    This section is a comment. Do not overwrite or remove it.
 273    Also, make sure to start the actual text at the margin.
 274    =======================================================
 275
 276 * No ABI change that would break compatibility with 20.11.
 277
 278 * The experimental function ``rte_telemetry_legacy_register`` has been
 279   removed from the public API and is now an internal-only function. This
 280   function was already marked as internal in the API documentation for it,
 281   and was not for use by external applications.
 282
 283
 284 Known Issues
 285 ------------
 286
 287 .. This section should contain new known issues in this release. Sample format:
 288
 289    * **Add title in present tense with full stop.**
 290
 291      Add a short 1-2 sentence description of the known issue
 292      in the present tense. Add information on any known workarounds.
 293
 294    This section is a comment. Do not overwrite or remove it.
 295    Also, make sure to start the actual text at the margin.
 296    =======================================================
 297
 298
 299 Tested Platforms
 300 ----------------
 301
 302 .. This section should contain a list of platforms that were tested
 303    with this release.
 304
 305    The format is:
 306
 307    * <vendor> platform with <vendor> <type of devices> combinations
 308
 309      * List of CPU
 310      * List of OS
 311      * List of devices
 312      * Other relevant details...
 313
 314    This section is a comment. Do not overwrite or remove it.
 315    Also, make sure to start the actual text at the margin.
 316    =======================================================