summaryrefslogtreecommitdiff
path: root/doc/usage
AgeCommit message (Collapse)Author
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]>
2022-03-28Merge tag 'v2022.04-rc5' into nextTom Rini
Prepare v2022.04-rc5
2022-03-26doc: man-page for the wdt commandHeinrich Schuchardt
Describe the wdt command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-03-10event: Add documentationSimon Glass
Add documentation for events, including the event command. Signed-off-by: Simon Glass <[email protected]>
2022-02-26doc: describe fatload commandHeinrich Schuchardt
Man-page for fatload command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-02-11doc: usage: DFU: Fix dfu_alt_info documentMasami Hiramatsu
Fix some typo and wrong information about dfu_alt_info. - Add the parameter format, decimal only or hexadecimal. - Use same parameter name for the same kind of parameters. (e.g. dev -> dev_id) Signed-off-by: Masami Hiramatsu <[email protected]>
2022-01-25doc: Add usage information for the acpi commandSimon Glass
Add some documentation for this command. Signed-off-by: Simon Glass <[email protected]>
2021-12-21doc: remove duplicate page inclusionHeinrich Schuchardt
doc/usage/index.rst in branch origin/next includes usage/environment twice. Remove the duplicate entry. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-12-20Merge tag 'v2022.01-rc4' into nextTom Rini
Prepare v2022.01-rc4
2021-12-09doc: usage: Fix command in fdt overlay apply sequenceAlexander Dahl
Literally adhering to the docs gave this wrong output: U-Boot> setenv fdtaddr 0x87f00000 U-Boot> fdtaddr $fdtaddr Unknown command 'fdtaddr' - try 'help' Fixes: d80162cfc559 ("doc: Document how to apply fdt overlays") Signed-off-by: Alexander Dahl <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2021-11-28sf: doc: Add documentation for the 'sf' commandSimon Glass
This command is fairly complicated so documentation is useful. Unfortunately I an not sure how the MTD side of things works and cannot find information about that. Signed-off-by: Simon Glass <[email protected]> Acked-by: Pratyush Yadav <[email protected]> Reviewed-by: Jagan Teki <[email protected]> Acked-by: Heinrich Schuchardt <[email protected]>
2021-11-16bootm: Tidy up use of autostart env varSimon Glass
This has different semantics in different places. Go with the bootm method and put it in a common function so that the behaviour is consistent in U-Boot. Update the docs. To be clear, this changes the way that 'bootelf' and standalone boot work. Before, if autostart was set to "fred" or "YES", for example, they would consider that a "yes". This may change behaviour for some boards, but the only in-tree boards which mention autostart use "no" to disable it, which will still work. Signed-off-by: Simon Glass <[email protected]> Suggested-by: Wolfgang Denk <[email protected]>
2021-11-16doc: Improve environment documentation furtherSimon Glass
Make various other updates suggested during review of the rST conversion. Signed-off-by: Simon Glass <[email protected]> Suggested-by: Heinrich Schuchardt <[email protected]>
2021-11-16doc: Improve environment documentationSimon Glass
Make various updates suggested during review of the rST conversion. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Marek Behún <[email protected]> Suggested-by: Wolfgang Denk <[email protected]>
2021-11-16doc: Mention CONFIG_DEFAULT_ENV_FILESimon Glass
Add mention of this option since it does a similar thing to the text environment. Signed-off-by: Simon Glass <[email protected]> Suggested-by: Rasmus Villemoes <[email protected]> Reviewed-by: Marek Behún <[email protected]>
2021-11-16env: Allow U-Boot scripts to be placed in a .env fileSimon Glass
At present U-Boot environment variables, and thus scripts, are defined by CONFIG_EXTRA_ENV_SETTINGS. It is painful to add large amounts of text to this file and dealing with quoting and newlines is harder than it should be. It would be better if we could just type the script into a text file and have it included by U-Boot. Add a feature that brings in a .env file associated with the board config, if present. To use it, create a file in a board/<vendor> directory, typically called <board>.env and controlled by the CONFIG_ENV_SOURCE_FILE option. The environment variables should be of the form "var=value". Values can extend to multiple lines. See the README under 'Environment Variables:' for more information and an example. In many cases environment variables need access to the U-Boot CONFIG variables to select different options. Enable this so that the environment scripts can be as useful as the ones currently in the board config files. This uses the C preprocessor, means that comments can be included in the environment using /* ... */ Also support += to allow variables to be appended to. This is needed when using the preprocessor. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Marek Behún <[email protected]> Tested-by: Marek Behún <[email protected]>
2021-11-16doc: Move environment documentation to rSTSimon Glass
Move this from the README to rST format. Drop i2cfast since it is obviously obsolete and breaks the formatting. Other changes and improvements are in a following patch. Signed-off-by: Simon Glass <[email protected]> Acked-by: Marek Behún <[email protected]>
2021-11-07doc: mmc rescan speed modeHeinrich Schuchardt
Provide human readable descriptions of the speed nodes instead of the name of constants from the code. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-09-16Merge tag 'v2021.10-rc4' into nextTom Rini
Prepare v2021.10-rc4 Signed-off-by: Tom Rini <[email protected]> # gpg: Signature made Tue 14 Sep 2021 06:58:32 PM EDT # gpg: using RSA key 1A3C7F70E08FAB1707809BBF147C39FF9634B72C # gpg: Good signature from "Thomas Rini <[email protected]>" [ultimate] # Conflicts: # board/Arcturus/ucp1020/spl.c # cmd/mvebu/Kconfig # common/Kconfig.boot # common/image-fit.c # configs/UCP1020_defconfig # configs/sifive_unmatched_defconfig # drivers/pci/Kconfig # include/configs/UCP1020.h # include/configs/sifive-unmatched.h # lib/Makefile # scripts/config_whitelist.txt
2021-09-10doc: usage: mmc: Document usage of speed mode in "mmc dev" and "mmc rescan"Aswath Govindraju
Add documentation on the usage of "mmc dev" and "mmc rescan" commands to set user defined speed modes. Signed-off-by: Aswath Govindraju <[email protected]>
2021-08-31qfw: Switch to CONFIG_SYS_LOAD_ADDR from CONFIG_LOADADDRTom Rini
All platforms define CONFIG_SYS_LOAD_ADDR, but only some define CONFIG_LOADADDR. Very very rarely are these not the same address, and qemu-ppce500 is one such case. However, based on reading the history of the code, this mismatched value was simply a copy-paste from other PowerPC platforms where it is this unused currently. Switch the code to use CONFIG_SYS_LOAD_ADDR and update the documentation. Cc: Bin Meng <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2021-08-02lib: Allow using 0x when a decimal value is requestedSimon Glass
U-Boot mostly uses hex for value input, largely because addresses are much easier to understand in hex. But in some cases a decimal value is requested, such as where the value is small or hex does not make sense in the context. In these cases it is sometimes useful to be able to provide a hex value in any case, if only to resolve any ambiguity. Add this functionality, for increased flexibility. Signed-off-by: Simon Glass <[email protected]>
2021-08-02doc: Add a note about number representationSimon Glass
Mention the default base of U-Boot in the command-line section. Add examples for decimal and octal. Signed-off-by: Simon Glass <[email protected]>
2021-08-02doc: Convert command-line info to rSTSimon Glass
Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <[email protected]>
2021-07-27doc: usage: add description for setexpr commandRoland Gaudig
Add usage for the setexpr command. It has been added to describe mainly the new setexpr format string operation. Signed-off-by: Roland Gaudig <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2021-06-28doc/usage: cmd-usage help file for askenvAdarsh Babu Kalepalli
help file for using askenv cmd is created. It provides description on the command purpose, description of arguments, couple of examples (illustrating command usage), configuration parameter and possible return values. Signed-off-by: Adarsh Babu Kalepalli <[email protected]> Add missing entry in doc/usage/index.rst. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-06-22mmc: Update environment variable with active partitionReuben Dowle
This patch allows uboot scripts make choices about where to boot from based on the active mmc boot partition. This allows having two copies of kernel, filesystems etc, and choosing which to boot from based off of the active bootloader partition. Signed-off-by: Reuben Dowle <[email protected]> Reviewed-by: Jaehoon Chung <[email protected]>
2021-06-09doc: usage: man-page for ums commandPatrick Delaunay
Provide a man-page for the ums command - USB Mass Storage. Signed-off-by: Patrick Delaunay <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>