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 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
  82
  83   Enabled handling of mixed algorithms in encrypted digest hash-cipher
  84   (generation) and cipher-hash (verification) requests in QAT PMD
  85   when running on GEN2 QAT hardware with particular firmware versions
  86   (GEN3 support was added in DPDK 20.02).
  87
  88 * **Updated the turbo_sw bbdev PMD.**
  89
  90   Supported large size code blocks which does not fit in one mbuf segment.
  91
  92 * **Updated ipsec-secgw sample application with following features.**
  93
  94   * Updated ipsec-secgw application to add event based packet processing.
  95     The worker thread(s) would receive events and submit them back to the
  96     event device after the processing. This way, multicore scaling and HW
  97     assisted scheduling is achieved by making use of the event device
  98     capabilities. The event mode currently supports only inline IPsec
  99     protocol offload.
 100
 101   * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
 102     AES-192-GCM, AES-256-GCM algorithms.
 103
 104
 105 Removed Items
 106 -------------
 107
 108 .. This section should contain removed items in this release. Sample format:
 109
 110    * Add a short 1-2 sentence description of the removed item
 111      in the past tense.
 112
 113    This section is a comment. Do not overwrite or remove it.
 114    Also, make sure to start the actual text at the margin.
 115    =========================================================
 116
 117
 118 API Changes
 119 -----------
 120
 121 .. This section should contain API changes. Sample format:
 122
 123    * sample: Add a short 1-2 sentence description of the API change
 124      which was announced in the previous releases and made in this release.
 125      Start with a scope label like "ethdev:".
 126      Use fixed width quotes for ``function_names`` or ``struct_names``.
 127      Use the past tense.
 128
 129    This section is a comment. Do not overwrite or remove it.
 130    Also, make sure to start the actual text at the margin.
 131    =========================================================
 132
 133
 134 ABI Changes
 135 -----------
 136
 137 .. This section should contain ABI changes. Sample format:
 138
 139    * sample: Add a short 1-2 sentence description of the ABI change
 140      which was announced in the previous releases and made in this release.
 141      Start with a scope label like "ethdev:".
 142      Use fixed width quotes for ``function_names`` or ``struct_names``.
 143      Use the past tense.
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =========================================================
 148
 149 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
 150
 151
 152 Known Issues
 153 ------------
 154
 155 .. This section should contain new known issues in this release. Sample format:
 156
 157    * **Add title in present tense with full stop.**
 158
 159      Add a short 1-2 sentence description of the known issue
 160      in the present tense. Add information on any known workarounds.
 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    =========================================================
 165
 166
 167 Tested Platforms
 168 ----------------
 169
 170 .. This section should contain a list of platforms that were tested
 171    with this release.
 172
 173    The format is:
 174
 175    * <vendor> platform with <vendor> <type of devices> combinations
 176
 177      * List of CPU
 178      * List of OS
 179      * List of devices
 180      * Other relevant details...
 181
 182    This section is a comment. Do not overwrite or remove it.
 183    Also, make sure to start the actual text at the margin.
 184    =========================================================