1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * NVIDIA Corporation <www.nvidia.com>
6 * Copyright 2014 Red Hat, Inc.
9 #ifndef _CONFIG_CMD_DISTRO_BOOTCMD_H
10 #define _CONFIG_CMD_DISTRO_BOOTCMD_H
13 * A note on error handling: It is possible for BOOT_TARGET_DEVICES to
14 * reference a device that is not enabled in the U-Boot configuration, e.g.
15 * it may include MMC in the list without CONFIG_CMD_MMC being enabled. Given
16 * that BOOT_TARGET_DEVICES is a macro that's expanded by the C pre-processor
17 * at compile time, it's not possible to detect and report such problems via
18 * a simple #ifdef/#error combination. Still, the code needs to report errors.
19 * The best way I've found to do this is to make BOOT_TARGET_DEVICES expand to
20 * reference a non-existent symbol, and have the name of that symbol encode
21 * the error message. Consequently, this file contains references to e.g.
22 * BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC. Given the
23 * prevalence of capitals here, this looks like a pre-processor macro and
24 * hence seems like it should be all capitals, but it's really an error
25 * message that includes some other pre-processor symbols in the text.
28 #define BOOTENV_SHARED_BLKDEV_BODY(devtypel) \
29 "if " #devtypel " dev ${devnum}; then " \
30 "devtype=" #devtypel "; " \
31 "run scan_dev_for_boot_part; " \
34 #define BOOTENV_SHARED_BLKDEV(devtypel) \
36 BOOTENV_SHARED_BLKDEV_BODY(devtypel)
38 #define BOOTENV_DEV_BLKDEV(devtypeu, devtypel, instance) \
39 "bootcmd_" #devtypel #instance "=" \
40 "devnum=" #instance "; " \
41 "run " #devtypel "_boot\0"
43 #define BOOTENV_DEV_NAME_BLKDEV(devtypeu, devtypel, instance) \
44 #devtypel #instance " "
47 #define BOOTENV_SHARED_HOST BOOTENV_SHARED_BLKDEV(host)
48 #define BOOTENV_DEV_HOST BOOTENV_DEV_BLKDEV
49 #define BOOTENV_DEV_NAME_HOST BOOTENV_DEV_NAME_BLKDEV
51 #define BOOTENV_SHARED_HOST
52 #define BOOTENV_DEV_HOST \
53 BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
54 #define BOOTENV_DEV_NAME_HOST \
55 BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
59 #define BOOTENV_SHARED_MMC BOOTENV_SHARED_BLKDEV(mmc)
60 #define BOOTENV_DEV_MMC BOOTENV_DEV_BLKDEV
61 #define BOOTENV_DEV_NAME_MMC BOOTENV_DEV_NAME_BLKDEV
63 #define BOOTENV_SHARED_MMC
64 #define BOOTENV_DEV_MMC \
65 BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
66 #define BOOTENV_DEV_NAME_MMC \
67 BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
70 #ifdef CONFIG_CMD_UBIFS
71 #define BOOTENV_SHARED_UBIFS \
73 "if ubi part ${bootubipart} && " \
74 "ubifsmount ubi0:${bootubivol}; " \
78 "bootfstype=ubifs; " \
79 "distro_bootpart=${bootubivol}; " \
80 "run scan_dev_for_boot; " \
83 #define BOOTENV_DEV_UBIFS(devtypeu, devtypel, instance, bootubipart, bootubivol) \
84 "bootcmd_ubifs" #instance "=" \
85 "bootubipart=" #bootubipart "; " \
86 "bootubivol=" #bootubivol "; " \
88 #define BOOTENV_DEV_NAME_UBIFS(devtypeu, devtypel, instance, bootubipart, bootubivol) \
89 #devtypel #instance " "
91 #define BOOTENV_SHARED_UBIFS
92 #define BOOTENV_DEV_UBIFS \
93 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
94 #define BOOTENV_DEV_NAME_UBIFS \
95 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
98 #ifdef CONFIG_EFI_LOADER
99 #if defined(CONFIG_ARM64)
100 #define BOOTEFI_NAME "bootaa64.efi"
101 #elif defined(CONFIG_ARM)
102 #define BOOTEFI_NAME "bootarm.efi"
103 #elif defined(CONFIG_X86_RUN_32BIT)
104 #define BOOTEFI_NAME "bootia32.efi"
105 #elif defined(CONFIG_X86_RUN_64BIT)
106 #define BOOTEFI_NAME "bootx64.efi"
107 #elif defined(CONFIG_ARCH_RV32I)
108 #define BOOTEFI_NAME "bootriscv32.efi"
109 #elif defined(CONFIG_ARCH_RV64I)
110 #define BOOTEFI_NAME "bootriscv64.efi"
115 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
117 * On 32bit ARM systems there is a reasonable number of systems that follow
118 * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
119 * scheme if we don't have an explicit fdtfile variable.
121 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK \
122 "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then " \
123 "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; " \
126 #ifndef BOOTENV_EFI_SET_FDTFILE_FALLBACK
127 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
131 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
132 #define BOOTENV_EFI_BOOTMGR \
133 "boot_efi_bootmgr=" \
134 "if fdt addr -q ${fdt_addr_r}; then " \
135 "bootefi bootmgr ${fdt_addr_r};" \
140 #define BOOTENV_EFI_BOOTMGR
143 #define BOOTENV_SHARED_EFI \
144 BOOTENV_EFI_BOOTMGR \
147 "load ${devtype} ${devnum}:${distro_bootpart} " \
148 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
149 "if fdt addr -q ${fdt_addr_r}; then " \
150 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
152 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
156 "load ${devtype} ${devnum}:${distro_bootpart} " \
157 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
159 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
160 "scan_dev_for_efi=" \
161 "setenv efi_fdtfile ${fdtfile}; " \
162 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
163 "for prefix in ${efi_dtb_prefixes}; do " \
164 "if test -e ${devtype} " \
165 "${devnum}:${distro_bootpart} " \
166 "${prefix}${efi_fdtfile}; then " \
167 "run load_efi_dtb; " \
170 "run boot_efi_bootmgr;" \
171 "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
172 "efi/boot/"BOOTEFI_NAME"; then " \
173 "echo Found EFI removable media binary " \
174 "efi/boot/"BOOTEFI_NAME"; " \
175 "run boot_efi_binary; " \
176 "echo EFI LOAD FAILED: continuing...; " \
178 "setenv efi_fdtfile\0"
179 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
181 #define BOOTENV_SHARED_EFI
182 #define SCAN_DEV_FOR_EFI
186 #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
187 #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
188 #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
190 #define BOOTENV_SHARED_SATA
191 #define BOOTENV_DEV_SATA \
192 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
193 #define BOOTENV_DEV_NAME_SATA \
194 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
198 #define BOOTENV_RUN_NVME_INIT "run nvme_init; "
199 #define BOOTENV_SET_NVME_NEED_INIT "setenv nvme_need_init; "
200 #define BOOTENV_SHARED_NVME \
202 "if ${nvme_need_init}; then " \
203 "setenv nvme_need_init false; " \
208 BOOTENV_RUN_PCI_ENUM \
209 BOOTENV_RUN_NVME_INIT \
210 BOOTENV_SHARED_BLKDEV_BODY(nvme)
211 #define BOOTENV_DEV_NVME BOOTENV_DEV_BLKDEV
212 #define BOOTENV_DEV_NAME_NVME BOOTENV_DEV_NAME_BLKDEV
214 #define BOOTENV_RUN_NVME_INIT
215 #define BOOTENV_SET_NVME_NEED_INIT
216 #define BOOTENV_SHARED_NVME
217 #define BOOTENV_DEV_NVME \
218 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
219 #define BOOTENV_DEV_NAME_NVME \
220 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
224 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
225 #define BOOTENV_SET_SCSI_NEED_INIT "scsi_need_init=; "
226 #define BOOTENV_SHARED_SCSI \
228 "if ${scsi_need_init}; then " \
229 "scsi_need_init=false; " \
234 BOOTENV_RUN_PCI_ENUM \
235 BOOTENV_RUN_SCSI_INIT \
236 BOOTENV_SHARED_BLKDEV_BODY(scsi)
237 #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
238 #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
240 #define BOOTENV_RUN_SCSI_INIT
241 #define BOOTENV_SET_SCSI_NEED_INIT
242 #define BOOTENV_SHARED_SCSI
243 #define BOOTENV_DEV_SCSI \
244 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
245 #define BOOTENV_DEV_NAME_SCSI \
246 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
250 #define BOOTENV_RUN_IDE_INIT "run ide_init; "
251 #define BOOTENV_SET_IDE_NEED_INIT "setenv ide_need_init; "
252 #define BOOTENV_SHARED_IDE \
254 "if ${ide_need_init}; then " \
255 "setenv ide_need_init false; " \
260 BOOTENV_RUN_IDE_INIT \
261 BOOTENV_SHARED_BLKDEV_BODY(ide)
262 #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
263 #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
265 #define BOOTENV_RUN_IDE_INIT
266 #define BOOTENV_SET_IDE_NEED_INIT
267 #define BOOTENV_SHARED_IDE
268 #define BOOTENV_DEV_IDE \
269 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
270 #define BOOTENV_DEV_NAME_IDE \
271 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
274 #if defined(CONFIG_PCI)
275 #define BOOTENV_RUN_PCI_ENUM "run boot_pci_enum; "
276 #define BOOTENV_SHARED_PCI \
277 "boot_pci_enum=pci enum\0"
279 #define BOOTENV_RUN_PCI_ENUM
280 #define BOOTENV_SHARED_PCI
283 #ifdef CONFIG_CMD_USB
284 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
285 #define BOOTENV_SHARED_USB \
286 "boot_net_usb_start=usb start\0" \
289 BOOTENV_SHARED_BLKDEV_BODY(usb)
290 #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
291 #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
293 #define BOOTENV_RUN_NET_USB_START
294 #define BOOTENV_SHARED_USB
295 #define BOOTENV_DEV_USB \
296 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
297 #define BOOTENV_DEV_NAME_USB \
298 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
301 #ifdef CONFIG_CMD_VIRTIO
302 #define BOOTENV_RUN_VIRTIO_INIT "run virtio_init; "
303 #define BOOTENV_SET_VIRTIO_NEED_INIT "virtio_need_init=; "
304 #define BOOTENV_SHARED_VIRTIO \
306 "if ${virtio_need_init}; then " \
307 "virtio_need_init=false; " \
312 BOOTENV_RUN_PCI_ENUM \
313 BOOTENV_RUN_VIRTIO_INIT \
314 BOOTENV_SHARED_BLKDEV_BODY(virtio)
315 #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
316 #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
318 #define BOOTENV_RUN_VIRTIO_INIT
319 #define BOOTENV_SET_VIRTIO_NEED_INIT
320 #define BOOTENV_SHARED_VIRTIO
321 #define BOOTENV_DEV_VIRTIO \
322 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
323 #define BOOTENV_DEV_NAME_VIRTIO \
324 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
327 #if defined(CONFIG_CMD_DHCP)
328 #if defined(CONFIG_EFI_LOADER)
329 /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
330 #if defined(CONFIG_ARM64) || defined(__aarch64__)
331 #define BOOTENV_EFI_PXE_ARCH "0xb"
332 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
333 #elif defined(CONFIG_ARM) || defined(__arm__)
334 #define BOOTENV_EFI_PXE_ARCH "0xa"
335 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
336 #elif defined(CONFIG_X86) || defined(__x86_64__)
337 #define BOOTENV_EFI_PXE_ARCH "0x7"
338 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
339 #elif defined(__i386__)
340 #define BOOTENV_EFI_PXE_ARCH "0x6"
341 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
342 #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
343 #define BOOTENV_EFI_PXE_ARCH "0x19"
344 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
345 #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
346 #define BOOTENV_EFI_PXE_ARCH "0x1b"
347 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
348 #elif defined(CONFIG_SANDBOX)
349 # error "sandbox EFI support is only supported on ARM and x86"
351 #error Please specify an EFI client identifier
355 * Ask the dhcp server for an EFI binary. If we get one, check for a
356 * device tree in the same folder. Then boot everything. If the file was
357 * not an EFI binary, we just return from the bootefi command and continue.
359 #define BOOTENV_EFI_RUN_DHCP \
360 "setenv efi_fdtfile ${fdtfile}; " \
361 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
362 "setenv efi_old_vci ${bootp_vci};" \
363 "setenv efi_old_arch ${bootp_arch};" \
364 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
365 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
366 "if dhcp ${kernel_addr_r}; then " \
367 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
368 "if fdt addr -q ${fdt_addr_r}; then " \
369 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
371 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
374 "setenv bootp_vci ${efi_old_vci};" \
375 "setenv bootp_arch ${efi_old_arch};" \
376 "setenv efi_fdtfile;" \
377 "setenv efi_old_arch;" \
378 "setenv efi_old_vci;"
380 #define BOOTENV_EFI_RUN_DHCP
382 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
384 "devtype=" #devtypel "; " \
385 BOOTENV_RUN_NET_USB_START \
386 BOOTENV_RUN_PCI_ENUM \
387 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
388 "source ${scriptaddr}; " \
390 BOOTENV_EFI_RUN_DHCP \
392 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
395 #define BOOTENV_DEV_DHCP \
396 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
397 #define BOOTENV_DEV_NAME_DHCP \
398 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
401 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
402 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
404 BOOTENV_RUN_NET_USB_START \
405 BOOTENV_RUN_PCI_ENUM \
407 "if pxe get; then " \
410 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
413 #define BOOTENV_DEV_PXE \
414 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
415 #define BOOTENV_DEV_NAME_PXE \
416 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
419 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance, ...) \
420 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance, ## __VA_ARGS__)
421 #define BOOTENV_BOOT_TARGETS \
422 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
424 #define BOOTENV_DEV(devtypeu, devtypel, instance, ...) \
425 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance, ## __VA_ARGS__)
427 BOOTENV_SHARED_HOST \
431 BOOTENV_SHARED_SATA \
432 BOOTENV_SHARED_SCSI \
433 BOOTENV_SHARED_NVME \
435 BOOTENV_SHARED_UBIFS \
437 BOOTENV_SHARED_VIRTIO \
438 "boot_prefixes=/ /boot/\0" \
439 "boot_scripts=boot.scr.uimg boot.scr\0" \
440 "boot_script_dhcp=boot.scr.uimg\0" \
441 BOOTENV_BOOT_TARGETS \
443 "boot_syslinux_conf=extlinux/extlinux.conf\0" \
445 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
446 "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
448 "scan_dev_for_extlinux=" \
449 "if test -e ${devtype} " \
450 "${devnum}:${distro_bootpart} " \
451 "${prefix}${boot_syslinux_conf}; then " \
452 "echo Found ${prefix}${boot_syslinux_conf}; " \
453 "run boot_extlinux; " \
454 "echo SCRIPT FAILED: continuing...; " \
458 "load ${devtype} ${devnum}:${distro_bootpart} " \
459 "${scriptaddr} ${prefix}${script}; " \
460 "source ${scriptaddr}\0" \
462 "scan_dev_for_scripts=" \
463 "for script in ${boot_scripts}; do " \
464 "if test -e ${devtype} " \
465 "${devnum}:${distro_bootpart} " \
466 "${prefix}${script}; then " \
467 "echo Found U-Boot script " \
468 "${prefix}${script}; " \
469 "run boot_a_script; " \
470 "echo SCRIPT FAILED: continuing...; " \
474 "scan_dev_for_boot=" \
475 "echo Scanning ${devtype} " \
476 "${devnum}:${distro_bootpart}...; " \
477 "for prefix in ${boot_prefixes}; do " \
478 "run scan_dev_for_extlinux; " \
479 "run scan_dev_for_scripts; " \
484 "scan_dev_for_boot_part=" \
485 "part list ${devtype} ${devnum} -bootable devplist; " \
486 "env exists devplist || setenv devplist 1; " \
487 "for distro_bootpart in ${devplist}; do " \
488 "if fstype ${devtype} " \
489 "${devnum}:${distro_bootpart} " \
490 "bootfstype; then " \
491 "run scan_dev_for_boot; " \
494 "setenv devplist\0" \
496 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
498 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
499 BOOTENV_SET_NVME_NEED_INIT \
500 BOOTENV_SET_IDE_NEED_INIT \
501 BOOTENV_SET_VIRTIO_NEED_INIT \
502 "for target in ${boot_targets}; do " \
503 "run bootcmd_${target}; " \
506 #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */