[thirdparty/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_mmc_read_raw(u32 bmp_load_addr, struct splash_location *location,
			       size_t read_size)
{
	struct disk_partition partition;
	struct blk_desc *desc;
	lbaint_t blkcnt;
	int ret, n;

	if (!IS_ENABLED(CONFIG_CMD_MMC)) {
		debug("%s: mmc support not available\n", __func__);
		return -ENOSYS;
	}

	ret = part_get_info_by_dev_and_name_or_num("mmc", location->devpart, &desc,
						   &partition, 1);
	if (ret < 0)
		return ret;

	blkcnt = DIV_ROUND_UP(read_size, partition.blksz);
	n = blk_dread(desc, partition.start, blkcnt, (void *)(uintptr_t)bmp_load_addr);

	return (n == blkcnt) ? 0 : -EIO;
}

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_MMC:
		return splash_mmc_read_raw(bmp_load_addr, location, read_size);
	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();
	}
}

#if defined(CONFIG_CMD_UBIFS) && !defined(CONFIG_SPL_BUILD)
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 legacy_img_hdr *img_header;
	const u32 *fit_header;
	u32 fit_size;
	const size_t header_size = sizeof(struct legacy_img_hdr);

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

	img_header = (struct legacy_img_hdr *)(uintptr_t)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, (uintptr_t)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 *)(uintptr_t)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;
	char *devpart;
	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;

	devpart = env_get("splashdevpart");
	if (devpart)
		splash_location->devpart = devpart;

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