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 * **Updated QAT crypto PMD.**
86 Performance enhancements:
88 * Removed atomics from the internal queue pair structure.
89 * Coalesce writes to HEAD CSR on response processing.
90 * Coalesce writes to TAIL CSR on request processing.
92 * **Updated the AESNI MB PMD.**
94 The AESNI MB PMD has been updated with additional support for:
97 * DES DOCSIS BPI algorithm.
99 This requires the IPSec Multi-buffer library 0.47. For more details,
100 check out the AESNI MB PMD documenation.
102 * **Updated the OpenSSL PMD.**
104 The OpenSSL PMD has been updated with additional support for:
108 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
110 Added new "PMD cyclecount" benchmark mode to dpdk-test-crypto-perf application
111 that displays more detailed breakdown of CPU cycles used by hardware
114 * **Added IOMMU support to libvhost-user**
116 Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
119 * **Added Membership library (rte_member).**
121 Added membership library. It provides an API for DPDK applications to insert a
122 new member, delete an existing member, or query the existence of a member in a
123 given set, or a group of sets. For the case of a group of sets the library
124 will return not only whether the element has been inserted before in one of
125 the sets but also which set it belongs to.
127 The Membership Library is an extension and generalization of a traditional
128 filter (for example Bloom Filter) structure that has multiple usages in a wide
129 variety of workloads and applications. In general, the Membership Library is a
130 data structure that provides a “set-summary” and responds to set-membership
131 queries whether a certain member belongs to a set(s).
133 See the :ref:`Membership Library <Member_Library>` documentation in
134 the Programmers Guide document, for more information.
136 * **Added the Generic Segmentation Offload Library.**
138 Added the Generic Segmentation Offload (GSO) library to enable
139 applications to split large packets (e.g. MTU is 64KB) into small
140 ones (e.g. MTU is 1500B). Supported packet types are:
143 * VxLAN packets, which must have an outer IPv4 header, and contain
144 an inner TCP/IPv4 packet.
145 * GRE packets, which must contain an outer IPv4 header, and inner
148 The GSO library doesn't check if the input packets have correct
149 checksums, and doesn't update checksums for output packets.
150 Additionally, the GSO library doesn't process IP fragmented packets.
156 .. This section should contain bug fixes added to the relevant
157 sections. Sample format:
159 * **code/section Fixed issue in the past tense with a full stop.**
161 Add a short 1-2 sentence description of the resolved issue in the past
164 The title should contain the code/lib section like a commit message.
166 Add the entries in alphabetic order in the relevant sections below.
168 This section is a comment. do not overwrite or remove it.
169 Also, make sure to start the actual text at the margin.
170 =========================================================
176 * **Service core fails to call service callback due to atomic lock**
178 In a specific configuration of multi-thread unsafe services and service
179 cores, a service core previously did not correctly release the atomic lock
180 on the service. This would result in the cores polling the service, but it
181 looked like another thread was executing the service callback. The logic for
182 atomic locking of the services has been fixed and refactored for readability.
203 .. This section should contain new known issues in this release. Sample format:
205 * **Add title in present tense with full stop.**
207 Add a short 1-2 sentence description of the known issue in the present
208 tense. Add information on any known workarounds.
210 This section is a comment. do not overwrite or remove it.
211 Also, make sure to start the actual text at the margin.
212 =========================================================
218 .. This section should contain API changes. Sample format:
220 * Add a short 1-2 sentence description of the API change. Use fixed width
221 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
224 This section is a comment. do not overwrite or remove it.
225 Also, make sure to start the actual text at the margin.
226 =========================================================
228 * **Ethdev device name length increased**
230 The size of internal device name is increased to 64 characters
231 to allow for storing longer bus specific name.
233 * **Service cores API updated for usability**
235 The service cores API has been changed, removing pointers from the API
236 where possible, instead using integer IDs to identify each service. This
237 simplifed application code, aids debugging, and provides better
238 encapsulation. A summary of the main changes made is as follows:
240 * Services identified by ID not by ``rte_service_spec`` pointer
241 * Reduced API surface by using ``set`` functions instead of enable/disable
242 * Reworked ``rte_service_register`` to provide the service ID to registrar
243 * Rework start and stop APIs into ``rte_service_runstate_set``
244 * Added API to set runstate of service implementation to indicate readyness
246 * **The following changes made in mempool library**
248 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
249 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
250 and ``rte_mempool_generic_get`` API.
251 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
252 ``rte_mempool_xmem_usage``.
254 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
256 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
257 remove this API as Xen dom0 support was removed.
259 * **Add return value to stats_get dev op API**
261 The ``stats_get`` dev op API return value has been changed to be int.
262 By this way PMDs can return an error value in case of failure at stats
263 getting process time.
265 * **Modified the rte_cryptodev_allocate_driver function in the cryptodev library.**
267 The function ``rte_cryptodev_allocate_driver()`` has been modified.
268 An extra parameter ``struct cryptodev_driver *crypto_drv`` has been added.
274 .. This section should contain ABI changes. Sample format:
276 * Add a short 1-2 sentence description of the ABI change that was announced
277 in the previous releases and made in this release. Use fixed width quotes
278 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
280 This section is a comment. do not overwrite or remove it.
281 Also, make sure to start the actual text at the margin.
282 =========================================================
284 * **Extended port_id range.**
286 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
287 changed, as described in the `New Features` section.
293 .. This section should contain removed items in this release. Sample format:
295 * Add a short 1-2 sentence description of the removed item in the past
298 This section is a comment. do not overwrite or remove it.
299 Also, make sure to start the actual text at the margin.
300 =========================================================
302 * The crypto performance unit tests have been removed,
303 replaced by the dpdk-test-crypto-perf application.
306 Shared Library Versions
307 -----------------------
309 .. Update any library version updated in this release and prepend with a ``+``
313 + librte_cfgfile.so.2
316 This section is a comment. do not overwrite or remove it.
317 =========================================================
320 The libraries prepended with a plus sign were incremented in this version.
325 librte_bitratestats.so.2
328 librte_cryptodev.so.3
329 librte_distributor.so.1
340 librte_latencystats.so.1
352 librte_pmd_ixgbe.so.2
354 + librte_pmd_softnic.so.1
355 librte_pmd_vhost.so.2
369 .. This section should contain a list of platforms that were tested with this
374 * <vendor> platform with <vendor> <type of devices> combinations
379 * Other relevant details...
381 This section is a comment. do not overwrite or remove it.
382 Also, make sure to start the actual text at the margin.
383 =========================================================