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 #if defined(CONFIG_CMD_PCI_ENUM) || defined(CONFIG_DM_PCI)
143 #define BOOTENV_RUN_NET_PCI_ENUM "run boot_net_pci_enum; "
144 #define BOOTENV_SHARED_PCI \
145 	"boot_net_pci_enum=pci enum\0"
146 #else
147 #define BOOTENV_RUN_NET_PCI_ENUM
148 #define BOOTENV_SHARED_PCI
149 #endif
150 
151 #ifdef CONFIG_CMD_USB
152 #define BOOTENV_RUN_NET_USB_START "run boot_net_usb_start; "
153 #define BOOTENV_SHARED_USB \
154 	"boot_net_usb_start=usb start\0" \
155 	"usb_boot=" \
156 		"usb start; " \
157 		BOOTENV_SHARED_BLKDEV_BODY(usb)
158 #define BOOTENV_DEV_USB		BOOTENV_DEV_BLKDEV
159 #define BOOTENV_DEV_NAME_USB	BOOTENV_DEV_NAME_BLKDEV
160 #else
161 #define BOOTENV_RUN_NET_USB_START
162 #define BOOTENV_SHARED_USB
163 #define BOOTENV_DEV_USB \
164 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
165 #define BOOTENV_DEV_NAME_USB \
166 	BOOT_TARGET_DEVICES_references_USB_without_CONFIG_CMD_USB
167 #endif
168 
169 #if defined(CONFIG_CMD_DHCP)
170 #define BOOTENV_DEV_DHCP(devtypeu, devtypel, instance) \
171 	"bootcmd_dhcp=" \
172 		BOOTENV_RUN_NET_USB_START \
173 		BOOTENV_RUN_NET_PCI_ENUM \
174 		"if dhcp ${scriptaddr} ${boot_script_dhcp}; then " \
175 			"source ${scriptaddr}; " \
176 		"fi\0"
177 #define BOOTENV_DEV_NAME_DHCP(devtypeu, devtypel, instance) \
178 	"dhcp "
179 #else
180 #define BOOTENV_DEV_DHCP \
181 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
182 #define BOOTENV_DEV_NAME_DHCP \
183 	BOOT_TARGET_DEVICES_references_DHCP_without_CONFIG_CMD_DHCP
184 #endif
185 
186 #if defined(CONFIG_CMD_DHCP) && defined(CONFIG_CMD_PXE)
187 #define BOOTENV_DEV_PXE(devtypeu, devtypel, instance) \
188 	"bootcmd_pxe=" \
189 		BOOTENV_RUN_NET_USB_START \
190 		BOOTENV_RUN_NET_PCI_ENUM \
191 		"dhcp; " \
192 		"if pxe get; then " \
193 			"pxe boot; " \
194 		"fi\0"
195 #define BOOTENV_DEV_NAME_PXE(devtypeu, devtypel, instance) \
196 	"pxe "
197 #else
198 #define BOOTENV_DEV_PXE \
199 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
200 #define BOOTENV_DEV_NAME_PXE \
201 	BOOT_TARGET_DEVICES_references_PXE_without_CONFIG_CMD_DHCP_or_PXE
202 #endif
203 
204 #define BOOTENV_DEV_NAME(devtypeu, devtypel, instance) \
205 	BOOTENV_DEV_NAME_##devtypeu(devtypeu, devtypel, instance)
206 #define BOOTENV_BOOT_TARGETS \
207 	"boot_targets=" BOOT_TARGET_DEVICES(BOOTENV_DEV_NAME) "\0"
208 
209 #define BOOTENV_DEV(devtypeu, devtypel, instance) \
210 	BOOTENV_DEV_##devtypeu(devtypeu, devtypel, instance)
211 #define BOOTENV \
212 	BOOTENV_SHARED_HOST \
213 	BOOTENV_SHARED_MMC \
214 	BOOTENV_SHARED_PCI \
215 	BOOTENV_SHARED_USB \
216 	BOOTENV_SHARED_SATA \
217 	BOOTENV_SHARED_SCSI \
218 	BOOTENV_SHARED_IDE \
219 	BOOTENV_SHARED_UBIFS \
220 	"boot_prefixes=/ /boot/\0" \
221 	"boot_scripts=boot.scr.uimg boot.scr\0" \
222 	"boot_script_dhcp=boot.scr.uimg\0" \
223 	BOOTENV_BOOT_TARGETS \
224 	\
225 	"boot_extlinux="                                                  \
226 		"sysboot ${devtype} ${devnum}:${distro_bootpart} any "    \
227 			"${scriptaddr} ${prefix}extlinux/extlinux.conf\0" \
228 	\
229 	"scan_dev_for_extlinux="                                          \
230 		"if test -e ${devtype} "                                  \
231 				"${devnum}:${distro_bootpart} "           \
232 				"${prefix}extlinux/extlinux.conf; then "  \
233 			"echo Found ${prefix}extlinux/extlinux.conf; "    \
234 			"run boot_extlinux; "                             \
235 			"echo SCRIPT FAILED: continuing...; "             \
236 		"fi\0"                                                    \
237 	\
238 	"boot_a_script="                                                  \
239 		"load ${devtype} ${devnum}:${distro_bootpart} "           \
240 			"${scriptaddr} ${prefix}${script}; "              \
241 		"source ${scriptaddr}\0"                                  \
242 	\
243 	"scan_dev_for_scripts="                                           \
244 		"for script in ${boot_scripts}; do "                      \
245 			"if test -e ${devtype} "                          \
246 					"${devnum}:${distro_bootpart} "   \
247 					"${prefix}${script}; then "       \
248 				"echo Found U-Boot script "               \
249 					"${prefix}${script}; "            \
250 				"run boot_a_script; "                     \
251 				"echo SCRIPT FAILED: continuing...; "     \
252 			"fi; "                                            \
253 		"done\0"                                                  \
254 	\
255 	"scan_dev_for_boot="                                              \
256 		"echo Scanning ${devtype} "                               \
257 				"${devnum}:${distro_bootpart}...; "       \
258 		"for prefix in ${boot_prefixes}; do "                     \
259 			"run scan_dev_for_extlinux; "                     \
260 			"run scan_dev_for_scripts; "                      \
261 		"done\0"                                                  \
262 	\
263 	"scan_dev_for_boot_part="                                         \
264 		"part list ${devtype} ${devnum} -bootable devplist; "     \
265 		"env exists devplist || setenv devplist 1; "              \
266 		"for distro_bootpart in ${devplist}; do "                 \
267 			"if fstype ${devtype} "                           \
268 					"${devnum}:${distro_bootpart} "   \
269 					"bootfstype; then "               \
270 				"run scan_dev_for_boot; "                 \
271 			"fi; "                                            \
272 		"done\0"                                                  \
273 	\
274 	BOOT_TARGET_DEVICES(BOOTENV_DEV)                                  \
275 	\
276 	"distro_bootcmd=" BOOTENV_SET_SCSI_NEED_INIT                      \
277 		"for target in ${boot_targets}; do "                      \
278 			"run bootcmd_${target}; "                         \
279 		"done\0"
280 
281 #ifndef CONFIG_BOOTCOMMAND
282 #define CONFIG_BOOTCOMMAND "run distro_bootcmd"
283 #endif
284 
285 #endif  /* _CONFIG_CMD_DISTRO_BOOTCMD_H */
286