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