This converts the existing README.commands.spl file to rST as
doc/usage/cmd/spl.rst and adds it to the command index. Minimal
rewording is done to the previous contents, to make it fit better with
the overall style of documentation now.
Signed-off-by: Tom Rini <tr...@konsulko.com>
---
Cc: Heinrich Schuchardt <xypron.g...@gmx.de>
---
doc/README.commands.spl | 31 --------------------------
doc/usage/cmd/spl.rst | 48 +++++++++++++++++++++++++++++++++++++++++
doc/usage/index.rst | 1 +
3 files changed, 49 insertions(+), 31 deletions(-)
delete mode 100644 doc/README.commands.spl
create mode 100644 doc/usage/cmd/spl.rst
diff --git a/doc/README.commands.spl b/doc/README.commands.spl
deleted file mode 100644
index ecfd3ca9ee58..000000000000
--- a/doc/README.commands.spl
+++ /dev/null
@@ -1,31 +0,0 @@
-The spl command is used to export a boot parameter image to RAM. Later
-it may implement more functions connected to the SPL.
-
-SUBCOMMAND EXPORT
-To execute the command everything has to be in place as if bootm should be
-used. (kernel image, initrd-image, fdt-image etc.)
-
-export has two subcommands:
- atags: exports the ATAGS
- fdt: exports the FDT
-
-Call is:
-spl export <fdt|atags> [kernel_addr] [initrd_addr] [fdt_addr if fdt]
-
-
-TYPICAL CALL
-
-on OMAP3:
-nandecc hw
-nand read 0x82000000 0x280000 0x400000 /* Read kernel image from NAND*/
-spl export atags /* export ATAGS */
-nand erase 0x680000 0x20000 /* erase - one page */
-nand write 0x80000100 0x680000 0x20000 /* write the image - one page */
-
-call with FDT:
-nandecc hw
-nand read 0x82000000 0x280000 0x400000 /* Read kernel image from NAND*/
-tftpboot 0x80000100 devkit8000.dtb /* Read fdt */
-spl export fdt 0x82000000 - 0x80000100 /* export FDT */
-nand erase 0x680000 0x20000 /* erase - one page */
-nand write <adress shown by spl export> 0x680000 0x20000
diff --git a/doc/usage/cmd/spl.rst b/doc/usage/cmd/spl.rst
new file mode 100644
index 000000000000..59471c65a623
--- /dev/null
+++ b/doc/usage/cmd/spl.rst
@@ -0,0 +1,48 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+.. index::
+ single: spl (command)
+
+spl command
+===========
+
+Synopsis
+--------
+
+::
+
+ spl export <fdt|atags> [kernel_addr] [initrd_addr] [fdt_addr if fdt]
+
+Description
+-----------
+
+The *spl* command is used to export a boot parameter image to RAM. Later
+it may implement more functions connected to the SPL.
+
+spl export
+~~~~~~~~~~
+
+To execute the command everything has to be in place as if bootm should be
+used. (kernel image, initrd-image, fdt-image if used). The first argument
+passed to the export subcommand must be either atags or fdt, which signifies if
+we are preparing an ATAGS or device tree for export.
+
+Example
+-------
+
+On an OMAP3 platform with ATAGS::
+
+ => nandecc hw
+ => nand read 0x82000000 0x280000 0x400000 /* Read kernel image from NAND*/
+ => spl export atags /* export ATAGS */
+ => nand erase 0x680000 0x20000 /* erase - one page */
+ => nand write 0x80000100 0x680000 0x20000 /* write the image - one page */
+
+On an OMAP3 platform with device tree::
+
+ => nandecc hw
+ => nand read 0x82000000 0x280000 0x400000 /* Read kernel image from NAND*/
+ => tftpboot 0x80000100 devkit8000.dtb /* Read fdt */
+ => spl export fdt 0x82000000 - 0x80000100 /* export FDT */
+ => nand erase 0x680000 0x20000 /* erase - one page */
+ => nand write <adress shown by spl export> 0x680000 0x20000
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 3a48521d5d56..a34db5cb627b 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -124,6 +124,7 @@ Shell commands
cmd/sntp
cmd/sound
cmd/source
+ cmd/spl
cmd/tcpm
cmd/temperature
cmd/test
--
2.43.0
