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 rte_flow support for matching GRE optional fields.**
76 Added ``gre_option`` item in rte_flow to support checksum/key/sequence
77 matching in GRE packets.
79 * **Added new RSS offload types for L2TPv2 in RSS flow.**
81 Added macro RTE_ETH_RSS_L2TPV2, now L2TPv2 session ID field can be used as
84 * **Added IP reassembly Ethernet offload API, to get and set config.**
86 Added IP reassembly offload APIs which provide functions to query IP
87 reassembly capabilities, to set configuration and to get currently set
88 reassembly configuration.
90 * **Added an API to enable queue based priority flow ctrl(PFC).**
92 New APIs, ``rte_eth_dev_priority_flow_ctrl_queue_info_get()`` and
93 ``rte_eth_dev_priority_flow_ctrl_queue_configure()``, was added.
95 * **Added a private dump API, to dump private info from device.**
97 Added the private dump API which provides querying private info from device.
98 There exists many private properties in different PMD drivers.
99 The information of these properties is important for debug.
100 As the information is private, a dump function is introduced.
102 * **Updated AF_XDP PMD**
104 * Added support for libxdp >=v1.2.2.
105 * Re-enabled secondary process support. RX/TX is not supported.
107 * **Updated Cisco enic driver.**
109 * Added rte_flow support for matching GENEVE packets.
110 * Added rte_flow support for matching eCPRI packets.
112 * **Updated Wangxun ngbe driver.**
114 * Added support for devices of custom PHY interfaces.
115 - M88E1512 PHY connects to RJ45
116 - M88E1512 PHY connects to RGMII combo
117 - YT8521S PHY connects to SFP
118 * Added LED OEM support.
120 * **Updated Wangxun txgbe driver.**
122 * Added LED OEM support.
124 * **Added an API for private user data in asymmetric crypto session.**
126 An API was added to get/set an asymmetric crypto session's user data.
128 * **Updated Marvell cnxk crypto PMD.**
130 * Added SHA256-HMAC support in lookaside protocol (IPsec) for CN10K.
131 * Added SHA384-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
132 * Added SHA512-HMAC support in lookaside protocol (IPsec) for CN9K & CN10K.
133 * Added AES-CTR support in lookaside protocol (IPsec) for CN9K & CN10K.
134 * Added NULL cipher support in lookaside protocol (IPsec) for CN9K & CN10K.
135 * Added AES-XCBC support in lookaside protocol (IPsec) for CN9K & CN10K.
136 * Added AES-CMAC support in CN9K & CN10K.
137 * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN10K.
139 * **Added support for CPM2.0b devices to Intel QuickAssist Technology PMD.**
141 * CPM2.0b (4942) devices are now enabled for QAT crypto PMD.
143 * **Added an API to retrieve event port id of ethdev Rx adapter.**
145 The new API ``rte_event_eth_rx_adapter_event_port_get()`` was added.
147 * **Added CNXK GPIO PMD.**
149 Added a new rawdevice PMD which allows to manage userspace GPIOs and install
150 custom GPIO interrupt handlers which bypass kernel. This is especially useful
151 for applications, that besides providing standard dataplane functionality
152 want to have fast and low latency access to GPIO pin state.
154 See the :doc:`../rawdevs/cnxk_gpio` rawdev guide for more details on this
157 * **Updated testpmd.**
159 * Called ``rte_ipv4/6_udptcp_cksum_mbuf()`` functions in testpmd csum mode
160 to support software UDP/TCP checksum over multiple segments.
166 .. This section should contain removed items in this release. Sample format:
168 * Add a short 1-2 sentence description of the removed item
171 This section is a comment. Do not overwrite or remove it.
172 Also, make sure to start the actual text at the margin.
173 =======================================================
175 * **Removed experimental performance thread example application.**
181 .. This section should contain API changes. Sample format:
183 * sample: Add a short 1-2 sentence description of the API change
184 which was announced in the previous releases and made in this release.
185 Start with a scope label like "ethdev:".
186 Use fixed width quotes for ``function_names`` or ``struct_names``.
189 This section is a comment. Do not overwrite or remove it.
190 Also, make sure to start the actual text at the margin.
191 =======================================================
193 * net: added experimental functions ``rte_ipv4_udptcp_cksum_mbuf()``,
194 ``rte_ipv4_udptcp_cksum_mbuf_verify()``, ``rte_ipv6_udptcp_cksum_mbuf()``,
195 ``rte_ipv6_udptcp_cksum_mbuf_verify()``
197 * ethdev: Old public macros and enumeration constants without ``RTE_ETH_`` prefix,
198 which are kept for backward compatibility, are marked as deprecated.
200 * cryptodev: The asymmetric session handling was modified to use a single
201 mempool object. An API ``rte_cryptodev_asym_session_pool_create`` was added
202 to create a mempool with element size big enough to hold the generic asymmetric
203 session header, max size for a device private session data, and user data size.
204 The session structure was moved to ``cryptodev_pmd.h``,
205 hiding it from applications.
206 The API ``rte_cryptodev_asym_session_init`` was removed as the initialization
207 is now moved to ``rte_cryptodev_asym_session_create``, which was updated to
208 return an integer value to indicate initialisation errors.
214 .. This section should contain ABI changes. Sample format:
216 * sample: Add a short 1-2 sentence description of the ABI change
217 which was announced in the previous releases and made in this release.
218 Start with a scope label like "ethdev:".
219 Use fixed width quotes for ``function_names`` or ``struct_names``.
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 =======================================================
226 * No ABI change that would break compatibility with 21.11.
232 .. This section should contain new known issues in this release. Sample format:
234 * **Add title in present tense with full stop.**
236 Add a short 1-2 sentence description of the known issue
237 in the present tense. Add information on any known workarounds.
239 This section is a comment. Do not overwrite or remove it.
240 Also, make sure to start the actual text at the margin.
241 =======================================================
247 .. This section should contain a list of platforms that were tested
252 * <vendor> platform with <vendor> <type of devices> combinations
257 * Other relevant details...
259 This section is a comment. Do not overwrite or remove it.
260 Also, make sure to start the actual text at the margin.
261 =======================================================