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   * Replaced pointer and physical address of IV with offset from the start
  94     of the crypto operation.
  95   * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
  96   * Removed Additional Authentication Data (AAD) length.
  97
  98 * **Reorganized the crypto operation structure.**
  99
 100   The crypto operation (``rte_crypto_op``) has been reorganized as follows:
 101
 102   * Added field ``rte_crypto_op_sess_type``.
 103   * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
 104     have been modified to be uint8_t values.
 105   * Removed the field ``opaque_data``.
 106   * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
 107
 108
 109 Resolved Issues
 110 ---------------
 111
 112 .. This section should contain bug fixes added to the relevant
 113    sections. Sample format:
 114
 115    * **code/section Fixed issue in the past tense with a full stop.**
 116
 117      Add a short 1-2 sentence description of the resolved issue in the past
 118      tense.
 119
 120      The title should contain the code/lib section like a commit message.
 121
 122      Add the entries in alphabetic order in the relevant sections below.
 123
 124    This section is a comment. do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =========================================================
 127
 128
 129 EAL
 130 ~~~
 131
 132
 133 Drivers
 134 ~~~~~~~
 135
 136
 137 Libraries
 138 ~~~~~~~~~
 139
 140
 141 Examples
 142 ~~~~~~~~
 143
 144
 145 Other
 146 ~~~~~
 147
 148
 149 Known Issues
 150 ------------
 151
 152 .. This section should contain new known issues in this release. Sample format:
 153
 154    * **Add title in present tense with full stop.**
 155
 156      Add a short 1-2 sentence description of the known issue in the present
 157      tense. Add information on any known workarounds.
 158
 159    This section is a comment. do not overwrite or remove it.
 160    Also, make sure to start the actual text at the margin.
 161    =========================================================
 162
 163
 164 API Changes
 165 -----------
 166
 167 .. This section should contain API changes. Sample format:
 168
 169    * Add a short 1-2 sentence description of the API change. Use fixed width
 170      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 171      tense.
 172
 173    This section is a comment. do not overwrite or remove it.
 174    Also, make sure to start the actual text at the margin.
 175    =========================================================
 176
 177
 178 ABI Changes
 179 -----------
 180
 181 .. This section should contain ABI changes. Sample format:
 182
 183    * Add a short 1-2 sentence description of the ABI change that was announced
 184      in the previous releases and made in this release. Use fixed width quotes
 185      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 186
 187    This section is a comment. do not overwrite or remove it.
 188    Also, make sure to start the actual text at the margin.
 189    =========================================================
 190
 191 * **Reorganized the crypto operation structures.**
 192
 193   Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
 194   structures, as described in the `New Features`_ section.
 195
 196 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
 197
 198   * Added cipher IV length and offset parameters.
 199
 200 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
 201
 202   * Added authentication IV length and offset parameters.
 203   * Changed field size of AAD length from uint32_t to uint16_t.
 204
 205
 206 Shared Library Versions
 207 -----------------------
 208
 209 .. Update any library version updated in this release and prepend with a ``+``
 210    sign, like this:
 211
 212      librte_acl.so.2
 213    + librte_cfgfile.so.2
 214      librte_cmdline.so.2
 215
 216    This section is a comment. do not overwrite or remove it.
 217    =========================================================
 218
 219
 220 The libraries prepended with a plus sign were incremented in this version.
 221
 222 .. code-block:: diff
 223
 224      librte_acl.so.2
 225      librte_bitratestats.so.1
 226      librte_cfgfile.so.2
 227      librte_cmdline.so.2
 228    + librte_cryptodev.so.3
 229      librte_distributor.so.1
 230      librte_eal.so.4
 231      librte_ethdev.so.6
 232      librte_hash.so.2
 233      librte_ip_frag.so.1
 234      librte_jobstats.so.1
 235      librte_kni.so.2
 236      librte_kvargs.so.1
 237      librte_latencystats.so.1
 238      librte_lpm.so.2
 239      librte_mbuf.so.3
 240      librte_mempool.so.2
 241      librte_meter.so.1
 242      librte_metrics.so.1
 243      librte_net.so.1
 244      librte_pdump.so.1
 245      librte_pipeline.so.3
 246      librte_pmd_bond.so.1
 247      librte_pmd_ring.so.2
 248      librte_port.so.3
 249      librte_power.so.1
 250      librte_reorder.so.1
 251      librte_ring.so.1
 252      librte_sched.so.1
 253      librte_table.so.2
 254      librte_timer.so.1
 255      librte_vhost.so.3
 256
 257
 258 Tested Platforms
 259 ----------------
 260
 261 .. This section should contain a list of platforms that were tested with this
 262    release.
 263
 264    The format is:
 265
 266    * <vendor> platform with <vendor> <type of devices> combinations
 267
 268      * List of CPU
 269      * List of OS
 270      * List of devices
 271      * Other relevant details...
 272
 273    This section is a comment. do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================