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