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
  80
  81 Removed Items
  82 -------------
  83
  84 .. This section should contain removed items in this release. Sample format:
  85
  86    * Add a short 1-2 sentence description of the removed item
  87      in the past tense.
  88
  89    This section is a comment. Do not overwrite or remove it.
  90    Also, make sure to start the actual text at the margin.
  91    =======================================================
  92
  93
  94 API Changes
  95 -----------
  96
  97 .. This section should contain API changes. Sample format:
  98
  99    * sample: Add a short 1-2 sentence description of the API change
 100      which was announced in the previous releases and made in this release.
 101      Start with a scope label like "ethdev:".
 102      Use fixed width quotes for ``function_names`` or ``struct_names``.
 103      Use the past tense.
 104
 105    This section is a comment. Do not overwrite or remove it.
 106    Also, make sure to start the actual text at the margin.
 107    =======================================================
 108
 109 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
 110   rte_cryptodev_is_valid_dev as it can be used by the application as
 111   well as PMD to check whether the device is valid or not.
 112
 113 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
 114   as it is for drivers only and should be private to DPDK, and not
 115   installed for app use.
 116
 117
 118 ABI Changes
 119 -----------
 120
 121 .. This section should contain ABI changes. Sample format:
 122
 123    * sample: Add a short 1-2 sentence description of the ABI change
 124      which was announced in the previous releases and made in this release.
 125      Start with a scope label like "ethdev:".
 126      Use fixed width quotes for ``function_names`` or ``struct_names``.
 127      Use the past tense.
 128
 129    This section is a comment. Do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =======================================================
 132
 133
 134 Known Issues
 135 ------------
 136
 137 .. This section should contain new known issues in this release. Sample format:
 138
 139    * **Add title in present tense with full stop.**
 140
 141      Add a short 1-2 sentence description of the known issue
 142      in the present tense. Add information on any known workarounds.
 143
 144    This section is a comment. Do not overwrite or remove it.
 145    Also, make sure to start the actual text at the margin.
 146    =======================================================
 147
 148
 149 Tested Platforms
 150 ----------------
 151
 152 .. This section should contain a list of platforms that were tested
 153    with this release.
 154
 155    The format is:
 156
 157    * <vendor> platform with <vendor> <type of devices> combinations
 158
 159      * List of CPU
 160      * List of OS
 161      * List of devices
 162      * Other relevant details...
 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    =======================================================