doc/guides/rel_notes/release_20_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.02
   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_02.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 Wait Until Equal API.**
  60
  61   A new API has been added to wait for a memory location to be updated with a
  62   16-bit, 32-bit, 64-bit value.
  63
  64 * **Updated rte_flow api to support L2TPv3 over IP flows.**
  65
  66   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
  67
  68 * **Added IONIC net PMD.**
  69
  70   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
  71   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
  72
  73 * **Updated Hisilicon hns3 driver.**
  74
  75   Updated Hisilicon hns3 driver with new features and improvements, including:
  76
  77   * Added support for Rx interrupt.
  78   * Added support setting VF MAC address by PF driver.
  79
  80 * **Updated the Intel ice driver.**
  81
  82   Updated the Intel ice driver with new features and improvements, including:
  83
  84   * Added support for MAC rules on specific port.
  85   * Added support for MAC/VLAN with TCP/UDP in switch rule.
  86   * Added support for 1/10G device.
  87
  88 * **Updated Intel iavf driver.**
  89
  90   Updated iavf PMD with new features and improvements, including:
  91
  92   * Added more supported device IDs.
  93   * Updated virtual channel to latest AVF spec.
  94
  95 * **Updated Intel i40e driver.**
  96
  97   Updated i40e PMD with new features and improvements, including:
  98
  99   * Added support for L2TPv3 over IP profiles which can be programmed by the
 100     dynamic device personalization (DDP) process.
 101   * Added support for ESP-AH profiles which can be programmed by the
 102     dynamic device personalization (DDP) process.
 103   * Added PF support Malicious Device Drive event catch and notify.
 104   * Added LLDP support.
 105   * Extended PHY access AQ cmd.
 106   * Added support for reading LPI counters.
 107   * Added support for Energy Efficient Ethernet
 108
 109 * **Updated Mellanox mlx5 driver.**
 110
 111   Updated Mellanox mlx5 driver with new features and improvements, including:
 112
 113   * Added support for RSS using L3/L4 source/destination only.
 114   * Added support for matching on GTP tunnel header item.
 115
 116 * **Add new vDPA PMD based on Mellanox devices**
 117
 118   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
 119   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 120
 121 * **Updated testpmd application.**
 122
 123   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
 124   application.
 125
 126 * **Added algorithms to cryptodev API.**
 127
 128   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
 129     asymmetric crypto library specifications.
 130   * ECPM (Elliptic Curve Point Multiplication) is added to
 131     asymmetric crypto library specifications.
 132
 133 * **Added synchronous Crypto burst API.**
 134
 135   A new API is introduced in crypto library to handle synchronous cryptographic
 136   operations allowing to achieve performance gain for cryptodevs which use
 137   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
 138   cryptodev is provided. The IPsec example application and ipsec library itself
 139   were changed to allow utilization of this new feature.
 140
 141 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 142
 143   Added handling of mixed algorithms in encrypted digest hash-cipher
 144   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
 145   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
 146   Such algorithm combinations are not supported on GEN1/GEN2 hardware
 147   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
 148
 149 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 150
 151   Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
 152   a single queue-pair all enqueues to the TX queue must be done from one thread
 153   and all dequeues from the RX queue must be done from one thread, but enqueues
 154   and dequeues may be done in different threads.).
 155
 156 * **Updated the ZUC PMD.**
 157
 158   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
 159     library (minimum version required 0.53).
 160   * Removed dynamic library limitation, so PMD can be built as a shared
 161     object now.
 162
 163 * **Updated the KASUMI PMD.**
 164
 165   * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
 166     library (minimum version required 0.53).
 167
 168 * **Updated the SNOW3G PMD.**
 169
 170   * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
 171     library (minimum version required 0.53).
 172
 173 * **Changed armv8 crypto PMD external dependency.**
 174
 175   armv8 crypto PMD now depends on Arm crypto library, and Marvell's
 176   armv8 crypto library is not used anymore. Library name is changed
 177   from armv8_crypto to AArch64crypto.
 178
 179 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 180
 181   Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
 182   applications would be able to offload entire IPsec offload to the hardware.
 183   For the configured sessions, hardware will do the lookup and perform
 184   decryption and IPsec transformation. For the outbound path, application
 185   can submit a plain packet to the PMD, and it would be sent out on wire
 186   after doing encryption and IPsec transformation of the packet.
 187
 188 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 189
 190   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
 191   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
 192
 193 * **Added event mode to l3fwd sample application.**
 194
 195   Add event device support for ``l3fwd`` sample application. It demonstrates
 196   usage of poll and event mode IO mechanism under a single application.
 197
 198 * **Added cycle-count mode to the compression performance tool.**
 199
 200   Enhanced the compression performance tool by adding a cycle-count mode
 201   which can be used to help measure and tune hardware and software PMDs.
 202
 203
 204 Removed Items
 205 -------------
 206
 207 .. This section should contain removed items in this release. Sample format:
 208
 209    * Add a short 1-2 sentence description of the removed item
 210      in the past tense.
 211
 212    This section is a comment. Do not overwrite or remove it.
 213    Also, make sure to start the actual text at the margin.
 214    =========================================================
 215
 216 * **Disabled building all the Linux kernel modules by default.**
 217
 218   In order to remove the build time dependency with Linux kernel,
 219   the Technical Board decided to disable all the kernel modules
 220   by default from 20.02 version.
 221
 222 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
 223
 224   The internal tail write coalescing feature was removed as not compatible with
 225   dual-thread feature. It was replaced with a threshold feature. At busy times
 226   if only a small number of packets can be enqueued, each enqueue causes
 227   an expensive MMIO write. These MMIO write occurrences can be optimised by using
 228   the new threshold parameter on process start. Please see qat documentation for
 229   more details.
 230
 231
 232 API Changes
 233 -----------
 234
 235 .. This section should contain API changes. Sample format:
 236
 237    * sample: Add a short 1-2 sentence description of the API change
 238      which was announced in the previous releases and made in this release.
 239      Start with a scope label like "ethdev:".
 240      Use fixed width quotes for ``function_names`` or ``struct_names``.
 241      Use the past tense.
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================
 246
 247
 248 ABI Changes
 249 -----------
 250
 251 .. This section should contain ABI changes. Sample format:
 252
 253    * sample: Add a short 1-2 sentence description of the ABI change
 254      which was announced in the previous releases and made in this release.
 255      Start with a scope label like "ethdev:".
 256      Use fixed width quotes for ``function_names`` or ``struct_names``.
 257      Use the past tense.
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 264
 265
 266 Known Issues
 267 ------------
 268
 269 .. This section should contain new known issues in this release. Sample format:
 270
 271    * **Add title in present tense with full stop.**
 272
 273      Add a short 1-2 sentence description of the known issue
 274      in the present tense. Add information on any known workarounds.
 275
 276    This section is a comment. Do not overwrite or remove it.
 277    Also, make sure to start the actual text at the margin.
 278    =========================================================
 279
 280
 281 Tested Platforms
 282 ----------------
 283
 284 .. This section should contain a list of platforms that were tested
 285    with this release.
 286
 287    The format is:
 288
 289    * <vendor> platform with <vendor> <type of devices> combinations
 290
 291      * List of CPU
 292      * List of OS
 293      * List of devices
 294      * Other relevant details...
 295
 296    This section is a comment. Do not overwrite or remove it.
 297    Also, make sure to start the actual text at the margin.
 298    =========================================================