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