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} ${bootubioff} && " \
74 "ubifsmount ubi0:${bootubivol}; " \
78 "bootfstype=ubifs; " \
79 "distro_bootpart=${bootubivol}; " \
80 "run scan_dev_for_boot; " \
83 #define BOOTENV_DEV_UBIFS_BOOTUBIOFF(off) #off /* type check, throw error when called with more args */
84 #define BOOTENV_DEV_UBIFS(devtypeu, devtypel, instance, bootubipart, bootubivol, ...) \
85 "bootcmd_ubifs" #instance "=" \
86 "bootubipart=" #bootubipart "; " \
87 "bootubivol=" #bootubivol "; " \
88 "bootubioff=" BOOTENV_DEV_UBIFS_BOOTUBIOFF(__VA_ARGS__) "; " \
90 #define BOOTENV_DEV_NAME_UBIFS(devtypeu, devtypel, instance, ...) \
91 #devtypel #instance " "
93 #define BOOTENV_SHARED_UBIFS
94 #define BOOTENV_DEV_UBIFS \
95 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
96 #define BOOTENV_DEV_NAME_UBIFS \
97 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
100 #ifdef CONFIG_EFI_LOADER
101 #if defined(CONFIG_ARM64)
102 #define BOOTEFI_NAME "bootaa64.efi"
103 #elif defined(CONFIG_ARM)
104 #define BOOTEFI_NAME "bootarm.efi"
105 #elif defined(CONFIG_X86_RUN_32BIT)
106 #define BOOTEFI_NAME "bootia32.efi"
107 #elif defined(CONFIG_X86_RUN_64BIT)
108 #define BOOTEFI_NAME "bootx64.efi"
109 #elif defined(CONFIG_ARCH_RV32I)
110 #define BOOTEFI_NAME "bootriscv32.efi"
111 #elif defined(CONFIG_ARCH_RV64I)
112 #define BOOTEFI_NAME "bootriscv64.efi"
117 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
119 * On 32bit ARM systems there is a reasonable number of systems that follow
120 * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
121 * scheme if we don't have an explicit fdtfile variable.
123 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK \
124 "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then " \
125 "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; " \
128 #ifndef BOOTENV_EFI_SET_FDTFILE_FALLBACK
129 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
133 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
134 #define BOOTENV_EFI_BOOTMGR \
135 "boot_efi_bootmgr=" \
136 "if fdt addr -q ${fdt_addr_r}; then " \
137 "bootefi bootmgr ${fdt_addr_r};" \
142 #define BOOTENV_EFI_BOOTMGR
145 #define BOOTENV_SHARED_EFI \
146 BOOTENV_EFI_BOOTMGR \
149 "load ${devtype} ${devnum}:${distro_bootpart} " \
150 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
151 "if fdt addr -q ${fdt_addr_r}; then " \
152 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
154 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
158 "load ${devtype} ${devnum}:${distro_bootpart} " \
159 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
161 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
162 "scan_dev_for_efi=" \
163 "setenv efi_fdtfile ${fdtfile}; " \
164 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
165 BOOTENV_RUN_EXTENSION_INIT \
166 "for prefix in ${efi_dtb_prefixes}; do " \
167 "if test -e ${devtype} " \
168 "${devnum}:${distro_bootpart} " \
169 "${prefix}${efi_fdtfile}; then " \
170 "run load_efi_dtb; " \
171 BOOTENV_RUN_EXTENSION_APPLY \
174 "run boot_efi_bootmgr;" \
175 "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
176 "efi/boot/"BOOTEFI_NAME"; then " \
177 "echo Found EFI removable media binary " \
178 "efi/boot/"BOOTEFI_NAME"; " \
179 "run boot_efi_binary; " \
180 "echo EFI LOAD FAILED: continuing...; " \
182 "setenv efi_fdtfile\0"
183 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
185 #define BOOTENV_SHARED_EFI
186 #define SCAN_DEV_FOR_EFI
190 #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
191 #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
192 #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
194 #define BOOTENV_SHARED_SATA
195 #define BOOTENV_DEV_SATA \
196 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
197 #define BOOTENV_DEV_NAME_SATA \
198 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
202 #define BOOTENV_RUN_NVME_INIT "run nvme_init; "
203 #define BOOTENV_SET_NVME_NEED_INIT "setenv nvme_need_init; "
204 #define BOOTENV_SHARED_NVME \
206 "if ${nvme_need_init}; then " \
207 "setenv nvme_need_init false; " \
212 BOOTENV_RUN_PCI_ENUM \
213 BOOTENV_RUN_NVME_INIT \
214 BOOTENV_SHARED_BLKDEV_BODY(nvme)
215 #define BOOTENV_DEV_NVME BOOTENV_DEV_BLKDEV
216 #define BOOTENV_DEV_NAME_NVME BOOTENV_DEV_NAME_BLKDEV
218 #define BOOTENV_RUN_NVME_INIT
219 #define BOOTENV_SET_NVME_NEED_INIT
220 #define BOOTENV_SHARED_NVME
221 #define BOOTENV_DEV_NVME \
222 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
223 #define BOOTENV_DEV_NAME_NVME \
224 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
228 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
229 #define BOOTENV_SET_SCSI_NEED_INIT "scsi_need_init=; "
230 #define BOOTENV_SHARED_SCSI \
232 "if ${scsi_need_init}; then " \
233 "scsi_need_init=false; " \
238 BOOTENV_RUN_PCI_ENUM \
239 BOOTENV_RUN_SCSI_INIT \
240 BOOTENV_SHARED_BLKDEV_BODY(scsi)
241 #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
242 #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
244 #define BOOTENV_RUN_SCSI_INIT
245 #define BOOTENV_SET_SCSI_NEED_INIT
246 #define BOOTENV_SHARED_SCSI
247 #define BOOTENV_DEV_SCSI \
248 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
249 #define BOOTENV_DEV_NAME_SCSI \
250 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
254 #define BOOTENV_RUN_IDE_INIT "run ide_init; "
255 #define BOOTENV_SET_IDE_NEED_INIT "setenv ide_need_init; "
256 #define BOOTENV_SHARED_IDE \
258 "if ${ide_need_init}; then " \
259 "setenv ide_need_init false; " \
264 BOOTENV_RUN_IDE_INIT \
265 BOOTENV_SHARED_BLKDEV_BODY(ide)
266 #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
267 #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
269 #define BOOTENV_RUN_IDE_INIT
270 #define BOOTENV_SET_IDE_NEED_INIT
271 #define BOOTENV_SHARED_IDE
272 #define BOOTENV_DEV_IDE \
273 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
274 #define BOOTENV_DEV_NAME_IDE \
275 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
278 #if defined(CONFIG_PCI)
279 #define BOOTENV_RUN_PCI_ENUM "run boot_pci_enum; "
280 #define BOOTENV_SHARED_PCI \
281 "boot_pci_enum=pci enum\0"
283 #define BOOTENV_RUN_PCI_ENUM
284 #define BOOTENV_SHARED_PCI
287 #ifdef CONFIG_CMD_USB
288 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
289 #define BOOTENV_SHARED_USB \
290 "boot_net_usb_start=usb start\0" \
293 BOOTENV_SHARED_BLKDEV_BODY(usb)
294 #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
295 #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
297 #define BOOTENV_RUN_NET_USB_START
298 #define BOOTENV_SHARED_USB
299 #define BOOTENV_DEV_USB \
300 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
301 #define BOOTENV_DEV_NAME_USB \
302 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
305 #ifdef CONFIG_CMD_VIRTIO
306 #define BOOTENV_RUN_VIRTIO_INIT "run virtio_init; "
307 #define BOOTENV_SET_VIRTIO_NEED_INIT "virtio_need_init=; "
308 #define BOOTENV_SHARED_VIRTIO \
310 "if ${virtio_need_init}; then " \
311 "virtio_need_init=false; " \
316 BOOTENV_RUN_PCI_ENUM \
317 BOOTENV_RUN_VIRTIO_INIT \
318 BOOTENV_SHARED_BLKDEV_BODY(virtio)
319 #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
320 #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
322 #define BOOTENV_RUN_VIRTIO_INIT
323 #define BOOTENV_SET_VIRTIO_NEED_INIT
324 #define BOOTENV_SHARED_VIRTIO
325 #define BOOTENV_DEV_VIRTIO \
326 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
327 #define BOOTENV_DEV_NAME_VIRTIO \
328 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
331 #if defined(CONFIG_CMD_DHCP)
332 #if defined(CONFIG_EFI_LOADER)
333 /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
334 #if defined(CONFIG_ARM64) || defined(__aarch64__)
335 #define BOOTENV_EFI_PXE_ARCH "0xb"
336 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
337 #elif defined(CONFIG_ARM) || defined(__arm__)
338 #define BOOTENV_EFI_PXE_ARCH "0xa"
339 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
340 #elif defined(CONFIG_X86) || defined(__x86_64__)
341 #define BOOTENV_EFI_PXE_ARCH "0x7"
342 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
343 #elif defined(__i386__)
344 #define BOOTENV_EFI_PXE_ARCH "0x6"
345 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
346 #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
347 #define BOOTENV_EFI_PXE_ARCH "0x19"
348 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
349 #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
350 #define BOOTENV_EFI_PXE_ARCH "0x1b"
351 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
352 #elif defined(CONFIG_SANDBOX)
353 # error "sandbox EFI support is only supported on ARM and x86"
355 #error Please specify an EFI client identifier
359 * Ask the dhcp server for an EFI binary. If we get one, check for a
360 * device tree in the same folder. Then boot everything. If the file was
361 * not an EFI binary, we just return from the bootefi command and continue.
363 #define BOOTENV_EFI_RUN_DHCP \
364 "setenv efi_fdtfile ${fdtfile}; " \
365 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
366 "setenv efi_old_vci ${bootp_vci};" \
367 "setenv efi_old_arch ${bootp_arch};" \
368 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
369 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
370 "if dhcp ${kernel_addr_r}; then " \
371 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
372 "if fdt addr -q ${fdt_addr_r}; then " \
373 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
375 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
378 "setenv bootp_vci ${efi_old_vci};" \
379 "setenv bootp_arch ${efi_old_arch};" \
380 "setenv efi_fdtfile;" \
381 "setenv efi_old_arch;" \
382 "setenv efi_old_vci;"
384 #define BOOTENV_EFI_RUN_DHCP
386 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
388 "devtype=" #devtypel "; " \
389 BOOTENV_RUN_NET_USB_START \
390 BOOTENV_RUN_PCI_ENUM \
391 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
392 "source ${scriptaddr}; " \
394 BOOTENV_EFI_RUN_DHCP \
396 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
399 #define BOOTENV_DEV_DHCP \
400 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
401 #define BOOTENV_DEV_NAME_DHCP \
402 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
405 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
406 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
408 BOOTENV_RUN_NET_USB_START \
409 BOOTENV_RUN_PCI_ENUM \
411 "if pxe get; then " \
414 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
417 #define BOOTENV_DEV_PXE \
418 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
419 #define BOOTENV_DEV_NAME_PXE \
420 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
423 #if defined(CONFIG_CMD_EXTENSION)
424 #define BOOTENV_RUN_EXTENSION_INIT "run extension_init; "
425 #define BOOTENV_RUN_EXTENSION_APPLY "run extension_apply; "
426 #define BOOTENV_SET_EXTENSION_NEED_INIT \
427 "extension_need_init=; " \
428 "setenv extension_overlay_addr ${fdtoverlay_addr_r}; "
429 #define BOOTENV_SHARED_EXTENSION \
431 "echo Extension init...; " \
432 "if ${extension_need_init}; then " \
433 "extension_need_init=false; " \
437 "extension_overlay_cmd=" \
438 "load ${devtype} ${devnum}:${distro_bootpart} " \
439 "${extension_overlay_addr} ${prefix}${extension_overlay_name}\0" \
441 "if fdt addr -q ${fdt_addr_r}; then " \
442 "extension apply all; " \
445 #define BOOTENV_RUN_EXTENSION_INIT
446 #define BOOTENV_RUN_EXTENSION_APPLY
447 #define BOOTENV_SET_EXTENSION_NEED_INIT
448 #define BOOTENV_SHARED_EXTENSION
451 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance, ...) \
452 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance, ## __VA_ARGS__)
453 #define BOOTENV_BOOT_TARGETS \
454 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
456 #define BOOTENV_DEV(devtypeu, devtypel, instance, ...) \
457 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance, ## __VA_ARGS__)
459 BOOTENV_SHARED_HOST \
463 BOOTENV_SHARED_SATA \
464 BOOTENV_SHARED_SCSI \
465 BOOTENV_SHARED_NVME \
467 BOOTENV_SHARED_UBIFS \
469 BOOTENV_SHARED_VIRTIO \
470 BOOTENV_SHARED_EXTENSION \
471 "boot_prefixes=/ /boot/\0" \
472 "boot_scripts=boot.scr.uimg boot.scr\0" \
473 "boot_script_dhcp=boot.scr.uimg\0" \
474 BOOTENV_BOOT_TARGETS \
476 "boot_syslinux_conf=extlinux/extlinux.conf\0" \
478 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
479 "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
481 "scan_dev_for_extlinux=" \
482 "if test -e ${devtype} " \
483 "${devnum}:${distro_bootpart} " \
484 "${prefix}${boot_syslinux_conf}; then " \
485 "echo Found ${prefix}${boot_syslinux_conf}; " \
486 "run boot_extlinux; " \
487 "echo SCRIPT FAILED: continuing...; " \
491 "load ${devtype} ${devnum}:${distro_bootpart} " \
492 "${scriptaddr} ${prefix}${script}; " \
493 "source ${scriptaddr}\0" \
495 "scan_dev_for_scripts=" \
496 "for script in ${boot_scripts}; do " \
497 "if test -e ${devtype} " \
498 "${devnum}:${distro_bootpart} " \
499 "${prefix}${script}; then " \
500 "echo Found U-Boot script " \
501 "${prefix}${script}; " \
502 "run boot_a_script; " \
503 "echo SCRIPT FAILED: continuing...; " \
507 "scan_dev_for_boot=" \
508 "echo Scanning ${devtype} " \
509 "${devnum}:${distro_bootpart}...; " \
510 "for prefix in ${boot_prefixes}; do " \
511 "run scan_dev_for_extlinux; " \
512 "run scan_dev_for_scripts; " \
517 "scan_dev_for_boot_part=" \
518 "part list ${devtype} ${devnum} -bootable devplist; " \
519 "env exists devplist || setenv devplist 1; " \
520 "for distro_bootpart in ${devplist}; do " \
521 "if fstype ${devtype} " \
522 "${devnum}:${distro_bootpart} " \
523 "bootfstype; then " \
524 "run scan_dev_for_boot; " \
527 "setenv devplist\0" \
529 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
531 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
532 BOOTENV_SET_NVME_NEED_INIT \
533 BOOTENV_SET_IDE_NEED_INIT \
534 BOOTENV_SET_VIRTIO_NEED_INIT \
535 BOOTENV_SET_EXTENSION_NEED_INIT \
536 "for target in ${boot_targets}; do " \
537 "run bootcmd_${target}; " \
540 #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */