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