James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved. |
| 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 | |
| 31 | #include <assert.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 32 | #include <debug.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 33 | #include <io_driver.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 34 | #include <io_fip.h> |
| 35 | #include <io_memmap.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 36 | #include <io_storage.h> |
| 37 | #include <io_semihosting.h> |
Dan Handley | 3aa9216 | 2014-08-04 18:31:43 +0100 | [diff] [blame^] | 38 | #include <platform_def.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 39 | #include <semihosting.h> /* For FOPEN_MODE_... */ |
| 40 | #include <string.h> |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 41 | |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 42 | /* IO devices */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 43 | static const io_dev_connector_t *sh_dev_con; |
| 44 | static uintptr_t sh_dev_spec; |
| 45 | static uintptr_t sh_init_params; |
| 46 | static uintptr_t sh_dev_handle; |
| 47 | static const io_dev_connector_t *fip_dev_con; |
| 48 | static uintptr_t fip_dev_spec; |
| 49 | static uintptr_t fip_dev_handle; |
| 50 | static const io_dev_connector_t *memmap_dev_con; |
| 51 | static uintptr_t memmap_dev_spec; |
| 52 | static uintptr_t memmap_init_params; |
| 53 | static uintptr_t memmap_dev_handle; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 54 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 55 | static const io_block_spec_t fip_block_spec = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 56 | .offset = FLASH0_BASE, |
| 57 | .length = FLASH0_SIZE |
| 58 | }; |
| 59 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 60 | static const io_file_spec_t bl2_file_spec = { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 61 | .path = BL2_IMAGE_NAME, |
Sandrine Bailleux | a9de1bb | 2014-03-20 15:51:02 +0000 | [diff] [blame] | 62 | .mode = FOPEN_MODE_RB |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 63 | }; |
| 64 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 65 | static const io_file_spec_t bl31_file_spec = { |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 66 | .path = BL31_IMAGE_NAME, |
Sandrine Bailleux | a9de1bb | 2014-03-20 15:51:02 +0000 | [diff] [blame] | 67 | .mode = FOPEN_MODE_RB |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 68 | }; |
| 69 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 70 | static const io_file_spec_t bl32_file_spec = { |
Achin Gupta | 375f538 | 2014-02-18 18:12:48 +0000 | [diff] [blame] | 71 | .path = BL32_IMAGE_NAME, |
Sandrine Bailleux | a9de1bb | 2014-03-20 15:51:02 +0000 | [diff] [blame] | 72 | .mode = FOPEN_MODE_RB |
Achin Gupta | 375f538 | 2014-02-18 18:12:48 +0000 | [diff] [blame] | 73 | }; |
| 74 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 75 | static const io_file_spec_t bl33_file_spec = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 76 | .path = BL33_IMAGE_NAME, |
Sandrine Bailleux | a9de1bb | 2014-03-20 15:51:02 +0000 | [diff] [blame] | 77 | .mode = FOPEN_MODE_RB |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 78 | }; |
| 79 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 80 | static int open_fip(const uintptr_t spec); |
| 81 | static int open_memmap(const uintptr_t spec); |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 82 | |
| 83 | struct plat_io_policy { |
| 84 | char *image_name; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 85 | uintptr_t *dev_handle; |
| 86 | uintptr_t image_spec; |
| 87 | int (*check)(const uintptr_t spec); |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 88 | }; |
| 89 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 90 | static const struct plat_io_policy policies[] = { |
| 91 | { |
| 92 | FIP_IMAGE_NAME, |
| 93 | &memmap_dev_handle, |
| 94 | (uintptr_t)&fip_block_spec, |
| 95 | open_memmap |
| 96 | }, { |
| 97 | BL2_IMAGE_NAME, |
| 98 | &fip_dev_handle, |
| 99 | (uintptr_t)&bl2_file_spec, |
| 100 | open_fip |
| 101 | }, { |
| 102 | BL31_IMAGE_NAME, |
| 103 | &fip_dev_handle, |
| 104 | (uintptr_t)&bl31_file_spec, |
| 105 | open_fip |
| 106 | }, { |
| 107 | BL32_IMAGE_NAME, |
| 108 | &fip_dev_handle, |
| 109 | (uintptr_t)&bl32_file_spec, |
| 110 | open_fip |
| 111 | }, { |
| 112 | BL33_IMAGE_NAME, |
| 113 | &fip_dev_handle, |
| 114 | (uintptr_t)&bl33_file_spec, |
| 115 | open_fip |
| 116 | }, { |
| 117 | 0, 0, 0 |
| 118 | } |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 119 | }; |
| 120 | |
| 121 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 122 | static int open_fip(const uintptr_t spec) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 123 | { |
| 124 | int result = IO_FAIL; |
| 125 | |
| 126 | /* See if a Firmware Image Package is available */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 127 | result = io_dev_init(fip_dev_handle, (uintptr_t)FIP_IMAGE_NAME); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 128 | if (result == IO_SUCCESS) { |
Dan Handley | 91b624e | 2014-07-29 17:14:00 +0100 | [diff] [blame] | 129 | VERBOSE("Using FIP\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 130 | /*TODO: Check image defined in spec is present in FIP. */ |
| 131 | } |
| 132 | return result; |
| 133 | } |
| 134 | |
| 135 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 136 | static int open_memmap(const uintptr_t spec) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 137 | { |
| 138 | int result = IO_FAIL; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 139 | uintptr_t local_image_handle; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 140 | |
| 141 | result = io_dev_init(memmap_dev_handle, memmap_init_params); |
| 142 | if (result == IO_SUCCESS) { |
| 143 | result = io_open(memmap_dev_handle, spec, &local_image_handle); |
| 144 | if (result == IO_SUCCESS) { |
Dan Handley | 91b624e | 2014-07-29 17:14:00 +0100 | [diff] [blame] | 145 | VERBOSE("Using Memmap IO\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 146 | io_close(local_image_handle); |
| 147 | } |
| 148 | } |
| 149 | return result; |
| 150 | } |
| 151 | |
| 152 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 153 | static int open_semihosting(const uintptr_t spec) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 154 | { |
| 155 | int result = IO_FAIL; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 156 | uintptr_t local_image_handle; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 157 | |
| 158 | /* See if the file exists on semi-hosting.*/ |
| 159 | result = io_dev_init(sh_dev_handle, sh_init_params); |
| 160 | if (result == IO_SUCCESS) { |
| 161 | result = io_open(sh_dev_handle, spec, &local_image_handle); |
| 162 | if (result == IO_SUCCESS) { |
Dan Handley | 91b624e | 2014-07-29 17:14:00 +0100 | [diff] [blame] | 163 | VERBOSE("Using Semi-hosting IO\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 164 | io_close(local_image_handle); |
| 165 | } |
| 166 | } |
| 167 | return result; |
| 168 | } |
| 169 | |
Dan Handley | ea45157 | 2014-05-15 14:53:30 +0100 | [diff] [blame] | 170 | void fvp_io_setup (void) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 171 | { |
| 172 | int io_result = IO_FAIL; |
| 173 | |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 174 | /* Register the IO devices on this platform */ |
| 175 | io_result = register_io_dev_sh(&sh_dev_con); |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 176 | assert(io_result == IO_SUCCESS); |
| 177 | |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 178 | io_result = register_io_dev_fip(&fip_dev_con); |
| 179 | assert(io_result == IO_SUCCESS); |
| 180 | |
| 181 | io_result = register_io_dev_memmap(&memmap_dev_con); |
| 182 | assert(io_result == IO_SUCCESS); |
| 183 | |
| 184 | /* Open connections to devices and cache the handles */ |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 185 | io_result = io_dev_open(sh_dev_con, sh_dev_spec, &sh_dev_handle); |
| 186 | assert(io_result == IO_SUCCESS); |
| 187 | |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 188 | io_result = io_dev_open(fip_dev_con, fip_dev_spec, &fip_dev_handle); |
| 189 | assert(io_result == IO_SUCCESS); |
| 190 | |
| 191 | io_result = io_dev_open(memmap_dev_con, memmap_dev_spec, |
| 192 | &memmap_dev_handle); |
| 193 | assert(io_result == IO_SUCCESS); |
| 194 | |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 195 | /* Ignore improbable errors in release builds */ |
| 196 | (void)io_result; |
| 197 | } |
| 198 | |
| 199 | |
| 200 | /* Return an IO device handle and specification which can be used to access |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 201 | * an image. Use this to enforce platform load policy */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 202 | int plat_get_image_source(const char *image_name, uintptr_t *dev_handle, |
| 203 | uintptr_t *image_spec) |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 204 | { |
| 205 | int result = IO_FAIL; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 206 | const struct plat_io_policy *policy; |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 207 | |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 208 | if ((image_name != NULL) && (dev_handle != NULL) && |
| 209 | (image_spec != NULL)) { |
| 210 | policy = policies; |
| 211 | while (policy->image_name != NULL) { |
| 212 | if (strcmp(policy->image_name, image_name) == 0) { |
| 213 | result = policy->check(policy->image_spec); |
| 214 | if (result == IO_SUCCESS) { |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 215 | *image_spec = policy->image_spec; |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 216 | *dev_handle = *(policy->dev_handle); |
| 217 | break; |
| 218 | } else { |
| 219 | result = open_semihosting( |
| 220 | policy->image_spec); |
| 221 | if (result == IO_SUCCESS) { |
| 222 | *dev_handle = sh_dev_handle; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 223 | *image_spec = |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 224 | policy->image_spec; |
| 225 | } |
| 226 | } |
| 227 | } |
| 228 | policy++; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 229 | } |
Ryan Harkin | 1bf80fc | 2014-02-18 17:40:24 +0000 | [diff] [blame] | 230 | } else { |
| 231 | result = IO_FAIL; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 232 | } |
James Morrissey | 9d72b4e | 2014-02-10 17:04:32 +0000 | [diff] [blame] | 233 | return result; |
| 234 | } |