blob: 37431aff7c852e0cd56fe9ae559828ee53dc9381 [file] [log] [blame]
Simon Glass917ae972024-10-28 13:47:56 +01001.. SPDX-License-Identifier: GPL-2.0+
2
3.. index::
4 single: sbi (command)
5
6sbi command
7===========
8
9Synopsis
10--------
11
12::
13
14 sb handoff
Simon Glass9a27d9d2024-10-28 13:47:57 +010015 sb map
Simon Glass917ae972024-10-28 13:47:56 +010016 sb state
17
18Description
19-----------
20
21The *sb* command is used to display information about sandbox's internal
22operation. See :doc:`/arch/sandbox/index` for more information.
23
24sb handoff
25~~~~~~~~~~
26
27This shows information about any handoff information received from SPL. If
28U-Boot is started from an SPL build, it shows a valid magic number.
29
Simon Glass9a27d9d2024-10-28 13:47:57 +010030sb map
31~~~~~~
32
33This shows any mappings between sandbox's emulated RAM and the underlying host
34address-space.
35
36Fields shown are:
37
38Addr
39 Address in emulated RAM
40
41Mapping
42 Equivalent address in the host address-space. While sandbox requests address
43 ``0x10000000`` from the OS, this is not always available.
44
45Refcnt
46 Shows the number of references to this mapping.
47
Simon Glass917ae972024-10-28 13:47:56 +010048sb state
49~~~~~~~~
50
51This shows basic information about the sandbox state, currently just the
52command-line with which sandbox was started.
53
54Example
55-------
56
57This shows checking for the presence of SPL-handoff information. For this to
58work, ``u-boot-spl`` must be run, with build that enables ``CONFIG_SPL``, such
59as ``sandbox_spl``::
60
61 => sb handoff
62 SPL handoff magic 14f93c7b
63
Simon Glass9a27d9d2024-10-28 13:47:57 +010064This shows output from the *sb map* subcommand, with a single mapping::
65
66 Sandbox memory-mapping
67 Addr Mapping Refcnt
68 ff000000 000056185b46d6d0 2
69
Simon Glass917ae972024-10-28 13:47:56 +010070This shows output from the *sb state* subcommand::
71
72 => sb state
73 Arguments:
74 /tmp/b/sandbox/u-boot -D
75
76Configuration
77-------------
78
79The *sb handoff* command is only supported if CONFIG_HANDOFF is enabled.