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
 103
 104 Removed Items
 105 -------------
 106
 107 .. This section should contain removed items in this release. Sample format:
 108
 109    * Add a short 1-2 sentence description of the removed item
 110      in the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =======================================================
 115
 116 * eal: Removed the deprecated function ``rte_get_master_lcore()``
 117   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
 118
 119 * eal: The old api arguments that were deprecated for
 120   blacklist/whitelist are removed. Users must use the new
 121   block/allow list arguments.
 122
 123
 124 API Changes
 125 -----------
 126
 127 .. This section should contain API changes. Sample format:
 128
 129    * sample: Add a short 1-2 sentence description of the API change
 130      which was announced in the previous releases and made in this release.
 131      Start with a scope label like "ethdev:".
 132      Use fixed width quotes for ``function_names`` or ``struct_names``.
 133      Use the past tense.
 134
 135    This section is a comment. Do not overwrite or remove it.
 136    Also, make sure to start the actual text at the margin.
 137    =======================================================
 138
 139 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 140   rte_cryptodev_is_valid_dev as it can be used by the application as
 141   well as PMD to check whether the device is valid or not.
 142
 143 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 144   as it is for drivers only and should be private to DPDK, and not
 145   installed for app use.
 146
 147
 148 ABI Changes
 149 -----------
 150
 151 .. This section should contain ABI changes. Sample format:
 152
 153    * sample: Add a short 1-2 sentence description of the ABI change
 154      which was announced in the previous releases and made in this release.
 155      Start with a scope label like "ethdev:".
 156      Use fixed width quotes for ``function_names`` or ``struct_names``.
 157      Use the past tense.
 158
 159    This section is a comment. Do not overwrite or remove it.
 160    Also, make sure to start the actual text at the margin.
 161    =======================================================
 162
 163 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
 164   routines used by inline outbound and inline inbound security processing were
 165   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
 166   have much processing in PMD specific callbacks but just 64-bit set/get.
 167   This avoids a per packet function pointer jump overhead for such PMDs.
 168
 169
 170 Known Issues
 171 ------------
 172
 173 .. This section should contain new known issues in this release. Sample format:
 174
 175    * **Add title in present tense with full stop.**
 176
 177      Add a short 1-2 sentence description of the known issue
 178      in the present tense. Add information on any known workarounds.
 179
 180    This section is a comment. Do not overwrite or remove it.
 181    Also, make sure to start the actual text at the margin.
 182    =======================================================
 183
 184
 185 Tested Platforms
 186 ----------------
 187
 188 .. This section should contain a list of platforms that were tested
 189    with this release.
 190
 191    The format is:
 192
 193    * <vendor> platform with <vendor> <type of devices> combinations
 194
 195      * List of CPU
 196      * List of OS
 197      * List of devices
 198      * Other relevant details...
 199
 200    This section is a comment. Do not overwrite or remove it.
 201    Also, make sure to start the actual text at the margin.
 202    =======================================================