xref: /rk3399_rockchip-uboot/include/config_distro_bootcmd.h (revision 1c39809b92c217877e160ee91a82743c9d4f3ed1)
1 /*
2  * (C) Copyright 2014
3  * NVIDIA Corporation <www.nvidia.com>
4  *
5  * Copyright 2014 Red Hat, Inc.
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  */
9 
10 #ifndef _CONFIG_CMD_DISTRO_BOOTCMD_H
11 #define _CONFIG_CMD_DISTRO_BOOTCMD_H
12 
13 /*
14  * A note on error handling: It is possible for BOOT_TARGET_DEVICES to
15  * reference a device that is not enabled in the U-Boot configuration, e.g.
16  * it may include MMC in the list without CONFIG_CMD_MMC being enabled. Given
17  * that BOOT_TARGET_DEVICES is a macro that's expanded by the C pre-processor
18  * at compile time, it's not  possible to detect and report such problems via
19  * a simple #ifdef/#error combination. Still, the code needs to report errors.
20  * The best way I've found to do this is to make BOOT_TARGET_DEVICES expand to
21  * reference a non-existent symbol, and have the name of that symbol encode
22  * the error message. Consequently, this file contains references to e.g.
23  * BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC. Given the
24  * prevalence of capitals here, this looks like a pre-processor macro and
25  * hence seems like it should be all capitals, but it's really an error
26  * message that includes some other pre-processor symbols in the text.
27  */
28 
29 /* We need the part command */
30 #define CONFIG_PARTITION_UUIDS
31 #define CONFIG_CMD_PART
32 
33 #define BOOTENV_SHARED_BLKDEV_BODY(devtypel) \
34 		"if " #devtypel " dev ${devnum}; then " \
35 			"setenv devtype " #devtypel "; " \
36 			"run scan_dev_for_boot_part; " \
37 		"fi\0"
38 
39 #define BOOTENV_SHARED_BLKDEV(devtypel) \
40 	#devtypel "_boot=" \
41 	BOOTENV_SHARED_BLKDEV_BODY(devtypel)
42 
43 #define BOOTENV_DEV_BLKDEV(devtypeu, devtypel, instance) \
44 	"bootcmd_" #devtypel #instance "=" \
45 		"setenv devnum " #instance "; " \
46 		"run " #devtypel "_boot\0"
47 
48 #define BOOTENV_DEV_NAME_BLKDEV(devtypeu, devtypel, instance) \
49 	#devtypel #instance " "
50 
51 #ifdef CONFIG_SANDBOX
52 #define BOOTENV_SHARED_HOST	BOOTENV_SHARED_BLKDEV(host)
53 #define BOOTENV_DEV_HOST	BOOTENV_DEV_BLKDEV
54 #define BOOTENV_DEV_NAME_HOST	BOOTENV_DEV_NAME_BLKDEV
55 #else
56 #define BOOTENV_SHARED_HOST
57 #define BOOTENV_DEV_HOST \
58 	BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
59 #define BOOTENV_DEV_NAME_HOST \
60 	BOOT_TARGET_DEVICES_references_HOST_without_CONFIG_SANDBOX
61 #endif
62 
63 #ifdef CONFIG_CMD_MMC
64 #define BOOTENV_SHARED_MMC	BOOTENV_SHARED_BLKDEV(mmc)
65 #define BOOTENV_DEV_MMC		BOOTENV_DEV_BLKDEV
66 #define BOOTENV_DEV_NAME_MMC	BOOTENV_DEV_NAME_BLKDEV
67 #else
68 #define BOOTENV_SHARED_MMC
69 #define BOOTENV_DEV_MMC \
70 	BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
71 #define BOOTENV_DEV_NAME_MMC \
72 	BOOT_TARGET_DEVICES_references_MMC_without_CONFIG_CMD_MMC
73 #endif
74 
75 #ifdef CONFIG_CMD_UBIFS
76 #define BOOTENV_SHARED_UBIFS \
77 	"ubifs_boot=" \
78 		"if ubi part UBI && ubifsmount ubi${devnum}:boot; then "  \
79 			"setenv devtype ubi; "                            \
80 			"setenv bootpart 0; "                             \
81 			"run scan_dev_for_boot; "                         \
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 
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 #endif
99 #endif
100 
101 #ifdef BOOTEFI_NAME
102 #define BOOTENV_SHARED_EFI                                                \
103 	"boot_efi_binary="                                                \
104 		"load ${devtype} ${devnum}:${distro_bootpart} "           \
105 			"${kernel_addr_r} efi/boot/"BOOTEFI_NAME"; "      \
106 		"if fdt addr ${fdt_addr_r}; then "                        \
107 			"bootefi ${kernel_addr_r} ${fdt_addr_r};"         \
108 		"else"                                                    \
109 			"bootefi ${kernel_addr_r} ${fdtcontroladdr};"     \
110 		"fi\0"                                                    \
111 	\
112 	"load_efi_dtb="                                                   \
113 		"load ${devtype} ${devnum}:${distro_bootpart} "           \
114 			"${fdt_addr_r} ${prefix}${fdtfile}\0"             \
115 	\
116 	"efi_dtb_prefixes=/ /dtb/ /dtb/current/\0"                        \
117 	"scan_dev_for_efi="                                               \
118 		"for prefix in ${efi_dtb_prefixes}; do "                  \
119 			"if test -e ${devtype} "                          \
120 					"${devnum}:${distro_bootpart} "   \
121 					"${prefix}${fdtfile}; then "      \
122 				"run load_efi_dtb; "                      \
123 			"fi;"                                             \
124 		"done;"                                                   \
125 		"if test -e ${devtype} ${devnum}:${distro_bootpart} "     \
126 					"efi/boot/"BOOTEFI_NAME"; then "  \
127 				"echo Found EFI removable media binary "  \
128 					"efi/boot/"BOOTEFI_NAME"; "       \
129 				"run boot_efi_binary; "                   \
130 				"echo EFI LOAD FAILED: continuing...; "   \
131 		"fi; \0"
132 #define SCAN_DEV_FOR_EFI "run scan_dev_for_efi;"
133 #else
134 #define BOOTENV_SHARED_EFI
135 #define SCAN_DEV_FOR_EFI
136 #endif
137 
138 #ifdef CONFIG_CMD_SATA
139 #define BOOTENV_SHARED_SATA	BOOTENV_SHARED_BLKDEV(sata)
140 #define BOOTENV_DEV_SATA	BOOTENV_DEV_BLKDEV
141 #define BOOTENV_DEV_NAME_SATA	BOOTENV_DEV_NAME_BLKDEV
142 #else
143 #define BOOTENV_SHARED_SATA
144 #define BOOTENV_DEV_SATA \
145 	BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_CMD_SATA
146 #define BOOTENV_DEV_NAME_SATA \
147 	BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_CMD_SATA
148 #endif
149 
150 #ifdef CONFIG_CMD_SCSI
151 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
152 #define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
153 #define BOOTENV_SHARED_SCSI \
154 	"scsi_init=" \
155 		"if ${scsi_need_init}; then " \
156 			"setenv scsi_need_init false; " \
157 			"scsi scan; " \
158 		"fi\0" \
159 	\
160 	"scsi_boot=" \
161 		BOOTENV_RUN_SCSI_INIT \
162 		BOOTENV_SHARED_BLKDEV_BODY(scsi)
163 #define BOOTENV_DEV_SCSI	BOOTENV_DEV_BLKDEV
164 #define BOOTENV_DEV_NAME_SCSI	BOOTENV_DEV_NAME_BLKDEV
165 #else
166 #define BOOTENV_RUN_SCSI_INIT
167 #define BOOTENV_SET_SCSI_NEED_INIT
168 #define BOOTENV_SHARED_SCSI
169 #define BOOTENV_DEV_SCSI \
170 	BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_CMD_SCSI
171 #define BOOTENV_DEV_NAME_SCSI \
172 	BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_CMD_SCSI
173 #endif
174 
175 #ifdef CONFIG_CMD_IDE
176 #define BOOTENV_SHARED_IDE	BOOTENV_SHARED_BLKDEV(ide)
177 #define BOOTENV_DEV_IDE		BOOTENV_DEV_BLKDEV
178 #define BOOTENV_DEV_NAME_IDE	BOOTENV_DEV_NAME_BLKDEV
179 #else
180 #define BOOTENV_SHARED_IDE
181 #define BOOTENV_DEV_IDE \
182 	BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_CMD_IDE
183 #define BOOTENV_DEV_NAME_IDE \
184 	BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_CMD_IDE
185 #endif
186 
187 #if defined(CONFIG_CMD_PCI_ENUM) || defined(CONFIG_DM_PCI)
188 #define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
189 #define BOOTENV_SHARED_PCI \
190 	"boot_net_pci_enum=pci enum\0"
191 #else
192 #define BOOTENV_RUN_NET_PCI_ENUM
193 #define BOOTENV_SHARED_PCI
194 #endif
195 
196 #ifdef CONFIG_CMD_USB
197 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
198 #define BOOTENV_SHARED_USB \
199 	"boot_net_usb_start=usb start\0" \
200 	"usb_boot=" \
201 		"usb start; " \
202 		BOOTENV_SHARED_BLKDEV_BODY(usb)
203 #define BOOTENV_DEV_USB		BOOTENV_DEV_BLKDEV
204 #define BOOTENV_DEV_NAME_USB	BOOTENV_DEV_NAME_BLKDEV
205 #else
206 #define BOOTENV_RUN_NET_USB_START
207 #define BOOTENV_SHARED_USB
208 #define BOOTENV_DEV_USB \
209 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
210 #define BOOTENV_DEV_NAME_USB \
211 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
212 #endif
213 
214 #if defined(CONFIG_CMD_DHCP)
215 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
216 	"bootcmd_dhcp=" \
217 		BOOTENV_RUN_NET_USB_START \
218 		BOOTENV_RUN_NET_PCI_ENUM \
219 		"if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
220 			"source ${scriptaddr}; " \
221 		"fi\0"
222 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
223 	"dhcp "
224 #else
225 #define BOOTENV_DEV_DHCP \
226 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
227 #define BOOTENV_DEV_NAME_DHCP \
228 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
229 #endif
230 
231 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
232 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
233 	"bootcmd_pxe=" \
234 		BOOTENV_RUN_NET_USB_START \
235 		BOOTENV_RUN_NET_PCI_ENUM \
236 		"dhcp; " \
237 		"if pxe get; then " \
238 			"pxe boot; " \
239 		"fi\0"
240 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
241 	"pxe "
242 #else
243 #define BOOTENV_DEV_PXE \
244 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
245 #define BOOTENV_DEV_NAME_PXE \
246 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
247 #endif
248 
249 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
250 	BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
251 #define BOOTENV_BOOT_TARGETS \
252 	"boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
253 
254 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
255 	BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
256 #define BOOTENV \
257 	BOOTENV_SHARED_HOST \
258 	BOOTENV_SHARED_MMC \
259 	BOOTENV_SHARED_PCI \
260 	BOOTENV_SHARED_USB \
261 	BOOTENV_SHARED_SATA \
262 	BOOTENV_SHARED_SCSI \
263 	BOOTENV_SHARED_IDE \
264 	BOOTENV_SHARED_UBIFS \
265 	BOOTENV_SHARED_EFI \
266 	"boot_prefixes=/ /boot/\0" \
267 	"boot_scripts=boot.scr.uimg boot.scr\0" \
268 	"boot_script_dhcp=boot.scr.uimg\0" \
269 	BOOTENV_BOOT_TARGETS \
270 	\
271 	"boot_extlinux="                                                  \
272 		"sysboot ${devtype} ${devnum}:${distro_bootpart} any "    \
273 			"${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
274 	\
275 	"scan_dev_for_extlinux="                                          \
276 		"if test -e ${devtype} "                                  \
277 				"${devnum}:${distro_bootpart} "           \
278 				"${prefix}extlinux/extlinux.conf; then "  \
279 			"echo Found ${prefix}extlinux/extlinux.conf; "    \
280 			"run boot_extlinux; "                             \
281 			"echo SCRIPT FAILED: continuing...; "             \
282 		"fi\0"                                                    \
283 	\
284 	"boot_a_script="                                                  \
285 		"load ${devtype} ${devnum}:${distro_bootpart} "           \
286 			"${scriptaddr} ${prefix}${script}; "              \
287 		"source ${scriptaddr}\0"                                  \
288 	\
289 	"scan_dev_for_scripts="                                           \
290 		"for script in ${boot_scripts}; do "                      \
291 			"if test -e ${devtype} "                          \
292 					"${devnum}:${distro_bootpart} "   \
293 					"${prefix}${script}; then "       \
294 				"echo Found U-Boot script "               \
295 					"${prefix}${script}; "            \
296 				"run boot_a_script; "                     \
297 				"echo SCRIPT FAILED: continuing...; "     \
298 			"fi; "                                            \
299 		"done\0"                                                  \
300 	\
301 	"scan_dev_for_boot="                                              \
302 		"echo Scanning ${devtype} "                               \
303 				"${devnum}:${distro_bootpart}...; "       \
304 		"for prefix in ${boot_prefixes}; do "                     \
305 			"run scan_dev_for_extlinux; "                     \
306 			"run scan_dev_for_scripts; "                      \
307 		"done;"                                                   \
308 		SCAN_DEV_FOR_EFI                                          \
309 		"\0"                                                      \
310 	\
311 	"scan_dev_for_boot_part="                                         \
312 		"part list ${devtype} ${devnum} -bootable devplist; "     \
313 		"env exists devplist || setenv devplist 1; "              \
314 		"for distro_bootpart in ${devplist}; do "                 \
315 			"if fstype ${devtype} "                           \
316 					"${devnum}:${distro_bootpart} "   \
317 					"bootfstype; then "               \
318 				"run scan_dev_for_boot; "                 \
319 			"fi; "                                            \
320 		"done\0"                                                  \
321 	\
322 	BOOT_TARGET_DEVICES(BOOTENV_DEV)                                  \
323 	\
324 	"distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT                      \
325 		"for target in ${boot_targets}; do "                      \
326 			"run bootcmd_${target}; "                         \
327 		"done\0"
328 
329 #ifndef CONFIG_BOOTCOMMAND
330 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
331 #endif
332 
333 #endif  /* _CONFIG_CMD_DISTRO_BOOTCMD_H */
334