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