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 * **Updated Hisilicon hns3 driver.**
  65
  66   Updated Hisilicon hns3 driver with new features and improvements, including:
  67
  68   * Added support for Rx interrupt.
  69
  70 * **Updated Mellanox mlx5 driver.**
  71
  72   Updated Mellanox mlx5 driver with new features and improvements, including:
  73
  74   * Added support for RSS using L3/L4 source/destination only.
  75
  76 * **Added algorithms to cryptodev API.**
  77
  78   * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
  79   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
  80     asymmetric crypto library specifications.
  81   * ECPM (Elliptic Curve Point Multiplication) is added to
  82     asymmetric crypto library specifications.
  83
  84 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
  85
  86   Added handling of mixed algorithms in encrypted digest hash-cipher
  87   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
  88   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
  89   Such algorithm combinations are not supported on GEN1/GEN2 hardware
  90   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
  91
  92 * **Updated the Intel QuickAssist Technology (QAT) symmetric crypto PMD.**
  93
  94   Added Chacha20-Poly1305 AEAD algorithm.
  95
  96
  97 Removed Items
  98 -------------
  99
 100 .. This section should contain removed items in this release. Sample format:
 101
 102    * Add a short 1-2 sentence description of the removed item
 103      in 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 API Changes
 111 -----------
 112
 113 .. This section should contain API changes. Sample format:
 114
 115    * sample: Add a short 1-2 sentence description of the API 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
 126 ABI Changes
 127 -----------
 128
 129 .. This section should contain ABI changes. Sample format:
 130
 131    * sample: Add a short 1-2 sentence description of the ABI change
 132      which was announced in the previous releases and made in this release.
 133      Start with a scope label like "ethdev:".
 134      Use fixed width quotes for ``function_names`` or ``struct_names``.
 135      Use the past tense.
 136
 137    This section is a comment. Do not overwrite or remove it.
 138    Also, make sure to start the actual text at the margin.
 139    =========================================================
 140
 141 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 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    =========================================================