diff options
author | Tom Rini | 2021-02-04 17:35:50 -0500 |
---|---|---|
committer | Tom Rini | 2021-02-04 17:35:50 -0500 |
commit | 55ffabec7f9108060350fae29b932fbd832f8296 (patch) | |
tree | ca7399205efb7aeb994def6728c6d79fc10d4ba5 /doc | |
parent | 21cb717e79e3f6588abae52fe55e2c415850c913 (diff) | |
parent | 5489448cd7d46554f7f45a180754be78eff9f54d (diff) |
Merge tag 'efi-2021-04-rc2' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
Pull request for UEFI sub-system for efi-2021-04-rc2
Bug fixes:
* do not allow creating of files with filenames on FAT file system
* install UEFI System Partition GUID on ESP handle
* in dtbdump.efi test tool use GUID to find ESP handle
Documentation:
* man-page for load command
* describe end of life of plat_auto
Diffstat (limited to 'doc')
-rw-r--r-- | doc/driver-model/design.rst | 6 | ||||
-rw-r--r-- | doc/usage/exception.rst | 5 | ||||
-rw-r--r-- | doc/usage/index.rst | 1 | ||||
-rw-r--r-- | doc/usage/load.rst | 74 |
4 files changed, 78 insertions, 8 deletions
diff --git a/doc/driver-model/design.rst b/doc/driver-model/design.rst index 2417976ab74..4e5cecbab6a 100644 --- a/doc/driver-model/design.rst +++ b/doc/driver-model/design.rst @@ -725,7 +725,7 @@ The steps are: 2. If plat_auto is non-zero, then the platform data space is allocated. This is only useful for device tree operation, since - otherwise you would have to specific the platform data in the + otherwise you would have to specify the platform data in the U_BOOT_DRVINFO() declaration. The space is allocated for the device and zeroed. It will be accessible as dev->plat. @@ -861,8 +861,8 @@ remove it. This performs the probe steps in reverse: be dynamically allocated, and thus needs to be deallocated during the remove() method, either: - - if the plat_auto is non-zero, the deallocation - happens automatically within the driver model core; or + - if the plat_auto is non-zero, the deallocation happens automatically + within the driver model core in the unbind stage; or - when plat_auto is 0, both the allocation (in probe() or preferably of_to_plat()) and the deallocation in remove() diff --git a/doc/usage/exception.rst b/doc/usage/exception.rst index 412a03ba0f3..db1490f0055 100644 --- a/doc/usage/exception.rst +++ b/doc/usage/exception.rst @@ -61,8 +61,3 @@ Examples pc = 0x56076dd1a0f9, pc_reloc = 0x540f9 resetting ... - -Return value ------------- - -The return value $? is always set to 0 (true). diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 83cfbafd905..5754958d7e4 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -23,6 +23,7 @@ Shell commands exit false for + load loady mbr pstore diff --git a/doc/usage/load.rst b/doc/usage/load.rst new file mode 100644 index 00000000000..1efee773179 --- /dev/null +++ b/doc/usage/load.rst @@ -0,0 +1,74 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +load command +============ + +Synopsis +-------- + +:: + + load <interface> [<dev[:part]> [<addr> [<filename> [bytes [pos]]]]] + +Description +----------- + +The load command is used to read a file from a filesystem into memory. + +The number of transferred bytes is saved in the environment variable filesize. +The load address is saved in the environment variable fileaddr. + +interface + interface for accessing the block device (mmc, sata, scsi, usb, ....) + +dev + device number + +part + partition number, defaults to 0 (whole device) + +addr + load address, defaults to environment variable loadaddr or if loadaddr is + not set to configuration variable CONFIG_SYS_LOAD_ADDR + +filename + path to file, defaults to environment variable bootfile + +bytes + maximum number of bytes to load + +pos + number of bytes to skip + +addr, bytes, pos are hexadecimal numbers. + +Example +------- + +:: + + => load mmc 0:1 ${kernel_addr_r} snp.efi + 149280 bytes read in 11 ms (12.9 MiB/s) + => + => load mmc 0:1 ${kernel_addr_r} snp.efi 1000000 + 149280 bytes read in 9 ms (15.8 MiB/s) + => + => load mmc 0:1 ${kernel_addr_r} snp.efi 1000000 100 + 149024 bytes read in 10 ms (14.2 MiB/s) + => + => load mmc 0:1 ${kernel_addr_r} snp.efi 10 + 16 bytes read in 1 ms (15.6 KiB/s) + => + +Configuration +------------- + +The load command is only available if CONFIG_CMD_FS_GENERIC=y. + +Return value +------------ + +The return value $? is set to 0 (true) if the file was successfully loaded +even if the number of bytes is less then the specified length. + +If an error occurs, the return value $? is set to 1 (false). |