doc/guides/rel_notes/release_20_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.02
   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
  22       xdg-open build/doc/html/guides/rel_notes/release_20_02.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Added Wait Until Equal API.**
  60
  61   A new API has been added to wait for a memory location to be updated with a
  62   16-bit, 32-bit, 64-bit value.
  63
  64 * **Added algorithms to cryptodev API.**
  65
  66   * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
  67   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
  68     asymmetric crypto library specifications.
  69   * ECPM (Elliptic Curve Point Multiplication) is added to
  70     asymmetric crypto library specifications.
  71
  72 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
  73
  74   Added handling of mixed algorithms in encrypted digest hash-cipher
  75   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
  76   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
  77   Such algorithm combinations are not supported on GEN1/GEN2 hardware
  78   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
  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
 110 ABI Changes
 111 -----------
 112
 113 .. This section should contain ABI changes. Sample format:
 114
 115    * sample: Add a short 1-2 sentence description of the ABI change
 116      which was announced in the previous releases and made in this release.
 117      Start with a scope label like "ethdev:".
 118      Use fixed width quotes for ``function_names`` or ``struct_names``.
 119      Use the past tense.
 120
 121    This section is a comment. Do not overwrite or remove it.
 122    Also, make sure to start the actual text at the margin.
 123    =========================================================
 124
 125 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 126
 127
 128 Known Issues
 129 ------------
 130
 131 .. This section should contain new known issues in this release. Sample format:
 132
 133    * **Add title in present tense with full stop.**
 134
 135      Add a short 1-2 sentence description of the known issue
 136      in the present tense. Add information on any known workarounds.
 137
 138    This section is a comment. Do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =========================================================
 141
 142
 143 Tested Platforms
 144 ----------------
 145
 146 .. This section should contain a list of platforms that were tested
 147    with this release.
 148
 149    The format is:
 150
 151    * <vendor> platform with <vendor> <type of devices> combinations
 152
 153      * List of CPU
 154      * List of OS
 155      * List of devices
 156      * Other relevant details...
 157
 158    This section is a comment. Do not overwrite or remove it.
 159    Also, make sure to start the actual text at the margin.
 160    =========================================================