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 * **Updated the turbo_sw bbdev PMD.**
  94
  95   Supported large size code blocks which does not fit in one mbuf segment.
  96
  97 * **Updated ipsec-secgw sample application with following features.**
  98
  99   * Updated ipsec-secgw application to add event based packet processing.
 100     The worker thread(s) would receive events and submit them back to the
 101     event device after the processing. This way, multicore scaling and HW
 102     assisted scheduling is achieved by making use of the event device
 103     capabilities. The event mode currently supports only inline IPsec
 104     protocol offload.
 105
 106   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 107     AES-192-GCM, AES-256-GCM algorithms.
 108
 109   * Added IPsec inbound load-distribution support for ipsec-secgw application
 110     using NIC load distribution feature(Flow Director).
 111
 112
 113 Removed Items
 114 -------------
 115
 116 .. This section should contain removed items in this release. Sample format:
 117
 118    * Add a short 1-2 sentence description of the removed item
 119      in 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 API Changes
 127 -----------
 128
 129 .. This section should contain API changes. Sample format:
 130
 131    * sample: Add a short 1-2 sentence description of the API 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
 142 ABI Changes
 143 -----------
 144
 145 .. This section should contain ABI changes. Sample format:
 146
 147    * sample: Add a short 1-2 sentence description of the ABI change
 148      which was announced in the previous releases and made in this release.
 149      Start with a scope label like "ethdev:".
 150      Use fixed width quotes for ``function_names`` or ``struct_names``.
 151      Use the past tense.
 152
 153    This section is a comment. Do not overwrite or remove it.
 154    Also, make sure to start the actual text at the margin.
 155    =========================================================
 156
 157 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 158
 159
 160 Known Issues
 161 ------------
 162
 163 .. This section should contain new known issues in this release. Sample format:
 164
 165    * **Add title in present tense with full stop.**
 166
 167      Add a short 1-2 sentence description of the known issue
 168      in the present tense. Add information on any known workarounds.
 169
 170    This section is a comment. Do not overwrite or remove it.
 171    Also, make sure to start the actual text at the margin.
 172    =========================================================
 173
 174
 175 Tested Platforms
 176 ----------------
 177
 178 .. This section should contain a list of platforms that were tested
 179    with this release.
 180
 181    The format is:
 182
 183    * <vendor> platform with <vendor> <type of devices> combinations
 184
 185      * List of CPU
 186      * List of OS
 187      * List of devices
 188      * Other relevant details...
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =========================================================