1 /* 2 * Copyright (c) 2015-2021, ARM Limited. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #include <common/debug.h> 8 #include <drivers/fwu/fwu_metadata.h> 9 #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> 13 #include <drivers/partition/partition.h> 14 #include <lib/utils.h> 15 16 #include <plat/arm/common/arm_fconf_getter.h> 17 #include <plat/arm/common/arm_fconf_io_storage.h> 18 #include <plat/arm/common/plat_arm.h> 19 #include <plat/common/platform.h> 20 #include <platform_def.h> 21 22 /* IO devices */ 23 static const io_dev_connector_t *fip_dev_con; 24 uintptr_t fip_dev_handle; 25 static const io_dev_connector_t *memmap_dev_con; 26 uintptr_t memmap_dev_handle; 27 28 #if ARM_GPT_SUPPORT 29 /* fip partition names */ 30 static const char * const fip_part_names[] = {"FIP_A", "FIP_B"}; 31 CASSERT(sizeof(fip_part_names)/sizeof(char *) == NR_OF_FW_BANKS, 32 assert_fip_partition_names_missing); 33 #endif /* ARM_GPT_SUPPORT */ 34 35 /* 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 39 int open_fip(const uintptr_t spec) 40 { 41 int result; 42 uintptr_t local_image_handle; 43 44 /* See if a Firmware Image Package is available */ 45 result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID); 46 if (result == 0) { 47 result = io_open(fip_dev_handle, spec, &local_image_handle); 48 if (result == 0) { 49 VERBOSE("Using FIP\n"); 50 io_close(local_image_handle); 51 } 52 } 53 return result; 54 } 55 56 int open_memmap(const uintptr_t spec) 57 { 58 int result; 59 uintptr_t local_image_handle; 60 61 result = io_dev_init(memmap_dev_handle, (uintptr_t)NULL); 62 if (result == 0) { 63 result = io_open(memmap_dev_handle, spec, &local_image_handle); 64 if (result == 0) { 65 VERBOSE("Using Memmap\n"); 66 io_close(local_image_handle); 67 } 68 } 69 return result; 70 } 71 72 int arm_io_setup(void) 73 { 74 int io_result; 75 76 io_result = register_io_dev_fip(&fip_dev_con); 77 if (io_result < 0) { 78 return io_result; 79 } 80 81 io_result = register_io_dev_memmap(&memmap_dev_con); 82 if (io_result < 0) { 83 return io_result; 84 } 85 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); 89 if (io_result < 0) { 90 return io_result; 91 } 92 93 io_result = io_dev_open(memmap_dev_con, (uintptr_t)NULL, 94 &memmap_dev_handle); 95 96 return io_result; 97 } 98 99 void plat_arm_io_setup(void) 100 { 101 int err; 102 103 err = arm_io_setup(); 104 if (err < 0) { 105 panic(); 106 } 107 } 108 109 int plat_arm_get_alt_image_source( 110 unsigned int image_id __unused, 111 uintptr_t *dev_handle __unused, 112 uintptr_t *image_spec __unused) 113 { 114 /* By default do not try an alternative */ 115 return -ENOENT; 116 } 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 */ 120 int plat_get_image_source(unsigned int image_id, uintptr_t *dev_handle, 121 uintptr_t *image_spec) 122 { 123 int result; 124 const struct plat_io_policy *policy; 125 126 policy = FCONF_GET_PROPERTY(arm, io_policies, image_id); 127 result = policy->check(policy->image_spec); 128 if (result == 0) { 129 *image_spec = policy->image_spec; 130 *dev_handle = *(policy->dev_handle); 131 } else { 132 VERBOSE("Trying alternative IO\n"); 133 result = plat_arm_get_alt_image_source(image_id, dev_handle, 134 image_spec); 135 } 136 137 return result; 138 } 139 140 /* 141 * See if a Firmware Image Package is available, 142 * by checking if TOC is valid or not. 143 */ 144 bool arm_io_is_toc_valid(void) 145 { 146 return (io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID) == 0); 147 } 148 149 #if ARM_GPT_SUPPORT 150 /****************************************************************************** 151 * Retrieve partition entry details such as offset and length, and set these 152 * details in the I/O policy of the requested image. 153 * 154 * @image_id: image id whose I/O policy to be updated 155 * 156 * @part_name: partition name whose details to be retrieved 157 * 158 * Returns 0 on success, error otherwise 159 * Alongside, returns device handle and image specification of requested 160 * image. 161 ******************************************************************************/ 162 int arm_set_image_source(unsigned int image_id, const char *part_name, 163 uintptr_t *dev_handle, uintptr_t *image_spec) 164 { 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 172 struct plat_io_policy *policy = FCONF_GET_PROPERTY(arm, 173 io_policies, 174 image_id); 175 176 assert(policy != NULL); 177 assert(policy->image_spec != 0UL); 178 179 io_block_spec_t *spec = (io_block_spec_t *)policy->image_spec; 180 /* set offset and length of the image */ 181 spec->offset = PLAT_ARM_FLASH_IMAGE_BASE + entry->start; 182 spec->length = entry->length; 183 184 *dev_handle = *(policy->dev_handle); 185 *image_spec = policy->image_spec; 186 187 return 0; 188 } 189 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 ******************************************************************************/ 195 void 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 ******************************************************************************/ 220 void plat_fwu_set_images_source(const 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 ******************************************************************************/ 230 int 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 */ 251