summaryrefslogtreecommitdiff
path: root/doc/usage
AgeCommit message (Collapse)AuthorFilesLines
2021-09-10doc: usage: mmc: Document usage of speed mode in "mmc dev" and "mmc rescan"Aswath Govindraju1-2/+47
Add documentation on the usage of "mmc dev" and "mmc rescan" commands to set user defined speed modes. Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
2021-08-02lib: Allow using 0x when a decimal value is requestedSimon Glass1-0/+6
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 <sjg@chromium.org>
2021-08-02doc: Add a note about number representationSimon Glass1-0/+31
Mention the default base of U-Boot in the command-line section. Add examples for decimal and octal. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-08-02doc: Convert command-line info to rSTSimon Glass2-0/+57
Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-07-27doc: usage: add description for setexpr commandRoland Gaudig2-0/+149
Add usage for the setexpr command. It has been added to describe mainly the new setexpr format string operation. Signed-off-by: Roland Gaudig <roland.gaudig@weidmueller.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-06-28doc/usage: cmd-usage help file for askenvAdarsh Babu Kalepalli2-0/+88
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 <opensource.kab@gmail.com> Add missing entry in doc/usage/index.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-06-22mmc: Update environment variable with active partitionReuben Dowle1-1/+3
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 <reuben.dowle@4rf.com> Reviewed-by: Jaehoon Chung <jh80.chung@samsung.com>
2021-06-09doc: usage: man-page for ums commandPatrick Delaunay2-0/+58
Provide a man-page for the ums command - USB Mass Storage. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-06-09doc: usage: man-page for pinmux commandPatrick Delaunay2-0/+96
Provide a man-page for the pinmux command. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Patrice Chotard <patrice.chotard@foss.st.com>
2021-06-09doc: usage: reorder commands in index.rstPatrick Delaunay1-3/+3
Reorder alphabetically the command in the index of usage in U-Boot documentation. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-05-25doc: usage: modify mmc man-pageJaehoon Chung1-1/+2
Modify mmc man-page. - Change a description about mmc erase command. - Add whitespace to distinguish. Signed-off-by: Jaehoon Chung <jh80.chung@samsung.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2021-05-18doc: extension.rst missing in doc/usage/index.rstHeinrich Schuchardt1-0/+1
'make htmldocs' results in a build warning checking consistency... doc/usage/extension.rst: WARNING: document isn't included in any toctree Add the document to the index. Fixes: 2f84e9cf06d3 ("cmd: add support for a new "extension" command") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-05-18doc: man-page for size commandHeinrich Schuchardt2-0/+41
Provide a man-page for the size command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-05-13cmd: add support for a new "extension" commandKory Maincent1-0/+111
This patch adds a new "extension" command, which aims at detecting extension boards connected to the hardware platform, and apply the Device Tree overlays that describe the hardware present on those extension boards. In order to enable this mechanism, board-specific code must implement the extension_board_scan() function that fills in a linked list of "struct extension", each describing one extension board. In addition, the board-specific code must select the SUPPORT_EXTENSION_SCAN Kconfig boolean. Based on this: - "extension scan" makes the generic code call the board-specific extension_board_scan() function to retrieve the list of detected extension boards. - "extension list" allows to list the detected extension boards. - "extension apply <number>|all" allows to apply the Device Tree overlay(s) corresponding to one, or all, extension boards The latter requires two environment variables to exist and set one variable to run: - extension_overlay_addr: the RAM address where to load the Device Tree overlays - extension_overlay_cmd: the U-Boot command to load one overlay. Indeed, the location and mechanism to load DT overlays is very setup specific. - extension_overlay_name: set by the command: the name of the DT which will be load during the execution. When calling the command described in the extension_overlay_cmd variable, the variable extension_overlay_name will be defined. So a typical extension_overlay_cmd will look like this: extension_overlay_cmd=load mmc 0:1 $extension_overlay_addr /boot/$extension_overlay_name Here is an example on how to use it: => run loadfdt => fdt addr $fdtaddr => setenv extension_overlay_addr 0x1000 => setenv extension_overlay_cmd 'load mmc 0:1 ${extension_overlay_addr} /boot/${extension_overlay_name}' => extension scan Found 1 extension board(s). => extension apply 0 519 bytes read in 3 ms (168.9 KiB/s) Signed-off-by: Kory Maincent <kory.maincent@bootlin.com> Reviewed-by: Maxime Ripard <maxime@cerno.tech>
2021-05-05cmd/exception: support ebreak exception on RISC-VHeinrich Schuchardt1-0/+3
The ebreak instruction should generate a breakpoint exception. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Rick Chen <rick@andestech.com>
2021-04-24doc: fatinfo man-pageHeinrich Schuchardt1-0/+51
Provide a man-page for the fatinfo command. The .rst file was lost in patch 15d9694600fe ("doc: fatinfo man-page"). Fixes: 15d9694600fe ("doc: fatinfo man-page") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-04-20doc: usage: add usage details for reset cmdIgor Opaniuk2-0/+27
Add usage details for reset command. Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io>
2021-04-17doc: fatinfo man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the fatinfo command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-04-10doc: mmc man-pageJaehoon Chung2-0/+213
Provide a man-pages for the mmc command. Signed-off-by: Jaehoon Chung <jh80.chung@samsung.com>
2021-03-30Merge tag 'v2021.04-rc5' into nextTom Rini2-0/+405
Prepare v2021.04-rc5
2021-03-27x86: Add a command to display coreboot sysinfoSimon Glass2-0/+26
This information is interesting to look at and can be important for debugging and inspection. Add a command to display it in a helpful format. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-26binman: doc: Add documentation to htmldocsSimon Glass2-0/+9
Add a link to binman's documentation and adjust the files so that it is accessible. Use the name README.rst so it is easy to discover when binman is installed without U-Boot. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-16doc: move README.dfu to HTML documentationHeinrich Schuchardt2-0/+405
Move README.dfu to doc/usage/dfu.rst and convert to reStructured text. In the long run this page should be split into two. One for the overview and one for the dfu command. UEFI capsule updates and dfutftp should be integrated into the overview page. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-03-15Merge tag 'v2021.04-rc4' into nextTom Rini2-0/+42
Prepare v2021.04-rc4
2021-03-14doc: describe the scp03 commandJorge Ramirez-Ortiz2-0/+34
The Secure Channel Protocol 03 command sends control requests (enable/provision) to the TEE implementing the protocol between the processor and the secure element. Signed-off-by: Jorge Ramirez-Ortiz <jorge@foundries.io> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-03-05cmd: Add a command to display the address mapBin Meng2-0/+42
This adds a new command 'addrmap' to display the address map for non-identity virtual-physical memory mappings. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Priyanka Jain <priyanka.jain@nxp.com>
2021-03-02doc: Add a note about producing 'md.b' output using hexdumpSimon Glass1-0/+10
Comparing a hex dump on the U-Boot command line with the contents of a file on the host system is fairly easy and convenient to do manually if it is small. But the format used hexdump by default differs from that shown by U-Boot. Add a note about how to make them the same. (For large dumps, writing the data to the network with tftpput, or to a USB stick with ext4save is easiest.) Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-02doc: describe the md commandSimon Glass2-0/+97
Provide a man-page for the md command. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-02-26doc: Document partition specificationsSean Anderson2-0/+81
This documents the way U-Boot understands partitions specifications. This also updates the fastboot documentation for the changes in the previous commit. Signed-off-by: Sean Anderson <sean.anderson@seco.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-02-21doc: qfw man-pageHeinrich Schuchardt2-0/+90
Provide a man-page for the qfw command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-02-21doc: booti man-pageHeinrich Schuchardt2-0/+115
Provide a man-page for the booti command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-02-04doc: return value exception commandHeinrich Schuchardt1-5/+0
If the exception cannot be raised, the command returns. Currently the return values are not all the same. Remove the sub-chapter 'Return value' Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-02-04doc: describe load commandHeinrich Schuchardt2-0/+75
Man-page for load command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-01-27doc: exception commandHeinrich Schuchardt2-0/+69
Create man-page for exception command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: describe command conitraceHeinrich Schuchardt2-0/+55
Provide a man-page for the conitrace command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: describe the false commandHeinrich Schuchardt2-0/+29
Provide a man-page for the false command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: document true commandHeinrich Schuchardt2-0/+29
Create a man-page for the true command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: describe loady commandHeinrich Schuchardt2-0/+68
Create a man-page for the loady command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: document echo commandHeinrich Schuchardt2-0/+66
Provide a man-page for the echo command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-01-25doc: document for statementHeinrich Schuchardt2-0/+66
Create a man-page for the for statement. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: describe exit commandHeinrich Schuchardt2-0/+41
Man-page for exit shell command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-25doc: document sbi commandHeinrich Schuchardt2-0/+50
Add a man-page for the sbi command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-18Merge tag 'doc-2021-04-rc1' of ↵Tom Rini4-1/+170
https://gitlab.denx.de/u-boot/custodians/u-boot-efi Pull request for documentation tag doc-2021-04-rc1 * document man-page base command * move README.fdt-overlays to HTML documentation * add synopsis for pstore command
2021-01-16doc: move README.fdt-overlays to HTML documentationHeinrich Schuchardt2-0/+136
Convert doc/README.fdt-overlays to doc/usage/fdt_overlays.rst. Edit the text for readability. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-16doc: add synopsis for pstore commandHeinrich Schuchardt1-1/+10
Add a synopsis section. Use lower case for command name. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-16doc: man-page base commandHeinrich Schuchardt2-0/+24
Provide a description of the base command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-16cmd: Add MBR partition layout control utilityMarek Szyprowski2-0/+95
Add a 'mbr' command to let users create or verify MBR partition layout based on the provided text description. The partition layout is alternatively read from the 'mbr_parts' environment variable. This can be used in scripts to help system image flashing tools to ensure proper partition layout. The syntax of the text description of the partition list is similar to the one used by the 'gpt' command. Supported parameters are: name (currently ignored), start (partition start offset in bytes), size (in bytes or '-' to expand it to the whole free area), bootable (boolean flag) and id (MBR partition type). If one wants to create more than 4 partitions, an 'Extended' primary partition (with 0x05 ID) has to be explicitely provided as a one of the first 4 entries. Here is an example how to create a 6 partitions (3 on the 'extended volume'), some of the predefined sizes: > setenv mbr_parts 'name=boot,start=4M,size=128M,bootable,id=0x0e; name=rootfs,size=3072M,id=0x83; name=system-data,size=512M,id=0x83; name=[ext],size=-,id=0x05; name=user,size=-,id=0x83; name=modules,size=100M,id=0x83; name=ramdisk,size=8M,id=0x83' > mbr write mmc 0 Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
2020-12-20doc: man-page for bootefi commandHeinrich Schuchardt2-0/+136
Provide a description of the bootefi command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-20doc: button commandHeinrich Schuchardt2-0/+65
Provide a description of the 'button' command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-15doc: move README.bootmenu to HTML docHeinrich Schuchardt2-0/+96
Convert README.bootmenu to reStructured text and move it to usage/bootmenu.rst. Adjust the text concerning configuration settings as these now are managed via Kconfig. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Pali Rohár <pali@kernel.org>
generated by cgit v1.2.3 (git 2.39.0) at 2024-09-15 22:40:58 +0300