xref: /dpdk/doc/guides/rel_notes/release_25_03.rst (revision c1d145834f287aa8cf53de914618a7312f2c360e)
17df61db6SDavid Marchand.. SPDX-License-Identifier: BSD-3-Clause
27df61db6SDavid Marchand   Copyright 2024 The DPDK contributors
37df61db6SDavid Marchand
47df61db6SDavid Marchand.. include:: <isonum.txt>
57df61db6SDavid Marchand
67df61db6SDavid MarchandDPDK Release 25.03
77df61db6SDavid Marchand==================
87df61db6SDavid Marchand
97df61db6SDavid Marchand.. **Read this first.**
107df61db6SDavid Marchand
117df61db6SDavid Marchand   The text in the sections below explains how to update the release notes.
127df61db6SDavid Marchand
137df61db6SDavid Marchand   Use proper spelling, capitalization and punctuation in all sections.
147df61db6SDavid Marchand
157df61db6SDavid Marchand   Variable and config names should be quoted as fixed width text:
167df61db6SDavid Marchand   ``LIKE_THIS``.
177df61db6SDavid Marchand
187df61db6SDavid Marchand   Build the docs and view the output file to ensure the changes are correct::
197df61db6SDavid Marchand
207df61db6SDavid Marchand      ninja -C build doc
217df61db6SDavid Marchand      xdg-open build/doc/guides/html/rel_notes/release_25_03.html
227df61db6SDavid Marchand
237df61db6SDavid Marchand
247df61db6SDavid MarchandNew Features
257df61db6SDavid Marchand------------
267df61db6SDavid Marchand
277df61db6SDavid Marchand.. This section should contain new features added in this release.
287df61db6SDavid Marchand   Sample format:
297df61db6SDavid Marchand
307df61db6SDavid Marchand   * **Add a title in the past tense with a full stop.**
317df61db6SDavid Marchand
327df61db6SDavid Marchand     Add a short 1-2 sentence description in the past tense.
337df61db6SDavid Marchand     The description should be enough to allow someone scanning
347df61db6SDavid Marchand     the release notes to understand the new feature.
357df61db6SDavid Marchand
367df61db6SDavid Marchand     If the feature adds a lot of sub-features you can use a bullet list
377df61db6SDavid Marchand     like this:
387df61db6SDavid Marchand
397df61db6SDavid Marchand     * Added feature foo to do something.
407df61db6SDavid Marchand     * Enhanced feature bar to do something else.
417df61db6SDavid Marchand
427df61db6SDavid Marchand     Refer to the previous release notes for examples.
437df61db6SDavid Marchand
447df61db6SDavid Marchand     Suggested order in release notes items:
457df61db6SDavid Marchand     * Core libs (EAL, mempool, ring, mbuf, buses)
467df61db6SDavid Marchand     * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
477df61db6SDavid Marchand       - ethdev (lib, PMDs)
487df61db6SDavid Marchand       - cryptodev (lib, PMDs)
497df61db6SDavid Marchand       - eventdev (lib, PMDs)
507df61db6SDavid Marchand       - etc
517df61db6SDavid Marchand     * Other libs
527df61db6SDavid Marchand     * Apps, Examples, Tools (if significant)
537df61db6SDavid Marchand
547df61db6SDavid Marchand     This section is a comment. Do not overwrite or remove it.
557df61db6SDavid Marchand     Also, make sure to start the actual text at the margin.
567df61db6SDavid Marchand     =======================================================
577df61db6SDavid Marchand
58b5458e2cSKonstantin Ananyev* **Added Staged-Ordered-Ring (SORING) API to the ring library.**
59b5458e2cSKonstantin Ananyev
60b5458e2cSKonstantin Ananyev  New API was added to the ring library to provide a SW abstraction
61b5458e2cSKonstantin Ananyev  for ordered queues with multiple processing stages.
62b5458e2cSKonstantin Ananyev  It is based on conventional DPDK rte_ring, re-uses many of its concepts,
63b5458e2cSKonstantin Ananyev  and even substantial part of its code.
64b5458e2cSKonstantin Ananyev  It can be viewed as an extension of rte_ring functionality.
65b5458e2cSKonstantin Ananyev
66d3bc77abSTudor Cornea* **Updated af_packet net driver.**
67d3bc77abSTudor Cornea
68d3bc77abSTudor Cornea  * Added ability to option to configure receive packet fanout mode.
696b324624SStefan Laesser  * Added statistics for failed buffer allocation and missed packets.
70d3bc77abSTudor Cornea
71186f8e8cSJesna K E* **Updated AMD axgbe driver.**
72186f8e8cSJesna K E
73186f8e8cSJesna K E  * Added support for the TCP Segmentation Offload (TSO).
74186f8e8cSJesna K E
75950820f1SZaiyu Wang* **Updated Wangxun ngbe driver.**
76950820f1SZaiyu Wang
77950820f1SZaiyu Wang  * Added support for virtual function (VF).
78950820f1SZaiyu Wang
797df61db6SDavid Marchand
807df61db6SDavid MarchandRemoved Items
817df61db6SDavid Marchand-------------
827df61db6SDavid Marchand
837df61db6SDavid Marchand.. This section should contain removed items in this release. Sample format:
847df61db6SDavid Marchand
857df61db6SDavid Marchand   * Add a short 1-2 sentence description of the removed item
867df61db6SDavid Marchand     in the past tense.
877df61db6SDavid Marchand
887df61db6SDavid Marchand   This section is a comment. Do not overwrite or remove it.
897df61db6SDavid Marchand   Also, make sure to start the actual text at the margin.
907df61db6SDavid Marchand   =======================================================
917df61db6SDavid Marchand
927df61db6SDavid Marchand
937df61db6SDavid MarchandAPI Changes
947df61db6SDavid Marchand-----------
957df61db6SDavid Marchand
967df61db6SDavid Marchand.. This section should contain API changes. Sample format:
977df61db6SDavid Marchand
987df61db6SDavid Marchand   * sample: Add a short 1-2 sentence description of the API change
997df61db6SDavid Marchand     which was announced in the previous releases and made in this release.
1007df61db6SDavid Marchand     Start with a scope label like "ethdev:".
1017df61db6SDavid Marchand     Use fixed width quotes for ``function_names`` or ``struct_names``.
1027df61db6SDavid Marchand     Use the past tense.
1037df61db6SDavid Marchand
1047df61db6SDavid Marchand   This section is a comment. Do not overwrite or remove it.
1057df61db6SDavid Marchand   Also, make sure to start the actual text at the margin.
1067df61db6SDavid Marchand   =======================================================
1077df61db6SDavid Marchand
108154303b0SAndre Muezerie* eal: The ``__rte_packed`` macro for packing data is replaced with
109154303b0SAndre Muezerie  ``__rte_packed_begin`` / ``__rte_packed_end``.
110154303b0SAndre Muezerie
111*c1d14583SBruce Richardson* build: The Intel networking drivers:
112*c1d14583SBruce Richardson  cpfl, e1000, fm10k, i40e, iavf, ice, idpf, igc, ipn3ke and ixgbe,
113*c1d14583SBruce Richardson  have been moved from ``drivers/net`` to a new ``drivers/net/intel`` directory.
114*c1d14583SBruce Richardson  The resulting build output, including the driver filenames, is the same,
115*c1d14583SBruce Richardson  but to enable/disable these drivers via Meson option requires use of the new paths.
116*c1d14583SBruce Richardson  For example, ``-Denable_drivers=/net/i40e`` becomes ``-Denable_drivers=/net/intel/i40e``.
117*c1d14583SBruce Richardson
1187df61db6SDavid Marchand
1197df61db6SDavid MarchandABI Changes
1207df61db6SDavid Marchand-----------
1217df61db6SDavid Marchand
1227df61db6SDavid Marchand.. This section should contain ABI changes. Sample format:
1237df61db6SDavid Marchand
1247df61db6SDavid Marchand   * sample: Add a short 1-2 sentence description of the ABI change
1257df61db6SDavid Marchand     which was announced in the previous releases and made in this release.
1267df61db6SDavid Marchand     Start with a scope label like "ethdev:".
1277df61db6SDavid Marchand     Use fixed width quotes for ``function_names`` or ``struct_names``.
1287df61db6SDavid Marchand     Use the past tense.
1297df61db6SDavid Marchand
1307df61db6SDavid Marchand   This section is a comment. Do not overwrite or remove it.
1317df61db6SDavid Marchand   Also, make sure to start the actual text at the margin.
1327df61db6SDavid Marchand   =======================================================
1337df61db6SDavid Marchand
1347df61db6SDavid Marchand* No ABI change that would break compatibility with 24.11.
1357df61db6SDavid Marchand
1367df61db6SDavid Marchand
1377df61db6SDavid MarchandKnown Issues
1387df61db6SDavid Marchand------------
1397df61db6SDavid Marchand
1407df61db6SDavid Marchand.. This section should contain new known issues in this release. Sample format:
1417df61db6SDavid Marchand
1427df61db6SDavid Marchand   * **Add title in present tense with full stop.**
1437df61db6SDavid Marchand
1447df61db6SDavid Marchand     Add a short 1-2 sentence description of the known issue
1457df61db6SDavid Marchand     in the present tense. Add information on any known workarounds.
1467df61db6SDavid Marchand
1477df61db6SDavid Marchand   This section is a comment. Do not overwrite or remove it.
1487df61db6SDavid Marchand   Also, make sure to start the actual text at the margin.
1497df61db6SDavid Marchand   =======================================================
1507df61db6SDavid Marchand
1517df61db6SDavid Marchand
1527df61db6SDavid MarchandTested Platforms
1537df61db6SDavid Marchand----------------
1547df61db6SDavid Marchand
1557df61db6SDavid Marchand.. This section should contain a list of platforms that were tested
1567df61db6SDavid Marchand   with this release.
1577df61db6SDavid Marchand
1587df61db6SDavid Marchand   The format is:
1597df61db6SDavid Marchand
1607df61db6SDavid Marchand   * <vendor> platform with <vendor> <type of devices> combinations
1617df61db6SDavid Marchand
1627df61db6SDavid Marchand     * List of CPU
1637df61db6SDavid Marchand     * List of OS
1647df61db6SDavid Marchand     * List of devices
1657df61db6SDavid Marchand     * Other relevant details...
1667df61db6SDavid Marchand
1677df61db6SDavid Marchand   This section is a comment. Do not overwrite or remove it.
1687df61db6SDavid Marchand   Also, make sure to start the actual text at the margin.
1697df61db6SDavid Marchand   =======================================================
170