examples/l3fwd: merge l3fwd-acl example
[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 initial RISC-V architecture support.***
59
60   Added EAL implementation for RISC-V architecture.
61   The initial device the porting was tested on is
62   a HiFive Unmatched development board based on the SiFive Freedom U740 SoC.
63   In theory this implementation should work
64   with any ``rv64gc`` ISA compatible implementation
65   with MMU supporting a reasonable address space size (U740 uses sv39 MMU).
66
67 * **Added Sequence Lock.**
68
69   Added a new synchronization primitive: the sequence lock
70   (seqlock). A seqlock allows for low overhead, parallel reads. The
71   DPDK seqlock uses a spinlock to serialize multiple writing threads.
72
73 * **Added protocol based input color selection for meter.**
74
75   Added new functions ``rte_mtr_color_in_protocol_set()``,
76   ``rte_mtr_color_in_protocol_get()``,
77   ``rte_mtr_color_in_protocol_priority_get()``,
78   ``rte_mtr_meter_vlan_table_update()``
79   and updated ``struct rte_mtr_params`` and ``struct rte_mtr_capabilities`` to
80   support protocol based input color selection for meter.
81
82 * **Added telemetry for module EEPROM.**
83
84   Added telemetry command to dump module EEPROM.
85   Added support for module EEPROM information format defined in:
86
87     * SFF-8079 revision 1.7
88     * SFF-8472 revision 12.0
89     * SFF-8636 revision 2.7
90
91 * **Added vhost API to get the number of in-flight packets.**
92
93   Added an API which can get the number of in-flight packets in
94   vhost async data path without using lock.
95
96 * **Added vhost async dequeue API to receive packets from guest.**
97
98   Added vhost async dequeue API which can leverage DMA devices to
99   accelerate receiving packets from guest.
100
101 * **Added vhost API to get the device type of a vDPA device.**
102
103   Added an API which can get the device type of vDPA device.
104
105 * **Updated Intel iavf driver.**
106
107   * Added Tx QoS queue rate limitation support.
108   * Added quanta size configuration support.
109   * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
110   * Added Protocol Agnostic Flow Offloading support in AVF FDIR and RSS.
111
112 * **Updated Intel ice driver.**
113
114  * Added support for RSS RETA configure in DCF mode.
115  * Added support for RSS HASH configure in DCF mode.
116  * Added support for MTU configure in DCF mode.
117  * Added support for promisc configuration in DCF mode.
118  * Added support for MAC configuration in DCF mode.
119  * Added support for VLAN filter and offload configuration in DCF mode.
120  * Added Tx QoS queue / queue group rate limitation configure support.
121  * Added Tx QoS queue / queue group priority configuration support.
122  * Added Tx QoS queue weight configuration support.
123
124 * **Updated Intel igc driver.**
125
126   Added Intel Foxville I226 devices in ``igc`` driver.
127   See the doc:`../nics/igc` NIC guide for more details.
128
129 * **Updated Mellanox mlx5 driver.**
130
131   * Added support for promiscuous mode on Windows.
132   * Added support for MTU on Windows.
133   * Added matching and RSS on IPsec ESP.
134
135 * **Updated VMware vmxnet3 networking driver.**
136
137   * Added version 5 support.
138   * Added RETA query and RETA update support.
139   * Added version 6 support with some new features:
140
141     * Increased maximum MTU up to 9190;
142     * Increased maximum number of Rx and Tx queues;
143     * Removed power-of-two limitations on Rx and Tx queue size;
144     * Extended interrupt structures (required for additional queues).
145
146 * **Updated Wangxun ngbe driver.**
147
148   * Added support for yt8531s PHY.
149
150 * **Added Elliptic Curve Diffie-Hellman (ECDH) algorithm in cryptodev.**
151
152   Added support for Elliptic Curve Diffie Hellman (ECDH) asymmetric
153   algorithm in cryptodev.
154
155 * **Updated Marvell cnxk crypto driver.**
156
157   * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
158   * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
159
160 * **Updated Intel QuickAssist Technology (QAT) crypto PMD.**
161
162   * Added support for secp384r1 elliptic curve.
163
164 * **Added eventdev API to quiesce an event port.**
165
166   Added the function ``rte_event_port_quiesce()``
167   to quiesce any lcore-specific resources consumed by the event port,
168   when the lcore is no more associated with an event port.
169
170 * **Added support for setting queue attributes at runtime in eventdev.**
171
172   Added new API ``rte_event_queue_attr_set()``, to set event queue attributes
173   at runtime.
174
175 * **Added new queues attributes weight and affinity in eventdev.**
176
177   Defined new event queue attributes weight and affinity as below:
178
179   * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
180   * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
181
182 * **Added telemetry to dmadev library.**
183
184   Added telemetry callback functions which allow for a list of DMA devices,
185   statistics and other DMA device information to be queried.
186
187 * **Added scalar version of the LPM library.**
188
189   Added scalar implementation of ``rte_lpm_lookupx4``.
190   This is a fall-back implementation for platforms that
191   don't support vector operations.
192
193 * **Merged l3fwd-acl into l3fwd example.**
194
195   Merged l3fwd-acl code into l3fwd as l3fwd-acl contains duplicate
196   and common functions to l3fwd.
197
198
199 Removed Items
200 -------------
201
202 .. This section should contain removed items in this release. Sample format:
203
204    * Add a short 1-2 sentence description of the removed item
205      in the past tense.
206
207    This section is a comment. Do not overwrite or remove it.
208    Also, make sure to start the actual text at the margin.
209    =======================================================
210
211
212 API Changes
213 -----------
214
215 .. This section should contain API changes. Sample format:
216
217    * sample: Add a short 1-2 sentence description of the API change
218      which was announced in the previous releases and made in this release.
219      Start with a scope label like "ethdev:".
220      Use fixed width quotes for ``function_names`` or ``struct_names``.
221      Use the past tense.
222
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    =======================================================
226
227 * The DPDK header file ``rte_altivec.h``,
228   which is a wrapper for the PPC header file ``altivec.h``,
229   undefines the AltiVec keyword ``vector``.
230   The alternative keyword ``__vector`` should be used instead.
231
232 * Experimental structures ``struct rte_mtr_params``
233   and ``struct rte_mtr_capabilities`` updated to support
234   protocol based input color for meter.
235
236
237 ABI Changes
238 -----------
239
240 .. This section should contain ABI changes. Sample format:
241
242    * sample: Add a short 1-2 sentence description of the ABI change
243      which was announced in the previous releases and made in this release.
244      Start with a scope label like "ethdev:".
245      Use fixed width quotes for ``function_names`` or ``struct_names``.
246      Use the past tense.
247
248    This section is a comment. Do not overwrite or remove it.
249    Also, make sure to start the actual text at the margin.
250    =======================================================
251
252 * No ABI change that would break compatibility with 21.11.
253
254
255 Known Issues
256 ------------
257
258 .. This section should contain new known issues in this release. Sample format:
259
260    * **Add title in present tense with full stop.**
261
262      Add a short 1-2 sentence description of the known issue
263      in the present tense. Add information on any known workarounds.
264
265    This section is a comment. Do not overwrite or remove it.
266    Also, make sure to start the actual text at the margin.
267    =======================================================
268
269
270 Tested Platforms
271 ----------------
272
273 .. This section should contain a list of platforms that were tested
274    with this release.
275
276    The format is:
277
278    * <vendor> platform with <vendor> <type of devices> combinations
279
280      * List of CPU
281      * List of OS
282      * List of devices
283      * Other relevant details...
284
285    This section is a comment. Do not overwrite or remove it.
286    Also, make sure to start the actual text at the margin.
287    =======================================================