summaryrefslogtreecommitdiff
path: root/doc/usage
AgeCommit message (Collapse)Author
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: 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-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: 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-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-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: 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-08-18net: introduce CONFIG_DNSJerome Forissier
Introduce the DNS Kconfig symbol so that various network commands may use host names without the dns command (CMD_DNS) being selected. Signed-off-by: Jerome Forissier <[email protected]> CC: E Shattow <[email protected]>
2025-08-08efi_loader: Support loading a ramdisk with bootefiSimon Glass
It is sometimes useful to be able to boot via EFI using a Linux initrd. Add support for this. Fix a 'specifiy' typo while here. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Mark Kettenis <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2025-08-06cmd: Add i3c command support.Dinesh Maniyam
Add i3c command file to support select, get i3c device target list, read and write operation. Signed-off-by: Dinesh Maniyam <[email protected]>
2025-08-01net: phy: Support overriding Auto Negotiation timeout with env variableSiddharth Vadapalli
The Auto Negotiation procedure between two Ethernet PHYs consists of determining the best commonly supported parameters among Speed, Duplex Mode and Flow Control. The time taken for this procedure is not only dependent on the local PHY used, but also on the link-partner PHY. While a timeout can be specified in the form of a "CONFIG" on the basis of the local PHY present on the device, since the timeout also depends on the link-partner PHY, it might be necessary to modify the timeout. To avoid rebuilding the bootloader for a given device, just because it may be connected to various link-partner PHYs, each with a different timeout, introduce an environment variable named "phy_aneg_timeout" and override "CONFIG_PHY_ANEG_TIMEOUT" with "phy_aneg_timeout". Signed-off-by: Siddharth Vadapalli <[email protected]> Acked-by: Jerome Forissier <[email protected]> [jf: add missing #include <env.h>] Signed-off-by: Jerome Forissier <[email protected]>
2025-07-26docs: Update FIT signature testing instructionsEnric Balletbo i Serra
Update the FIT signature testing instructions to use the pytest suite instead of the old vboot_test.sh script. Signed-off-by: Enric Balletbo i Serra <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2025-07-19doc: PXE: mention extlinux.conf and sysbootFiona Klute
These use the same format as PXE boot. Signed-off-by: Fiona Klute <[email protected]> Cc: Tom Rini <[email protected]>
2025-07-19doc: PXE usage: move environment variables to a separate sectionFiona Klute
This works better with RST formatting, and avoids duplication. Signed-off-by: Fiona Klute <[email protected]> Cc: Tom Rini <[email protected]>
2025-07-19doc: move PXE README into usage documentationFiona Klute
This is only a reformatting, with a few grammar fixes (capitalization, and a missing "is" and "be" added each). Signed-off-by: Fiona Klute <[email protected]> Cc: Tom Rini <[email protected]>
2025-07-19doc: correct references in x86-fit-boot.rstHeinrich Schuchardt
Correct the references for * the x86 boot protocol description * the FIT file format Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-07-08doc: add doc/cmd/sntp.rst and remove doc/README.SNTPJerome Forissier
Add a proper documentation file for the sntp command in RST format and drop doc/README.SNTP. The documentation now includes the NET_LWIP specificities. Signed-off-by: Jerome Forissier <[email protected]>
2025-06-23Merge tag 'v2025.07-rc5' into nextTom Rini
Prepare v2025.07-rc5 With this merge, tighten up the LTO_FLAGS removal we added to not trigger on ARMv7 (which is Thumb-2 and should be fine).
2025-06-21doc: cmd: wget: remove erroneous noteJerome Forissier
The note about U-Boot not being able to verify server certificates is false now that WGET_CACERT and WGET_BUILTIN_CACERT have been added. Remove it. Signed-off-by: Jerome Forissier <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-06-20Merge patch series "Consistent Kconfig environment options CONFIG_ENV_ prefix"Tom Rini
Marek Vasut <[email protected]> says: Rename the environment related variables and add ENV_ prefix, so that all configuration options which are related to environment would have an CONFIG_ENV_ prefix. No functional change. Link: https://lore.kernel.org/r/[email protected]
2025-06-20env: Rename DEFAULT_ENV_FILE to ENV_DEFAULT_ENV_TEXT_FILEMarek Vasut
Rename the variable and add ENV_ prefix, so that all configuration options which are related to environment would have an CONFIG_ENV_ prefix. No functional change. Also rename USE_DEFAULT_ENV_FILE to USE_ENV_DEFAULT_ENV_TEXT_FILE . Signed-off-by: Marek Vasut <[email protected]>
2025-06-17doc: cmd: gpt: add information on type partitionPatrick Delaunay
Add information on type partition, copied from README.gpt. I also correct issue for gpt_parts variable and add example of "gpt read" usage. Signed-off-by: Patrick Delaunay <[email protected]> Reviewed-by: Patrice Chotard <[email protected]>
2025-06-09Merge tag 'v2025.07-rc4' into nextTom Rini
Prepare v2025.07-rc4
2025-06-07doc: efi_loader: Tidy up the bootefi-command docsSimon Glass
There are backslashes in some of the tags which seems to be unnecessary. Remove then. Change the word 'either' to 'any' since there are three options. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-05-29Merge patch series "regex patches"Tom Rini
Rasmus Villemoes <[email protected]> says: This started as a rather simple patch, 1/12, adding the ability to more conveniently do regex matching in shell. But with that, it became very easy to see what the slre library can and especially what it cannot do, and that way I found both outright bugs and a "wow, doesn't it support that syntax" gotcha. I couldn't find any tests ('git grep slre -- test/' was empty), so I added a small test suite and tweaked slre.c. Link: https://lore.kernel.org/r/[email protected]
2025-05-29doc: document test commandRasmus Villemoes
Add documentation for the test command, including the newly added =~ operator and some gotchas wrt. the numeric comparisons. Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Rasmus Villemoes <[email protected]>
2025-05-20net, net-lwip: wget: suppress console output when called by EFIJerome Forissier
Functions called from EFI applications should not do console output. Refactor the wget code to implement this requirement. The wget_http_info struct is used to hold the boolean that signifies whether the output is allowed or not. Signed-off-by: Jerome Forissier <[email protected]> Reported-by: Heinrich Schuchardt <[email protected]>
2025-05-11doc: RISC-V supports semihostingHeinrich Schuchardt
Mention that RISC-V supports semihosting. Update the link to ARM's semihosting documentation Update SPDX identifier to current format. Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-04-25doc: fix typo 'to'Aristo Chen
Fix typo from "to" to "do" Signed-off-by: Aristo Chen <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-04-25doc: fix typo commnadAristo Chen
fix typo from "commnad" to "command" Signed-off-by: Aristo Chen <[email protected]>
2025-04-25doc: remove duplicated "commands"Aristo Chen
The "commands" are duplicated, so remove one of them Signed-off-by: Aristo Chen <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-04-08Merge branch 'next'Tom Rini
Note that this undoes the changes of commit cf6d4535cc4c ("x86: emulation: Disable bloblist for now") as that was intended only for the release due to time.
2025-04-04Merge patch series "cmd: fuse: Introduce fuse writebuff sub-system and clean up"Tom Rini
Harsha Vardhan V M <[email protected]> says: This patch series introduces the fuse writebuff sub-system command and makes improvements to the existing fuse implementation by removing the custom string functions. The patches are required to be applied in sequence. The series consists of the following changes: Patch 1 removes custom string functions and replaces them with standard string functions. Patch 2 introduces fuse.rst documentation for fuse commands. Patch 3 introduces the fuse writebuff sub-system command, allowing to write a structured buffer in memory to fuses, and implementing the necessary function calls. Patch 4 enables the fuse sub-system in the K3 platform. Patch 5 updates the fuse.rst documentation to include details about the new fuse writebuff command. These changes aim to improve the fuse sub-system by the removal of custom string functions and the addition of the fuse writebuff command improves fuse programming workflows by allowing to write a structured buffer in memory to efuses. Link: https://lore.kernel.org/r/[email protected]
2025-04-04doc: cmd: Add fuse writebuff cmd documentationHarsha Vardhan V M
Add fuse writebuff sub-system command documentation. Signed-off-by: Harsha Vardhan V M <[email protected]>
2025-04-04doc: cmd: Add documentation for fuse commandHarsha Vardhan V M
Add documentation for the 'fuse' sub-system commands in doc/usage/cmd/fuse.rst file. Remove doc/README.fuse file. Signed-off-by: Harsha Vardhan V M <[email protected]>
2025-04-03acpi: Support checking checksumsSimon Glass
When the ACPI tables come from an earlier bootloader it is helpful to see whether the checksums are correct or not. Add a -c flag to the 'acpi list' command to support that. Signed-off-by: Simon Glass <[email protected]>
2025-04-03doc: Fix typo bootfloe to bootflowAndrew Davis
Signed-off-by: Andrew Davis <[email protected]>
2025-04-03doc: correct references to overlay-fdt-boot.txtHeinrich Schuchardt
doc/uImage.FIT/overlay-fdt-boot.txt does not exist anymore. Reference the correct section of doc/usage/fit/overlay-fdt-boot.rst. Fixes: 6f6e8bb695a7 ("doc: Bring in the FIT overlay information") Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-03-14doc: update meminfo with arch specific informationIlias Apalodimas
Since we added support in meminfo to dump live page tables, describe the only working architecture for now (aarch64) and add links to public documentation for further reading. Signed-off-by: Ilias Apalodimas <[email protected]>
2025-03-11doc: cmd: wget: document cacert subcommandJerome Forissier
Document the 'wget cacert' subcommand which allows to configure root (CA) certificates for HTTPS. Signed-off-by: Jerome Forissier <[email protected]> Acked-by: Ilias Apalodimas <[email protected]>
2025-03-10env: Provide a work-around for unquoting fdtfileSimon Glass
Some boards use a CONFIG option to specify the value of this variable. This is normally handled by efi_get_distro_fdt_name() but in the case of sunxi this does not work, since 'soc' is sunxi, but the files are in the allwinner directory. Provide a work-around for this particular case. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2025-03-07Merge patch series "This series adds support for file renaming to ↵Tom Rini
EFI_FILE_PROTOCOL.SetInfo()." Gabriel Dalimonte <[email protected]> says: This series adds support for file renaming to EFI_FILE_PROTOCOL.SetInfo(). One of the use cases for renaming in EFI is to facilitate boot loader boot counting. No existing filesystems in U-Boot currently include file renaming, resulting in support for renaming at the filesystem level and a concrete implementation for the FAT filesystem. Link: https://lore.kernel.org/r/[email protected]