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 initial RISC-V architecture support.***
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).
67 * **Added Sequence Lock.**
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.
73 * ** Added function get random floating point number.**
75 Added the function ``rte_drand()`` to provide a pseudo-random
76 floating point number.
78 * **Added protocol based input color selection for meter.**
80 Added new functions ``rte_mtr_color_in_protocol_set()``,
81 ``rte_mtr_color_in_protocol_get()``,
82 ``rte_mtr_color_in_protocol_priority_get()``,
83 ``rte_mtr_meter_vlan_table_update()``
84 and updated ``struct rte_mtr_params`` and ``struct rte_mtr_capabilities`` to
85 support protocol based input color selection for meter.
87 * **Added Rx queue available descriptors threshold and event.**
89 Added ethdev API and corresponding driver operations to set Rx queue
90 available descriptors threshold and query for queues with reached
91 threshold when a new event ``RTE_ETH_EVENT_RX_AVAIL_THRESH`` is received.
93 * **Added telemetry for module EEPROM.**
95 Added telemetry command to dump module EEPROM.
96 Added support for module EEPROM information format defined in:
98 * SFF-8079 revision 1.7
99 * SFF-8472 revision 12.0
100 * SFF-8636 revision 2.7
102 * **Added vhost API to get the number of in-flight packets.**
104 Added an API which can get the number of in-flight packets in
105 vhost async data path without using lock.
107 * **Added vhost async dequeue API to receive packets from guest.**
109 Added vhost async dequeue API which can leverage DMA devices to
110 accelerate receiving packets from guest.
112 * **Added vhost API to get the device type of a vDPA device.**
114 Added an API which can get the device type of vDPA device.
116 * **Updated Amazon ena driver.**
118 The new driver version (v2.7.0) includes:
120 * Added fast mbuf free feature support.
121 * Added ``enable_llq`` device argument for controlling the PMD LLQ
122 (Low Latency Queue) mode.
124 * **Updated Atomic Rules' Arkville PMD.**
126 * A firmware version update to Arkville 22.07 is required.
127 * Added support for Atomic Rules PCI device IDs ``0x101a, 0x101b, 0x101c``.
128 * Added PMD support for virtual functions and vfio_pci driver.
130 * **Updated Intel iavf driver.**
132 * Added Tx QoS queue rate limitation support.
133 * Added quanta size configuration support.
134 * Added ``DEV_RX_OFFLOAD_TIMESTAMP`` support.
135 * Added Protocol Agnostic Flow Offloading support in AVF FDIR and RSS.
137 * **Updated Intel ice driver.**
139 * Added support for RSS RETA configure in DCF mode.
140 * Added support for RSS HASH configure in DCF mode.
141 * Added support for MTU configure in DCF mode.
142 * Added support for promisc configuration in DCF mode.
143 * Added support for MAC configuration in DCF mode.
144 * Added support for VLAN filter and offload configuration in DCF mode.
145 * Added Tx QoS queue / queue group rate limitation configure support.
146 * Added Tx QoS queue / queue group priority configuration support.
147 * Added Tx QoS queue weight configuration support.
149 * **Updated Intel igc driver.**
151 Added Intel Foxville I226 devices in ``igc`` driver.
152 See the doc:`../nics/igc` NIC guide for more details.
154 * **Updated Mellanox mlx5 driver.**
156 * Added support for promiscuous mode on Windows.
157 * Added support for MTU on Windows.
158 * Added matching and RSS on IPsec ESP.
160 * **Updated VMware vmxnet3 networking driver.**
162 * Added version 5 support.
163 * Added RETA query and RETA update support.
164 * Added version 6 support with some new features:
166 * Increased maximum MTU up to 9190;
167 * Increased maximum number of Rx and Tx queues;
168 * Removed power-of-two limitations on Rx and Tx queue size;
169 * Extended interrupt structures (required for additional queues).
171 * **Updated Wangxun ngbe driver.**
173 * Added support for yt8531s PHY.
175 * **Added Elliptic Curve Diffie-Hellman (ECDH) algorithm in cryptodev.**
177 Added support for Elliptic Curve Diffie Hellman (ECDH) asymmetric
178 algorithm in cryptodev.
180 * **Updated Marvell cnxk crypto driver.**
182 * Added AH mode support in lookaside protocol (IPsec) for CN9K & CN10K.
183 * Added AES-GMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
185 * **Updated Intel QuickAssist Technology (QAT) crypto PMD.**
187 * Added support for secp384r1 elliptic curve.
189 * **Added eventdev API to quiesce an event port.**
191 Added the function ``rte_event_port_quiesce()``
192 to quiesce any lcore-specific resources consumed by the event port,
193 when the lcore is no more associated with an event port.
195 * **Added support for setting queue attributes at runtime in eventdev.**
197 Added new API ``rte_event_queue_attr_set()``, to set event queue attributes
200 * **Added new queues attributes weight and affinity in eventdev.**
202 Defined new event queue attributes weight and affinity as below:
204 * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
205 * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
207 * **Added telemetry to dmadev library.**
209 Added telemetry callback functions which allow for a list of DMA devices,
210 statistics and other DMA device information to be queried.
212 * **Added scalar version of the LPM library.**
214 Added scalar implementation of ``rte_lpm_lookupx4``.
215 This is a fall-back implementation for platforms that
216 don't support vector operations.
218 * **Merged l3fwd-acl into l3fwd example.**
220 Merged l3fwd-acl code into l3fwd as l3fwd-acl contains duplicate
221 and common functions to l3fwd.
227 .. This section should contain removed items in this release. Sample format:
229 * Add a short 1-2 sentence description of the removed item
232 This section is a comment. Do not overwrite or remove it.
233 Also, make sure to start the actual text at the margin.
234 =======================================================
240 .. This section should contain API changes. Sample format:
242 * sample: Add a short 1-2 sentence description of the API 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``.
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 =======================================================
252 * The DPDK header file ``rte_altivec.h``,
253 which is a wrapper for the PPC header file ``altivec.h``,
254 undefines the AltiVec keyword ``vector``.
255 The alternative keyword ``__vector`` should be used instead.
257 * Experimental structures ``struct rte_mtr_params``
258 and ``struct rte_mtr_capabilities`` updated to support
259 protocol based input color for meter.
265 .. This section should contain ABI changes. Sample format:
267 * sample: Add a short 1-2 sentence description of the ABI change
268 which was announced in the previous releases and made in this release.
269 Start with a scope label like "ethdev:".
270 Use fixed width quotes for ``function_names`` or ``struct_names``.
273 This section is a comment. Do not overwrite or remove it.
274 Also, make sure to start the actual text at the margin.
275 =======================================================
277 * No ABI change that would break compatibility with 21.11.
283 .. This section should contain new known issues in this release. Sample format:
285 * **Add title in present tense with full stop.**
287 Add a short 1-2 sentence description of the known issue
288 in the present tense. Add information on any known workarounds.
290 This section is a comment. Do not overwrite or remove it.
291 Also, make sure to start the actual text at the margin.
292 =======================================================
298 .. This section should contain a list of platforms that were tested
303 * <vendor> platform with <vendor> <type of devices> combinations
308 * Other relevant details...
310 This section is a comment. Do not overwrite or remove it.
311 Also, make sure to start the actual text at the margin.
312 =======================================================