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