doc/guides/rel_notes/release_20_05.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2020 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.05
   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_05.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 * **Updated Mellanox mlx5 driver.**
  60
  61   Updated Mellanox mlx5 driver with new features and improvements, including:
  62
  63   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
  64
  65 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
  66
  67   Enabled handling of mixed algorithms in encrypted digest hash-cipher
  68   (generation) and cipher-hash (verification) requests in QAT PMD
  69   when running on GEN2 QAT hardware with particular firmware versions
  70   (GEN3 support was added in DPDK 20.02).
  71
  72 * **Updated the turbo_sw bbdev PMD.**
  73
  74   Supported large size code blocks which does not fit in one mbuf segment.
  75
  76 * **Added event mode to ipsec-secgw application.**
  77
  78   Updated ipsec-secgw application to add event based packet processing. The worker
  79   thread(s) would receive events and submit them back to the event device after
  80   the processing. This way, multicore scaling and HW assisted scheduling is achieved
  81   by making use of the event device capabilities. The event mode currently supports
  82   only inline IPsec protocol offload.
  83
  84
  85 Removed Items
  86 -------------
  87
  88 .. This section should contain removed items in this release. Sample format:
  89
  90    * Add a short 1-2 sentence description of the removed item
  91      in the past tense.
  92
  93    This section is a comment. Do not overwrite or remove it.
  94    Also, make sure to start the actual text at the margin.
  95    =========================================================
  96
  97
  98 API Changes
  99 -----------
 100
 101 .. This section should contain API changes. Sample format:
 102
 103    * sample: Add a short 1-2 sentence description of the API change
 104      which was announced in the previous releases and made in this release.
 105      Start with a scope label like "ethdev:".
 106      Use fixed width quotes for ``function_names`` or ``struct_names``.
 107      Use the past tense.
 108
 109    This section is a comment. Do not overwrite or remove it.
 110    Also, make sure to start the actual text at the margin.
 111    =========================================================
 112
 113
 114 ABI Changes
 115 -----------
 116
 117 .. This section should contain ABI changes. Sample format:
 118
 119    * sample: Add a short 1-2 sentence description of the ABI change
 120      which was announced in the previous releases and made in this release.
 121      Start with a scope label like "ethdev:".
 122      Use fixed width quotes for ``function_names`` or ``struct_names``.
 123      Use the past tense.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 130
 131
 132 Known Issues
 133 ------------
 134
 135 .. This section should contain new known issues in this release. Sample format:
 136
 137    * **Add title in present tense with full stop.**
 138
 139      Add a short 1-2 sentence description of the known issue
 140      in the present tense. Add information on any known workarounds.
 141
 142    This section is a comment. Do not overwrite or remove it.
 143    Also, make sure to start the actual text at the margin.
 144    =========================================================
 145
 146
 147 Tested Platforms
 148 ----------------
 149
 150 .. This section should contain a list of platforms that were tested
 151    with this release.
 152
 153    The format is:
 154
 155    * <vendor> platform with <vendor> <type of devices> combinations
 156
 157      * List of CPU
 158      * List of OS
 159      * List of devices
 160      * Other relevant details...
 161
 162    This section is a comment. Do not overwrite or remove it.
 163    Also, make sure to start the actual text at the margin.
 164    =========================================================