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
127 #define BOOTENV_SHARED_EFI \
128 "boot_efi_bootmgr=" \
129 "if fdt addr ${fdt_addr_r}; then " \
130 "bootefi bootmgr ${fdt_addr_r};" \
136 "load ${devtype} ${devnum}:${distro_bootpart} " \
137 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
138 "if fdt addr ${fdt_addr_r}; then " \
139 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
141 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
145 "load ${devtype} ${devnum}:${distro_bootpart} " \
146 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
148 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
149 "scan_dev_for_efi=" \
150 "setenv efi_fdtfile ${fdtfile}; " \
151 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
152 "for prefix in ${efi_dtb_prefixes}; do " \
153 "if test -e ${devtype} " \
154 "${devnum}:${distro_bootpart} " \
155 "${prefix}${efi_fdtfile}; then " \
156 "run load_efi_dtb; " \
159 "run boot_efi_bootmgr;" \
160 "if test -e ${devtype} ${devnum}:${distro_bootpart} " \
161 "efi/boot/"BOOTEFI_NAME"; then " \
162 "echo Found EFI removable media binary " \
163 "efi/boot/"BOOTEFI_NAME"; " \
164 "run boot_efi_binary; " \
165 "echo EFI LOAD FAILED: continuing...; " \
167 "setenv efi_fdtfile\0"
168 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
170 #define BOOTENV_SHARED_EFI
171 #define SCAN_DEV_FOR_EFI
175 #define BOOTENV_SHARED_SATA BOOTENV_SHARED_BLKDEV(sata)
176 #define BOOTENV_DEV_SATA BOOTENV_DEV_BLKDEV
177 #define BOOTENV_DEV_NAME_SATA BOOTENV_DEV_NAME_BLKDEV
179 #define BOOTENV_SHARED_SATA
180 #define BOOTENV_DEV_SATA \
181 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
182 #define BOOTENV_DEV_NAME_SATA \
183 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
187 #define BOOTENV_RUN_NVME_INIT "run nvme_init; "
188 #define BOOTENV_SET_NVME_NEED_INIT "setenv nvme_need_init; "
189 #define BOOTENV_SHARED_NVME \
191 "if ${nvme_need_init}; then " \
192 "setenv nvme_need_init false; " \
197 BOOTENV_RUN_PCI_ENUM \
198 BOOTENV_RUN_NVME_INIT \
199 BOOTENV_SHARED_BLKDEV_BODY(nvme)
200 #define BOOTENV_DEV_NVME BOOTENV_DEV_BLKDEV
201 #define BOOTENV_DEV_NAME_NVME BOOTENV_DEV_NAME_BLKDEV
203 #define BOOTENV_RUN_NVME_INIT
204 #define BOOTENV_SET_NVME_NEED_INIT
205 #define BOOTENV_SHARED_NVME
206 #define BOOTENV_DEV_NVME \
207 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
208 #define BOOTENV_DEV_NAME_NVME \
209 BOOT_TARGET_DEVICES_references_NVME_without_CONFIG_NVME
213 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
214 #define BOOTENV_SET_SCSI_NEED_INIT "scsi_need_init=; "
215 #define BOOTENV_SHARED_SCSI \
217 "if ${scsi_need_init}; then " \
218 "scsi_need_init=false; " \
223 BOOTENV_RUN_SCSI_INIT \
224 BOOTENV_SHARED_BLKDEV_BODY(scsi)
225 #define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
226 #define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
228 #define BOOTENV_RUN_SCSI_INIT
229 #define BOOTENV_SET_SCSI_NEED_INIT
230 #define BOOTENV_SHARED_SCSI
231 #define BOOTENV_DEV_SCSI \
232 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
233 #define BOOTENV_DEV_NAME_SCSI \
234 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
238 #define BOOTENV_RUN_IDE_INIT "run ide_init; "
239 #define BOOTENV_SET_IDE_NEED_INIT "setenv ide_need_init; "
240 #define BOOTENV_SHARED_IDE \
242 "if ${ide_need_init}; then " \
243 "setenv ide_need_init false; " \
248 BOOTENV_RUN_IDE_INIT \
249 BOOTENV_SHARED_BLKDEV_BODY(ide)
250 #define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
251 #define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
253 #define BOOTENV_RUN_IDE_INIT
254 #define BOOTENV_SET_IDE_NEED_INIT
255 #define BOOTENV_SHARED_IDE
256 #define BOOTENV_DEV_IDE \
257 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
258 #define BOOTENV_DEV_NAME_IDE \
259 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
262 #if defined(CONFIG_DM_PCI)
263 #define BOOTENV_RUN_PCI_ENUM "run boot_pci_enum; "
264 #define BOOTENV_SHARED_PCI \
265 "boot_pci_enum=pci enum\0"
267 #define BOOTENV_RUN_PCI_ENUM
268 #define BOOTENV_SHARED_PCI
271 #ifdef CONFIG_CMD_USB
272 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
273 #define BOOTENV_SHARED_USB \
274 "boot_net_usb_start=usb start\0" \
277 BOOTENV_SHARED_BLKDEV_BODY(usb)
278 #define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
279 #define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
281 #define BOOTENV_RUN_NET_USB_START
282 #define BOOTENV_SHARED_USB
283 #define BOOTENV_DEV_USB \
284 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
285 #define BOOTENV_DEV_NAME_USB \
286 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
289 #ifdef CONFIG_CMD_VIRTIO
290 #define BOOTENV_RUN_VIRTIO_INIT "run virtio_init; "
291 #define BOOTENV_SET_VIRTIO_NEED_INIT "virtio_need_init=; "
292 #define BOOTENV_SHARED_VIRTIO \
294 "if ${virtio_need_init}; then " \
295 "virtio_need_init=false; " \
300 BOOTENV_RUN_PCI_ENUM \
301 BOOTENV_RUN_VIRTIO_INIT \
302 BOOTENV_SHARED_BLKDEV_BODY(virtio)
303 #define BOOTENV_DEV_VIRTIO BOOTENV_DEV_BLKDEV
304 #define BOOTENV_DEV_NAME_VIRTIO BOOTENV_DEV_NAME_BLKDEV
306 #define BOOTENV_RUN_VIRTIO_INIT
307 #define BOOTENV_SET_VIRTIO_NEED_INIT
308 #define BOOTENV_SHARED_VIRTIO
309 #define BOOTENV_DEV_VIRTIO \
310 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
311 #define BOOTENV_DEV_NAME_VIRTIO \
312 BOOT_TARGET_DEVICES_references_VIRTIO_without_CONFIG_CMD_VIRTIO
315 #if defined(CONFIG_CMD_DHCP)
316 #if defined(CONFIG_EFI_LOADER)
317 /* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
318 #if defined(CONFIG_ARM64) || defined(__aarch64__)
319 #define BOOTENV_EFI_PXE_ARCH "0xb"
320 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
321 #elif defined(CONFIG_ARM) || defined(__arm__)
322 #define BOOTENV_EFI_PXE_ARCH "0xa"
323 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
324 #elif defined(CONFIG_X86) || defined(__x86_64__)
325 #define BOOTENV_EFI_PXE_ARCH "0x7"
326 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
327 #elif defined(__i386__)
328 #define BOOTENV_EFI_PXE_ARCH "0x6"
329 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
330 #elif defined(CONFIG_ARCH_RV32I) || ((defined(__riscv) && __riscv_xlen == 32))
331 #define BOOTENV_EFI_PXE_ARCH "0x19"
332 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
333 #elif defined(CONFIG_ARCH_RV64I) || ((defined(__riscv) && __riscv_xlen == 64))
334 #define BOOTENV_EFI_PXE_ARCH "0x1b"
335 #define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
336 #elif defined(CONFIG_SANDBOX)
337 # error "sandbox EFI support is only supported on ARM and x86"
339 #error Please specify an EFI client identifier
343 * Ask the dhcp server for an EFI binary. If we get one, check for a
344 * device tree in the same folder. Then boot everything. If the file was
345 * not an EFI binary, we just return from the bootefi command and continue.
347 #define BOOTENV_EFI_RUN_DHCP \
348 "setenv efi_fdtfile ${fdtfile}; " \
349 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
350 "setenv efi_old_vci ${bootp_vci};" \
351 "setenv efi_old_arch ${bootp_arch};" \
352 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
353 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
354 "if dhcp ${kernel_addr_r}; then " \
355 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
356 "if fdt addr ${fdt_addr_r}; then " \
357 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
359 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
362 "setenv bootp_vci ${efi_old_vci};" \
363 "setenv bootp_arch ${efi_old_arch};" \
364 "setenv efi_fdtfile;" \
365 "setenv efi_old_arch;" \
366 "setenv efi_old_vci;"
368 #define BOOTENV_EFI_RUN_DHCP
370 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
372 BOOTENV_RUN_NET_USB_START \
373 BOOTENV_RUN_PCI_ENUM \
374 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
375 "source ${scriptaddr}; " \
377 BOOTENV_EFI_RUN_DHCP \
379 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
382 #define BOOTENV_DEV_DHCP \
383 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
384 #define BOOTENV_DEV_NAME_DHCP \
385 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
388 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
389 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
391 BOOTENV_RUN_NET_USB_START \
392 BOOTENV_RUN_PCI_ENUM \
394 "if pxe get; then " \
397 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
400 #define BOOTENV_DEV_PXE \
401 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
402 #define BOOTENV_DEV_NAME_PXE \
403 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
406 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
407 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
408 #define BOOTENV_BOOT_TARGETS \
409 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
411 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
412 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
414 BOOTENV_SHARED_HOST \
418 BOOTENV_SHARED_SATA \
419 BOOTENV_SHARED_SCSI \
420 BOOTENV_SHARED_NVME \
422 BOOTENV_SHARED_UBIFS \
424 BOOTENV_SHARED_VIRTIO \
425 "boot_prefixes=/ /boot/\0" \
426 "boot_scripts=boot.scr.uimg boot.scr\0" \
427 "boot_script_dhcp=boot.scr.uimg\0" \
428 BOOTENV_BOOT_TARGETS \
430 "boot_syslinux_conf=extlinux/extlinux.conf\0" \
432 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
433 "${scriptaddr} ${prefix}${boot_syslinux_conf}\0" \
435 "scan_dev_for_extlinux=" \
436 "if test -e ${devtype} " \
437 "${devnum}:${distro_bootpart} " \
438 "${prefix}${boot_syslinux_conf}; then " \
439 "echo Found ${prefix}${boot_syslinux_conf}; " \
440 "run boot_extlinux; " \
441 "echo SCRIPT FAILED: continuing...; " \
445 "load ${devtype} ${devnum}:${distro_bootpart} " \
446 "${scriptaddr} ${prefix}${script}; " \
447 "source ${scriptaddr}\0" \
449 "scan_dev_for_scripts=" \
450 "for script in ${boot_scripts}; do " \
451 "if test -e ${devtype} " \
452 "${devnum}:${distro_bootpart} " \
453 "${prefix}${script}; then " \
454 "echo Found U-Boot script " \
455 "${prefix}${script}; " \
456 "run boot_a_script; " \
457 "echo SCRIPT FAILED: continuing...; " \
461 "scan_dev_for_boot=" \
462 "echo Scanning ${devtype} " \
463 "${devnum}:${distro_bootpart}...; " \
464 "for prefix in ${boot_prefixes}; do " \
465 "run scan_dev_for_extlinux; " \
466 "run scan_dev_for_scripts; " \
471 "scan_dev_for_boot_part=" \
472 "part list ${devtype} ${devnum} -bootable devplist; " \
473 "env exists devplist || setenv devplist 1; " \
474 "for distro_bootpart in ${devplist}; do " \
475 "if fstype ${devtype} " \
476 "${devnum}:${distro_bootpart} " \
477 "bootfstype; then " \
478 "run scan_dev_for_boot; " \
481 "setenv devplist\0" \
483 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
485 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
486 BOOTENV_SET_NVME_NEED_INIT \
487 BOOTENV_SET_IDE_NEED_INIT \
488 BOOTENV_SET_VIRTIO_NEED_INIT \
489 "for target in ${boot_targets}; do " \
490 "run bootcmd_${target}; " \
493 #ifndef CONFIG_BOOTCOMMAND
494 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
497 #endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */