summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2025-10-28board: starfive: Add initial Milk-V Mars CM and Mars CM Lite user documentationE Shattow
Add initial board docs for Milk-V Mars CM (eMMC) and Milk-V Mars CM Lite (SD Card) to the visionfive2 board target. Signed-off-by: E Shattow <[email protected]>
2025-10-27Prepare v2026.01-rc1v2026.01-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2025-10-26doc/usage: Add a reference to General rules for commandsTom Rini
For clarity, add a reference link to the start of the section on command documentation that all commands follow some general rules. Signed-off-by: Tom Rini <[email protected]>
2025-10-26doc: usage: Use glob for all commandsTom Rini
Make use of the glob syntax to automatically include all command documents. Signed-off-by: Tom Rini <[email protected]>
2025-10-26doc: seama: Reword return value sectionTom Rini
With the addition of general text about how the return value is handled, reference that while retaining the additional information about setting $seama_image_size Reviewed-by: Quentin Schulz <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2025-10-26doc: askenv: Reword and remove return valueTom Rini
With the addition of general text about how the return value is handled, remove the examples from the askenv documentation as they are all normal expected results. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-10-26doc: usage: Add general rule for `$?`Tom Rini
For nearly all commands in U-Boot the '?' variable is handled the same way with 0 meaning success, 1 meaning any failure. Explain this in the general rules section of the cmdline documentation (with a link to a counter example) and then remove the redundant wording from most commands. We retain a section about the return value in a number of places where we are doing something such as always returning a specific value or we have useful additional information to go along with the normal return codes. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
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 <[email protected]>
2025-10-26doc: Fix whitespace in devicetree example in overlay-fdt-boot.rstWolfgang Wallner
Fix the whitespace and add a missing quotation mark (default = "foo-reva.dtb") in overlay-fdt-boot.rst. Signed-off-by: Wolfgang Wallner <[email protected]>
2025-10-26doc: Fix typosWolfgang Wallner
Fix typos/wording in various files in doc/. Signed-off-by: Wolfgang Wallner <[email protected]> Reviewed-by: E Shattow <[email protected]>
2025-10-26doc: separate read and write command documentationHeinrich Schuchardt
* Avoid two step navigation to get to the description of the write command. * Add missing index entries * Correct formatting of the examples. * Describe configuration and return value. Signed-off-by: Heinrich Schuchardt <[email protected]>
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 <[email protected]> Signed-off-by: Benjamin Hahn <[email protected]>
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 <[email protected]>
2025-10-22doc: bindings: fix aquantia-phy.txt typoBeiyan Yun
Fix typo: "weays" -> "ways" Signed-off-by: Beiyan Yun <[email protected]>
2025-10-22tftp: make TFTP ports unconditionally configurableAlvin Šipraga
A few lines of code being guarded by the CONFIG_TFTP_PORT option seems an unnecessary restriction on the TFTP support provided by a vanilla U-Boot image. In cases where the TFTP server cannot run as superuser - and hence cannot run on the well-known port 69 - this quirk incurs a full reconfiguration and rebuild of the bootloader only in order to select the appropriate destination port. Remove the CONFIG_TFTP_PORT option entirely and make the tftpdstp and tftpsrcp variables always have an effect. Their being unset will mean that U-Boot behaves the same as if CONFIG_TFTP_PORT was unset. Update the documentation accordingly. And fix up the single board which was originally enabling this option. Signed-off-by: Alvin Šipraga <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-10-18doc: ti: j722s_evm: drop outdated boot notePeter Robinson
The j722s_evm support is now largely complete and is certainly not limited to UART boot so drop the confusing note from the docs. Signed-off-by: Peter Robinson <[email protected]>
2025-10-18doc: environment: fix links to Linux kernel documentationMattia Narducci
Architecture-specific documentation in the Linux kernel was moved to the arch/ subdirectory. Signed-off-by: Mattia Narducci <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-10-18doc: sandbox: fix typosLukas Zirpel
Fix two typos in the sandbox docs. Signed-off-by: Lukas Zirpel <[email protected]> Cc: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-10-18cmd/dma: documentationBrian Sune
This explains how to use the new U-Boot command 'dmareset'. Signed-off-by: Brian Sune <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2025-10-18doc: samsung: Extend E850-96 documentation to be comprehensiveSam Protsenko
Add more bootloading details for E850-96 board. New sections cover next topics: - Hardware configuration of the boot device - Flashing and updating the software (multiple methods) - Booting with Standard Boot (multiple methods) - EFI System Partition structure for E850-96 - Loadable firmware (LDFW) note - Ethernet and USB Host Support That documents all recently enabled U-Boot features for E850-96, which can hopefully make U-Boot more useful for the users and developers of this platform. Signed-off-by: Sam Protsenko <[email protected]>
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 <[email protected]> Reviewed-by: Martin Schwan <[email protected]>
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 <[email protected]> [trini: Keep our strlcpy/cat check] Signed-off-by: Tom Rini <[email protected]>
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 <[email protected]>
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 <[email protected]> Signed-off-by: Tom Rini <[email protected]>
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 <[email protected]>
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 <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]> Signed-off-by: Javier Tia <[email protected]>
2025-10-03doc: develop: fix grammar and syntaxYegor Yefremov
Signed-off-by: Yegor Yefremov <[email protected]> Reviewed-by: Simon Glass <[email protected]>
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 <[email protected]>
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 <[email protected]>
2025-09-27doc: build: documentation: add description of KDOC_WERRORE Shattow
Describe KDOC_WERROR and recommend when building documentation for a patch submission. Signed-off-by: E Shattow <[email protected]>
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 <[email protected]> Fixes: 284ef1bbcefc ("doc: memory: Add documentation for system RAM") Signed-off-by: Anshul Dalal <[email protected]>
2025-09-27doc: environment: clarify env precedenceRicardo Simoes
Since commit 5cf6a06a it is possible to have both text-based and old-style C environment files. But so far the environment documentation has not reflected this change. This commit fixes that. Signed-off-by: Ricardo Simoes <[email protected]> Signed-off-by: Mark Jonas <[email protected]>
2025-09-27doc: usage: Add File System section and Ext4 documentationTony Dinh
Create doc/usage/filesystems/ section. Convert doc/README.ext4 to rST format and move it to the new section. Update documentation to add configuration instruction for Ext4 Write when using large partitions. Note that this patch depends on this previous patch: https://patchwork.ozlabs.org/project/uboot/patch/[email protected]/ Signed-off-by: Tony Dinh <[email protected]> Reviewed-by: Anshul Dalal <[email protected]>
2025-09-27doc: Remove README.commands.itestTom Rini
We currently document this command in doc/usage/cmd/itest.rst and this documentation is more comprehensive than the older README file. Delete the older file. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-09-27doc: ext4fs: update documentation for Ext4 Write configurationTony Dinh
Update documentation for how to configure Ext4 Write when using large partitions. Signed-off-by: Tony Dinh <[email protected]>
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 <[email protected]> Fixes: a2d881f5bcd3 doc: memory: Add documentation for system RAM Signed-off-by: Neha Malcom Francis <[email protected]> [trini: Take Neha's original svg and re-apply it] Signed-off-by: Tom Rini <[email protected]>
2025-09-27doc: board: ti: am335x_evm: Add documentationSidharth Seela
Link: https://lore.kernel.org/u-boot/20250829191830.GZ124814@bill-the-cat/ Add documentation for config changes required to enable Falcon SD-FAT boot. Signed-off-by: Sidharth Seela <[email protected]> Cc: Tom Rini <[email protected]>
2025-09-26imx94_evk: Add i.MX943 EVK board supportYe Li
Add board-level code and defconfig for the i.MX943 EVK board, supporting multiple SOM variants: 19x19 LPDDR5, 19x19 LPDDR4 and 15x15 LPDDR4. Signed-off-by: Ye Li <[email protected]> Signed-off-by: Alice Guo <[email protected]> Acked-by: Peng Fan <[email protected]> Reviewed-by: Jacky Bai <[email protected]>
2025-09-23Merge tag 'v2025.10-rc5' into nextTom Rini
Prepare v2025.10-rc5
2025-09-23Prepare v2025.10-rc5v2025.10-rc5Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2025-09-22doc: phytec: imx8m: Style and firmware updateYannic Moog
Use single make command for compiling blobs and U-Boot. Update the imx firmware version. Signed-off-by: Yannic Moog <[email protected]>
2025-09-22doc: phytec: update imx8m docs for optee buildsYannic Moog
OP-TEE configs are enabled by default, change the doc to no longer declare OP-TEE as optional. Also remove CFG_TEE_BENCHMARK as it is no longer present in optee_os. Further, phycore-imx8mm and imx8mm-phygate-tauri-l use different build instructions, so dissolve the common file for building OP-TEE. Reviewed-by: Teresa Remmet <[email protected]> Signed-off-by: Yannic Moog <[email protected]>
2025-09-20imx93_frdm: Add support for flashing board with UUUMathieu Dubois-Briand
Allow to flash a board using NXP UUU utility: - Enable fastboot support on USB. - Add fastboot partition aliases with names used by UUU. Also add extra environment variables used by UUU. - Set 'dofastboot' environment variable based on boot device configuration, allowing to automatically enter fastboot when booting from USB. Signed-off-by: Mathieu Dubois-Briand <[email protected]>
2025-09-19doc: microchip: add mpfs_video.rstJamie Gibbons
Add documentation to support the addition of the MPFS Video Kit. Signed-off-by: Jamie Gibbons <[email protected]> Reviewed-by: Leo Yu-Chi Liang <[email protected]>
2025-09-19doc: microchip: introduce common sectionsJamie Gibbons
With the upcoming additions of new MPFS boards, separate common documentation to allow this to be reused appropriately and avoid duplication. Signed-off-by: Jamie Gibbons <[email protected]> Reviewed-by: Leo Yu-Chi Liang <[email protected]>
2025-09-17imx95_evk: Restore support for i.MX95 A0 siliconAlice Guo
This patch is used to restore support for i.MX95 A0 silicon. To avoid duplicating defconfig, imx95.config is added and can be shared between imx95_a0_19x19_evk_defconfig and imx95_19x19_evk_defconfig. container.cfg and imximage.cfg are used to created .cfgout files that are be passed to mkimage with -n to build flash.bin. Now they have been deleted and replaced by adding their content to properties of node which type is nxp-imx9image under binman node. Fixes: 9936724aa9b ("imx95_evk: Add i.MX95 B0 support") Signed-off-by: Alice Guo <[email protected]> Tested-By: Tim Harvey <[email protected]> # imx95-19x19-evk (rA0)
2025-09-16Merge patch series "Modernize U-Boot code formatting with clang-format"Tom Rini
Javier Tia <[email protected]> says: This patch series modernizes U-Boot's code formatting infrastructure by with current Linux kernel practices and providing a more robust and comprehensive formatting solution. Link: https://lore.kernel.org/r/[email protected]
2025-09-16doc: Update U-Boot coding style guide with clang-format usageJavier Tia
The U-Boot coding style guide has been updated to include information about using the `.clang-format` configuration file for automatic code formatting. This ensures consistent formatting across the entire codebase and aligns with Linux kernel coding standards. The goal with introducing a predefined coding style is consistency rather than personal preference. The .clang-format file is copied directly from the Linux kernel without any modifications, ensuring complete compatibility with kernel coding standards. Include comprehensive best practices for using clang-format, specifically guidance on formatting only changed blocks versus entire files, creating separate formatting-only commits for better code review, and leveraging git clang-format for targeted formatting. Add examples of editor integrations. This enhancement will help maintainers and contributors to easily adhere to U-Boot coding standards. Signed-off-by: Javier Tia <[email protected]>