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