summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2022-10-11 17:35:42 -0400
committerTom Rini <[email protected]>2022-10-11 17:35:42 -0400
commit8db1fa5a0da78c1a9a16882f2e49beac3ccf5308 (patch)
tree917986046cbdb4c39576bb1d733a33523fe44ca8 /doc
parent300077cf8cfe6875f3f0a919ec1d0dd32c42b178 (diff)
parentc68e73b65fb9101e3234586db29c3a04e9b37534 (diff)
Merge branch '2022-10-11-assorted-fixes-and-updates'
- Assorted code cleanups and fixes, along with two new commands.
Diffstat (limited to 'doc')
-rw-r--r--doc/README.pxe12
-rw-r--r--doc/develop/distro.rst32
-rw-r--r--doc/usage/cmd/cat.rst49
-rw-r--r--doc/usage/cmd/temperature.rst50
-rw-r--r--doc/usage/cmd/xxd.rst50
-rw-r--r--doc/usage/index.rst3
6 files changed, 193 insertions, 3 deletions
diff --git a/doc/README.pxe b/doc/README.pxe
index 75caa01c4a1..d14d2bdcc9b 100644
--- a/doc/README.pxe
+++ b/doc/README.pxe
@@ -163,6 +163,13 @@ fdtoverlays <path> [...] - if this label is chosen, use tftp to retrieve the DT
and then applied in the load order to the fdt blob stored at the
address indicated in the fdt_addr_r environment variable.
+devicetree-overlay <path> [...] - if this label is chosen, use tftp to retrieve the DT
+ overlay(s) at <path>. it will be temporarily stored at the
+ address indicated in the fdtoverlay_addr_r environment variable,
+ and then applied in the load order to the fdt blob stored at the
+ address indicated in the fdt_addr_r environment variable.
+ Alias for fdtoverlays.
+
kaslrseed - set this label to request random number from hwrng as kaslr seed.
append <string> - use <string> as the kernel command line when booting this
@@ -178,6 +185,11 @@ fdt <path> - if this label is chosen, use tftp to retrieve the fdt blob
the fdt_addr_r environment variable, and that address will
be passed to bootm.
+devicetree <path> - if this label is chosen, use tftp to retrieve the fdt blob
+ at <path>. it will be stored at the address indicated in
+ the fdt_addr_r environment variable, and that address will
+ be passed to bootm. Alias for fdt.
+
fdtdir <path> - if this label is chosen, use tftp to retrieve a fdt blob
relative to <path>. If the fdtfile environment variable
is set, <path>/<fdtfile> is retrieved. Otherwise, the
diff --git a/doc/develop/distro.rst b/doc/develop/distro.rst
index 3ee3dac6a27..bc72aa951ef 100644
--- a/doc/develop/distro.rst
+++ b/doc/develop/distro.rst
@@ -68,10 +68,10 @@ Boot Configuration Files
The standard format for boot configuration files is that of extlinux.conf, as
handled by U-Boot's "syslinux" (disk) or "pxe boot" (network). This is roughly
-as specified at BootLoaderSpec_:
+as specified at `Boot Loader Specification`_:
-... with the exceptions that the BootLoaderSpec document:
+... with the exceptions that the Boot Loader Specification document:
* Prescribes a separate configuration per boot menu option, whereas U-Boot
lumps all options into a single extlinux.conf file. Hence, U-Boot searches
@@ -81,6 +81,8 @@ as specified at BootLoaderSpec_:
* Does not document the fdtdir option, which automatically selects the DTB to
pass to the kernel.
+See also doc/README.pxe under 'pxe file format'.
+
One example extlinux.conf generated by the Fedora installer is::
# extlinux.conf generated by anaconda
@@ -115,6 +117,25 @@ One example extlinux.conf generated by the Fedora installer is::
fdtdir /boot/dtb-3.16.0-0.rc6.git1.1.fc22.armv7hl+lpae
+One example of hand-crafted extlinux.conf::
+
+ menu title Select kernel
+ timeout 100
+
+ label Arch with uart devicetree overlay
+ kernel /arch/Image.gz
+ initrd /arch/initramfs-linux.img
+ fdt /dtbs/arch/board.dtb
+ fdtoverlays /dtbs/arch/overlay/uart0-gpio0-1.dtbo
+ append console=ttyS0,115200 console=tty1 rw root=UUID=fc0d0284-ca84-4194-bf8a-4b9da8d66908
+
+ label Arch with uart devicetree overlay but with Boot Loader Specification keys
+ kernel /arch/Image.gz
+ initrd /arch/initramfs-linux.img
+ devicetree /dtbs/arch/board.dtb
+ devicetree-overlay /dtbs/arch/overlay/uart0-gpio0-1.dtbo
+ append console=ttyS0,115200 console=tty1 rw root=UUID=fc0d0284-ca84-4194-bf8a-4b9da8d66908
+
Another hand-crafted network boot configuration file is::
TIMEOUT 100
@@ -214,6 +235,11 @@ fdt_addr_r:
A size of 1MB for the FDT/DTB seems reasonable.
+fdtoverlay_addr_r:
+ Mandatory. The location in RAM where DTB overlays will be temporarily
+ stored and then applied in the load order to the fdt blob stored at the
+ address indicated in the fdt_addr_r environment variable.
+
fdtfile:
Mandatory. the name of the DTB file for the specific board for instance
the espressobin v5 board the value is "marvell/armada-3720-espressobin.dtb"
@@ -408,7 +434,7 @@ way in future u-boot versions. In particular the <device type>_boot
variables (e.g. mmc_boot, usb_boot) are a strictly internal implementation
detail and must not be used as a public interface.
-.. _BootLoaderSpec: http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec/
+.. _`Boot Loader Specification`: https://systemd.io/BOOT_LOADER_SPECIFICATION/
.. sectionauthor:: (C) Copyright 2014 Red Hat Inc.
.. sectionauthor:: Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved.
diff --git a/doc/usage/cmd/cat.rst b/doc/usage/cmd/cat.rst
new file mode 100644
index 00000000000..5ef4731fe3f
--- /dev/null
+++ b/doc/usage/cmd/cat.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+cat command
+===============
+
+Synopsis
+--------
+
+::
+
+ cat <interface> <dev[:part]> <file>
+
+Description
+-----------
+
+The cat command prints the file content to standard out.
+
+interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+
+dev
+ device number
+
+part
+ partition number, defaults to 1
+
+file
+ path to file
+
+Example
+-------
+
+Here is the output for a example text file:
+
+::
+
+ => cat mmc 0:1 hello
+ hello world
+ =>
+
+Configuration
+-------------
+
+The cat command is only available if CONFIG_CMD_CAT=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the file is readable, otherwise it returns a non-zero error code.
diff --git a/doc/usage/cmd/temperature.rst b/doc/usage/cmd/temperature.rst
new file mode 100644
index 00000000000..a5144ec50f8
--- /dev/null
+++ b/doc/usage/cmd/temperature.rst
@@ -0,0 +1,50 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+temperature command
+===================
+
+Synopsis
+--------
+
+::
+
+ temperature list
+ temperature get [thermal device name]
+
+Description
+-----------
+
+The *temperature* command is used to list thermal sensors and get their
+readings.
+
+The 'temperature list' command diplays the available thermal devices.
+
+The 'temperature get' command is used to get the reading in degrees C from
+the desired device which is selected by passing its device name.
+
+ thermal device name
+ device name of thermal sensor to select
+
+Example
+-------
+
+::
+
+
+ => temperature list
+ | Device | Driver | Parent
+ | tmon@610508110 | sparx5-temp | axi@600000000
+ =>
+ => temperature get tmon@610508110
+ tmon@610508110: 42 C
+
+Configuration
+-------------
+
+The *temperature* command is only available if CONFIG_CMD_TEMPERATURE=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the command succeeded and to 1 (false)
+otherwise.
diff --git a/doc/usage/cmd/xxd.rst b/doc/usage/cmd/xxd.rst
new file mode 100644
index 00000000000..0de1223dce3
--- /dev/null
+++ b/doc/usage/cmd/xxd.rst
@@ -0,0 +1,50 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+xxd command
+===============
+
+Synopsis
+--------
+
+::
+
+ xxd <interface> <dev[:part]> <file>
+
+Description
+-----------
+
+The xxd command prints the file content as hexdump to standard out.
+
+interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+
+dev
+ device number
+
+part
+ partition number, defaults to 1
+
+file
+ path to file
+
+Example
+-------
+
+Here is the output for a example text file:
+
+::
+
+ => xxd mmc 0:1 hello
+ 00000000: 68 65 6c 6c 6f 20 77 6f 72 6c 64 0a 00 01 02 03 hello world.....
+ 00000010: 04 05 ..
+ =>
+
+Configuration
+-------------
+
+The xxd command is only available if CONFIG_CMD_XXD=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the file is readable, otherwise it returns a non-zero error code.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index d0641105ae4..90221015ee1 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -31,6 +31,7 @@ Shell commands
cmd/bootmeth
cmd/button
cmd/bootz
+ cmd/cat
cmd/cbsysinfo
cmd/cls
cmd/conitrace
@@ -67,10 +68,12 @@ Shell commands
cmd/scp03
cmd/setexpr
cmd/size
+ cmd/temperature
cmd/tftpput
cmd/true
cmd/ums
cmd/wdt
+ cmd/xxd
Booting OS
----------