Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 1 | /* |
Dan Handley | e83b0ca | 2014-01-14 18:17:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 3 | * |
| 4 | * Redistribution and use in source and binary forms, with or without |
| 5 | * modification, are permitted provided that the following conditions are met: |
| 6 | * |
| 7 | * Redistributions of source code must retain the above copyright notice, this |
| 8 | * list of conditions and the following disclaimer. |
| 9 | * |
| 10 | * Redistributions in binary form must reproduce the above copyright notice, |
| 11 | * this list of conditions and the following disclaimer in the documentation |
| 12 | * and/or other materials provided with the distribution. |
| 13 | * |
| 14 | * Neither the name of ARM nor the names of its contributors may be used |
| 15 | * to endorse or promote products derived from this software without specific |
| 16 | * prior written permission. |
| 17 | * |
| 18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 19 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 21 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 22 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 23 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 24 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 25 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 26 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 28 | * POSSIBILITY OF SUCH DAMAGE. |
| 29 | */ |
| 30 | |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 31 | #include <arch.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 32 | #include <arch_helpers.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 33 | #include <assert.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 34 | #include <bl_common.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 35 | #include <debug.h> |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 36 | #include <errno.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 37 | #include <io_storage.h> |
| 38 | #include <platform.h> |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 39 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 40 | unsigned long page_align(unsigned long value, unsigned dir) |
| 41 | { |
| 42 | unsigned long page_size = 1 << FOUR_KB_SHIFT; |
| 43 | |
| 44 | /* Round up the limit to the next page boundary */ |
| 45 | if (value & (page_size - 1)) { |
| 46 | value &= ~(page_size - 1); |
| 47 | if (dir == UP) |
| 48 | value += page_size; |
| 49 | } |
| 50 | |
| 51 | return value; |
| 52 | } |
| 53 | |
| 54 | static inline unsigned int is_page_aligned (unsigned long addr) { |
| 55 | const unsigned long page_size = 1 << FOUR_KB_SHIFT; |
| 56 | |
| 57 | return (addr & (page_size - 1)) == 0; |
| 58 | } |
| 59 | |
| 60 | void change_security_state(unsigned int target_security_state) |
| 61 | { |
| 62 | unsigned long scr = read_scr(); |
| 63 | |
| 64 | if (target_security_state == SECURE) |
| 65 | scr &= ~SCR_NS_BIT; |
| 66 | else if (target_security_state == NON_SECURE) |
| 67 | scr |= SCR_NS_BIT; |
| 68 | else |
| 69 | assert(0); |
| 70 | |
| 71 | write_scr(scr); |
| 72 | } |
| 73 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 74 | /****************************************************************************** |
| 75 | * Determine whether the memory region delimited by 'addr' and 'size' is free, |
| 76 | * given the extents of free memory. |
| 77 | * Return 1 if it is free, 0 otherwise. |
| 78 | *****************************************************************************/ |
| 79 | static int is_mem_free(uint64_t free_base, size_t free_size, |
| 80 | uint64_t addr, size_t size) |
| 81 | { |
| 82 | return (addr >= free_base) && (addr + size <= free_base + free_size); |
| 83 | } |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 84 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 85 | /****************************************************************************** |
| 86 | * Inside a given memory region, determine whether a sub-region of memory is |
| 87 | * closer from the top or the bottom of the encompassing region. Return the |
| 88 | * size of the smallest chunk of free memory surrounding the sub-region in |
| 89 | * 'small_chunk_size'. |
| 90 | *****************************************************************************/ |
| 91 | static unsigned int choose_mem_pos(uint64_t mem_start, uint64_t mem_end, |
| 92 | uint64_t submem_start, uint64_t submem_end, |
| 93 | size_t *small_chunk_size) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 94 | { |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 95 | size_t top_chunk_size, bottom_chunk_size; |
| 96 | |
| 97 | assert(mem_start <= submem_start); |
| 98 | assert(submem_start <= submem_end); |
| 99 | assert(submem_end <= mem_end); |
| 100 | assert(small_chunk_size != NULL); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 101 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 102 | top_chunk_size = mem_end - submem_end; |
| 103 | bottom_chunk_size = submem_start - mem_start; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 104 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 105 | if (top_chunk_size < bottom_chunk_size) { |
| 106 | *small_chunk_size = top_chunk_size; |
| 107 | return TOP; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 108 | } else { |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 109 | *small_chunk_size = bottom_chunk_size; |
| 110 | return BOTTOM; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 111 | } |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | /****************************************************************************** |
| 115 | * Reserve the memory region delimited by 'addr' and 'size'. The extents of free |
| 116 | * memory are passed in 'free_base' and 'free_size' and they will be updated to |
| 117 | * reflect the memory usage. |
| 118 | * The caller must ensure the memory to reserve is free. |
| 119 | *****************************************************************************/ |
| 120 | void reserve_mem(uint64_t *free_base, size_t *free_size, |
| 121 | uint64_t addr, size_t size) |
| 122 | { |
| 123 | size_t discard_size; |
| 124 | size_t reserved_size; |
| 125 | unsigned int pos; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 126 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 127 | assert(free_base != NULL); |
| 128 | assert(free_size != NULL); |
| 129 | assert(is_mem_free(*free_base, *free_size, addr, size)); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 130 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 131 | pos = choose_mem_pos(*free_base, *free_base + *free_size, |
| 132 | addr, addr + size, |
| 133 | &discard_size); |
| 134 | |
| 135 | reserved_size = size + discard_size; |
| 136 | *free_size -= reserved_size; |
| 137 | |
| 138 | if (pos == BOTTOM) |
| 139 | *free_base = addr + size; |
| 140 | |
| 141 | INFO("Reserved %u bytes (discarded %u bytes %s)\n", |
| 142 | reserved_size, discard_size, |
| 143 | pos == TOP ? "above" : "below"); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 144 | } |
| 145 | |
| 146 | static void dump_load_info(unsigned long image_load_addr, |
| 147 | unsigned long image_size, |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 148 | const meminfo_t *mem_layout) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 149 | { |
| 150 | #if DEBUG |
| 151 | printf("Trying to load image at address 0x%lx, size = 0x%lx\r\n", |
| 152 | image_load_addr, image_size); |
| 153 | printf("Current memory layout:\r\n"); |
| 154 | printf(" total region = [0x%lx, 0x%lx]\r\n", mem_layout->total_base, |
| 155 | mem_layout->total_base + mem_layout->total_size); |
| 156 | printf(" free region = [0x%lx, 0x%lx]\r\n", mem_layout->free_base, |
| 157 | mem_layout->free_base + mem_layout->free_size); |
| 158 | #endif |
| 159 | } |
| 160 | |
Ryan Harkin | 87274c4 | 2014-02-04 11:43:57 +0000 | [diff] [blame] | 161 | /* Generic function to return the size of an image */ |
| 162 | unsigned long image_size(const char *image_name) |
| 163 | { |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 164 | uintptr_t dev_handle; |
| 165 | uintptr_t image_handle; |
| 166 | uintptr_t image_spec; |
Ryan Harkin | 87274c4 | 2014-02-04 11:43:57 +0000 | [diff] [blame] | 167 | size_t image_size = 0; |
| 168 | int io_result = IO_FAIL; |
| 169 | |
| 170 | assert(image_name != NULL); |
| 171 | |
| 172 | /* Obtain a reference to the image by querying the platform layer */ |
| 173 | io_result = plat_get_image_source(image_name, &dev_handle, &image_spec); |
| 174 | if (io_result != IO_SUCCESS) { |
| 175 | WARN("Failed to obtain reference to image '%s' (%i)\n", |
| 176 | image_name, io_result); |
| 177 | return 0; |
| 178 | } |
| 179 | |
| 180 | /* Attempt to access the image */ |
| 181 | io_result = io_open(dev_handle, image_spec, &image_handle); |
| 182 | if (io_result != IO_SUCCESS) { |
| 183 | WARN("Failed to access image '%s' (%i)\n", |
| 184 | image_name, io_result); |
| 185 | return 0; |
| 186 | } |
| 187 | |
| 188 | /* Find the size of the image */ |
| 189 | io_result = io_size(image_handle, &image_size); |
| 190 | if ((io_result != IO_SUCCESS) || (image_size == 0)) { |
| 191 | WARN("Failed to determine the size of the image '%s' file (%i)\n", |
| 192 | image_name, io_result); |
| 193 | } |
| 194 | io_result = io_close(image_handle); |
| 195 | /* Ignore improbable/unrecoverable error in 'close' */ |
| 196 | |
| 197 | /* TODO: Consider maintaining open device connection from this |
| 198 | * bootloader stage |
| 199 | */ |
| 200 | io_result = io_dev_close(dev_handle); |
| 201 | /* Ignore improbable/unrecoverable error in 'dev_close' */ |
| 202 | |
| 203 | return image_size; |
| 204 | } |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 205 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 206 | /******************************************************************************* |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 207 | * Generic function to load an image at a specific address given a name and |
| 208 | * extents of free memory. It updates the memory layout if the load is |
| 209 | * successful, as well as the image information and the entry point information. |
| 210 | * The caller might pass a NULL pointer for the entry point if it is not |
| 211 | * interested in this information, e.g. because the image just needs to be |
| 212 | * loaded in memory but won't ever be executed. |
| 213 | * Returns 0 on success, a negative error code otherwise. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 214 | ******************************************************************************/ |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 215 | int load_image(meminfo_t *mem_layout, |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 216 | const char *image_name, |
| 217 | uint64_t image_base, |
| 218 | image_info_t *image_data, |
| 219 | entry_point_info_t *entry_point_info) |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 220 | { |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 221 | uintptr_t dev_handle; |
| 222 | uintptr_t image_handle; |
| 223 | uintptr_t image_spec; |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 224 | size_t image_size; |
| 225 | size_t bytes_read; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 226 | int io_result = IO_FAIL; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 227 | |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 228 | assert(mem_layout != NULL); |
| 229 | assert(image_name != NULL); |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 230 | assert(image_data != NULL); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 231 | assert(image_data->h.version >= VERSION_1); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 232 | |
| 233 | /* Obtain a reference to the image by querying the platform layer */ |
| 234 | io_result = plat_get_image_source(image_name, &dev_handle, &image_spec); |
| 235 | if (io_result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 236 | WARN("Failed to obtain reference to image '%s' (%i)\n", |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 237 | image_name, io_result); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 238 | return io_result; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 239 | } |
| 240 | |
| 241 | /* Attempt to access the image */ |
| 242 | io_result = io_open(dev_handle, image_spec, &image_handle); |
| 243 | if (io_result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 244 | WARN("Failed to access image '%s' (%i)\n", |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 245 | image_name, io_result); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 246 | return io_result; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 247 | } |
| 248 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 249 | INFO("Loading file '%s' at address 0x%lx\n", image_name, image_base); |
| 250 | |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 251 | /* Find the size of the image */ |
| 252 | io_result = io_size(image_handle, &image_size); |
| 253 | if ((io_result != IO_SUCCESS) || (image_size == 0)) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 254 | WARN("Failed to determine the size of the image '%s' file (%i)\n", |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 255 | image_name, io_result); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 256 | goto exit; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 257 | } |
| 258 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 259 | /* Check that the memory where the image will be loaded is free */ |
| 260 | if (!is_mem_free(mem_layout->free_base, mem_layout->free_size, |
| 261 | image_base, image_size)) { |
| 262 | WARN("Failed to reserve memory: 0x%lx - 0x%lx\n", |
| 263 | image_base, image_base + image_size); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 264 | dump_load_info(image_base, image_size, mem_layout); |
| 265 | io_result = -ENOMEM; |
| 266 | goto exit; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 267 | } |
| 268 | |
| 269 | /* We have enough space so load the image now */ |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 270 | /* TODO: Consider whether to try to recover/retry a partially successful read */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 271 | io_result = io_read(image_handle, image_base, image_size, &bytes_read); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 272 | if ((io_result != IO_SUCCESS) || (bytes_read < image_size)) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 273 | WARN("Failed to load '%s' file (%i)\n", image_name, io_result); |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 274 | goto exit; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 275 | } |
| 276 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 277 | /* |
| 278 | * Update the memory usage info. |
| 279 | * This is done after the actual loading so that it is not updated when |
| 280 | * the load is unsuccessful. |
| 281 | */ |
| 282 | reserve_mem(&mem_layout->free_base, &mem_layout->free_size, |
| 283 | image_base, image_size); |
| 284 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 285 | image_data->image_base = image_base; |
| 286 | image_data->image_size = image_size; |
| 287 | |
Sandrine Bailleux | 3ab33f3 | 2014-05-28 11:31:18 +0100 | [diff] [blame] | 288 | if (entry_point_info != NULL) |
| 289 | entry_point_info->pc = image_base; |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 290 | |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 291 | /* |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 292 | * File has been successfully loaded. |
| 293 | * Flush the image in TZRAM so that the next EL can see it. |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 294 | */ |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 295 | flush_dcache_range(image_base, image_size); |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 296 | |
Sandrine Bailleux | 467d057 | 2014-06-24 14:02:34 +0100 | [diff] [blame] | 297 | INFO("File '%s' loaded: 0x%lx - 0x%lx\n", image_name, image_base, |
| 298 | image_base + image_size); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 299 | |
| 300 | exit: |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 301 | io_close(image_handle); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 302 | /* Ignore improbable/unrecoverable error in 'close' */ |
| 303 | |
| 304 | /* TODO: Consider maintaining open device connection from this bootloader stage */ |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 305 | io_dev_close(dev_handle); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 306 | /* Ignore improbable/unrecoverable error in 'dev_close' */ |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 307 | |
Vikram Kanigiri | da56743 | 2014-04-15 18:08:08 +0100 | [diff] [blame] | 308 | return io_result; |
Achin Gupta | 4f6ad66 | 2013-10-25 09:08:21 +0100 | [diff] [blame] | 309 | } |