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