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   * Added support for synchronous Crypto burst API.
  85
  86 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
  87
  88   Enabled handling of mixed algorithms in encrypted digest hash-cipher
  89   (generation) and cipher-hash (verification) requests in QAT PMD
  90   when running on GEN2 QAT hardware with particular firmware versions
  91   (GEN3 support was added in DPDK 20.02).
  92
  93 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
  94
  95   Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
  96   to QAT PMD.
  97
  98 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
  99
 100   Added a special way of buffer handling when internal QAT intermediate buffer
 101   is too small for Huffman dynamic compression operation. Instead of falling
 102   back to fixed compression, the operation is now split into multiple smaller
 103   dynamic compression requests (possible to execute on QAT) and their results
 104   are then combined and copied into the output buffer. This is not possible if
 105   any checksum calculation was requested - in such case the code falls back to
 106   fixed compression as before.
 107
 108 * **Updated the turbo_sw bbdev PMD.**
 109
 110   Supported large size code blocks which does not fit in one mbuf segment.
 111
 112 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
 113
 114   Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
 115   (Programmable  Acceleration Card) N3000.  See the
 116   :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
 117
 118 * **Updated ipsec-secgw sample application with following features.**
 119
 120   * Updated ipsec-secgw application to add event based packet processing.
 121     The worker thread(s) would receive events and submit them back to the
 122     event device after the processing. This way, multicore scaling and HW
 123     assisted scheduling is achieved by making use of the event device
 124     capabilities. The event mode currently supports only inline IPsec
 125     protocol offload.
 126
 127   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 128     AES-192-GCM, AES-256-GCM algorithms.
 129
 130   * Added IPsec inbound load-distribution support for ipsec-secgw application
 131     using NIC load distribution feature(Flow Director).
 132
 133
 134 Removed Items
 135 -------------
 136
 137 .. This section should contain removed items in this release. Sample format:
 138
 139    * Add a short 1-2 sentence description of the removed item
 140      in the past tense.
 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 API Changes
 148 -----------
 149
 150 .. This section should contain API changes. Sample format:
 151
 152    * sample: Add a short 1-2 sentence description of the API change
 153      which was announced in the previous releases and made in this release.
 154      Start with a scope label like "ethdev:".
 155      Use fixed width quotes for ``function_names`` or ``struct_names``.
 156      Use the past tense.
 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    =========================================================
 161
 162
 163 ABI Changes
 164 -----------
 165
 166 .. This section should contain ABI changes. Sample format:
 167
 168    * sample: Add a short 1-2 sentence description of the ABI change
 169      which was announced in the previous releases and made in this release.
 170      Start with a scope label like "ethdev:".
 171      Use fixed width quotes for ``function_names`` or ``struct_names``.
 172      Use the past tense.
 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    =========================================================
 177
 178 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 179
 180
 181 Known Issues
 182 ------------
 183
 184 .. This section should contain new known issues in this release. Sample format:
 185
 186    * **Add title in present tense with full stop.**
 187
 188      Add a short 1-2 sentence description of the known issue
 189      in the present tense. Add information on any known workarounds.
 190
 191    This section is a comment. Do not overwrite or remove it.
 192    Also, make sure to start the actual text at the margin.
 193    =========================================================
 194
 195
 196 Tested Platforms
 197 ----------------
 198
 199 .. This section should contain a list of platforms that were tested
 200    with this release.
 201
 202    The format is:
 203
 204    * <vendor> platform with <vendor> <type of devices> combinations
 205
 206      * List of CPU
 207      * List of OS
 208      * List of devices
 209      * Other relevant details...
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    Also, make sure to start the actual text at the margin.
 213    =========================================================