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