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