ethdev: support SFF-8636 module telemetry
[dpdk.git] / doc / guides / rel_notes / release_22_07.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2022 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 22.07
7 ==================
8
9 .. **Read this first.**
10
11    The text in the sections below explains how to update the release notes.
12
13    Use proper spelling, capitalization and punctuation in all sections.
14
15    Variable and config names should be quoted as fixed width text:
16    ``LIKE_THIS``.
17
18    Build the docs and view the output file to ensure the changes are correct::
19
20       ninja -C build doc
21       xdg-open build/doc/guides/html/rel_notes/release_22_07.html
22
23
24 New Features
25 ------------
26
27 .. This section should contain new features added in this release.
28    Sample format:
29
30    * **Add a title in the past tense with a full stop.**
31
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.
35
36      If the feature adds a lot of sub-features you can use a bullet list
37      like this:
38
39      * Added feature foo to do something.
40      * Enhanced feature bar to do something else.
41
42      Refer to the previous release notes for examples.
43
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)
47        - ethdev (lib, PMDs)
48        - cryptodev (lib, PMDs)
49        - eventdev (lib, PMDs)
50        - etc
51      * Other libs
52      * Apps, Examples, Tools (if significant)
53
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      =======================================================
57
58 * **Added protocol based input color selection for meter.**
59
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.
66
67 * **Added telemetry for module EEPROM.**
68
69   Added telemetry command to dump module EEPROM.
70   Added support for module EEPROM information format defined in:
71
72     * SFF-8079 revision 1.7
73     * SFF-8472 revision 12.0
74     * SFF-8636 revision 2.7
75
76 * **Added vhost API to get the number of in-flight packets.**
77
78   Added an API which can get the number of in-flight packets in
79   vhost async data path without using lock.
80
81 * **Updated Intel iavf driver.**
82
83   * Added Tx QoS queue rate limitation support.
84   * Added quanta size configuration support.
85   * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
86
87 * **Updated Intel ice driver.**
88
89  * Added support for RSS RETA configure in DCF mode.
90  * Added support for RSS HASH configure in DCF mode.
91  * Added support for MTU configure in DCF mode.
92  * Added support for promisc configuration in DCF mode.
93  * Added support for MAC configuration in DCF mode.
94  * Added support for VLAN filter and offload configuration in DCF mode.
95
96 * **Updated Mellanox mlx5 driver.**
97
98   * Added support for promiscuous mode on Windows.
99   * Added support for MTU on Windows.
100   * Added matching and RSS on IPsec ESP.
101
102 * **Updated VMware vmxnet3 networking driver.**
103
104   * Added version 5 support.
105   * Added RETA query and RETA update support.
106   * Added version 6 support with some new features:
107
108     * Increased maximum MTU up to 9190;
109     * Increased maximum number of Rx and Tx queues;
110     * Removed power-of-two limitations on Rx and Tx queue size;
111     * Extended interrupt structures (required for additional queues).
112
113 * **Updated Wangxun ngbe driver.**
114
115   * Added support for yt8531s PHY.
116
117 * **Added Elliptic Curve Diffie-Hellman (ECDH) algorithm in cryptodev.**
118
119   Added support for Elliptic Curve Diffie Hellman (ECDH) asymmetric
120   algorithm in cryptodev.
121
122 * **Updated Marvell cnxk crypto driver.**
123
124   * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
125   * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
126
127 * **Updated Intel QuickAssist Technology (QAT) crypto PMD.**
128
129   * Added support for secp384r1 elliptic curve.
130
131 * **Added eventdev API to quiesce an event port.**
132
133   Added the function ``rte_event_port_quiesce()``
134   to quiesce any lcore-specific resources consumed by the event port,
135   when the lcore is no more associated with an event port.
136
137 * **Added support for setting queue attributes at runtime in eventdev.**
138
139   Added new API ``rte_event_queue_attr_set()``, to set event queue attributes
140   at runtime.
141
142 * **Added new queues attributes weight and affinity in eventdev.**
143
144   Defined new event queue attributes weight and affinity as below:
145
146   * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
147   * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
148
149 * **Added scalar version of the LPM library.**
150
151   Added scalar implementation of ``rte_lpm_lookupx4``.
152   This is a fall-back implementation for platforms that
153   don't support vector operations.
154
155
156 Removed Items
157 -------------
158
159 .. This section should contain removed items in this release. Sample format:
160
161    * Add a short 1-2 sentence description of the removed item
162      in the past tense.
163
164    This section is a comment. Do not overwrite or remove it.
165    Also, make sure to start the actual text at the margin.
166    =======================================================
167
168
169 API Changes
170 -----------
171
172 .. This section should contain API changes. Sample format:
173
174    * sample: Add a short 1-2 sentence description of the API change
175      which was announced in the previous releases and made in this release.
176      Start with a scope label like "ethdev:".
177      Use fixed width quotes for ``function_names`` or ``struct_names``.
178      Use the past tense.
179
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    =======================================================
183
184 * The DPDK header file ``rte_altivec.h``,
185   which is a wrapper for the PPC header file ``altivec.h``,
186   undefines the AltiVec keyword ``vector``.
187   The alternative keyword ``__vector`` should be used instead.
188
189 * Experimental structures ``struct rte_mtr_params``
190   and ``struct rte_mtr_capabilities`` updated to support
191   protocol based input color for meter.
192
193
194 ABI Changes
195 -----------
196
197 .. This section should contain ABI changes. Sample format:
198
199    * sample: Add a short 1-2 sentence description of the ABI change
200      which was announced in the previous releases and made in this release.
201      Start with a scope label like "ethdev:".
202      Use fixed width quotes for ``function_names`` or ``struct_names``.
203      Use the past tense.
204
205    This section is a comment. Do not overwrite or remove it.
206    Also, make sure to start the actual text at the margin.
207    =======================================================
208
209 * No ABI change that would break compatibility with 21.11.
210
211
212 Known Issues
213 ------------
214
215 .. This section should contain new known issues in this release. Sample format:
216
217    * **Add title in present tense with full stop.**
218
219      Add a short 1-2 sentence description of the known issue
220      in the present tense. Add information on any known workarounds.
221
222    This section is a comment. Do not overwrite or remove it.
223    Also, make sure to start the actual text at the margin.
224    =======================================================
225
226
227 Tested Platforms
228 ----------------
229
230 .. This section should contain a list of platforms that were tested
231    with this release.
232
233    The format is:
234
235    * <vendor> platform with <vendor> <type of devices> combinations
236
237      * List of CPU
238      * List of OS
239      * List of devices
240      * Other relevant details...
241
242    This section is a comment. Do not overwrite or remove it.
243    Also, make sure to start the actual text at the margin.
244    =======================================================