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