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