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 "env exists bootubipart || " \
74 "env set bootubipart UBI; " \
75 "env exists bootubivol || " \
76 "env set bootubivol boot; " \
77 "if ubi part ${bootubipart} && " \
78 "ubifsmount ubi${devnum}:${bootubivol}; " \
81 "run scan_dev_for_boot; " \
83 #define BOOTENV_DEV_UBIFS BOOTENV_DEV_BLKDEV
84 #define BOOTENV_DEV_NAME_UBIFS BOOTENV_DEV_NAME_BLKDEV
86 #define BOOTENV_SHARED_UBIFS
87 #define BOOTENV_DEV_UBIFS \
88 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
89 #define BOOTENV_DEV_NAME_UBIFS \
90 BOOT_TARGET_DEVICES_references_UBIFS_without_CONFIG_CMD_UBIFS
93 #ifdef CONFIG_EFI_LOADER
94 #if defined(CONFIG_ARM64)
95 #define BOOTEFI_NAME "bootaa64.efi"
96 #elif defined(CONFIG_ARM)
97 #define BOOTEFI_NAME "bootarm.efi"
98 #elif defined(CONFIG_X86_RUN_32BIT)
99 #define BOOTEFI_NAME "bootia32.efi"
100 #elif defined(CONFIG_X86_RUN_64BIT)
101 #define BOOTEFI_NAME "bootx64.efi"
102 #elif defined(CONFIG_ARCH_RV32I)
103 #define BOOTEFI_NAME "bootriscv32.efi"
104 #elif defined(CONFIG_ARCH_RV64I)
105 #define BOOTEFI_NAME "bootriscv64.efi"
110 #if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
112 * On 32bit ARM systems there is a reasonable number of systems that follow
113 * the $soc-$board$boardver.dtb name scheme for their device trees. Use that
114 * scheme if we don't have an explicit fdtfile variable.
116 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK \
117 "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then " \
118 "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; " \
121 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
125 #define BOOTENV_SHARED_EFI \
127 "if fdt addr ${fdt_addr_r}; then " \
128 "bootefi bootmgr ${fdt_addr_r};" \
130 "bootefi bootmgr ${fdtcontroladdr};" \
132 "load ${devtype} ${devnum}:${distro_bootpart} " \
133 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
134 "if fdt addr ${fdt_addr_r}; then " \
135 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
137 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
141 "load ${devtype} ${devnum}:${distro_bootpart} " \
142 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
144 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
145 "scan_dev_for_efi=" \
146 "setenv efi_fdtfile ${fdtfile}; " \
147 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
148 "for prefix in ${efi_dtb_prefixes}; do " \
149 "if test -e ${devtype} " \
150 "${devnum}:${distro_bootpart} " \
151 "${prefix}${efi_fdtfile}; then " \
152 "run load_efi_dtb; " \
155 "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
156 "efi/boot/"BOOTEFI_NAME"; then " \
157 "echo Found EFI removable media binary " \
158 "efi/boot/"BOOTEFI_NAME"; " \
159 "run boot_efi_binary; " \
160 "echo EFI LOAD FAILED: continuing...; " \
162 "setenv efi_fdtfile\0"
163 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
165 #define BOOTENV_SHARED_EFI
166 #define SCAN_DEV_FOR_EFI
170 #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
171 #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
172 #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
174 #define BOOTENV_SHARED_SATA
175 #define BOOTENV_DEV_SATA \
176 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
177 #define BOOTENV_DEV_NAME_SATA \
178 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
182 #define BOOTENV_RUN_NVME_INIT "run nvme_init; "
183 #define BOOTENV_SET_NVME_NEED_INIT "setenv nvme_need_init; "
184 #define BOOTENV_SHARED_NVME \
186 "if ${nvme_need_init}; then " \
187 "setenv nvme_need_init false; " \
192 BOOTENV_RUN_NVME_INIT \
193 BOOTENV_SHARED_BLKDEV_BODY(nvme)
194 #define BOOTENV_DEV_NVME BOOTENV_DEV_BLKDEV
195 #define BOOTENV_DEV_NAME_NVME BOOTENV_DEV_NAME_BLKDEV
197 #define BOOTENV_RUN_NVME_INIT
198 #define BOOTENV_SET_NVME_NEED_INIT
199 #define BOOTENV_SHARED_NVME
200 #define BOOTENV_DEV_NVME \
201 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
202 #define BOOTENV_DEV_NAME_NVME \
203 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
207 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
208 #define BOOTENV_SET_SCSI_NEED_INIT "scsi_need_init=; "
209 #define BOOTENV_SHARED_SCSI \
211 "if ${scsi_need_init}; then " \
212 "scsi_need_init=false; " \
217 BOOTENV_RUN_SCSI_INIT \
218 BOOTENV_SHARED_BLKDEV_BODY(scsi)
219 #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
220 #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
222 #define BOOTENV_RUN_SCSI_INIT
223 #define BOOTENV_SET_SCSI_NEED_INIT
224 #define BOOTENV_SHARED_SCSI
225 #define BOOTENV_DEV_SCSI \
226 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
227 #define BOOTENV_DEV_NAME_SCSI \
228 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
232 #define BOOTENV_RUN_IDE_INIT "run ide_init; "
233 #define BOOTENV_SET_IDE_NEED_INIT "setenv ide_need_init; "
234 #define BOOTENV_SHARED_IDE \
236 "if ${ide_need_init}; then " \
237 "setenv ide_need_init false; " \
242 BOOTENV_RUN_IDE_INIT \
243 BOOTENV_SHARED_BLKDEV_BODY(ide)
244 #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
245 #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
247 #define BOOTENV_RUN_IDE_INIT
248 #define BOOTENV_SET_IDE_NEED_INIT
249 #define BOOTENV_SHARED_IDE
250 #define BOOTENV_DEV_IDE \
251 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
252 #define BOOTENV_DEV_NAME_IDE \
253 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
256 #if defined(CONFIG_DM_PCI)
257 #define BOOTENV_RUN_PCI_ENUM "run boot_pci_enum; "
258 #define BOOTENV_SHARED_PCI \
259 "boot_pci_enum=pci enum\0"
261 #define BOOTENV_RUN_PCI_ENUM
262 #define BOOTENV_SHARED_PCI
265 #ifdef CONFIG_CMD_USB
266 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
267 #define BOOTENV_SHARED_USB \
268 "boot_net_usb_start=usb start\0" \
271 BOOTENV_SHARED_BLKDEV_BODY(usb)
272 #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
273 #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
275 #define BOOTENV_RUN_NET_USB_START
276 #define BOOTENV_SHARED_USB
277 #define BOOTENV_DEV_USB \
278 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
279 #define BOOTENV_DEV_NAME_USB \
280 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
283 #ifdef CONFIG_CMD_VIRTIO
284 #define BOOTENV_RUN_VIRTIO_INIT "run virtio_init; "
285 #define BOOTENV_SET_VIRTIO_NEED_INIT "virtio_need_init=; "
286 #define BOOTENV_SHARED_VIRTIO \
288 "if ${virtio_need_init}; then " \
289 "virtio_need_init=false; " \
294 BOOTENV_RUN_PCI_ENUM \
295 BOOTENV_RUN_VIRTIO_INIT \
296 BOOTENV_SHARED_BLKDEV_BODY(virtio)
297 #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
298 #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
300 #define BOOTENV_RUN_VIRTIO_INIT
301 #define BOOTENV_SET_VIRTIO_NEED_INIT
302 #define BOOTENV_SHARED_VIRTIO
303 #define BOOTENV_DEV_VIRTIO \
304 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
305 #define BOOTENV_DEV_NAME_VIRTIO \
306 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
309 #if defined(CONFIG_CMD_DHCP)
310 #if defined(CONFIG_EFI_LOADER)
311 /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
312 #if defined(CONFIG_ARM64) || defined(__aarch64__)
313 #define BOOTENV_EFI_PXE_ARCH "0xb"
314 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
315 #elif defined(CONFIG_ARM) || defined(__arm__)
316 #define BOOTENV_EFI_PXE_ARCH "0xa"
317 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
318 #elif defined(CONFIG_X86) || defined(__x86_64__)
319 #define BOOTENV_EFI_PXE_ARCH "0x7"
320 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
321 #elif defined(__i386__)
322 #define BOOTENV_EFI_PXE_ARCH "0x6"
323 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
324 #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
325 #define BOOTENV_EFI_PXE_ARCH "0x19"
326 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
327 #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
328 #define BOOTENV_EFI_PXE_ARCH "0x1b"
329 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
330 #elif defined(CONFIG_SANDBOX)
331 # error "sandbox EFI support is only supported on ARM and x86"
333 #error Please specify an EFI client identifier
337 * Ask the dhcp server for an EFI binary. If we get one, check for a
338 * device tree in the same folder. Then boot everything. If the file was
339 * not an EFI binary, we just return from the bootefi command and continue.
341 #define BOOTENV_EFI_RUN_DHCP \
342 "setenv efi_fdtfile ${fdtfile}; " \
343 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
344 "setenv efi_old_vci ${bootp_vci};" \
345 "setenv efi_old_arch ${bootp_arch};" \
346 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
347 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
348 "if dhcp ${kernel_addr_r}; then " \
349 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
350 "if fdt addr ${fdt_addr_r}; then " \
351 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
353 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
356 "setenv bootp_vci ${efi_old_vci};" \
357 "setenv bootp_arch ${efi_old_arch};" \
358 "setenv efi_fdtfile;" \
359 "setenv efi_old_arch;" \
360 "setenv efi_old_vci;"
362 #define BOOTENV_EFI_RUN_DHCP
364 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
366 BOOTENV_RUN_NET_USB_START \
367 BOOTENV_RUN_PCI_ENUM \
368 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
369 "source ${scriptaddr}; " \
371 BOOTENV_EFI_RUN_DHCP \
373 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
376 #define BOOTENV_DEV_DHCP \
377 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
378 #define BOOTENV_DEV_NAME_DHCP \
379 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
382 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
383 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
385 BOOTENV_RUN_NET_USB_START \
386 BOOTENV_RUN_PCI_ENUM \
388 "if pxe get; then " \
391 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
394 #define BOOTENV_DEV_PXE \
395 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
396 #define BOOTENV_DEV_NAME_PXE \
397 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
400 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
401 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
402 #define BOOTENV_BOOT_TARGETS \
403 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
405 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
406 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
408 BOOTENV_SHARED_HOST \
412 BOOTENV_SHARED_SATA \
413 BOOTENV_SHARED_SCSI \
414 BOOTENV_SHARED_NVME \
416 BOOTENV_SHARED_UBIFS \
418 BOOTENV_SHARED_VIRTIO \
419 "boot_prefixes=/ /boot/\0" \
420 "boot_scripts=boot.scr.uimg boot.scr\0" \
421 "boot_script_dhcp=boot.scr.uimg\0" \
422 BOOTENV_BOOT_TARGETS \
424 "boot_syslinux_conf=extlinux/extlinux.conf\0" \
426 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
427 "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
429 "scan_dev_for_extlinux=" \
430 "if test -e ${devtype} " \
431 "${devnum}:${distro_bootpart} " \
432 "${prefix}${boot_syslinux_conf}; then " \
433 "echo Found ${prefix}${boot_syslinux_conf}; " \
434 "run boot_extlinux; " \
435 "echo SCRIPT FAILED: continuing...; " \
439 "load ${devtype} ${devnum}:${distro_bootpart} " \
440 "${scriptaddr} ${prefix}${script}; " \
441 "source ${scriptaddr}\0" \
443 "scan_dev_for_scripts=" \
444 "for script in ${boot_scripts}; do " \
445 "if test -e ${devtype} " \
446 "${devnum}:${distro_bootpart} " \
447 "${prefix}${script}; then " \
448 "echo Found U-Boot script " \
449 "${prefix}${script}; " \
450 "run boot_a_script; " \
451 "echo SCRIPT FAILED: continuing...; " \
455 "scan_dev_for_boot=" \
456 "echo Scanning ${devtype} " \
457 "${devnum}:${distro_bootpart}...; " \
458 "for prefix in ${boot_prefixes}; do " \
459 "run scan_dev_for_extlinux; " \
460 "run scan_dev_for_scripts; " \
465 "scan_dev_for_boot_part=" \
466 "part list ${devtype} ${devnum} -bootable devplist; " \
467 "env exists devplist || setenv devplist 1; " \
468 "for distro_bootpart in ${devplist}; do " \
469 "if fstype ${devtype} " \
470 "${devnum}:${distro_bootpart} " \
471 "bootfstype; then " \
472 "run scan_dev_for_boot; " \
475 "setenv devplist\0" \
477 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
479 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
480 BOOTENV_SET_NVME_NEED_INIT \
481 BOOTENV_SET_IDE_NEED_INIT \
482 BOOTENV_SET_VIRTIO_NEED_INIT \
483 "for target in ${boot_targets}; do " \
484 "run bootcmd_${target}; " \
487 #ifndef CONFIG_BOOTCOMMAND
488 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
491 #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */