sandbox.rst 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. .. SPDX-License-Identifier: GPL-2.0+ */
  2. .. Copyright (c) 2014 The Chromium OS Authors.
  3. .. sectionauthor:: Simon Glass <sjg@chromium.org>
  4. Sandbox
  5. =======
  6. Native Execution of U-Boot
  7. --------------------------
  8. The 'sandbox' architecture is designed to allow U-Boot to run under Linux on
  9. almost any hardware. To achieve this it builds U-Boot (so far as possible)
  10. as a normal C application with a main() and normal C libraries.
  11. All of U-Boot's architecture-specific code therefore cannot be built as part
  12. of the sandbox U-Boot. The purpose of running U-Boot under Linux is to test
  13. all the generic code, not specific to any one architecture. The idea is to
  14. create unit tests which we can run to test this upper level code.
  15. Sandbox allows development of many types of new features in a traditional way,
  16. rather than needing to test each iteration on real hardware. Many U-Boot
  17. features were developed on sandbox, including the core driver model, most
  18. uclasses, verified boot, bloblist, logging and dozens of others. Sandbox has
  19. enabled many large-scale code refactors as well.
  20. CONFIG_SANDBOX is defined when building a native board.
  21. The board name is 'sandbox' but the vendor name is unset, so there is a
  22. single board in board/sandbox.
  23. CONFIG_SANDBOX_BIG_ENDIAN should be defined when running on big-endian
  24. machines.
  25. There are two versions of the sandbox: One using 32-bit-wide integers, and one
  26. using 64-bit-wide integers. The 32-bit version can be build and run on either
  27. 32 or 64-bit hosts by either selecting or deselecting CONFIG_SANDBOX_32BIT; by
  28. default, the sandbox it built for a 32-bit host. The sandbox using 64-bit-wide
  29. integers can only be built on 64-bit hosts.
  30. Note that standalone/API support is not available at present.
  31. Prerequisites
  32. -------------
  33. Here are some packages that are worth installing if you are doing sandbox or
  34. tools development in U-Boot:
  35. python3-pytest lzma lzma-alone lz4 python3 python3-virtualenv
  36. libssl1.0-dev
  37. Basic Operation
  38. ---------------
  39. To run sandbox U-Boot use something like::
  40. make sandbox_defconfig all
  41. ./u-boot
  42. Note: If you get errors about 'sdl-config: Command not found' you may need to
  43. install libsdl2.0-dev or similar to get SDL support. Alternatively you can
  44. build sandbox without SDL (i.e. no display/keyboard support) by removing
  45. the CONFIG_SANDBOX_SDL line in include/configs/sandbox.h or using::
  46. make sandbox_defconfig all NO_SDL=1
  47. ./u-boot
  48. U-Boot will start on your computer, showing a sandbox emulation of the serial
  49. console::
  50. U-Boot 2014.04 (Mar 20 2014 - 19:06:00)
  51. DRAM: 128 MiB
  52. Using default environment
  53. In: serial
  54. Out: lcd
  55. Err: lcd
  56. =>
  57. You can issue commands as your would normally. If the command you want is
  58. not supported you can add it to include/configs/sandbox.h.
  59. To exit, type 'poweroff' or press Ctrl-C.
  60. Console / LCD support
  61. ---------------------
  62. Assuming that CONFIG_SANDBOX_SDL is defined when building, you can run the
  63. sandbox with LCD and keyboard emulation, using something like::
  64. ./u-boot -d u-boot.dtb -l
  65. This will start U-Boot with a window showing the contents of the LCD. If
  66. that window has the focus then you will be able to type commands as you
  67. would on the console. You can adjust the display settings in the device
  68. tree file - see arch/sandbox/dts/sandbox.dts.
  69. Command-line Options
  70. --------------------
  71. Various options are available, mostly for test purposes. Use -h to see
  72. available options. Some of these are described below:
  73. -t, --terminal <arg>
  74. The terminal is normally in what is called 'raw-with-sigs' mode. This means
  75. that you can use arrow keys for command editing and history, but if you
  76. press Ctrl-C, U-Boot will exit instead of handling this as a keypress.
  77. Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked'
  78. (where the terminal is in cooked mode and cursor keys will not work, Ctrl-C
  79. will exit).
  80. -l
  81. Show the LCD emulation window.
  82. -d <device_tree>
  83. A device tree binary file can be provided with -d. If you edit the source
  84. (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
  85. recreate the binary file.
  86. -D
  87. To use the default device tree, use -D.
  88. -T
  89. To use the test device tree, use -T.
  90. -c [<cmd>;]<cmd>
  91. To execute commands directly, use the -c option. You can specify a single
  92. command, or multiple commands separated by a semicolon, as is normal in
  93. U-Boot. Be careful with quoting as the shell will normally process and
  94. swallow quotes. When -c is used, U-Boot exits after the command is complete,
  95. but you can force it to go to interactive mode instead with -i.
  96. -i
  97. Go to interactive mode after executing the commands specified by -c.
  98. Environment Variables
  99. ---------------------
  100. UBOOT_SB_TIME_OFFSET
  101. This environment variable stores the offset of the emulated real time clock
  102. to the host's real time clock in seconds. The offset defaults to zero.
  103. Memory Emulation
  104. ----------------
  105. Memory emulation is supported, with the size set by CONFIG_SYS_SDRAM_SIZE.
  106. The -m option can be used to read memory from a file on start-up and write
  107. it when shutting down. This allows preserving of memory contents across
  108. test runs. You can tell U-Boot to remove the memory file after it is read
  109. (on start-up) with the --rm_memory option.
  110. To access U-Boot's emulated memory within the code, use map_sysmem(). This
  111. function is used throughout U-Boot to ensure that emulated memory is used
  112. rather than the U-Boot application memory. This provides memory starting
  113. at 0 and extending to the size of the emulation.
  114. Storing State
  115. -------------
  116. With sandbox you can write drivers which emulate the operation of drivers on
  117. real devices. Some of these drivers may want to record state which is
  118. preserved across U-Boot runs. This is particularly useful for testing. For
  119. example, the contents of a SPI flash chip should not disappear just because
  120. U-Boot exits.
  121. State is stored in a device tree file in a simple format which is driver-
  122. specific. You then use the -s option to specify the state file. Use -r to
  123. make U-Boot read the state on start-up (otherwise it starts empty) and -w
  124. to write it on exit (otherwise the stored state is left unchanged and any
  125. changes U-Boot made will be lost). You can also use -n to tell U-Boot to
  126. ignore any problems with missing state. This is useful when first running
  127. since the state file will be empty.
  128. The device tree file has one node for each driver - the driver can store
  129. whatever properties it likes in there. See 'Writing Sandbox Drivers' below
  130. for more details on how to get drivers to read and write their state.
  131. Running and Booting
  132. -------------------
  133. Since there is no machine architecture, sandbox U-Boot cannot actually boot
  134. a kernel, but it does support the bootm command. Filesystems, memory
  135. commands, hashing, FIT images, verified boot and many other features are
  136. supported.
  137. When 'bootm' runs a kernel, sandbox will exit, as U-Boot does on a real
  138. machine. Of course in this case, no kernel is run.
  139. It is also possible to tell U-Boot that it has jumped from a temporary
  140. previous U-Boot binary, with the -j option. That binary is automatically
  141. removed by the U-Boot that gets the -j option. This allows you to write
  142. tests which emulate the action of chain-loading U-Boot, typically used in
  143. a situation where a second 'updatable' U-Boot is stored on your board. It
  144. is very risky to overwrite or upgrade the only U-Boot on a board, since a
  145. power or other failure will brick the board and require return to the
  146. manufacturer in the case of a consumer device.
  147. Supported Drivers
  148. -----------------
  149. U-Boot sandbox supports these emulations:
  150. - Block devices
  151. - Chrome OS EC
  152. - GPIO
  153. - Host filesystem (access files on the host from within U-Boot)
  154. - I2C
  155. - Keyboard (Chrome OS)
  156. - LCD
  157. - Network
  158. - Serial (for console only)
  159. - Sound (incomplete - see sandbox_sdl_sound_init() for details)
  160. - SPI
  161. - SPI flash
  162. - TPM (Trusted Platform Module)
  163. A wide range of commands are implemented. Filesystems which use a block
  164. device are supported.
  165. Also sandbox supports driver model (CONFIG_DM) and associated commands.
  166. Sandbox Variants
  167. ----------------
  168. There are unfortunately quite a few variants at present:
  169. sandbox:
  170. should be used for most tests
  171. sandbox64:
  172. special build that forces a 64-bit host
  173. sandbox_flattree:
  174. builds with dev_read\_...() functions defined as inline.
  175. We need this build so that we can test those inline functions, and we
  176. cannot build with both the inline functions and the non-inline functions
  177. since they are named the same.
  178. sandbox_spl:
  179. builds sandbox with SPL support, so you can run spl/u-boot-spl
  180. and it will start up and then load ./u-boot. It is also possible to
  181. run ./u-boot directly.
  182. Of these sandbox_spl can probably be removed since it is a superset of sandbox.
  183. Most of the config options should be identical between these variants.
  184. Linux RAW Networking Bridge
  185. ---------------------------
  186. The sandbox_eth_raw driver bridges traffic between the bottom of the network
  187. stack and the RAW sockets API in Linux. This allows much of the U-Boot network
  188. functionality to be tested in sandbox against real network traffic.
  189. For Ethernet network adapters, the bridge utilizes the RAW AF_PACKET API. This
  190. is needed to get access to the lowest level of the network stack in Linux. This
  191. means that all of the Ethernet frame is included. This allows the U-Boot network
  192. stack to be fully used. In other words, nothing about the Linux network stack is
  193. involved in forming the packets that end up on the wire. To receive the
  194. responses to packets sent from U-Boot the network interface has to be set to
  195. promiscuous mode so that the network card won't filter out packets not destined
  196. for its configured (on Linux) MAC address.
  197. The RAW sockets Ethernet API requires elevated privileges in Linux. You can
  198. either run as root, or you can add the capability needed like so::
  199. sudo /sbin/setcap "CAP_NET_RAW+ep" /path/to/u-boot
  200. The default device tree for sandbox includes an entry for eth0 on the sandbox
  201. host machine whose alias is "eth1". The following are a few examples of network
  202. operations being tested on the eth0 interface.
  203. .. code-block:: none
  204. sudo /path/to/u-boot -D
  205. DHCP
  206. ....
  207. setenv autoload no
  208. setenv ethrotate no
  209. setenv ethact eth1
  210. dhcp
  211. PING
  212. ....
  213. setenv autoload no
  214. setenv ethrotate no
  215. setenv ethact eth1
  216. dhcp
  217. ping $gatewayip
  218. TFTP
  219. ....
  220. setenv autoload no
  221. setenv ethrotate no
  222. setenv ethact eth1
  223. dhcp
  224. setenv serverip WWW.XXX.YYY.ZZZ
  225. tftpboot u-boot.bin
  226. The bridge also supports (to a lesser extent) the localhost interface, 'lo'.
  227. The 'lo' interface cannot use the RAW AF_PACKET API because the lo interface
  228. doesn't support Ethernet-level traffic. It is a higher-level interface that is
  229. expected only to be used at the AF_INET level of the API. As such, the most raw
  230. we can get on that interface is the RAW AF_INET API on UDP. This allows us to
  231. set the IP_HDRINCL option to include everything except the Ethernet header in
  232. the packets we send and receive.
  233. Because only UDP is supported, ICMP traffic will not work, so expect that ping
  234. commands will time out.
  235. The default device tree for sandbox includes an entry for lo on the sandbox
  236. host machine whose alias is "eth5". The following is an example of a network
  237. operation being tested on the lo interface.
  238. .. code-block:: none
  239. TFTP
  240. ....
  241. setenv ethrotate no
  242. setenv ethact eth5
  243. tftpboot u-boot.bin
  244. SPI Emulation
  245. -------------
  246. Sandbox supports SPI and SPI flash emulation.
  247. The device can be enabled via a device tree, for example::
  248. spi@0 {
  249. #address-cells = <1>;
  250. #size-cells = <0>;
  251. reg = <0 1>;
  252. compatible = "sandbox,spi";
  253. cs-gpios = <0>, <&gpio_a 0>;
  254. spi.bin@0 {
  255. reg = <0>;
  256. compatible = "spansion,m25p16", "jedec,spi-nor";
  257. spi-max-frequency = <40000000>;
  258. sandbox,filename = "spi.bin";
  259. };
  260. };
  261. The file must be created in advance::
  262. $ dd if=/dev/zero of=spi.bin bs=1M count=2
  263. $ u-boot -T
  264. Here, you can use "-T" or "-D" option to specify test.dtb or u-boot.dtb,
  265. respectively, or "-d <file>" for your own dtb.
  266. With this setup you can issue SPI flash commands as normal::
  267. =>sf probe
  268. SF: Detected M25P16 with page size 64 KiB, total 2 MiB
  269. =>sf read 0 0 10000
  270. SF: 65536 bytes @ 0x0 Read: OK
  271. Since this is a full SPI emulation (rather than just flash), you can
  272. also use low-level SPI commands::
  273. =>sspi 0:0 32 9f
  274. FF202015
  275. This is issuing a READ_ID command and getting back 20 (ST Micro) part
  276. 0x2015 (the M25P16).
  277. Block Device Emulation
  278. ----------------------
  279. U-Boot can use raw disk images for block device emulation. To e.g. list
  280. the contents of the root directory on the second partion of the image
  281. "disk.raw", you can use the following commands::
  282. =>host bind 0 ./disk.raw
  283. =>ls host 0:2
  284. A disk image can be created using the following commands::
  285. $> truncate -s 1200M ./disk.raw
  286. $> echo -e "label: gpt\n,64M,U\n,,L" | /usr/sbin/sgdisk ./disk.raw
  287. $> lodev=`sudo losetup -P -f --show ./disk.raw`
  288. $> sudo mkfs.vfat -n EFI -v ${lodev}p1
  289. $> sudo mkfs.ext4 -L ROOT -v ${lodev}p2
  290. or utilize the device described in test/py/make_test_disk.py::
  291. #!/usr/bin/python
  292. import make_test_disk
  293. make_test_disk.makeDisk()
  294. Writing Sandbox Drivers
  295. -----------------------
  296. Generally you should put your driver in a file containing the word 'sandbox'
  297. and put it in the same directory as other drivers of its type. You can then
  298. implement the same hooks as the other drivers.
  299. To access U-Boot's emulated memory, use map_sysmem() as mentioned above.
  300. If your driver needs to store configuration or state (such as SPI flash
  301. contents or emulated chip registers), you can use the device tree as
  302. described above. Define handlers for this with the SANDBOX_STATE_IO macro.
  303. See arch/sandbox/include/asm/state.h for documentation. In short you provide
  304. a node name, compatible string and functions to read and write the state.
  305. Since writing the state can expand the device tree, you may need to use
  306. state_setprop() which does this automatically and avoids running out of
  307. space. See existing code for examples.
  308. Debugging the init sequence
  309. ---------------------------
  310. If you get a failure in the initcall sequence, like this::
  311. initcall sequence 0000560775957c80 failed at call 0000000000048134 (err=-96)
  312. Then you use can use grep to see which init call failed, e.g.::
  313. $ grep 0000000000048134 u-boot.map
  314. stdio_add_devices
  315. Of course another option is to run it with a debugger such as gdb::
  316. $ gdb u-boot
  317. ...
  318. (gdb) br initcall.h:41
  319. Breakpoint 1 at 0x4db9d: initcall.h:41. (2 locations)
  320. Note that two locations are reported, since this function is used in both
  321. board_init_f() and board_init_r().
  322. .. code-block:: none
  323. (gdb) r
  324. Starting program: /tmp/b/sandbox/u-boot
  325. [Thread debugging using libthread_db enabled]
  326. Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
  327. U-Boot 2018.09-00264-ge0c2ba9814-dirty (Sep 22 2018 - 12:21:46 -0600)
  328. DRAM: 128 MiB
  329. MMC:
  330. Breakpoint 1, initcall_run_list (init_sequence=0x5555559619e0 <init_sequence_f>)
  331. at /scratch/sglass/cosarm/src/third_party/u-boot/files/include/initcall.h:41
  332. 41 printf("initcall sequence %p failed at call %p (err=%d)\n",
  333. (gdb) print *init_fnc_ptr
  334. $1 = (const init_fnc_t) 0x55555559c114 <stdio_add_devices>
  335. (gdb)
  336. This approach can be used on normal boards as well as sandbox.
  337. SDL_CONFIG
  338. ----------
  339. If sdl-config is on a different path from the default, set the SDL_CONFIG
  340. environment variable to the correct pathname before building U-Boot.
  341. Using valgrind / memcheck
  342. -------------------------
  343. It is possible to run U-Boot under valgrind to check memory allocations::
  344. valgrind u-boot
  345. If you are running sandbox SPL or TPL, then valgrind will not by default
  346. notice when U-Boot jumps from TPL to SPL, or from SPL to U-Boot proper. To
  347. fix this, use::
  348. valgrind --trace-children=yes u-boot
  349. Testing
  350. -------
  351. U-Boot sandbox can be used to run various tests, mostly in the test/
  352. directory.
  353. See :doc:`../develop/tests_sandbox` for more information and
  354. :doc:`../develop/testing` for information about testing generally.
  355. Memory Map
  356. ----------
  357. Sandbox has its own emulated memory starting at 0. Here are some of the things
  358. that are mapped into that memory:
  359. ======= ======================== ===============================
  360. Addr Config Usage
  361. ======= ======================== ===============================
  362. 0 CONFIG_SYS_FDT_LOAD_ADDR Device tree
  363. e000 CONFIG_BLOBLIST_ADDR Blob list
  364. 10000 CONFIG_MALLOC_F_ADDR Early memory allocation
  365. f0000 CONFIG_PRE_CON_BUF_ADDR Pre-console buffer
  366. 100000 CONFIG_TRACE_EARLY_ADDR Early trace buffer (if enabled). Also used
  367. as the SPL load buffer in spl_test_load().
  368. 200000 CONFIG_SYS_TEXT_BASE Load buffer for U-Boot (sandbox_spl only)
  369. ======= ======================== ===============================