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 Hisilicon hns3 PMD.**
  60
  61   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
  62   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
  63   See the :doc:`../nics/hns3` guide for more details on this new driver.
  64
  65 * **Updated the Intel e1000 driver.**
  66
  67   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  68
  69 * **Updated the Intel i40e driver.**
  70
  71   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  72
  73 * **Updated the Intel fm10k driver.**
  74
  75   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  76
  77 * **Updated the Intel ice driver.**
  78
  79   Updated the Intel ice driver with new features and improvements, including:
  80
  81   * Added support for device-specific DDP package loading.
  82   * Added support for handling Receive Flex Descriptor.
  83   * Added support for protocol extraction on per Rx queue.
  84   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  85
  86 * **Added Marvell NITROX symmetric crypto PMD.**
  87
  88   Added a symmetric crypto PMD for Marvell NITROX V security processor.
  89   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
  90
  91 * **Updated NXP crypto PMDs for PDCP support.**
  92
  93   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
  94   Support is added for all sequence number sizes for control and user plane.
  95   Test application is updated for unit testing.
  96
  97 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
  98
  99   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 100   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 101   classic 2-pass mode when running on QAT GEN3, significantly improving
 102   the performance of AES GCM operations.
 103
 104 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 105
 106   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 107   Please note that stateful compression is not supported.
 108
 109
 110 Removed Items
 111 -------------
 112
 113 .. This section should contain removed items in this release. Sample format:
 114
 115    * Add a short 1-2 sentence description of the removed item
 116      in the past tense.
 117
 118    This section is a comment. Do not overwrite or remove it.
 119    Also, make sure to start the actual text at the margin.
 120    =========================================================
 121
 122    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
 123      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
 124      hw-vlan-strip|hw-vlan-extend on|off”.
 125
 126      The testpmd commands set that can be used instead in order to enable or disable Rx
 127      offloading on all Rx queues of a port is:
 128      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
 129      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
 130
 131
 132 API Changes
 133 -----------
 134
 135 .. This section should contain API changes. Sample format:
 136
 137    * sample: Add a short 1-2 sentence description of the API change
 138      which was announced in the previous releases and made in this release.
 139      Start with a scope label like "ethdev:".
 140      Use fixed width quotes for ``function_names`` or ``struct_names``.
 141      Use the past tense.
 142
 143    This section is a comment. Do not overwrite or remove it.
 144    Also, make sure to start the actual text at the margin.
 145    =========================================================
 146
 147 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 148   ``int`` to provide a way to report various error conditions.
 149
 150 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 151   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 152   provide a way to report various error conditions.
 153
 154 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 155   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 156   provide a way to report various error conditions.
 157
 158 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 159   ``int`` to provide a way to report various error conditions.
 160
 161 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 162   return value from ``void`` to ``int`` to provide a way to report various
 163   error conditions.
 164
 165 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 166   ``int`` to provide a way to report various error conditions.
 167
 168 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 169   ``int`` to provide a way to report various error conditions.
 170
 171
 172 ABI Changes
 173 -----------
 174
 175 .. This section should contain ABI changes. Sample format:
 176
 177    * sample: Add a short 1-2 sentence description of the ABI change
 178      which was announced in the previous releases and made in this release.
 179      Start with a scope label like "ethdev:".
 180      Use fixed width quotes for ``function_names`` or ``struct_names``.
 181      Use the past tense.
 182
 183    This section is a comment. Do not overwrite or remove it.
 184    Also, make sure to start the actual text at the margin.
 185    =========================================================
 186
 187
 188 Shared Library Versions
 189 -----------------------
 190
 191 .. Update any library version updated in this release
 192    and prepend with a ``+`` sign, like this:
 193
 194      libfoo.so.1
 195    + libupdated.so.2
 196      libbar.so.1
 197
 198    This section is a comment. Do not overwrite or remove it.
 199    =========================================================
 200
 201 The libraries prepended with a plus sign were incremented in this version.
 202
 203 .. code-block:: diff
 204
 205      librte_acl.so.2
 206      librte_bbdev.so.1
 207      librte_bitratestats.so.2
 208      librte_bpf.so.1
 209      librte_bus_dpaa.so.2
 210      librte_bus_fslmc.so.2
 211      librte_bus_ifpga.so.2
 212      librte_bus_pci.so.2
 213      librte_bus_vdev.so.2
 214      librte_bus_vmbus.so.2
 215      librte_cfgfile.so.2
 216      librte_cmdline.so.2
 217      librte_compressdev.so.1
 218      librte_cryptodev.so.8
 219      librte_distributor.so.1
 220      librte_eal.so.11
 221      librte_efd.so.1
 222    + librte_ethdev.so.13
 223      librte_eventdev.so.7
 224      librte_flow_classify.so.1
 225      librte_gro.so.1
 226      librte_gso.so.1
 227      librte_hash.so.2
 228      librte_ip_frag.so.1
 229      librte_ipsec.so.1
 230      librte_jobstats.so.1
 231      librte_kni.so.2
 232      librte_kvargs.so.1
 233      librte_latencystats.so.1
 234      librte_lpm.so.2
 235      librte_mbuf.so.5
 236      librte_member.so.1
 237      librte_mempool.so.5
 238      librte_meter.so.3
 239      librte_metrics.so.1
 240      librte_net.so.1
 241      librte_pci.so.1
 242      librte_pdump.so.3
 243      librte_pipeline.so.3
 244      librte_pmd_bnxt.so.2
 245      librte_pmd_bond.so.2
 246      librte_pmd_i40e.so.2
 247      librte_pmd_ixgbe.so.2
 248      librte_pmd_dpaa2_qdma.so.1
 249      librte_pmd_ring.so.2
 250      librte_pmd_softnic.so.1
 251      librte_pmd_vhost.so.2
 252      librte_port.so.3
 253      librte_power.so.1
 254      librte_rawdev.so.1
 255      librte_rcu.so.1
 256      librte_reorder.so.1
 257      librte_ring.so.2
 258      librte_sched.so.3
 259      librte_security.so.2
 260      librte_stack.so.1
 261      librte_table.so.3
 262      librte_timer.so.1
 263      librte_vhost.so.4
 264
 265
 266 Known Issues
 267 ------------
 268
 269 .. This section should contain new known issues in this release. Sample format:
 270
 271    * **Add title in present tense with full stop.**
 272
 273      Add a short 1-2 sentence description of the known issue
 274      in the present tense. Add information on any known workarounds.
 275
 276    This section is a comment. Do not overwrite or remove it.
 277    Also, make sure to start the actual text at the margin.
 278    =========================================================
 279
 280
 281 Tested Platforms
 282 ----------------
 283
 284 .. This section should contain a list of platforms that were tested
 285    with this release.
 286
 287    The format is:
 288
 289    * <vendor> platform with <vendor> <type of devices> combinations
 290
 291      * List of CPU
 292      * List of OS
 293      * List of devices
 294      * Other relevant details...
 295
 296    This section is a comment. Do not overwrite or remove it.
 297    Also, make sure to start the actual text at the margin.
 298    =========================================================
 299
 300 * **Updated Mellanox mlx5 driver.**
 301
 302   Updated Mellanox mlx5 driver with new features and improvements, including:
 303
 304   * Added support for VLAN pop flow offload command.
 305   * Added support for VLAN push flow offload command.
 306   * Added support for VLAN set PCP offload command.
 307   * Added support for VLAN set VID offload command.
 308