summaryrefslogtreecommitdiff
path: root/doc/usage/index.rst
AgeCommit message (Collapse)AuthorFilesLines
2023-09-02doc: Add gpt command documentationJoshua Watt1-0/+1
Adds initial documentation for the gpt command Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
2023-08-27doc: describe TPL/VPL/SPL bootHeinrich Schuchardt1-0/+1
This is a stub describing how TPL, VPL, and SPL load the next boot stages on a detail level for users. For sure we will need a few patches on top to catch the whole complexity. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Paul Barker <paul.barker.ct@bp.renesas.com>
2023-08-08arm_ffa: introduce armffa commandAbdellatif El Khlifi1-0/+1
Provide armffa command showcasing the use of the U-Boot FF-A support armffa is a command showcasing how to invoke FF-A operations. This provides a guidance to the client developers on how to call the FF-A bus interfaces. The command also allows to gather secure partitions information and ping these partitions. The command is also helpful in testing the communication with secure partitions. For more details please refer to the command documentation [1]. A Sandbox test is provided for the armffa command. [1]: doc/usage/cmd/armffa.rst Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Reviewed-by: Simon Glass <sjg@chromium.org> Cc: Tom Rini <trini@konsulko.com> Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> Cc: Jens Wiklander <jens.wiklander@linaro.org> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
2023-07-25Revert "Merge branch '2023-07-24-introduce-FF-A-suppport'"Tom Rini1-1/+0
This reverts commit d927d1a80843e1c3e2a3f0b8f6150790bef83da1, reversing changes made to c07ad9520c6190070513016fdb495d4703a4a853. These changes do not pass CI currently. Signed-off-by: Tom Rini <trini@konsulko.com>
2023-07-24arm_ffa: introduce armffa commandAbdellatif El Khlifi1-0/+1
Provide armffa command showcasing the use of the U-Boot FF-A support armffa is a command showcasing how to invoke FF-A operations. This provides a guidance to the client developers on how to call the FF-A bus interfaces. The command also allows to gather secure partitions information and ping these partitions. The command is also helpful in testing the communication with secure partitions. For more details please refer to the command documentation [1]. [1]: doc/usage/cmd/armffa.rst Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Reviewed-by: Simon Glass <sjg@chromium.org> Cc: Tom Rini <trini@konsulko.com> Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> Cc: Jens Wiklander <jens.wiklander@linaro.org> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
2023-07-17x86: mtrr: Add documentationSimon Glass1-0/+1
Add documention for the x86 'mtrr' command. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2023-07-14expo: Add a configuration editorSimon Glass1-0/+1
Add a new 'cedit' command which allows editing configuration using an expo. The configuration items appear as menus on the display. This is extremely basic, only supporting menus and not providing any way to load or save the configuration. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-07-01doc: saves man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the saves command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-07-01doc: loads man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the loads command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-06-23doc: Improve documentation for the bootm commandSimon Glass1-0/+1
Reformat and rewrite the documentation for this command. This is a complicated command, so further improvements are welcome. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-06-23doc: Move FIT into its own directorySimon Glass1-1/+1
Create a new usage/fit directory which will house information about FIT. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2023-06-23doc: bind man-pageHeinrich Schuchardt1-0/+1
provide a man-page for the bind command Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-06-23doc: unbind man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the unbind command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-06-16doc: man-page for imxtractHeinrich Schuchardt1-0/+1
Provide a man-page for the imxtract command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-06-02doc: loadx man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the loadx command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-06-02doc: loadb man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the loadb command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-05-04doc: man-page for cpHeinrich Schuchardt1-0/+1
Add a man-page for the cp command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-04-08doc: coninfo man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the coninfo command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-04-05doc: blkmap: Add introduction and examplesTobias Waldekranz1-0/+1
Explain block maps by going through two common use-cases. Signed-off-by: Tobias Waldekranz <tobias@waldekranz.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-03-25doc: Add help for the efi commandSimon Glass1-0/+1
This command currently has no help. Add some. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-03-17doc: document read/write commandsRasmus Villemoes1-0/+2
The read and write commands are, deliberately, implemented in the same file, so that they stay feature-compatible (e.g. if someone implements support for "read the full partition, however large that is", that same syntax should also work for write). In order to ensure the documentation for both are similarly kept in sync, and to avoid duplication, document them both in read.rst, and add a stub write.rst referring to read.rst. Signed-off-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-03-13doc: man-page for panic commandHeinrich Schuchardt1-0/+1
Provide a man-page for the panic command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-02-24Merge branch 'master' of https://source.denx.de/u-boot/custodians/u-boot-tegraTom Rini1-0/+1
2023-02-11trace: Update documentationSimon Glass1-0/+1
Revamp the documentation for the new features, including a description of the new features and documentation for the trace command. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-02-07cmd: Add a SEAMA image load commandLinus Walleij1-0/+1
Add a command to load SEAMA (Seattle Image), a NAND flash on-flash storage format. This type of flash image is found in some D-Link routers such as DIR-645, DIR-842, DIR-859, DIR-860L, DIR-885L, DIR890L and DCH-M225, as well as in WD and NEC routers on the ath79 (MIPS), Broadcom BCM53xx, and RAMIPS platforms. This U-Boot command will read and decode a SEAMA image from raw NAND flash on any platform. As it is always using big endian format for the data decoding is always necessary on platforms such as ARM. The command is needed to read a SEAMA-encoded boot image on the D-Link DIR-890L router for boot from NAND flash in an upcoming port of U-Boot to the Broadcom Northstar (BCM4709, BCM53xx) architecture. A basic test and documentation is added as well. The test must be run on a target with NAND flash support and at least one resident SEAMA image in flash. Cc: Rafał Miłecki <rafal@milecki.pl> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2023-01-31Merge tag 'u-boot-amlogic-20230131' of ↵Tom Rini1-0/+1
https://source.denx.de/u-boot/custodians/u-boot-amlogic - jethub j100: add rescue boot from microSD - move meson sm command to cmd/meson and add efusedump sub-command - switch dwc2 otg to DM for G12A, GXL & AXG - Add new boards: - Odroid Go Ultra - Odroid-N2L
2023-01-27doc: man-page for mtestHeinrich Schuchardt1-0/+1
Provide a man-page for the mtest command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-01-27doc: sleep man-pageHeinrich Schuchardt1-0/+1
Provide a man-page for the sleep command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-01-20doc: man-page for bdinfoHeinrich Schuchardt1-0/+1
Provide a man-page for the bdinfo command Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-01-20doc: man-page for blkcacheHeinrich Schuchardt1-0/+1
Provide a man-page for the blkcache command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-01-20doc: man-page for source commandHeinrich Schuchardt1-0/+1
Provide a man-page for the source command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Sean Anderson <seanga2@gmail.com>
2023-01-18doc: man-page for the part commandEnric Balletbo i Serra1-0/+1
Provide a man-page for the part command. Signed-off-by: Enric Balletbo i Serra <eballetbo@redhat.com>
2023-01-10doc/usage: cmd: documentation for meson/sm commandAlexey Romanov1-0/+1
Added docs for Meson Security Monitor command. Signed-off-by: Alexey Romanov <avromanov@sberdevices.ru> Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Link: https://lore.kernel.org/r/20230110105650.54580-4-avromanov@sberdevices.ru Signed-off-by: Neil Armstrong <neil.armstrong@linaro.org>
2022-12-05doc: man-page for the sound commandHeinrich Schuchardt1-0/+1
Provide a man-page for the sound command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-11-28doc: cmd: wget: add documentationYing-Chun Liu (PaulLiu)1-0/+1
Add documentation for the wget command. Signed-off-by: Ying-Chun Liu (PaulLiu) <paul.liu@linaro.org> Cc: Christian Gmeiner <christian.gmeiner@gmail.com> Cc: Joe Hershberger <joe.hershberger@ni.com> Cc: Michal Simek <michal.simek@xilinx.com> Cc: Ramon Fried <rfried.dev@gmail.com> Cc: Simon Glass <sjg@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Ramon Fried <rfried.dev@gmail.com>
2022-11-16doc: add man-page for cmp commandHeinrich Schuchardt1-0/+1
Provide a man-page for the cmp command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-11-16Documentation: man-page for command bootdHeinrich Schuchardt1-0/+1
Provide a man-page for the bootd command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-11-08dm: Add documentation for host command and implementationSimon Glass1-0/+1
Document the 'host' command and also the internals of how it is implemented. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-11-08test: doc: Add documentation for ut commandSimon Glass1-0/+1
Before adding more options, document this command. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-10-31FWU: cmd: Add a command to read FWU metadataSughosh Ganu1-0/+1
Add a command to read the metadata as specified in the FWU specification and print the fields of the metadata. Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Etienne Carriere <etienne.carriere@linaro.org>
2022-10-30video: Add commands to list and change fontsSimon Glass1-0/+1
Add a new 'font' command which allows the fonts to be listed as well as selecting a different font and size. Allow the test to run on sandbox, where multiple font/size combinations are supported, as well as sandbox_flattree, where they are not. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-10-11doc: cmd: temperature: add documentationRobert Marko1-0/+1
Add documentation for the temperature command. Signed-off-by: Robert Marko <robert.marko@sartura.hr> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-10-11cmd: xxd: add new commandRoger Knecht1-0/+1
Add xxd command to print file content as hexdump to standard out Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Roger Knecht <rknecht@pm.me>
2022-10-11cmd: cat: add new commandRoger Knecht1-0/+1
Add cat command to print file content to standard out Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Roger Knecht <rknecht@pm.me>
2022-10-10doc: man-page for clsHeinrich Schuchardt1-0/+1
Provide a man-page for the cls command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-19Merge branch 'master' into nextTom Rini1-0/+1
Signed-off-by: Tom Rini <trini@konsulko.com>
2022-09-14Merge tag 'efi-next-2022-09-14' of ↵Tom Rini1-0/+1
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 Kojima1-0/+1
Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2022-09-13cyclic: Add documentationStefan Roese1-0/+1
Add documentation for the cyclic function infrastructure, including the cyclic command. Signed-off-by: Stefan Roese <sr@denx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-09doc: man-page for tftpputHeinrich Schuchardt1-0/+1
Provide a man-page for the tftpput command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
generated by cgit v1.2.3 (git 2.39.0) at 2024-08-26 14:35:42 +0300