1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2021 The DPDK contributors 3 4.. include:: <isonum.txt> 5 6DPDK Release 21.05 7================== 8 9.. **Read this first.** 10 11 The text in the sections below explains how to update the release notes. 12 13 Use proper spelling, capitalization and punctuation in all sections. 14 15 Variable and config names should be quoted as fixed width text: 16 ``LIKE_THIS``. 17 18 Build the docs and view the output file to ensure the changes are correct:: 19 20 make doc-guides-html 21 xdg-open build/doc/html/guides/rel_notes/release_21_05.html 22 23 24New Features 25------------ 26 27.. This section should contain new features added in this release. 28 Sample format: 29 30 * **Add a title in the past tense with a full stop.** 31 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. 35 36 If the feature adds a lot of sub-features you can use a bullet list 37 like this: 38 39 * Added feature foo to do something. 40 * Enhanced feature bar to do something else. 41 42 Refer to the previous release notes for examples. 43 44 Suggested order in release notes items: 45 * Core libs (EAL, mempool, ring, mbuf, buses) 46 * Device abstraction libs and PMDs 47 - ethdev (lib, PMDs) 48 - cryptodev (lib, PMDs) 49 - eventdev (lib, PMDs) 50 - etc 51 * Other libs 52 * Apps, Examples, Tools (if significant) 53 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 ======================================================= 57 58* **Added support for Marvell CN10K SoC drivers.** 59 60 Added Marvell CN10K SoC support. Marvell CN10K SoC are based on Octeon 10 61 family of ARM64 processors with ARM Neoverse N2 core with accelerators for 62 packet processing, timers, cryptography, etc. 63 64 * Added common/cnxk driver consisting of common API to be used by 65 net, crypto and event PMD's. 66 67* **Enhanced ethdev representor syntax.** 68 69 * Introduced representor type of VF, SF and PF. 70 * Supported sub-function and multi-host in representor syntax:: 71 72 representor=# [0,2-4] /* Legacy VF compatible. */ 73 representor=[[c#]pf#]vf# c1pf2vf3 /* VF 3 on PF 2 of controller 1. */ 74 representor=[[c#]pf#]sf# sf[0,2-1023] /* 1023 SFs. */ 75 representor=[c#]pf# c2pf[0,1] /* 2 PFs on controller 2. */ 76 77* **Updated Arkville PMD driver.** 78 79 Updated Arkville net driver with new features and improvements, including: 80 81 * Generalized passing meta data between PMD and FPGA, allowing up to 20 82 bytes of user specified information in RX and TX paths. 83 84 * Updated dynamic PMD extensions API using standardized names. 85 86 * Added support for new Atomic Rules PCI device IDs ``0x100f, 0x1010, 0x1017, 87 0x1018, 0x1019``. 88 89* **Updated Broadcom bnxt driver.** 90 91 * Updated HWRM structures to 1.10.2.15 version. 92 93* **Updated Hisilicon hns3 driver.** 94 95 * Added support for module EEPROM dumping. 96 * Added support for freeing Tx mbuf on demand. 97 * Added support for copper port in Kunpeng930. 98 * Added support for runtime config to select IO burst function. 99 * Added support for outer UDP checksum in Kunpeng930. 100 * Added support for query Tx descriptor status. 101 * Added support for query Rx descriptor status. 102 103* **Updated Intel iavf driver.** 104 105 Updated the Intel iavf driver with new features and improvements, including: 106 107 * Added flow filter to support GTPU inner L3/L4 fields matching. 108 109* **Updated NXP DPAA driver.** 110 111 * Added support for shared ethernet interface. 112 * Added support for external buffers in Tx. 113 114* **Updated NXP DPAA2 driver.** 115 116 * Added support for traffic management. 117 * Added support for configurable Tx confirmation. 118 * Added support for external buffers in Tx. 119 120* **Updated Wangxun txgbe driver.** 121 122 * Added support for txgbevf PMD. 123 * Support device arguments to handle AN training for backplane NICs. 124 125* **Enabled vmxnet3 PMD on Windows.** 126 127* **Updated the AF_XDP driver.** 128 129 * Added support for preferred busy polling. 130 131* **Updated Mellanox RegEx PMD.** 132 133 * Added support for multi-segments mbuf. 134 135* **Updated testpmd.** 136 137 * Added a command line option to configure forced speed for Ethernet port. 138 ``dpdk-testpmd -- --eth-link-speed N`` 139 * Added command to display Rx queue used descriptor count. 140 ``show port (port_id) rxq (queue_id) desc used count`` 141 142 143Removed Items 144------------- 145 146.. This section should contain removed items in this release. Sample format: 147 148 * Add a short 1-2 sentence description of the removed item 149 in the past tense. 150 151 This section is a comment. Do not overwrite or remove it. 152 Also, make sure to start the actual text at the margin. 153 ======================================================= 154 155 156API Changes 157----------- 158 159.. This section should contain API changes. Sample format: 160 161 * sample: Add a short 1-2 sentence description of the API change 162 which was announced in the previous releases and made in this release. 163 Start with a scope label like "ethdev:". 164 Use fixed width quotes for ``function_names`` or ``struct_names``. 165 Use the past tense. 166 167 This section is a comment. Do not overwrite or remove it. 168 Also, make sure to start the actual text at the margin. 169 ======================================================= 170 171* eal: The experimental TLS API added in ``rte_thread.h`` has been renamed 172 from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy 173 and confusion with the transport layer security term. 174 175* pci: The value ``PCI_ANY_ID`` is marked as deprecated 176 and can be replaced with ``RTE_PCI_ANY_ID``. 177 178 179ABI Changes 180----------- 181 182.. This section should contain ABI changes. Sample format: 183 184 * sample: Add a short 1-2 sentence description of the ABI change 185 which was announced in the previous releases and made in this release. 186 Start with a scope label like "ethdev:". 187 Use fixed width quotes for ``function_names`` or ``struct_names``. 188 Use the past tense. 189 190 This section is a comment. Do not overwrite or remove it. 191 Also, make sure to start the actual text at the margin. 192 ======================================================= 193 194* No ABI change that would break compatibility with 20.11. 195 196* The experimental function ``rte_telemetry_legacy_register`` has been 197 removed from the public API and is now an internal-only function. This 198 function was already marked as internal in the API documentation for it, 199 and was not for use by external applications. 200 201 202Known Issues 203------------ 204 205.. This section should contain new known issues in this release. Sample format: 206 207 * **Add title in present tense with full stop.** 208 209 Add a short 1-2 sentence description of the known issue 210 in the present tense. Add information on any known workarounds. 211 212 This section is a comment. Do not overwrite or remove it. 213 Also, make sure to start the actual text at the margin. 214 ======================================================= 215 216 217Tested Platforms 218---------------- 219 220.. This section should contain a list of platforms that were tested 221 with this release. 222 223 The format is: 224 225 * <vendor> platform with <vendor> <type of devices> combinations 226 227 * List of CPU 228 * List of OS 229 * List of devices 230 * Other relevant details... 231 232 This section is a comment. Do not overwrite or remove it. 233 Also, make sure to start the actual text at the margin. 234 ======================================================= 235