blob: 387086a2917f43f047f198fd6022ffeecd6ec8c7 [file] [log] [blame]
Dan Handley9df48042015-03-19 18:58:55 +00001/*
Manish V Badarkhedd6f2522021-02-22 17:30:17 +00002 * Copyright (c) 2015-2021, ARM Limited. All rights reserved.
Dan Handley9df48042015-03-19 18:58:55 +00003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Dan Handley9df48042015-03-19 18:58:55 +00005 */
Antonio Nino Diaze0f90632018-12-14 00:18:21 +00006
Antonio Nino Diaze0f90632018-12-14 00:18:21 +00007#include <common/debug.h>
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +01008#include <drivers/fwu/fwu_metadata.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +00009#include <drivers/io/io_driver.h>
10#include <drivers/io/io_fip.h>
11#include <drivers/io/io_memmap.h>
12#include <drivers/io/io_storage.h>
Manish V Badarkhedd6f2522021-02-22 17:30:17 +000013#include <drivers/partition/partition.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000014#include <lib/utils.h>
Louis Mayencourt6b232d92020-02-28 16:57:30 +000015
16#include <plat/arm/common/arm_fconf_getter.h>
17#include <plat/arm/common/arm_fconf_io_storage.h>
Antonio Nino Diazbd7b7402019-01-25 14:30:04 +000018#include <plat/arm/common/plat_arm.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000019#include <plat/common/platform.h>
Louis Mayencourt6b232d92020-02-28 16:57:30 +000020#include <platform_def.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000021
Dan Handley9df48042015-03-19 18:58:55 +000022/* IO devices */
23static const io_dev_connector_t *fip_dev_con;
Louis Mayencourt6b232d92020-02-28 16:57:30 +000024uintptr_t fip_dev_handle;
Dan Handley9df48042015-03-19 18:58:55 +000025static const io_dev_connector_t *memmap_dev_con;
Louis Mayencourt6b232d92020-02-28 16:57:30 +000026uintptr_t memmap_dev_handle;
Dan Handley9df48042015-03-19 18:58:55 +000027
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +010028#if ARM_GPT_SUPPORT
29/* fip partition names */
30static const char * const fip_part_names[] = {"FIP_A", "FIP_B"};
31CASSERT(sizeof(fip_part_names)/sizeof(char *) == NR_OF_FW_BANKS,
32 assert_fip_partition_names_missing);
33#endif /* ARM_GPT_SUPPORT */
34
Dan Handley9df48042015-03-19 18:58:55 +000035/* Weak definitions may be overridden in specific ARM standard platform */
36#pragma weak plat_arm_io_setup
37#pragma weak plat_arm_get_alt_image_source
38
Louis Mayencourt6b232d92020-02-28 16:57:30 +000039int open_fip(const uintptr_t spec)
Dan Handley9df48042015-03-19 18:58:55 +000040{
41 int result;
42 uintptr_t local_image_handle;
43
44 /* See if a Firmware Image Package is available */
Juan Castillo3a66aca2015-04-13 17:36:19 +010045 result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID);
Juan Castillo6e762062015-11-02 10:47:01 +000046 if (result == 0) {
Dan Handley9df48042015-03-19 18:58:55 +000047 result = io_open(fip_dev_handle, spec, &local_image_handle);
Juan Castillo6e762062015-11-02 10:47:01 +000048 if (result == 0) {
Dan Handley9df48042015-03-19 18:58:55 +000049 VERBOSE("Using FIP\n");
50 io_close(local_image_handle);
51 }
52 }
53 return result;
54}
55
Louis Mayencourt6b232d92020-02-28 16:57:30 +000056int open_memmap(const uintptr_t spec)
Dan Handley9df48042015-03-19 18:58:55 +000057{
58 int result;
59 uintptr_t local_image_handle;
60
61 result = io_dev_init(memmap_dev_handle, (uintptr_t)NULL);
Juan Castillo6e762062015-11-02 10:47:01 +000062 if (result == 0) {
Dan Handley9df48042015-03-19 18:58:55 +000063 result = io_open(memmap_dev_handle, spec, &local_image_handle);
Juan Castillo6e762062015-11-02 10:47:01 +000064 if (result == 0) {
Dan Handley9df48042015-03-19 18:58:55 +000065 VERBOSE("Using Memmap\n");
66 io_close(local_image_handle);
67 }
68 }
69 return result;
70}
71
Louis Mayencourt7d24ce12020-01-29 14:43:06 +000072int arm_io_setup(void)
Dan Handley9df48042015-03-19 18:58:55 +000073{
74 int io_result;
75
76 io_result = register_io_dev_fip(&fip_dev_con);
Louis Mayencourt7d24ce12020-01-29 14:43:06 +000077 if (io_result < 0) {
78 return io_result;
79 }
Dan Handley9df48042015-03-19 18:58:55 +000080
81 io_result = register_io_dev_memmap(&memmap_dev_con);
Louis Mayencourt7d24ce12020-01-29 14:43:06 +000082 if (io_result < 0) {
83 return io_result;
84 }
Dan Handley9df48042015-03-19 18:58:55 +000085
86 /* Open connections to devices and cache the handles */
87 io_result = io_dev_open(fip_dev_con, (uintptr_t)NULL,
88 &fip_dev_handle);
Louis Mayencourt7d24ce12020-01-29 14:43:06 +000089 if (io_result < 0) {
90 return io_result;
91 }
Dan Handley9df48042015-03-19 18:58:55 +000092
93 io_result = io_dev_open(memmap_dev_con, (uintptr_t)NULL,
94 &memmap_dev_handle);
Dan Handley9df48042015-03-19 18:58:55 +000095
Louis Mayencourt7d24ce12020-01-29 14:43:06 +000096 return io_result;
Dan Handley9df48042015-03-19 18:58:55 +000097}
98
99void plat_arm_io_setup(void)
100{
Louis Mayencourt7d24ce12020-01-29 14:43:06 +0000101 int err;
102
103 err = arm_io_setup();
104 if (err < 0) {
105 panic();
106 }
Dan Handley9df48042015-03-19 18:58:55 +0000107}
108
109int plat_arm_get_alt_image_source(
Soren Brinkmann46dd1702016-01-14 10:11:05 -0800110 unsigned int image_id __unused,
111 uintptr_t *dev_handle __unused,
112 uintptr_t *image_spec __unused)
Dan Handley9df48042015-03-19 18:58:55 +0000113{
114 /* By default do not try an alternative */
Juan Castillo6e762062015-11-02 10:47:01 +0000115 return -ENOENT;
Dan Handley9df48042015-03-19 18:58:55 +0000116}
117
118/* Return an IO device handle and specification which can be used to access
119 * an image. Use this to enforce platform load policy */
Juan Castillo3a66aca2015-04-13 17:36:19 +0100120int plat_get_image_source(unsigned int image_id, uintptr_t *dev_handle,
Dan Handley9df48042015-03-19 18:58:55 +0000121 uintptr_t *image_spec)
122{
Juan Castillo6e762062015-11-02 10:47:01 +0000123 int result;
Dan Handley9df48042015-03-19 18:58:55 +0000124 const struct plat_io_policy *policy;
125
Louis Mayencourt6b232d92020-02-28 16:57:30 +0000126 policy = FCONF_GET_PROPERTY(arm, io_policies, image_id);
Juan Castillo3a66aca2015-04-13 17:36:19 +0100127 result = policy->check(policy->image_spec);
Juan Castillo6e762062015-11-02 10:47:01 +0000128 if (result == 0) {
Juan Castillo3a66aca2015-04-13 17:36:19 +0100129 *image_spec = policy->image_spec;
130 *dev_handle = *(policy->dev_handle);
Dan Handley9df48042015-03-19 18:58:55 +0000131 } else {
Juan Castillo3a66aca2015-04-13 17:36:19 +0100132 VERBOSE("Trying alternative IO\n");
133 result = plat_arm_get_alt_image_source(image_id, dev_handle,
134 image_spec);
Dan Handley9df48042015-03-19 18:58:55 +0000135 }
Juan Castillo3a66aca2015-04-13 17:36:19 +0100136
Dan Handley9df48042015-03-19 18:58:55 +0000137 return result;
138}
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100139
140/*
141 * See if a Firmware Image Package is available,
142 * by checking if TOC is valid or not.
143 */
Louis Mayencourt70d7c092020-01-29 11:42:31 +0000144bool arm_io_is_toc_valid(void)
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100145{
Louis Mayencourt70d7c092020-01-29 11:42:31 +0000146 return (io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID) == 0);
Yatharth Kochar736a3bf2015-10-11 14:14:55 +0100147}
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000148
149#if ARM_GPT_SUPPORT
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100150/******************************************************************************
151 * Retrieve partition entry details such as offset and length, and set these
152 * details in the I/O policy of the requested image.
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000153 *
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100154 * @image_id: image id whose I/O policy to be updated
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000155 *
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100156 * @part_name: partition name whose details to be retrieved
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000157 *
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100158 * Returns 0 on success, error otherwise
159 * Alongside, returns device handle and image specification of requested
160 * image.
161 ******************************************************************************/
162int arm_set_image_source(unsigned int image_id, const char *part_name,
163 uintptr_t *dev_handle, uintptr_t *image_spec)
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000164{
165 const partition_entry_t *entry = get_partition_entry(part_name);
166
167 if (entry == NULL) {
168 ERROR("Unable to find the %s partition\n", part_name);
169 return -ENOENT;
170 }
171
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100172 struct plat_io_policy *policy = FCONF_GET_PROPERTY(arm,
173 io_policies,
174 image_id);
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000175
176 assert(policy != NULL);
177 assert(policy->image_spec != 0UL);
178
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100179 io_block_spec_t *spec = (io_block_spec_t *)policy->image_spec;
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000180 /* set offset and length of the image */
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100181 spec->offset = PLAT_ARM_FLASH_IMAGE_BASE + entry->start;
182 spec->length = entry->length;
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000183
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100184 *dev_handle = *(policy->dev_handle);
185 *image_spec = policy->image_spec;
Manish V Badarkhedd6f2522021-02-22 17:30:17 +0000186
187 return 0;
188}
Manish V Badarkhed2f0a7a2021-06-25 23:43:33 +0100189
190/*******************************************************************************
191 * Set the source offset and length of the FIP image in its I/O policy.
192 *
193 * @active_fw_bank_idx: active firmware bank index gathered from FWU metadata.
194 ******************************************************************************/
195void arm_set_fip_addr(uint32_t active_fw_bank_idx)
196{
197 uintptr_t dev_handle __unused;
198 uintptr_t image_spec __unused;
199
200 assert(active_fw_bank_idx < NR_OF_FW_BANKS);
201
202 INFO("Booting with partition %s\n", fip_part_names[active_fw_bank_idx]);
203
204 int result = arm_set_image_source(FIP_IMAGE_ID,
205 fip_part_names[active_fw_bank_idx],
206 &dev_handle,
207 &image_spec);
208 if (result != 0) {
209 panic();
210 }
211}
212#endif /* ARM_GPT_SUPPORT */
213
214#if PSA_FWU_SUPPORT
215/*******************************************************************************
216 * Read the FIP partition of the GPT image corresponding to the active firmware
217 * bank to get its offset and length, and update these details in the I/O policy
218 * of the FIP image.
219 ******************************************************************************/
220void plat_fwu_set_images_source(struct fwu_metadata *metadata)
221{
222 arm_set_fip_addr(metadata->active_index);
223}
224
225/*******************************************************************************
226 * Read the requested FWU metadata partition of the GPT image to get its offset
227 * and length, and update these details in the I/O policy of the requested FWU
228 * metadata image.
229 ******************************************************************************/
230int plat_fwu_set_metadata_image_source(unsigned int image_id,
231 uintptr_t *dev_handle,
232 uintptr_t *image_spec)
233{
234 int result = -1;
235
236 if (image_id == FWU_METADATA_IMAGE_ID) {
237 result = arm_set_image_source(FWU_METADATA_IMAGE_ID,
238 "FWU-Metadata",
239 dev_handle,
240 image_spec);
241 } else if (image_id == BKUP_FWU_METADATA_IMAGE_ID) {
242 result = arm_set_image_source(BKUP_FWU_METADATA_IMAGE_ID,
243 "Bkup-FWU-Metadata",
244 dev_handle,
245 image_spec);
246 }
247
248 return result;
249}
250#endif /* PSA_FWU_SUPPORT */