summaryrefslogtreecommitdiff
path: root/doc/develop
AgeCommit message (Collapse)Author
3 daysdoc: develop: process: Document using b4 and patchwork for custodiansTom Rini
- We already have good custodian documentation for patchwork, add a reference and then link to it here. - Add a reference to the existing b4 documentation, and reference it here. - Note and link to patchwork integration, am/shazam and ty features of b4 as these are the most likely useful portions. Be specific about keeping the default ${summary} as that includes important information. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: sending_patches: Update link to patchworkTom Rini
Make use of an anonymous reference for the external link here, per rST best practices. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: codingstyle: Update b4 external linkTom Rini
Rather than pointing at the source code for b4, point the the official documentation. Also, use an anonymous reference for the link, per rST best practices. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: process: Make "Work flow of a Custodian" a subsectionTom Rini
Make the "Work flow of a Custodian" section be a subsection of the Custodians section. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Michael Trimarchi <michael@amarulasolutions.com>
3 daysdoc: develop: process: Move Custodians sectionTom Rini
Move the "Custodians" section to be after the "Review Process, Git Tags" section, in preparation for more re-organization. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: process: Explain when/how Custodians may edit patchesTom Rini
As seen with commit d503633a3676 ("Revert "doc: board: starfive: update jh7110 common description""), it has not always been clear what is and isn't allowed by custodians, and what the expectations are. To prevent further unintentional conflicts, document the limited cases where custodians are allowed to modify patches directly, and how to do that. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: process: Rework the custodian feedback sectionTom Rini
Now that we have two items here, rework this slightly to be using bullet points, and so easier to expand on. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
3 daysdoc: develop: process: Move the existing block about patch applicationTom Rini
We have a long block about the expectations and feedback about a patch applying, or not, as part of the Custodian workflow. Move this to the Custodians section from the Workflow of a custodian section. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
5 daysPrepare v2026.04-rc1v2026.04-rc1Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
13 daysUpdate links to doc/develop/falcon.rstJ. Neuschäfer
README.falcon was converted to ReST/HTML in 2023. Signed-off-by: J. Neuschäfer <j.ne@posteo.net> Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2026-01-12Merge patch series "a few test.py improvements"Tom Rini
David Lechner <dlechner@baylibre.com> says: While trying to run the test suite for the first time, I encountered a few minor issues. Here are a few patches to address them. Link: https://lore.kernel.org/r/20260105-a-few-test-py-improvements-v3-0-fea38243ca5b@baylibre.com
2026-01-12doc: pytest: mention additional requirements for venvDavid Lechner
Add a paragraph explaining that in addition to the requirements.txt for test/py/test.py itself, users may need to install additional python packages depending on the U-Boot configuration being built. Reviewed-by: Simon Glass <simon.glass@canonical.com> Tested-by: Mattijs Korpershoek <mkorpershoek@kernel.org> # sandbox Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org> Signed-off-by: David Lechner <dlechner@baylibre.com>
2026-01-05Merge branch 'next'Tom Rini
2026-01-05Prepare v2026.01v2026.01Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2026-01-02kbuild: Bump the build system to 6.1Sughosh Ganu
Our last sync with the kernel was 5.1. We are so out of sync now, that tracking the patches and backporting them one by one makes little sense and it's going to take ages. This is an attempt to sync up Makefiles to 6.1. Unfortunately due to sheer amount of patches this is not easy to review, but that's what we decided during a community call for the bump to 5.1, so we are following the same guidelines here. Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>a #rebased on -next
2025-12-22Prepare v2026.01-rc5v2026.01-rc5Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-12-18doc: pytest: fix typo in multiple config options example for buildconfigspecQuentin Schulz
The option should be 'net_lwip' and not 'net lwip' (see all usage of it in the test code base). Fixes: 2bac578c5aba ("test: allow multiple config options in buildconfigspec") Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Jerome Forissier <jerome.forissier@linaro.org> Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org>
2025-12-08Prepare v2026.01-rc4v2026.01-rc4Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-12-06doc: pytest: add missing hook script env varsDavid Lechner
Add the _EXTRA variants of U_BOOT_BUILD_DIR and U_BOOT_RESULT_DIR to the list of environment variables set for hook scripts. These were added in commit 8f2a9fa7d6e7 ("test: Support testing with two board-builds") but were not documented. Signed-off-by: David Lechner <dlechner@baylibre.com>
2025-12-06doc: pytest: fix hook script environment variable namesDavid Lechner
Fix the names of environment variables set for hook scripts. These have a U_BOOT_ prefix, not UBOOT_. Signed-off-by: David Lechner <dlechner@baylibre.com>
2025-11-24Prepare v2026.01-rc3v2026.01-rc3Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-11-21doc: pytest: fix u-boot-test-flash typoDavid Lechner
Fix typo: `s/u-boot-test-flash1/u-boot-test-flash/`. The correct name of the script doesn't have a "1" in it. Signed-off-by: David Lechner <dlechner@baylibre.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-11-21doc: describe return values of C testsHeinrich Schuchardt
* Enumerate return values of C tests * Reference assertion macros Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-11-21doc: make writing DM test subsection of writing C testHeinrich Schuchardt
A driver model test is just a special case of a C test. Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-11-15doc: pytest: Complete dependencies list with missing packagesKory Maincent (TI.com)
Add missing dependencies to the pytest usage documentation and correct the device tree compiler package name from 'dtc' to 'device-tree-compiler'. This ensures users have the complete list of dependencies needed to run the pytest test suite without errors. Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org> Signed-off-by: Kory Maincent (TI.com) <kory.maincent@bootlin.com> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-11-10Prepare v2026.01-rc2v2026.01-rc2Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-11-06doc: bootstd: Describe the optional extension_overlay_addr environmentKory Maincent (TI.com)
Add extension_overlay_addr description to the list of environment variables that can be useful during the standard boot. Signed-off-by: Kory Maincent (TI.com) <kory.maincent@bootlin.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2025-11-06doc: bootstd: Remove extension support from TODO listKory Maincent (TI.com)
Now that extension support has been added to extlinux and efi bootmeths we can remove this line from the TODO list. Signed-off-by: Kory Maincent (TI.com) <kory.maincent@bootlin.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2025-11-04Merge patch series "Enable Firmware Handoff CI test on qemu_arm64"Tom Rini
Raymond Mao <raymond.mao@linaro.org> says: This patch series enable Firmware Handoff [1] CI tests on qemu_arm64 by: 1. fetch MbedTLS (v3.6), OP-TEE (v4.7.0) and TF-A (v2.13.0); 2. build bl1 and fip with both Firmware Handoff and Measured Boot enabled; 3. pytest to validate the Firmware Handoff feature via bloblist by checking the existence of expected FDT nodes and TPM events generated and handed over from TF-A/OP-TEE. [1] https://github.com/FirmwareHandoff/firmware_handoff Link: https://lore.kernel.org/r/20251021181703.598342-1-raymond.mao@linaro.org
2025-11-04pytest: add test script to validate Firmware HandoffRaymond Mao
Add test cases to validate FDT and TPM eventlog handoff from TF-A and OP-TEE via bloblist. For FDT, the nodes 'reserved-memory' and 'firmware' appended by OP-TEE indicates a successful handoff. For TPM eventlog, the events 'SECURE_RT_EL3', 'SECURE_RT_EL1_OPTEE' and 'SECURE_RT_EL1_OPTEE_EXTRA1' created by TF-A indicates a successful handoff. Signed-off-by: Raymond Mao <raymond.mao@linaro.org> Reviewed-by: Tom Rini <trini@konsulko.com>
2025-11-03doc: develop: add docs for secure falcon modeAnshul Dalal
This patch documents the newly added SPL_OS_BOOT_SECURE option that enables authenticated boot in falcon mode. The document provides steps for using secure falcon mode on ARM64 taking TI's AM62x EVM as an example. Signed-off-by: Anshul Dalal <anshuld@ti.com>
2025-10-27Prepare v2026.01-rc1v2026.01-rc1Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-10-26doc: develop: virtio: Fix qemu example (true/false -> on/off)Wolfgang Wallner
The given qemu examples use true/false, while qemu actually on/off. Signed-off-by: Wolfgang Wallner <wolfgang.wallner@br-automation.com>
2025-10-26doc: Fix typosWolfgang Wallner
Fix typos/wording in various files in doc/. Signed-off-by: Wolfgang Wallner <wolfgang.wallner@br-automation.com> Reviewed-by: E Shattow <e@freeshell.de>
2025-10-24bootstd: make it possible to use tftp for netboot with standardbootBenjamin Hahn
Add the option to load the bootscript with the tftp command (static IP) instead of the dhcp command (dynamic IP). For this a new function tftpb_run similar to dhcp_run, is needed. The selection of which command to use can be done with the ip_dyn environment variable, which can be set to yes or no. The ip_dyn variable was chosen as it is already in use on the imx platforms. Also edit the bootstd doc. Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Benjamin Hahn <B.Hahn@phytec.de>
2025-10-22boot: Run global bootmeths after all bootdevs are exhaustedSimon Glass
When there are no more bootdevs we should still go through the global bootmeths, since some may not have yet been used, if their priority has not yet come up. Add a final check for this at the end of the iterator. Update the documentation to match the new behaviour of global bootmeths. Signed-off-by: Simon Glass <sjg@chromium.org>
2025-10-13bootstd: rauc: extend and fix doc to reflect real flowAndreas Pretzsch
The documentation of bootmeth rauc in some aspects does not reflect the real program flow. Specifically the reset of boot tries in case of "no more slots found" is incorrect (it won't change BOOT_ORDER). Also the search sequence for boot scripts was mixed and incomplete. Fix these points in the documentation. Explain the initial setup of any missing BOOT_ORDER and BOOT_x_LEFT environment variables, and inform about BOOT_x_LEFT decrementing. Signed-off-by: Andreas Pretzsch <apr@cn-eng.de> Reviewed-by: Martin Schwan <m.schwan@phytec.de>
2025-10-08scripts/checkpatch.pl: Resync with v6.17Kory Maincent
This resyncs us with the version found in v6.17 of the Linux kernel with the following exceptions: - Keep our u-boot specific tests / code area. - Keep the location of our checkpatch.rst - Change the "use strscpy" test as we don't have that to strlcpy - Keep debug/printf in the list for $logFunctions - Keep checks to "env" files - Keep our tests for strncpy/strncat This also syncs the spdxcheck.py tool and all the associated documentation. Signed-off-by: Kory Maincent <kory.maincent@bootlin.com> [trini: Keep our strlcpy/cat check] Signed-off-by: Tom Rini <trini@konsulko.com>
2025-10-06Merge branch 'next'Tom Rini
Merge the outstanding changes from the 'next' branch to master.
2025-10-06Prepare v2025.10v2025.10Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2025-10-03cmd: spl: Remove ATAG support from this commandTom Rini
While we continue to have some systems which support extremely legacy OS booting methods, we do not have use cases for supporting this in Falcon mode anymore. Remove this support and references from the documentation. Co-developed-by: Anshul Dalal <anshuld@ti.com> Signed-off-by: Tom Rini <trini@konsulko.com>
2025-10-03doc: pytest: Fix inline code and other formattingMartin Schwan
Mainly fix inline code and some other formatting mistakes. Inline code uses double backticks `` in reStructuredText instead of single backticks as in Markdown. Also fix some smaller formatting issues, such as excess colons before literal blocks. Signed-off-by: Martin Schwan <m.schwan@phytec.de>
2025-10-03doc: Update coding style to recommend b4 for patch submissionJavier Tia
Replace references to patman with b4 as the recommended tool for preparing and sending patches. b4 is widely adopted in the Linux kernel community and U-Boot ships with configuration to simplify its use with the project mailing list. The updated guidelines describe how to prepare series with b4, handle cover letters and recipient lists, run style checks, and send patches safely. Instructions also highlight how to collect and apply review tags before resending. This change documents the preferred workflow for contributors and ensures consistency with common practices across related upstream communities. Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org> Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org> Signed-off-by: Javier Tia <javier.tia@linaro.org>
2025-10-03doc: develop: fix grammar and syntaxYegor Yefremov
Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2025-09-30Merge tag 'u-boot-socfpga-next-20250930' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-socfpga into next SoCFPGA updates for v2025.10: CI: https://source.denx.de/u-boot/custodians/u-boot-socfpga/-/pipelines/27762 This pull request brings a set of updates across SoCFPGA platforms covering Agilex5, Agilex7, N5X, and Stratix10. The changes include: * Agilex5 enhancements: - USB3.1 enablement and DWC3 host driver support - System Manager register configuration for USB3 - Watchdog timeout increase and SDMMC clock API integration - dcache handling improvements in SMC mailbox path - Enable SPL_SYS_DCACHE_OFF in defconfig * Clock driver improvements: - Introduce dt-bindings header for Agilex clocks - Add enable/disable API and EMAC clock selection fixes - Replace manual shifts with FIELD_GET usage * DDR updates: - IOSSM mailbox compatibility check - Correct DDR calibration status handling * Device tree changes: - Agilex5: disable cache allocation for reads - Stratix10: add NAND IP node - Enable driver model watchdog - Enable USB3.1 node for Agilex5 * Config cleanups: - Simplify Agilex7 VAB defconfig - Remove obsolete SYS_BOOTM_LEN from N5X VAB config - Enable CRC32 support for SoCFPGA - Increase USB hub debounce timeout Overall this set improves reliability of DDR and cache flows, adds missing USB and MMC features for Agilex5, and refines clock and configuration handling across platforms. This patch set has been tested on Agilex 5 devkit, and Agilex devkit.
2025-09-27doc: Update mentions of README.fdt-controlE Shattow
Update documents 'README.fdt-control' reference to replacement 'control.rst': doc/arch/nios2.rst dts/Makefile Also convert some adjacent pathname mentions to rST links where applicable Fixes: 3e9fddfc4f14 "doc: Move devicetree control doc to rST" Signed-off-by: E Shattow <e@freeshell.de>
2025-09-27doc: develop: process: Add note about asking for feedbackTom Rini
It can be unclear to contributors what to do if they haven't gotten any feedback on patches they have submitted. Add a sentence saying that if they feel it's been too long without any comment, it's OK to reply again. Signed-off-by: Tom Rini <trini@konsulko.com>
2025-09-27doc: memory: fix encodings for spl layout diagramsAnshul Dalal
The commit 284ef1bbcefc ("doc: memory: Add documentation for system RAM") added documentation for U-Boot's memory usage along with diagrams showcasing the SPL's memory usage. Although the SVGs for the diagrams were improperly encoded. Therefore, this patch fixes the older SVGs with one's with better encoding and reduced size created using inkscape[1]. [1]: https://inkscape.org/ Reported-by: Alexander Dahl <ada@thorsis.com> Fixes: 284ef1bbcefc ("doc: memory: Add documentation for system RAM") Signed-off-by: Anshul Dalal <anshuld@ti.com>
2025-09-27doc: memory: Restore missing diagramNeha Malcom Francis
When applying the patch that became commit a2d881f5bcd3 ("doc: memory: Add documentation for system RAM") one of the diagrams was missed. Re-add this missing file. Reported-by: Adriano Carvalho <adrianocarvalho.pt@gmail.com> Fixes: a2d881f5bcd3 doc: memory: Add documentation for system RAM Signed-off-by: Neha Malcom Francis <n-francis@ti.com> [trini: Take Neha's original svg and re-apply it] Signed-off-by: Tom Rini <trini@konsulko.com>
2025-09-23Merge tag 'v2025.10-rc5' into nextTom Rini
Prepare v2025.10-rc5