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