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 * The default behaviour of CRC strip offload changed. Without any specific Rx
 116   offload flag, default behavior by PMD is now to strip CRC.
 117   DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
 118   To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
 119   offload.
 120
 121
 122 ABI Changes
 123 -----------
 124
 125 .. This section should contain ABI changes. Sample format:
 126
 127    * Add a short 1-2 sentence description of the ABI change
 128      that was announced in the previous releases and made in this release.
 129      Use fixed width quotes for ``function_names`` or ``struct_names``.
 130      Use the past tense.
 131
 132    This section is a comment. Do not overwrite or remove it.
 133    Also, make sure to start the actual text at the margin.
 134    =========================================================
 135
 136
 137 Removed Items
 138 -------------
 139
 140 .. This section should contain removed items in this release. Sample format:
 141
 142    * Add a short 1-2 sentence description of the removed item
 143      in the past tense.
 144
 145    This section is a comment. Do not overwrite or remove it.
 146    Also, make sure to start the actual text at the margin.
 147    =========================================================
 148
 149
 150 Shared Library Versions
 151 -----------------------
 152
 153 .. Update any library version updated in this release
 154    and prepend with a ``+`` sign, like this:
 155
 156      librte_acl.so.2
 157    + librte_cfgfile.so.2
 158      librte_cmdline.so.2
 159
 160    This section is a comment. Do not overwrite or remove it.
 161    =========================================================
 162
 163 The libraries prepended with a plus sign were incremented in this version.
 164
 165 .. code-block:: diff
 166
 167      librte_acl.so.2
 168      librte_bbdev.so.1
 169      librte_bitratestats.so.2
 170      librte_bpf.so.1
 171      librte_bus_dpaa.so.1
 172      librte_bus_fslmc.so.1
 173      librte_bus_pci.so.1
 174      librte_bus_vdev.so.1
 175    + librte_bus_vmbus.so.1
 176      librte_cfgfile.so.2
 177      librte_cmdline.so.2
 178      librte_common_octeontx.so.1
 179      librte_compressdev.so.1
 180      librte_cryptodev.so.5
 181      librte_distributor.so.1
 182      librte_eal.so.8
 183      librte_ethdev.so.10
 184      librte_eventdev.so.5
 185      librte_flow_classify.so.1
 186      librte_gro.so.1
 187      librte_gso.so.1
 188      librte_hash.so.2
 189      librte_ip_frag.so.1
 190      librte_jobstats.so.1
 191      librte_kni.so.2
 192      librte_kvargs.so.1
 193      librte_latencystats.so.1
 194      librte_lpm.so.2
 195      librte_mbuf.so.4
 196      librte_mempool.so.5
 197      librte_meter.so.2
 198      librte_metrics.so.1
 199      librte_net.so.1
 200      librte_pci.so.1
 201      librte_pdump.so.2
 202      librte_pipeline.so.3
 203      librte_pmd_bnxt.so.2
 204      librte_pmd_bond.so.2
 205      librte_pmd_i40e.so.2
 206      librte_pmd_ixgbe.so.2
 207      librte_pmd_dpaa2_cmdif.so.1
 208      librte_pmd_dpaa2_qdma.so.1
 209      librte_pmd_ring.so.2
 210      librte_pmd_softnic.so.1
 211      librte_pmd_vhost.so.2
 212    + librte_pmd_netvsc.so.1
 213      librte_port.so.3
 214      librte_power.so.1
 215      librte_rawdev.so.1
 216      librte_reorder.so.1
 217      librte_ring.so.2
 218      librte_sched.so.1
 219      librte_security.so.1
 220      librte_table.so.3
 221      librte_timer.so.1
 222      librte_vhost.so.3
 223
 224
 225 Known Issues
 226 ------------
 227
 228 .. This section should contain new known issues in this release. Sample format:
 229
 230    * **Add title in present tense with full stop.**
 231
 232      Add a short 1-2 sentence description of the known issue
 233      in the present tense. Add information on any known workarounds.
 234
 235    This section is a comment. Do not overwrite or remove it.
 236    Also, make sure to start the actual text at the margin.
 237    =========================================================
 238
 239 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
 240   driver; the Linux netvsc device must be brought up before the netvsc device is
 241   unbound and passed to the DPDK.
 242
 243
 244 Tested Platforms
 245 ----------------
 246
 247 .. This section should contain a list of platforms that were tested
 248    with this release.
 249
 250    The format is:
 251
 252    * <vendor> platform with <vendor> <type of devices> combinations
 253
 254      * List of CPU
 255      * List of OS
 256      * List of devices
 257      * Other relevant details...
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================