doc/guides/rel_notes/release_18_08.rst

   1 DPDK Release 18.08
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_18_08.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release.
  24    Sample format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense.
  29      The description should be enough to allow someone scanning
  30      the release notes to understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list
  33      like this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. Do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Added Flow API support for CXGBE PMD.**
  45
  46   Flow API support has been added to CXGBE Poll Mode Driver to offload
  47   flows to Chelsio T5/T6 NICs.
  48
  49 * **Added ixgbe preferred Rx/Tx parameters.**
  50
  51   Rather than applications providing explicit Rx and Tx parameters such as
  52   queue and burst sizes, they can request that the EAL instead uses preferred
  53   values provided by the PMD, falling back to defaults within the EAL if the
  54   PMD does not provide any. The provision of such tuned values now includes
  55   the ixgbe PMD.
  56
  57 * **Added descriptor status check support for fm10k.**
  58
  59   ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
  60   are supported by fm10K.
  61
  62 * **Updated the enic driver.**
  63
  64   * Add support for mbuf fast free offload.
  65   * Add low cycle count Tx handler for no-offload Tx (except mbuf fast free).
  66   * Add low cycle count Rx handler for non-scattered Rx.
  67   * Minor performance improvements to scattered Rx handler.
  68   * Add handlers to add/delete VxLAN port number.
  69   * Add devarg to specify ingress VLAN rewrite mode.
  70
  71
  72 API Changes
  73 -----------
  74
  75 .. This section should contain API changes. Sample format:
  76
  77    * Add a short 1-2 sentence description of the API change.
  78      Use fixed width quotes for ``function_names`` or ``struct_names``.
  79      Use the past tense.
  80
  81    This section is a comment. Do not overwrite or remove it.
  82    Also, make sure to start the actual text at the margin.
  83    =========================================================
  84
  85 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
  86   has been replaced with field ``struct rte_device *device``.
  87   Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
  88   supports an unlimited number of sessions.
  89
  90 * cryptodev: Following functions were deprecated and are removed in 18.08:
  91
  92   - ``rte_cryptodev_queue_pair_start``
  93   - ``rte_cryptodev_queue_pair_stop``
  94
  95 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
  96   replaced with the following more explicit flags:
  97   - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
  98   - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
  99   - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
 100
 101
 102 ABI Changes
 103 -----------
 104
 105 .. This section should contain ABI changes. Sample format:
 106
 107    * Add a short 1-2 sentence description of the ABI change
 108      that was announced in the previous releases and made in this release.
 109      Use fixed width quotes for ``function_names`` or ``struct_names``.
 110      Use the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =========================================================
 115
 116
 117 Removed Items
 118 -------------
 119
 120 .. This section should contain removed items in this release. Sample format:
 121
 122    * Add a short 1-2 sentence description of the removed item
 123      in the past tense.
 124
 125    This section is a comment. Do not overwrite or remove it.
 126    Also, make sure to start the actual text at the margin.
 127    =========================================================
 128
 129
 130 Shared Library Versions
 131 -----------------------
 132
 133 .. Update any library version updated in this release
 134    and prepend with a ``+`` sign, like this:
 135
 136      librte_acl.so.2
 137    + librte_cfgfile.so.2
 138      librte_cmdline.so.2
 139
 140    This section is a comment. Do not overwrite or remove it.
 141    =========================================================
 142
 143 The libraries prepended with a plus sign were incremented in this version.
 144
 145 .. code-block:: diff
 146
 147      librte_acl.so.2
 148      librte_bbdev.so.1
 149      librte_bitratestats.so.2
 150      librte_bpf.so.1
 151      librte_bus_dpaa.so.1
 152      librte_bus_fslmc.so.1
 153      librte_bus_pci.so.1
 154      librte_bus_vdev.so.1
 155      librte_cfgfile.so.2
 156      librte_cmdline.so.2
 157      librte_common_octeontx.so.1
 158      librte_compressdev.so.1
 159    + librte_cryptodev.so.5
 160      librte_distributor.so.1
 161      librte_eal.so.7
 162      librte_ethdev.so.9
 163      librte_eventdev.so.4
 164      librte_flow_classify.so.1
 165      librte_gro.so.1
 166      librte_gso.so.1
 167      librte_hash.so.2
 168      librte_ip_frag.so.1
 169      librte_jobstats.so.1
 170      librte_kni.so.2
 171      librte_kvargs.so.1
 172      librte_latencystats.so.1
 173      librte_lpm.so.2
 174      librte_mbuf.so.4
 175      librte_mempool.so.4
 176      librte_meter.so.2
 177      librte_metrics.so.1
 178      librte_net.so.1
 179      librte_pci.so.1
 180      librte_pdump.so.2
 181      librte_pipeline.so.3
 182      librte_pmd_bnxt.so.2
 183      librte_pmd_bond.so.2
 184      librte_pmd_i40e.so.2
 185      librte_pmd_ixgbe.so.2
 186      librte_pmd_dpaa2_cmdif.so.1
 187      librte_pmd_dpaa2_qdma.so.1
 188      librte_pmd_ring.so.2
 189      librte_pmd_softnic.so.1
 190      librte_pmd_vhost.so.2
 191      librte_port.so.3
 192      librte_power.so.1
 193      librte_rawdev.so.1
 194      librte_reorder.so.1
 195      librte_ring.so.2
 196      librte_sched.so.1
 197      librte_security.so.1
 198      librte_table.so.3
 199      librte_timer.so.1
 200      librte_vhost.so.3
 201
 202
 203 Known Issues
 204 ------------
 205
 206 .. This section should contain new known issues in this release. Sample format:
 207
 208    * **Add title in present tense with full stop.**
 209
 210      Add a short 1-2 sentence description of the known issue
 211      in the present tense. Add information on any known workarounds.
 212
 213    This section is a comment. Do not overwrite or remove it.
 214    Also, make sure to start the actual text at the margin.
 215    =========================================================
 216
 217
 218 Tested Platforms
 219 ----------------
 220
 221 .. This section should contain a list of platforms that were tested
 222    with this release.
 223
 224    The format is:
 225
 226    * <vendor> platform with <vendor> <type of devices> combinations
 227
 228      * List of CPU
 229      * List of OS
 230      * List of devices
 231      * Other relevant details...
 232
 233    This section is a comment. Do not overwrite or remove it.
 234    Also, make sure to start the actual text at the margin.
 235    =========================================================