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