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/html/guides/rel_notes/release_21_08.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 auxiliary bus support.**
60 Auxiliary bus provides a way to split function into child-devices
61 representing sub-domains of functionality. Each auxiliary device
62 represents a part of its parent functionality.
64 * **Added XZ compressed firmware support.**
66 Using ``rte_firmware_read``, a driver can now handle XZ compressed firmware
67 in a transparent way, with EAL uncompressing using libarchive if this library
68 is available when building DPDK.
70 * **Updated Amazon ENA PMD.**
72 The new driver version (v2.4.0) introduced bug fixes and improvements,
75 * Added Rx interrupt support.
76 * RSS hash function key reconfiguration support.
78 * **Updated Intel iavf driver.**
80 * Added Tx QoS VF queue TC mapping.
81 * Added FDIR and RSS for GTPoGRE, support filter based on GTPU TEID/QFI,
82 outer most L3 or inner most l3/l4.
84 * **Updated Intel ice driver.**
86 * In AVX2 code, added the new RX and TX paths to use the HW offload
87 features. When the HW offload features are configured to be used, the
88 offload paths are chosen automatically. In parallel the support for HW
89 offload features was removed from the legacy AVX2 paths.
90 * Added Tx QoS TC bandwidth configuration in DCF.
92 * **Added support for Marvell CN10K SoC ethernet device.**
94 * Added net/cnxk driver which provides the support for the integrated ethernet
97 * **Updated Mellanox mlx5 driver.**
99 * Added Sub-Function support based on auxiliary bus.
100 * Added support for meter hierarchy.
101 * Added support for metering policy actions of yellow color.
102 * Added support for metering trTCM RFC2698 and RFC4115.
103 * Added devargs options ``allow_duplicate_pattern``.
104 * Added matching on IPv4 Internet Header Length (IHL).
105 * Added support for matching on VXLAN header last 8-bits reserved field.
106 * Optimized multi-thread flow rule insertion rate.
108 * **Added Wangxun ngbe PMD.**
110 Added a new PMD driver for Wangxun 1 Gigabit Ethernet NICs.
111 See the :doc:`../nics/ngbe` for more details.
113 * **Updated Solarflare network PMD.**
115 Updated the Solarflare ``sfc_efx`` driver with changes including:
117 * Added COUNT action support for SN1000 NICs
119 * **Updated Intel QuickAssist crypto PMD.**
121 Added fourth generation of QuickAssist Technology(QAT) devices support.
122 Only symmetric crypto has been currently enabled, compression and asymmetric
123 crypto PMD will fail to create.
125 * **Added support for Marvell CNXK crypto driver.**
127 * Added cnxk crypto PMD which provides support for an integrated
128 crypto driver for CN9K and CN10K series of SOCs. Support for
129 symmetric crypto algorithms is added to both the PMDs.
130 * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
131 * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
133 * **Updated Marvell OCTEON TX crypto PMD.**
135 Added support for crypto adapter OP_FORWARD mode.
137 * **Added support for Nvidia crypto device driver.**
139 Added mlx5 crypto driver to support AES-XTS cipher operations.
140 The first device to support it is ConnectX-6.
142 * **Updated ISAL compress device PMD.**
144 The ISAL compress device PMD now supports Arm platforms.
146 * **Added Baseband PHY CNXK PMD.**
148 Added Baseband PHY PMD which allows to configure BPHY hardware block
149 comprising accelerators and DSPs specifically tailored for 5G/LTE inline
150 usecases. Configuration happens via standard rawdev enq/deq operations. See
151 the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
153 * **Added support for Marvell CN10K, CN9K, event Rx/Tx adapter.**
155 * Added Rx/Tx adapter support for event/cnxk when the ethernet device requested
157 * Added support for event vectorization for Rx/Tx adapter.
159 * **Added cppc_cpufreq support to Power Management library.**
161 Added support for cppc_cpufreq driver which works on most arm64 platforms.
163 * **Added multi-queue support to Ethernet PMD Power Management**
165 The experimental PMD power management API now supports managing
166 multiple Ethernet Rx queues per lcore.
172 .. This section should contain removed items in this release. Sample format:
174 * Add a short 1-2 sentence description of the removed item
177 This section is a comment. Do not overwrite or remove it.
178 Also, make sure to start the actual text at the margin.
179 =======================================================
185 .. This section should contain API changes. Sample format:
187 * sample: Add a short 1-2 sentence description of the API change
188 which was announced in the previous releases and made in this release.
189 Start with a scope label like "ethdev:".
190 Use fixed width quotes for ``function_names`` or ``struct_names``.
193 This section is a comment. Do not overwrite or remove it.
194 Also, make sure to start the actual text at the margin.
195 =======================================================
197 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
200 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
201 to use a callback mechanism.
203 * rte_power: The experimental PMD power management API is no longer considered
204 to be thread safe; all Rx queues affected by the API will now need to be
205 stopped before making any changes to the power management scheme.
211 .. This section should contain ABI changes. Sample format:
213 * sample: Add a short 1-2 sentence description of the ABI change
214 which was announced in the previous releases and made in this release.
215 Start with a scope label like "ethdev:".
216 Use fixed width quotes for ``function_names`` or ``struct_names``.
219 This section is a comment. Do not overwrite or remove it.
220 Also, make sure to start the actual text at the margin.
221 =======================================================
223 * No ABI change that would break compatibility with 20.11.
229 .. This section should contain new known issues in this release. Sample format:
231 * **Add title in present tense with full stop.**
233 Add a short 1-2 sentence description of the known issue
234 in the present tense. Add information on any known workarounds.
236 This section is a comment. Do not overwrite or remove it.
237 Also, make sure to start the actual text at the margin.
238 =======================================================
244 .. This section should contain a list of platforms that were tested
249 * <vendor> platform with <vendor> <type of devices> combinations
254 * Other relevant details...
256 This section is a comment. Do not overwrite or remove it.
257 Also, make sure to start the actual text at the margin.
258 =======================================================