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 support for generic flow API (rte_flow) on igb NIC.**
46 This API provides a generic means to configure hardware to match specific
47 ingress or egress traffic, alter its behavior and query related counters
48 according to any number of user-defined rules.
50 * Generic flow API support for Ethernet, IPv4, UDP, TCP and
51 RAW pattern items with QUEUE actions. There are four
52 type of filter support for this feature on igb.
54 * **Added Generic Flow API support to enic.**
56 Flow API support for outer Ethernet, VLAN, IPv4, IPv6, UDP, TCP, SCTP, VxLAN
57 and inner Ethernet, VLAN, IPv4, IPv6, UDP and TCP pattern items with QUEUE,
58 MARK, FLAG and VOID actions for ingress traffic.
60 * **Added support for Chelsio T6 family of adapters**
62 CXGBE PMD updated to run Chelsio T6 family of adapters.
64 * **Added latency and performance improvements for cxgbe**
66 TX and RX path reworked to improve performance. Also reduced latency
69 * **Updated bnxt PMD.**
71 Major enhancements include:
72 * Support MTU modification.
74 * Support VLAN filter and strip functionality.
75 * Other enhancements to add support for more dev_ops.
76 * Add PMD specific APIs mainly to control VF from PF.
77 * Update HWRM version to 1.7.7
79 * **Added support for Rx interrupts on mlx4 driver.**
81 Rx queues can be armed with an interrupt which will trigger on the
84 * **Updated szedata2 PMD.**
86 Added support for firmwares with multiple Ethernet ports per physical port.
88 * **Reorganized the symmetric crypto operation structure.**
90 The crypto operation (``rte_crypto_sym_op``) has been reorganized as follows:
92 * Removed field ``rte_crypto_sym_op_sess_type``.
93 * Replaced pointer and physical address of IV with offset from the start
94 of the crypto operation.
95 * Moved length and offset of cipher IV to ``rte_crypto_cipher_xform``.
96 * Removed Additional Authentication Data (AAD) length.
97 * Removed digest length.
99 * **Reorganized the crypto operation structure.**
101 The crypto operation (``rte_crypto_op``) has been reorganized as follows:
103 * Added field ``rte_crypto_op_sess_type``.
104 * Enumerations ``rte_crypto_op_status`` and ``rte_crypto_op_type``
105 have been modified to be uint8_t values.
106 * Removed the field ``opaque_data``.
107 * Pointer to ``rte_crypto_sym_op`` has been replaced with a zero length array.
109 * **Updated cryptodev library.**
111 * Added AEAD algorithm specific functions and structures, so it is not
112 necessary to use a combination of cipher and authentication
119 .. This section should contain bug fixes added to the relevant
120 sections. Sample format:
122 * **code/section Fixed issue in the past tense with a full stop.**
124 Add a short 1-2 sentence description of the resolved issue in the past
127 The title should contain the code/lib section like a commit message.
129 Add the entries in alphabetic order in the relevant sections below.
131 This section is a comment. do not overwrite or remove it.
132 Also, make sure to start the actual text at the margin.
133 =========================================================
159 .. This section should contain new known issues in this release. Sample format:
161 * **Add title in present tense with full stop.**
163 Add a short 1-2 sentence description of the known issue in the present
164 tense. Add information on any known workarounds.
166 This section is a comment. do not overwrite or remove it.
167 Also, make sure to start the actual text at the margin.
168 =========================================================
174 .. This section should contain API changes. Sample format:
176 * Add a short 1-2 sentence description of the API change. Use fixed width
177 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 ABI changes. Sample format:
190 * Add a short 1-2 sentence description of the ABI change that was announced
191 in the previous releases and made in this release. Use fixed width quotes
192 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
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 * **Reorganized the crypto operation structures.**
200 Some fields have been modified in the ``rte_crypto_op`` and ``rte_crypto_sym_op``
201 structures, as described in the `New Features`_ section.
203 * **Reorganized the ``rte_crypto_sym_cipher_xform`` structure.**
205 * Added cipher IV length and offset parameters.
207 * **Reorganized the ``rte_crypto_sym_auth_xform`` structure.**
209 * Added authentication IV length and offset parameters.
210 * Changed field size of AAD length from uint32_t to uint16_t.
211 * Changed field size of digest length from uint32_t to uint16_t.
214 Shared Library Versions
215 -----------------------
217 .. Update any library version updated in this release and prepend with a ``+``
221 + librte_cfgfile.so.2
224 This section is a comment. do not overwrite or remove it.
225 =========================================================
228 The libraries prepended with a plus sign were incremented in this version.
233 librte_bitratestats.so.1
236 + librte_cryptodev.so.3
237 librte_distributor.so.1
245 librte_latencystats.so.1
269 .. This section should contain a list of platforms that were tested with this
274 * <vendor> platform with <vendor> <type of devices> combinations
279 * Other relevant details...
281 This section is a comment. do not overwrite or remove it.
282 Also, make sure to start the actual text at the margin.
283 =========================================================