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