]> git.ipfire.org Git - thirdparty/u-boot.git/blame - include/config_distro_bootcmd.h
rtc: pl031: convert the driver to driver model
[thirdparty/u-boot.git] / include / config_distro_bootcmd.h
CommitLineData
83d290c5 1/* SPDX-License-Identifier: GPL-2.0+ */
2a43201a
DG
2/*
3 * (C) Copyright 2014
4 * NVIDIA Corporation <www.nvidia.com>
5 *
6 * Copyright 2014 Red Hat, Inc.
2a43201a
DG
7 */
8
9#ifndef _CONFIG_CMD_DISTRO_BOOTCMD_H
10#define _CONFIG_CMD_DISTRO_BOOTCMD_H
11
90b7caaf
SW
12/*
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.
26 */
27
2a43201a
DG
28#define BOOTENV_SHARED_BLKDEV_BODY(devtypel) \
29 "if " #devtypel " dev ${devnum}; then " \
30 "setenv devtype " #devtypel "; " \
735b1cfe 31 "run scan_dev_for_boot_part; " \
2a43201a
DG
32 "fi\0"
33
34#define BOOTENV_SHARED_BLKDEV(devtypel) \
35 #devtypel "_boot=" \
36 BOOTENV_SHARED_BLKDEV_BODY(devtypel)
37
38#define BOOTENV_DEV_BLKDEV(devtypeu, devtypel, instance) \
39 "bootcmd_" #devtypel #instance "=" \
40 "setenv devnum " #instance "; " \
41 "run " #devtypel "_boot\0"
42
43#define BOOTENV_DEV_NAME_BLKDEV(devtypeu, devtypel, instance) \
44 #devtypel #instance " "
45
d0bce0d1
SS
46#ifdef CONFIG_SANDBOX
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
50#else
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
56#endif
57
2a43201a
DG
58#ifdef CONFIG_CMD_MMC
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
62#else
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
68#endif
69
40d21547
RS
70#ifdef CONFIG_CMD_UBIFS
71#define BOOTENV_SHARED_UBIFS \
72 "ubifs_boot=" \
6e1364fe
DW
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}; " \
79 "then " \
80 "setenv devtype ubi; " \
81 "run scan_dev_for_boot; " \
40d21547
RS
82 "fi\0"
83#define BOOTENV_DEV_UBIFS BOOTENV_DEV_BLKDEV
84#define BOOTENV_DEV_NAME_UBIFS BOOTENV_DEV_NAME_BLKDEV
85#else
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
91#endif
92
74522c89
AG
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"
a53fbf40
HS
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"
2c6903fa
AG
102#elif defined(CONFIG_CPU_RISCV_32)
103#define BOOTEFI_NAME "bootriscv32.efi"
104#elif defined(CONFIG_CPU_RISCV_64)
105#define BOOTEFI_NAME "bootriscv64.efi"
74522c89
AG
106#endif
107#endif
108
109#ifdef BOOTEFI_NAME
ff2545ab
AG
110#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64)
111/*
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.
115 */
116#define BOOTENV_EFI_SET_FDTFILE_FALLBACK \
117 "if test -z \"${fdtfile}\" -a -n \"${soc}\"; then " \
118 "setenv efi_fdtfile ${soc}-${board}${boardver}.dtb; " \
119 "fi; "
120#else
121#define BOOTENV_EFI_SET_FDTFILE_FALLBACK
122#endif
123
124
74522c89
AG
125#define BOOTENV_SHARED_EFI \
126 "boot_efi_binary=" \
9975fe96
RC
127 "if fdt addr ${fdt_addr_r}; then " \
128 "bootefi bootmgr ${fdt_addr_r};" \
129 "else " \
130 "bootefi bootmgr ${fdtcontroladdr};" \
131 "fi;" \
74522c89
AG
132 "load ${devtype} ${devnum}:${distro_bootpart} " \
133 "${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; " \
1c39809b
AG
134 "if fdt addr ${fdt_addr_r}; then " \
135 "bootefi ${kernel_addr_r} ${fdt_addr_r};" \
6e1364fe 136 "else " \
1c39809b
AG
137 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
138 "fi\0" \
74522c89
AG
139 \
140 "load_efi_dtb=" \
141 "load ${devtype} ${devnum}:${distro_bootpart} " \
ff2545ab 142 "${fdt_addr_r} ${prefix}${efi_fdtfile}\0" \
74522c89
AG
143 \
144 "efi_dtb_prefixes=/ /dtb/ /dtb/current/\0" \
145 "scan_dev_for_efi=" \
ff2545ab
AG
146 "setenv efi_fdtfile ${fdtfile}; " \
147 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
74522c89
AG
148 "for prefix in ${efi_dtb_prefixes}; do " \
149 "if test -e ${devtype} " \
150 "${devnum}:${distro_bootpart} " \
ff2545ab 151 "${prefix}${efi_fdtfile}; then " \
74522c89
AG
152 "run load_efi_dtb; " \
153 "fi;" \
154 "done;" \
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...; " \
ff2545ab
AG
161 "fi; " \
162 "setenv efi_fdtfile\0"
74522c89
AG
163#define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
164#else
165#define BOOTENV_SHARED_EFI
166#define SCAN_DEV_FOR_EFI
167#endif
168
10e40d54 169#ifdef CONFIG_SATA
2a43201a
DG
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
173#else
174#define BOOTENV_SHARED_SATA
175#define BOOTENV_DEV_SATA \
10e40d54 176 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
2a43201a 177#define BOOTENV_DEV_NAME_SATA \
10e40d54 178 BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_SATA
2a43201a
DG
179#endif
180
c649e3c9 181#ifdef CONFIG_SCSI
a03bdaa1
HG
182#define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
183#define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
184#define BOOTENV_SHARED_SCSI \
185 "scsi_init=" \
186 "if ${scsi_need_init}; then " \
187 "setenv scsi_need_init false; " \
188 "scsi scan; " \
189 "fi\0" \
190 \
191 "scsi_boot=" \
192 BOOTENV_RUN_SCSI_INIT \
193 BOOTENV_SHARED_BLKDEV_BODY(scsi)
2a43201a
DG
194#define BOOTENV_DEV_SCSI BOOTENV_DEV_BLKDEV
195#define BOOTENV_DEV_NAME_SCSI BOOTENV_DEV_NAME_BLKDEV
196#else
a03bdaa1
HG
197#define BOOTENV_RUN_SCSI_INIT
198#define BOOTENV_SET_SCSI_NEED_INIT
2a43201a
DG
199#define BOOTENV_SHARED_SCSI
200#define BOOTENV_DEV_SCSI \
c649e3c9 201 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
2a43201a 202#define BOOTENV_DEV_NAME_SCSI \
c649e3c9 203 BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_SCSI
2a43201a
DG
204#endif
205
fc843a02 206#ifdef CONFIG_IDE
2a43201a
DG
207#define BOOTENV_SHARED_IDE BOOTENV_SHARED_BLKDEV(ide)
208#define BOOTENV_DEV_IDE BOOTENV_DEV_BLKDEV
209#define BOOTENV_DEV_NAME_IDE BOOTENV_DEV_NAME_BLKDEV
210#else
211#define BOOTENV_SHARED_IDE
212#define BOOTENV_DEV_IDE \
fc843a02 213 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
2a43201a 214#define BOOTENV_DEV_NAME_IDE \
fc843a02 215 BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_IDE
2a43201a
DG
216#endif
217
18642424 218#if defined(CONFIG_DM_PCI)
986691fb
SW
219#define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
220#define BOOTENV_SHARED_PCI \
221 "boot_net_pci_enum=pci enum\0"
222#else
223#define BOOTENV_RUN_NET_PCI_ENUM
224#define BOOTENV_SHARED_PCI
225#endif
226
2a43201a 227#ifdef CONFIG_CMD_USB
3483b75d 228#define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
2a43201a 229#define BOOTENV_SHARED_USB \
3483b75d 230 "boot_net_usb_start=usb start\0" \
2a43201a 231 "usb_boot=" \
3483b75d 232 "usb start; " \
2a43201a
DG
233 BOOTENV_SHARED_BLKDEV_BODY(usb)
234#define BOOTENV_DEV_USB BOOTENV_DEV_BLKDEV
235#define BOOTENV_DEV_NAME_USB BOOTENV_DEV_NAME_BLKDEV
236#else
3483b75d 237#define BOOTENV_RUN_NET_USB_START
2a43201a
DG
238#define BOOTENV_SHARED_USB
239#define BOOTENV_DEV_USB \
240 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
241#define BOOTENV_DEV_NAME_USB \
242 BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
243#endif
244
245#if defined(CONFIG_CMD_DHCP)
20898ea9 246#if defined(CONFIG_EFI_LOADER)
2c6903fa 247/* http://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml */
a4958a71 248#if defined(CONFIG_ARM64) || defined(__aarch64__)
20898ea9
AG
249#define BOOTENV_EFI_PXE_ARCH "0xb"
250#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00011:UNDI:003000"
a4958a71 251#elif defined(CONFIG_ARM) || defined(__arm__)
20898ea9
AG
252#define BOOTENV_EFI_PXE_ARCH "0xa"
253#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00010:UNDI:003000"
a4958a71 254#elif defined(CONFIG_X86) || defined(__x86_64__)
20898ea9
AG
255#define BOOTENV_EFI_PXE_ARCH "0x7"
256#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00007:UNDI:003000"
a4958a71
SG
257#elif defined(__i386__)
258#define BOOTENV_EFI_PXE_ARCH "0x6"
259#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00006:UNDI:003000"
260#elif defined(CONFIG_CPU_RISCV_32) || ((defined(__riscv) && __riscv_xlen == 32))
2c6903fa
AG
261#define BOOTENV_EFI_PXE_ARCH "0x19"
262#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00025:UNDI:003000"
a4958a71 263#elif defined(CONFIG_CPU_RISCV_64) || ((defined(__riscv) && __riscv_xlen == 64))
2c6903fa
AG
264#define BOOTENV_EFI_PXE_ARCH "0x1b"
265#define BOOTENV_EFI_PXE_VCI "PXEClient:Arch:00027:UNDI:003000"
a4958a71
SG
266#elif defined(CONFIG_SANDBOX)
267# error "sandbox EFI support is only supported on ARM and x86"
20898ea9
AG
268#else
269#error Please specify an EFI client identifier
270#endif
271
272/*
273 * Ask the dhcp server for an EFI binary. If we get one, check for a
274 * device tree in the same folder. Then boot everything. If the file was
275 * not an EFI binary, we just return from the bootefi command and continue.
276 */
277#define BOOTENV_EFI_RUN_DHCP \
278 "setenv efi_fdtfile ${fdtfile}; " \
279 BOOTENV_EFI_SET_FDTFILE_FALLBACK \
280 "setenv efi_old_vci ${bootp_vci};" \
281 "setenv efi_old_arch ${bootp_arch};" \
282 "setenv bootp_vci " BOOTENV_EFI_PXE_VCI ";" \
283 "setenv bootp_arch " BOOTENV_EFI_PXE_ARCH ";" \
284 "if dhcp ${kernel_addr_r}; then " \
285 "tftpboot ${fdt_addr_r} dtb/${efi_fdtfile};" \
286 "if fdt addr ${fdt_addr_r}; then " \
287 "bootefi ${kernel_addr_r} ${fdt_addr_r}; " \
288 "else " \
289 "bootefi ${kernel_addr_r} ${fdtcontroladdr};" \
290 "fi;" \
291 "fi;" \
292 "setenv bootp_vci ${efi_old_vci};" \
293 "setenv bootp_arch ${efi_old_arch};" \
294 "setenv efi_fdtfile;" \
295 "setenv efi_old_arch;" \
296 "setenv efi_old_vci;"
297#else
298#define BOOTENV_EFI_RUN_DHCP
299#endif
2a43201a
DG
300#define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
301 "bootcmd_dhcp=" \
3483b75d 302 BOOTENV_RUN_NET_USB_START \
986691fb 303 BOOTENV_RUN_NET_PCI_ENUM \
cc11b392 304 "if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
2a43201a 305 "source ${scriptaddr}; " \
20898ea9
AG
306 "fi;" \
307 BOOTENV_EFI_RUN_DHCP \
308 "\0"
2a43201a
DG
309#define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
310 "dhcp "
311#else
312#define BOOTENV_DEV_DHCP \
313 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
314#define BOOTENV_DEV_NAME_DHCP \
315 BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
316#endif
317
318#if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
319#define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
320 "bootcmd_pxe=" \
3483b75d 321 BOOTENV_RUN_NET_USB_START \
986691fb 322 BOOTENV_RUN_NET_PCI_ENUM \
2a43201a
DG
323 "dhcp; " \
324 "if pxe get; then " \
325 "pxe boot; " \
326 "fi\0"
327#define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
328 "pxe "
329#else
330#define BOOTENV_DEV_PXE \
331 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
332#define BOOTENV_DEV_NAME_PXE \
333 BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
334#endif
335
336#define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
337 BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
338#define BOOTENV_BOOT_TARGETS \
339 "boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
340
341#define BOOTENV_DEV(devtypeu, devtypel, instance) \
342 BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
343#define BOOTENV \
d0bce0d1 344 BOOTENV_SHARED_HOST \
2a43201a 345 BOOTENV_SHARED_MMC \
986691fb 346 BOOTENV_SHARED_PCI \
2a43201a
DG
347 BOOTENV_SHARED_USB \
348 BOOTENV_SHARED_SATA \
349 BOOTENV_SHARED_SCSI \
350 BOOTENV_SHARED_IDE \
40d21547 351 BOOTENV_SHARED_UBIFS \
74522c89 352 BOOTENV_SHARED_EFI \
2a43201a
DG
353 "boot_prefixes=/ /boot/\0" \
354 "boot_scripts=boot.scr.uimg boot.scr\0" \
cc11b392 355 "boot_script_dhcp=boot.scr.uimg\0" \
2a43201a 356 BOOTENV_BOOT_TARGETS \
2a43201a
DG
357 \
358 "boot_extlinux=" \
59d03cb3 359 "sysboot ${devtype} ${devnum}:${distro_bootpart} any " \
2a43201a
DG
360 "${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
361 \
362 "scan_dev_for_extlinux=" \
59d03cb3
SS
363 "if test -e ${devtype} " \
364 "${devnum}:${distro_bootpart} " \
2a43201a
DG
365 "${prefix}extlinux/extlinux.conf; then " \
366 "echo Found ${prefix}extlinux/extlinux.conf; " \
367 "run boot_extlinux; " \
368 "echo SCRIPT FAILED: continuing...; " \
369 "fi\0" \
370 \
371 "boot_a_script=" \
59d03cb3 372 "load ${devtype} ${devnum}:${distro_bootpart} " \
2a43201a
DG
373 "${scriptaddr} ${prefix}${script}; " \
374 "source ${scriptaddr}\0" \
375 \
376 "scan_dev_for_scripts=" \
377 "for script in ${boot_scripts}; do " \
59d03cb3
SS
378 "if test -e ${devtype} " \
379 "${devnum}:${distro_bootpart} " \
2a43201a
DG
380 "${prefix}${script}; then " \
381 "echo Found U-Boot script " \
382 "${prefix}${script}; " \
383 "run boot_a_script; " \
384 "echo SCRIPT FAILED: continuing...; " \
385 "fi; " \
386 "done\0" \
387 \
388 "scan_dev_for_boot=" \
59d03cb3
SS
389 "echo Scanning ${devtype} " \
390 "${devnum}:${distro_bootpart}...; " \
2a43201a
DG
391 "for prefix in ${boot_prefixes}; do " \
392 "run scan_dev_for_extlinux; " \
393 "run scan_dev_for_scripts; " \
74522c89
AG
394 "done;" \
395 SCAN_DEV_FOR_EFI \
396 "\0" \
2a43201a 397 \
735b1cfe 398 "scan_dev_for_boot_part=" \
f643d929
SS
399 "part list ${devtype} ${devnum} -bootable devplist; " \
400 "env exists devplist || setenv devplist 1; " \
59d03cb3
SS
401 "for distro_bootpart in ${devplist}; do " \
402 "if fstype ${devtype} " \
403 "${devnum}:${distro_bootpart} " \
735b1cfe
SS
404 "bootfstype; then " \
405 "run scan_dev_for_boot; " \
406 "fi; " \
407 "done\0" \
408 \
2a43201a
DG
409 BOOT_TARGET_DEVICES(BOOTENV_DEV) \
410 \
453c6cc1 411 "distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT \
2a43201a
DG
412 "for target in ${boot_targets}; do " \
413 "run bootcmd_${target}; " \
414 "done\0"
415
453c6cc1
SS
416#ifndef CONFIG_BOOTCOMMAND
417#define CONFIG_BOOTCOMMAND "run distro_bootcmd"
418#endif
419
2a43201a 420#endif /* _CONFIG_CMD_DISTRO_BOOTCMD_H */