doc/guides/rel_notes/release_17_11.rst

   1 DPDK Release 17.11
   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_11.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 * **Extended port_id range from uint8_t to uint16_t.**
  45
  46   Increased port_id range from 8 bits to 16 bits in order to support more than
  47   256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
  48   in the meantime.
  49
  50 * **nfp: Added PF support.**
  51
  52   Previously Netronome's NFP PMD had just support for VFs. PF support is
  53   just as a basic DPDK port and has no VF management yet.
  54
  55   PF support comes with firmware upload support which allows the PMD to
  56   independently work from kernel netdev NFP drivers.
  57
  58   NFP 4000 devices are also now supported along with previous 6000 devices.
  59
  60 * **Updated bnxt PMD.**
  61
  62   Major enhancements include:
  63
  64    * Support for Flow API
  65    * Support for Tx and Rx descriptor status functions
  66
  67
  68 Resolved Issues
  69 ---------------
  70
  71 .. This section should contain bug fixes added to the relevant
  72    sections. Sample format:
  73
  74    * **code/section Fixed issue in the past tense with a full stop.**
  75
  76      Add a short 1-2 sentence description of the resolved issue in the past
  77      tense.
  78
  79      The title should contain the code/lib section like a commit message.
  80
  81      Add the entries in alphabetic order in the relevant sections below.
  82
  83    This section is a comment. do not overwrite or remove it.
  84    Also, make sure to start the actual text at the margin.
  85    =========================================================
  86
  87
  88 EAL
  89 ~~~
  90
  91 * **Service core fails to call service callback due to atomic lock**
  92
  93   In a specific configuration of multi-thread unsafe services and service
  94   cores, a service core previously did not correctly release the atomic lock
  95   on the service. This would result in the cores polling the service, but it
  96   looked like another thread was executing the service callback. The logic for
  97   atomic locking of the services has been fixed and refactored for readability.
  98
  99 Drivers
 100 ~~~~~~~
 101
 102
 103 Libraries
 104 ~~~~~~~~~
 105
 106
 107 Examples
 108 ~~~~~~~~
 109
 110
 111 Other
 112 ~~~~~
 113
 114
 115 Known Issues
 116 ------------
 117
 118 .. This section should contain new known issues in this release. Sample format:
 119
 120    * **Add title in present tense with full stop.**
 121
 122      Add a short 1-2 sentence description of the known issue in the present
 123      tense. Add information on any known workarounds.
 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 API Changes
 131 -----------
 132
 133 .. This section should contain API changes. Sample format:
 134
 135    * Add a short 1-2 sentence description of the API change. Use fixed width
 136      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 137      tense.
 138
 139    This section is a comment. do not overwrite or remove it.
 140    Also, make sure to start the actual text at the margin.
 141    =========================================================
 142
 143 * **Service cores API updated for usability**
 144
 145   The service cores API has been changed, removing pointers from the API
 146   where possible, instead using integer IDs to identify each service. This
 147   simplifed application code, aids debugging, and provides better
 148   encapsulation. A summary of the main changes made is as follows:
 149
 150   * Services identified by ID not by ``rte_service_spec`` pointer
 151   * Reduced API surface by using ``set`` functions instead of enable/disable
 152   * Reworked ``rte_service_register`` to provide the service ID to registrar
 153   * Rework start and stop APIs into ``rte_service_runstate_set``
 154   * Added API to set runstate of service implementation to indicate readyness
 155
 156
 157 ABI Changes
 158 -----------
 159
 160 .. This section should contain ABI changes. Sample format:
 161
 162    * Add a short 1-2 sentence description of the ABI change that was announced
 163      in the previous releases and made in this release. Use fixed width quotes
 164      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 165
 166    This section is a comment. do not overwrite or remove it.
 167    Also, make sure to start the actual text at the margin.
 168    =========================================================
 169
 170 * **Extended port_id range.**
 171
 172   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 173   changed, as described in the `New Features` section.
 174
 175 Shared Library Versions
 176 -----------------------
 177
 178 .. Update any library version updated in this release and prepend with a ``+``
 179    sign, like this:
 180
 181      librte_acl.so.2
 182    + librte_cfgfile.so.2
 183      librte_cmdline.so.2
 184
 185    This section is a comment. do not overwrite or remove it.
 186    =========================================================
 187
 188
 189 The libraries prepended with a plus sign were incremented in this version.
 190
 191 .. code-block:: diff
 192
 193      librte_acl.so.2
 194      librte_bitratestats.so.2
 195      librte_cfgfile.so.2
 196      librte_cmdline.so.2
 197      librte_cryptodev.so.3
 198      librte_distributor.so.1
 199      librte_eal.so.5
 200      librte_ethdev.so.8
 201      librte_eventdev.so.2
 202      librte_gro.so.1
 203      librte_hash.so.2
 204      librte_ip_frag.so.1
 205      librte_jobstats.so.1
 206      librte_kni.so.2
 207      librte_kvargs.so.1
 208      librte_latencystats.so.1
 209      librte_lpm.so.2
 210      librte_mbuf.so.3
 211      librte_mempool.so.2
 212      librte_meter.so.1
 213      librte_metrics.so.1
 214      librte_net.so.1
 215      librte_pdump.so.2
 216      librte_pipeline.so.3
 217      librte_pmd_bnxt.so.2
 218      librte_pmd_bond.so.2
 219      librte_pmd_i40e.so.2
 220      librte_pmd_ixgbe.so.2
 221      librte_pmd_ring.so.2
 222      librte_pmd_vhost.so.2
 223      librte_port.so.3
 224      librte_power.so.1
 225      librte_reorder.so.1
 226      librte_ring.so.1
 227      librte_sched.so.1
 228      librte_table.so.2
 229      librte_timer.so.1
 230      librte_vhost.so.3
 231
 232
 233 Tested Platforms
 234 ----------------
 235
 236 .. This section should contain a list of platforms that were tested with this
 237    release.
 238
 239    The format is:
 240
 241    * <vendor> platform with <vendor> <type of devices> combinations
 242
 243      * List of CPU
 244      * List of OS
 245      * List of devices
 246      * Other relevant details...
 247
 248    This section is a comment. do not overwrite or remove it.
 249    Also, make sure to start the actual text at the margin.
 250    =========================================================