summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2023-01-19 09:41:54 -0500
committerTom Rini <[email protected]>2023-01-19 09:41:54 -0500
commit7aec35be4b5fa7aabc0ece03dc8825495d86a1be (patch)
tree483d9f85e8184cb91f00e3345391bff13eee580a /doc
parent5b958dea5c678dbdb2aeb6ac3c0c8cc8dfea065c (diff)
parentace75d642fa71034b248cde30709c79e06c52d61 (diff)
Merge branch '2022-01-18-assorted-updates'
- A few TI platform fixes, compression test cleanup and zstd update, npcm7xx update, add "part type" subcommand, VBE bugfix on some platforms, cleanup EVENT related Kconfig option logic (and fix some platforms), other minor cleanups.
Diffstat (limited to 'doc')
-rw-r--r--doc/README.gpt2
-rw-r--r--doc/board/google/chromebook_coral.rst2
-rw-r--r--doc/usage/cmd/part.rst154
-rw-r--r--doc/usage/index.rst1
4 files changed, 157 insertions, 2 deletions
diff --git a/doc/README.gpt b/doc/README.gpt
index 91e397d06f8..cc2a1b7ac78 100644
--- a/doc/README.gpt
+++ b/doc/README.gpt
@@ -260,7 +260,7 @@ Partition type GUID:
For created partition, the used partition type GUID is
PARTITION_BASIC_DATA_GUID (EBD0A0A2-B9E5-4433-87C0-68B6B72699C7).
-If you define 'CONFIG_PARTITION_TYPE_GUID', a optionnal parameter 'type'
+If you define 'CONFIG_PARTITION_TYPE_GUID', an optional parameter 'type'
can specify a other partition type guid:
"uuid_disk=...;name=u-boot,size=60MiB,uuid=...;
diff --git a/doc/board/google/chromebook_coral.rst b/doc/board/google/chromebook_coral.rst
index 8edbf0429cd..23e2db45564 100644
--- a/doc/board/google/chromebook_coral.rst
+++ b/doc/board/google/chromebook_coral.rst
@@ -259,7 +259,7 @@ Boot flow - U-Boot pre-relocation
U-Boot (running from start_from_spl.S) starts running in RAM and uses the same
stack as SPL. It does various init activities before relocation. Notably
-arch_cpu_init_dm() sets up the pin muxing for the chip using a very large table
+fsp_setup_pinctrl() sets up the pin muxing for the chip using a very large table
in the device tree.
PCI auto-config is not used before relocation, but CONFIG_PCI of course is
diff --git a/doc/usage/cmd/part.rst b/doc/usage/cmd/part.rst
new file mode 100644
index 00000000000..8d2a2803912
--- /dev/null
+++ b/doc/usage/cmd/part.rst
@@ -0,0 +1,154 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+part command
+===============
+
+Synopis
+-------
+
+::
+
+ part uuid <interface> <dev>:<part> [varname]
+ part list <interface> <dev> [flags] [varname]
+ part start <interface> <dev> <part> <varname>
+ part size <interface> <dev> <part> <varname>
+ part number <interface> <dev> <part> <varname>
+ part type <interface> <dev>:<part> [varname]
+ part types
+
+Description
+-----------
+
+The `part` command is used to manage disk partition related commands.
+
+The 'part uuid' command prints or sets an environment variable to partition UUID
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ varname
+ an optional environment variable to store the current partition UUID value into.
+
+The 'part list' command prints or sets an environment variable to the list of partitions
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ flags
+ -bootable
+ lists only bootable partitions
+ varname
+ an optional environment variable to store the list of partitions value into.
+
+The 'part start' commnad sets an environment variable to the start of the partition (in blocks),
+part can be either partition number or partition name.
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ varname
+ a variable to store the current start of the partition value into.
+
+The 'part size' command sets an environment variable to the size of the partition (in blocks),
+part can be either partition number or partition name.
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ varname
+ a variable to store the current size of the partition value into.
+
+The 'part number' command sets an environment variable to the partition number using the partition name,
+part must be specified as partition name.
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ varname
+ a variable to store the current partition number value into
+
+The 'part type' command prints or sets an environment variable to the partition type UUID.
+
+ interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+ dev
+ device number
+ part
+ partition number
+ varname
+ a variable to store the current partition type UUID value into
+
+The 'part types' command list supported partition table types.
+
+Examples
+--------
+
+::
+
+ => host bind 0 ./test_gpt_disk_image.bin
+ => part uuid host 0:1
+ 24156b69-3378-497f-bb3e-b982223de528
+ => part uuid host 0:1 varname
+ => env print varname
+ varname=24156b69-3378-497f-bb3e-b982223de528
+ =>
+ => part list host 0
+
+ Partition Map for HOST device 0 -- Partition Type: EFI
+
+ Part Start LBA End LBA Name
+ Attributes
+ Type GUID
+ Partition GUID
+ 1 0x00000800 0x00000fff "second"
+ attrs: 0x0000000000000000
+ type: ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
+ (data)
+ guid: 24156b69-3378-497f-bb3e-b982223de528
+ 2 0x00001000 0x00001bff "first"
+ attrs: 0x0000000000000000
+ type: ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
+ (data)
+ guid: 5272ee44-29ab-4d46-af6c-4b45ac67d3b7
+ =>
+ => part start host 0 2 varname
+ => env print varname
+ varname=1000
+ =>
+ => part size host 0 2 varname
+ => env print varname
+ varname=c00
+ =>
+ => part number host 0 2 varname
+ => env print varname
+ varname=0x2
+ =>
+ => part type host 0:1
+ ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
+ => part type host 0:1 varname
+ => env print varname
+ varname=ebd0a0a2-b9e5-4433-87c0-68b6b72699c7
+ =>
+ => part types
+ Supported partition tables: EFI, AMIGA, DOS, ISO, MAC
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the command succededd. If an
+error occurs, the return value $? is set to 1 (false).
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index bbd40a6e189..cf3666a77d8 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -61,6 +61,7 @@ Shell commands
cmd/mbr
cmd/md
cmd/mmc
+ cmd/part
cmd/pause
cmd/pinmux
cmd/printenv