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