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