xref: /rk3399_ARM-atf/plat/intel/soc/common/socfpga_storage.c (revision 79626f460f115cc32b0dbeb48e72828d2dbf662a)
1e9b5e360SHadi Asyrafi /*
2e9b5e360SHadi Asyrafi  * Copyright (c) 2019, ARM Limited and Contributors. All rights reserved.
36197dc98SJit Loon Lim  * Copyright (c) 2019-2023, Intel Corporation. All rights reserved.
4e9b5e360SHadi Asyrafi  *
5e9b5e360SHadi Asyrafi  * SPDX-License-Identifier: BSD-3-Clause
6e9b5e360SHadi Asyrafi  */
7e9b5e360SHadi Asyrafi 
8e9b5e360SHadi Asyrafi #include <arch_helpers.h>
9e9b5e360SHadi Asyrafi #include <assert.h>
10e9b5e360SHadi Asyrafi #include <common/debug.h>
11e9b5e360SHadi Asyrafi #include <common/tbbr/tbbr_img_def.h>
12*79626f46SJit Loon Lim #include <drivers/cadence/cdns_nand.h>
13*79626f46SJit Loon Lim #include <drivers/cadence/cdns_sdmmc.h>
14e9b5e360SHadi Asyrafi #include <drivers/io/io_block.h>
15e9b5e360SHadi Asyrafi #include <drivers/io/io_driver.h>
16e9b5e360SHadi Asyrafi #include <drivers/io/io_fip.h>
17e9b5e360SHadi Asyrafi #include <drivers/io/io_memmap.h>
18*79626f46SJit Loon Lim #include <drivers/io/io_mtd.h>
19e9b5e360SHadi Asyrafi #include <drivers/io/io_storage.h>
20e9b5e360SHadi Asyrafi #include <drivers/mmc.h>
21e9b5e360SHadi Asyrafi #include <drivers/partition/partition.h>
22e9b5e360SHadi Asyrafi #include <lib/mmio.h>
23e9b5e360SHadi Asyrafi #include <tools_share/firmware_image_package.h>
24e9b5e360SHadi Asyrafi 
25e9b5e360SHadi Asyrafi #include "socfpga_private.h"
26e9b5e360SHadi Asyrafi 
27*79626f46SJit Loon Lim 
28e9b5e360SHadi Asyrafi #define PLAT_FIP_BASE		(0)
29e9b5e360SHadi Asyrafi #define PLAT_FIP_MAX_SIZE	(0x1000000)
30e9b5e360SHadi Asyrafi #define PLAT_MMC_DATA_BASE	(0xffe3c000)
31e9b5e360SHadi Asyrafi #define PLAT_MMC_DATA_SIZE	(0x2000)
32e9b5e360SHadi Asyrafi #define PLAT_QSPI_DATA_BASE	(0x3C00000)
33e9b5e360SHadi Asyrafi #define PLAT_QSPI_DATA_SIZE	(0x1000000)
34*79626f46SJit Loon Lim #define PLAT_NAND_DATA_BASE	(0x0200000)
35*79626f46SJit Loon Lim #define PLAT_NAND_DATA_SIZE	(0x1000000)
36e9b5e360SHadi Asyrafi 
37e9b5e360SHadi Asyrafi static const io_dev_connector_t *fip_dev_con;
38e9b5e360SHadi Asyrafi static const io_dev_connector_t *boot_dev_con;
39e9b5e360SHadi Asyrafi 
40*79626f46SJit Loon Lim static io_mtd_dev_spec_t nand_dev_spec;
41*79626f46SJit Loon Lim 
42e9b5e360SHadi Asyrafi static uintptr_t fip_dev_handle;
43e9b5e360SHadi Asyrafi static uintptr_t boot_dev_handle;
44e9b5e360SHadi Asyrafi 
45e9b5e360SHadi Asyrafi static const io_uuid_spec_t bl2_uuid_spec = {
46e9b5e360SHadi Asyrafi 	.uuid = UUID_TRUSTED_BOOT_FIRMWARE_BL2,
47e9b5e360SHadi Asyrafi };
48e9b5e360SHadi Asyrafi 
49e9b5e360SHadi Asyrafi static const io_uuid_spec_t bl31_uuid_spec = {
50e9b5e360SHadi Asyrafi 	.uuid = UUID_EL3_RUNTIME_FIRMWARE_BL31,
51e9b5e360SHadi Asyrafi };
52e9b5e360SHadi Asyrafi 
53e9b5e360SHadi Asyrafi static const io_uuid_spec_t bl33_uuid_spec = {
54e9b5e360SHadi Asyrafi 	.uuid = UUID_NON_TRUSTED_FIRMWARE_BL33,
55e9b5e360SHadi Asyrafi };
56e9b5e360SHadi Asyrafi 
57e9b5e360SHadi Asyrafi uintptr_t a2_lba_offset;
58e9b5e360SHadi Asyrafi const char a2[] = {0xa2, 0x0};
59e9b5e360SHadi Asyrafi 
60e9b5e360SHadi Asyrafi static const io_block_spec_t gpt_block_spec = {
61e9b5e360SHadi Asyrafi 	.offset = 0,
62e9b5e360SHadi Asyrafi 	.length = MMC_BLOCK_SIZE
63e9b5e360SHadi Asyrafi };
64e9b5e360SHadi Asyrafi 
65e9b5e360SHadi Asyrafi static int check_fip(const uintptr_t spec);
66e9b5e360SHadi Asyrafi static int check_dev(const uintptr_t spec);
67e9b5e360SHadi Asyrafi 
68e9b5e360SHadi Asyrafi static io_block_dev_spec_t boot_dev_spec;
69e9b5e360SHadi Asyrafi static int (*register_io_dev)(const io_dev_connector_t **);
70e9b5e360SHadi Asyrafi 
71e9b5e360SHadi Asyrafi static io_block_spec_t fip_spec = {
72e9b5e360SHadi Asyrafi 	.offset		= PLAT_FIP_BASE,
73e9b5e360SHadi Asyrafi 	.length		= PLAT_FIP_MAX_SIZE,
74e9b5e360SHadi Asyrafi };
75e9b5e360SHadi Asyrafi 
76e9b5e360SHadi Asyrafi struct plat_io_policy {
77e9b5e360SHadi Asyrafi 	uintptr_t       *dev_handle;
78e9b5e360SHadi Asyrafi 	uintptr_t       image_spec;
79e9b5e360SHadi Asyrafi 	int             (*check)(const uintptr_t spec);
80e9b5e360SHadi Asyrafi };
81e9b5e360SHadi Asyrafi 
82e9b5e360SHadi Asyrafi static const struct plat_io_policy policies[] = {
83e9b5e360SHadi Asyrafi 	[FIP_IMAGE_ID] = {
84e9b5e360SHadi Asyrafi 		&boot_dev_handle,
85e9b5e360SHadi Asyrafi 		(uintptr_t)&fip_spec,
86e9b5e360SHadi Asyrafi 		check_dev
87e9b5e360SHadi Asyrafi 	},
88e9b5e360SHadi Asyrafi 	[BL2_IMAGE_ID] = {
89e9b5e360SHadi Asyrafi 	  &fip_dev_handle,
90e9b5e360SHadi Asyrafi 	  (uintptr_t)&bl2_uuid_spec,
91e9b5e360SHadi Asyrafi 	  check_fip
92e9b5e360SHadi Asyrafi 	},
93e9b5e360SHadi Asyrafi 	[BL31_IMAGE_ID] = {
94e9b5e360SHadi Asyrafi 		&fip_dev_handle,
95e9b5e360SHadi Asyrafi 		(uintptr_t)&bl31_uuid_spec,
96e9b5e360SHadi Asyrafi 		check_fip
97e9b5e360SHadi Asyrafi 	},
98e9b5e360SHadi Asyrafi 	[BL33_IMAGE_ID] = {
99e9b5e360SHadi Asyrafi 		&fip_dev_handle,
100e9b5e360SHadi Asyrafi 		(uintptr_t) &bl33_uuid_spec,
101e9b5e360SHadi Asyrafi 		check_fip
102e9b5e360SHadi Asyrafi 	},
103e9b5e360SHadi Asyrafi 	[GPT_IMAGE_ID] = {
104e9b5e360SHadi Asyrafi 		&boot_dev_handle,
105e9b5e360SHadi Asyrafi 		(uintptr_t) &gpt_block_spec,
106e9b5e360SHadi Asyrafi 		check_dev
107e9b5e360SHadi Asyrafi 	},
108e9b5e360SHadi Asyrafi };
109e9b5e360SHadi Asyrafi 
110e9b5e360SHadi Asyrafi static int check_dev(const uintptr_t spec)
111e9b5e360SHadi Asyrafi {
112e9b5e360SHadi Asyrafi 	int result;
113e9b5e360SHadi Asyrafi 	uintptr_t local_handle;
114e9b5e360SHadi Asyrafi 
115e9b5e360SHadi Asyrafi 	result = io_dev_init(boot_dev_handle, (uintptr_t)NULL);
116e9b5e360SHadi Asyrafi 	if (result == 0) {
117e9b5e360SHadi Asyrafi 		result = io_open(boot_dev_handle, spec, &local_handle);
118e9b5e360SHadi Asyrafi 		if (result == 0)
119e9b5e360SHadi Asyrafi 			io_close(local_handle);
120e9b5e360SHadi Asyrafi 	}
121e9b5e360SHadi Asyrafi 	return result;
122e9b5e360SHadi Asyrafi }
123e9b5e360SHadi Asyrafi 
124e9b5e360SHadi Asyrafi static int check_fip(const uintptr_t spec)
125e9b5e360SHadi Asyrafi {
126e9b5e360SHadi Asyrafi 	int result;
127e9b5e360SHadi Asyrafi 	uintptr_t local_image_handle;
128e9b5e360SHadi Asyrafi 
129e9b5e360SHadi Asyrafi 	result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID);
130e9b5e360SHadi Asyrafi 	if (result == 0) {
131e9b5e360SHadi Asyrafi 		result = io_open(fip_dev_handle, spec, &local_image_handle);
132e9b5e360SHadi Asyrafi 		if (result == 0)
133e9b5e360SHadi Asyrafi 			io_close(local_image_handle);
134e9b5e360SHadi Asyrafi 	}
135e9b5e360SHadi Asyrafi 	return result;
136e9b5e360SHadi Asyrafi }
137e9b5e360SHadi Asyrafi 
138e9b5e360SHadi Asyrafi void socfpga_io_setup(int boot_source)
139e9b5e360SHadi Asyrafi {
140e9b5e360SHadi Asyrafi 	int result;
141e9b5e360SHadi Asyrafi 
142e9b5e360SHadi Asyrafi 	switch (boot_source) {
143e9b5e360SHadi Asyrafi 	case BOOT_SOURCE_SDMMC:
144e9b5e360SHadi Asyrafi 		register_io_dev = &register_io_dev_block;
145e9b5e360SHadi Asyrafi 		boot_dev_spec.buffer.offset	= PLAT_MMC_DATA_BASE;
146*79626f46SJit Loon Lim 		boot_dev_spec.buffer.length	= SOCFPGA_MMC_BLOCK_SIZE;
147e9b5e360SHadi Asyrafi 		boot_dev_spec.ops.read		= mmc_read_blocks;
148e9b5e360SHadi Asyrafi 		boot_dev_spec.ops.write		= mmc_write_blocks;
149e9b5e360SHadi Asyrafi 		boot_dev_spec.block_size	= MMC_BLOCK_SIZE;
150e9b5e360SHadi Asyrafi 		break;
151e9b5e360SHadi Asyrafi 
152e9b5e360SHadi Asyrafi 	case BOOT_SOURCE_QSPI:
153e9b5e360SHadi Asyrafi 		register_io_dev = &register_io_dev_memmap;
154*79626f46SJit Loon Lim 		fip_spec.offset = PLAT_QSPI_DATA_BASE;
155e9b5e360SHadi Asyrafi 		break;
156e9b5e360SHadi Asyrafi 
157*79626f46SJit Loon Lim #if PLATFORM_MODEL == PLAT_SOCFPGA_AGILEX5
158*79626f46SJit Loon Lim 	case BOOT_SOURCE_NAND:
159*79626f46SJit Loon Lim 		register_io_dev = &register_io_dev_mtd;
160*79626f46SJit Loon Lim 		nand_dev_spec.ops.init = cdns_nand_init_mtd;
161*79626f46SJit Loon Lim 		nand_dev_spec.ops.read = cdns_nand_read;
162*79626f46SJit Loon Lim 		nand_dev_spec.ops.write = NULL;
163*79626f46SJit Loon Lim 		fip_spec.offset = PLAT_NAND_DATA_BASE;
164*79626f46SJit Loon Lim 		break;
165*79626f46SJit Loon Lim #endif
166*79626f46SJit Loon Lim 
167e9b5e360SHadi Asyrafi 	default:
168e9b5e360SHadi Asyrafi 		ERROR("Unsupported boot source\n");
169e9b5e360SHadi Asyrafi 		panic();
170e9b5e360SHadi Asyrafi 		break;
171e9b5e360SHadi Asyrafi 	}
172e9b5e360SHadi Asyrafi 
173e9b5e360SHadi Asyrafi 	result = (*register_io_dev)(&boot_dev_con);
174e9b5e360SHadi Asyrafi 	assert(result == 0);
175e9b5e360SHadi Asyrafi 
176e9b5e360SHadi Asyrafi 	result = register_io_dev_fip(&fip_dev_con);
177e9b5e360SHadi Asyrafi 	assert(result == 0);
178e9b5e360SHadi Asyrafi 
179*79626f46SJit Loon Lim 	if (boot_source == BOOT_SOURCE_NAND) {
180*79626f46SJit Loon Lim 		result = io_dev_open(boot_dev_con, (uintptr_t)&nand_dev_spec,
181*79626f46SJit Loon Lim 								&boot_dev_handle);
182*79626f46SJit Loon Lim 	} else {
183e9b5e360SHadi Asyrafi 		result = io_dev_open(boot_dev_con, (uintptr_t)&boot_dev_spec,
184e9b5e360SHadi Asyrafi 								&boot_dev_handle);
185*79626f46SJit Loon Lim 	}
186e9b5e360SHadi Asyrafi 	assert(result == 0);
187e9b5e360SHadi Asyrafi 
188e9b5e360SHadi Asyrafi 	result = io_dev_open(fip_dev_con, (uintptr_t)NULL, &fip_dev_handle);
189e9b5e360SHadi Asyrafi 	assert(result == 0);
190e9b5e360SHadi Asyrafi 
191e9b5e360SHadi Asyrafi 	if (boot_source == BOOT_SOURCE_SDMMC) {
192e9b5e360SHadi Asyrafi 		partition_init(GPT_IMAGE_ID);
193e9b5e360SHadi Asyrafi 		fip_spec.offset = get_partition_entry(a2)->start;
194e9b5e360SHadi Asyrafi 	}
195e9b5e360SHadi Asyrafi 
196e9b5e360SHadi Asyrafi 	(void)result;
197e9b5e360SHadi Asyrafi }
198e9b5e360SHadi Asyrafi 
199e9b5e360SHadi Asyrafi int plat_get_image_source(unsigned int image_id, uintptr_t *dev_handle,
200e9b5e360SHadi Asyrafi 			uintptr_t *image_spec)
201e9b5e360SHadi Asyrafi {
202e9b5e360SHadi Asyrafi 	int result;
203e9b5e360SHadi Asyrafi 	const struct plat_io_policy *policy;
204e9b5e360SHadi Asyrafi 
205e9b5e360SHadi Asyrafi 	assert(image_id < ARRAY_SIZE(policies));
206e9b5e360SHadi Asyrafi 
207e9b5e360SHadi Asyrafi 	policy = &policies[image_id];
208e9b5e360SHadi Asyrafi 	result = policy->check(policy->image_spec);
209e9b5e360SHadi Asyrafi 	assert(result == 0);
210e9b5e360SHadi Asyrafi 
211e9b5e360SHadi Asyrafi 	*image_spec = policy->image_spec;
212e9b5e360SHadi Asyrafi 	*dev_handle = *(policy->dev_handle);
213e9b5e360SHadi Asyrafi 
214e9b5e360SHadi Asyrafi 	return result;
215e9b5e360SHadi Asyrafi }
216