doc/guides/rel_notes/release_19_08.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.08
   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_19_08.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 significant)
  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 * **Updated the bnxt PMD.**
  58
  59   Updated the bnxt PMD. The major enhancements include:
  60
  61   * Performance optimizations in non-vector Tx path
  62   * Added support for SSE vector mode
  63   * Updated HWRM API to version 1.10.0.74
  64
  65 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  66
  67   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  68   of Ethernet controllers. These controllers support link speeds up to
  69   200Gbps, 50G PAM-4, and PCIe 4.0.
  70
  71 * **Updated Solarflare network PMD.**
  72
  73   Updated the Solarflare ``sfc_efx`` driver with changes including:
  74
  75   * Added support for Rx interrupts.
  76
  77 * **Added memif PMD.**
  78
  79   Added the new Shared Memory Packet Interface (``memif``) PMD.
  80   See the :doc:`../nics/memif` guide for more details on this new driver.
  81
  82 * **Updated the AF_XDP PMD.**
  83
  84   Updated the AF_XDP PMD. The new features include:
  85
  86   * Enabled zero copy through mbuf's external memory mechanism to achieve
  87     high performance
  88   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
  89     queues
  90
  91
  92 Removed Items
  93 -------------
  94
  95 .. This section should contain removed items in this release. Sample format:
  96
  97    * Add a short 1-2 sentence description of the removed item
  98      in the past tense.
  99
 100    This section is a comment. Do not overwrite or remove it.
 101    Also, make sure to start the actual text at the margin.
 102    =========================================================
 103
 104 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 105
 106 * build: armv8 crypto extension is disabled.
 107
 108
 109 API Changes
 110 -----------
 111
 112 .. This section should contain API changes. Sample format:
 113
 114    * sample: Add a short 1-2 sentence description of the API change
 115      which was announced in the previous releases and made in this release.
 116      Start with a scope label like "ethdev:".
 117      Use fixed width quotes for ``function_names`` or ``struct_names``.
 118      Use the past tense.
 119
 120    This section is a comment. Do not overwrite or remove it.
 121    Also, make sure to start the actual text at the margin.
 122    =========================================================
 123
 124 * The network structures, definitions and functions have
 125   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 126
 127
 128 ABI Changes
 129 -----------
 130
 131 .. This section should contain ABI changes. Sample format:
 132
 133    * sample: Add a short 1-2 sentence description of the ABI change
 134      which was announced in the previous releases and made in this release.
 135      Start with a scope label like "ethdev:".
 136      Use fixed width quotes for ``function_names`` or ``struct_names``.
 137      Use 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      libfoo.so.1
 151    + libupdated.so.2
 152      libbar.so.1
 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.2
 166      librte_bus_fslmc.so.2
 167      librte_bus_ifpga.so.2
 168      librte_bus_pci.so.2
 169      librte_bus_vdev.so.2
 170      librte_bus_vmbus.so.2
 171      librte_cfgfile.so.2
 172      librte_cmdline.so.2
 173      librte_compressdev.so.1
 174      librte_cryptodev.so.7
 175      librte_distributor.so.1
 176      librte_eal.so.10
 177      librte_efd.so.1
 178      librte_ethdev.so.12
 179      librte_eventdev.so.6
 180      librte_flow_classify.so.1
 181      librte_gro.so.1
 182      librte_gso.so.1
 183      librte_hash.so.2
 184      librte_ip_frag.so.1
 185      librte_ipsec.so.1
 186      librte_jobstats.so.1
 187      librte_kni.so.2
 188      librte_kvargs.so.1
 189      librte_latencystats.so.1
 190      librte_lpm.so.2
 191      librte_mbuf.so.5
 192      librte_member.so.1
 193      librte_mempool.so.5
 194      librte_meter.so.3
 195      librte_metrics.so.1
 196      librte_net.so.1
 197      librte_pci.so.1
 198      librte_pdump.so.3
 199      librte_pipeline.so.3
 200      librte_pmd_bnxt.so.2
 201      librte_pmd_bond.so.2
 202      librte_pmd_i40e.so.2
 203      librte_pmd_ixgbe.so.2
 204      librte_pmd_dpaa2_qdma.so.1
 205      librte_pmd_ring.so.2
 206      librte_pmd_softnic.so.1
 207      librte_pmd_vhost.so.2
 208      librte_port.so.3
 209      librte_power.so.1
 210      librte_rawdev.so.1
 211      librte_rcu.so.1
 212      librte_reorder.so.1
 213      librte_ring.so.2
 214      librte_sched.so.2
 215      librte_security.so.2
 216      librte_stack.so.1
 217      librte_table.so.3
 218      librte_timer.so.1
 219      librte_vhost.so.4
 220
 221
 222 Known Issues
 223 ------------
 224
 225 .. This section should contain new known issues in this release. Sample format:
 226
 227    * **Add title in present tense with full stop.**
 228
 229      Add a short 1-2 sentence description of the known issue
 230      in the present tense. Add information on any known workarounds.
 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    =========================================================
 235
 236
 237 Tested Platforms
 238 ----------------
 239
 240 .. This section should contain a list of platforms that were tested
 241    with this release.
 242
 243    The format is:
 244
 245    * <vendor> platform with <vendor> <type of devices> combinations
 246
 247      * List of CPU
 248      * List of OS
 249      * List of devices
 250      * Other relevant details...
 251
 252    This section is a comment. Do not overwrite or remove it.
 253    Also, make sure to start the actual text at the margin.
 254    =========================================================
 255