1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2023 The DPDK contributors 3 4.. include:: <isonum.txt> 5 6DPDK Release 24.03 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 ninja -C build doc 21 xdg-open build/doc/guides/html/rel_notes/release_24_03.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 (ordered alphabetically by vendor name) 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 HiSilicon UACCE bus support.** 59 60 UACCE (Unified/User-space-access-intended Accelerator Framework) bus driver 61 has been added, so that the accelerator devices could be seen in DPDK and could 62 be further registered such as a compress, crypto, DMA and ethernet devices. 63 64* **Introduced argument parsing library.** 65 66 The argparse library was added to ease writing user-friendly applications, 67 replacing ``getopt()`` usage. 68 69* **Improved RSS hash algorithm support.** 70 71 Added new function ``rte_eth_find_rss_algo`` 72 to get RSS hash algorithm by its name. 73 74* **Updated Marvell cnxk crypto driver.** 75 76 * Added support for Rx inject in crypto_cn10k. 77 * Added support for TLS record processing in crypto_cn10k 78 to support TLS v1.2, TLS v1.3 and DTLS v1.2. 79 * Added PMD API to allow raw submission of instructions to CPT. 80 81 82Removed Items 83------------- 84 85.. This section should contain removed items in this release. Sample format: 86 87 * Add a short 1-2 sentence description of the removed item 88 in the past tense. 89 90 This section is a comment. Do not overwrite or remove it. 91 Also, make sure to start the actual text at the margin. 92 ======================================================= 93 94* log: Removed the statically defined logtypes that were used internally by DPDK. 95 All code should be using the dynamic logtypes (see ``RTE_LOG_REGISTER()``). 96 The application reserved statically defined logtypes ``RTE_LOGTYPE_USER1..RTE_LOGTYPE_USER8`` 97 are still defined. 98 99 100API Changes 101----------- 102 103.. This section should contain API changes. Sample format: 104 105 * sample: Add a short 1-2 sentence description of the API change 106 which was announced in the previous releases and made in this release. 107 Start with a scope label like "ethdev:". 108 Use fixed width quotes for ``function_names`` or ``struct_names``. 109 Use the past tense. 110 111 This section is a comment. Do not overwrite or remove it. 112 Also, make sure to start the actual text at the margin. 113 ======================================================= 114 115* eal: Removed ``typeof(type)`` from the expansion of ``RTE_DEFINE_PER_LCORE`` 116 and ``RTE_DECLARE_PER_LCORE`` macros aligning them with their intended design. 117 If use with an expression is desired applications can adapt by supplying 118 ``typeof(e)`` as an argument. 119 120* eal: Improved ``RTE_BUILD_BUG_ON`` by using C11 ``static_assert``. 121 Non-constant expressions are now rejected instead of being silently ignored. 122 123* gso: ``rte_gso_segment`` now returns -ENOTSUP for unknown protocols. 124 125 126ABI Changes 127----------- 128 129.. This section should contain ABI changes. Sample format: 130 131 * sample: Add a short 1-2 sentence description of the ABI change 132 which was announced in the previous releases and made in this release. 133 Start with a scope label like "ethdev:". 134 Use fixed width quotes for ``function_names`` or ``struct_names``. 135 Use the past tense. 136 137 This section is a comment. Do not overwrite or remove it. 138 Also, make sure to start the actual text at the margin. 139 ======================================================= 140 141* No ABI change that would break compatibility with 23.11. 142 143 144Known Issues 145------------ 146 147.. This section should contain new known issues in this release. Sample format: 148 149 * **Add title in present tense with full stop.** 150 151 Add a short 1-2 sentence description of the known issue 152 in the present tense. Add information on any known workarounds. 153 154 This section is a comment. Do not overwrite or remove it. 155 Also, make sure to start the actual text at the margin. 156 ======================================================= 157 158 159Tested Platforms 160---------------- 161 162.. This section should contain a list of platforms that were tested 163 with this release. 164 165 The format is: 166 167 * <vendor> platform with <vendor> <type of devices> combinations 168 169 * List of CPU 170 * List of OS 171 * List of devices 172 * Other relevant details... 173 174 This section is a comment. Do not overwrite or remove it. 175 Also, make sure to start the actual text at the margin. 176 ======================================================= 177