summaryrefslogtreecommitdiff
path: root/doc/usage
AgeCommit message (Collapse)Author
2022-10-17fdt: Show a message when the working FDT changesSimon Glass
The working FDT is the one which comes from the OS and is fixed up by U-Boot. When the bootm command runs, it sets up the working FDT to be the one it is about to pass to the OS, so that fixups can happen. This seems like an important step, so add a message indicating that the working FDT has changed. This is shown during the running of the bootm command. Signed-off-by: Simon Glass <[email protected]>
2022-10-11doc: cmd: temperature: add documentationRobert Marko
Add documentation for the temperature command. Signed-off-by: Robert Marko <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-10-11cmd: xxd: add new commandRoger Knecht
Add xxd command to print file content as hexdump to standard out Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Roger Knecht <[email protected]>
2022-10-11cmd: cat: add new commandRoger Knecht
Add cat command to print file content to standard out Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Roger Knecht <[email protected]>
2022-10-10doc: man-page for clsHeinrich Schuchardt
Provide a man-page for the cls command. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-10-03Merge branch 'next'Tom Rini
2022-09-30doc: improve description of autostartHeinrich Schuchardt
Complete the list of commands influenced by the autostart environment variable. Make it clearer what values qualifies at 'yes'. Eventually the list of environment variables is to be alphabetically sorted. Move autostart up. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-09-25blk: Rename if_type to uclass_idSimon Glass
Use the word 'uclass' instead of 'if_type' to complete the conversion. Signed-off-by: Simon Glass <[email protected]>
2022-09-19Merge branch 'master' into nextTom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-09-15doc: cmd: loady: Document new configurationPali Rohár
Signed-off-by: Pali Rohár <[email protected]>
2022-09-14Merge tag 'efi-next-2022-09-14' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-efi into next Pull request for efi next UEFI: Implement a command eficonfig to maintain Load Options and boot order via menus.
2022-09-14doc:eficonfig: add documentation for eficonfig commandMasahisa Kojima
Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2022-09-14doc:bootmenu: add description for UEFI boot supportMasahisa Kojima
The bootmenu enumerates the UEFI boot options for boot device selection. This commit adds the description how the UEFI boot work in bootmenu. This commit also adds "Synopsis", "Description" and "Configuration" sections to follow the U-Boot command documentation format. Signed-off-by: Masahisa Kojima <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2022-09-13cyclic: Add documentationStefan Roese
Add documentation for the cyclic function infrastructure, including the cyclic command. Signed-off-by: Stefan Roese <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-09-09Merge tag 'efi-2022-10-rc5' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-efi Pull request for efi-2022-10-rc5 Documentation: * man-page for tftpput UEFI: * fix driver binding protocol for block IO devices * don't delete invalid handles * add a unit test for the EFI Conformance Profile Table Other: * correct short text for tftpboot
2022-09-09doc: man-page for tftpputHeinrich Schuchardt
Provide a man-page for the tftpput command. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-09-02cmd: Add pause commandSamuel Dionne-Riel
This command is being introduced with the goal of allowing user-friendly "generic use case" U-Boot builds to pause until user input under some situations. The main use case would be when a boot failure happens, to pause until the user has had time to acknowledge the current state. Tested using: make && ./u-boot -v -T -c 'ut lib lib_test_hush_pause' Signed-off-by: Samuel Dionne-Riel <[email protected]> Cc: Simon Glass <[email protected]>
2022-09-01doc: Add gpio status output fields descriptionPatrice Chotard
Add gpio status output fields description and one output example. Signed-off-by: Patrice Chotard <[email protected]> Reviewed-by: Simon Glass <[email protected]> Tweak the formatting. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-13doc: man-page for gpio commandHeinrich Schuchardt
Provide a man-page for the gpio command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-12bootstd: Update documentationSimon Glass
Add some documentation updates, particularly about global bootmeths. Signed-off-by: Simon Glass <[email protected]>
2022-08-02doc: rng: Add documentation for the rng commandSughosh Ganu
Add a usage document for the 'rng' u-boot command. Signed-off-by: Sughosh Ganu <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]> Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Ilias Apalodimas <[email protected]>
2022-07-29doc: environment: Further expand on Image locations and provide exampleTom Rini
Start by elaborating on what some of our constraints tend to be with image location values, and document where these external constraints can come from. Provide a new subsection, an example based on the TI ARMv7 OMAP2PLUS families of chips, that gives sample values and explains why we use these particular values. This is based on what is in include/configs/ti_armv7_common.h as of fb3ad9bd923d ("TI: Add, use a DEFAULT_LINUX_BOOT_ENV environment string") as this contains just the values referenced in this document now and not some of the further additions that are less generic. Cc: Heinrich Schuchardt <[email protected]> Cc: Simon Glass <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-07-26doc: Make a start on docs for fdt commandSimon Glass
Add some information about the 'fdt addr' subcommand, to get things started. Signed-off-by: Simon Glass <[email protected]>
2022-07-13doc: environment: Expand on fdt_addr, initrd_addr and loadaddrTom Rini
- Explain why fdt_addr and initrd_addr should not be set to disable relocation normally. - Provide some advice on the typical loadaddr default value. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-07-13doc: environment: Drop u-boot_addr_rTom Rini
This variable is never set nor explained why it would be set, drop it. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-06-28dm: core: Add documentation for the dm commandSimon Glass
Add a description and examples for the dm subcommands. Signed-off-by: Simon Glass <[email protected]>
2022-06-22cmd: load: add load command for memory mappedRui Miguel Silva
cp.b is used a lot as a way to load binaries to memory and execute them, however we may need to integrate this with the efi subsystem to set it up as a bootdev. So, introduce a loadm command that will be consistent with the other loadX commands and will call the efi API's. ex: loadm $kernel_addr $kernel_addr_r $kernel_size with this a kernel with CONFIG_EFI_STUB enabled will be loaded and then subsequently booted with bootefi command. Signed-off-by: Rui Miguel Silva <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2022-06-19doc: man-page for the printenv commandHeinrich Schuchardt
Privide a man-page for the printenv command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-06-19doc: man-page for bootz commandHeinrich Schuchardt
Provide a man-page for the bootz command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-06-04doc: environment: Fix typoChris Packham
"valu" should be "value". Signed-off-by: Chris Packham <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-05-28cmd/bootefi: correct command syntaxHeinrich Schuchardt
For indicating the address and size of a memory region other commands use a <addr>[:<size>] syntax. Do the same for bootefi. Fixes: 2058983689f0 ("cmd: bootefi: restore ability to boot arbitrary blob") Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-05-03doc: fix typos in bootmenu.rstHeinrich Schuchardt
%s/cammand/command/ %s/sequencies/sequences/ Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2022-04-25Merge branch '2022-04-25-initial-implementation-of-stdboot'Tom Rini
To quote the author: The bootflow feature provide a built-in way for U-Boot to automatically boot an Operating System without custom scripting and other customisation. This is called 'standard boot' since it provides a standard way for U-Boot to boot a distro, without scripting. It introduces the following concepts: - bootdev - a device which can hold a distro - bootmeth - a method to scan a bootdev to find bootflows (owned by U-Boot) - bootflow - a description of how to boot (owned by the distro) This series provides an implementation of these, enabled to scan for bootflows from MMC, USB and Ethernet. It supports the existing distro boot as well as the EFI loader flow (bootefi/bootmgr). It works similiarly to the existing script-based approach, but is native to U-Boot. With this we can boot on a Raspberry Pi 3 with just one command: bootflow scan -lb which means to scan, listing (-l) each bootflow and trying to boot each one (-b). The final patch shows this. With a standard way to identify boot devices, booting become easier. It also should be possible to support U-Boot scripts, for backwards compatibility only. ... The design is described in these two documents: https://drive.google.com/file/d/1ggW0KJpUOR__vBkj3l61L2dav4ZkNC12/view?usp=sharing https://drive.google.com/file/d/1kTrflO9vvGlKp-ZH_jlgb9TY3WYG6FF9/view?usp=sharing
2022-04-25bootstd: doc: Add documentationSimon Glass
Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <[email protected]>
2022-04-23doc: update bootefi man-pageHeinrich Schuchardt
A image_size parameter has been added to the bootefi parameter. Describe all parameters. Correct how the description of how the device-path in the loaded image protocol is determined. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-04-15doc: man-page for the env commandPatrick Delaunay
Describe the env command. Signed-off-by: Patrick Delaunay <[email protected]>
2022-04-09doc: correct bootefi.rstHeinrich Schuchardt
* add link to booti man-page * correct link description for efidebug command * correct punctuation Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-04-07env: Drop the unncessary protocol mention in autoloadSimon Glass
Drop this text at the end since it already mentions bootp and dhcp. Signed-off-by: Simon Glass <[email protected]> Suggested-by: Heinrich Schuchardt <[email protected]>
2022-04-07env: Move the doc comment to the codeSimon Glass
This doesn't really make much sense in the documentation. Add a code comment instead. Suggested-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Simon Glass <[email protected]>
2022-04-04Merge branch 'next'Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-04-01ls1046ardb: Add support for JTAG bootSean Anderson
This adds support for booting entirely from JTAG while using a hard-coded RCW. With these steps, it is not necessary to program a "good" RCW using CodeWarrior. The method here can be performed with any JTAG adapter supported by OpenOCD, including the on-board CMSIS-DAP (albeit very slowly). These steps require LS1046A support in OpenOCD, which was added in [1]. [1] https://sourceforge.net/p/openocd/code/ci/5b70c1f679755677c925b4e6dd2c3d8be4715717/ Signed-off-by: Sean Anderson <[email protected]> [trini: Add reference to doc/board/nxp/ls1046ardb.rst]
2022-04-01doc: smh: Update semihosting documentationSean Anderson
This documents how to use semihosting, the new semihosting features, and how to migrate from smhload. Signed-off-by: Sean Anderson <[email protected]>
2022-04-01doc: Convert semihosting readme to rSTSean Anderson
This converts the semihosting readme to rST. I have tried to make only cosmetic changes, but I did fix up the first link (which was broken). Signed-off-by: Sean Anderson <[email protected]>
2022-03-31doc: usage: Convert README.plan9 to reSTBin Meng
This converts the existing README.plan9 to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-03-31doc: usage: Update vxworks doc to mention RISC-V supportBin Meng
At present the doc only mentions Arm, PowerPC and x86. RISC-V support has been added since VxWorks SR0650 support for a while, and U-Boot supports loading a RISC-V VxWorks kernel too. Let's document it. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-03-31doc: usage: Convert README.vxworks to reSTBin Meng
This converts the existing README.vxworks to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-03-31doc: usage: Update the extension command titleBin Meng
Update the extension command title for consistency with other commands. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-03-31doc: usage: Group all shell command docs into cmd/ sub-directoryBin Meng
Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-03-31doc: mmc devPatrick Delaunay
Provide human readable descriptions of the speed nodes instead of the name of constants from the code as it is already done for 'mmc rescan' command in commit 212f078496e4 ("doc: mmc rescan speed mode"). Signed-off-by: Patrick Delaunay <[email protected]> Reviewed-by: Aswath Govindraju <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2022-03-28video: Drop cfg_consoleSimon Glass
The non-driver model video support was removed two years ago. Drop this driver, which is only used by nokia_rx51. Signed-off-by: Simon Glass <[email protected]>