From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Tue, 16 May 2023 05:43:01 +0000 (+0200)
Subject: doc: loadb man-page
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=e48f29d7cab7ed80a36836ad684312b21e798882;p=u-boot.git

doc: loadb man-page

Provide a man-page for the loadb command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---

diff --git a/doc/usage/cmd/loadb.rst b/doc/usage/cmd/loadb.rst
new file mode 100644
index 0000000000..b37d1d7b59
--- /dev/null
+++ b/doc/usage/cmd/loadb.rst
@@ -0,0 +1,70 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+loadb command
+=============
+
+Synopsis
+--------
+
+::
+
+    loadb [addr [baud]]
+
+Description
+-----------
+
+The loady command is used to transfer a file to the device via the serial line
+using the Kermit protocol.
+
+The number of transferred bytes is saved in environment variable filesize.
+
+addr
+    load address, defaults to environment variable loadaddr or if loadaddr is
+    not set to configuration variable CONFIG_SYS_LOAD_ADDR
+
+baud
+    baud rate for the Kermit transmission. After the transmission the baud
+    rate is reset to the original value.
+
+Example
+-------
+
+In the example below the terminal emulation program picocom and G-Kermit
+serve to transfer a file to a device.
+
+.. code-block:: bash
+
+    picocom --baud 115200 --send-cmd "gkermit -iXvs" /dev/ttyUSB0
+
+After entering the loadb command the key sequence <CTRL-A><CTRL-S> is used to
+let picocom prompt for the file name. Picocom invokes G-Kermit for the file
+transfer.
+
+::
+
+    => loadb 60800000 115200
+    ## Ready for binary (kermit) download to 0x60800000 at 115200 bps...
+
+    *** file: helloworld.efi
+    $ gkermit -iXvs helloworld.efi
+    G-Kermit 2.01, The Kermit Project, 2021-11-15
+    Escape back to your local Kermit and give a RECEIVE command.
+
+    KERMIT READY TO SEND...
+    |
+    *** exit status: 0 ***
+    ## Total Size      = 0x00000c00 = 3072 Bytes
+    ## Start Addr      = 0x60800000
+    =>
+
+The transfer can be cancelled by pressing <CTRL+C>.
+
+Configuration
+-------------
+
+The command is only available if CONFIG_CMD_LOADB=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) on success, 1 (false) on error.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0fde130a54..f348848fc7 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -63,6 +63,7 @@ Shell commands
    cmd/gpio
    cmd/host
    cmd/load
+   cmd/loadb
    cmd/loadm
    cmd/loady
    cmd/mbr