1 .. SPDX-License-Identifier: GPL-2.0+ */
2 .. Copyright (c) 2014 The Chromium OS Authors.
3 .. sectionauthor:: Simon Glass <sjg@chromium.org>
8 Native Execution of U-Boot
9 --------------------------
11 The 'sandbox' architecture is designed to allow U-Boot to run under Linux on
12 almost any hardware. To achieve this it builds U-Boot (so far as possible)
13 as a normal C application with a main() and normal C libraries.
15 All of U-Boot's architecture-specific code therefore cannot be built as part
16 of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test
17 all the generic code, not specific to any one architecture. The idea is to
18 create unit tests which we can run to test this upper level code.
20 CONFIG_SANDBOX is defined when building a native board.
22 The board name is 'sandbox' but the vendor name is unset, so there is a
23 single board in board/sandbox.
25 CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
28 There are two versions of the sandbox: One using 32-bit-wide integers, and one
29 using 64-bit-wide integers. The 32-bit version can be build and run on either
30 32 or 64-bit hosts by either selecting or deselecting CONFIG_SANDBOX_32BIT; by
31 default, the sandbox it built for a 32-bit host. The sandbox using 64-bit-wide
32 integers can only be built on 64-bit hosts.
34 Note that standalone/API support is not available at present.
40 Here are some packages that are worth installing if you are doing sandbox or
41 tools development in U-Boot:
43 python3-pytest lzma lzma-alone lz4 python3 python3-virtualenv
50 To run sandbox U-Boot use something like::
52 make sandbox_defconfig all
55 Note: If you get errors about 'sdl-config: Command not found' you may need to
56 install libsdl2.0-dev or similar to get SDL support. Alternatively you can
57 build sandbox without SDL (i.e. no display/keyboard support) by removing
58 the CONFIG_SANDBOX_SDL line in include/configs/sandbox.h or using::
60 make sandbox_defconfig all NO_SDL=1
63 U-Boot will start on your computer, showing a sandbox emulation of the serial
66 U-Boot 2014.04 (Mar 20 2014 - 19:06:00)
69 Using default environment
76 You can issue commands as your would normally. If the command you want is
77 not supported you can add it to include/configs/sandbox.h.
79 To exit, type 'reset' or press Ctrl-C.
85 Assuming that CONFIG_SANDBOX_SDL is defined when building, you can run the
86 sandbox with LCD and keyboard emulation, using something like::
88 ./u-boot -d u-boot.dtb -l
90 This will start U-Boot with a window showing the contents of the LCD. If
91 that window has the focus then you will be able to type commands as you
92 would on the console. You can adjust the display settings in the device
93 tree file - see arch/sandbox/dts/sandbox.dts.
99 Various options are available, mostly for test purposes. Use -h to see
100 available options. Some of these are described below.
102 The terminal is normally in what is called 'raw-with-sigs' mode. This means
103 that you can use arrow keys for command editing and history, but if you
104 press Ctrl-C, U-Boot will exit instead of handling this as a keypress.
106 Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked'
107 (where the terminal is in cooked mode and cursor keys will not work, Ctrl-C
110 As mentioned above, -l causes the LCD emulation window to be shown.
112 A device tree binary file can be provided with -d. If you edit the source
113 (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
114 recreate the binary file.
116 To use the default device tree, use -D. To use the test device tree, use -T.
118 To execute commands directly, use the -c option. You can specify a single
119 command, or multiple commands separated by a semicolon, as is normal in
120 U-Boot. Be careful with quoting as the shell will normally process and
121 swallow quotes. When -c is used, U-Boot exits after the command is complete,
122 but you can force it to go to interactive mode instead with -i.
128 Memory emulation is supported, with the size set by CONFIG_SYS_SDRAM_SIZE.
129 The -m option can be used to read memory from a file on start-up and write
130 it when shutting down. This allows preserving of memory contents across
131 test runs. You can tell U-Boot to remove the memory file after it is read
132 (on start-up) with the --rm_memory option.
134 To access U-Boot's emulated memory within the code, use map_sysmem(). This
135 function is used throughout U-Boot to ensure that emulated memory is used
136 rather than the U-Boot application memory. This provides memory starting
137 at 0 and extending to the size of the emulation.
143 With sandbox you can write drivers which emulate the operation of drivers on
144 real devices. Some of these drivers may want to record state which is
145 preserved across U-Boot runs. This is particularly useful for testing. For
146 example, the contents of a SPI flash chip should not disappear just because
149 State is stored in a device tree file in a simple format which is driver-
150 specific. You then use the -s option to specify the state file. Use -r to
151 make U-Boot read the state on start-up (otherwise it starts empty) and -w
152 to write it on exit (otherwise the stored state is left unchanged and any
153 changes U-Boot made will be lost). You can also use -n to tell U-Boot to
154 ignore any problems with missing state. This is useful when first running
155 since the state file will be empty.
157 The device tree file has one node for each driver - the driver can store
158 whatever properties it likes in there. See 'Writing Sandbox Drivers' below
159 for more details on how to get drivers to read and write their state.
165 Since there is no machine architecture, sandbox U-Boot cannot actually boot
166 a kernel, but it does support the bootm command. Filesystems, memory
167 commands, hashing, FIT images, verified boot and many other features are
170 When 'bootm' runs a kernel, sandbox will exit, as U-Boot does on a real
171 machine. Of course in this case, no kernel is run.
173 It is also possible to tell U-Boot that it has jumped from a temporary
174 previous U-Boot binary, with the -j option. That binary is automatically
175 removed by the U-Boot that gets the -j option. This allows you to write
176 tests which emulate the action of chain-loading U-Boot, typically used in
177 a situation where a second 'updatable' U-Boot is stored on your board. It
178 is very risky to overwrite or upgrade the only U-Boot on a board, since a
179 power or other failure will brick the board and require return to the
180 manufacturer in the case of a consumer device.
186 U-Boot sandbox supports these emulations:
191 - Host filesystem (access files on the host from within U-Boot)
193 - Keyboard (Chrome OS)
196 - Serial (for console only)
197 - Sound (incomplete - see sandbox_sdl_sound_init() for details)
200 - TPM (Trusted Platform Module)
202 A wide range of commands are implemented. Filesystems which use a block
203 device are supported.
205 Also sandbox supports driver model (CONFIG_DM) and associated commands.
211 There are unfortunately quite a few variants at present:
214 should be used for most tests
216 special build that forces a 64-bit host
218 builds with dev_read\_...() functions defined as inline.
219 We need this build so that we can test those inline functions, and we
220 cannot build with both the inline functions and the non-inline functions
221 since they are named the same.
223 builds sandbox with SPL support, so you can run spl/u-boot-spl
224 and it will start up and then load ./u-boot. It is also possible to
225 run ./u-boot directly.
227 Of these sandbox_spl can probably be removed since it is a superset of sandbox.
229 Most of the config options should be identical between these variants.
232 Linux RAW Networking Bridge
233 ---------------------------
235 The sandbox_eth_raw driver bridges traffic between the bottom of the network
236 stack and the RAW sockets API in Linux. This allows much of the U-Boot network
237 functionality to be tested in sandbox against real network traffic.
239 For Ethernet network adapters, the bridge utilizes the RAW AF_PACKET API. This
240 is needed to get access to the lowest level of the network stack in Linux. This
241 means that all of the Ethernet frame is included. This allows the U-Boot network
242 stack to be fully used. In other words, nothing about the Linux network stack is
243 involved in forming the packets that end up on the wire. To receive the
244 responses to packets sent from U-Boot the network interface has to be set to
245 promiscuous mode so that the network card won't filter out packets not destined
246 for its configured (on Linux) MAC address.
248 The RAW sockets Ethernet API requires elevated privileges in Linux. You can
249 either run as root, or you can add the capability needed like so::
251 sudo /sbin/setcap "CAP_NET_RAW+ep" /path/to/u-boot
253 The default device tree for sandbox includes an entry for eth0 on the sandbox
254 host machine whose alias is "eth1". The following are a few examples of network
255 operations being tested on the eth0 interface.
259 sudo /path/to/u-boot -D
285 setenv serverip WWW.XXX.YYY.ZZZ
288 The bridge also supports (to a lesser extent) the localhost interface, 'lo'.
290 The 'lo' interface cannot use the RAW AF_PACKET API because the lo interface
291 doesn't support Ethernet-level traffic. It is a higher-level interface that is
292 expected only to be used at the AF_INET level of the API. As such, the most raw
293 we can get on that interface is the RAW AF_INET API on UDP. This allows us to
294 set the IP_HDRINCL option to include everything except the Ethernet header in
295 the packets we send and receive.
297 Because only UDP is supported, ICMP traffic will not work, so expect that ping
298 commands will time out.
300 The default device tree for sandbox includes an entry for lo on the sandbox
301 host machine whose alias is "eth5". The following is an example of a network
302 operation being tested on the lo interface.
317 Sandbox supports SPI and SPI flash emulation.
319 The device can be enabled via a device tree, for example::
322 #address-cells = <1>;
325 compatible = "sandbox,spi";
326 cs-gpios = <0>, <&gpio_a 0>;
329 compatible = "spansion,m25p16", "jedec,spi-nor";
330 spi-max-frequency = <40000000>;
331 sandbox,filename = "spi.bin";
335 The file must be created in advance::
337 $ dd if=/dev/zero of=spi.bin bs=1M count=2
340 Here, you can use "-T" or "-D" option to specify test.dtb or u-boot.dtb,
341 respectively, or "-d <file>" for your own dtb.
343 With this setup you can issue SPI flash commands as normal::
346 SF: Detected M25P16 with page size 64 KiB, total 2 MiB
348 SF: 65536 bytes @ 0x0 Read: OK
350 Since this is a full SPI emulation (rather than just flash), you can
351 also use low-level SPI commands::
356 This is issuing a READ_ID command and getting back 20 (ST Micro) part
360 Block Device Emulation
361 ----------------------
363 U-Boot can use raw disk images for block device emulation. To e.g. list
364 the contents of the root directory on the second partion of the image
365 "disk.raw", you can use the following commands::
367 =>host bind 0 ./disk.raw
370 A disk image can be created using the following commands::
372 $> truncate -s 1200M ./disk.raw
373 $> echo -e "label: gpt\n,64M,U\n,,L" | /usr/sbin/sgdisk ./disk.raw
374 $> lodev=`sudo losetup -P -f --show ./disk.raw`
375 $> sudo mkfs.vfat -n EFI -v ${lodev}p1
376 $> sudo mkfs.ext4 -L ROOT -v ${lodev}p2
378 or utilize the device described in test/py/make_test_disk.py::
381 import make_test_disk
382 make_test_disk.makeDisk()
384 Writing Sandbox Drivers
385 -----------------------
387 Generally you should put your driver in a file containing the word 'sandbox'
388 and put it in the same directory as other drivers of its type. You can then
389 implement the same hooks as the other drivers.
391 To access U-Boot's emulated memory, use map_sysmem() as mentioned above.
393 If your driver needs to store configuration or state (such as SPI flash
394 contents or emulated chip registers), you can use the device tree as
395 described above. Define handlers for this with the SANDBOX_STATE_IO macro.
396 See arch/sandbox/include/asm/state.h for documentation. In short you provide
397 a node name, compatible string and functions to read and write the state.
398 Since writing the state can expand the device tree, you may need to use
399 state_setprop() which does this automatically and avoids running out of
400 space. See existing code for examples.
403 Debugging the init sequence
404 ---------------------------
406 If you get a failure in the initcall sequence, like this::
408 initcall sequence 0000560775957c80 failed at call 0000000000048134 (err=-96)
410 Then you use can use grep to see which init call failed, e.g.::
412 $ grep 0000000000048134 u-boot.map
415 Of course another option is to run it with a debugger such as gdb::
419 (gdb) br initcall.h:41
420 Breakpoint 1 at 0x4db9d: initcall.h:41. (2 locations)
422 Note that two locations are reported, since this function is used in both
423 board_init_f() and board_init_r().
428 Starting program: /tmp/b/sandbox/u-boot
429 [Thread debugging using libthread_db enabled]
430 Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
432 U-Boot 2018.09-00264-ge0c2ba9814-dirty (Sep 22 2018 - 12:21:46 -0600)
437 Breakpoint 1, initcall_run_list (init_sequence=0x5555559619e0 <init_sequence_f>)
438 at /scratch/sglass/cosarm/src/third_party/u-boot/files/include/initcall.h:41
439 41 printf("initcall sequence %p failed at call %p (err=%d)\n",
440 (gdb) print *init_fnc_ptr
441 $1 = (const init_fnc_t) 0x55555559c114 <stdio_add_devices>
445 This approach can be used on normal boards as well as sandbox.
451 If sdl-config is on a different path from the default, set the SDL_CONFIG
452 environment variable to the correct pathname before building U-Boot.
455 Using valgrind / memcheck
456 -------------------------
458 It is possible to run U-Boot under valgrind to check memory allocations::
462 If you are running sandbox SPL or TPL, then valgrind will not by default
463 notice when U-Boot jumps from TPL to SPL, or from SPL to U-Boot proper. To
466 valgrind --trace-children=yes u-boot
472 U-Boot sandbox can be used to run various tests, mostly in the test/
473 directory. These include:
476 Unit tests for command parsing and handling
478 Unit tests for U-Boot's compression algorithms, useful for
479 security checking. It supports gzip, bzip2, lzma and lzo.
483 ./test/py/test.py --bd sandbox --build -k ut_dm -v
486 Unit tests for images:
487 test/image/test-imagetools.sh - multi-file images
488 test/image/test-fit.py - FIT images
490 test/trace/test-trace.sh tests the tracing system (see README.trace)
492 See test/vboot/vboot_test.sh for this
494 If you change or enhance any of the above subsystems, you shold write or
495 expand a test and include it with your patch series submission. Test
496 coverage in U-Boot is limited, as we need to work to improve it.
498 Note that many of these tests are implemented as commands which you can
499 run natively on your board if desired (and enabled).
501 To run all tests use "make check".
503 To run a single test in an existing sandbox build, you can use -T to use the
504 test device tree, and -c to select the test:
506 /tmp/b/sandbox/u-boot -T -c "ut dm pci_busdev"
508 This runs dm_test_pci_busdev() which is in test/dm/pci.c
514 Sandbox has its own emulated memory starting at 0. Here are some of the things
515 that are mapped into that memory:
517 ======= ======================== ===============================
519 ======= ======================== ===============================
520 0 CONFIG_SYS_FDT_LOAD_ADDR Device tree
521 e000 CONFIG_BLOBLIST_ADDR Blob list
522 10000 CONFIG_MALLOC_F_ADDR Early memory allocation
523 f0000 CONFIG_PRE_CON_BUF_ADDR Pre-console buffer
524 100000 CONFIG_TRACE_EARLY_ADDR Early trace buffer (if enabled)
525 ======= ======================== ===============================