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 * **Added eBPF JIT support for arm64.**
 118
 119   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 120   performance.
 121
 122
 123 Removed Items
 124 -------------
 125
 126 .. This section should contain removed items in this release. Sample format:
 127
 128    * Add a short 1-2 sentence description of the removed item
 129      in the past tense.
 130
 131    This section is a comment. Do not overwrite or remove it.
 132    Also, make sure to start the actual text at the margin.
 133    =========================================================
 134
 135    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
 136      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
 137      hw-vlan-strip|hw-vlan-extend on|off”.
 138
 139      The testpmd commands set that can be used instead in order to enable or disable Rx
 140      offloading on all Rx queues of a port is:
 141      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
 142      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
 143
 144
 145 API Changes
 146 -----------
 147
 148 .. This section should contain API changes. Sample format:
 149
 150    * sample: Add a short 1-2 sentence description of the API change
 151      which was announced in the previous releases and made in this release.
 152      Start with a scope label like "ethdev:".
 153      Use fixed width quotes for ``function_names`` or ``struct_names``.
 154      Use the past tense.
 155
 156    This section is a comment. Do not overwrite or remove it.
 157    Also, make sure to start the actual text at the margin.
 158    =========================================================
 159
 160 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 161   ``int`` to provide a way to report various error conditions.
 162
 163 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 164   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 165   provide a way to report various error conditions.
 166
 167 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 168   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 169   provide a way to report various error conditions.
 170
 171 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 172   ``int`` to provide a way to report various error conditions.
 173
 174 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 175   return value from ``void`` to ``int`` to provide a way to report various
 176   error conditions.
 177
 178 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 179   ``int`` to provide a way to report various error conditions.
 180
 181 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 182   ``int`` to provide a way to report various error conditions.
 183
 184
 185 ABI Changes
 186 -----------
 187
 188 .. This section should contain ABI changes. Sample format:
 189
 190    * sample: Add a short 1-2 sentence description of the ABI change
 191      which was announced in the previous releases and made in this release.
 192      Start with a scope label like "ethdev:".
 193      Use fixed width quotes for ``function_names`` or ``struct_names``.
 194      Use the past tense.
 195
 196    This section is a comment. Do not overwrite or remove it.
 197    Also, make sure to start the actual text at the margin.
 198    =========================================================
 199
 200
 201 Shared Library Versions
 202 -----------------------
 203
 204 .. Update any library version updated in this release
 205    and prepend with a ``+`` sign, like this:
 206
 207      libfoo.so.1
 208    + libupdated.so.2
 209      libbar.so.1
 210
 211    This section is a comment. Do not overwrite or remove it.
 212    =========================================================
 213
 214 The libraries prepended with a plus sign were incremented in this version.
 215
 216 .. code-block:: diff
 217
 218      librte_acl.so.2
 219      librte_bbdev.so.1
 220      librte_bitratestats.so.2
 221      librte_bpf.so.1
 222      librte_bus_dpaa.so.2
 223      librte_bus_fslmc.so.2
 224      librte_bus_ifpga.so.2
 225      librte_bus_pci.so.2
 226      librte_bus_vdev.so.2
 227      librte_bus_vmbus.so.2
 228      librte_cfgfile.so.2
 229      librte_cmdline.so.2
 230      librte_compressdev.so.1
 231      librte_cryptodev.so.8
 232      librte_distributor.so.1
 233      librte_eal.so.11
 234      librte_efd.so.1
 235    + librte_ethdev.so.13
 236      librte_eventdev.so.7
 237      librte_flow_classify.so.1
 238      librte_gro.so.1
 239      librte_gso.so.1
 240      librte_hash.so.2
 241      librte_ip_frag.so.1
 242      librte_ipsec.so.1
 243      librte_jobstats.so.1
 244      librte_kni.so.2
 245      librte_kvargs.so.1
 246      librte_latencystats.so.1
 247      librte_lpm.so.2
 248      librte_mbuf.so.5
 249      librte_member.so.1
 250      librte_mempool.so.5
 251      librte_meter.so.3
 252      librte_metrics.so.1
 253      librte_net.so.1
 254      librte_pci.so.1
 255      librte_pdump.so.3
 256      librte_pipeline.so.3
 257      librte_pmd_bnxt.so.2
 258      librte_pmd_bond.so.2
 259      librte_pmd_i40e.so.2
 260      librte_pmd_ixgbe.so.2
 261      librte_pmd_dpaa2_qdma.so.1
 262      librte_pmd_ring.so.2
 263      librte_pmd_softnic.so.1
 264      librte_pmd_vhost.so.2
 265      librte_port.so.3
 266      librte_power.so.1
 267      librte_rawdev.so.1
 268      librte_rcu.so.1
 269      librte_reorder.so.1
 270      librte_ring.so.2
 271      librte_sched.so.3
 272      librte_security.so.2
 273      librte_stack.so.1
 274      librte_table.so.3
 275      librte_timer.so.1
 276      librte_vhost.so.4
 277
 278
 279 Known Issues
 280 ------------
 281
 282 .. This section should contain new known issues in this release. Sample format:
 283
 284    * **Add title in present tense with full stop.**
 285
 286      Add a short 1-2 sentence description of the known issue
 287      in the present tense. Add information on any known workarounds.
 288
 289    This section is a comment. Do not overwrite or remove it.
 290    Also, make sure to start the actual text at the margin.
 291    =========================================================
 292
 293
 294 Tested Platforms
 295 ----------------
 296
 297 .. This section should contain a list of platforms that were tested
 298    with this release.
 299
 300    The format is:
 301
 302    * <vendor> platform with <vendor> <type of devices> combinations
 303
 304      * List of CPU
 305      * List of OS
 306      * List of devices
 307      * Other relevant details...
 308
 309    This section is a comment. Do not overwrite or remove it.
 310    Also, make sure to start the actual text at the margin.
 311    =========================================================
 312
 313 * **Updated Mellanox mlx5 driver.**
 314
 315   Updated Mellanox mlx5 driver with new features and improvements, including:
 316
 317   * Added support for VLAN pop flow offload command.
 318   * Added support for VLAN push flow offload command.
 319   * Added support for VLAN set PCP offload command.
 320   * Added support for VLAN set VID offload command.
 321