summaryrefslogtreecommitdiff
path: root/doc/usage
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2022-06-23 08:16:21 -0400
committerTom Rini <[email protected]>2022-06-23 08:16:21 -0400
commit9121478ee6f2aee381f8fe49d8997d43527d351a (patch)
tree44ca356e93474a6d909dd4754288bc92cee33e7c /doc/usage
parent52af0101be55da74a32e9b169864508101f886fe (diff)
parent929e581a620feba40bea659725f88b338d8b65ec (diff)
Merge branch '2022-06-22-platform-updates-and-additions' into next
- Add hpe gxp architecture and platform, Arm corstone1000 platform. - ast2600, devkit8000, NPCM7xx improvements
Diffstat (limited to 'doc/usage')
-rw-r--r--doc/usage/cmd/loadm.rst49
-rw-r--r--doc/usage/index.rst1
2 files changed, 50 insertions, 0 deletions
diff --git a/doc/usage/cmd/loadm.rst b/doc/usage/cmd/loadm.rst
new file mode 100644
index 00000000000..b6571140437
--- /dev/null
+++ b/doc/usage/cmd/loadm.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+loadm command
+=============
+
+Synopsis
+--------
+
+::
+
+ loadm <src_addr> <dst_addr> <len>
+
+Description
+-----------
+
+The loadm command is used to copy memory content from source address
+to destination address and, if efi is enabled, will setup a "Mem" efi
+boot device.
+
+The number of transferred bytes must be set by bytes parameter
+
+src_addr
+ start address of the memory location to be loaded
+
+dst_addr
+ destination address of the byte stream to be loaded
+
+len
+ number of bytes to be copied in hexadecimal. Can not be 0 (zero).
+
+Example
+-------
+
+::
+
+ => loadm ${kernel_addr} ${kernel_addr_r} ${kernel_size}
+ loaded bin to memory: size: 12582912
+
+Configuration
+-------------
+
+The command is only available if CONFIG_CMD_LOADM=y.
+
+Return value
+------------
+
+The return value $? is set 0 (true) if the loading is succefull, and
+is set to 1 (false) in case of error.
+
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 770418434ad..8d08ea14b00 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -44,6 +44,7 @@ Shell commands
cmd/fatload
cmd/for
cmd/load
+ cmd/loadm
cmd/loady
cmd/mbr
cmd/md