[u-boot.git] / common / splash_source.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2014 CompuLab, Ltd. <www.compulab.co.il>
 *
 * Authors: Igor Grinberg <grinberg@compulab.co.il>
 */

#include <common.h>
#include <bmp_layout.h>
#include <command.h>
#include <env.h>
#include <errno.h>
#include <fs.h>
#include <fdt_support.h>
#include <image.h>
#include <log.h>
#include <nand.h>
#include <sata.h>
#include <spi.h>
#include <spi_flash.h>
#include <splash.h>
#include <usb.h>
#include <virtio.h>
#include <asm/global_data.h>

DECLARE_GLOBAL_DATA_PTR;

#ifdef CONFIG_SPI_FLASH
static struct spi_flash *sf;
static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
{
	if (!sf) {
		sf = spi_flash_probe(CONFIG_SF_DEFAULT_BUS,
				     CONFIG_SF_DEFAULT_CS,
				     CONFIG_SF_DEFAULT_SPEED,
				     CONFIG_SF_DEFAULT_MODE);
		if (!sf)
			return -ENODEV;
	}

	return spi_flash_read(sf, offset, read_size, (void *)(uintptr_t)bmp_load_addr);
}
#else
static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
{
	debug("%s: sf support not available\n", __func__);
	return -ENOSYS;
}
#endif

#ifdef CONFIG_CMD_NAND
static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
{
	struct mtd_info *mtd = get_nand_dev_by_index(nand_curr_device);
	return nand_read_skip_bad(mtd, offset,
				  &read_size, NULL,
				  mtd->size,
				  (u_char *)bmp_load_addr);
}
#else
static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
{
	debug("%s: nand support not available\n", __func__);
	return -ENOSYS;
}
#endif

static int splash_storage_read_raw(struct splash_location *location,
			       u32 bmp_load_addr, size_t read_size)
{
	u32 offset;

	if (!location)
		return -EINVAL;

	offset = location->offset;
	switch (location->storage) {
	case SPLASH_STORAGE_NAND:
		return splash_nand_read_raw(bmp_load_addr, offset, read_size);
	case SPLASH_STORAGE_SF:
		return splash_sf_read_raw(bmp_load_addr, offset, read_size);
	default:
		printf("Unknown splash location\n");
	}

	return -EINVAL;
}

static int splash_load_raw(struct splash_location *location, u32 bmp_load_addr)
{
	struct bmp_header *bmp_hdr;
	int res;
	size_t bmp_size, bmp_header_size = sizeof(struct bmp_header);

	if (bmp_load_addr + bmp_header_size >= gd->start_addr_sp)
		goto splash_address_too_high;

	res = splash_storage_read_raw(location, bmp_load_addr, bmp_header_size);
	if (res < 0)
		return res;

	bmp_hdr = (struct bmp_header *)(uintptr_t)bmp_load_addr;
	bmp_size = le32_to_cpu(bmp_hdr->file_size);

	if (bmp_load_addr + bmp_size >= gd->start_addr_sp)
		goto splash_address_too_high;

	return splash_storage_read_raw(location, bmp_load_addr, bmp_size);

splash_address_too_high:
	printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n");

	return -EFAULT;
}

static int splash_select_fs_dev(struct splash_location *location)
{
	int res;

	switch (location->storage) {
	case SPLASH_STORAGE_MMC:
		res = fs_set_blk_dev("mmc", location->devpart, FS_TYPE_ANY);
		break;
	case SPLASH_STORAGE_USB:
		res = fs_set_blk_dev("usb", location->devpart, FS_TYPE_ANY);
		break;
	case SPLASH_STORAGE_SATA:
		res = fs_set_blk_dev("sata", location->devpart, FS_TYPE_ANY);
		break;
	case SPLASH_STORAGE_NAND:
		if (location->ubivol != NULL)
			res = fs_set_blk_dev("ubi", NULL, FS_TYPE_UBIFS);
		else
			res = -ENODEV;
		break;
	default:
		printf("Error: unsupported location storage.\n");
		return -ENODEV;
	}

	if (res)
		printf("Error: could not access storage.\n");

	return res;
}

