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 IDXD dmadev driver implementation.**
80 The IDXD dmadev driver provide device drivers for the Intel DSA devices.
81 This device driver can be used through the generic dmadev API.
83 * **Added IOAT dmadev driver implementation.**
85 The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
86 driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
87 Skylake and Broadwell. This device driver can be used through the generic dmadev API.
89 * **Added support to get all MAC addresses of a device.**
91 Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
92 addresses assigned to given ethernet port.
94 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
96 Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
97 TCP/UDP/SCTP header checksum field can be used as input set for RSS.
99 * **Added flow flex item.**
101 The configurable flow flex item provides the capability to introduce
102 an arbitrary user-specified network protocol header,
103 configure the hardware accordingly, and perform match on this header
104 with desired patterns and masks.
106 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
108 A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
109 The following parts of Rx metadata were defined:
111 * ``RTE_ETH_RX_METADATA_USER_FLAG``
112 * ``RTE_ETH_RX_METADATA_USER_MARK``
113 * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
115 * **Added an API to get a proxy port to manage "transfer" flows.**
117 A new API, ``rte_flow_pick_transfer_proxy()``, was added.
119 * **Updated af_packet ethdev driver.**
121 * Default VLAN strip behavior was changed. VLAN tag won't be stripped
122 unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
124 * **Added API to get device configuration in ethdev.**
126 Added an ethdev API which can help users get device configuration.
128 * **Updated AF_XDP PMD.**
130 * Disabled secondary process support.
132 * **Updated Amazon ENA PMD.**
134 Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
135 bug fixes and improvements, including:
137 * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
138 * NUMA aware allocations for the queue helper structures.
139 * Watchdog's feature which is checking for missing Tx completions.
141 * **Updated Broadcom bnxt PMD.**
143 * Added flow offload support for Thor.
144 * Implement support for tunnel offload.
145 * Updated HWRM API to version 1.10.2.44
147 * **Updated Intel iavf driver.**
149 * Added Intel iavf support on Windows.
150 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
152 * **Updated Intel ice driver.**
154 * Added 1PPS out support by a devargs.
155 * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
156 * Added DEV_RX_OFFLOAD_TIMESTAMP support.
157 * Added timesync API support under scalar path.
159 * **Updated Intel ixgbe driver.**
161 * Added Intel ixgbe support on Windows.
163 * **Updated Marvell cnxk ethdev driver.**
165 * Added rte_flow support for dual VLAN insert and strip actions.
166 * Added rte_tm support.
167 * Added support for Inline IPsec for CN9K event mode and CN10K
168 poll mode and event mode.
169 * Added support for ingress meter for CN10K platform.
171 * **Updated Mellanox mlx5 driver.**
173 Updated the Mellanox mlx5 driver with new features and improvements, including:
175 * Added implicit mempool registration to avoid data path hiccups (opt-out).
176 * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
178 * **Updated Solarflare network PMD.**
180 Updated the Solarflare ``sfc_efx`` driver with changes including:
182 * Added port representors support on SN1000 SmartNICs
183 * Added flow API transfer proxy support
185 * **Updated Marvell cnxk crypto PMD.**
187 * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
188 * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
189 * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
190 * Added support for lookaside protocol (IPsec) offload for CN9K.
191 * Added support for ZUC algorithm with 256-bit key length for CN10K.
192 * Added support for CN98xx dual block.
193 * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
195 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
197 * Added event crypto adapter OP_FORWARD mode support.
199 * **Updated NXP dpaa_sec crypto PMD.**
201 * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
202 * Added PDCP short MAC-I support.
203 * Added raw vector datapath API support.
205 * **Updated NXP dpaa2_sec crypto PMD.**
207 * Added PDCP short MAC-I support.
208 * Added raw vector datapath API support.
210 * **Updated the ACC100 bbdev PMD.**
212 Added support for more comprehensive CRC options.
214 * **Updated the turbo_sw bbdev PMD.**
216 Added support for more comprehensive CRC options.
218 * **Added NXP LA12xx baseband PMD.**
220 * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
221 * See the :doc:`../bbdevs/la12xx` for more details.
223 * **Updated IPsec library.**
225 * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
227 * Added support for NAT-T / UDP encapsulated ESP.
228 * Added support for SA telemetry.
229 * Added support for setting a non default starting ESN value.
231 * **Added multi-process support for testpmd.**
233 Added command-line options to specify total number of processes and
234 current process ID. Each process owns subset of Rx and Tx queues.
236 * **Updated test-crypto-perf application with new cases.**
238 * Added support for asymmetric crypto throughput performance measurement.
239 Only modex is supported for now.
240 * Added support for lookaside IPsec protocol offload throughput measurement.
242 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
244 * Added known vector tests (AES-GCM 128, 192, 256).
245 * Added tests to verify error reporting with ICV corruption.
246 * Added tests to verify IV generation.
247 * Added tests to verify UDP encapsulation.
248 * Added tests to verify UDP encapsulation ports.
249 * Added tests to validate packets soft expiry.
250 * Added tests to validate packets hard expiry.
251 * Added tests to verify tunnel header verification in IPsec inbound.
252 * Added tests to verify inner checksum.
254 * **Revised packet capture framework.**
256 * New dpdk-dumpcap program that has most of the features
257 of the wireshark dumpcap utility including:
258 capture of multiple interfaces, filtering,
259 and stopping after number of bytes, packets.
260 * New library for writing pcapng packet capture files.
261 * Enhancements to the pdump library to support:
262 * Packet filter with BPF.
263 * Pcapng format with timestamps and meta-data.
264 * Fixes packet capture with stripped VLAN tags.
270 .. This section should contain removed items in this release. Sample format:
272 * Add a short 1-2 sentence description of the removed item
275 This section is a comment. Do not overwrite or remove it.
276 Also, make sure to start the actual text at the margin.
277 =======================================================
279 * eal: Removed the deprecated function ``rte_get_master_lcore()``
280 and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
282 * eal: The old api arguments that were deprecated for
283 blacklist/whitelist are removed. Users must use the new
284 block/allow list arguments.
286 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
287 ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
289 * ethdev: Removed the port mirroring API. A more fine-grain flow API
290 action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
291 The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
292 the functions ``rte_eth_mirror_rule_set`` and
293 ``rte_eth_mirror_rule_reset`` along with the associated macros
294 ``ETH_MIRROR_*`` are removed.
296 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
297 driver callback. It is replaced by the more complete function
298 ``rte_eth_rx_descriptor_status``.
300 * ethdev: Removed deprecated ``shared`` attribute of the
301 ``struct rte_flow_action_count``. Shared counters should be managed
302 using indirect actions API (``rte_flow_action_handle_create`` etc).
304 * i40e: Removed i40evf driver.
305 iavf already became the default VF driver for i40e devices,
306 so there is no need to maintain i40evf.
312 .. This section should contain API changes. Sample format:
314 * sample: Add a short 1-2 sentence description of the API change
315 which was announced in the previous releases and made in this release.
316 Start with a scope label like "ethdev:".
317 Use fixed width quotes for ``function_names`` or ``struct_names``.
320 This section is a comment. Do not overwrite or remove it.
321 Also, make sure to start the actual text at the margin.
322 =======================================================
324 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
325 removed. Its usages have been replaced by a new function
326 ``rte_kvargs_get_with_value()``.
328 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
329 Calls to ``cmdline_free()`` after it need to be deleted from applications.
331 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
333 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
334 to dynamically allocate and free it, and to access user data in callbacks.
336 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
337 that objects from this pool will not be used for device IO (e.g. DMA).
339 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
340 Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
342 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
343 The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
345 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
346 deprecated. Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
348 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
349 will be removed in DPDK 22.11.
351 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
352 to ``src_addr`` and ``dst_addr``, respectively.
354 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
355 Existing ``version_ihl`` field is kept for backward compatibility.
357 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
360 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
361 Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
363 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
364 with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
366 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
367 array is extended, data pointer field is explicitly added to union, the
368 action behavior is defined in more strict fashion and documentation updated.
369 The immediate value behavior has been changed, the entire immediate field
370 should be provided, and offset for immediate source bitfield is assigned
371 from destination one.
373 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
374 rte_cryptodev_is_valid_dev as it can be used by the application as
375 well as PMD to check whether the device is valid or not.
377 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
378 as it is for drivers only and should be private to DPDK, and not
379 installed for app use.
381 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
382 renamed to ``aux_flags`` to indicate warnings and other information from
383 the crypto/security operation. This field will be used to communicate
384 events such as soft expiry with IPsec in lookaside mode.
386 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
387 moved to the end of the structure and extended to ``uint32_t``.
389 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
390 field to support total buffer length to facilitate protocol offload case.
392 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
393 ``dest_sgl`` to support out of place processing.
395 * bbdev: Added device info related to data byte endianness processing.
397 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
398 TLB misses if any and aligns to memory structure of other subsystems.
404 .. This section should contain ABI changes. Sample format:
406 * sample: Add a short 1-2 sentence description of the ABI change
407 which was announced in the previous releases and made in this release.
408 Start with a scope label like "ethdev:".
409 Use fixed width quotes for ``function_names`` or ``struct_names``.
412 This section is a comment. Do not overwrite or remove it.
413 Also, make sure to start the actual text at the margin.
414 =======================================================
416 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
417 Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
418 to internal queue data as input parameter. While this change is transparent
419 to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
420 is used by public inline function ``rte_eth_rx_queue_count``.
422 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
423 private data structures. ``rte_eth_devices[]`` can't be accessed directly
424 by user any more. While it is an ABI breakage, this change is intended
425 to be transparent for both users (no changes in user app is required) and
426 PMD developers (no changes in PMD is required).
428 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
429 routines used by inline outbound and inline inbound security processing were
430 made inline and enhanced to do simple 64-bit set/get for PMDs that do not
431 have much processing in PMD specific callbacks but just 64-bit set/get.
432 This avoids a per packet function pointer jump overhead for such PMDs.
434 * security: A new option ``iv_gen_disable`` was added in structure
435 ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
436 so that application can provide its own IV and test known test vectors.
438 * security: A new option ``tunnel_hdr_verify`` was added in structure
439 ``rte_security_ipsec_sa_options`` to indicate whether outer header
440 verification need to be done as part of inbound IPsec processing.
442 * security: A new option ``udp_ports_verify`` was added in structure
443 ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
444 verification need to be done as part of inbound IPsec processing.
446 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
447 replace ``esn_soft_limit`` in IPsec configuration structure
448 ``rte_security_ipsec_xform`` to allow applications to configure SA soft
449 and hard expiry limits. Limits can be either in number of packets or bytes.
451 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
452 in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
453 packet IPv4 header checksum and L4 checksum need to be offloaded to
456 * security: A new structure ``esn`` was added in structure
457 ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
458 application to start from an arbitrary ESN value for debug and SA lifetime
459 enforcement purposes.
461 * security: A new structure ``udp`` was added in structure
462 ``rte_security_ipsec_xform`` to allow setting the source and destination ports
463 for UDP encapsulated IPsec traffic.
465 * bbdev: Added capability related to more comprehensive CRC options,
466 shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
468 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
469 were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
472 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
473 by the fastpath inline functions. The structures ``rte_eventdev``,
474 ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
475 accessed directly by user any more. This change is transparent to both
476 applications and PMDs.
478 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
484 .. This section should contain new known issues in this release. Sample format:
486 * **Add title in present tense with full stop.**
488 Add a short 1-2 sentence description of the known issue
489 in the present tense. Add information on any known workarounds.
491 This section is a comment. Do not overwrite or remove it.
492 Also, make sure to start the actual text at the margin.
493 =======================================================
499 .. This section should contain a list of platforms that were tested
504 * <vendor> platform with <vendor> <type of devices> combinations
509 * Other relevant details...
511 This section is a comment. Do not overwrite or remove it.
512 Also, make sure to start the actual text at the margin.
513 =======================================================