blob: 4674c420ac855b34ded356199f6ff080671428e2 [file] [log] [blame]
Bin Meng49116e62019-07-18 00:34:33 -07001.. SPDX-License-Identifier: GPL-2.0+ */
2.. Copyright (c) 2014 The Chromium OS Authors.
3.. sectionauthor:: Simon Glass <sjg@chromium.org>
4
5Sandbox
6=======
Simon Glass744d9852011-10-10 08:22:14 +00007
8Native Execution of U-Boot
Bin Meng49116e62019-07-18 00:34:33 -07009--------------------------
Simon Glass744d9852011-10-10 08:22:14 +000010
11The 'sandbox' architecture is designed to allow U-Boot to run under Linux on
12almost any hardware. To achieve this it builds U-Boot (so far as possible)
13as a normal C application with a main() and normal C libraries.
14
15All of U-Boot's architecture-specific code therefore cannot be built as part
16of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test
17all the generic code, not specific to any one architecture. The idea is to
18create unit tests which we can run to test this upper level code.
19
20CONFIG_SANDBOX is defined when building a native board.
21
Simon Glass9b250ac2014-09-23 13:05:59 -060022The board name is 'sandbox' but the vendor name is unset, so there is a
23single board in board/sandbox.
Simon Glass744d9852011-10-10 08:22:14 +000024
25CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
26machines.
27
Mario Sixc6b89f32018-02-12 08:05:57 +010028There are two versions of the sandbox: One using 32-bit-wide integers, and one
29using 64-bit-wide integers. The 32-bit version can be build and run on either
3032 or 64-bit hosts by either selecting or deselecting CONFIG_SANDBOX_32BIT; by
31default, the sandbox it built for a 32-bit host. The sandbox using 64-bit-wide
32integers can only be built on 64-bit hosts.
Bin Meng226b50b2017-08-01 16:33:34 -070033
Simon Glass744d9852011-10-10 08:22:14 +000034Note that standalone/API support is not available at present.
35
Simon Glass75b3c3a2014-03-22 17:12:59 -060036
Simon Glassa1f49ab2020-03-18 09:42:39 -060037Prerequisites
38-------------
39
40Here are some packages that are worth installing if you are doing sandbox or
41tools development in U-Boot:
42
43 python3-pytest lzma lzma-alone lz4 python3 python3-virtualenv
44 libssl1.0-dev
45
46
Simon Glass75b3c3a2014-03-22 17:12:59 -060047Basic Operation
48---------------
49
Bin Meng49116e62019-07-18 00:34:33 -070050To run sandbox U-Boot use something like::
Simon Glass75b3c3a2014-03-22 17:12:59 -060051
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +053052 make sandbox_defconfig all
Simon Glass75b3c3a2014-03-22 17:12:59 -060053 ./u-boot
54
Bin Meng49116e62019-07-18 00:34:33 -070055Note: If you get errors about 'sdl-config: Command not found' you may need to
Simon Glass96d0cd42020-02-03 07:36:12 -070056install libsdl2.0-dev or similar to get SDL support. Alternatively you can
Bin Meng49116e62019-07-18 00:34:33 -070057build sandbox without SDL (i.e. no display/keyboard support) by removing
58the CONFIG_SANDBOX_SDL line in include/configs/sandbox.h or using::
Simon Glass75b3c3a2014-03-22 17:12:59 -060059
Bin Meng49116e62019-07-18 00:34:33 -070060 make sandbox_defconfig all NO_SDL=1
61 ./u-boot
Simon Glass75b3c3a2014-03-22 17:12:59 -060062
Simon Glass75b3c3a2014-03-22 17:12:59 -060063U-Boot will start on your computer, showing a sandbox emulation of the serial
Bin Meng49116e62019-07-18 00:34:33 -070064console::
Simon Glass75b3c3a2014-03-22 17:12:59 -060065
Bin Meng49116e62019-07-18 00:34:33 -070066 U-Boot 2014.04 (Mar 20 2014 - 19:06:00)
Simon Glass75b3c3a2014-03-22 17:12:59 -060067
Bin Meng49116e62019-07-18 00:34:33 -070068 DRAM: 128 MiB
69 Using default environment
Simon Glass75b3c3a2014-03-22 17:12:59 -060070
Bin Meng49116e62019-07-18 00:34:33 -070071 In: serial
72 Out: lcd
73 Err: lcd
74 =>
Simon Glass75b3c3a2014-03-22 17:12:59 -060075
76You can issue commands as your would normally. If the command you want is
77not supported you can add it to include/configs/sandbox.h.
78
79To exit, type 'reset' or press Ctrl-C.
80
81
82Console / LCD support
83---------------------
84
85Assuming that CONFIG_SANDBOX_SDL is defined when building, you can run the
Bin Meng49116e62019-07-18 00:34:33 -070086sandbox with LCD and keyboard emulation, using something like::
Simon Glass75b3c3a2014-03-22 17:12:59 -060087
88 ./u-boot -d u-boot.dtb -l
89
90This will start U-Boot with a window showing the contents of the LCD. If
91that window has the focus then you will be able to type commands as you
92would on the console. You can adjust the display settings in the device
93tree file - see arch/sandbox/dts/sandbox.dts.
94
95
96Command-line Options
97--------------------
98
99Various options are available, mostly for test purposes. Use -h to see
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200100available options. Some of these are described below:
Simon Glass75b3c3a2014-03-22 17:12:59 -0600101
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200102* -t, --terminal <arg>
103 - The terminal is normally in what is called 'raw-with-sigs' mode. This means
104 that you can use arrow keys for command editing and history, but if you
105 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
108 will exit).
Simon Glass75b3c3a2014-03-22 17:12:59 -0600109
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200110* -l
111 - Show the LCD emulation window.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600112
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200113* -d <device_tree>
114 - A device tree binary file can be provided with -d. If you edit the source
115 (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
116 recreate the binary file.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600117
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200118* -D
119 - To use the default device tree, use -D.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600120
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200121* -T
122 - To use the test device tree, use -T.
Simon Glass189882c2019-09-25 08:56:07 -0600123
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200124* -c [<cmd>;]<cmd>
125 - To execute commands directly, use the -c option. You can specify a single
126 command, or multiple commands separated by a semicolon, as is normal in
127 U-Boot. Be careful with quoting as the shell will normally process and
128 swallow quotes. When -c is used, U-Boot exits after the command is complete,
129 but you can force it to go to interactive mode instead with -i.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600130
Heinrich Schuchardt9c22adb2020-09-19 20:05:47 +0200131* -i
132 - Go to interactive mode after executing the commands specified by -c.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600133
134Memory Emulation
135----------------
136
137Memory emulation is supported, with the size set by CONFIG_SYS_SDRAM_SIZE.
138The -m option can be used to read memory from a file on start-up and write
139it when shutting down. This allows preserving of memory contents across
140test runs. You can tell U-Boot to remove the memory file after it is read
141(on start-up) with the --rm_memory option.
142
143To access U-Boot's emulated memory within the code, use map_sysmem(). This
144function is used throughout U-Boot to ensure that emulated memory is used
145rather than the U-Boot application memory. This provides memory starting
146at 0 and extending to the size of the emulation.
147
148
149Storing State
150-------------
151
152With sandbox you can write drivers which emulate the operation of drivers on
153real devices. Some of these drivers may want to record state which is
154preserved across U-Boot runs. This is particularly useful for testing. For
155example, the contents of a SPI flash chip should not disappear just because
156U-Boot exits.
157
158State is stored in a device tree file in a simple format which is driver-
159specific. You then use the -s option to specify the state file. Use -r to
160make U-Boot read the state on start-up (otherwise it starts empty) and -w
161to write it on exit (otherwise the stored state is left unchanged and any
162changes U-Boot made will be lost). You can also use -n to tell U-Boot to
163ignore any problems with missing state. This is useful when first running
164since the state file will be empty.
165
166The device tree file has one node for each driver - the driver can store
167whatever properties it likes in there. See 'Writing Sandbox Drivers' below
168for more details on how to get drivers to read and write their state.
169
170
171Running and Booting
172-------------------
173
174Since there is no machine architecture, sandbox U-Boot cannot actually boot
175a kernel, but it does support the bootm command. Filesystems, memory
176commands, hashing, FIT images, verified boot and many other features are
177supported.
178
179When 'bootm' runs a kernel, sandbox will exit, as U-Boot does on a real
180machine. Of course in this case, no kernel is run.
181
182It is also possible to tell U-Boot that it has jumped from a temporary
183previous U-Boot binary, with the -j option. That binary is automatically
184removed by the U-Boot that gets the -j option. This allows you to write
185tests which emulate the action of chain-loading U-Boot, typically used in
186a situation where a second 'updatable' U-Boot is stored on your board. It
187is very risky to overwrite or upgrade the only U-Boot on a board, since a
188power or other failure will brick the board and require return to the
189manufacturer in the case of a consumer device.
190
191
192Supported Drivers
193-----------------
194
195U-Boot sandbox supports these emulations:
196
197- Block devices
198- Chrome OS EC
199- GPIO
200- Host filesystem (access files on the host from within U-Boot)
Joe Hershberger3ea143a2015-03-22 17:09:13 -0500201- I2C
Simon Glass75b3c3a2014-03-22 17:12:59 -0600202- Keyboard (Chrome OS)
203- LCD
Joe Hershberger3ea143a2015-03-22 17:09:13 -0500204- Network
Simon Glass75b3c3a2014-03-22 17:12:59 -0600205- Serial (for console only)
206- Sound (incomplete - see sandbox_sdl_sound_init() for details)
207- SPI
208- SPI flash
209- TPM (Trusted Platform Module)
210
Trevor Woerner1f154a62018-04-30 19:13:05 -0400211A wide range of commands are implemented. Filesystems which use a block
Simon Glass75b3c3a2014-03-22 17:12:59 -0600212device are supported.
213
Simon Glass89b199c2016-05-14 18:49:27 -0600214Also sandbox supports driver model (CONFIG_DM) and associated commands.
Simon Glass744d9852011-10-10 08:22:14 +0000215
216
Simon Glass969c8f42018-09-18 18:43:28 -0600217Sandbox Variants
218----------------
219
220There are unfortunately quite a few variants at present:
221
Bin Meng49116e62019-07-18 00:34:33 -0700222sandbox:
223 should be used for most tests
224sandbox64:
225 special build that forces a 64-bit host
226sandbox_flattree:
227 builds with dev_read\_...() functions defined as inline.
228 We need this build so that we can test those inline functions, and we
229 cannot build with both the inline functions and the non-inline functions
230 since they are named the same.
Bin Meng49116e62019-07-18 00:34:33 -0700231sandbox_spl:
232 builds sandbox with SPL support, so you can run spl/u-boot-spl
233 and it will start up and then load ./u-boot. It is also possible to
234 run ./u-boot directly.
Simon Glass969c8f42018-09-18 18:43:28 -0600235
Tom Riniee8da592019-10-11 16:28:47 -0400236Of these sandbox_spl can probably be removed since it is a superset of sandbox.
Simon Glass969c8f42018-09-18 18:43:28 -0600237
238Most of the config options should be identical between these variants.
239
240
Joe Hershbergera346ca72015-03-22 17:09:21 -0500241Linux RAW Networking Bridge
242---------------------------
243
244The sandbox_eth_raw driver bridges traffic between the bottom of the network
245stack and the RAW sockets API in Linux. This allows much of the U-Boot network
246functionality to be tested in sandbox against real network traffic.
247
248For Ethernet network adapters, the bridge utilizes the RAW AF_PACKET API. This
249is needed to get access to the lowest level of the network stack in Linux. This
250means that all of the Ethernet frame is included. This allows the U-Boot network
251stack to be fully used. In other words, nothing about the Linux network stack is
252involved in forming the packets that end up on the wire. To receive the
253responses to packets sent from U-Boot the network interface has to be set to
254promiscuous mode so that the network card won't filter out packets not destined
255for its configured (on Linux) MAC address.
256
257The RAW sockets Ethernet API requires elevated privileges in Linux. You can
Bin Meng49116e62019-07-18 00:34:33 -0700258either run as root, or you can add the capability needed like so::
Joe Hershbergera346ca72015-03-22 17:09:21 -0500259
Bin Meng49116e62019-07-18 00:34:33 -0700260 sudo /sbin/setcap "CAP_NET_RAW+ep" /path/to/u-boot
Joe Hershbergera346ca72015-03-22 17:09:21 -0500261
262The default device tree for sandbox includes an entry for eth0 on the sandbox
263host machine whose alias is "eth1". The following are a few examples of network
264operations being tested on the eth0 interface.
265
Bin Meng49116e62019-07-18 00:34:33 -0700266.. code-block:: none
Joe Hershbergera346ca72015-03-22 17:09:21 -0500267
Bin Meng49116e62019-07-18 00:34:33 -0700268 sudo /path/to/u-boot -D
Joe Hershbergera346ca72015-03-22 17:09:21 -0500269
Bin Meng49116e62019-07-18 00:34:33 -0700270 DHCP
271 ....
Joe Hershbergera346ca72015-03-22 17:09:21 -0500272
Bin Meng49116e62019-07-18 00:34:33 -0700273 setenv autoload no
274 setenv ethrotate no
275 setenv ethact eth1
276 dhcp
Joe Hershbergera346ca72015-03-22 17:09:21 -0500277
Bin Meng49116e62019-07-18 00:34:33 -0700278 PING
279 ....
Joe Hershbergera346ca72015-03-22 17:09:21 -0500280
Bin Meng49116e62019-07-18 00:34:33 -0700281 setenv autoload no
282 setenv ethrotate no
283 setenv ethact eth1
284 dhcp
285 ping $gatewayip
Joe Hershbergera346ca72015-03-22 17:09:21 -0500286
Bin Meng49116e62019-07-18 00:34:33 -0700287 TFTP
288 ....
289
290 setenv autoload no
291 setenv ethrotate no
292 setenv ethact eth1
293 dhcp
294 setenv serverip WWW.XXX.YYY.ZZZ
295 tftpboot u-boot.bin
Joe Hershbergera346ca72015-03-22 17:09:21 -0500296
Trevor Woerner1f154a62018-04-30 19:13:05 -0400297The bridge also supports (to a lesser extent) the localhost interface, 'lo'.
Joe Hershberger22f68522015-03-22 17:09:23 -0500298
299The 'lo' interface cannot use the RAW AF_PACKET API because the lo interface
300doesn't support Ethernet-level traffic. It is a higher-level interface that is
301expected only to be used at the AF_INET level of the API. As such, the most raw
302we can get on that interface is the RAW AF_INET API on UDP. This allows us to
303set the IP_HDRINCL option to include everything except the Ethernet header in
304the packets we send and receive.
305
306Because only UDP is supported, ICMP traffic will not work, so expect that ping
307commands will time out.
308
309The default device tree for sandbox includes an entry for lo on the sandbox
310host machine whose alias is "eth5". The following is an example of a network
311operation being tested on the lo interface.
312
Bin Meng49116e62019-07-18 00:34:33 -0700313.. code-block:: none
Joe Hershberger22f68522015-03-22 17:09:23 -0500314
Bin Meng49116e62019-07-18 00:34:33 -0700315 TFTP
316 ....
317
318 setenv ethrotate no
319 setenv ethact eth5
320 tftpboot u-boot.bin
Joe Hershberger22f68522015-03-22 17:09:23 -0500321
Joe Hershbergera346ca72015-03-22 17:09:21 -0500322
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700323SPI Emulation
324-------------
325
326Sandbox supports SPI and SPI flash emulation.
327
AKASHI Takahiro5e61c4e2020-04-27 15:46:45 +0900328The device can be enabled via a device tree, for example::
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700329
AKASHI Takahiro5e61c4e2020-04-27 15:46:45 +0900330 spi@0 {
331 #address-cells = <1>;
332 #size-cells = <0>;
333 reg = <0 1>;
334 compatible = "sandbox,spi";
335 cs-gpios = <0>, <&gpio_a 0>;
336 spi.bin@0 {
337 reg = <0>;
338 compatible = "spansion,m25p16", "jedec,spi-nor";
339 spi-max-frequency = <40000000>;
340 sandbox,filename = "spi.bin";
341 };
342 };
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700343
AKASHI Takahiro5e61c4e2020-04-27 15:46:45 +0900344The file must be created in advance::
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700345
AKASHI Takahiro5e61c4e2020-04-27 15:46:45 +0900346 $ dd if=/dev/zero of=spi.bin bs=1M count=2
347 $ u-boot -T
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700348
AKASHI Takahiro5e61c4e2020-04-27 15:46:45 +0900349Here, you can use "-T" or "-D" option to specify test.dtb or u-boot.dtb,
350respectively, or "-d <file>" for your own dtb.
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700351
Bin Meng49116e62019-07-18 00:34:33 -0700352With this setup you can issue SPI flash commands as normal::
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700353
Bin Meng49116e62019-07-18 00:34:33 -0700354 =>sf probe
355 SF: Detected M25P16 with page size 64 KiB, total 2 MiB
356 =>sf read 0 0 10000
357 SF: 65536 bytes @ 0x0 Read: OK
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700358
359Since this is a full SPI emulation (rather than just flash), you can
Bin Meng49116e62019-07-18 00:34:33 -0700360also use low-level SPI commands::
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700361
Bin Meng49116e62019-07-18 00:34:33 -0700362 =>sspi 0:0 32 9f
363 FF202015
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700364
365This is issuing a READ_ID command and getting back 20 (ST Micro) part
3660x2015 (the M25P16).
367
Mike Frysingerffdb20b2013-12-03 16:43:27 -0700368
Stefan Brüns2945eb72016-08-11 22:52:03 +0200369Block Device Emulation
370----------------------
371
372U-Boot can use raw disk images for block device emulation. To e.g. list
373the contents of the root directory on the second partion of the image
Bin Meng49116e62019-07-18 00:34:33 -0700374"disk.raw", you can use the following commands::
Stefan Brüns2945eb72016-08-11 22:52:03 +0200375
Bin Meng49116e62019-07-18 00:34:33 -0700376 =>host bind 0 ./disk.raw
377 =>ls host 0:2
Stefan Brüns2945eb72016-08-11 22:52:03 +0200378
Bin Meng49116e62019-07-18 00:34:33 -0700379A disk image can be created using the following commands::
Stefan Brüns2945eb72016-08-11 22:52:03 +0200380
Bin Meng49116e62019-07-18 00:34:33 -0700381 $> truncate -s 1200M ./disk.raw
382 $> echo -e "label: gpt\n,64M,U\n,,L" | /usr/sbin/sgdisk ./disk.raw
383 $> lodev=`sudo losetup -P -f --show ./disk.raw`
384 $> sudo mkfs.vfat -n EFI -v ${lodev}p1
385 $> sudo mkfs.ext4 -L ROOT -v ${lodev}p2
Stefan Brüns2945eb72016-08-11 22:52:03 +0200386
Bin Meng49116e62019-07-18 00:34:33 -0700387or utilize the device described in test/py/make_test_disk.py::
Alison Chaikenbf6d76b2017-09-09 23:47:12 -0700388
389 #!/usr/bin/python
390 import make_test_disk
391 make_test_disk.makeDisk()
Stefan Brüns2945eb72016-08-11 22:52:03 +0200392
Simon Glass75b3c3a2014-03-22 17:12:59 -0600393Writing Sandbox Drivers
394-----------------------
Simon Glass744d9852011-10-10 08:22:14 +0000395
Simon Glass75b3c3a2014-03-22 17:12:59 -0600396Generally you should put your driver in a file containing the word 'sandbox'
397and put it in the same directory as other drivers of its type. You can then
398implement the same hooks as the other drivers.
399
400To access U-Boot's emulated memory, use map_sysmem() as mentioned above.
401
402If your driver needs to store configuration or state (such as SPI flash
403contents or emulated chip registers), you can use the device tree as
404described above. Define handlers for this with the SANDBOX_STATE_IO macro.
405See arch/sandbox/include/asm/state.h for documentation. In short you provide
406a node name, compatible string and functions to read and write the state.
407Since writing the state can expand the device tree, you may need to use
408state_setprop() which does this automatically and avoids running out of
409space. See existing code for examples.
410
411
Simon Glass001d1882019-04-08 13:20:41 -0600412Debugging the init sequence
413---------------------------
414
Bin Meng49116e62019-07-18 00:34:33 -0700415If you get a failure in the initcall sequence, like this::
Simon Glass001d1882019-04-08 13:20:41 -0600416
417 initcall sequence 0000560775957c80 failed at call 0000000000048134 (err=-96)
418
Bin Meng49116e62019-07-18 00:34:33 -0700419Then you use can use grep to see which init call failed, e.g.::
Simon Glass001d1882019-04-08 13:20:41 -0600420
421 $ grep 0000000000048134 u-boot.map
422 stdio_add_devices
423
Bin Meng49116e62019-07-18 00:34:33 -0700424Of course another option is to run it with a debugger such as gdb::
Simon Glass001d1882019-04-08 13:20:41 -0600425
426 $ gdb u-boot
427 ...
428 (gdb) br initcall.h:41
429 Breakpoint 1 at 0x4db9d: initcall.h:41. (2 locations)
430
431Note that two locations are reported, since this function is used in both
432board_init_f() and board_init_r().
433
Bin Meng49116e62019-07-18 00:34:33 -0700434.. code-block:: none
435
Simon Glass001d1882019-04-08 13:20:41 -0600436 (gdb) r
437 Starting program: /tmp/b/sandbox/u-boot
438 [Thread debugging using libthread_db enabled]
439 Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
440
441 U-Boot 2018.09-00264-ge0c2ba9814-dirty (Sep 22 2018 - 12:21:46 -0600)
442
443 DRAM: 128 MiB
444 MMC:
445
446 Breakpoint 1, initcall_run_list (init_sequence=0x5555559619e0 <init_sequence_f>)
447 at /scratch/sglass/cosarm/src/third_party/u-boot/files/include/initcall.h:41
448 41 printf("initcall sequence %p failed at call %p (err=%d)\n",
449 (gdb) print *init_fnc_ptr
450 $1 = (const init_fnc_t) 0x55555559c114 <stdio_add_devices>
451 (gdb)
452
453
454This approach can be used on normal boards as well as sandbox.
455
456
Simon Glasse8a7b302019-05-18 11:59:47 -0600457SDL_CONFIG
458----------
459
460If sdl-config is on a different path from the default, set the SDL_CONFIG
461environment variable to the correct pathname before building U-Boot.
462
463
Simon Glass80b7cb82019-05-18 11:59:50 -0600464Using valgrind / memcheck
465-------------------------
466
Bin Meng49116e62019-07-18 00:34:33 -0700467It is possible to run U-Boot under valgrind to check memory allocations::
Simon Glass80b7cb82019-05-18 11:59:50 -0600468
469 valgrind u-boot
470
471If you are running sandbox SPL or TPL, then valgrind will not by default
472notice when U-Boot jumps from TPL to SPL, or from SPL to U-Boot proper. To
Bin Meng49116e62019-07-18 00:34:33 -0700473fix this, use::
Simon Glass80b7cb82019-05-18 11:59:50 -0600474
475 valgrind --trace-children=yes u-boot
476
477
Simon Glass75b3c3a2014-03-22 17:12:59 -0600478Testing
479-------
480
481U-Boot sandbox can be used to run various tests, mostly in the test/
482directory. These include:
483
Bin Meng49116e62019-07-18 00:34:33 -0700484command_ut:
485 Unit tests for command parsing and handling
486compression:
487 Unit tests for U-Boot's compression algorithms, useful for
488 security checking. It supports gzip, bzip2, lzma and lzo.
489driver model:
490 Run this pytest::
491
492 ./test/py/test.py --bd sandbox --build -k ut_dm -v
493
494image:
495 Unit tests for images:
496 test/image/test-imagetools.sh - multi-file images
497 test/image/test-fit.py - FIT images
498tracing:
499 test/trace/test-trace.sh tests the tracing system (see README.trace)
500verified boot:
501 See test/vboot/vboot_test.sh for this
Simon Glass75b3c3a2014-03-22 17:12:59 -0600502
503If you change or enhance any of the above subsystems, you shold write or
504expand a test and include it with your patch series submission. Test
505coverage in U-Boot is limited, as we need to work to improve it.
506
507Note that many of these tests are implemented as commands which you can
508run natively on your board if desired (and enabled).
509
Simon Glass9946d552018-11-15 18:43:59 -0700510To run all tests use "make check".
511
Simon Glass189882c2019-09-25 08:56:07 -0600512To run a single test in an existing sandbox build, you can use -T to use the
513test device tree, and -c to select the test:
514
515 /tmp/b/sandbox/u-boot -T -c "ut dm pci_busdev"
516
517This runs dm_test_pci_busdev() which is in test/dm/pci.c
518
Simon Glass9946d552018-11-15 18:43:59 -0700519
520Memory Map
521----------
522
523Sandbox has its own emulated memory starting at 0. Here are some of the things
524that are mapped into that memory:
525
Bin Meng49116e62019-07-18 00:34:33 -0700526======= ======================== ===============================
527Addr Config Usage
528======= ======================== ===============================
Simon Glass9946d552018-11-15 18:43:59 -0700529 0 CONFIG_SYS_FDT_LOAD_ADDR Device tree
530 e000 CONFIG_BLOBLIST_ADDR Blob list
531 10000 CONFIG_MALLOC_F_ADDR Early memory allocation
Simon Glassa1396cd2019-04-08 13:20:44 -0600532 f0000 CONFIG_PRE_CON_BUF_ADDR Pre-console buffer
533 100000 CONFIG_TRACE_EARLY_ADDR Early trace buffer (if enabled)
Bin Meng49116e62019-07-18 00:34:33 -0700534======= ======================== ===============================