Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +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 | |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 31 | #include <assert.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 32 | #include <debug.h> |
| 33 | #include <errno.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 34 | #include <firmware_image_package.h> |
Dan Handley | 714a0d2 | 2014-04-09 13:13:04 +0100 | [diff] [blame] | 35 | #include <io_driver.h> |
| 36 | #include <io_fip.h> |
Dan Handley | 2bd4ef2 | 2014-04-09 13:14:54 +0100 | [diff] [blame] | 37 | #include <io_storage.h> |
| 38 | #include <platform.h> |
| 39 | #include <stdint.h> |
| 40 | #include <string.h> |
| 41 | #include <uuid.h> |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 42 | |
| 43 | /* Useful for printing UUIDs when debugging.*/ |
| 44 | #define PRINT_UUID2(x) \ |
| 45 | "%08x-%04hx-%04hx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx", \ |
| 46 | x.time_low, x.time_mid, x.time_hi_and_version, \ |
| 47 | x.clock_seq_hi_and_reserved, x.clock_seq_low, \ |
| 48 | x.node[0], x.node[1], x.node[2], x.node[3], \ |
| 49 | x.node[4], x.node[5] |
| 50 | |
| 51 | typedef struct { |
| 52 | const char *name; |
| 53 | const uuid_t uuid; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 54 | } plat_fip_name_uuid_t; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 55 | |
| 56 | typedef struct { |
| 57 | /* Put file_pos above the struct to allow {0} on static init. |
| 58 | * It is a workaround for a known bug in GCC |
| 59 | * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53119 |
| 60 | */ |
| 61 | unsigned int file_pos; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 62 | fip_toc_entry_t entry; |
| 63 | } file_state_t; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 64 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 65 | static const plat_fip_name_uuid_t name_uuid[] = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 66 | {BL2_IMAGE_NAME, UUID_TRUSTED_BOOT_FIRMWARE_BL2}, |
| 67 | {BL31_IMAGE_NAME, UUID_EL3_RUNTIME_FIRMWARE_BL31}, |
| 68 | {BL32_IMAGE_NAME, UUID_SECURE_PAYLOAD_BL32}, |
| 69 | {BL33_IMAGE_NAME, UUID_NON_TRUSTED_FIRMWARE_BL33}, |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 70 | }; |
| 71 | |
| 72 | static const uuid_t uuid_null = {0}; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 73 | static file_state_t current_file = {0}; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 74 | static uintptr_t backend_dev_handle; |
| 75 | static uintptr_t backend_image_spec; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 76 | |
| 77 | |
| 78 | /* Firmware Image Package driver functions */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 79 | static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info); |
| 80 | static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 81 | io_entity_t *entity); |
| 82 | static int fip_file_len(io_entity_t *entity, size_t *length); |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 83 | static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 84 | size_t *length_read); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 85 | static int fip_file_close(io_entity_t *entity); |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 86 | static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params); |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 87 | static int fip_dev_close(io_dev_info_t *dev_info); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 88 | |
| 89 | |
| 90 | static inline int copy_uuid(uuid_t *dst, const uuid_t *src) |
| 91 | { |
| 92 | memcpy(dst, src, sizeof(uuid_t)); |
| 93 | return 0; |
| 94 | } |
| 95 | |
| 96 | |
| 97 | /* Return 0 for equal uuids. */ |
| 98 | static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2) |
| 99 | { |
| 100 | return memcmp(uuid1, uuid2, sizeof(uuid_t)); |
| 101 | } |
| 102 | |
| 103 | |
| 104 | /* TODO: We could check version numbers or do a package checksum? */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 105 | static inline int is_valid_header(fip_toc_header_t *header) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 106 | { |
| 107 | if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) { |
| 108 | return 1; |
| 109 | } else { |
| 110 | return 0; |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | |
| 115 | static int file_to_uuid(const char *filename, uuid_t *uuid) |
| 116 | { |
| 117 | int i; |
| 118 | int status = -EINVAL; |
| 119 | |
Sandrine Bailleux | 0c51e07 | 2014-03-19 16:03:48 +0000 | [diff] [blame] | 120 | for (i = 0; i < (sizeof(name_uuid) / sizeof(name_uuid[0])); i++) { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 121 | if (strcmp(filename, name_uuid[i].name) == 0) { |
| 122 | copy_uuid(uuid, &name_uuid[i].uuid); |
| 123 | status = 0; |
| 124 | break; |
| 125 | } |
| 126 | } |
| 127 | return status; |
| 128 | } |
| 129 | |
| 130 | |
| 131 | /* Identify the device type as a virtual driver */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 132 | io_type_t device_type_fip(void) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 133 | { |
| 134 | return IO_TYPE_FIRMWARE_IMAGE_PACKAGE; |
| 135 | } |
| 136 | |
| 137 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 138 | static const io_dev_connector_t fip_dev_connector = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 139 | .dev_open = fip_dev_open |
| 140 | }; |
| 141 | |
| 142 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 143 | static const io_dev_funcs_t fip_dev_funcs = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 144 | .type = device_type_fip, |
| 145 | .open = fip_file_open, |
| 146 | .seek = NULL, |
| 147 | .size = fip_file_len, |
| 148 | .read = fip_file_read, |
| 149 | .write = NULL, |
| 150 | .close = fip_file_close, |
| 151 | .dev_init = fip_dev_init, |
| 152 | .dev_close = fip_dev_close, |
| 153 | }; |
| 154 | |
| 155 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 156 | /* No state associated with this device so structure can be const */ |
| 157 | static const io_dev_info_t fip_dev_info = { |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 158 | .funcs = &fip_dev_funcs, |
| 159 | .info = (uintptr_t)NULL |
| 160 | }; |
| 161 | |
| 162 | |
| 163 | /* Open a connection to the FIP device */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 164 | static int fip_dev_open(const uintptr_t dev_spec __attribute__((unused)), |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 165 | io_dev_info_t **dev_info) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 166 | { |
| 167 | assert(dev_info != NULL); |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 168 | *dev_info = (io_dev_info_t *)&fip_dev_info; /* cast away const */ |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 169 | |
| 170 | return IO_SUCCESS; |
| 171 | } |
| 172 | |
| 173 | |
| 174 | /* Do some basic package checks. */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 175 | static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 176 | { |
| 177 | int result = IO_FAIL; |
| 178 | char *image_name = (char *)init_params; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 179 | uintptr_t backend_handle; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 180 | fip_toc_header_t header; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 181 | size_t bytes_read; |
| 182 | |
| 183 | /* Obtain a reference to the image by querying the platform layer */ |
| 184 | result = plat_get_image_source(image_name, &backend_dev_handle, |
| 185 | &backend_image_spec); |
| 186 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 187 | WARN("Failed to obtain reference to image '%s' (%i)\n", |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 188 | image_name, result); |
| 189 | result = IO_FAIL; |
| 190 | goto fip_dev_init_exit; |
| 191 | } |
| 192 | |
| 193 | /* Attempt to access the FIP image */ |
| 194 | result = io_open(backend_dev_handle, backend_image_spec, |
| 195 | &backend_handle); |
| 196 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 197 | WARN("Failed to access image '%s' (%i)\n", image_name, result); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 198 | result = IO_FAIL; |
| 199 | goto fip_dev_init_exit; |
| 200 | } |
| 201 | |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 202 | result = io_read(backend_handle, (uintptr_t)&header, sizeof(header), |
| 203 | &bytes_read); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 204 | if (result == IO_SUCCESS) { |
| 205 | if (!is_valid_header(&header)) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 206 | WARN("Firmware Image Package header check failed.\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 207 | result = IO_FAIL; |
| 208 | } else { |
| 209 | INFO("FIP header looks OK.\n"); |
| 210 | } |
| 211 | } |
| 212 | |
| 213 | io_close(backend_handle); |
| 214 | |
| 215 | fip_dev_init_exit: |
| 216 | return result; |
| 217 | } |
| 218 | |
| 219 | /* Close a connection to the FIP device */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 220 | static int fip_dev_close(io_dev_info_t *dev_info) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 221 | { |
| 222 | /* TODO: Consider tracking open files and cleaning them up here */ |
| 223 | |
| 224 | /* Clear the backend. */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 225 | backend_dev_handle = (uintptr_t)NULL; |
| 226 | backend_image_spec = (uintptr_t)NULL; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 227 | |
| 228 | return IO_SUCCESS; |
| 229 | } |
| 230 | |
| 231 | |
| 232 | /* Open a file for access from package. */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 233 | static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 234 | io_entity_t *entity) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 235 | { |
| 236 | int result = IO_FAIL; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 237 | uintptr_t backend_handle; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 238 | uuid_t file_uuid; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 239 | const io_file_spec_t *file_spec = (io_file_spec_t *)spec; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 240 | size_t bytes_read; |
| 241 | int found_file = 0; |
| 242 | |
| 243 | assert(file_spec != NULL); |
| 244 | assert(entity != NULL); |
| 245 | |
| 246 | /* Can only have one file open at a time for the moment. We need to |
| 247 | * track state like file cursor position. We know the header lives at |
| 248 | * offset zero, so this entry should never be zero for an active file. |
| 249 | * When the system supports dynamic memory allocation we can allow more |
| 250 | * than one open file at a time if needed. |
| 251 | */ |
| 252 | if (current_file.entry.offset_address != 0) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 253 | WARN("fip_file_open : Only one open file at a time.\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 254 | return IO_RESOURCES_EXHAUSTED; |
| 255 | } |
| 256 | |
| 257 | /* Attempt to access the FIP image */ |
| 258 | result = io_open(backend_dev_handle, backend_image_spec, |
| 259 | &backend_handle); |
| 260 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 261 | WARN("Failed to open Firmware Image Package (%i)\n", result); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 262 | result = IO_FAIL; |
| 263 | goto fip_file_open_exit; |
| 264 | } |
| 265 | |
| 266 | /* Seek past the FIP header into the Table of Contents */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 267 | result = io_seek(backend_handle, IO_SEEK_SET, sizeof(fip_toc_header_t)); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 268 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 269 | WARN("fip_file_open: failed to seek\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 270 | result = IO_FAIL; |
| 271 | goto fip_file_open_close; |
| 272 | } |
| 273 | |
| 274 | file_to_uuid(file_spec->path, &file_uuid); |
| 275 | |
| 276 | found_file = 0; |
| 277 | do { |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 278 | result = io_read(backend_handle, |
| 279 | (uintptr_t)¤t_file.entry, |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 280 | sizeof(current_file.entry), |
| 281 | &bytes_read); |
| 282 | if (result == IO_SUCCESS) { |
| 283 | if (compare_uuids(¤t_file.entry.uuid, |
| 284 | &file_uuid) == 0) { |
| 285 | found_file = 1; |
| 286 | break; |
| 287 | } |
| 288 | } else { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 289 | WARN("Failed to read FIP (%i)\n", result); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 290 | goto fip_file_open_close; |
| 291 | } |
| 292 | } while (compare_uuids(¤t_file.entry.uuid, &uuid_null) != 0); |
| 293 | |
| 294 | if (found_file == 1) { |
| 295 | /* All fine. Update entity info with file state and return. Set |
| 296 | * the file position to 0. The 'current_file.entry' holds the |
| 297 | * base and size of the file. |
| 298 | */ |
| 299 | current_file.file_pos = 0; |
| 300 | entity->info = (uintptr_t)¤t_file; |
| 301 | } else { |
| 302 | /* Did not find the file in the FIP. */ |
Jeenu Viswambharan | dd3dc32 | 2014-02-20 11:51:00 +0000 | [diff] [blame] | 303 | current_file.entry.offset_address = 0; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 304 | result = IO_FAIL; |
| 305 | } |
| 306 | |
| 307 | fip_file_open_close: |
| 308 | io_close(backend_handle); |
| 309 | |
| 310 | fip_file_open_exit: |
| 311 | return result; |
| 312 | } |
| 313 | |
| 314 | |
| 315 | /* Return the size of a file in package */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 316 | static int fip_file_len(io_entity_t *entity, size_t *length) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 317 | { |
| 318 | assert(entity != NULL); |
| 319 | assert(length != NULL); |
| 320 | |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 321 | *length = ((file_state_t *)entity->info)->entry.size; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 322 | |
| 323 | return IO_SUCCESS; |
| 324 | } |
| 325 | |
| 326 | |
| 327 | /* Read data from a file in package */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 328 | static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 329 | size_t *length_read) |
| 330 | { |
| 331 | int result = IO_FAIL; |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 332 | file_state_t *fp; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 333 | size_t file_offset; |
| 334 | size_t bytes_read; |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 335 | uintptr_t backend_handle; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 336 | |
| 337 | assert(entity != NULL); |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 338 | assert(buffer != (uintptr_t)NULL); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 339 | assert(length_read != NULL); |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 340 | assert(entity->info != (uintptr_t)NULL); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 341 | |
| 342 | /* Open the backend, attempt to access the blob image */ |
| 343 | result = io_open(backend_dev_handle, backend_image_spec, |
| 344 | &backend_handle); |
| 345 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 346 | WARN("Failed to open FIP (%i)\n", result); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 347 | result = IO_FAIL; |
| 348 | goto fip_file_read_exit; |
| 349 | } |
| 350 | |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 351 | fp = (file_state_t *)entity->info; |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 352 | |
| 353 | /* Seek to the position in the FIP where the payload lives */ |
| 354 | file_offset = fp->entry.offset_address + fp->file_pos; |
| 355 | result = io_seek(backend_handle, IO_SEEK_SET, file_offset); |
| 356 | if (result != IO_SUCCESS) { |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 357 | WARN("fip_file_read: failed to seek\n"); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 358 | result = IO_FAIL; |
| 359 | goto fip_file_read_close; |
| 360 | } |
| 361 | |
| 362 | result = io_read(backend_handle, buffer, length, &bytes_read); |
| 363 | if (result != IO_SUCCESS) { |
| 364 | /* We cannot read our data. Fail. */ |
Jeenu Viswambharan | 08c28d5 | 2014-02-20 12:03:31 +0000 | [diff] [blame] | 365 | WARN("Failed to read payload (%i)\n", result); |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 366 | result = IO_FAIL; |
| 367 | goto fip_file_read_close; |
| 368 | } else { |
| 369 | /* Set caller length and new file position. */ |
| 370 | *length_read = bytes_read; |
| 371 | fp->file_pos += bytes_read; |
| 372 | } |
| 373 | |
| 374 | /* Close the backend. */ |
| 375 | fip_file_read_close: |
| 376 | io_close(backend_handle); |
| 377 | |
| 378 | fip_file_read_exit: |
| 379 | return result; |
| 380 | } |
| 381 | |
| 382 | |
| 383 | /* Close a file in package */ |
Dan Handley | e2712bc | 2014-04-10 15:37:22 +0100 | [diff] [blame] | 384 | static int fip_file_close(io_entity_t *entity) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 385 | { |
| 386 | /* Clear our current file pointer. |
| 387 | * If we had malloc() we would free() here. |
| 388 | */ |
| 389 | if (current_file.entry.offset_address != 0) { |
| 390 | memset(¤t_file, 0, sizeof(current_file)); |
| 391 | } |
| 392 | |
| 393 | /* Clear the Entity info. */ |
| 394 | entity->info = 0; |
| 395 | |
| 396 | return IO_SUCCESS; |
| 397 | } |
| 398 | |
| 399 | /* Exported functions */ |
| 400 | |
| 401 | /* Register the Firmware Image Package driver with the IO abstraction */ |
Dan Handley | a4cb68e | 2014-04-23 13:47:06 +0100 | [diff] [blame] | 402 | int register_io_dev_fip(const io_dev_connector_t **dev_con) |
Harry Liebel | 561cd33 | 2014-02-14 14:42:48 +0000 | [diff] [blame] | 403 | { |
| 404 | int result = IO_FAIL; |
| 405 | assert(dev_con != NULL); |
| 406 | |
| 407 | result = io_register_device(&fip_dev_info); |
| 408 | if (result == IO_SUCCESS) |
| 409 | *dev_con = &fip_dev_connector; |
| 410 | |
| 411 | return result; |
| 412 | } |