xref: /rk3399_rockchip-uboot/common/spl/spl_fit.c (revision 5adfa265793d2e41fd1619cafcd9cf4e18f80341)
1f1dcee59SSimon Glass /*
2f1dcee59SSimon Glass  * Copyright (C) 2016 Google, Inc
3f1dcee59SSimon Glass  * Written by Simon Glass <sjg@chromium.org>
4f1dcee59SSimon Glass  *
5f1dcee59SSimon Glass  * SPDX-License-Identifier:     GPL-2.0+
6f1dcee59SSimon Glass  */
7f1dcee59SSimon Glass 
8f1dcee59SSimon Glass #include <common.h>
9f1dcee59SSimon Glass #include <errno.h>
10f1dcee59SSimon Glass #include <image.h>
11f1dcee59SSimon Glass #include <libfdt.h>
12f1dcee59SSimon Glass #include <spl.h>
13f1dcee59SSimon Glass 
14f1dcee59SSimon Glass static ulong fdt_getprop_u32(const void *fdt, int node, const char *prop)
15f1dcee59SSimon Glass {
16f1dcee59SSimon Glass 	const u32 *cell;
17f1dcee59SSimon Glass 	int len;
18f1dcee59SSimon Glass 
19f1dcee59SSimon Glass 	cell = fdt_getprop(fdt, node, prop, &len);
20f1dcee59SSimon Glass 	if (len != sizeof(*cell))
21f1dcee59SSimon Glass 		return -1U;
22f1dcee59SSimon Glass 	return fdt32_to_cpu(*cell);
23f1dcee59SSimon Glass }
24f1dcee59SSimon Glass 
25f1dcee59SSimon Glass static int spl_fit_select_fdt(const void *fdt, int images, int *fdt_offsetp)
26f1dcee59SSimon Glass {
27f1dcee59SSimon Glass 	const char *name, *fdt_name;
28f1dcee59SSimon Glass 	int conf, node, fdt_node;
29f1dcee59SSimon Glass 	int len;
30f1dcee59SSimon Glass 
31f1dcee59SSimon Glass 	*fdt_offsetp = 0;
32f1dcee59SSimon Glass 	conf = fdt_path_offset(fdt, FIT_CONFS_PATH);
33f1dcee59SSimon Glass 	if (conf < 0) {
34f1dcee59SSimon Glass 		debug("%s: Cannot find /configurations node: %d\n", __func__,
35f1dcee59SSimon Glass 		      conf);
36f1dcee59SSimon Glass 		return -EINVAL;
37f1dcee59SSimon Glass 	}
38f1dcee59SSimon Glass 	for (node = fdt_first_subnode(fdt, conf);
39f1dcee59SSimon Glass 	     node >= 0;
40f1dcee59SSimon Glass 	     node = fdt_next_subnode(fdt, node)) {
41f1dcee59SSimon Glass 		name = fdt_getprop(fdt, node, "description", &len);
42*5adfa265SMichal Simek 		if (!name) {
43*5adfa265SMichal Simek #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
44*5adfa265SMichal Simek 			printf("%s: Missing FDT description in DTB\n",
45*5adfa265SMichal Simek 			       __func__);
46*5adfa265SMichal Simek #endif
47f1dcee59SSimon Glass 			return -EINVAL;
48*5adfa265SMichal Simek 		}
49f1dcee59SSimon Glass 		if (board_fit_config_name_match(name))
50f1dcee59SSimon Glass 			continue;
51f1dcee59SSimon Glass 
52f1dcee59SSimon Glass 		debug("Selecting config '%s'", name);
53f1dcee59SSimon Glass 		fdt_name = fdt_getprop(fdt, node, FIT_FDT_PROP, &len);
54f1dcee59SSimon Glass 		if (!fdt_name) {
55f1dcee59SSimon Glass 			debug("%s: Cannot find fdt name property: %d\n",
56f1dcee59SSimon Glass 			      __func__, len);
57f1dcee59SSimon Glass 			return -EINVAL;
58f1dcee59SSimon Glass 		}
59f1dcee59SSimon Glass 
60f1dcee59SSimon Glass 		debug(", fdt '%s'\n", fdt_name);
61f1dcee59SSimon Glass 		fdt_node = fdt_subnode_offset(fdt, images, fdt_name);
62f1dcee59SSimon Glass 		if (fdt_node < 0) {
63f1dcee59SSimon Glass 			debug("%s: Cannot find fdt node '%s': %d\n",
64f1dcee59SSimon Glass 			      __func__, fdt_name, fdt_node);
65f1dcee59SSimon Glass 			return -EINVAL;
66f1dcee59SSimon Glass 		}
67f1dcee59SSimon Glass 
68f1dcee59SSimon Glass 		*fdt_offsetp = fdt_getprop_u32(fdt, fdt_node, "data-offset");
69f1dcee59SSimon Glass 		len = fdt_getprop_u32(fdt, fdt_node, "data-size");
70f1dcee59SSimon Glass #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
71f1dcee59SSimon Glass 		printf("FIT: Selected '%s'\n", name);
72f1dcee59SSimon Glass #endif
73f1dcee59SSimon Glass 
74f1dcee59SSimon Glass 		return len;
75f1dcee59SSimon Glass 	}
76f1dcee59SSimon Glass 
77f1dcee59SSimon Glass #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
78f1dcee59SSimon Glass 	printf("No matching DT out of these options:\n");
79f1dcee59SSimon Glass 	for (node = fdt_first_subnode(fdt, conf);
80f1dcee59SSimon Glass 	     node >= 0;
81f1dcee59SSimon Glass 	     node = fdt_next_subnode(fdt, node)) {
82f1dcee59SSimon Glass 		name = fdt_getprop(fdt, node, "name", &len);
83f1dcee59SSimon Glass 		printf("   %s\n", name);
84f1dcee59SSimon Glass 	}
85f1dcee59SSimon Glass #endif
86f1dcee59SSimon Glass 
87f1dcee59SSimon Glass 	return -ENOENT;
88f1dcee59SSimon Glass }
89f1dcee59SSimon Glass 
90f1dcee59SSimon Glass int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
91f1dcee59SSimon Glass {
92f1dcee59SSimon Glass 	int sectors;
93f1dcee59SSimon Glass 	ulong size, load;
94f1dcee59SSimon Glass 	unsigned long count;
95f1dcee59SSimon Glass 	int node, images;
96f1dcee59SSimon Glass 	void *load_ptr;
97f1dcee59SSimon Glass 	int fdt_offset, fdt_len;
98f1dcee59SSimon Glass 	int data_offset, data_size;
99f1dcee59SSimon Glass 	int base_offset;
100f1dcee59SSimon Glass 	int src_sector;
101f1dcee59SSimon Glass 	void *dst;
102f1dcee59SSimon Glass 
103f1dcee59SSimon Glass 	/*
104f1dcee59SSimon Glass 	 * Figure out where the external images start. This is the base for the
105f1dcee59SSimon Glass 	 * data-offset properties in each image.
106f1dcee59SSimon Glass 	 */
107f1dcee59SSimon Glass 	size = fdt_totalsize(fit);
108f1dcee59SSimon Glass 	size = (size + 3) & ~3;
109f1dcee59SSimon Glass 	base_offset = (size + 3) & ~3;
110f1dcee59SSimon Glass 
111f1dcee59SSimon Glass 	/*
112f1dcee59SSimon Glass 	 * So far we only have one block of data from the FIT. Read the entire
113f1dcee59SSimon Glass 	 * thing, including that first block, placing it so it finishes before
114f1dcee59SSimon Glass 	 * where we will load the image.
115f1dcee59SSimon Glass 	 *
116f1dcee59SSimon Glass 	 * Note that we will load the image such that its first byte will be
117f1dcee59SSimon Glass 	 * at the load address. Since that byte may be part-way through a
118f1dcee59SSimon Glass 	 * block, we may load the image up to one block before the load
119f1dcee59SSimon Glass 	 * address. So take account of that here by subtracting an addition
120f1dcee59SSimon Glass 	 * block length from the FIT start position.
121f1dcee59SSimon Glass 	 *
122f1dcee59SSimon Glass 	 * In fact the FIT has its own load address, but we assume it cannot
123f1dcee59SSimon Glass 	 * be before CONFIG_SYS_TEXT_BASE.
124f1dcee59SSimon Glass 	 */
125f1dcee59SSimon Glass 	fit = (void *)(CONFIG_SYS_TEXT_BASE - size - info->bl_len);
126f1dcee59SSimon Glass 	sectors = (size + info->bl_len - 1) / info->bl_len;
127f1dcee59SSimon Glass 	count = info->read(info, sector, sectors, fit);
128f1dcee59SSimon Glass 	debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n",
129f1dcee59SSimon Glass 	      sector, sectors, fit, count);
130f1dcee59SSimon Glass 	if (count == 0)
131f1dcee59SSimon Glass 		return -EIO;
132f1dcee59SSimon Glass 
133f1dcee59SSimon Glass 	/* find the firmware image to load */
134f1dcee59SSimon Glass 	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
135f1dcee59SSimon Glass 	if (images < 0) {
136f1dcee59SSimon Glass 		debug("%s: Cannot find /images node: %d\n", __func__, images);
137f1dcee59SSimon Glass 		return -1;
138f1dcee59SSimon Glass 	}
139f1dcee59SSimon Glass 	node = fdt_first_subnode(fit, images);
140f1dcee59SSimon Glass 	if (node < 0) {
141f1dcee59SSimon Glass 		debug("%s: Cannot find first image node: %d\n", __func__, node);
142f1dcee59SSimon Glass 		return -1;
143f1dcee59SSimon Glass 	}
144f1dcee59SSimon Glass 
145f1dcee59SSimon Glass 	/* Get its information and set up the spl_image structure */
146f1dcee59SSimon Glass 	data_offset = fdt_getprop_u32(fit, node, "data-offset");
147f1dcee59SSimon Glass 	data_size = fdt_getprop_u32(fit, node, "data-size");
148f1dcee59SSimon Glass 	load = fdt_getprop_u32(fit, node, "load");
149f1dcee59SSimon Glass 	debug("data_offset=%x, data_size=%x\n", data_offset, data_size);
150f1dcee59SSimon Glass 	spl_image.load_addr = load;
151f1dcee59SSimon Glass 	spl_image.entry_point = load;
152f1dcee59SSimon Glass 	spl_image.os = IH_OS_U_BOOT;
153f1dcee59SSimon Glass 
154f1dcee59SSimon Glass 	/*
155f1dcee59SSimon Glass 	 * Work out where to place the image. We read it so that the first
156f1dcee59SSimon Glass 	 * byte will be at 'load'. This may mean we need to load it starting
157f1dcee59SSimon Glass 	 * before then, since we can only read whole blocks.
158f1dcee59SSimon Glass 	 */
159f1dcee59SSimon Glass 	sectors = (data_size + info->bl_len - 1) / info->bl_len;
160f1dcee59SSimon Glass 	data_offset += base_offset;
161f1dcee59SSimon Glass 	load_ptr = (void *)load;
162f1dcee59SSimon Glass 	debug("U-Boot size %x, data %p\n", data_size, load_ptr);
163f1dcee59SSimon Glass 	dst = load_ptr - (data_offset % info->bl_len);
164f1dcee59SSimon Glass 
165f1dcee59SSimon Glass 	/* Read the image */
166f1dcee59SSimon Glass 	src_sector = sector + data_offset / info->bl_len;
167f1dcee59SSimon Glass 	debug("image: data_offset=%x, dst=%p, src_sector=%x, sectors=%x\n",
168f1dcee59SSimon Glass 	      data_offset, dst, src_sector, sectors);
169f1dcee59SSimon Glass 	count = info->read(info, src_sector, sectors, dst);
170f1dcee59SSimon Glass 	if (count != sectors)
171f1dcee59SSimon Glass 		return -EIO;
172f1dcee59SSimon Glass 
173f1dcee59SSimon Glass 	/* Figure out which device tree the board wants to use */
174f1dcee59SSimon Glass 	fdt_len = spl_fit_select_fdt(fit, images, &fdt_offset);
175f1dcee59SSimon Glass 	if (fdt_len < 0)
176f1dcee59SSimon Glass 		return fdt_len;
177f1dcee59SSimon Glass 
178f1dcee59SSimon Glass 	/*
179f1dcee59SSimon Glass 	 * Read the device tree and place it after the image. There may be
180f1dcee59SSimon Glass 	 * some extra data before it since we can only read entire blocks.
181f1dcee59SSimon Glass 	 */
182f1dcee59SSimon Glass 	dst = load_ptr + data_size;
183f1dcee59SSimon Glass 	fdt_offset += base_offset;
184f1dcee59SSimon Glass 	count = info->read(info, sector + fdt_offset / info->bl_len, sectors,
185f1dcee59SSimon Glass 			   dst);
186f1dcee59SSimon Glass 	debug("fit read %x sectors to %x, dst %p, data_offset %x\n",
187f1dcee59SSimon Glass 	      sectors, spl_image.load_addr, dst, fdt_offset);
188f1dcee59SSimon Glass 	if (count != sectors)
189f1dcee59SSimon Glass 		return -EIO;
190f1dcee59SSimon Glass 
191f1dcee59SSimon Glass 	/*
192f1dcee59SSimon Glass 	 * Copy the device tree so that it starts immediately after the image.
193f1dcee59SSimon Glass 	 * After this we will have the U-Boot image and its device tree ready
194f1dcee59SSimon Glass 	 * for us to start.
195f1dcee59SSimon Glass 	 */
196f1dcee59SSimon Glass 	memcpy(dst, dst + fdt_offset % info->bl_len, fdt_len);
197f1dcee59SSimon Glass 
198f1dcee59SSimon Glass 	return 0;
199f1dcee59SSimon Glass }
200