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 Generic Receive Offload API.**
46 Generic Receive Offload (GRO) API supports to reassemble TCP/IPv4
47 packets. GRO API assumes all inputted packets are with correct
48 checksums. GRO API doesn't update checksums for merged packets. If
49 inputted packets are IP fragmented, GRO API assumes they are complete
50 packets (i.e. with L4 headers).
52 * **Added support for generic flow API (rte_flow) on igb NIC.**
54 This API provides a generic means to configure hardware to match specific
55 ingress or egress traffic, alter its behavior and query related counters
56 according to any number of user-defined rules.
58 * Generic flow API support for Ethernet, IPv4, UDP, TCP and
59 RAW pattern items with QUEUE actions. There are four
60 type of filter support for this feature on igb.
62 * **Added Generic Flow API support to enic.**
64 Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
65 and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
66 MARK, FLAG and VOID actions for ingress traffic.
68 * **Added support for Chelsio T6 family of adapters**
70 CXGBE PMD updated to run Chelsio T6 family of adapters.
72 * **Added latency and performance improvements for cxgbe**
74 TX and RX path reworked to improve performance. Also reduced latency
77 * **Updated bnxt PMD.**
79 Major enhancements include:
80 * Support MTU modification.
82 * Support VLAN filter and strip functionality.
83 * Other enhancements to add support for more dev_ops.
84 * Add PMD specific APIs mainly to control VF from PF.
85 * Update HWRM version to 1.7.7
87 * **Added support for Rx interrupts on mlx4 driver.**
89 Rx queues can be armed with an interrupt which will trigger on the
92 * **Updated szedata2 PMD.**
94 Added support for firmwares with multiple Ethernet ports per physical port.
96 * **Reorganized the symmetric crypto operation structure.**
98 The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
100 * Removed field ``rte_crypto_sym_op_sess_type``.
101 * Replaced pointer and physical address of IV with offset from the start
102 of the crypto operation.
103 * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
104 * Removed Additional Authentication Data (AAD) length.
105 * Removed digest length.
106 * Removed AAD pointer and physical address from ``auth`` structure.
107 * Added ``aead`` structure, containing parameters for AEAD algorithms.
109 * **Reorganized the crypto operation structure.**
111 The crypto operation (``rte_crypto_op``) has been reorganized as follows:
113 * Added field ``rte_crypto_op_sess_type``.
114 * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
115 have been modified to be uint8_t values.
116 * Removed the field ``opaque_data``.
117 * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
119 * **Reorganized the crypto symmetric session structure.**
121 The crypto symmetric session structure (``rte_cryptodev_sym_session``) has
122 been reorganized as follows:
124 * ``dev_id`` field has been removed.
125 * ``driver_id`` field has been removed.
126 * Mempool pointer ``mp`` has been removed.
127 * Replaced ``private`` marker with array of pointers to private data sessions
128 ``sess_private_data``.
130 * **Updated cryptodev library.**
132 * Added AEAD algorithm specific functions and structures, so it is not
133 necessary to use a combination of cipher and authentication
135 * Added helper functions for crypto device driver identification.
136 * Added support for multi-device sessions, so a single session can be
137 used in multiple drivers.
138 * Added functions to initialize and free individual driver private data
141 * **Updated dpaa2_sec crypto PMD.**
143 Added support for AES-GCM and AES-CTR
145 * **Updated the AESNI MB PMD.**
147 The AESNI MB PMD has been updated with additional support for:
149 * 12-byte IV on AES Counter Mode, apart from the previous 16-byte IV.
151 * **Updated the AES-NI GCM PMD.**
153 The AES-NI GCM PMD was migrated from the ISA-L library to the Multi Buffer
154 library, as the latter library has Scatter Gather List support
155 now. The migration entailed adding additional support for:
159 * **Updated the Cryptodev Scheduler PMD.**
161 Added a multicore based distribution mode, which distributes the enqueued
162 crypto operations among several slaves, running on different logical cores.
164 * **Added dpdk-test-eventdev test application.**
166 The dpdk-test-eventdev tool is a Data Plane Development Kit (DPDK) application
167 that allows exercising various eventdev use cases.
168 This application has a generic framework to add new eventdev based test cases
169 to verify functionality and measure the performance parameters of DPDK
176 .. This section should contain bug fixes added to the relevant
177 sections. Sample format:
179 * **code/section Fixed issue in the past tense with a full stop.**
181 Add a short 1-2 sentence description of the resolved issue in the past
184 The title should contain the code/lib section like a commit message.
186 Add the entries in alphabetic order in the relevant sections below.
188 This section is a comment. do not overwrite or remove it.
189 Also, make sure to start the actual text at the margin.
190 =========================================================
216 .. This section should contain new known issues in this release. Sample format:
218 * **Add title in present tense with full stop.**
220 Add a short 1-2 sentence description of the known issue in the present
221 tense. Add information on any known workarounds.
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 API changes. Sample format:
233 * Add a short 1-2 sentence description of the API change. Use fixed width
234 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
237 This section is a comment. do not overwrite or remove it.
238 Also, make sure to start the actual text at the margin.
239 =========================================================
241 * **Reworked rte_cryptodev library.**
243 The rte_cryptodev library has been reworked and updated. The following changes
244 have been made to it:
246 * The crypto device type enumeration has been removed from cryptodev library.
247 * The function ``rte_crypto_count_devtype()`` has been removed, and replaced
248 by the new function ``rte_crypto_count_by_driver()``.
249 * Moved crypto device driver names definitions to the particular PMDs.
250 These names are not public anymore.
251 * ``rte_cryptodev_configure()`` does not create the session mempool
252 for the device anymore.
253 * ``rte_cryptodev_queue_pair_attach_sym_session()`` and
254 ``rte_cryptodev_queue_pair_dettach_sym_session()`` functions require
255 the new parameter ``device id``.
256 * Modified parameters of ``rte_cryptodev_sym_session_create()``, to accept
257 ``mempool``, instead of ``device id`` and ``rte_crypto_sym_xform``.
258 * Remove ``device id`` parameter from ``rte_cryptodev_sym_session_free()``.
259 * Added new field ``session_pool`` to ``rte_cryptodev_queue_pair_setup()``.
265 .. This section should contain ABI changes. Sample format:
267 * Add a short 1-2 sentence description of the ABI change that was announced
268 in the previous releases and made in this release. Use fixed width quotes
269 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
271 This section is a comment. do not overwrite or remove it.
272 Also, make sure to start the actual text at the margin.
273 =========================================================
275 * **Reorganized the crypto operation structures.**
277 Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
278 structures, as described in the `New Features`_ section.
280 * **Reorganized the crypto symmetric session structure.**
282 Some fields have been modified in the ``rte_cryptodev_sym_session``
283 structure, as described in the `New Features`_ section.
285 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
287 * Added cipher IV length and offset parameters.
289 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
291 * Added authentication IV length and offset parameters.
292 * Changed field size of AAD length from uint32_t to uint16_t.
293 * Changed field size of digest length from uint32_t to uint16_t.
294 * Removed AAD length.
296 * Replaced ``dev_type`` enumeration with uint8_t ``driver_id`` in
297 ``rte_cryptodev_info`` and ``rte_cryptodev`` structures.
299 * Removed ``session_mp`` from ``rte_cryptodev_config``.
302 Shared Library Versions
303 -----------------------
305 .. Update any library version updated in this release and prepend with a ``+``
309 + librte_cfgfile.so.2
312 This section is a comment. do not overwrite or remove it.
313 =========================================================
316 The libraries prepended with a plus sign were incremented in this version.
321 librte_bitratestats.so.1
324 + librte_cryptodev.so.3
325 librte_distributor.so.1
334 librte_latencystats.so.1
358 .. This section should contain a list of platforms that were tested with this
363 * <vendor> platform with <vendor> <type of devices> combinations
368 * Other relevant details...
370 This section is a comment. do not overwrite or remove it.
371 Also, make sure to start the actual text at the margin.
372 =========================================================