#ifdef CONFIG_USB_STORAGE
static int splash_init_usb(void)
{
	int err;

	err = usb_init();
	if (err)
		return err;

#ifndef CONFIG_DM_USB
	err = usb_stor_scan(1) < 0 ? -ENODEV : 0;
#endif

	return err;
}
#else
static inline int splash_init_usb(void)
{
	printf("Cannot load splash image: no USB support\n");
	return -ENOSYS;
}
#endif

#ifdef CONFIG_SATA
static int splash_init_sata(void)
{
	return sata_probe(0);
}
#else
static inline int splash_init_sata(void)
{
	printf("Cannot load splash image: no SATA support\n");
	return -ENOSYS;
}
#endif

static int splash_init_virtio(void)
{
	if (!IS_ENABLED(CONFIG_VIRTIO)) {
		printf("Cannot load splash image: no virtio support\n");
		return -ENOSYS;
	} else {
		return virtio_init();
	}
}

#ifdef CONFIG_CMD_UBIFS
static int splash_mount_ubifs(struct splash_location *location)
{
	int res;
	char cmd[32];

	sprintf(cmd, "ubi part %s", location->mtdpart);
	res = run_command(cmd, 0);
	if (res)
		return res;

	sprintf(cmd, "ubifsmount %s", location->ubivol);
	res = run_command(cmd, 0);

	return res;
}

static inline int splash_umount_ubifs(void)
{
	return run_command("ubifsumount", 0);
}
#else
static inline int splash_mount_ubifs(struct splash_location *location)
{
	printf("Cannot load splash image: no UBIFS support\n");
	return -ENOSYS;
}

static inline int splash_umount_ubifs(void)
{
	printf("Cannot unmount UBIFS: no UBIFS support\n");
	return -ENOSYS;
}
#endif

#define SPLASH_SOURCE_DEFAULT_FILE_NAME		"splash.bmp"

static int splash_load_fs(struct splash_location *location, u32 bmp_load_addr)
{
	int res = 0;
	loff_t bmp_size;
	loff_t actread;
	char *splash_file;

	splash_file = env_get("splashfile");
	if (!splash_file)
		splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME;

	if (location->storage == SPLASH_STORAGE_USB)
		res = splash_init_usb();

	if (location->storage == SPLASH_STORAGE_SATA)
		res = splash_init_sata();

	if (location->storage == SPLASH_STORAGE_VIRTIO)
		res = splash_init_virtio();

	if (location->ubivol != NULL)
		res = splash_mount_ubifs(location);

	if (res)
		return res;

	res = splash_select_fs_dev(location);
	if (res)
		goto out;

	res = fs_size(splash_file, &bmp_size);
	if (res) {
		printf("Error (%d): cannot determine file size\n", res);
		goto out;
	}

	if (bmp_load_addr + bmp_size >= gd->start_addr_sp) {
		printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n");
		res = -EFAULT;
		goto out;
	}

	splash_select_fs_dev(location);
	res = fs_read(splash_file, bmp_load_addr, 0, 0, &actread);

out:
	if (location->ubivol != NULL)
		splash_umount_ubifs();

	return res;
}

/**
 * select_splash_location - return the splash location based on board support
 *			    and env variable "splashsource".
 *
 * @locations:		An array of supported splash locations.
 * @size:		Size of splash_locations array.
 *
 * @return: If a null set of splash locations is given, or
 *	    splashsource env variable is set to unsupported value
 *			return NULL.
 *	    If splashsource env variable is not defined
 *			return the first entry in splash_locations as default.
 *	    If splashsource env variable contains a supported value
 *			return the location selected by splashsource.
 */
static struct splash_location *select_splash_location(
			    struct splash_location *locations, uint size)
{
	int i;
	char *env_splashsource;

	if (!locations || size == 0)
		return NULL;

	env_splashsource = env_get("splashsource");
	if (env_splashsource == NULL)
		return &locations[0];

	for (i = 0; i < size; i++) {
		if (!strcmp(locations[i].name, env_splashsource))
			return &locations[i];
	}

