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