doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.11
   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_19_11.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 Lock-free Stack for aarch64.**
  60
  61   The lock-free stack implementation is enabled for aarch64 platforms.
  62
  63 * **Added Hisilicon hns3 PMD.**
  64
  65   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
  66   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
  67   See the :doc:`../nics/hns3` guide for more details on this new driver.
  68
  69 * **Updated the Intel e1000 driver.**
  70
  71   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  72
  73 * **Updated the Intel ixgbe driver.**
  74
  75   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  76
  77 * **Updated the Intel i40e driver.**
  78
  79   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  80
  81 * **Updated the Intel fm10k driver.**
  82
  83   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  84
  85 * **Updated the Intel ice driver.**
  86
  87   Updated the Intel ice driver with new features and improvements, including:
  88
  89   * Added support for device-specific DDP package loading.
  90   * Added support for handling Receive Flex Descriptor.
  91   * Added support for protocol extraction on per Rx queue.
  92   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  93
  94 * **Added cryptodev asymmetric session-less operation.**
  95
  96   Added session-less option to cryptodev asymmetric structure. It works the same
  97   way as symmetric crypto, corresponding xform is used directly by the crypto op.
  98
  99 * **Added Marvell NITROX symmetric crypto PMD.**
 100
 101   Added a symmetric crypto PMD for Marvell NITROX V security processor.
 102   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
 103
 104 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
 105
 106   Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
 107   Supports RSA and modexp operations.
 108
 109 * **Added Marvell OCTEON TX2 crypto PMD**
 110
 111   Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
 112
 113   See :doc:`../cryptodevs/octeontx2` for more details
 114
 115 * **Updated NXP crypto PMDs for PDCP support.**
 116
 117   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
 118   Support is added for all sequence number sizes for control and user plane.
 119   Test application is updated for unit testing.
 120
 121 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 122
 123   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 124   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 125   classic 2-pass mode when running on QAT GEN3, significantly improving
 126   the performance of AES GCM operations.
 127
 128 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 129
 130   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 131   Please note that stateful compression is not supported.
 132
 133 * **Added external buffers support for dpdk-test-compress-perf tool.**
 134
 135   Added a command line option to dpdk-test-compress-perf tool to allocate
 136   and use memory zones as external buffers instead of keeping the data directly
 137   in mbuf areas.
 138
 139 * **Updated the IPSec library.**
 140
 141   Added SA Database API to ``librte_ipsec``.
 142
 143 * **Introduced FIFO for NTB PMD.**
 144
 145   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 146   packet based processing.
 147
 148 * **Added eBPF JIT support for arm64.**
 149
 150   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 151   performance.
 152
 153
 154 Removed Items
 155 -------------
 156
 157 .. This section should contain removed items in this release. Sample format:
 158
 159    * Add a short 1-2 sentence description of the removed item
 160      in the past tense.
 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 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 167
 168     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 169                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 170
 171   The testpmd commands set that can be used instead
 172   in order to enable or disable Rx offloading on all Rx queues of a port is::
 173
 174     port config <port_id> rx_offload crc_strip|scatter|
 175                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 176                                      vlan_strip|vlan_filter|vlan_extend on|off
 177
 178
 179 API Changes
 180 -----------
 181
 182 .. This section should contain API changes. Sample format:
 183
 184    * sample: Add a short 1-2 sentence description of the API change
 185      which was announced in the previous releases and made in this release.
 186      Start with a scope label like "ethdev:".
 187      Use fixed width quotes for ``function_names`` or ``struct_names``.
 188      Use the past tense.
 189
 190    This section is a comment. Do not overwrite or remove it.
 191    Also, make sure to start the actual text at the margin.
 192    =========================================================
 193
 194 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 195   ``int`` to provide a way to report various error conditions.
 196
 197 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 198   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 199   provide a way to report various error conditions.
 200
 201 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 202   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 203   provide a way to report various error conditions.
 204
 205 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 206   ``int`` to provide a way to report various error conditions.
 207
 208 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 209   return value from ``void`` to ``int`` to provide a way to report various
 210   error conditions.
 211
 212 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 213   ``int`` to provide a way to report various error conditions.
 214
 215 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 216   ``int`` to provide a way to report various error conditions.
 217
 218 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 219   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 220   has been introduced in this release is used when used when all the packets
 221   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 222
 223
 224 ABI Changes
 225 -----------
 226
 227 .. This section should contain ABI changes. Sample format:
 228
 229    * sample: Add a short 1-2 sentence description of the ABI change
 230      which was announced in the previous releases and made in this release.
 231      Start with a scope label like "ethdev:".
 232      Use fixed width quotes for ``function_names`` or ``struct_names``.
 233      Use the past tense.
 234
 235    This section is a comment. Do not overwrite or remove it.
 236    Also, make sure to start the actual text at the margin.
 237    =========================================================
 238
 239
 240 Shared Library Versions
 241 -----------------------
 242
 243 .. Update any library version updated in this release
 244    and prepend with a ``+`` sign, like this:
 245
 246      libfoo.so.1
 247    + libupdated.so.2
 248      libbar.so.1
 249
 250    This section is a comment. Do not overwrite or remove it.
 251    =========================================================
 252
 253 The libraries prepended with a plus sign were incremented in this version.
 254
 255 .. code-block:: diff
 256
 257      librte_acl.so.2
 258      librte_bbdev.so.1
 259      librte_bitratestats.so.2
 260      librte_bpf.so.1
 261      librte_bus_dpaa.so.2
 262      librte_bus_fslmc.so.2
 263      librte_bus_ifpga.so.2
 264      librte_bus_pci.so.2
 265      librte_bus_vdev.so.2
 266      librte_bus_vmbus.so.2
 267      librte_cfgfile.so.2
 268      librte_cmdline.so.2
 269      librte_compressdev.so.1
 270      librte_cryptodev.so.8
 271      librte_distributor.so.1
 272      librte_eal.so.11
 273      librte_efd.so.1
 274    + librte_ethdev.so.13
 275    + librte_eventdev.so.8
 276      librte_flow_classify.so.1
 277      librte_gro.so.1
 278      librte_gso.so.1
 279      librte_hash.so.2
 280      librte_ip_frag.so.1
 281      librte_ipsec.so.1
 282      librte_jobstats.so.1
 283      librte_kni.so.2
 284      librte_kvargs.so.1
 285      librte_latencystats.so.1
 286      librte_lpm.so.2
 287      librte_mbuf.so.5
 288      librte_member.so.1
 289      librte_mempool.so.5
 290      librte_meter.so.3
 291      librte_metrics.so.1
 292      librte_net.so.1
 293      librte_pci.so.1
 294      librte_pdump.so.3
 295      librte_pipeline.so.3
 296      librte_pmd_bnxt.so.2
 297      librte_pmd_bond.so.2
 298      librte_pmd_i40e.so.2
 299      librte_pmd_ixgbe.so.2
 300      librte_pmd_dpaa2_qdma.so.1
 301      librte_pmd_ring.so.2
 302      librte_pmd_softnic.so.1
 303      librte_pmd_vhost.so.2
 304      librte_port.so.3
 305      librte_power.so.1
 306      librte_rawdev.so.1
 307      librte_rcu.so.1
 308      librte_reorder.so.1
 309      librte_ring.so.2
 310      librte_sched.so.3
 311      librte_security.so.2
 312      librte_stack.so.1
 313      librte_table.so.3
 314      librte_timer.so.1
 315      librte_vhost.so.4
 316
 317
 318 Known Issues
 319 ------------
 320
 321 .. This section should contain new known issues in this release. Sample format:
 322
 323    * **Add title in present tense with full stop.**
 324
 325      Add a short 1-2 sentence description of the known issue
 326      in the present tense. Add information on any known workarounds.
 327
 328    This section is a comment. Do not overwrite or remove it.
 329    Also, make sure to start the actual text at the margin.
 330    =========================================================
 331
 332
 333 Tested Platforms
 334 ----------------
 335
 336 .. This section should contain a list of platforms that were tested
 337    with this release.
 338
 339    The format is:
 340
 341    * <vendor> platform with <vendor> <type of devices> combinations
 342
 343      * List of CPU
 344      * List of OS
 345      * List of devices
 346      * Other relevant details...
 347
 348    This section is a comment. Do not overwrite or remove it.
 349    Also, make sure to start the actual text at the margin.
 350    =========================================================
 351
 352 * **Updated Mellanox mlx5 driver.**
 353
 354   Updated Mellanox mlx5 driver with new features and improvements, including:
 355
 356   * Added support for VLAN pop flow offload command.
 357   * Added support for VLAN push flow offload command.
 358   * Added support for VLAN set PCP offload command.
 359   * Added support for VLAN set VID offload command.
 360