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       make doc-guides-html
  21       xdg-open build/doc/html/guides/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 crypto PMD.**
  66
  67   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
  68   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
  69   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
  70   * Added support for lookaside protocol (IPsec) offload for CN9K.
  71
  72 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
  73
  74   * Added event crypto adapter OP_FORWARD mode support.
  75
  76 * **Updated NXP dpaa_sec crypto PMD.**
  77
  78   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
  79   * Added PDCP short MAC-I support.
  80
  81 * **Updated NXP dpaa2_sec crypto PMD.**
  82
  83   * Added PDCP short MAC-I support.
  84
  85 * **Added multi-process support for testpmd.**
  86
  87   Added command-line options to specify total number of processes and
  88   current process ID. Each process owns subset of Rx and Tx queues.
  89
  90
  91 Removed Items
  92 -------------
  93
  94 .. This section should contain removed items in this release. Sample format:
  95
  96    * Add a short 1-2 sentence description of the removed item
  97      in the past tense.
  98
  99    This section is a comment. Do not overwrite or remove it.
 100    Also, make sure to start the actual text at the margin.
 101    =======================================================
 102
 103
 104 API Changes
 105 -----------
 106
 107 .. This section should contain API changes. Sample format:
 108
 109    * sample: Add a short 1-2 sentence description of the API change
 110      which was announced in the previous releases and made in this release.
 111      Start with a scope label like "ethdev:".
 112      Use fixed width quotes for ``function_names`` or ``struct_names``.
 113      Use the past tense.
 114
 115    This section is a comment. Do not overwrite or remove it.
 116    Also, make sure to start the actual text at the margin.
 117    =======================================================
 118
 119 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 120   rte_cryptodev_is_valid_dev as it can be used by the application as
 121   well as PMD to check whether the device is valid or not.
 122
 123 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 124   as it is for drivers only and should be private to DPDK, and not
 125   installed for app use.
 126
 127
 128 ABI Changes
 129 -----------
 130
 131 .. This section should contain ABI changes. Sample format:
 132
 133    * sample: Add a short 1-2 sentence description of the ABI change
 134      which was announced in the previous releases and made in this release.
 135      Start with a scope label like "ethdev:".
 136      Use fixed width quotes for ``function_names`` or ``struct_names``.
 137      Use the past tense.
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =======================================================
 142
 143
 144 Known Issues
 145 ------------
 146
 147 .. This section should contain new known issues in this release. Sample format:
 148
 149    * **Add title in present tense with full stop.**
 150
 151      Add a short 1-2 sentence description of the known issue
 152      in the present tense. Add information on any known workarounds.
 153
 154    This section is a comment. Do not overwrite or remove it.
 155    Also, make sure to start the actual text at the margin.
 156    =======================================================
 157
 158
 159 Tested Platforms
 160 ----------------
 161
 162 .. This section should contain a list of platforms that were tested
 163    with this release.
 164
 165    The format is:
 166
 167    * <vendor> platform with <vendor> <type of devices> combinations
 168
 169      * List of CPU
 170      * List of OS
 171      * List of devices
 172      * Other relevant details...
 173
 174    This section is a comment. Do not overwrite or remove it.
 175    Also, make sure to start the actual text at the margin.
 176    =======================================================