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