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