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