doc/guides/rel_notes/release_21_11.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.11
   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       ninja -C build doc
  21       xdg-open build/doc/guides/html/rel_notes/release_21_11.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 (ordered alphabetically by vendor name)
  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 * **Enabled new devargs parser.**
  59
  60   * Enabled devargs syntax
  61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
  62   * Added bus-level parsing of the devargs syntax.
  63   * Kept compatibility with the legacy syntax as parsing fallback.
  64
  65 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
  66
  67   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
  68   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
  69
  70 * **Updated Broadcom bnxt PMD.**
  71
  72   * Added flow offload support for Thor.
  73   * Implement support for tunnel offload.
  74   * Updated HWRM API to version 1.10.2.44
  75
  76 * **Updated Intel iavf driver.**
  77
  78   * Added Intel iavf support on Windows.
  79
  80 * **Updated Intel ice driver.**
  81
  82   * Added 1PPS out support by a devargs.
  83   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
  84
  85 * **Updated Marvell cnxk ethdev driver.**
  86
  87   * Added rte_flow support for dual VLAN insert and strip actions.
  88   * Added rte_tm support.
  89
  90 * **Updated Marvell cnxk crypto PMD.**
  91
  92   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
  93   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
  94   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
  95   * Added support for lookaside protocol (IPsec) offload for CN9K.
  96
  97 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
  98
  99   * Added event crypto adapter OP_FORWARD mode support.
 100
 101 * **Updated NXP dpaa_sec crypto PMD.**
 102
 103   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
 104   * Added PDCP short MAC-I support.
 105
 106 * **Updated NXP dpaa2_sec crypto PMD.**
 107
 108   * Added PDCP short MAC-I support.
 109
 110 * **Added multi-process support for testpmd.**
 111
 112   Added command-line options to specify total number of processes and
 113   current process ID. Each process owns subset of Rx and Tx queues.
 114
 115 * **Updated test-crypto-perf application with new cases.**
 116
 117   * Added support for asymmetric crypto throughput performance measurement.
 118     Only modex is supported for now.
 119
 120 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
 121
 122   * Added known vector tests (AES-GCM 128, 192, 256).
 123   * Added tests to verify error reporting with ICV corruption.
 124   * Added tests to verify IV generation.
 125   * Added tests to verify UDP encapsulation.
 126   * Added tests to validate packets soft expiry.
 127   * Added tests to validate packets hard expiry.
 128   * Added tests to verify tunnel header verification in IPsec inbound.
 129
 130
 131 Removed Items
 132 -------------
 133
 134 .. This section should contain removed items in this release. Sample format:
 135
 136    * Add a short 1-2 sentence description of the removed item
 137      in the past tense.
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =======================================================
 142
 143 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 144   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 145
 146 * eal: The old api arguments that were deprecated for
 147   blacklist/whitelist are removed. Users must use the new
 148   block/allow list arguments.
 149
 150
 151 API Changes
 152 -----------
 153
 154 .. This section should contain API changes. Sample format:
 155
 156    * sample: Add a short 1-2 sentence description of the API change
 157      which was announced in the previous releases and made in this release.
 158      Start with a scope label like "ethdev:".
 159      Use fixed width quotes for ``function_names`` or ``struct_names``.
 160      Use the past tense.
 161
 162    This section is a comment. Do not overwrite or remove it.
 163    Also, make sure to start the actual text at the margin.
 164    =======================================================
 165
 166 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
 167   removed. Its usages have been replaced by a new function
 168   ``rte_kvargs_get_with_value()``.
 169
 170 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 171   rte_cryptodev_is_valid_dev as it can be used by the application as
 172   well as PMD to check whether the device is valid or not.
 173
 174 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 175   as it is for drivers only and should be private to DPDK, and not
 176   installed for app use.
 177
 178 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
 179   renamed to ``aux_flags`` to indicate warnings and other information from
 180   the crypto/security operation. This field will be used to communicate
 181   events such as soft expiry with IPsec in lookaside mode.
 182
 183
 184 ABI Changes
 185 -----------
 186
 187 .. This section should contain ABI changes. Sample format:
 188
 189    * sample: Add a short 1-2 sentence description of the ABI change
 190      which was announced in the previous releases and made in this release.
 191      Start with a scope label like "ethdev:".
 192      Use fixed width quotes for ``function_names`` or ``struct_names``.
 193      Use the past tense.
 194
 195    This section is a comment. Do not overwrite or remove it.
 196    Also, make sure to start the actual text at the margin.
 197    =======================================================
 198
 199 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 200   routines used by inline outbound and inline inbound security processing were
 201   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 202   have much processing in PMD specific callbacks but just 64-bit set/get.
 203   This avoids a per packet function pointer jump overhead for such PMDs.
 204
 205 * security: A new option ``iv_gen_disable`` was added in structure
 206   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
 207   so that application can provide its own IV and test known test vectors.
 208
 209 * security: A new option ``tunnel_hdr_verify`` was added in structure
 210   ``rte_security_ipsec_sa_options`` to indicate whether outer header
 211   verification need to be done as part of inbound IPsec processing.
 212
 213 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
 214   replace ``esn_soft_limit`` in IPsec configuration structure
 215   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
 216   and hard expiry limits. Limits can be either in number of packets or bytes.
 217
 218
 219 Known Issues
 220 ------------
 221
 222 .. This section should contain new known issues in this release. Sample format:
 223
 224    * **Add title in present tense with full stop.**
 225
 226      Add a short 1-2 sentence description of the known issue
 227      in the present tense. Add information on any known workarounds.
 228
 229    This section is a comment. Do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =======================================================
 232
 233
 234 Tested Platforms
 235 ----------------
 236
 237 .. This section should contain a list of platforms that were tested
 238    with this release.
 239
 240    The format is:
 241
 242    * <vendor> platform with <vendor> <type of devices> combinations
 243
 244      * List of CPU
 245      * List of OS
 246      * List of devices
 247      * Other relevant details...
 248
 249    This section is a comment. Do not overwrite or remove it.
 250    Also, make sure to start the actual text at the margin.
 251    =======================================================