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/io/io_driver.h> 9 #include <drivers/io/io_fip.h> 10 #include <drivers/io/io_memmap.h> 11 #include <drivers/io/io_storage.h> 12 #include <drivers/partition/partition.h> 13 #include <lib/utils.h> 14 15 #include <plat/arm/common/arm_fconf_getter.h> 16 #include <plat/arm/common/arm_fconf_io_storage.h> 17 #include <plat/arm/common/plat_arm.h> 18 #include <plat/common/platform.h> 19 #include <platform_def.h> 20 21 /* IO devices */ 22 static const io_dev_connector_t *fip_dev_con; 23 uintptr_t fip_dev_handle; 24 static const io_dev_connector_t *memmap_dev_con; 25 uintptr_t memmap_dev_handle; 26 27 /* Weak definitions may be overridden in specific ARM standard platform */ 28 #pragma weak plat_arm_io_setup 29 #pragma weak plat_arm_get_alt_image_source 30 31 int open_fip(const uintptr_t spec) 32 { 33 int result; 34 uintptr_t local_image_handle; 35 36 /* See if a Firmware Image Package is available */ 37 result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID); 38 if (result == 0) { 39 result = io_open(fip_dev_handle, spec, &local_image_handle); 40 if (result == 0) { 41 VERBOSE("Using FIP\n"); 42 io_close(local_image_handle); 43 } 44 } 45 return result; 46 } 47 48 int open_memmap(const uintptr_t spec) 49 { 50 int result; 51 uintptr_t local_image_handle; 52 53 result = io_dev_init(memmap_dev_handle, (uintptr_t)NULL); 54 if (result == 0) { 55 result = io_open(memmap_dev_handle, spec, &local_image_handle); 56 if (result == 0) { 57 VERBOSE("Using Memmap\n"); 58 io_close(local_image_handle); 59 } 60 } 61 return result; 62 } 63 64 int arm_io_setup(void) 65 { 66 int io_result; 67 68 io_result = register_io_dev_fip(&fip_dev_con); 69 if (io_result < 0) { 70 return io_result; 71 } 72 73 io_result = register_io_dev_memmap(&memmap_dev_con); 74 if (io_result < 0) { 75 return io_result; 76 } 77 78 /* Open connections to devices and cache the handles */ 79 io_result = io_dev_open(fip_dev_con, (uintptr_t)NULL, 80 &fip_dev_handle); 81 if (io_result < 0) { 82 return io_result; 83 } 84 85 io_result = io_dev_open(memmap_dev_con, (uintptr_t)NULL, 86 &memmap_dev_handle); 87 88 return io_result; 89 } 90 91 void plat_arm_io_setup(void) 92 { 93 int err; 94 95 err = arm_io_setup(); 96 if (err < 0) { 97 panic(); 98 } 99 } 100 101 int plat_arm_get_alt_image_source( 102 unsigned int image_id __unused, 103 uintptr_t *dev_handle __unused, 104 uintptr_t *image_spec __unused) 105 { 106 /* By default do not try an alternative */ 107 return -ENOENT; 108 } 109 110 /* Return an IO device handle and specification which can be used to access 111 * an image. Use this to enforce platform load policy */ 112 int plat_get_image_source(unsigned int image_id, uintptr_t *dev_handle, 113 uintptr_t *image_spec) 114 { 115 int result; 116 const struct plat_io_policy *policy; 117 118 policy = FCONF_GET_PROPERTY(arm, io_policies, image_id); 119 result = policy->check(policy->image_spec); 120 if (result == 0) { 121 *image_spec = policy->image_spec; 122 *dev_handle = *(policy->dev_handle); 123 } else { 124 VERBOSE("Trying alternative IO\n"); 125 result = plat_arm_get_alt_image_source(image_id, dev_handle, 126 image_spec); 127 } 128 129 return result; 130 } 131 132 /* 133 * See if a Firmware Image Package is available, 134 * by checking if TOC is valid or not. 135 */ 136 bool arm_io_is_toc_valid(void) 137 { 138 return (io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_ID) == 0); 139 } 140 141 #if ARM_GPT_SUPPORT 142 /********************************************************************** 143 * arm_set_image_source: Set image specification in IO policy 144 * 145 * @image_id: id of the image whose specification to be set 146 * 147 * @part_name: name of the partition that to be read for entry details 148 * 149 * set the entry and offset details of partition in global IO policy 150 * of the image 151 *********************************************************************/ 152 int arm_set_image_source(unsigned int image_id, const char *part_name) 153 { 154 const partition_entry_t *entry = get_partition_entry(part_name); 155 156 if (entry == NULL) { 157 ERROR("Unable to find the %s partition\n", part_name); 158 return -ENOENT; 159 } 160 161 const struct plat_io_policy *policy = FCONF_GET_PROPERTY(arm, 162 io_policies, 163 image_id); 164 165 assert(policy != NULL); 166 assert(policy->image_spec != 0UL); 167 168 /* set offset and length of the image */ 169 io_block_spec_t *image_spec = (io_block_spec_t *)policy->image_spec; 170 171 image_spec->offset = PLAT_ARM_FLASH_IMAGE_BASE + entry->start; 172 image_spec->length = entry->length; 173 174 return 0; 175 } 176 #endif 177