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 * **Added new API for rte_ring.**
  60
  61   * New synchronization modes for rte_ring.
  62
  63   Introduced new optional MT synchronization modes for rte_ring:
  64   Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
  65   With these mode selected, rte_ring shows significant improvements for
  66   average enqueue/dequeue times on overcommitted systems.
  67
  68   * Added peek style API for rte_ring.
  69
  70   For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
  71   mode, provide an ability to split enqueue/dequeue operation into two phases
  72   (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
  73   objects in the ring without removing them from it (aka MT safe peek).
  74
  75 * **Updated Mellanox mlx5 driver.**
  76
  77   Updated Mellanox mlx5 driver with new features and improvements, including:
  78
  79   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
  80
  81 * **Updated the AESNI MB crypto PMD.**
  82
  83   * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
  84
  85 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
  86
  87   Enabled handling of mixed algorithms in encrypted digest hash-cipher
  88   (generation) and cipher-hash (verification) requests in QAT PMD
  89   when running on GEN2 QAT hardware with particular firmware versions
  90   (GEN3 support was added in DPDK 20.02).
  91
  92 * **Updated the turbo_sw bbdev PMD.**
  93
  94   Supported large size code blocks which does not fit in one mbuf segment.
  95
  96 * **Updated ipsec-secgw sample application with following features.**
  97
  98   * Updated ipsec-secgw application to add event based packet processing.
  99     The worker thread(s) would receive events and submit them back to the
 100     event device after the processing. This way, multicore scaling and HW
 101     assisted scheduling is achieved by making use of the event device
 102     capabilities. The event mode currently supports only inline IPsec
 103     protocol offload.
 104
 105   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 106     AES-192-GCM, AES-256-GCM algorithms.
 107
 108
 109 Removed Items
 110 -------------
 111
 112 .. This section should contain removed items in this release. Sample format:
 113
 114    * Add a short 1-2 sentence description of the removed item
 115      in the past tense.
 116
 117    This section is a comment. Do not overwrite or remove it.
 118    Also, make sure to start the actual text at the margin.
 119    =========================================================
 120
 121
 122 API Changes
 123 -----------
 124
 125 .. This section should contain API changes. Sample format:
 126
 127    * sample: Add a short 1-2 sentence description of the API change
 128      which was announced in the previous releases and made in this release.
 129      Start with a scope label like "ethdev:".
 130      Use fixed width quotes for ``function_names`` or ``struct_names``.
 131      Use the past tense.
 132
 133    This section is a comment. Do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137
 138 ABI Changes
 139 -----------
 140
 141 .. This section should contain ABI changes. Sample format:
 142
 143    * sample: Add a short 1-2 sentence description of the ABI change
 144      which was announced in the previous releases and made in this release.
 145      Start with a scope label like "ethdev:".
 146      Use fixed width quotes for ``function_names`` or ``struct_names``.
 147      Use the past tense.
 148
 149    This section is a comment. Do not overwrite or remove it.
 150    Also, make sure to start the actual text at the margin.
 151    =========================================================
 152
 153 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 154
 155
 156 Known Issues
 157 ------------
 158
 159 .. This section should contain new known issues in this release. Sample format:
 160
 161    * **Add title in present tense with full stop.**
 162
 163      Add a short 1-2 sentence description of the known issue
 164      in the present tense. Add information on any known workarounds.
 165
 166    This section is a comment. Do not overwrite or remove it.
 167    Also, make sure to start the actual text at the margin.
 168    =========================================================
 169
 170
 171 Tested Platforms
 172 ----------------
 173
 174 .. This section should contain a list of platforms that were tested
 175    with this release.
 176
 177    The format is:
 178
 179    * <vendor> platform with <vendor> <type of devices> combinations
 180
 181      * List of CPU
 182      * List of OS
 183      * List of devices
 184      * Other relevant details...
 185
 186    This section is a comment. Do not overwrite or remove it.
 187    Also, make sure to start the actual text at the margin.
 188    =========================================================