doc/guides/rel_notes/release_18_02.rst

   1 DPDK Release 18.02
   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_02.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    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. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      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 the ixgbe ethernet driver to support RSS with flow API.**
  45
  46   Rte_flow actually defined to include RSS, but till now, RSS is out of
  47   rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
  48   configuration using rte_flow API.
  49
  50 * **Add MAC loopback support for i40e.**
  51
  52   Add MAC loopback support for i40e in order to support test task asked by
  53   users. According to the device configuration, it will setup TX->RX loopback
  54   link or not.
  55
  56 * **Add the support of run time determination of number of queues per i40e VF**
  57
  58   The number of queue per VF is determined by its host PF. If the PCI address
  59   of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
  60   with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
  61   1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
  62   per VF is 4 by default.
  63
  64 * **Added the i40e ethernet driver to support RSS with flow API.**
  65
  66   Rte_flow actually defined to include RSS, but till now, RSS is out of
  67   rte_flow. This patch is to support i40e NIC with existing RSS
  68   configuration using rte_flow API.It also enable queue region configuration
  69   using flow API for i40e.
  70
  71 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
  72
  73   Added support for NVGRE, VXLAN and GENEVE tunnels.
  74
  75   * Added support for UDP tunnel ports configuration.
  76   * Added tunneled packets classification.
  77   * Added inner checksum offload.
  78
  79 * **Added the igb ethernet driver to support RSS with flow API.**
  80
  81   Rte_flow actually defined to include RSS, but till now, RSS is out of
  82   rte_flow. This patch is to support igb NIC with existing RSS configuration
  83   using rte_flow API.
  84
  85 * **Add AVF (Adaptive Virtual Function) net PMD.**
  86
  87   A new net PMD has been added, which supports Intel® Ethernet Adaptive
  88   Virtual Function (AVF) with features list below:
  89
  90   * Basic Rx/Tx burst
  91   * SSE vectorized Rx/Tx burst
  92   * Promiscuous mode
  93   * MAC/VLAN offload
  94   * Checksum offload
  95   * TSO offload
  96   * Jumbo frame and MTU setting
  97   * RSS configuration
  98   * stats
  99   * Rx/Tx descriptor status
 100   * Link status update/event
 101
 102
 103 API Changes
 104 -----------
 105
 106 .. This section should contain API changes. Sample format:
 107
 108    * Add a short 1-2 sentence description of the API change. Use fixed width
 109      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 110      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 ABI Changes
 118 -----------
 119
 120 .. This section should contain ABI changes. Sample format:
 121
 122    * Add a short 1-2 sentence description of the ABI change that was announced
 123      in the previous releases and made in this release. Use fixed width quotes
 124      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 125
 126    This section is a comment. do not overwrite or remove it.
 127    Also, make sure to start the actual text at the margin.
 128    =========================================================
 129
 130
 131 Removed Items
 132 -------------
 133
 134 .. This section should contain removed items in this release. Sample format:
 135
 136    * Add a short 1-2 sentence description of the removed item in the past
 137      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 Known Issues
 145 ------------
 146
 147 .. This section should contain new known issues in this release. Sample format:
 148
 149    * **Add title in present tense with full stop.**
 150
 151      Add a short 1-2 sentence description of the known issue in the present
 152      tense. Add information on any known workarounds.
 153
 154    This section is a comment. do not overwrite or remove it.
 155    Also, make sure to start the actual text at the margin.
 156    =========================================================
 157
 158
 159 Shared Library Versions
 160 -----------------------
 161
 162 .. Update any library version updated in this release and prepend with a ``+``
 163    sign, like this:
 164
 165      librte_acl.so.2
 166    + librte_cfgfile.so.2
 167      librte_cmdline.so.2
 168
 169    This section is a comment. do not overwrite or remove it.
 170    =========================================================
 171
 172
 173 The libraries prepended with a plus sign were incremented in this version.
 174
 175 .. code-block:: diff
 176
 177      librte_acl.so.2
 178      librte_bitratestats.so.2
 179      librte_bus_dpaa.so.1
 180      librte_bus_fslmc.so.1
 181      librte_bus_pci.so.1
 182      librte_bus_vdev.so.1
 183      librte_cfgfile.so.2
 184      librte_cmdline.so.2
 185      librte_cryptodev.so.4
 186      librte_distributor.so.1
 187      librte_eal.so.6
 188      librte_ethdev.so.8
 189      librte_eventdev.so.3
 190      librte_flow_classify.so.1
 191      librte_gro.so.1
 192      librte_gso.so.1
 193      librte_hash.so.2
 194      librte_ip_frag.so.1
 195      librte_jobstats.so.1
 196      librte_kni.so.2
 197      librte_kvargs.so.1
 198      librte_latencystats.so.1
 199      librte_lpm.so.2
 200      librte_mbuf.so.3
 201      librte_mempool.so.3
 202      librte_meter.so.1
 203      librte_metrics.so.1
 204      librte_net.so.1
 205      librte_pci.so.1
 206      librte_pdump.so.2
 207      librte_pipeline.so.3
 208      librte_pmd_bnxt.so.2
 209      librte_pmd_bond.so.2
 210      librte_pmd_i40e.so.2
 211      librte_pmd_ixgbe.so.2
 212      librte_pmd_ring.so.2
 213      librte_pmd_softnic.so.1
 214      librte_pmd_vhost.so.2
 215      librte_port.so.3
 216      librte_power.so.1
 217      librte_reorder.so.1
 218      librte_ring.so.1
 219      librte_sched.so.1
 220      librte_security.so.1
 221      librte_table.so.3
 222      librte_timer.so.1
 223      librte_vhost.so.3
 224
 225
 226
 227 Tested Platforms
 228 ----------------
 229
 230 .. This section should contain a list of platforms that were tested with this
 231    release.
 232
 233    The format is:
 234
 235    * <vendor> platform with <vendor> <type of devices> combinations
 236
 237      * List of CPU
 238      * List of OS
 239      * List of devices
 240      * Other relevant details...
 241
 242    This section is a comment. do not overwrite or remove it.
 243    Also, make sure to start the actual text at the margin.
 244    =========================================================