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