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