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_11.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 * **Extended port_id range from uint8_t to uint16_t.**
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
50 * **Modified the return type of rte_eth_stats_reset.**
52 Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``
53 so the caller may know whether a device supports the operation or not
54 and if the operation was carried out.
56 * **Added a new driver for Marvell Armada 7k/8k devices.**
58 Added the new mrvl net driver for Marvell Armada 7k/8k devices. See the
59 "Network Interface Controller Drivers" document for more details on this new
62 * **Added SoftNIC PMD.**
64 Added new SoftNIC PMD. This virtual device offers applications a software
65 fallback support for traffic management.
67 * **nfp: Added PF support.**
69 Previously Netronome's NFP PMD had just support for VFs. PF support is
70 just as a basic DPDK port and has no VF management yet.
72 PF support comes with firmware upload support which allows the PMD to
73 independently work from kernel netdev NFP drivers.
75 NFP 4000 devices are also now supported along with previous 6000 devices.
77 * **Updated bnxt PMD.**
79 Major enhancements include:
81 * Support for Flow API
82 * Support for Tx and Rx descriptor status functions
84 * **Added IOMMU support to libvhost-user**
86 Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
89 * **Added Membership library (rte_member).**
91 Added membership library. It provides an API for DPDK applications to insert a
92 new member, delete an existing member, or query the existence of a member in a
93 given set, or a group of sets. For the case of a group of sets the library
94 will return not only whether the element has been inserted before in one of
95 the sets but also which set it belongs to.
97 The Membership Library is an extension and generalization of a traditional
98 filter (for example Bloom Filter) structure that has multiple usages in a wide
99 variety of workloads and applications. In general, the Membership Library is a
100 data structure that provides a “set-summary” and responds to set-membership
101 queries whether a certain member belongs to a set(s).
103 See the :ref:`Membership Library <Member_Library>` documentation in
104 the Programmers Guide document, for more information.
106 * **Added the Generic Segmentation Offload Library.**
108 Added the Generic Segmentation Offload (GSO) library to enable
109 applications to split large packets (e.g. MTU is 64KB) into small
110 ones (e.g. MTU is 1500B). Supported packet types are:
113 * VxLAN packets, which must have an outer IPv4 header, and contain
114 an inner TCP/IPv4 packet.
115 * GRE packets, which must contain an outer IPv4 header, and inner
118 The GSO library doesn't check if the input packets have correct
119 checksums, and doesn't update checksums for output packets.
120 Additionally, the GSO library doesn't process IP fragmented packets.
126 .. This section should contain bug fixes added to the relevant
127 sections. Sample format:
129 * **code/section Fixed issue in the past tense with a full stop.**
131 Add a short 1-2 sentence description of the resolved issue in the past
134 The title should contain the code/lib section like a commit message.
136 Add the entries in alphabetic order in the relevant sections below.
138 This section is a comment. do not overwrite or remove it.
139 Also, make sure to start the actual text at the margin.
140 =========================================================
146 * **Service core fails to call service callback due to atomic lock**
148 In a specific configuration of multi-thread unsafe services and service
149 cores, a service core previously did not correctly release the atomic lock
150 on the service. This would result in the cores polling the service, but it
151 looked like another thread was executing the service callback. The logic for
152 atomic locking of the services has been fixed and refactored for readability.
173 .. This section should contain new known issues in this release. Sample format:
175 * **Add title in present tense with full stop.**
177 Add a short 1-2 sentence description of the known issue in the present
178 tense. Add information on any known workarounds.
180 This section is a comment. do not overwrite or remove it.
181 Also, make sure to start the actual text at the margin.
182 =========================================================
188 .. This section should contain API changes. Sample format:
190 * Add a short 1-2 sentence description of the API change. Use fixed width
191 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
194 This section is a comment. do not overwrite or remove it.
195 Also, make sure to start the actual text at the margin.
196 =========================================================
198 * **Ethdev device name length increased**
200 The size of internal device name is increased to 64 characters
201 to allow for storing longer bus specific name.
203 * **Service cores API updated for usability**
205 The service cores API has been changed, removing pointers from the API
206 where possible, instead using integer IDs to identify each service. This
207 simplifed application code, aids debugging, and provides better
208 encapsulation. A summary of the main changes made is as follows:
210 * Services identified by ID not by ``rte_service_spec`` pointer
211 * Reduced API surface by using ``set`` functions instead of enable/disable
212 * Reworked ``rte_service_register`` to provide the service ID to registrar
213 * Rework start and stop APIs into ``rte_service_runstate_set``
214 * Added API to set runstate of service implementation to indicate readyness
216 * **The following changes made in mempool library**
218 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
219 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
220 and ``rte_mempool_generic_get`` API.
221 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
222 ``rte_mempool_xmem_usage``.
224 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
226 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
227 remove this API as Xen dom0 support was removed.
229 * **Add return value to stats_get dev op API**
231 The ``stats_get`` dev op API return value has been changed to be int.
232 By this way PMDs can return an error value in case of failure at stats
233 getting process time.
235 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
237 The function ``rte_cryptodev_allocate_driver()`` has been modified.
238 An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
244 .. This section should contain ABI changes. Sample format:
246 * Add a short 1-2 sentence description of the ABI change that was announced
247 in the previous releases and made in this release. Use fixed width quotes
248 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
250 This section is a comment. do not overwrite or remove it.
251 Also, make sure to start the actual text at the margin.
252 =========================================================
254 * **Extended port_id range.**
256 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
257 changed, as described in the `New Features` section.
259 Shared Library Versions
260 -----------------------
262 .. Update any library version updated in this release and prepend with a ``+``
266 + librte_cfgfile.so.2
269 This section is a comment. do not overwrite or remove it.
270 =========================================================
273 The libraries prepended with a plus sign were incremented in this version.
278 librte_bitratestats.so.2
281 librte_cryptodev.so.3
282 librte_distributor.so.1
293 librte_latencystats.so.1
305 librte_pmd_ixgbe.so.2
307 + librte_pmd_softnic.so.1
308 librte_pmd_vhost.so.2
322 .. This section should contain a list of platforms that were tested with this
327 * <vendor> platform with <vendor> <type of devices> combinations
332 * Other relevant details...
334 This section is a comment. do not overwrite or remove it.
335 Also, make sure to start the actual text at the margin.
336 =========================================================