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 #ifndef BOOTENV_EFI_SET_FDTFILE_FALLBACK
122 #define BOOTENV_EFI_SET_FDTFILE_FALLBACK
126 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
127 #define BOOTENV_EFI_BOOTMGR \
128 "boot_efi_bootmgr=" \
129 "if fdt addr ${fdt_addr_r}; then " \
130 "bootefi bootmgr ${fdt_addr_r};" \
135 #define BOOTENV_EFI_BOOTMGR
138 #define BOOTENV_SHARED_EFI \
139 BOOTENV_EFI_BOOTMGR \
142 "load ${devtype} ${devnum}:${distro_bootpart} " \
143 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
144 "if fdt addr ${fdt_addr_r}; then " \
145 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
147 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
151 "load ${devtype} ${devnum}:${distro_bootpart} " \
152 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
154 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
155 "scan_dev_for_efi=" \
156 "setenv efi_fdtfile ${fdtfile}; " \
157 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
158 "for prefix in ${efi_dtb_prefixes}; do " \
159 "if test -e ${devtype} " \
160 "${devnum}:${distro_bootpart} " \
161 "${prefix}${efi_fdtfile}; then " \
162 "run load_efi_dtb; " \
165 "run boot_efi_bootmgr;" \
166 "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
167 "efi/boot/"BOOTEFI_NAME"; then " \
168 "echo Found EFI removable media binary " \
169 "efi/boot/"BOOTEFI_NAME"; " \
170 "run boot_efi_binary; " \
171 "echo EFI LOAD FAILED: continuing...; " \
173 "setenv efi_fdtfile\0"
174 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
176 #define BOOTENV_SHARED_EFI
177 #define SCAN_DEV_FOR_EFI
181 #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
182 #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
183 #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
185 #define BOOTENV_SHARED_SATA
186 #define BOOTENV_DEV_SATA \
187 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
188 #define BOOTENV_DEV_NAME_SATA \
189 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
193 #define BOOTENV_RUN_NVME_INIT "run nvme_init; "
194 #define BOOTENV_SET_NVME_NEED_INIT "setenv nvme_need_init; "
195 #define BOOTENV_SHARED_NVME \
197 "if ${nvme_need_init}; then " \
198 "setenv nvme_need_init false; " \
203 BOOTENV_RUN_PCI_ENUM \
204 BOOTENV_RUN_NVME_INIT \
205 BOOTENV_SHARED_BLKDEV_BODY(nvme)
206 #define BOOTENV_DEV_NVME BOOTENV_DEV_BLKDEV
207 #define BOOTENV_DEV_NAME_NVME BOOTENV_DEV_NAME_BLKDEV
209 #define BOOTENV_RUN_NVME_INIT
210 #define BOOTENV_SET_NVME_NEED_INIT
211 #define BOOTENV_SHARED_NVME
212 #define BOOTENV_DEV_NVME \
213 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
214 #define BOOTENV_DEV_NAME_NVME \
215 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
219 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
220 #define BOOTENV_SET_SCSI_NEED_INIT "scsi_need_init=; "
221 #define BOOTENV_SHARED_SCSI \
223 "if ${scsi_need_init}; then " \
224 "scsi_need_init=false; " \
229 BOOTENV_RUN_PCI_ENUM \
230 BOOTENV_RUN_SCSI_INIT \
231 BOOTENV_SHARED_BLKDEV_BODY(scsi)
232 #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
233 #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
235 #define BOOTENV_RUN_SCSI_INIT
236 #define BOOTENV_SET_SCSI_NEED_INIT
237 #define BOOTENV_SHARED_SCSI
238 #define BOOTENV_DEV_SCSI \
239 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
240 #define BOOTENV_DEV_NAME_SCSI \
241 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
245 #define BOOTENV_RUN_IDE_INIT "run ide_init; "
246 #define BOOTENV_SET_IDE_NEED_INIT "setenv ide_need_init; "
247 #define BOOTENV_SHARED_IDE \
249 "if ${ide_need_init}; then " \
250 "setenv ide_need_init false; " \
255 BOOTENV_RUN_IDE_INIT \
256 BOOTENV_SHARED_BLKDEV_BODY(ide)
257 #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
258 #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
260 #define BOOTENV_RUN_IDE_INIT
261 #define BOOTENV_SET_IDE_NEED_INIT
262 #define BOOTENV_SHARED_IDE
263 #define BOOTENV_DEV_IDE \
264 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
265 #define BOOTENV_DEV_NAME_IDE \
266 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
269 #if defined(CONFIG_PCI)
270 #define BOOTENV_RUN_PCI_ENUM "run boot_pci_enum; "
271 #define BOOTENV_SHARED_PCI \
272 "boot_pci_enum=pci enum\0"
274 #define BOOTENV_RUN_PCI_ENUM
275 #define BOOTENV_SHARED_PCI
278 #ifdef CONFIG_CMD_USB
279 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
280 #define BOOTENV_SHARED_USB \
281 "boot_net_usb_start=usb start\0" \
284 BOOTENV_SHARED_BLKDEV_BODY(usb)
285 #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
286 #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
288 #define BOOTENV_RUN_NET_USB_START
289 #define BOOTENV_SHARED_USB
290 #define BOOTENV_DEV_USB \
291 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
292 #define BOOTENV_DEV_NAME_USB \
293 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
296 #ifdef CONFIG_CMD_VIRTIO
297 #define BOOTENV_RUN_VIRTIO_INIT "run virtio_init; "
298 #define BOOTENV_SET_VIRTIO_NEED_INIT "virtio_need_init=; "
299 #define BOOTENV_SHARED_VIRTIO \
301 "if ${virtio_need_init}; then " \
302 "virtio_need_init=false; " \
307 BOOTENV_RUN_PCI_ENUM \
308 BOOTENV_RUN_VIRTIO_INIT \
309 BOOTENV_SHARED_BLKDEV_BODY(virtio)
310 #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
311 #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
313 #define BOOTENV_RUN_VIRTIO_INIT
314 #define BOOTENV_SET_VIRTIO_NEED_INIT
315 #define BOOTENV_SHARED_VIRTIO
316 #define BOOTENV_DEV_VIRTIO \
317 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
318 #define BOOTENV_DEV_NAME_VIRTIO \
319 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
322 #if defined(CONFIG_CMD_DHCP)
323 #if defined(CONFIG_EFI_LOADER)
324 /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
325 #if defined(CONFIG_ARM64) || defined(__aarch64__)
326 #define BOOTENV_EFI_PXE_ARCH "0xb"
327 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
328 #elif defined(CONFIG_ARM) || defined(__arm__)
329 #define BOOTENV_EFI_PXE_ARCH "0xa"
330 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
331 #elif defined(CONFIG_X86) || defined(__x86_64__)
332 #define BOOTENV_EFI_PXE_ARCH "0x7"
333 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
334 #elif defined(__i386__)
335 #define BOOTENV_EFI_PXE_ARCH "0x6"
336 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
337 #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
338 #define BOOTENV_EFI_PXE_ARCH "0x19"
339 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
340 #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
341 #define BOOTENV_EFI_PXE_ARCH "0x1b"
342 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
343 #elif defined(CONFIG_SANDBOX)
344 # error "sandbox EFI support is only supported on ARM and x86"
346 #error Please specify an EFI client identifier
350 * Ask the dhcp server for an EFI binary. If we get one, check for a
351 * device tree in the same folder. Then boot everything. If the file was
352 * not an EFI binary, we just return from the bootefi command and continue.
354 #define BOOTENV_EFI_RUN_DHCP \
355 "setenv efi_fdtfile ${fdtfile}; " \
356 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
357 "setenv efi_old_vci ${bootp_vci};" \
358 "setenv efi_old_arch ${bootp_arch};" \
359 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
360 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
361 "if dhcp ${kernel_addr_r}; then " \
362 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
363 "if fdt addr ${fdt_addr_r}; then " \
364 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
366 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
369 "setenv bootp_vci ${efi_old_vci};" \
370 "setenv bootp_arch ${efi_old_arch};" \
371 "setenv efi_fdtfile;" \
372 "setenv efi_old_arch;" \
373 "setenv efi_old_vci;"
375 #define BOOTENV_EFI_RUN_DHCP
377 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
379 "devtype=" #devtypel "; " \
380 BOOTENV_RUN_NET_USB_START \
381 BOOTENV_RUN_PCI_ENUM \
382 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
383 "source ${scriptaddr}; " \
385 BOOTENV_EFI_RUN_DHCP \
387 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
390 #define BOOTENV_DEV_DHCP \
391 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
392 #define BOOTENV_DEV_NAME_DHCP \
393 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
396 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
397 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
399 BOOTENV_RUN_NET_USB_START \
400 BOOTENV_RUN_PCI_ENUM \
402 "if pxe get; then " \
405 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
408 #define BOOTENV_DEV_PXE \
409 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
410 #define BOOTENV_DEV_NAME_PXE \
411 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
414 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
415 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
416 #define BOOTENV_BOOT_TARGETS \
417 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
419 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
420 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
422 BOOTENV_SHARED_HOST \
426 BOOTENV_SHARED_SATA \
427 BOOTENV_SHARED_SCSI \
428 BOOTENV_SHARED_NVME \
430 BOOTENV_SHARED_UBIFS \
432 BOOTENV_SHARED_VIRTIO \
433 "boot_prefixes=/ /boot/\0" \
434 "boot_scripts=boot.scr.uimg boot.scr\0" \
435 "boot_script_dhcp=boot.scr.uimg\0" \
436 BOOTENV_BOOT_TARGETS \
438 "boot_syslinux_conf=extlinux/extlinux.conf\0" \
440 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
441 "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
443 "scan_dev_for_extlinux=" \
444 "if test -e ${devtype} " \
445 "${devnum}:${distro_bootpart} " \
446 "${prefix}${boot_syslinux_conf}; then " \
447 "echo Found ${prefix}${boot_syslinux_conf}; " \
448 "run boot_extlinux; " \
449 "echo SCRIPT FAILED: continuing...; " \
453 "load ${devtype} ${devnum}:${distro_bootpart} " \
454 "${scriptaddr} ${prefix}${script}; " \
455 "source ${scriptaddr}\0" \
457 "scan_dev_for_scripts=" \
458 "for script in ${boot_scripts}; do " \
459 "if test -e ${devtype} " \
460 "${devnum}:${distro_bootpart} " \
461 "${prefix}${script}; then " \
462 "echo Found U-Boot script " \
463 "${prefix}${script}; " \
464 "run boot_a_script; " \
465 "echo SCRIPT FAILED: continuing...; " \
469 "scan_dev_for_boot=" \
470 "echo Scanning ${devtype} " \
471 "${devnum}:${distro_bootpart}...; " \
472 "for prefix in ${boot_prefixes}; do " \
473 "run scan_dev_for_extlinux; " \
474 "run scan_dev_for_scripts; " \
479 "scan_dev_for_boot_part=" \
480 "part list ${devtype} ${devnum} -bootable devplist; " \
481 "env exists devplist || setenv devplist 1; " \
482 "for distro_bootpart in ${devplist}; do " \
483 "if fstype ${devtype} " \
484 "${devnum}:${distro_bootpart} " \
485 "bootfstype; then " \
486 "run scan_dev_for_boot; " \
489 "setenv devplist\0" \
491 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
493 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
494 BOOTENV_SET_NVME_NEED_INIT \
495 BOOTENV_SET_IDE_NEED_INIT \
496 BOOTENV_SET_VIRTIO_NEED_INIT \
497 "for target in ${boot_targets}; do " \
498 "run bootcmd_${target}; " \
501 #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */