Open Menu / doc / usage / cmd / sb.rst
Loading...
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
.. SPDX-License-Identifier: GPL-2.0+

.. index::
   single: sbi (command)

sbi command
===========

Synopsis
--------

::

    sb devoff <node>
    sb devon <node>
    sb handoff
    sb map
    sb state

Description
-----------

The *sb* command is used to display information about sandbox's internal
operation and to manage devices. See :doc:`/arch/sandbox/index` for more
information.

sb devoff
~~~~~~~~~

This disables a device that was previously enabled with *sb devon*. The device
is removed (deactivated) and unbound from the driver model. The parameter is
the name of a device tree node.

sb devon
~~~~~~~~

This enables a device from the device tree. The device tree node is located,
bound to the driver model, and probed (activated). This is useful for testing
devices that are not automatically bound at startup, i.e. those marked as
status = "disabled" in the device tree. The parameter is the name of a root
devicetree node.

sb handoff
~~~~~~~~~~

This shows information about any handoff information received from SPL. If
U-Boot is started from an SPL build, it shows a valid magic number.

sb map
~~~~~~

This shows any mappings between sandbox's emulated RAM and the underlying host
address-space.

Fields shown are:

Addr
    Address in emulated RAM

Mapping
    Equivalent address in the host address-space. While sandbox requests address
    ``0x10000000`` from the OS, this is not always available.

Refcnt
    Shows the number of references to this mapping.

sb state
~~~~~~~~

This shows basic information about the sandbox state, currently just the
command-line with which sandbox was started.

Example
-------

This shows enabling a device from the `test.dts` device tree. Note that sandbox
must be run with the -T flag to use the test device tree::

    => sb devon mmc11
    Device 'mmc11' enabled
    => ls mmc b
                extlinux/
            7   initrd.img-6.8.0-53-generic
         1616   vmlinuz-6.8.0-53-generic

    2 file(s), 1 dir(s)

    => sb devoff mmc11
    Device 'mmc11' disabled
    => ls mmc b
    ** Bad device specification mmc b **
    Couldn't find partition mmc b
    =>

This shows checking for the presence of SPL-handoff information. For this to
work, ``u-boot-spl`` must be run, with build that enables ``CONFIG_SPL``, such
as ``sandbox_spl``::

    => sb handoff
    SPL handoff magic 14f93c7b

This shows output from the *sb map* subcommand, with a single mapping::

    Sandbox memory-mapping
        Addr           Mapping  Refcnt
    ff000000  000056185b46d6d0       2

This shows output from the *sb state* subcommand::

    => sb state
    Arguments:
    /tmp/b/sandbox/u-boot -D

Configuration
-------------

The *sb handoff* command is only supported if CONFIG_HANDOFF is enabled.