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 Marvell NITROX symmetric crypto PMD.**
  95
  96   Added a symmetric crypto PMD for Marvell NITROX V security processor.
  97   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
  98
  99 * **Updated NXP crypto PMDs for PDCP support.**
 100
 101   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
 102   Support is added for all sequence number sizes for control and user plane.
 103   Test application is updated for unit testing.
 104
 105 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 106
 107   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 108   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 109   classic 2-pass mode when running on QAT GEN3, significantly improving
 110   the performance of AES GCM operations.
 111
 112 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 113
 114   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 115   Please note that stateful compression is not supported.
 116
 117 * **Introduced FIFO for NTB PMD.**
 118
 119   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 120   packet based processing.
 121
 122 * **Added eBPF JIT support for arm64.**
 123
 124   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 125   performance.
 126
 127
 128 Removed Items
 129 -------------
 130
 131 .. This section should contain removed items in this release. Sample format:
 132
 133    * Add a short 1-2 sentence description of the removed item
 134      in the past tense.
 135
 136    This section is a comment. Do not overwrite or remove it.
 137    Also, make sure to start the actual text at the margin.
 138    =========================================================
 139
 140    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
 141      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
 142      hw-vlan-strip|hw-vlan-extend on|off”.
 143
 144      The testpmd commands set that can be used instead in order to enable or disable Rx
 145      offloading on all Rx queues of a port is:
 146      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
 147      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
 148
 149
 150 API Changes
 151 -----------
 152
 153 .. This section should contain API changes. Sample format:
 154
 155    * sample: Add a short 1-2 sentence description of the API change
 156      which was announced in the previous releases and made in this release.
 157      Start with a scope label like "ethdev:".
 158      Use fixed width quotes for ``function_names`` or ``struct_names``.
 159      Use the past tense.
 160
 161    This section is a comment. Do not overwrite or remove it.
 162    Also, make sure to start the actual text at the margin.
 163    =========================================================
 164
 165 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 166   ``int`` to provide a way to report various error conditions.
 167
 168 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 169   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 170   provide a way to report various error conditions.
 171
 172 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 173   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 174   provide a way to report various error conditions.
 175
 176 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 177   ``int`` to provide a way to report various error conditions.
 178
 179 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 180   return value from ``void`` to ``int`` to provide a way to report various
 181   error conditions.
 182
 183 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 184   ``int`` to provide a way to report various error conditions.
 185
 186 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 187   ``int`` to provide a way to report various error conditions.
 188
 189
 190 ABI Changes
 191 -----------
 192
 193 .. This section should contain ABI changes. Sample format:
 194
 195    * sample: Add a short 1-2 sentence description of the ABI change
 196      which was announced in the previous releases and made in this release.
 197      Start with a scope label like "ethdev:".
 198      Use fixed width quotes for ``function_names`` or ``struct_names``.
 199      Use the past tense.
 200
 201    This section is a comment. Do not overwrite or remove it.
 202    Also, make sure to start the actual text at the margin.
 203    =========================================================
 204
 205
 206 Shared Library Versions
 207 -----------------------
 208
 209 .. Update any library version updated in this release
 210    and prepend with a ``+`` sign, like this:
 211
 212      libfoo.so.1
 213    + libupdated.so.2
 214      libbar.so.1
 215
 216    This section is a comment. Do not overwrite or remove it.
 217    =========================================================
 218
 219 The libraries prepended with a plus sign were incremented in this version.
 220
 221 .. code-block:: diff
 222
 223      librte_acl.so.2
 224      librte_bbdev.so.1
 225      librte_bitratestats.so.2
 226      librte_bpf.so.1
 227      librte_bus_dpaa.so.2
 228      librte_bus_fslmc.so.2
 229      librte_bus_ifpga.so.2
 230      librte_bus_pci.so.2
 231      librte_bus_vdev.so.2
 232      librte_bus_vmbus.so.2
 233      librte_cfgfile.so.2
 234      librte_cmdline.so.2
 235      librte_compressdev.so.1
 236      librte_cryptodev.so.8
 237      librte_distributor.so.1
 238      librte_eal.so.11
 239      librte_efd.so.1
 240    + librte_ethdev.so.13
 241      librte_eventdev.so.7
 242      librte_flow_classify.so.1
 243      librte_gro.so.1
 244      librte_gso.so.1
 245      librte_hash.so.2
 246      librte_ip_frag.so.1
 247      librte_ipsec.so.1
 248      librte_jobstats.so.1
 249      librte_kni.so.2
 250      librte_kvargs.so.1
 251      librte_latencystats.so.1
 252      librte_lpm.so.2
 253      librte_mbuf.so.5
 254      librte_member.so.1
 255      librte_mempool.so.5
 256      librte_meter.so.3
 257      librte_metrics.so.1
 258      librte_net.so.1
 259      librte_pci.so.1
 260      librte_pdump.so.3
 261      librte_pipeline.so.3
 262      librte_pmd_bnxt.so.2
 263      librte_pmd_bond.so.2
 264      librte_pmd_i40e.so.2
 265      librte_pmd_ixgbe.so.2
 266      librte_pmd_dpaa2_qdma.so.1
 267      librte_pmd_ring.so.2
 268      librte_pmd_softnic.so.1
 269      librte_pmd_vhost.so.2
 270      librte_port.so.3
 271      librte_power.so.1
 272      librte_rawdev.so.1
 273      librte_rcu.so.1
 274      librte_reorder.so.1
 275      librte_ring.so.2
 276      librte_sched.so.3
 277      librte_security.so.2
 278      librte_stack.so.1
 279      librte_table.so.3
 280      librte_timer.so.1
 281      librte_vhost.so.4
 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    =========================================================
 317
 318 * **Updated Mellanox mlx5 driver.**
 319
 320   Updated Mellanox mlx5 driver with new features and improvements, including:
 321
 322   * Added support for VLAN pop flow offload command.
 323   * Added support for VLAN push flow offload command.
 324   * Added support for VLAN set PCP offload command.
 325   * Added support for VLAN set VID offload command.
 326