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 mlx5 driver.**
102 Updated the mlx5 driver, include the following changes:
104 * Added vectorized Rx/Tx burst for x86.
105 * Added support for isolated mode from flow API.
106 * Re-worked flow drop action to implement in hardware classifier.
107 * Improved Rx interrupts management.
109 * **Updated szedata2 PMD.**
111 Added support for firmwares with multiple Ethernet ports per physical port.
113 * **Updated dpaa2 PMD.**
115 Major enhancements include:
116 * Support MAC Filter configuration
117 * Support Segmented Buffers
118 * Support VLAN filter and strip functionality.
119 * Other enhancements to add support for more dev_ops.
120 * Optimized the packet receive path
122 * **Reorganized the symmetric crypto operation structure.**
124 The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
126 * Removed field ``rte_crypto_sym_op_sess_type``.
127 * Replaced pointer and physical address of IV with offset from the start
128 of the crypto operation.
129 * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
130 * Removed Additional Authentication Data (AAD) length.
131 * Removed digest length.
132 * Removed AAD pointer and physical address from ``auth`` structure.
133 * Added ``aead`` structure, containing parameters for AEAD algorithms.
135 * **Reorganized the crypto operation structure.**
137 The crypto operation (``rte_crypto_op``) has been reorganized as follows:
139 * Added field ``rte_crypto_op_sess_type``.
140 * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
141 have been modified to be uint8_t values.
142 * Removed the field ``opaque_data``.
143 * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
145 * **Reorganized the crypto symmetric session structure.**
147 The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
148 been reorganized as follows:
150 * ``dev_id`` field has been removed.
151 * ``driver_id`` field has been removed.
152 * Mempool pointer ``mp`` has been removed.
153 * Replaced ``private`` marker with array of pointers to private data sessions
154 ``sess_private_data``.
156 * **Updated cryptodev library.**
158 * Added AEAD algorithm specific functions and structures, so it is not
159 necessary to use a combination of cipher and authentication
161 * Added helper functions for crypto device driver identification.
162 * Added support for multi-device sessions, so a single session can be
163 used in multiple drivers.
164 * Added functions to initialize and free individual driver private data
167 * **Updated dpaa2_sec crypto PMD.**
169 Added support for AES-GCM and AES-CTR
171 * **Updated the AESNI MB PMD.**
173 The AESNI MB PMD has been updated with additional support for:
175 * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
177 * **Updated the AES-NI GCM PMD.**
179 The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
180 library, as the latter library has Scatter Gather List support
181 now. The migration entailed adding additional support for:
185 * **Updated the Cryptodev Scheduler PMD.**
187 Added a multicore based distribution mode, which distributes the enqueued
188 crypto operations among several slaves, running on different logical cores.
190 * **Added NXP DPAA2 Eventdev PMD.**
192 Added the new dpaa2 eventdev driver for NXP DPAA2 devices. See the
193 "Event Device Drivers" document for more details on this new driver.
195 * **Added dpdk-test-eventdev test application.**
197 The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
198 that allows exercising various eventdev use cases.
199 This application has a generic framework to add new eventdev based test cases
200 to verify functionality and measure the performance parameters of DPDK
207 .. This section should contain bug fixes added to the relevant
208 sections. Sample format:
210 * **code/section Fixed issue in the past tense with a full stop.**
212 Add a short 1-2 sentence description of the resolved issue in the past
215 The title should contain the code/lib section like a commit message.
217 Add the entries in alphabetic order in the relevant sections below.
219 This section is a comment. do not overwrite or remove it.
220 Also, make sure to start the actual text at the margin.
221 =========================================================
247 .. This section should contain new known issues in this release. Sample format:
249 * **Add title in present tense with full stop.**
251 Add a short 1-2 sentence description of the known issue in the present
252 tense. Add information on any known workarounds.
254 This section is a comment. do not overwrite or remove it.
255 Also, make sure to start the actual text at the margin.
256 =========================================================
262 .. This section should contain API changes. Sample format:
264 * Add a short 1-2 sentence description of the API change. Use fixed width
265 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
268 This section is a comment. do not overwrite or remove it.
269 Also, make sure to start the actual text at the margin.
270 =========================================================
272 * **Modified the _rte_eth_dev_callback_process function in the ethdev library.**
274 The function ``_rte_eth_dev_callback_process()`` has been modified. The return
275 value has been changed from void to int and an extra parameter ``void *ret_param``
278 * **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
280 * The following rte_ethdev library functions were removed:
282 * ``rte_eth_dev_bypass_event_show``
283 * ``rte_eth_dev_bypass_event_store``
284 * ``rte_eth_dev_bypass_init``
285 * ``rte_eth_dev_bypass_state_set``
286 * ``rte_eth_dev_bypass_state_show``
287 * ``rte_eth_dev_bypass_ver_show``
288 * ``rte_eth_dev_bypass_wd_reset``
289 * ``rte_eth_dev_bypass_wd_timeout_show``
290 * ``rte_eth_dev_wd_timeout_store``
292 * The following ixgbe PMD functions were added:
294 * ``rte_pmd_ixgbe_bypass_event_show``
295 * ``rte_pmd_ixgbe_bypass_event_store``
296 * ``rte_pmd_ixgbe_bypass_init``
297 * ``rte_pmd_ixgbe_bypass_state_set``
298 * ``rte_pmd_ixgbe_bypass_state_show``
299 * ``rte_pmd_ixgbe_bypass_ver_show``
300 * ``rte_pmd_ixgbe_bypass_wd_reset``
301 * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
302 * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
304 * **Reworked rte_cryptodev library.**
306 The rte_cryptodev library has been reworked and updated. The following changes
307 have been made to it:
309 * The crypto device type enumeration has been removed from cryptodev library.
310 * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
311 by the new function ``rte_crypto_count_by_driver()``.
312 * Moved crypto device driver names definitions to the particular PMDs.
313 These names are not public anymore.
314 * ``rte_cryptodev_configure()`` does not create the session mempool
315 for the device anymore.
316 * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
317 ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
318 the new parameter ``device id``.
319 * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
320 ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
321 * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
322 * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
323 * Removed ``aad_size`` parameter from ``rte_cryptodev_sym_capability_check_auth()``.
324 * Added ``iv_size`` parameter to ``rte_cryptodev_sym_capability_check_auth()``.
325 * Removed ``RTE_CRYPTO_OP_STATUS_ENQUEUED`` from enum ``rte_crypto_op_status``.
331 .. This section should contain ABI changes. Sample format:
333 * Add a short 1-2 sentence description of the ABI change that was announced
334 in the previous releases and made in this release. Use fixed width quotes
335 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
337 This section is a comment. do not overwrite or remove it.
338 Also, make sure to start the actual text at the margin.
339 =========================================================
341 * **Reorganized the crypto operation structures.**
343 Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
344 structures, as described in the `New Features`_ section.
346 * **Reorganized the crypto symmetric session structure.**
348 Some fields have been modified in the ``rte_cryptodev_sym_session``
349 structure, as described in the `New Features`_ section.
351 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
353 * Added cipher IV length and offset parameters.
354 * Changed field size of key length from size_t to uint16_t.
356 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
358 * Added authentication IV length and offset parameters.
359 * Changed field size of AAD length from uint32_t to uint16_t.
360 * Changed field size of digest length from uint32_t to uint16_t.
361 * Removed AAD length.
362 * Changed field size of key length from size_t to uint16_t.
364 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
365 ``rte_cryptodev_info`` and ``rte_cryptodev`` structures.
367 * Removed ``session_mp`` from ``rte_cryptodev_config``.
370 Shared Library Versions
371 -----------------------
373 .. Update any library version updated in this release and prepend with a ``+``
377 + librte_cfgfile.so.2
380 This section is a comment. do not overwrite or remove it.
381 =========================================================
384 The libraries prepended with a plus sign were incremented in this version.
389 librte_bitratestats.so.1
392 + librte_cryptodev.so.3
393 librte_distributor.so.1
402 librte_latencystats.so.1
426 .. This section should contain a list of platforms that were tested with this
431 * <vendor> platform with <vendor> <type of devices> combinations
436 * Other relevant details...
438 This section is a comment. do not overwrite or remove it.
439 Also, make sure to start the actual text at the margin.
440 =========================================================
442 * Intel(R) platforms with Mellanox(R) NICs combinations
446 * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
447 * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
448 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
449 * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
453 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
454 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
459 * MLNX_OFED: 4.1-1.0.2.0
463 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
465 * Host interface: PCI Express 3.0 x8
466 * Device ID: 15b3:1007
467 * Firmware version: 2.40.5030
469 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
471 * Host interface: PCI Express 3.0 x8
472 * Device ID: 15b3:1013
473 * Firmware version: 12.18.2000
475 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
477 * Host interface: PCI Express 3.0 x8
478 * Device ID: 15b3:1013
479 * Firmware version: 12.18.2000
481 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
483 * Host interface: PCI Express 3.0 x8
484 * Device ID: 15b3:1013
485 * Firmware version: 12.18.2000
487 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
489 * Host interface: PCI Express 3.0 x8
490 * Device ID: 15b3:1013
491 * Firmware version: 12.18.2000
493 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
495 * Host interface: PCI Express 3.0 x8
496 * Device ID: 15b3:1013
497 * Firmware version: 12.18.2000
499 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
501 * Host interface: PCI Express 3.0 x16
502 * Device ID: 15b3:1013
503 * Firmware version: 12.18.2000
505 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
507 * Host interface: PCI Express 3.0 x8
508 * Device ID: 15b3:1013
509 * Firmware version: 12.18.2000
511 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
513 * Host interface: PCI Express 3.0 x8
514 * Device ID: 15b3:1013
515 * Firmware version: 12.18.2000
517 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
519 * Host interface: PCI Express 3.0 x16
520 * Device ID: 15b3:1013
521 * Firmware version: 12.18.2000
523 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
525 * Host interface: PCI Express 3.0 x16
526 * Device ID: 15b3:1013
527 * Firmware version: 12.18.2000
529 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
531 * Host interface: PCI Express 3.0 x16
532 * Device ID: 15b3:1013
533 * Firmware version: 12.18.2000
535 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
537 * Host interface: PCI Express 3.0 x8
538 * Device ID: 15b3:1015
539 * Firmware version: 14.18.2000
541 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
543 * Host interface: PCI Express 3.0 x8
544 * Device ID: 15b3:1015
545 * Firmware version: 14.18.2000
547 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
549 * Host interface: PCI Express 3.0 x16
550 * Device ID: 15b3:1017
551 * Firmware version: 16.19.1200
553 * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
555 * Host interface: PCI Express 4.0 x16
556 * Device ID: 15b3:1019
557 * Firmware version: 16.19.1200