config_distro_bootcmd.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2014
  4. * NVIDIA Corporation <www.nvidia.com>
  5. *
  6. * Copyright 2014 Red Hat, Inc.
  7. */
  8. #ifndef _CONFIG_CMD_DISTRO_BOOTCMD_H
  9. #define _CONFIG_CMD_DISTRO_BOOTCMD_H
  10. /*
  11. * A note on error handling: It is possible for BOOT_TARGET_DEVICES to
  12. * reference a device that is not enabled in the U-Boot configuration, e.g.
  13. * it may include MMC in the list without CONFIG_CMD_MMC being enabled. Given
  14. * that BOOT_TARGET_DEVICES is a macro that's expanded by the C pre-processor
  15. * at compile time, it's not possible to detect and report such problems via
  16. * a simple #ifdef/#error combination. Still, the code needs to report errors.
  17. * The best way I've found to do this is to make BOOT_TARGET_DEVICES expand to
  18. * reference a non-existent symbol, and have the name of that symbol encode
  19. * the error message. Consequently, this file contains references to e.g.
  20. * BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC. Given the
  21. * prevalence of capitals here, this looks like a pre-processor macro and
  22. * hence seems like it should be all capitals, but it's really an error
  23. * message that includes some other pre-processor symbols in the text.
  24. */
  25. #define BOOTENV_SHARED_BLKDEV_BODY(devtypel) \
  26. "if " #devtypel " dev ${devnum}; then " \
  27. "setenv devtype " #devtypel "; " \
  28. "run scan_dev_for_boot_part; " \
  29. "fi\0"
  30. #define BOOTENV_SHARED_BLKDEV(devtypel) \
  31. #devtypel "_boot=" \
  32. BOOTENV_SHARED_BLKDEV_BODY(devtypel)
  33. #define BOOTENV_DEV_BLKDEV(devtypeu, devtypel, instance) \
  34. "bootcmd_" #devtypel #instance "=" \
  35. "setenv devnum " #instance "; " \
  36. "run " #devtypel "_boot\0"
  37. #define BOOTENV_DEV_NAME_BLKDEV(devtypeu, devtypel, instance) \
  38. #devtypel #instance " "
  39. #ifdef CONFIG_SANDBOX
  40. #define BOOTENV_SHARED_HOST BOOTENV_SHARED_BLKDEV(host)
  41. #define BOOTENV_DEV_HOST BOOTENV_DEV_BLKDEV
  42. #define BOOTENV_DEV_NAME_HOST BOOTENV_DEV_NAME_BLKDEV
  43. #else
  44. #define BOOTENV_SHARED_HOST
  45. #define BOOTENV_DEV_HOST \
  46. BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
  47. #define BOOTENV_DEV_NAME_HOST \
  48. BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
  49. #endif
  50. #ifdef CONFIG_CMD_MMC
  51. #define BOOTENV_SHARED_MMC BOOTENV_SHARED_BLKDEV(mmc)
  52. #define BOOTENV_DEV_MMC BOOTENV_DEV_BLKDEV
  53. #define BOOTENV_DEV_NAME_MMC BOOTENV_DEV_NAME_BLKDEV
  54. #else
  55. #define BOOTENV_SHARED_MMC
  56. #define BOOTENV_DEV_MMC \
  57. BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
  58. #define BOOTENV_DEV_NAME_MMC \
  59. BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
  60. #endif
  61. #ifdef CONFIG_CMD_UBIFS
  62. #define BOOTENV_SHARED_UBIFS \
  63. "ubifs_boot=" \
  64. "env exists bootubipart || " \
  65. "env set bootubipart UBI; " \
  66. "env exists bootubivol || " \
  67. "env set bootubivol boot; " \
  68. "if ubi part ${bootubipart} && " \
  69. "ubifsmount ubi${devnum}:${bootubivol}; " \
  70. "then " \
  71. "setenv devtype ubi; " \
  72. "run scan_dev_for_boot; " \
  73. "fi\0"
  74. #define BOOTENV_DEV_UBIFS BOOTENV_DEV_BLKDEV
  75. #define BOOTENV_DEV_NAME_UBIFS BOOTENV_DEV_NAME_BLKDEV
  76. #else
  77. #define BOOTENV_SHARED_UBIFS
  78. #define BOOTENV_DEV_UBIFS \
  79. BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
  80. #define BOOTENV_DEV_NAME_UBIFS \
  81. BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
  82. #endif
  83. #ifdef CONFIG_EFI_LOADER
  84. #if defined(CONFIG_ARM64)
  85. #define BOOTEFI_NAME "bootaa64.efi"
  86. #elif defined(CONFIG_ARM)
  87. #define BOOTEFI_NAME "bootarm.efi"
  88. #elif defined(CONFIG_X86_RUN_32BIT)
  89. #define BOOTEFI_NAME "bootia32.efi"
  90. #elif defined(CONFIG_X86_RUN_64BIT)
  91. #define BOOTEFI_NAME "bootx64.efi"
  92. #elif defined(CONFIG_ARCH_RV32I)
  93. #define BOOTEFI_NAME "bootriscv32.efi"
  94. #elif defined(CONFIG_ARCH_RV64I)
  95. #define BOOTEFI_NAME "bootriscv64.efi"
  96. #endif
  97. #endif
  98. #ifdef BOOTEFI_NAME
  99. #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
  100. /*
  101. * On 32bit ARM systems there is a reasonable number of systems that follow
  102. * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
  103. * scheme if we don't have an explicit fdtfile variable.
  104. */
  105. #define BOOTENV_EFI_SET_FDTFILE_FALLBACK \
  106. "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then " \
  107. "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; " \
  108. "fi; "
  109. #else
  110. #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
  111. #endif
  112. #define BOOTENV_SHARED_EFI \
  113. "boot_efi_binary=" \
  114. "if fdt addr ${fdt_addr_r}; then " \
  115. "bootefi bootmgr ${fdt_addr_r};" \
  116. "else " \
  117. "bootefi bootmgr ${fdtcontroladdr};" \
  118. "fi;" \
  119. "load ${devtype} ${devnum}:${distro_bootpart} " \
  120. "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
  121. "if fdt addr ${fdt_addr_r}; then " \
  122. "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
  123. "else " \
  124. "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
  125. "fi\0" \
  126. \
  127. "load_efi_dtb=" \
  128. "load ${devtype} ${devnum}:${distro_bootpart} " \
  129. "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
  130. \
  131. "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
  132. "scan_dev_for_efi=" \
  133. "setenv efi_fdtfile ${fdtfile}; " \
  134. BOOTENV_EFI_SET_FDTFILE_FALLBACK \
  135. "for prefix in ${efi_dtb_prefixes}; do " \
  136. "if test -e ${devtype} " \
  137. "${devnum}:${distro_bootpart} " \
  138. "${prefix}${efi_fdtfile}; then " \
  139. "run load_efi_dtb; " \
  140. "fi;" \
  141. "done;" \
  142. "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
  143. "efi/boot/"BOOTEFI_NAME"; then " \
  144. "echo Found EFI removable media binary " \
  145. "efi/boot/"BOOTEFI_NAME"; " \
  146. "run boot_efi_binary; " \
  147. "echo EFI LOAD FAILED: continuing...; " \
  148. "fi; " \
  149. "setenv efi_fdtfile\0"
  150. #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
  151. #else
  152. #define BOOTENV_SHARED_EFI
  153. #define SCAN_DEV_FOR_EFI
  154. #endif
  155. #ifdef CONFIG_SATA
  156. #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
  157. #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
  158. #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
  159. #else
  160. #define BOOTENV_SHARED_SATA
  161. #define BOOTENV_DEV_SATA \
  162. BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
  163. #define BOOTENV_DEV_NAME_SATA \
  164. BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
  165. #endif
  166. #ifdef CONFIG_SCSI
  167. #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
  168. #define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
  169. #define BOOTENV_SHARED_SCSI \
  170. "scsi_init=" \
  171. "if ${scsi_need_init}; then " \
  172. "setenv scsi_need_init false; " \
  173. "scsi scan; " \
  174. "fi\0" \
  175. \
  176. "scsi_boot=" \
  177. BOOTENV_RUN_SCSI_INIT \
  178. BOOTENV_SHARED_BLKDEV_BODY(scsi)
  179. #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
  180. #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
  181. #else
  182. #define BOOTENV_RUN_SCSI_INIT
  183. #define BOOTENV_SET_SCSI_NEED_INIT
  184. #define BOOTENV_SHARED_SCSI
  185. #define BOOTENV_DEV_SCSI \
  186. BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
  187. #define BOOTENV_DEV_NAME_SCSI \
  188. BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
  189. #endif
  190. #ifdef CONFIG_IDE
  191. #define BOOTENV_SHARED_IDE BOOTENV_SHARED_BLKDEV(ide)
  192. #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
  193. #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
  194. #else
  195. #define BOOTENV_SHARED_IDE
  196. #define BOOTENV_DEV_IDE \
  197. BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
  198. #define BOOTENV_DEV_NAME_IDE \
  199. BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
  200. #endif
  201. #if defined(CONFIG_DM_PCI)
  202. #define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
  203. #define BOOTENV_SHARED_PCI \
  204. "boot_net_pci_enum=pci enum\0"
  205. #else
  206. #define BOOTENV_RUN_NET_PCI_ENUM
  207. #define BOOTENV_SHARED_PCI
  208. #endif
  209. #ifdef CONFIG_CMD_USB
  210. #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
  211. #define BOOTENV_SHARED_USB \
  212. "boot_net_usb_start=usb start\0" \
  213. "usb_boot=" \
  214. "usb start; " \
  215. BOOTENV_SHARED_BLKDEV_BODY(usb)
  216. #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
  217. #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
  218. #else
  219. #define BOOTENV_RUN_NET_USB_START
  220. #define BOOTENV_SHARED_USB
  221. #define BOOTENV_DEV_USB \
  222. BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
  223. #define BOOTENV_DEV_NAME_USB \
  224. BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
  225. #endif
  226. #ifdef CONFIG_CMD_VIRTIO
  227. #define BOOTENV_SHARED_VIRTIO BOOTENV_SHARED_BLKDEV(virtio)
  228. #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
  229. #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
  230. #else
  231. #define BOOTENV_SHARED_VIRTIO
  232. #define BOOTENV_DEV_VIRTIO \
  233. BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
  234. #define BOOTENV_DEV_NAME_VIRTIO \
  235. BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
  236. #endif
  237. #if defined(CONFIG_CMD_DHCP)
  238. #if defined(CONFIG_EFI_LOADER)
  239. /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
  240. #if defined(CONFIG_ARM64) || defined(__aarch64__)
  241. #define BOOTENV_EFI_PXE_ARCH "0xb"
  242. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
  243. #elif defined(CONFIG_ARM) || defined(__arm__)
  244. #define BOOTENV_EFI_PXE_ARCH "0xa"
  245. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
  246. #elif defined(CONFIG_X86) || defined(__x86_64__)
  247. #define BOOTENV_EFI_PXE_ARCH "0x7"
  248. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
  249. #elif defined(__i386__)
  250. #define BOOTENV_EFI_PXE_ARCH "0x6"
  251. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
  252. #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
  253. #define BOOTENV_EFI_PXE_ARCH "0x19"
  254. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
  255. #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
  256. #define BOOTENV_EFI_PXE_ARCH "0x1b"
  257. #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
  258. #elif defined(CONFIG_SANDBOX)
  259. # error "sandbox EFI support is only supported on ARM and x86"
  260. #else
  261. #error Please specify an EFI client identifier
  262. #endif
  263. /*
  264. * Ask the dhcp server for an EFI binary. If we get one, check for a
  265. * device tree in the same folder. Then boot everything. If the file was
  266. * not an EFI binary, we just return from the bootefi command and continue.
  267. */
  268. #define BOOTENV_EFI_RUN_DHCP \
  269. "setenv efi_fdtfile ${fdtfile}; " \
  270. BOOTENV_EFI_SET_FDTFILE_FALLBACK \
  271. "setenv efi_old_vci ${bootp_vci};" \
  272. "setenv efi_old_arch ${bootp_arch};" \
  273. "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
  274. "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
  275. "if dhcp ${kernel_addr_r}; then " \
  276. "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
  277. "if fdt addr ${fdt_addr_r}; then " \
  278. "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
  279. "else " \
  280. "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
  281. "fi;" \
  282. "fi;" \
  283. "setenv bootp_vci ${efi_old_vci};" \
  284. "setenv bootp_arch ${efi_old_arch};" \
  285. "setenv efi_fdtfile;" \
  286. "setenv efi_old_arch;" \
  287. "setenv efi_old_vci;"
  288. #else
  289. #define BOOTENV_EFI_RUN_DHCP
  290. #endif
  291. #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
  292. "bootcmd_dhcp=" \
  293. BOOTENV_RUN_NET_USB_START \
  294. BOOTENV_RUN_NET_PCI_ENUM \
  295. "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
  296. "source ${scriptaddr}; " \
  297. "fi;" \
  298. BOOTENV_EFI_RUN_DHCP \
  299. "\0"
  300. #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
  301. "dhcp "
  302. #else
  303. #define BOOTENV_DEV_DHCP \
  304. BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
  305. #define BOOTENV_DEV_NAME_DHCP \
  306. BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
  307. #endif
  308. #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
  309. #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
  310. "bootcmd_pxe=" \
  311. BOOTENV_RUN_NET_USB_START \
  312. BOOTENV_RUN_NET_PCI_ENUM \
  313. "dhcp; " \
  314. "if pxe get; then " \
  315. "pxe boot; " \
  316. "fi\0"
  317. #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
  318. "pxe "
  319. #else
  320. #define BOOTENV_DEV_PXE \
  321. BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
  322. #define BOOTENV_DEV_NAME_PXE \
  323. BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
  324. #endif
  325. #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
  326. BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
  327. #define BOOTENV_BOOT_TARGETS \
  328. "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
  329. #define BOOTENV_DEV(devtypeu, devtypel, instance) \
  330. BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
  331. #define BOOTENV \
  332. BOOTENV_SHARED_HOST \
  333. BOOTENV_SHARED_MMC \
  334. BOOTENV_SHARED_PCI \
  335. BOOTENV_SHARED_USB \
  336. BOOTENV_SHARED_SATA \
  337. BOOTENV_SHARED_SCSI \
  338. BOOTENV_SHARED_IDE \
  339. BOOTENV_SHARED_UBIFS \
  340. BOOTENV_SHARED_EFI \
  341. BOOTENV_SHARED_VIRTIO \
  342. "boot_prefixes=/ /boot/\0" \
  343. "boot_scripts=boot.scr.uimg boot.scr\0" \
  344. "boot_script_dhcp=boot.scr.uimg\0" \
  345. BOOTENV_BOOT_TARGETS \
  346. \
  347. "boot_syslinux_conf=extlinux/extlinux.conf\0" \
  348. "boot_extlinux=" \
  349. "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
  350. "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
  351. \
  352. "scan_dev_for_extlinux=" \
  353. "if test -e ${devtype} " \
  354. "${devnum}:${distro_bootpart} " \
  355. "${prefix}${boot_syslinux_conf}; then " \
  356. "echo Found ${prefix}${boot_syslinux_conf}; " \
  357. "run boot_extlinux; " \
  358. "echo SCRIPT FAILED: continuing...; " \
  359. "fi\0" \
  360. \
  361. "boot_a_script=" \
  362. "load ${devtype} ${devnum}:${distro_bootpart} " \
  363. "${scriptaddr} ${prefix}${script}; " \
  364. "source ${scriptaddr}\0" \
  365. \
  366. "scan_dev_for_scripts=" \
  367. "for script in ${boot_scripts}; do " \
  368. "if test -e ${devtype} " \
  369. "${devnum}:${distro_bootpart} " \
  370. "${prefix}${script}; then " \
  371. "echo Found U-Boot script " \
  372. "${prefix}${script}; " \
  373. "run boot_a_script; " \
  374. "echo SCRIPT FAILED: continuing...; " \
  375. "fi; " \
  376. "done\0" \
  377. \
  378. "scan_dev_for_boot=" \
  379. "echo Scanning ${devtype} " \
  380. "${devnum}:${distro_bootpart}...; " \
  381. "for prefix in ${boot_prefixes}; do " \
  382. "run scan_dev_for_extlinux; " \
  383. "run scan_dev_for_scripts; " \
  384. "done;" \
  385. SCAN_DEV_FOR_EFI \
  386. "\0" \
  387. \
  388. "scan_dev_for_boot_part=" \
  389. "part list ${devtype} ${devnum} -bootable devplist; " \
  390. "env exists devplist || setenv devplist 1; " \
  391. "for distro_bootpart in ${devplist}; do " \
  392. "if fstype ${devtype} " \
  393. "${devnum}:${distro_bootpart} " \
  394. "bootfstype; then " \
  395. "run scan_dev_for_boot; " \
  396. "fi; " \
  397. "done\0" \
  398. \
  399. BOOT_TARGET_DEVICES(BOOTENV_DEV) \
  400. \
  401. "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
  402. "for target in ${boot_targets}; do " \
  403. "run bootcmd_${target}; " \
  404. "done\0"
  405. #ifndef CONFIG_BOOTCOMMAND
  406. #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
  407. #endif
  408. #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */