doc/guides/rel_notes/release_17_08.rst

   1 DPDK Release 17.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_17_08.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 support for generic flow API (rte_flow) on igb NIC.**
  45
  46   This API provides a generic means to configure hardware to match specific
  47   ingress or egress traffic, alter its behavior and query related counters
  48   according to any number of user-defined rules.
  49
  50   * Generic flow API support for Ethernet, IPv4, UDP, TCP and
  51     RAW pattern items with QUEUE actions. There are four
  52     type of filter support for this feature on igb.
  53
  54 * **Added Generic Flow API support to enic.**
  55
  56   Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
  57   and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
  58   MARK, FLAG and VOID actions for ingress traffic.
  59
  60 * **Added support for Chelsio T6 family of adapters**
  61
  62   CXGBE PMD updated to run Chelsio T6 family of adapters.
  63
  64 * **Added latency and performance improvements for cxgbe**
  65
  66   TX and RX path reworked to improve performance.  Also reduced latency
  67   for slow traffic.
  68
  69 * **Updated bnxt PMD.**
  70
  71   Major enhancements include:
  72   * Support MTU modification.
  73   * Support LRO.
  74   * Support VLAN filter and strip functionality.
  75   * Other enhancements to add support for more dev_ops.
  76   * Add PMD specific APIs mainly to control VF from PF.
  77   * Update HWRM version to 1.7.7
  78
  79 * **Added support for Rx interrupts on mlx4 driver.**
  80
  81   Rx queues can be armed with an interrupt which will trigger on the
  82   next packet arrival.
  83
  84 * **Updated szedata2 PMD.**
  85
  86   Added support for firmwares with multiple Ethernet ports per physical port.
  87
  88 * **Reorganized the symmetric crypto operation structure.**
  89
  90   The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
  91
  92   * Removed field ``rte_crypto_sym_op_sess_type``.
  93
  94 * **Reorganized the crypto operation structure.**
  95
  96   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
  97
  98   * Added field ``rte_crypto_op_sess_type``.
  99
 100
 101 Resolved Issues
 102 ---------------
 103
 104 .. This section should contain bug fixes added to the relevant
 105    sections. Sample format:
 106
 107    * **code/section Fixed issue in the past tense with a full stop.**
 108
 109      Add a short 1-2 sentence description of the resolved issue in the past
 110      tense.
 111
 112      The title should contain the code/lib section like a commit message.
 113
 114      Add the entries in alphabetic order in the relevant sections below.
 115
 116    This section is a comment. do not overwrite or remove it.
 117    Also, make sure to start the actual text at the margin.
 118    =========================================================
 119
 120
 121 EAL
 122 ~~~
 123
 124
 125 Drivers
 126 ~~~~~~~
 127
 128
 129 Libraries
 130 ~~~~~~~~~
 131
 132
 133 Examples
 134 ~~~~~~~~
 135
 136
 137 Other
 138 ~~~~~
 139
 140
 141 Known Issues
 142 ------------
 143
 144 .. This section should contain new known issues in this release. Sample format:
 145
 146    * **Add title in present tense with full stop.**
 147
 148      Add a short 1-2 sentence description of the known issue in the present
 149      tense. Add information on any known workarounds.
 150
 151    This section is a comment. do not overwrite or remove it.
 152    Also, make sure to start the actual text at the margin.
 153    =========================================================
 154
 155
 156 API Changes
 157 -----------
 158
 159 .. This section should contain API changes. Sample format:
 160
 161    * Add a short 1-2 sentence description of the API change. Use fixed width
 162      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 163      tense.
 164
 165    This section is a comment. do not overwrite or remove it.
 166    Also, make sure to start the actual text at the margin.
 167    =========================================================
 168
 169
 170 ABI Changes
 171 -----------
 172
 173 .. This section should contain ABI changes. Sample format:
 174
 175    * Add a short 1-2 sentence description of the ABI change that was announced
 176      in the previous releases and made in this release. Use fixed width quotes
 177      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 178
 179    This section is a comment. do not overwrite or remove it.
 180    Also, make sure to start the actual text at the margin.
 181    =========================================================
 182
 183 * **Reorganized the crypto operation structures.**
 184
 185   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 186   structures, as described in the `New Features`_ section.
 187
 188
 189 Shared Library Versions
 190 -----------------------
 191
 192 .. Update any library version updated in this release and prepend with a ``+``
 193    sign, like this:
 194
 195      librte_acl.so.2
 196    + librte_cfgfile.so.2
 197      librte_cmdline.so.2
 198
 199    This section is a comment. do not overwrite or remove it.
 200    =========================================================
 201
 202
 203 The libraries prepended with a plus sign were incremented in this version.
 204
 205 .. code-block:: diff
 206
 207      librte_acl.so.2
 208      librte_bitratestats.so.1
 209      librte_cfgfile.so.2
 210      librte_cmdline.so.2
 211    + librte_cryptodev.so.3
 212      librte_distributor.so.1
 213      librte_eal.so.4
 214      librte_ethdev.so.6
 215      librte_hash.so.2
 216      librte_ip_frag.so.1
 217      librte_jobstats.so.1
 218      librte_kni.so.2
 219      librte_kvargs.so.1
 220      librte_latencystats.so.1
 221      librte_lpm.so.2
 222      librte_mbuf.so.3
 223      librte_mempool.so.2
 224      librte_meter.so.1
 225      librte_metrics.so.1
 226      librte_net.so.1
 227      librte_pdump.so.1
 228      librte_pipeline.so.3
 229      librte_pmd_bond.so.1
 230      librte_pmd_ring.so.2
 231      librte_port.so.3
 232      librte_power.so.1
 233      librte_reorder.so.1
 234      librte_ring.so.1
 235      librte_sched.so.1
 236      librte_table.so.2
 237      librte_timer.so.1
 238      librte_vhost.so.3
 239
 240
 241 Tested Platforms
 242 ----------------
 243
 244 .. This section should contain a list of platforms that were tested with this
 245    release.
 246
 247    The format is:
 248
 249    * <vendor> platform with <vendor> <type of devices> combinations
 250
 251      * List of CPU
 252      * List of OS
 253      * List of devices
 254      * Other relevant details...
 255
 256    This section is a comment. do not overwrite or remove it.
 257    Also, make sure to start the actual text at the margin.
 258    =========================================================