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