1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2021 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_03.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 ability to reuse hugepages in Linux.**
60 It is possible to reuse files in hugetlbfs to speed up hugepage mapping,
61 which may be useful for fast restart and large allocations.
62 The new mode is activated with ``--huge-unlink=never``
63 and has security implications, refer to the user and programmer guides.
65 * **Added functions to calculate UDP/TCP checksum in mbuf.**
67 * Added the following functions to calculate UDP/TCP checksum of packets
68 which can be over multi-segments:
69 - ``rte_ipv4_udptcp_cksum_mbuf()``
70 - ``rte_ipv4_udptcp_cksum_mbuf_verify()``
71 - ``rte_ipv6_udptcp_cksum_mbuf()``
72 - ``rte_ipv6_udptcp_cksum_mbuf_verify()``
74 * **Added functions to configure flow engine.**
76 * Added ``rte_flow_configure`` API to configure flow management
77 engine, allowing to pre-allocate some resources for better performance.
78 Added ``rte_flow_info_get`` API to retrieve available resources.
80 * Added ``rte_flow_template_table_create`` API to group flow rules
81 with the same flow attributes and common matching patterns and actions
82 defined by ``rte_flow_pattern_template_create`` and
83 ``rte_flow_actions_template_create`` respectively.
84 Corresponding functions to destroy these entities are:
85 ``rte_flow_template_table_destroy``, ``rte_flow_pattern_template_destroy``
86 and ``rte_flow_actions_template_destroy``.
88 * **Added functions for asynchronous flow rules creation/destruction.**
90 * Added ``rte_flow_async_create`` and ``rte_flow_async_destroy`` API
91 to enqueue flow creaion/destruction operations asynchronously as well as
92 ``rte_flow_pull`` to poll and retrieve results of these operations and
93 ``rte_flow_push`` to push all the in-flight operations to the NIC.
95 * **Added rte_flow support for matching GRE optional fields.**
97 Added ``gre_option`` item in rte_flow to support checksum/key/sequence
98 matching in GRE packets.
100 * **Added new RSS offload types for L2TPv2 in RSS flow.**
102 Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
105 * **Added IP reassembly Ethernet offload API, to get and set config.**
107 Added IP reassembly offload APIs which provide functions to query IP
108 reassembly capabilities, to set configuration and to get currently set
109 reassembly configuration.
111 * **Added an API to enable queue based priority flow ctrl(PFC).**
113 New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
114 ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
116 * **Added a private dump API, to dump private info from device.**
118 Added the private dump API which provides querying private info from device.
119 There exists many private properties in different PMD drivers.
120 The information of these properties is important for debug.
121 As the information is private, a dump function is introduced.
123 * **Updated AF_XDP PMD**
125 * Added support for libxdp >=v1.2.2.
126 * Re-enabled secondary process support. RX/TX is not supported.
128 * **Updated Amazon ENA PMD.**
130 The new driver version (v2.6.0) introduced bug fixes and improvements, including:
132 * Added new checksum related xstats: ``l3_csum_bad``, ``l4_csum_bad`` and
134 * Added support for the link status configuration.
135 * Added optimized memcpy support for the ARM platforms.
136 * Added ENA admin queue support for the MP applications.
137 * Added free Tx mbuf on demand feature support.
138 * Added ``rte_eth_xstats_get_names_by_id`` API support.
139 * Added ``miss_txc_to`` device argument for setting the Tx completion timeout.
141 * **Updated Cisco enic driver.**
143 * Added rte_flow support for matching GENEVE packets.
144 * Added rte_flow support for matching eCPRI packets.
146 * **Updated Intel iavf driver.**
148 * Added L2TPv2 (include PPP over L2TPv2) RSS support based on outer
149 MAC src/dst address and L2TPv2 session ID.
150 * Added L2TPv2 (include PPP over L2TPv2) FDIR support based on outer
151 MAC src/dst address and L2TPv2 session ID.
152 * Added PPPoL2TPv2oUDP FDIR distribute packets based on inner IP
153 src/dst address and UDP/TCP src/dst port.
155 * **Updated Marvell cnxk ethdev PMD.**
157 * Added queue based priority flow control support for CN9K & CN10K.
159 * **Updated Wangxun ngbe driver.**
161 * Added support for devices of custom PHY interfaces.
162 - M88E1512 PHY connects to RJ45
163 - M88E1512 PHY connects to RGMII combo
164 - YT8521S PHY connects to SFP
165 * Added LED OEM support.
167 * **Updated Wangxun txgbe driver.**
169 * Added LED OEM support.
171 * **Added an API for private user data in asymmetric crypto session.**
173 An API was added to get/set an asymmetric crypto session's user data.
175 * **Updated Marvell cnxk crypto PMD.**
177 * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
178 * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
179 * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
180 * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
181 * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
182 * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
183 * Added AES-CMAC support in CN9K & CN10K.
184 * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
186 * **Updated Intel QuickAssist Technology crypto PMD.**
188 * Added support for CPM2.0b (4942) devices.
189 * Added ECDSA algorithm support.
190 * Added ECPM algorithm support.
192 * **Added an API to retrieve event port id of ethdev Rx adapter.**
194 The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
196 * **Added support for Kunpeng930 DMA devices to HiSilicon DMA PMD.**
198 * Kunpeng930 DMA devices are now enabled for HiSilicon DMA PMD.
200 * **Added CNXK GPIO PMD.**
202 Added a new rawdevice PMD which allows to manage userspace GPIOs and install
203 custom GPIO interrupt handlers which bypass kernel. This is especially useful
204 for applications, that besides providing standard dataplane functionality
205 want to have fast and low latency access to GPIO pin state.
207 See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
210 * **Updated testpmd.**
212 * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
213 to support software UDP/TCP checksum over multiple segments.
215 * **Added crypto producer mode in test-eventdev.**
217 * Crypto producer mode helps to measure performance of OP_NEW and OP_FORWARD
218 modes of event crypto adapter.
224 .. This section should contain removed items in this release. Sample format:
226 * Add a short 1-2 sentence description of the removed item
229 This section is a comment. Do not overwrite or remove it.
230 Also, make sure to start the actual text at the margin.
231 =======================================================
233 * **Removed experimental performance thread example application.**
239 .. This section should contain API changes. Sample format:
241 * sample: Add a short 1-2 sentence description of the API change
242 which was announced in the previous releases and made in this release.
243 Start with a scope label like "ethdev:".
244 Use fixed width quotes for ``function_names`` or ``struct_names``.
247 This section is a comment. Do not overwrite or remove it.
248 Also, make sure to start the actual text at the margin.
249 =======================================================
251 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
252 ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
253 ``rte_ipv6_udptcp_cksum_mbuf_verify()``
255 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
256 which are kept for backward compatibility, are marked as deprecated.
258 * cryptodev: The asymmetric session handling was modified to use a single
259 mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
260 to create a mempool with element size big enough to hold the generic asymmetric
261 session header, max size for a device private session data, and user data size.
262 The session structure was moved to ``cryptodev_pmd.h``,
263 hiding it from applications.
264 The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
265 is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
266 return an integer value to indicate initialisation errors.
272 .. This section should contain ABI changes. Sample format:
274 * sample: Add a short 1-2 sentence description of the ABI change
275 which was announced in the previous releases and made in this release.
276 Start with a scope label like "ethdev:".
277 Use fixed width quotes for ``function_names`` or ``struct_names``.
280 This section is a comment. Do not overwrite or remove it.
281 Also, make sure to start the actual text at the margin.
282 =======================================================
284 * No ABI change that would break compatibility with 21.11.
290 .. This section should contain new known issues in this release. Sample format:
292 * **Add title in present tense with full stop.**
294 Add a short 1-2 sentence description of the known issue
295 in the present tense. Add information on any known workarounds.
297 This section is a comment. Do not overwrite or remove it.
298 Also, make sure to start the actual text at the margin.
299 =======================================================
305 .. This section should contain a list of platforms that were tested
310 * <vendor> platform with <vendor> <type of devices> combinations
315 * Other relevant details...
317 This section is a comment. Do not overwrite or remove it.
318 Also, make sure to start the actual text at the margin.
319 =======================================================