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_08.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 Service Core functionality.**
46 The service core functionality added to EAL allows DPDK to run services such
47 as SW PMDs on lcores without the application manually running them. The
48 service core infrastructure allows flexibility of running multiple services
49 on the same service lcore, and provides the application with powerful APIs to
50 configure the mapping from service lcores to services.
52 * **Added Generic Receive Offload API.**
54 Generic Receive Offload (GRO) API supports to reassemble TCP/IPv4
55 packets. GRO API assumes all inputted packets are with correct
56 checksums. GRO API doesn't update checksums for merged packets. If
57 inputted packets are IP fragmented, GRO API assumes they are complete
58 packets (i.e. with L4 headers).
60 * **Added support for generic flow API (rte_flow) on igb NIC.**
62 This API provides a generic means to configure hardware to match specific
63 ingress or egress traffic, alter its behavior and query related counters
64 according to any number of user-defined rules.
66 * Generic flow API support for Ethernet, IPv4, UDP, TCP and
67 RAW pattern items with QUEUE actions. There are four
68 type of filter support for this feature on igb.
70 * **Added Generic Flow API support to enic.**
72 Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
73 and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
74 MARK, FLAG and VOID actions for ingress traffic.
76 * **Added support for Chelsio T6 family of adapters**
78 CXGBE PMD updated to run Chelsio T6 family of adapters.
80 * **Added latency and performance improvements for cxgbe**
82 TX and RX path reworked to improve performance. Also reduced latency
85 * **Updated bnxt PMD.**
87 Major enhancements include:
88 * Support MTU modification.
90 * Support VLAN filter and strip functionality.
91 * Other enhancements to add support for more dev_ops.
92 * Add PMD specific APIs mainly to control VF from PF.
93 * Update HWRM version to 1.7.7
95 * **Added support for Rx interrupts on mlx4 driver.**
97 Rx queues can be armed with an interrupt which will trigger on the
100 * **Updated szedata2 PMD.**
102 Added support for firmwares with multiple Ethernet ports per physical port.
104 * **Reorganized the symmetric crypto operation structure.**
106 The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
108 * Removed field ``rte_crypto_sym_op_sess_type``.
109 * Replaced pointer and physical address of IV with offset from the start
110 of the crypto operation.
111 * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
112 * Removed Additional Authentication Data (AAD) length.
113 * Removed digest length.
114 * Removed AAD pointer and physical address from ``auth`` structure.
115 * Added ``aead`` structure, containing parameters for AEAD algorithms.
117 * **Reorganized the crypto operation structure.**
119 The crypto operation (``rte_crypto_op``) has been reorganized as follows:
121 * Added field ``rte_crypto_op_sess_type``.
122 * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
123 have been modified to be uint8_t values.
124 * Removed the field ``opaque_data``.
125 * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
127 * **Reorganized the crypto symmetric session structure.**
129 The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
130 been reorganized as follows:
132 * ``dev_id`` field has been removed.
133 * ``driver_id`` field has been removed.
134 * Mempool pointer ``mp`` has been removed.
135 * Replaced ``private`` marker with array of pointers to private data sessions
136 ``sess_private_data``.
138 * **Updated cryptodev library.**
140 * Added AEAD algorithm specific functions and structures, so it is not
141 necessary to use a combination of cipher and authentication
143 * Added helper functions for crypto device driver identification.
144 * Added support for multi-device sessions, so a single session can be
145 used in multiple drivers.
146 * Added functions to initialize and free individual driver private data
149 * **Updated dpaa2_sec crypto PMD.**
151 Added support for AES-GCM and AES-CTR
153 * **Updated the AESNI MB PMD.**
155 The AESNI MB PMD has been updated with additional support for:
157 * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
159 * **Updated the AES-NI GCM PMD.**
161 The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
162 library, as the latter library has Scatter Gather List support
163 now. The migration entailed adding additional support for:
167 * **Updated the Cryptodev Scheduler PMD.**
169 Added a multicore based distribution mode, which distributes the enqueued
170 crypto operations among several slaves, running on different logical cores.
172 * **Added NXP DPAA2 Eventdev PMD.**
174 Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
175 "Event Device Drivers" document for more details on this new driver.
177 * **Added dpdk-test-eventdev test application.**
179 The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
180 that allows exercising various eventdev use cases.
181 This application has a generic framework to add new eventdev based test cases
182 to verify functionality and measure the performance parameters of DPDK
189 .. This section should contain bug fixes added to the relevant
190 sections. Sample format:
192 * **code/section Fixed issue in the past tense with a full stop.**
194 Add a short 1-2 sentence description of the resolved issue in the past
197 The title should contain the code/lib section like a commit message.
199 Add the entries in alphabetic order in the relevant sections below.
201 This section is a comment. do not overwrite or remove it.
202 Also, make sure to start the actual text at the margin.
203 =========================================================
229 .. This section should contain new known issues in this release. Sample format:
231 * **Add title in present tense with full stop.**
233 Add a short 1-2 sentence description of the known issue in the present
234 tense. Add information on any known workarounds.
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 =========================================================
244 .. This section should contain API changes. Sample format:
246 * Add a short 1-2 sentence description of the API change. Use fixed width
247 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
256 The function ``_rte_eth_dev_callback_process()`` has been modified. The return
257 value has been changed from void to int and an extra parameter ``void *ret_param``
260 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
262 * The following rte_ethdev library functions were removed:
264 * ``rte_eth_dev_bypass_event_show``
265 * ``rte_eth_dev_bypass_event_store``
266 * ``rte_eth_dev_bypass_init``
267 * ``rte_eth_dev_bypass_state_set``
268 * ``rte_eth_dev_bypass_state_show``
269 * ``rte_eth_dev_bypass_ver_show``
270 * ``rte_eth_dev_bypass_wd_reset``
271 * ``rte_eth_dev_bypass_wd_timeout_show``
272 * ``rte_eth_dev_wd_timeout_store``
274 * The following ixgbe PMD functions were added:
276 * ``rte_pmd_ixgbe_bypass_event_show``
277 * ``rte_pmd_ixgbe_bypass_event_store``
278 * ``rte_pmd_ixgbe_bypass_init``
279 * ``rte_pmd_ixgbe_bypass_state_set``
280 * ``rte_pmd_ixgbe_bypass_state_show``
281 * ``rte_pmd_ixgbe_bypass_ver_show``
282 * ``rte_pmd_ixgbe_bypass_wd_reset``
283 * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
284 * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
286 * **Reworked rte_cryptodev library.**
288 The rte_cryptodev library has been reworked and updated. The following changes
289 have been made to it:
291 * The crypto device type enumeration has been removed from cryptodev library.
292 * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
293 by the new function ``rte_crypto_count_by_driver()``.
294 * Moved crypto device driver names definitions to the particular PMDs.
295 These names are not public anymore.
296 * ``rte_cryptodev_configure()`` does not create the session mempool
297 for the device anymore.
298 * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
299 ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
300 the new parameter ``device id``.
301 * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
302 ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
303 * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
304 * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
305 * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
306 * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
307 * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
313 .. This section should contain ABI changes. Sample format:
315 * Add a short 1-2 sentence description of the ABI change that was announced
316 in the previous releases and made in this release. Use fixed width quotes
317 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
319 This section is a comment. do not overwrite or remove it.
320 Also, make sure to start the actual text at the margin.
321 =========================================================
323 * **Reorganized the crypto operation structures.**
325 Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
326 structures, as described in the `New Features`_ section.
328 * **Reorganized the crypto symmetric session structure.**
330 Some fields have been modified in the ``rte_cryptodev_sym_session``
331 structure, as described in the `New Features`_ section.
333 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
335 * Added cipher IV length and offset parameters.
336 * Changed field size of key length from size_t to uint16_t.
338 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
340 * Added authentication IV length and offset parameters.
341 * Changed field size of AAD length from uint32_t to uint16_t.
342 * Changed field size of digest length from uint32_t to uint16_t.
343 * Removed AAD length.
344 * Changed field size of key length from size_t to uint16_t.
346 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
347 ``rte_cryptodev_info`` and ``rte_cryptodev`` structures.
349 * Removed ``session_mp`` from ``rte_cryptodev_config``.
352 Shared Library Versions
353 -----------------------
355 .. Update any library version updated in this release and prepend with a ``+``
359 + librte_cfgfile.so.2
362 This section is a comment. do not overwrite or remove it.
363 =========================================================
366 The libraries prepended with a plus sign were incremented in this version.
371 librte_bitratestats.so.1
374 + librte_cryptodev.so.3
375 librte_distributor.so.1
384 librte_latencystats.so.1
408 .. This section should contain a list of platforms that were tested with this
413 * <vendor> platform with <vendor> <type of devices> combinations
418 * Other relevant details...
420 This section is a comment. do not overwrite or remove it.
421 Also, make sure to start the actual text at the margin.
422 =========================================================