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