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_CMD_SATA
94 #define BOOTENV_SHARED_SATA	BOOTENV_SHARED_BLKDEV(sata)
95 #define BOOTENV_DEV_SATA	BOOTENV_DEV_BLKDEV
96 #define BOOTENV_DEV_NAME_SATA	BOOTENV_DEV_NAME_BLKDEV
97 #else
98 #define BOOTENV_SHARED_SATA
99 #define BOOTENV_DEV_SATA \
100 	BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_CMD_SATA
101 #define BOOTENV_DEV_NAME_SATA \
102 	BOOT_TARGET_DEVICES_references_SATA_without_CONFIG_CMD_SATA
103 #endif
104 
105 #ifdef CONFIG_CMD_SCSI
106 #define BOOTENV_RUN_SCSI_INIT "run scsi_init; "
107 #define BOOTENV_SET_SCSI_NEED_INIT "setenv scsi_need_init; "
108 #define BOOTENV_SHARED_SCSI \
109 	"scsi_init=" \
110 		"if ${scsi_need_init}; then " \
111 			"setenv scsi_need_init false; " \
112 			"scsi scan; " \
113 		"fi\0" \
114 	\
115 	"scsi_boot=" \
116 		BOOTENV_RUN_SCSI_INIT \
117 		BOOTENV_SHARED_BLKDEV_BODY(scsi)
118 #define BOOTENV_DEV_SCSI	BOOTENV_DEV_BLKDEV
119 #define BOOTENV_DEV_NAME_SCSI	BOOTENV_DEV_NAME_BLKDEV
120 #else
121 #define BOOTENV_RUN_SCSI_INIT
122 #define BOOTENV_SET_SCSI_NEED_INIT
123 #define BOOTENV_SHARED_SCSI
124 #define BOOTENV_DEV_SCSI \
125 	BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_CMD_SCSI
126 #define BOOTENV_DEV_NAME_SCSI \
127 	BOOT_TARGET_DEVICES_references_SCSI_without_CONFIG_CMD_SCSI
128 #endif
129 
130 #ifdef CONFIG_CMD_IDE
131 #define BOOTENV_SHARED_IDE	BOOTENV_SHARED_BLKDEV(ide)
132 #define BOOTENV_DEV_IDE		BOOTENV_DEV_BLKDEV
133 #define BOOTENV_DEV_NAME_IDE	BOOTENV_DEV_NAME_BLKDEV
134 #else
135 #define BOOTENV_SHARED_IDE
136 #define BOOTENV_DEV_IDE \
137 	BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_CMD_IDE
138 #define BOOTENV_DEV_NAME_IDE \
139 	BOOT_TARGET_DEVICES_references_IDE_without_CONFIG_CMD_IDE
140 #endif
141 
142 #ifdef CONFIG_CMD_USB
143 #define BOOTENV_RUN_USB_INIT "usb start; "
144 #define BOOTENV_SHARED_USB \
145 	"usb_boot=" \
146 		BOOTENV_RUN_USB_INIT \
147 		BOOTENV_SHARED_BLKDEV_BODY(usb)
148 #define BOOTENV_DEV_USB		BOOTENV_DEV_BLKDEV
149 #define BOOTENV_DEV_NAME_USB	BOOTENV_DEV_NAME_BLKDEV
150 #else
151 #define BOOTENV_RUN_USB_INIT
152 #define BOOTENV_SHARED_USB
153 #define BOOTENV_DEV_USB \
154 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
155 #define BOOTENV_DEV_NAME_USB \
156 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
157 #endif
158 
159 #if defined(CONFIG_CMD_DHCP)
160 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
161 	"bootcmd_dhcp=" \
162 		BOOTENV_RUN_USB_INIT \
163 		"if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
164 			"source ${scriptaddr}; " \
165 		"fi\0"
166 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
167 	"dhcp "
168 #else
169 #define BOOTENV_DEV_DHCP \
170 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
171 #define BOOTENV_DEV_NAME_DHCP \
172 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
173 #endif
174 
175 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
176 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
177 	"bootcmd_pxe=" \
178 		BOOTENV_RUN_USB_INIT \
179 		"dhcp; " \
180 		"if pxe get; then " \
181 			"pxe boot; " \
182 		"fi\0"
183 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
184 	"pxe "
185 #else
186 #define BOOTENV_DEV_PXE \
187 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
188 #define BOOTENV_DEV_NAME_PXE \
189 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
190 #endif
191 
192 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
193 	BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
194 #define BOOTENV_BOOT_TARGETS \
195 	"boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
196 
197 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
198 	BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
199 #define BOOTENV \
200 	BOOTENV_SHARED_HOST \
201 	BOOTENV_SHARED_MMC \
202 	BOOTENV_SHARED_USB \
203 	BOOTENV_SHARED_SATA \
204 	BOOTENV_SHARED_SCSI \
205 	BOOTENV_SHARED_IDE \
206 	BOOTENV_SHARED_UBIFS \
207 	"boot_prefixes=/ /boot/\0" \
208 	"boot_scripts=boot.scr.uimg boot.scr\0" \
209 	"boot_script_dhcp=boot.scr.uimg\0" \
210 	BOOTENV_BOOT_TARGETS \
211 	\
212 	"boot_extlinux="                                                  \
213 		"sysboot ${devtype} ${devnum}:${distro_bootpart} any "    \
214 			"${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
215 	\
216 	"scan_dev_for_extlinux="                                          \
217 		"if test -e ${devtype} "                                  \
218 				"${devnum}:${distro_bootpart} "           \
219 				"${prefix}extlinux/extlinux.conf; then "  \
220 			"echo Found ${prefix}extlinux/extlinux.conf; "    \
221 			"run boot_extlinux; "                             \
222 			"echo SCRIPT FAILED: continuing...; "             \
223 		"fi\0"                                                    \
224 	\
225 	"boot_a_script="                                                  \
226 		"load ${devtype} ${devnum}:${distro_bootpart} "           \
227 			"${scriptaddr} ${prefix}${script}; "              \
228 		"source ${scriptaddr}\0"                                  \
229 	\
230 	"scan_dev_for_scripts="                                           \
231 		"for script in ${boot_scripts}; do "                      \
232 			"if test -e ${devtype} "                          \
233 					"${devnum}:${distro_bootpart} "   \
234 					"${prefix}${script}; then "       \
235 				"echo Found U-Boot script "               \
236 					"${prefix}${script}; "            \
237 				"run boot_a_script; "                     \
238 				"echo SCRIPT FAILED: continuing...; "     \
239 			"fi; "                                            \
240 		"done\0"                                                  \
241 	\
242 	"scan_dev_for_boot="                                              \
243 		"echo Scanning ${devtype} "                               \
244 				"${devnum}:${distro_bootpart}...; "       \
245 		"for prefix in ${boot_prefixes}; do "                     \
246 			"run scan_dev_for_extlinux; "                     \
247 			"run scan_dev_for_scripts; "                      \
248 		"done\0"                                                  \
249 	\
250 	"scan_dev_for_boot_part="                                         \
251 		"part list ${devtype} ${devnum} -bootable devplist; "     \
252 		"env exists devplist || setenv devplist 1; "              \
253 		"for distro_bootpart in ${devplist}; do "                 \
254 			"if fstype ${devtype} "                           \
255 					"${devnum}:${distro_bootpart} "   \
256 					"bootfstype; then "               \
257 				"run scan_dev_for_boot; "                 \
258 			"fi; "                                            \
259 		"done\0"                                                  \
260 	\
261 	BOOT_TARGET_DEVICES(BOOTENV_DEV)                                  \
262 	\
263 	"distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT                      \
264 		"for target in ${boot_targets}; do "                      \
265 			"run bootcmd_${target}; "                         \
266 		"done\0"
267 
268 #ifndef CONFIG_BOOTCOMMAND
269 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
270 #endif
271 
272 #endif  /* _CONFIG_CMD_DISTRO_BOOTCMD_H */
273