summaryrefslogtreecommitdiffstats
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'v2021.04-rc5' into nextTom Rini2021-03-292-0/+405
|\ | | | | | | Prepare v2021.04-rc5
| * doc: move README.dfu to HTML documentationHeinrich Schuchardt2021-03-162-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>
* | x86: Add a command to display coreboot sysinfoSimon Glass2021-03-272-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>
* | binman: doc: Add documentation to htmldocsSimon Glass2021-03-262-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>
* | Merge tag 'v2021.04-rc4' into nextTom Rini2021-03-152-0/+42
|\| | | | | | | Prepare v2021.04-rc4
| * cmd: Add a command to display the address mapBin Meng2021-03-052-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>
* | doc: describe the scp03 commandJorge Ramirez-Ortiz2021-03-142-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>
* | doc: Add a note about producing 'md.b' output using hexdumpSimon Glass2021-03-021-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>
* | doc: describe the md commandSimon Glass2021-03-022-0/+97
|/ | | | | | Provide a man-page for the md command. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: Document partition specificationsSean Anderson2021-02-262-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>
* doc: qfw man-pageHeinrich Schuchardt2021-02-212-0/+90
| | | | | | Provide a man-page for the qfw command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: booti man-pageHeinrich Schuchardt2021-02-212-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>
* doc: return value exception commandHeinrich Schuchardt2021-02-041-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>
* doc: describe load commandHeinrich Schuchardt2021-02-042-0/+75
| | | | | | | Man-page for load command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: exception commandHeinrich Schuchardt2021-01-272-0/+69
| | | | | | Create man-page for exception command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: describe command conitraceHeinrich Schuchardt2021-01-252-0/+55
| | | | | | Provide a man-page for the conitrace command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: describe the false commandHeinrich Schuchardt2021-01-252-0/+29
| | | | | | Provide a man-page for the false command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: document true commandHeinrich Schuchardt2021-01-252-0/+29
| | | | | | Create a man-page for the true command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: describe loady commandHeinrich Schuchardt2021-01-252-0/+68
| | | | | | Create a man-page for the loady command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: document echo commandHeinrich Schuchardt2021-01-252-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>
* doc: document for statementHeinrich Schuchardt2021-01-252-0/+66
| | | | | | Create a man-page for the for statement. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: describe exit commandHeinrich Schuchardt2021-01-252-0/+41
| | | | | | Man-page for exit shell command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: document sbi commandHeinrich Schuchardt2021-01-252-0/+50
| | | | | | Add a man-page for the sbi command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* Merge tag 'doc-2021-04-rc1' of ↵Tom Rini2021-01-184-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
| * doc: move README.fdt-overlays to HTML documentationHeinrich Schuchardt2021-01-162-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>
| * doc: add synopsis for pstore commandHeinrich Schuchardt2021-01-161-1/+10
| | | | | | | | | | | | | | | | Add a synopsis section. Use lower case for command name. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: man-page base commandHeinrich Schuchardt2021-01-162-0/+24
| | | | | | | | | | | | Provide a description of the base command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | cmd: Add MBR partition layout control utilityMarek Szyprowski2021-01-152-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>
* doc: man-page for bootefi commandHeinrich Schuchardt2020-12-202-0/+136
| | | | | | Provide a description of the bootefi command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: button commandHeinrich Schuchardt2020-12-202-0/+65
| | | | | | Provide a description of the 'button' command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: move README.bootmenu to HTML docHeinrich Schuchardt2020-12-152-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>
* doc: move README.NetConsole to HTML documentationHeinrich Schuchardt2020-12-152-0/+111
| | | | | | | | Convert README.NetConsole to reStructured text and move it to doc/usage/netconsole.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: use code-block in pstore.rstHeinrich Schuchardt2020-12-151-1/+3
| | | | | | Use syntax highlighting for a Linux console session. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: move pstore.rst to usage/pstore.rstHeinrich Schuchardt2020-12-152-0/+94
Let's have a separate chapter dedicated to using U-Boot. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>