summaryrefslogtreecommitdiff
path: root/doc/usage
AgeCommit message (Collapse)AuthorFilesLines
2024-09-21doc: usage: cmd: ums: fix dependenciesThomas Perrot1-1/+1
Replace CONFIG_USB_USB_GADGET by CONFIG_USB_GADGET_DOWNLOAD. Signed-off-by: Thomas Perrot <thomas.perrot@bootlin.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-08-24doc: document the pwm commandEmil Kronborg2-0/+92
Signed-off-by: Emil Kronborg <emil.kronborg@protonmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-08-02doc: cmd: add documentation for cpu commandHou Zhiqiang2-0/+102
Add documentation for the 'cpu' command, taking NXP i.MX 8M Plus as a example. Signed-off-by: Hou Zhiqiang <Zhiqiang.Hou@nxp.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-07-19doc: Move bootstd into its own directorySimon Glass4-4/+4
Before adding more files, move the bootstd docs into a new directory, with an index. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
2024-07-19doc: add missing table of content linksSam Povilus1-4/+17
add missing table of content links, make alphabetical Signed-off-by: Sam Povilus <sam.povilus@amd.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-07-19doc: Remove FIT documentation that is elsewhereSam Povilus2-682/+6
Before 9d0750064e (doc: Move external FIT docs into the main body), the FIT property data-size was not a mandatory property and still it is not expected to be set alongside the data property. Move the data-size property to the "Conditionally mandatory property" section, where it actually belongs. Signed-off-by: Sam Povilus <sam.povilus@amd.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-07-14doc: add bootelf command documentationMaxim Moskalets2-0/+62
Signed-off-by: Maxim Moskalets <maximmosk4@gmail.com> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-07-14doc: fix heading level of itest examplesHeinrich Schuchardt1-1/+1
The Examples section should be on the second heading level. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-07-01Merge branch 'next'Tom Rini1-3/+3
2024-06-30doc: fit: Make data-size a conditionally mandatory propertyBastian Germann1-3/+3
Before 9d0750064e (doc: Move external FIT docs into the main body), the FIT property data-size was not a mandatory property and still it is not expected to be set alongside the data property. Move the data-size property to the "Conditionally mandatory property" section, where it actually belongs. Signed-off-by: Bastian Germann <bage@debian.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-06-28Drop the special am335x_boneblack_vboot targetSimon Glass1-11/+10
Now that am335x_evm boots OK on the Beaglebone black, drop the latter and update the docs to cover the change. Also add a few updates about 'make fit' and drop the note about the security review, as U-Boot's verified boot has had quite extensive review now. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Tom Rini <trini@konsulko.com>
2024-06-16doc: Fix link reference to general verified boot docsAlexander Dahl1-1/+1
Fixes: ad29e08b79fd ("doc: Bring in FIT signature files") Signed-off-by: Alexander Dahl <ada@thorsis.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-06-16doc: describe UEFI measured bootIlias Apalodimas1-4/+31
We currently only describe the process to enable measured boot using bootm. Describe the UEFI requirements as well which predate bootm. Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-06-10doc: cmd: bootmeth: Fix extlinunx -> extlinux typoMattijs Korpershoek1-1/+1
Fix a trivial typo in the bootmeth documentation. Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-06-06doc: Update netconsole examples, mention stderrFiona Klute1-9/+11
Stderr was missing from the initial description and example. As I understand the env command documentation the subcommand style is preferred, though the old format is still fully supported. Signed-off-by: Fiona Klute <fiona.klute@gmx.de> Reviewed-by: Tony Dinh <mibodhi@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2024-06-06doc: Detailed example for netconsole setupFiona Klute1-1/+34
This adds details that I would have liked to have readily available, in particular how to activate the network interface before enabling netconsole, and how to integrate netconsole so you can use the U-Boot prompt. Signed-off-by: Fiona Klute <fiona.klute@gmx.de> Reviewed-by: Tony Dinh <mibodhi@gmail.com>
2024-06-06doc: add clarity to what a "fpga" image isSam Povilus1-1/+1
Update fit documentation to clarify that FPGA images are vendor specific and opaque bitstreams. Signed-off-by: Sam Povilus <sam.povilus@amd.com>
2024-06-06doc: Remove extraneous curly bracesSam Povilus1-14/+14
Update documentation to remove un-needed curly braces. Signed-off-by: Sam Povilus <sam.povilus@amd.com>
2024-05-01doc: correct description of 'env print -e'Heinrich Schuchardt1-3/+7
If 'env print -e' is invoked without variable name, all UEFI variables are listed. Describe that 'env print -e' requires CONFIG_HEXDUMP=y to print content of UEFI variables. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-04-20doc: update list of aliases for the env commandHeinrich Schuchardt1-1/+2
* add link to askenv man-page * add printenv Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-04-20doc: sort env sub-commands alphabeticallyHeinrich Schuchardt1-17/+17
The 'env' man-page is currently only partially sorted. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-04-14Merge https://source.denx.de/u-boot/custodians/u-boot-usbTom Rini1-0/+13
2024-04-12usb: Add environment based device ignorelistJanne Grunau1-0/+13
Add the environment variable "usb_ignorelist" to prevent USB devices listed in it from being bound to drivers. This allows to ignore devices which are undesirable or trigger bugs in u-boot's USB stack. Devices emulating keyboards are one example of undesirable devices as u-boot currently supports only a single USB keyboard device. Most commonly, people run into this with Yubikeys, so let's ignore those in the default environment. Based on previous USB keyboard specific patches for the same purpose. Link: https://lore.kernel.org/u-boot/7ab604fb-0fec-4f5e-8708-7a3a7e2cb568@denx.de/ Reviewed-by: Neal Gompa <neal@gompa.dev> Reviewed-by: Marek Vasut <marex@denx.de> Signed-off-by: Janne Grunau <j@jannau.net>
2024-04-08doc: improve description of FAT partition name generationHeinrich Schuchardt1-3/+14
List all prefix currently used for generating FAT partition names. Describe which device class uses which prefix. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-04-08doc: missing :: in doc/usage/cmd/itest.rstHeinrich Schuchardt1-0/+2
Add :: for correct formatting of example. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-04-02Merge branch 'next'Tom Rini2-4/+11
Merge in all changes from the next branch now that the release is out.
2024-03-27doc: add reference to itest in if man-pageHeinrich Schuchardt1-3/+3
Add a cross reference to the itest command. Fix a typo: %s/Example/Examples/. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-27doc: man-page for itestHeinrich Schuchardt2-0/+114
Provide a man-page for the itest command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-25Merge tag 'v2024.04-rc5' into nextTom Rini2-0/+73
Prepare v2024.04-rc5
2024-03-21doc: typo SynopisHeinrich Schuchardt21-42/+42
%s/Synopis/Synopsis/g Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-21doc: man-page for ifHeinrich Schuchardt2-0/+73
Provide a man-page for the if command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-21doc: typo SynopisHeinrich Schuchardt21-42/+42
%s/Synopis/Synopsis/g Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-19Merge tag 'u-boot-socfpga-next-20240319' of ↵Tom Rini1-1/+1
https://source.denx.de/u-boot/custodians/u-boot-socfpga into next - A new driver in the misc to register setting from device tree. This also provides user a clean interface and all register settings are centralized in one place, device tree. - Enable Agilex5 platform for Intel product. Changes, modification and new files are created for board, dts, configs and makefile to create the base for Agilex5. Build-tested on SoC64 boards, boot tested on some of them.
2024-03-13cmd: rng: Add rng list commandWeizhao Ouyang1-4/+10
The 'rng list' command probes all RNG devices and list those devices that are successfully probed. Also update the help info. Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Weizhao Ouyang <o451686892@gmail.com>
2024-03-13doc: fix mistyped "env flags" commandThomas Weißschuh1-1/+1
Signed-off-by: Thomas Weißschuh <thomas@t-8ch.de> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2024-03-02cmd: setexpr: fix no matching string in gsub return empty valueMassimiliano Minella1-0/+1
In gsub, when the destination string is empty, the string 't' is provided and the regular expression doesn't match, then the final result is an empty string. Example: => echo ${foo} => setenv foo => setexpr foo gsub e a bar => echo ${foo} => The variable ${foo} should contain "bar" and the lack of match shouldn't be considered an error. This patch fixes the erroneous behavior by removing the return statement and breaking out of the loop in case of lack of match. Also add a test for the no match case. Signed-off-by: Massimiliano Minella <massimiliano.minella@se.com>
2024-02-13boot: add support for button commandsCaleb Connolly1-0/+4
With the relatively new button API in U-Boot, it's now much easier to model the common usecase of mapping arbitrary actions to different buttons during boot - for example entering fastboot mode, setting some additional kernel cmdline arguments, or booting with a custom recovery ramdisk, to name a few. Historically, this functionality has been implemented in board code, making it fixed for a given U-Boot binary and requiring the code be duplicated and modified for every board. Implement a generic abstraction to run an arbitrary command during boot when a specific button is pressed. The button -> command mapping is configured via environment variables with the following format: button_cmd_N_name=<button label> button_cmd_N=<command to run> Where N is the mapping number starting from 0. For example: button_cmd_0_name=vol_down button_cmd_0=fastboot usb 0 This will cause the device to enter fastboot mode if volume down is held during boot. After we enter the cli loop the button commands are no longer valid, this allows the buttons to additionally be used for navigating a boot menu. Tested-by: Svyatoslav Ryhel <clamor95@gmail.com> # Tegra30 Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
2024-01-26doc: man-page for smbios commandHeinrich Schuchardt2-0/+94
Provide a man-page for the smbios command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2024-01-17Merge tag 'efi-2024-04-rc1-2' of ↵Tom Rini93-30/+306
https://source.denx.de/u-boot/custodians/u-boot-efi Documentation: * add generated index to table of contents * create index entries for commands * update Python packages used to build the documentation * fix typos in dfu documentation UEFI: * split unrelated code from efi_bootmgr.c * rename CONFIG_BOOTEFI_BOOTMGR to CONFIG_EFI_BOOTMGR * net: tftp: remove explicit EFI configuration dependency * fs: remove explicit EFI configuration dependency Other: * Add Goldfish RTC driver and make it available on RISC-V QEMU
2024-01-17doc: drop references to non-existing CONFIG_MEM_SUPPORT_64BIT_DATARasmus Villemoes2-2/+2
Such a config option does not exist. Rephrase, and avoid mentioning MEM_SUPPORT_64BIT_DATA, which is an implementation detail. Signed-off-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk>
2024-01-17doc: create index entries for commandsHeinrich Schuchardt92-0/+276
Add the description of CLI commands to the generated index. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17doc: dfu: fix a handful of typosMattijs Korpershoek1-30/+30
Reword some sentences, add missing periods and fix various typos in the dfu documentation. This was originally contributed on [1] [1] https://github.com/Maalobs/u-boot/commit/9a21ed8ba722d904b68945f40ca6697b4b1cc4d4 Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
2024-01-16doc/usage/cmd/cp.rst: document that overlapping regions are supportedRasmus Villemoes1-1/+2
Now that the cp command is changed to use memmove() internally, update the documentation to explicitly state that overlapping regions are allowed. Signed-off-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk>
2024-01-03Merge tag 'v2024.01-rc6' into nextTom Rini2-1/+6
Prepare v2024.01-rc6
2023-12-28cli: Enables using modern hush parser as command line parserFrancis Laniel1-2/+17
If one defines HUSH_MODERN_PARSER, it is then possible to use modern parser with: => cli get old => cli set modern => cli get modern Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Francis Laniel <francis.laniel@amarulasolutions.com>
2023-12-28cmd: Add new cli commandFrancis Laniel2-0/+60
This command can be used to print the current parser with 'cli get'. It can also be used to set the current parser with 'cli set'. For the moment, only one value is valid for set: old. Signed-off-by: Francis Laniel <francis.laniel@amarulasolutions.com>
2023-12-20rsa: use pkcs11 uri as defined in rfc7512Ayoub Zaki1-1/+1
pkcs11 : change engine uri to use full pk11-URI as defined in: https://www.rfc-editor.org/rfc/rfc7512.html Signed-off-by: Ayoub Zaki <ayoub.zaki@embetrix.com>
2023-12-19net: wget: Support non-default HTTP portMarek Vasut2-1/+6
Currently the wget command is hard wired to HTTP port 80. This is inconvenient, as it is extremely easy to start trivial HTTP server as an unprivileged user using e.g. python http module to serve the files, but such a server has to run on one of the higher ports: " $ python3 -m http.server -d $(pwd) 8080 " Make it possible to configure HTTP server port the same way it is possible to configure TFTP server port, using environment variable 'httpdstp' (similar to 'tftpdstp'). Retain port 80 as the default fallback port. This way, users can start their own trivial server and conveniently download whatever files they need into U-Boot. Signed-off-by: Marek Vasut <marex@denx.de> Reviewed-by: Tom Rini <trini@konsulko.com> Reviewed-by: Ramon Fried <rfried.dev@gmail.com>
2023-12-17doc: Replace examples of MD5 and SHA1 with SHA256Sean Anderson15-105/+105
Both SHA1 and (especially) MD5 are no longer as safe as they once were for cryptographic use. Replaces examples which use them with examples using SHA256 instead. This will provide more-secure defaults for users who use documentation examples as a base for their own use. This is not too necessary for non-verified-boot scenarios (since someone could just replace the checksum), but I wanted to be complete. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Peter Robinson <pbrobinson@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Tom Rini <trini@konsulko.com>
2023-12-13bootstd: Add a menu option to bootflow scanSimon Glass1-0/+5
Allow showing a menu and automatically booting, with 'bootflow scan'. This is more convenient than using a script. Signed-off-by: Simon Glass <sjg@chromium.org>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 23:19:09 +0000