4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_17_05.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
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.
32 If the feature adds a lot of sub-features you can use a bullet list like
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
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 =========================================================
44 * **Added free Tx mbuf on demand API.**
46 Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
47 to request the driver to release mbufs from their Tx ring that are no longer
48 in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
50 * **Added descriptor status ethdev API.**
52 Added a new API to get the status of a descriptor.
54 For Rx, it is almost similar to the ``rx_descriptor_done`` API, except
55 it differentiates descriptors which are hold by the driver and not
56 returned to the hardware. For Tx, it is a new API.
58 * **Increased number of next hops for LPM IPv6 to 2^21.**
60 The next_hop field is extended from 8 bits to 21 bits for IPv6.
62 * **Added VFIO hotplug support.**
64 How hotplug supported with UIO and VFIO drivers.
66 * **Added powerpc support in pci probing for vfio-pci devices.**
68 sPAPR IOMMU based pci probing enabled for vfio-pci devices.
70 * **Updated the ixgbe base driver.**
72 Updated the ixgbe base driver, including the following changes:
74 * Add link block check for KR.
75 * Complete HW initialization even if SFP is not present.
76 * Add VF xcast promiscuous mode.
78 * **Added powerpc support for i40e and its vector PMD .**
80 i40e PMD and its vector PMD enabled by default in powerpc.
82 * **Added TSO support for tunneled and non-tunneled packets on mlx5 driver.**
84 Added support for Hardware TSO for tunneled and non-tunneled packets.
85 Tunneling protocols supported are GRE and VXLAN.
87 * **Added support for Rx interrupts on mlx5 driver.**
89 Rx queues can be armed with an interrupt which will trigger on the
92 * **Updated the sfc_efx driver.**
94 * Generic flow API support for Ethernet, VLAN, IPv4, IPv6, UDP and TCP
95 pattern items with QUEUE action for ingress traffic.
97 * Support virtual functions (VFs)
99 * **Added LiquidIO network PMD.**
101 Added poll mode driver support for Cavium LiquidIO II server adapter VFs.
103 * **Added vmxnet3 version 3 support.**
105 Added support for vmxnet3 version 3 which includes several
106 performance enhancements viz. configurable TX data ring, Receive
107 Data Ring, ability to register memory regions.
113 .. This section should contain bug fixes added to the relevant
114 sections. Sample format:
116 * **code/section Fixed issue in the past tense with a full stop.**
118 Add a short 1-2 sentence description of the resolved issue in the past
121 The title should contain the code/lib section like a commit message.
123 Add the entries in alphabetic order in the relevant sections below.
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 =========================================================
153 .. This section should contain new known issues in this release. Sample format:
155 * **Add title in present tense with full stop.**
157 Add a short 1-2 sentence description of the known issue in the present
158 tense. Add information on any known workarounds.
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 =========================================================
168 .. This section should contain API changes. Sample format:
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
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 =========================================================
178 * The LPM ``next_hop`` field is extended from 8 bits to 21 bits for IPv6
179 while keeping ABI compatibility.
181 * **Reworked rte_ring library**
183 The rte_ring library has been reworked and updated. The following changes
184 have been made to it:
186 * removed the build-time setting ``CONFIG_RTE_RING_SPLIT_PROD_CONS``
187 * removed the build-time setting ``CONFIG_RTE_LIBRTE_RING_DEBUG``
188 * removed the build-time setting ``CONFIG_RTE_RING_PAUSE_REP_COUNT``
189 * removed the function ``rte_ring_set_water_mark`` as part of a general
190 removal of watermarks support in the library.
191 * added an extra parameter to the burst/bulk enqueue functions to
192 return the number of free spaces in the ring after enqueue. This can
193 be used by an application to implement its own watermark functionality.
194 * added an extra parameter to the burst/bulk dequeue functions to return
195 the number elements remaining in the ring after dequeue.
196 * changed the return value of the enqueue and dequeue bulk functions to
197 match that of the burst equivalents. In all cases, ring functions which
198 operate on multiple packets now return the number of elements enqueued
199 or dequeued, as appropriate. The updated functions are:
201 - ``rte_ring_mp_enqueue_bulk``
202 - ``rte_ring_sp_enqueue_bulk``
203 - ``rte_ring_enqueue_bulk``
204 - ``rte_ring_mc_dequeue_bulk``
205 - ``rte_ring_sc_dequeue_bulk``
206 - ``rte_ring_dequeue_bulk``
208 NOTE: the above functions all have different parameters as well as
209 different return values, due to the other listed changes above. This
210 means that all instances of the functions in existing code will be
211 flagged by the compiler. The return value usage should be checked
212 while fixing the compiler error due to the extra parameter.
217 .. This section should contain ABI changes. Sample format:
219 * Add a short 1-2 sentence description of the ABI change that was announced
220 in the previous releases and made in this release. Use fixed width quotes
221 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
223 This section is a comment. do not overwrite or remove it.
224 Also, make sure to start the actual text at the margin.
225 =========================================================
231 .. This section should contain removed items in this release. Sample format:
233 * Add a short 1-2 sentence description of the removed item in the past
236 This section is a comment. do not overwrite or remove it.
237 Also, make sure to start the actual text at the margin.
238 =========================================================
240 * KNI vhost support removed.
243 Shared Library Versions
244 -----------------------
246 .. Update any library version updated in this release and prepend with a ``+``
250 + librte_cfgfile.so.2
253 This section is a comment. do not overwrite or remove it.
254 =========================================================
257 The libraries prepended with a plus sign were incremented in this version.
264 librte_cryptodev.so.2
265 librte_distributor.so.1
295 .. This section should contain a list of platforms that were tested with this
300 * <vendor> platform with <vendor> <type of devices> combinations
305 * Other relevant details...
307 This section is a comment. do not overwrite or remove it.
308 Also, make sure to start the actual text at the margin.
309 =========================================================