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