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 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 141   ``int`` to provide a way to report various error conditions.
 142
 143
 144 ABI Changes
 145 -----------
 146
 147 .. This section should contain ABI changes. Sample format:
 148
 149    * sample: Add a short 1-2 sentence description of the ABI change
 150      which was announced in the previous releases and made in this release.
 151      Start with a scope label like "ethdev:".
 152      Use fixed width quotes for ``function_names`` or ``struct_names``.
 153      Use the past tense.
 154
 155    This section is a comment. Do not overwrite or remove it.
 156    Also, make sure to start the actual text at the margin.
 157    =========================================================
 158
 159
 160 Shared Library Versions
 161 -----------------------
 162
 163 .. Update any library version updated in this release
 164    and prepend with a ``+`` sign, like this:
 165
 166      libfoo.so.1
 167    + libupdated.so.2
 168      libbar.so.1
 169
 170    This section is a comment. Do not overwrite or remove it.
 171    =========================================================
 172
 173 The libraries prepended with a plus sign were incremented in this version.
 174
 175 .. code-block:: diff
 176
 177      librte_acl.so.2
 178      librte_bbdev.so.1
 179      librte_bitratestats.so.2
 180      librte_bpf.so.1
 181      librte_bus_dpaa.so.2
 182      librte_bus_fslmc.so.2
 183      librte_bus_ifpga.so.2
 184      librte_bus_pci.so.2
 185      librte_bus_vdev.so.2
 186      librte_bus_vmbus.so.2
 187      librte_cfgfile.so.2
 188      librte_cmdline.so.2
 189      librte_compressdev.so.1
 190      librte_cryptodev.so.8
 191      librte_distributor.so.1
 192      librte_eal.so.11
 193      librte_efd.so.1
 194    + librte_ethdev.so.13
 195      librte_eventdev.so.7
 196      librte_flow_classify.so.1
 197      librte_gro.so.1
 198      librte_gso.so.1
 199      librte_hash.so.2
 200      librte_ip_frag.so.1
 201      librte_ipsec.so.1
 202      librte_jobstats.so.1
 203      librte_kni.so.2
 204      librte_kvargs.so.1
 205      librte_latencystats.so.1
 206      librte_lpm.so.2
 207      librte_mbuf.so.5
 208      librte_member.so.1
 209      librte_mempool.so.5
 210      librte_meter.so.3
 211      librte_metrics.so.1
 212      librte_net.so.1
 213      librte_pci.so.1
 214      librte_pdump.so.3
 215      librte_pipeline.so.3
 216      librte_pmd_bnxt.so.2
 217      librte_pmd_bond.so.2
 218      librte_pmd_i40e.so.2
 219      librte_pmd_ixgbe.so.2
 220      librte_pmd_dpaa2_qdma.so.1
 221      librte_pmd_ring.so.2
 222      librte_pmd_softnic.so.1
 223      librte_pmd_vhost.so.2
 224      librte_port.so.3
 225      librte_power.so.1
 226      librte_rawdev.so.1
 227      librte_rcu.so.1
 228      librte_reorder.so.1
 229      librte_ring.so.2
 230      librte_sched.so.3
 231      librte_security.so.2
 232      librte_stack.so.1
 233      librte_table.so.3
 234      librte_timer.so.1
 235      librte_vhost.so.4
 236
 237
 238 Known Issues
 239 ------------
 240
 241 .. This section should contain new known issues in this release. Sample format:
 242
 243    * **Add title in present tense with full stop.**
 244
 245      Add a short 1-2 sentence description of the known issue
 246      in the present tense. Add information on any known workarounds.
 247
 248    This section is a comment. Do not overwrite or remove it.
 249    Also, make sure to start the actual text at the margin.
 250    =========================================================
 251
 252
 253 Tested Platforms
 254 ----------------
 255
 256 .. This section should contain a list of platforms that were tested
 257    with this release.
 258
 259    The format is:
 260
 261    * <vendor> platform with <vendor> <type of devices> combinations
 262
 263      * List of CPU
 264      * List of OS
 265      * List of devices
 266      * Other relevant details...
 267
 268    This section is a comment. Do not overwrite or remove it.
 269    Also, make sure to start the actual text at the margin.
 270    =========================================================
 271
 272 * **Updated Mellanox mlx5 driver.**
 273
 274   Updated Mellanox mlx5 driver with new features and improvements, including:
 275
 276   * Added support for VLAN pop flow offload command.
 277   * Added support for VLAN push flow offload command.
 278   * Added support for VLAN set PCP offload command.
 279   * Added support for VLAN set VID offload command.
 280