	printf("splashsource env variable set to unsupported value\n");
	return NULL;
}

#ifdef CONFIG_FIT
static int splash_load_fit(struct splash_location *location, u32 bmp_load_addr)
{
	int res;
	int node_offset;
	const char *splash_file;
	const void *internal_splash_data;
	size_t internal_splash_size;
	int external_splash_addr;
	int external_splash_size;
	bool is_splash_external = false;
	struct image_header *img_header;
	const u32 *fit_header;
	u32 fit_size;
	const size_t header_size = sizeof(struct image_header);

	/* Read in image header */
	res = splash_storage_read_raw(location, bmp_load_addr, header_size);
	if (res < 0)
		return res;

	img_header = (struct image_header *)bmp_load_addr;
	if (image_get_magic(img_header) != FDT_MAGIC) {
		printf("Could not find FDT magic\n");
		return -EINVAL;
	}

	fit_size = fdt_totalsize(img_header);

	/* Read in entire FIT */
	fit_header = (const u32 *)(bmp_load_addr + header_size);
	res = splash_storage_read_raw(location, (u32)fit_header, fit_size);
	if (res < 0)
		return res;

	res = fit_check_format(fit_header, IMAGE_SIZE_INVAL);
	if (res) {
		debug("Could not find valid FIT image\n");
		return res;
	}

	/* Get the splash image node */
	splash_file = env_get("splashfile");
	if (!splash_file)
		splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME;

	node_offset = fit_image_get_node(fit_header, splash_file);
	if (node_offset < 0) {
		debug("Could not find splash image '%s' in FIT\n",
		      splash_file);
		return -ENOENT;
	}

	/* Extract the splash data from FIT */
	/* 1. Test if splash is in FIT internal data. */
	if (!fit_image_get_data(fit_header, node_offset, &internal_splash_data, &internal_splash_size))
		memmove((void *)bmp_load_addr, internal_splash_data, internal_splash_size);
	/* 2. Test if splash is in FIT external data with fixed position. */
	else if (!fit_image_get_data_position(fit_header, node_offset, &external_splash_addr))
		is_splash_external = true;
	/* 3. Test if splash is in FIT external data with offset. */
	else if (!fit_image_get_data_offset(fit_header, node_offset, &external_splash_addr)) {
		/* Align data offset to 4-byte boundary */
		fit_size = ALIGN(fdt_totalsize(fit_header), 4);
		/* External splash offset means the offset by end of FIT header */
		external_splash_addr += location->offset + fit_size;
		is_splash_external = true;
	} else {
		printf("Failed to get splash image from FIT\n");
		return -ENODATA;
	}

	if (is_splash_external) {
		res = fit_image_get_data_size(fit_header, node_offset, &external_splash_size);
		if (res < 0) {
			printf("Failed to get size of splash image (err=%d)\n", res);
			return res;
		}

		/* Read in the splash data */
		location->offset = external_splash_addr;
		res = splash_storage_read_raw(location, bmp_load_addr, external_splash_size);
		if (res < 0)
			return res;
	}

	return 0;
}
#endif /* CONFIG_FIT */

/**
 * splash_source_load - load splash image from a supported location.
 *
 * Select a splash image location based on the value of splashsource environment
 * variable and the board supported splash source locations, and load a
 * splashimage to the address pointed to by splashimage environment variable.
 *
 * @locations:		An array of supported splash locations.
 * @size:		Size of splash_locations array.
 *
 * @return: 0 on success, negative value on failure.
 */
int splash_source_load(struct splash_location *locations, uint size)
{
	struct splash_location *splash_location;
	char *env_splashimage_value;
	u32 bmp_load_addr;

	env_splashimage_value = env_get("splashimage");
	if (env_splashimage_value == NULL)
		return -ENOENT;

	bmp_load_addr = hextoul(env_splashimage_value, 0);
	if (bmp_load_addr == 0) {
		printf("Error: bad splashimage address specified\n");
		return -EFAULT;
	}

	splash_location = select_splash_location(locations, size);
	if (!splash_location)
		return -EINVAL;

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