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 * **Added memif PMD.**
  72
  73   Added the new Shared Memory Packet Interface (``memif``) PMD.
  74   See the :doc:`../nics/memif` guide for more details on this new driver.
  75
  76 * **Updated the AF_XDP PMD.**
  77
  78   Updated the AF_XDP PMD. The new features include:
  79
  80   * Enabled zero copy through mbuf's external memory mechanism to achieve
  81     high performance
  82   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
  83     queues
  84
  85
  86 Removed Items
  87 -------------
  88
  89 .. This section should contain removed items in this release. Sample format:
  90
  91    * Add a short 1-2 sentence description of the removed item
  92      in the past tense.
  93
  94    This section is a comment. Do not overwrite or remove it.
  95    Also, make sure to start the actual text at the margin.
  96    =========================================================
  97
  98 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
  99
 100 * build: armv8 crypto extension is disabled.
 101
 102
 103 API Changes
 104 -----------
 105
 106 .. This section should contain API changes. Sample format:
 107
 108    * sample: Add a short 1-2 sentence description of the API change
 109      which was announced in the previous releases and made in this release.
 110      Start with a scope label like "ethdev:".
 111      Use fixed width quotes for ``function_names`` or ``struct_names``.
 112      Use 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 * The network structures, definitions and functions have
 119   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 120
 121
 122 ABI Changes
 123 -----------
 124
 125 .. This section should contain ABI changes. Sample format:
 126
 127    * sample: Add a short 1-2 sentence description of the ABI change
 128      which was announced in the previous releases and made in this release.
 129      Start with a scope label like "ethdev:".
 130      Use fixed width quotes for ``function_names`` or ``struct_names``.
 131      Use the past tense.
 132
 133    This section is a comment. Do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137
 138 Shared Library Versions
 139 -----------------------
 140
 141 .. Update any library version updated in this release
 142    and prepend with a ``+`` sign, like this:
 143
 144      libfoo.so.1
 145    + libupdated.so.2
 146      libbar.so.1
 147
 148    This section is a comment. Do not overwrite or remove it.
 149    =========================================================
 150
 151 The libraries prepended with a plus sign were incremented in this version.
 152
 153 .. code-block:: diff
 154
 155      librte_acl.so.2
 156      librte_bbdev.so.1
 157      librte_bitratestats.so.2
 158      librte_bpf.so.1
 159      librte_bus_dpaa.so.2
 160      librte_bus_fslmc.so.2
 161      librte_bus_ifpga.so.2
 162      librte_bus_pci.so.2
 163      librte_bus_vdev.so.2
 164      librte_bus_vmbus.so.2
 165      librte_cfgfile.so.2
 166      librte_cmdline.so.2
 167      librte_compressdev.so.1
 168      librte_cryptodev.so.7
 169      librte_distributor.so.1
 170      librte_eal.so.10
 171      librte_efd.so.1
 172      librte_ethdev.so.12
 173      librte_eventdev.so.6
 174      librte_flow_classify.so.1
 175      librte_gro.so.1
 176      librte_gso.so.1
 177      librte_hash.so.2
 178      librte_ip_frag.so.1
 179      librte_ipsec.so.1
 180      librte_jobstats.so.1
 181      librte_kni.so.2
 182      librte_kvargs.so.1
 183      librte_latencystats.so.1
 184      librte_lpm.so.2
 185      librte_mbuf.so.5
 186      librte_member.so.1
 187      librte_mempool.so.5
 188      librte_meter.so.3
 189      librte_metrics.so.1
 190      librte_net.so.1
 191      librte_pci.so.1
 192      librte_pdump.so.3
 193      librte_pipeline.so.3
 194      librte_pmd_bnxt.so.2
 195      librte_pmd_bond.so.2
 196      librte_pmd_i40e.so.2
 197      librte_pmd_ixgbe.so.2
 198      librte_pmd_dpaa2_qdma.so.1
 199      librte_pmd_ring.so.2
 200      librte_pmd_softnic.so.1
 201      librte_pmd_vhost.so.2
 202      librte_port.so.3
 203      librte_power.so.1
 204      librte_rawdev.so.1
 205      librte_rcu.so.1
 206      librte_reorder.so.1
 207      librte_ring.so.2
 208      librte_sched.so.2
 209      librte_security.so.2
 210      librte_stack.so.1
 211      librte_table.so.3
 212      librte_timer.so.1
 213      librte_vhost.so.4
 214
 215
 216 Known Issues
 217 ------------
 218
 219 .. This section should contain new known issues in this release. Sample format:
 220
 221    * **Add title in present tense with full stop.**
 222
 223      Add a short 1-2 sentence description of the known issue
 224      in the present tense. Add information on any known workarounds.
 225
 226    This section is a comment. Do not overwrite or remove it.
 227    Also, make sure to start the actual text at the margin.
 228    =========================================================
 229
 230
 231 Tested Platforms
 232 ----------------
 233
 234 .. This section should contain a list of platforms that were tested
 235    with this release.
 236
 237    The format is:
 238
 239    * <vendor> platform with <vendor> <type of devices> combinations
 240
 241      * List of CPU
 242      * List of OS
 243      * List of devices
 244      * Other relevant details...
 245
 246    This section is a comment. Do not overwrite or remove it.
 247    Also, make sure to start the actual text at the margin.
 248    =========================================================
 249