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