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_21_11.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 * **Enabled new devargs parser.**
60 * Enabled devargs syntax
61 ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
62 * Added bus-level parsing of the devargs syntax.
63 * Kept compatibility with the legacy syntax as parsing fallback.
65 * **Updated EAL hugetlbfs mount handling for Linux.**
67 * Modified to allow ``--huge-dir`` option to specify a sub-directory
68 within a hugetlbfs mountpoint.
70 * **Added dmadev library.**
72 * Added a DMA device framework for management and provision of
73 hardware and software DMA devices.
74 * Added generic API which support a number of different DMA
76 * Added multi-process support.
78 * **Added support to get all MAC addresses of a device.**
80 Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
81 addresses assigned to given ethernet port.
83 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
85 Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
86 TCP/UDP/SCTP header checksum field can be used as input set for RSS.
88 * **Added flow flex item.**
90 The configurable flow flex item provides the capability to introduce
91 an arbitrary user-specified network protocol header,
92 configure the hardware accordingly, and perform match on this header
93 with desired patterns and masks.
95 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
97 A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
98 The following parts of Rx metadata were defined:
100 * ``RTE_ETH_RX_METADATA_USER_FLAG``
101 * ``RTE_ETH_RX_METADATA_USER_MARK``
102 * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
104 * **Added an API to get a proxy port to manage "transfer" flows.**
106 A new API, ``rte_flow_pick_transfer_proxy()``, was added.
108 * **Updated af_packet ethdev driver.**
110 * Default VLAN strip behavior was changed. VLAN tag won't be stripped
111 unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
113 * **Added API to get device configuration in ethdev.**
115 Added an ethdev API which can help users get device configuration.
117 * **Updated AF_XDP PMD.**
119 * Disabled secondary process support.
121 * **Updated Amazon ENA PMD.**
123 Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
124 bug fixes and improvements, including:
126 * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
127 * NUMA aware allocations for the queue helper structures.
128 * Watchdog's feature which is checking for missing Tx completions.
130 * **Updated Broadcom bnxt PMD.**
132 * Added flow offload support for Thor.
133 * Implement support for tunnel offload.
134 * Updated HWRM API to version 1.10.2.44
136 * **Updated Intel iavf driver.**
138 * Added Intel iavf support on Windows.
139 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
141 * **Updated Intel ice driver.**
143 * Added 1PPS out support by a devargs.
144 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
145 * Added DEV_RX_OFFLOAD_TIMESTAMP support.
146 * Added timesync API support under scalar path.
148 * **Updated Intel ixgbe driver.**
150 * Added Intel ixgbe support on Windows.
152 * **Updated Marvell cnxk ethdev driver.**
154 * Added rte_flow support for dual VLAN insert and strip actions.
155 * Added rte_tm support.
156 * Added support for Inline IPsec for CN9K event mode and CN10K
157 poll mode and event mode.
158 * Added support for ingress meter for CN10K platform.
160 * **Updated Mellanox mlx5 driver.**
162 Updated the Mellanox mlx5 driver with new features and improvements, including:
164 * Added implicit mempool registration to avoid data path hiccups (opt-out).
165 * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
167 * **Updated Solarflare network PMD.**
169 Updated the Solarflare ``sfc_efx`` driver with changes including:
171 * Added port representors support on SN1000 SmartNICs
172 * Added flow API transfer proxy support
174 * **Updated Marvell cnxk crypto PMD.**
176 * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
177 * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
178 * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
179 * Added support for lookaside protocol (IPsec) offload for CN9K.
180 * Added support for ZUC algorithm with 256-bit key length for CN10K.
181 * Added support for CN98xx dual block.
182 * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
184 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
186 * Added event crypto adapter OP_FORWARD mode support.
188 * **Updated NXP dpaa_sec crypto PMD.**
190 * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
191 * Added PDCP short MAC-I support.
192 * Added raw vector datapath API support.
194 * **Updated NXP dpaa2_sec crypto PMD.**
196 * Added PDCP short MAC-I support.
197 * Added raw vector datapath API support.
199 * **Updated the ACC100 bbdev PMD.**
201 Added support for more comprehensive CRC options.
203 * **Updated the turbo_sw bbdev PMD.**
205 Added support for more comprehensive CRC options.
207 * **Added NXP LA12xx baseband PMD.**
209 * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
210 * See the :doc:`../bbdevs/la12xx` for more details.
212 * **Updated IPsec library.**
214 * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
216 * Added support for NAT-T / UDP encapsulated ESP.
217 * Added support for SA telemetry.
218 * Added support for setting a non default starting ESN value.
220 * **Added multi-process support for testpmd.**
222 Added command-line options to specify total number of processes and
223 current process ID. Each process owns subset of Rx and Tx queues.
225 * **Updated test-crypto-perf application with new cases.**
227 * Added support for asymmetric crypto throughput performance measurement.
228 Only modex is supported for now.
229 * Added support for lookaside IPsec protocol offload throughput measurement.
231 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
233 * Added known vector tests (AES-GCM 128, 192, 256).
234 * Added tests to verify error reporting with ICV corruption.
235 * Added tests to verify IV generation.
236 * Added tests to verify UDP encapsulation.
237 * Added tests to verify UDP encapsulation ports.
238 * Added tests to validate packets soft expiry.
239 * Added tests to validate packets hard expiry.
240 * Added tests to verify tunnel header verification in IPsec inbound.
241 * Added tests to verify inner checksum.
243 * **Revised packet capture framework.**
245 * New library for writing pcapng packet capture files.
251 .. This section should contain removed items in this release. Sample format:
253 * Add a short 1-2 sentence description of the removed item
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 =======================================================
260 * eal: Removed the deprecated function ``rte_get_master_lcore()``
261 and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
263 * eal: The old api arguments that were deprecated for
264 blacklist/whitelist are removed. Users must use the new
265 block/allow list arguments.
267 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
268 ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
270 * ethdev: Removed the port mirroring API. A more fine-grain flow API
271 action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
272 The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
273 the functions ``rte_eth_mirror_rule_set`` and
274 ``rte_eth_mirror_rule_reset`` along with the associated macros
275 ``ETH_MIRROR_*`` are removed.
277 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
278 driver callback. It is replaced by the more complete function
279 ``rte_eth_rx_descriptor_status``.
281 * ethdev: Removed deprecated ``shared`` attribute of the
282 ``struct rte_flow_action_count``. Shared counters should be managed
283 using indirect actions API (``rte_flow_action_handle_create`` etc).
285 * i40e: Removed i40evf driver.
286 iavf already became the default VF driver for i40e devices,
287 so there is no need to maintain i40evf.
293 .. This section should contain API changes. Sample format:
295 * sample: Add a short 1-2 sentence description of the API change
296 which was announced in the previous releases and made in this release.
297 Start with a scope label like "ethdev:".
298 Use fixed width quotes for ``function_names`` or ``struct_names``.
301 This section is a comment. Do not overwrite or remove it.
302 Also, make sure to start the actual text at the margin.
303 =======================================================
305 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
306 removed. Its usages have been replaced by a new function
307 ``rte_kvargs_get_with_value()``.
309 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
310 that objects from this pool will not be used for device IO (e.g. DMA).
312 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
313 Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
315 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
316 The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
318 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
319 deprecated. Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
321 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
322 will be removed in DPDK 22.11.
324 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
325 to ``src_addr`` and ``dst_addr``, respectively.
327 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
328 Existing ``version_ihl`` field is kept for backward compatibility.
330 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
333 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
334 Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
336 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
337 with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
339 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
340 array is extended, data pointer field is explicitly added to union, the
341 action behavior is defined in more strict fashion and documentation updated.
342 The immediate value behavior has been changed, the entire immediate field
343 should be provided, and offset for immediate source bitfield is assigned
344 from destination one.
346 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
347 rte_cryptodev_is_valid_dev as it can be used by the application as
348 well as PMD to check whether the device is valid or not.
350 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
351 as it is for drivers only and should be private to DPDK, and not
352 installed for app use.
354 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
355 renamed to ``aux_flags`` to indicate warnings and other information from
356 the crypto/security operation. This field will be used to communicate
357 events such as soft expiry with IPsec in lookaside mode.
359 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
360 moved to the end of the structure and extended to ``uint32_t``.
362 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
363 field to support total buffer length to facilitate protocol offload case.
365 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
366 ``dest_sgl`` to support out of place processing.
368 * bbdev: Added device info related to data byte endianness processing.
370 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
371 TLB misses if any and aligns to memory structure of other subsystems.
377 .. This section should contain ABI changes. Sample format:
379 * sample: Add a short 1-2 sentence description of the ABI change
380 which was announced in the previous releases and made in this release.
381 Start with a scope label like "ethdev:".
382 Use fixed width quotes for ``function_names`` or ``struct_names``.
385 This section is a comment. Do not overwrite or remove it.
386 Also, make sure to start the actual text at the margin.
387 =======================================================
389 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
390 Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
391 to internal queue data as input parameter. While this change is transparent
392 to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
393 is used by public inline function ``rte_eth_rx_queue_count``.
395 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
396 private data structures. ``rte_eth_devices[]`` can't be accessed directly
397 by user any more. While it is an ABI breakage, this change is intended
398 to be transparent for both users (no changes in user app is required) and
399 PMD developers (no changes in PMD is required).
401 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
402 routines used by inline outbound and inline inbound security processing were
403 made inline and enhanced to do simple 64-bit set/get for PMDs that do not
404 have much processing in PMD specific callbacks but just 64-bit set/get.
405 This avoids a per packet function pointer jump overhead for such PMDs.
407 * security: A new option ``iv_gen_disable`` was added in structure
408 ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
409 so that application can provide its own IV and test known test vectors.
411 * security: A new option ``tunnel_hdr_verify`` was added in structure
412 ``rte_security_ipsec_sa_options`` to indicate whether outer header
413 verification need to be done as part of inbound IPsec processing.
415 * security: A new option ``udp_ports_verify`` was added in structure
416 ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
417 verification need to be done as part of inbound IPsec processing.
419 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
420 replace ``esn_soft_limit`` in IPsec configuration structure
421 ``rte_security_ipsec_xform`` to allow applications to configure SA soft
422 and hard expiry limits. Limits can be either in number of packets or bytes.
424 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
425 in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
426 packet IPv4 header checksum and L4 checksum need to be offloaded to
429 * security: A new structure ``esn`` was added in structure
430 ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
431 application to start from an arbitrary ESN value for debug and SA lifetime
432 enforcement purposes.
434 * security: A new structure ``udp`` was added in structure
435 ``rte_security_ipsec_xform`` to allow setting the source and destination ports
436 for UDP encapsulated IPsec traffic.
438 * bbdev: Added capability related to more comprehensive CRC options,
439 shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
441 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
442 were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
445 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
446 by the fastpath inline functions. The structures ``rte_eventdev``,
447 ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
448 accessed directly by user any more. This change is transparent to both
449 applications and PMDs.
451 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
457 .. This section should contain new known issues in this release. Sample format:
459 * **Add title in present tense with full stop.**
461 Add a short 1-2 sentence description of the known issue
462 in the present tense. Add information on any known workarounds.
464 This section is a comment. Do not overwrite or remove it.
465 Also, make sure to start the actual text at the margin.
466 =======================================================
472 .. This section should contain a list of platforms that were tested
477 * <vendor> platform with <vendor> <type of devices> combinations
482 * Other relevant details...
484 This section is a comment. Do not overwrite or remove it.
485 Also, make sure to start the actual text at the margin.
486 =======================================================