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 * **Added ability to switch queue deferred start flag on testpmd app.**
  76
  77   Added a console command to testpmd app, giving ability to switch
  78   ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
  79   the specified port. The port must be stopped before the command call in order
  80   to reconfigure queues.
  81
  82
  83 API Changes
  84 -----------
  85
  86 .. This section should contain API changes. Sample format:
  87
  88    * Add a short 1-2 sentence description of the API change.
  89      Use fixed width quotes for ``function_names`` or ``struct_names``.
  90      Use the past tense.
  91
  92    This section is a comment. Do not overwrite or remove it.
  93    Also, make sure to start the actual text at the margin.
  94    =========================================================
  95
  96 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
  97   functions were deprecated since 17.05 and are replaced by
  98   ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
  99
 100 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
 101   actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
 102   support MAC changes once the port has started and with this new device
 103   flag the MAC can be properly configured in any case. This is particularly
 104   important for bonding.
 105
 106
 107 ABI Changes
 108 -----------
 109
 110 .. This section should contain ABI changes. Sample format:
 111
 112    * Add a short 1-2 sentence description of the ABI change
 113      that was announced in the previous releases and made in this release.
 114      Use fixed width quotes for ``function_names`` or ``struct_names``.
 115      Use the past tense.
 116
 117    This section is a comment. Do not overwrite or remove it.
 118    Also, make sure to start the actual text at the margin.
 119    =========================================================
 120
 121
 122 Removed Items
 123 -------------
 124
 125 .. This section should contain removed items in this release. Sample format:
 126
 127    * Add a short 1-2 sentence description of the removed item
 128      in 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
 135 Shared Library Versions
 136 -----------------------
 137
 138 .. Update any library version updated in this release
 139    and prepend with a ``+`` sign, like this:
 140
 141      librte_acl.so.2
 142    + librte_cfgfile.so.2
 143      librte_cmdline.so.2
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    =========================================================
 147
 148 The libraries prepended with a plus sign were incremented in this version.
 149
 150 .. code-block:: diff
 151
 152      librte_acl.so.2
 153      librte_bbdev.so.1
 154      librte_bitratestats.so.2
 155      librte_bpf.so.1
 156      librte_bus_dpaa.so.1
 157      librte_bus_fslmc.so.1
 158      librte_bus_pci.so.1
 159      librte_bus_vdev.so.1
 160    + librte_bus_vmbus.so.1
 161      librte_cfgfile.so.2
 162      librte_cmdline.so.2
 163      librte_common_octeontx.so.1
 164      librte_compressdev.so.1
 165      librte_cryptodev.so.5
 166      librte_distributor.so.1
 167      librte_eal.so.8
 168      librte_ethdev.so.10
 169      librte_eventdev.so.4
 170      librte_flow_classify.so.1
 171      librte_gro.so.1
 172      librte_gso.so.1
 173      librte_hash.so.2
 174      librte_ip_frag.so.1
 175      librte_jobstats.so.1
 176      librte_kni.so.2
 177      librte_kvargs.so.1
 178      librte_latencystats.so.1
 179      librte_lpm.so.2
 180      librte_mbuf.so.4
 181      librte_mempool.so.5
 182      librte_meter.so.2
 183      librte_metrics.so.1
 184      librte_net.so.1
 185      librte_pci.so.1
 186      librte_pdump.so.2
 187      librte_pipeline.so.3
 188      librte_pmd_bnxt.so.2
 189      librte_pmd_bond.so.2
 190      librte_pmd_i40e.so.2
 191      librte_pmd_ixgbe.so.2
 192      librte_pmd_dpaa2_cmdif.so.1
 193      librte_pmd_dpaa2_qdma.so.1
 194      librte_pmd_ring.so.2
 195      librte_pmd_softnic.so.1
 196      librte_pmd_vhost.so.2
 197    + librte_pmd_netvsc.so.1
 198      librte_port.so.3
 199      librte_power.so.1
 200      librte_rawdev.so.1
 201      librte_reorder.so.1
 202      librte_ring.so.2
 203      librte_sched.so.1
 204      librte_security.so.1
 205      librte_table.so.3
 206      librte_timer.so.1
 207      librte_vhost.so.3
 208
 209
 210 Known Issues
 211 ------------
 212
 213 .. This section should contain new known issues in this release. Sample format:
 214
 215    * **Add title in present tense with full stop.**
 216
 217      Add a short 1-2 sentence description of the known issue
 218      in the present tense. Add information on any known workarounds.
 219
 220    This section is a comment. Do not overwrite or remove it.
 221    Also, make sure to start the actual text at the margin.
 222    =========================================================
 223
 224 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 225   driver; the Linux netvsc device must be brought up before the netvsc device is
 226   unbound and passed to the DPDK.
 227
 228
 229 Tested Platforms
 230 ----------------
 231
 232 .. This section should contain a list of platforms that were tested
 233    with this release.
 234
 235    The format is:
 236
 237    * <vendor> platform with <vendor> <type of devices> combinations
 238
 239      * List of CPU
 240      * List of OS
 241      * List of devices
 242      * Other relevant details...
 243
 244    This section is a comment. Do not overwrite or remove it.
 245    Also, make sure to start the actual text at the margin.
 246    =========================================================