]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | // SPDX-License-Identifier: GPL-2.0+ |
f4a40f05 IG |
2 | /* |
3 | * (C) Copyright 2014 CompuLab, Ltd. <www.compulab.co.il> | |
4 | * | |
5 | * Authors: Igor Grinberg <[email protected]> | |
f4a40f05 IG |
6 | */ |
7 | ||
8 | #include <common.h> | |
7583f1f5 | 9 | #include <bmp_layout.h> |
7b51b576 | 10 | #include <env.h> |
6947e3f5 | 11 | #include <errno.h> |
7583f1f5 | 12 | #include <fs.h> |
db1b79b8 | 13 | #include <fdt_support.h> |
7583f1f5 | 14 | #include <image.h> |
15 | #include <nand.h> | |
16 | #include <sata.h> | |
7e8d7f2a | 17 | #include <spi.h> |
7583f1f5 | 18 | #include <spi_flash.h> |
19 | #include <splash.h> | |
9bb4e947 | 20 | #include <usb.h> |
f4a40f05 IG |
21 | |
22 | DECLARE_GLOBAL_DATA_PTR; | |
23 | ||
7e8d7f2a NK |
24 | #ifdef CONFIG_SPI_FLASH |
25 | static struct spi_flash *sf; | |
bcbb6448 | 26 | static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size) |
7e8d7f2a NK |
27 | { |
28 | if (!sf) { | |
29 | sf = spi_flash_probe(CONFIG_SF_DEFAULT_BUS, | |
30 | CONFIG_SF_DEFAULT_CS, | |
31 | CONFIG_SF_DEFAULT_SPEED, | |
32 | CONFIG_SF_DEFAULT_MODE); | |
33 | if (!sf) | |
34 | return -ENODEV; | |
35 | } | |
36 | ||
37 | return spi_flash_read(sf, offset, read_size, (void *)bmp_load_addr); | |
38 | } | |
39 | #else | |
bcbb6448 | 40 | static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size) |
7e8d7f2a NK |
41 | { |
42 | debug("%s: sf support not available\n", __func__); | |
43 | return -ENOSYS; | |
44 | } | |
45 | #endif | |
46 | ||
f4a40f05 | 47 | #ifdef CONFIG_CMD_NAND |
bcbb6448 | 48 | static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size) |
7be4cd2c | 49 | { |
edba8cc4 GS |
50 | struct mtd_info *mtd = get_nand_dev_by_index(nand_curr_device); |
51 | return nand_read_skip_bad(mtd, offset, | |
7be4cd2c | 52 | &read_size, NULL, |
edba8cc4 | 53 | mtd->size, |
7be4cd2c NK |
54 | (u_char *)bmp_load_addr); |
55 | } | |
56 | #else | |
bcbb6448 | 57 | static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size) |
7be4cd2c NK |
58 | { |
59 | debug("%s: nand support not available\n", __func__); | |
60 | return -ENOSYS; | |
61 | } | |
62 | #endif | |
63 | ||
bcbb6448 | 64 | static int splash_storage_read_raw(struct splash_location *location, |
fd29dd55 | 65 | u32 bmp_load_addr, size_t read_size) |
7be4cd2c | 66 | { |
fd29dd55 NK |
67 | u32 offset; |
68 | ||
69 | if (!location) | |
70 | return -EINVAL; | |
71 | ||
72 | offset = location->offset; | |
73 | switch (location->storage) { | |
74 | case SPLASH_STORAGE_NAND: | |
bcbb6448 | 75 | return splash_nand_read_raw(bmp_load_addr, offset, read_size); |
7e8d7f2a | 76 | case SPLASH_STORAGE_SF: |
bcbb6448 | 77 | return splash_sf_read_raw(bmp_load_addr, offset, read_size); |
fd29dd55 NK |
78 | default: |
79 | printf("Unknown splash location\n"); | |
80 | } | |
81 | ||
82 | return -EINVAL; | |
7be4cd2c NK |
83 | } |
84 | ||
fd29dd55 | 85 | static int splash_load_raw(struct splash_location *location, u32 bmp_load_addr) |
f4a40f05 IG |
86 | { |
87 | struct bmp_header *bmp_hdr; | |
88 | int res; | |
89 | size_t bmp_size, bmp_header_size = sizeof(struct bmp_header); | |
90 | ||
91 | if (bmp_load_addr + bmp_header_size >= gd->start_addr_sp) | |
92 | goto splash_address_too_high; | |
93 | ||
bcbb6448 | 94 | res = splash_storage_read_raw(location, bmp_load_addr, bmp_header_size); |
f4a40f05 IG |
95 | if (res < 0) |
96 | return res; | |
97 | ||
98 | bmp_hdr = (struct bmp_header *)bmp_load_addr; | |
99 | bmp_size = le32_to_cpu(bmp_hdr->file_size); | |
100 | ||
101 | if (bmp_load_addr + bmp_size >= gd->start_addr_sp) | |
102 | goto splash_address_too_high; | |
103 | ||
bcbb6448 | 104 | return splash_storage_read_raw(location, bmp_load_addr, bmp_size); |
f4a40f05 IG |
105 | |
106 | splash_address_too_high: | |
f82eb2fa | 107 | printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n"); |
f4a40f05 | 108 | |
6947e3f5 | 109 | return -EFAULT; |
f4a40f05 | 110 | } |
f4a40f05 | 111 | |
870dd309 NK |
112 | static int splash_select_fs_dev(struct splash_location *location) |
113 | { | |
114 | int res; | |
115 | ||
116 | switch (location->storage) { | |
117 | case SPLASH_STORAGE_MMC: | |
118 | res = fs_set_blk_dev("mmc", location->devpart, FS_TYPE_ANY); | |
119 | break; | |
9bb4e947 NK |
120 | case SPLASH_STORAGE_USB: |
121 | res = fs_set_blk_dev("usb", location->devpart, FS_TYPE_ANY); | |
122 | break; | |
50c2d2e1 NK |
123 | case SPLASH_STORAGE_SATA: |
124 | res = fs_set_blk_dev("sata", location->devpart, FS_TYPE_ANY); | |
125 | break; | |
1cb075c6 EM |
126 | case SPLASH_STORAGE_NAND: |
127 | if (location->ubivol != NULL) | |
128 | res = fs_set_blk_dev("ubi", NULL, FS_TYPE_UBIFS); | |
129 | else | |
130 | res = -ENODEV; | |
131 | break; | |
870dd309 NK |
132 | default: |
133 | printf("Error: unsupported location storage.\n"); | |
134 | return -ENODEV; | |
135 | } | |
136 | ||
137 | if (res) | |
138 | printf("Error: could not access storage.\n"); | |
139 | ||
140 | return res; | |
141 | } | |
142 | ||
9bb4e947 NK |
143 | #ifdef CONFIG_USB_STORAGE |
144 | static int splash_init_usb(void) | |
145 | { | |
146 | int err; | |
147 | ||
148 | err = usb_init(); | |
149 | if (err) | |
150 | return err; | |
151 | ||
d7b60fbf AB |
152 | #ifndef CONFIG_DM_USB |
153 | err = usb_stor_scan(1) < 0 ? -ENODEV : 0; | |
154 | #endif | |
155 | ||
156 | return err; | |
9bb4e947 NK |
157 | } |
158 | #else | |
159 | static inline int splash_init_usb(void) | |
160 | { | |
161 | printf("Cannot load splash image: no USB support\n"); | |
162 | return -ENOSYS; | |
163 | } | |
164 | #endif | |
165 | ||
10e40d54 | 166 | #ifdef CONFIG_SATA |
50c2d2e1 NK |
167 | static int splash_init_sata(void) |
168 | { | |
f19f1ecb | 169 | return sata_probe(0); |
50c2d2e1 NK |
170 | } |
171 | #else | |
172 | static inline int splash_init_sata(void) | |
173 | { | |
174 | printf("Cannot load splash image: no SATA support\n"); | |
175 | return -ENOSYS; | |
176 | } | |
177 | #endif | |
178 | ||
1cb075c6 EM |
179 | #ifdef CONFIG_CMD_UBIFS |
180 | static int splash_mount_ubifs(struct splash_location *location) | |
181 | { | |
182 | int res; | |
183 | char cmd[32]; | |
184 | ||
185 | sprintf(cmd, "ubi part %s", location->mtdpart); | |
186 | res = run_command(cmd, 0); | |
187 | if (res) | |
188 | return res; | |
189 | ||
190 | sprintf(cmd, "ubifsmount %s", location->ubivol); | |
191 | res = run_command(cmd, 0); | |
192 | ||
193 | return res; | |
194 | } | |
195 | ||
196 | static inline int splash_umount_ubifs(void) | |
197 | { | |
198 | return run_command("ubifsumount", 0); | |
199 | } | |
200 | #else | |
201 | static inline int splash_mount_ubifs(struct splash_location *location) | |
202 | { | |
203 | printf("Cannot load splash image: no UBIFS support\n"); | |
204 | return -ENOSYS; | |
205 | } | |
206 | ||
207 | static inline int splash_umount_ubifs(void) | |
208 | { | |
209 | printf("Cannot unmount UBIFS: no UBIFS support\n"); | |
210 | return -ENOSYS; | |
211 | } | |
212 | #endif | |
213 | ||
870dd309 NK |
214 | #define SPLASH_SOURCE_DEFAULT_FILE_NAME "splash.bmp" |
215 | ||
216 | static int splash_load_fs(struct splash_location *location, u32 bmp_load_addr) | |
217 | { | |
9bb4e947 | 218 | int res = 0; |
870dd309 | 219 | loff_t bmp_size; |
3cc6e707 | 220 | loff_t actread; |
870dd309 NK |
221 | char *splash_file; |
222 | ||
00caae6d | 223 | splash_file = env_get("splashfile"); |
870dd309 NK |
224 | if (!splash_file) |
225 | splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME; | |
226 | ||
9bb4e947 NK |
227 | if (location->storage == SPLASH_STORAGE_USB) |
228 | res = splash_init_usb(); | |
229 | ||
50c2d2e1 NK |
230 | if (location->storage == SPLASH_STORAGE_SATA) |
231 | res = splash_init_sata(); | |
232 | ||
1cb075c6 EM |
233 | if (location->ubivol != NULL) |
234 | res = splash_mount_ubifs(location); | |
235 | ||
9bb4e947 NK |
236 | if (res) |
237 | return res; | |
238 | ||
870dd309 NK |
239 | res = splash_select_fs_dev(location); |
240 | if (res) | |
1cb075c6 | 241 | goto out; |
870dd309 NK |
242 | |
243 | res = fs_size(splash_file, &bmp_size); | |
244 | if (res) { | |
245 | printf("Error (%d): cannot determine file size\n", res); | |
1cb075c6 | 246 | goto out; |
870dd309 NK |
247 | } |
248 | ||
249 | if (bmp_load_addr + bmp_size >= gd->start_addr_sp) { | |
250 | printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n"); | |
1cb075c6 EM |
251 | res = -EFAULT; |
252 | goto out; | |
870dd309 NK |
253 | } |
254 | ||
255 | splash_select_fs_dev(location); | |
3cc6e707 | 256 | res = fs_read(splash_file, bmp_load_addr, 0, 0, &actread); |
1cb075c6 EM |
257 | |
258 | out: | |
259 | if (location->ubivol != NULL) | |
260 | splash_umount_ubifs(); | |
261 | ||
262 | return res; | |
870dd309 NK |
263 | } |
264 | ||
fd29dd55 NK |
265 | /** |
266 | * select_splash_location - return the splash location based on board support | |
267 | * and env variable "splashsource". | |
268 | * | |
269 | * @locations: An array of supported splash locations. | |
270 | * @size: Size of splash_locations array. | |
271 | * | |
272 | * @return: If a null set of splash locations is given, or | |
273 | * splashsource env variable is set to unsupported value | |
274 | * return NULL. | |
275 | * If splashsource env variable is not defined | |
276 | * return the first entry in splash_locations as default. | |
277 | * If splashsource env variable contains a supported value | |
278 | * return the location selected by splashsource. | |
279 | */ | |
280 | static struct splash_location *select_splash_location( | |
281 | struct splash_location *locations, uint size) | |
282 | { | |
283 | int i; | |
284 | char *env_splashsource; | |
285 | ||
286 | if (!locations || size == 0) | |
287 | return NULL; | |
288 | ||
00caae6d | 289 | env_splashsource = env_get("splashsource"); |
fd29dd55 NK |
290 | if (env_splashsource == NULL) |
291 | return &locations[0]; | |
292 | ||
293 | for (i = 0; i < size; i++) { | |
294 | if (!strcmp(locations[i].name, env_splashsource)) | |
295 | return &locations[i]; | |
296 | } | |
297 | ||
298 | printf("splashsource env variable set to unsupported value\n"); | |
299 | return NULL; | |
300 | } | |
301 | ||
db1b79b8 | 302 | #ifdef CONFIG_FIT |
303 | static int splash_load_fit(struct splash_location *location, u32 bmp_load_addr) | |
304 | { | |
305 | int res; | |
306 | int node_offset; | |
3d92f317 | 307 | const char *splash_file; |
d5006836 LR |
308 | const void *internal_splash_data; |
309 | size_t internal_splash_size; | |
310 | int external_splash_addr; | |
311 | int external_splash_size; | |
312 | bool is_splash_external = false; | |
db1b79b8 | 313 | struct image_header *img_header; |
314 | const u32 *fit_header; | |
315 | u32 fit_size; | |
316 | const size_t header_size = sizeof(struct image_header); | |
317 | ||
318 | /* Read in image header */ | |
319 | res = splash_storage_read_raw(location, bmp_load_addr, header_size); | |
320 | if (res < 0) | |
321 | return res; | |
322 | ||
323 | img_header = (struct image_header *)bmp_load_addr; | |
a7126edc NM |
324 | if (image_get_magic(img_header) != FDT_MAGIC) { |
325 | printf("Could not find FDT magic\n"); | |
326 | return -EINVAL; | |
327 | } | |
328 | ||
db1b79b8 | 329 | fit_size = fdt_totalsize(img_header); |
330 | ||
331 | /* Read in entire FIT */ | |
332 | fit_header = (const u32 *)(bmp_load_addr + header_size); | |
333 | res = splash_storage_read_raw(location, (u32)fit_header, fit_size); | |
334 | if (res < 0) | |
335 | return res; | |
336 | ||
337 | res = fit_check_format(fit_header); | |
338 | if (!res) { | |
339 | debug("Could not find valid FIT image\n"); | |
340 | return -EINVAL; | |
341 | } | |
342 | ||
3d92f317 LR |
343 | /* Get the splash image node */ |
344 | splash_file = env_get("splashfile"); | |
345 | if (!splash_file) | |
346 | splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME; | |
347 | ||
348 | node_offset = fit_image_get_node(fit_header, splash_file); | |
db1b79b8 | 349 | if (node_offset < 0) { |
350 | debug("Could not find splash image '%s' in FIT\n", | |
3d92f317 | 351 | splash_file); |
db1b79b8 | 352 | return -ENOENT; |
353 | } | |
354 | ||
d5006836 LR |
355 | /* Extract the splash data from FIT */ |
356 | /* 1. Test if splash is in FIT internal data. */ | |
357 | if (!fit_image_get_data(fit_header, node_offset, &internal_splash_data, &internal_splash_size)) | |
358 | memmove((void *)bmp_load_addr, internal_splash_data, internal_splash_size); | |
359 | /* 2. Test if splash is in FIT external data with fixed position. */ | |
360 | else if (!fit_image_get_data_position(fit_header, node_offset, &external_splash_addr)) | |
361 | is_splash_external = true; | |
362 | /* 3. Test if splash is in FIT external data with offset. */ | |
363 | else if (!fit_image_get_data_offset(fit_header, node_offset, &external_splash_addr)) { | |
364 | /* Align data offset to 4-byte boundary */ | |
365 | fit_size = ALIGN(fdt_totalsize(fit_header), 4); | |
366 | /* External splash offset means the offset by end of FIT header */ | |
367 | external_splash_addr += location->offset + fit_size; | |
368 | is_splash_external = true; | |
369 | } else { | |
370 | printf("Failed to get splash image from FIT\n"); | |
371 | return -ENODATA; | |
db1b79b8 | 372 | } |
373 | ||
d5006836 LR |
374 | if (is_splash_external) { |
375 | res = fit_image_get_data_size(fit_header, node_offset, &external_splash_size); | |
376 | if (res < 0) { | |
377 | printf("Failed to get size of splash image (err=%d)\n", res); | |
378 | return res; | |
379 | } | |
380 | ||
381 | /* Read in the splash data */ | |
382 | location->offset = external_splash_addr; | |
383 | res = splash_storage_read_raw(location, bmp_load_addr, external_splash_size); | |
384 | if (res < 0) | |
385 | return res; | |
db1b79b8 | 386 | } |
387 | ||
db1b79b8 | 388 | return 0; |
389 | } | |
390 | #endif /* CONFIG_FIT */ | |
391 | ||
f82eb2fa NK |
392 | /** |
393 | * splash_source_load - load splash image from a supported location. | |
394 | * | |
395 | * Select a splash image location based on the value of splashsource environment | |
396 | * variable and the board supported splash source locations, and load a | |
397 | * splashimage to the address pointed to by splashimage environment variable. | |
398 | * | |
399 | * @locations: An array of supported splash locations. | |
400 | * @size: Size of splash_locations array. | |
401 | * | |
402 | * @return: 0 on success, negative value on failure. | |
403 | */ | |
404 | int splash_source_load(struct splash_location *locations, uint size) | |
f4a40f05 | 405 | { |
fd29dd55 | 406 | struct splash_location *splash_location; |
f4a40f05 IG |
407 | char *env_splashimage_value; |
408 | u32 bmp_load_addr; | |
409 | ||
00caae6d | 410 | env_splashimage_value = env_get("splashimage"); |
f4a40f05 | 411 | if (env_splashimage_value == NULL) |
6947e3f5 | 412 | return -ENOENT; |
f4a40f05 IG |
413 | |
414 | bmp_load_addr = simple_strtoul(env_splashimage_value, 0, 16); | |
415 | if (bmp_load_addr == 0) { | |
416 | printf("Error: bad splashimage address specified\n"); | |
6947e3f5 | 417 | return -EFAULT; |
f4a40f05 IG |
418 | } |
419 | ||
fd29dd55 NK |
420 | splash_location = select_splash_location(locations, size); |
421 | if (!splash_location) | |
422 | return -EINVAL; | |
423 | ||
3b593f90 | 424 | if (splash_location->flags == SPLASH_STORAGE_RAW) |
870dd309 | 425 | return splash_load_raw(splash_location, bmp_load_addr); |
3b593f90 | 426 | else if (splash_location->flags == SPLASH_STORAGE_FS) |
870dd309 | 427 | return splash_load_fs(splash_location, bmp_load_addr); |
db1b79b8 | 428 | #ifdef CONFIG_FIT |
429 | else if (splash_location->flags == SPLASH_STORAGE_FIT) | |
430 | return splash_load_fit(splash_location, bmp_load_addr); | |
431 | #endif | |
870dd309 | 432 | return -EINVAL; |
f4a40f05 | 433 | } |