1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2022 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
21 xdg-open build/doc/guides/html/rel_notes/release_22_07.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Added protocol based input color selection for meter.**
60 Added new functions ``rte_mtr_color_in_protocol_set()``,
61 ``rte_mtr_color_in_protocol_get()``,
62 ``rte_mtr_color_in_protocol_priority_get()``,
63 ``rte_mtr_meter_vlan_table_update()``
64 and updated ``struct rte_mtr_params`` and ``struct rte_mtr_capabilities`` to
65 support protocol based input color selection for meter.
67 * **Added telemetry for module EEPROM.**
69 Added telemetry command to dump module EEPROM.
71 * **Added vhost API to get the number of in-flight packets.**
73 Added an API which can get the number of in-flight packets in
74 vhost async data path without using lock.
76 * **Updated Intel iavf driver.**
78 * Added Tx QoS queue rate limitation support.
79 * Added quanta size configuration support.
80 * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
82 * **Updated Intel ice driver.**
84 * Added support for RSS RETA configure in DCF mode.
85 * Added support for RSS HASH configure in DCF mode.
86 * Added support for MTU configure in DCF mode.
87 * Added support for promisc configuration in DCF mode.
88 * Added support for MAC configuration in DCF mode.
89 * Added support for VLAN filter and offload configuration in DCF mode.
91 * **Updated Mellanox mlx5 driver.**
93 * Added support for promiscuous mode on Windows.
94 * Added support for MTU on Windows.
95 * Added matching and RSS on IPsec ESP.
97 * **Updated VMware vmxnet3 networking driver.**
99 * Added version 5 support.
100 * Added RETA query and RETA update support.
101 * Added version 6 support with some new features:
103 * Increased maximum MTU up to 9190;
104 * Increased maximum number of Rx and Tx queues;
105 * Removed power-of-two limitations on Rx and Tx queue size;
106 * Extended interrupt structures (required for additional queues).
108 * **Updated Wangxun ngbe driver.**
110 * Added support for yt8531s PHY.
112 * **Added Elliptic Curve Diffie-Hellman (ECDH) algorithm in cryptodev.**
114 Added support for Elliptic Curve Diffie Hellman (ECDH) asymmetric
115 algorithm in cryptodev.
117 * **Updated Marvell cnxk crypto driver.**
119 * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
120 * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
122 * **Updated Intel QuickAssist Technology (QAT) crypto PMD.**
124 * Added support for secp384r1 elliptic curve.
126 * **Added eventdev API to quiesce an event port.**
128 Added the function ``rte_event_port_quiesce()``
129 to quiesce any lcore-specific resources consumed by the event port,
130 when the lcore is no more associated with an event port.
132 * **Added support for setting queue attributes at runtime in eventdev.**
134 Added new API ``rte_event_queue_attr_set()``, to set event queue attributes
137 * **Added new queues attributes weight and affinity in eventdev.**
139 Defined new event queue attributes weight and affinity as below:
141 * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
142 * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
144 * **Added scalar version of the LPM library.**
146 Added scalar implementation of ``rte_lpm_lookupx4``.
147 This is a fall-back implementation for platforms that
148 don't support vector operations.
154 .. This section should contain removed items in this release. Sample format:
156 * Add a short 1-2 sentence description of the removed item
159 This section is a comment. Do not overwrite or remove it.
160 Also, make sure to start the actual text at the margin.
161 =======================================================
167 .. This section should contain API changes. Sample format:
169 * sample: Add a short 1-2 sentence description of the API change
170 which was announced in the previous releases and made in this release.
171 Start with a scope label like "ethdev:".
172 Use fixed width quotes for ``function_names`` or ``struct_names``.
175 This section is a comment. Do not overwrite or remove it.
176 Also, make sure to start the actual text at the margin.
177 =======================================================
179 * The DPDK header file ``rte_altivec.h``,
180 which is a wrapper for the PPC header file ``altivec.h``,
181 undefines the AltiVec keyword ``vector``.
182 The alternative keyword ``__vector`` should be used instead.
184 * Experimental structures ``struct rte_mtr_params``
185 and ``struct rte_mtr_capabilities`` updated to support
186 protocol based input color for meter.
192 .. This section should contain ABI changes. Sample format:
194 * sample: Add a short 1-2 sentence description of the ABI change
195 which was announced in the previous releases and made in this release.
196 Start with a scope label like "ethdev:".
197 Use fixed width quotes for ``function_names`` or ``struct_names``.
200 This section is a comment. Do not overwrite or remove it.
201 Also, make sure to start the actual text at the margin.
202 =======================================================
204 * No ABI change that would break compatibility with 21.11.
210 .. This section should contain new known issues in this release. Sample format:
212 * **Add title in present tense with full stop.**
214 Add a short 1-2 sentence description of the known issue
215 in the present tense. Add information on any known workarounds.
217 This section is a comment. Do not overwrite or remove it.
218 Also, make sure to start the actual text at the margin.
219 =======================================================
225 .. This section should contain a list of platforms that were tested
230 * <vendor> platform with <vendor> <type of devices> combinations
235 * Other relevant details...
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 =======================================================