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