doc/guides/rel_notes/release_18_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2018 The DPDK contributors
   3
   4 DPDK Release 18.11
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_18_11.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significative)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Add support to offload more flow match and actions for CXGBE PMD**
  58
  59   Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
  60
  61   * Match items: destination MAC address.
  62   * Action items: push/pop/rewrite vlan header.
  63
  64 * **Added a devarg to use the latest supported vector path in i40e.**
  65   A new devarg ``use-latest-supported-vec`` was introduced to allow users to
  66   choose the latest vector path that the platform supported. For example, users
  67   can use AVX2 vector path on BDW/HSW to get better performance.
  68
  69 * **Added support for SR-IOV in netvsc PMD.**
  70
  71   The ``netvsc`` poll mode driver now supports the Accelerated Networking
  72   SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
  73   vdev_netvsc, tap, and failsafe drivers combination.
  74
  75 * **Updated failsafe driver.**
  76
  77   Updated the failsafe driver including the following changes:
  78
  79   * Support for Rx and Tx queues start and stop.
  80   * Support for Rx and Tx queues deferred start.
  81   * Support for runtime Rx and Tx queues setup.
  82   * Support multicast MAC address set.
  83
  84 * **Added ability to switch queue deferred start flag on testpmd app.**
  85
  86   Added a console command to testpmd app, giving ability to switch
  87   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
  88   the specified port. The port must be stopped before the command call in order
  89   to reconfigure queues.
  90
  91
  92 API Changes
  93 -----------
  94
  95 .. This section should contain API changes. Sample format:
  96
  97    * Add a short 1-2 sentence description of the API change.
  98      Use fixed width quotes for ``function_names`` or ``struct_names``.
  99      Use the past tense.
 100
 101    This section is a comment. Do not overwrite or remove it.
 102    Also, make sure to start the actual text at the margin.
 103    =========================================================
 104
 105 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
 106   functions were deprecated since 17.05 and are replaced by
 107   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
 108
 109 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 110   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 111   support MAC changes once the port has started and with this new device
 112   flag the MAC can be properly configured in any case. This is particularly
 113   important for bonding.
 114
 115
 116 ABI Changes
 117 -----------
 118
 119 .. This section should contain ABI changes. Sample format:
 120
 121    * Add a short 1-2 sentence description of the ABI change
 122      that was announced in the previous releases and made in this release.
 123      Use fixed width quotes for ``function_names`` or ``struct_names``.
 124      Use the past tense.
 125
 126    This section is a comment. Do not overwrite or remove it.
 127    Also, make sure to start the actual text at the margin.
 128    =========================================================
 129
 130
 131 Removed Items
 132 -------------
 133
 134 .. This section should contain removed items in this release. Sample format:
 135
 136    * Add a short 1-2 sentence description of the removed item
 137      in the past tense.
 138
 139    This section is a comment. Do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143
 144 Shared Library Versions
 145 -----------------------
 146
 147 .. Update any library version updated in this release
 148    and prepend with a ``+`` sign, like this:
 149
 150      librte_acl.so.2
 151    + librte_cfgfile.so.2
 152      librte_cmdline.so.2
 153
 154    This section is a comment. Do not overwrite or remove it.
 155    =========================================================
 156
 157 The libraries prepended with a plus sign were incremented in this version.
 158
 159 .. code-block:: diff
 160
 161      librte_acl.so.2
 162      librte_bbdev.so.1
 163      librte_bitratestats.so.2
 164      librte_bpf.so.1
 165      librte_bus_dpaa.so.1
 166      librte_bus_fslmc.so.1
 167      librte_bus_pci.so.1
 168      librte_bus_vdev.so.1
 169    + librte_bus_vmbus.so.1
 170      librte_cfgfile.so.2
 171      librte_cmdline.so.2
 172      librte_common_octeontx.so.1
 173      librte_compressdev.so.1
 174      librte_cryptodev.so.5
 175      librte_distributor.so.1
 176      librte_eal.so.8
 177      librte_ethdev.so.10
 178      librte_eventdev.so.4
 179      librte_flow_classify.so.1
 180      librte_gro.so.1
 181      librte_gso.so.1
 182      librte_hash.so.2
 183      librte_ip_frag.so.1
 184      librte_jobstats.so.1
 185      librte_kni.so.2
 186      librte_kvargs.so.1
 187      librte_latencystats.so.1
 188      librte_lpm.so.2
 189      librte_mbuf.so.4
 190      librte_mempool.so.5
 191      librte_meter.so.2
 192      librte_metrics.so.1
 193      librte_net.so.1
 194      librte_pci.so.1
 195      librte_pdump.so.2
 196      librte_pipeline.so.3
 197      librte_pmd_bnxt.so.2
 198      librte_pmd_bond.so.2
 199      librte_pmd_i40e.so.2
 200      librte_pmd_ixgbe.so.2
 201      librte_pmd_dpaa2_cmdif.so.1
 202      librte_pmd_dpaa2_qdma.so.1
 203      librte_pmd_ring.so.2
 204      librte_pmd_softnic.so.1
 205      librte_pmd_vhost.so.2
 206    + librte_pmd_netvsc.so.1
 207      librte_port.so.3
 208      librte_power.so.1
 209      librte_rawdev.so.1
 210      librte_reorder.so.1
 211      librte_ring.so.2
 212      librte_sched.so.1
 213      librte_security.so.1
 214      librte_table.so.3
 215      librte_timer.so.1
 216      librte_vhost.so.3
 217
 218
 219 Known Issues
 220 ------------
 221
 222 .. This section should contain new known issues in this release. Sample format:
 223
 224    * **Add title in present tense with full stop.**
 225
 226      Add a short 1-2 sentence description of the known issue
 227      in the present tense. Add information on any known workarounds.
 228
 229    This section is a comment. Do not overwrite or remove it.
 230    Also, make sure to start the actual text at the margin.
 231    =========================================================
 232
 233 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 234   driver; the Linux netvsc device must be brought up before the netvsc device is
 235   unbound and passed to the DPDK.
 236
 237
 238 Tested Platforms
 239 ----------------
 240
 241 .. This section should contain a list of platforms that were tested
 242    with this release.
 243
 244    The format is:
 245
 246    * <vendor> platform with <vendor> <type of devices> combinations
 247
 248      * List of CPU
 249      * List of OS
 250      * List of devices
 251      * Other relevant details...
 252
 253    This section is a comment. Do not overwrite or remove it.
 254    Also, make sure to start the actual text at the margin.
 255    =========================================================