1 /* 2 * Copyright (c) 2014-2019, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #include <assert.h> 8 #include <errno.h> 9 #include <stdint.h> 10 #include <string.h> 11 12 #include <platform_def.h> 13 14 #include <common/bl_common.h> 15 #include <common/debug.h> 16 #include <drivers/io/io_driver.h> 17 #include <drivers/io/io_fip.h> 18 #include <drivers/io/io_storage.h> 19 #include <lib/utils.h> 20 #include <plat/common/platform.h> 21 #include <tools_share/firmware_image_package.h> 22 #include <tools_share/uuid.h> 23 24 #ifndef MAX_FIP_DEVICES 25 #define MAX_FIP_DEVICES 1 26 #endif 27 28 /* Useful for printing UUIDs when debugging.*/ 29 #define PRINT_UUID2(x) \ 30 "%08x-%04hx-%04hx-%02hhx%02hhx-%02hhx%02hhx%02hhx%02hhx%02hhx%02hhx", \ 31 x.time_low, x.time_mid, x.time_hi_and_version, \ 32 x.clock_seq_hi_and_reserved, x.clock_seq_low, \ 33 x.node[0], x.node[1], x.node[2], x.node[3], \ 34 x.node[4], x.node[5] 35 36 typedef struct { 37 unsigned int file_pos; 38 fip_toc_entry_t entry; 39 } file_state_t; 40 41 /* 42 * Maintain dev_spec per FIP Device 43 * TODO - Add backend handles and file state 44 * per FIP device here once backends like io_memmap 45 * can support multiple open files 46 */ 47 typedef struct { 48 uintptr_t dev_spec; 49 } fip_dev_state_t; 50 51 static const uuid_t uuid_null; 52 /* 53 * Only one file can be open across all FIP device 54 * as backends like io_memmap don't support 55 * multiple open files. The file state and 56 * backend handle should be maintained per FIP device 57 * if the same support is available in the backend 58 */ 59 static file_state_t current_file = {0}; 60 static uintptr_t backend_dev_handle; 61 static uintptr_t backend_image_spec; 62 63 static fip_dev_state_t state_pool[MAX_FIP_DEVICES]; 64 static io_dev_info_t dev_info_pool[MAX_FIP_DEVICES]; 65 66 /* Track number of allocated fip devices */ 67 static unsigned int fip_dev_count; 68 69 /* Firmware Image Package driver functions */ 70 static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info); 71 static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, 72 io_entity_t *entity); 73 static int fip_file_len(io_entity_t *entity, size_t *length); 74 static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, 75 size_t *length_read); 76 static int fip_file_close(io_entity_t *entity); 77 static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params); 78 static int fip_dev_close(io_dev_info_t *dev_info); 79 80 81 /* Return 0 for equal uuids. */ 82 static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2) 83 { 84 return memcmp(uuid1, uuid2, sizeof(uuid_t)); 85 } 86 87 88 static inline int is_valid_header(fip_toc_header_t *header) 89 { 90 if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) { 91 return 1; 92 } else { 93 return 0; 94 } 95 } 96 97 98 /* Identify the device type as a virtual driver */ 99 static io_type_t device_type_fip(void) 100 { 101 return IO_TYPE_FIRMWARE_IMAGE_PACKAGE; 102 } 103 104 105 static const io_dev_connector_t fip_dev_connector = { 106 .dev_open = fip_dev_open 107 }; 108 109 110 static const io_dev_funcs_t fip_dev_funcs = { 111 .type = device_type_fip, 112 .open = fip_file_open, 113 .seek = NULL, 114 .size = fip_file_len, 115 .read = fip_file_read, 116 .write = NULL, 117 .close = fip_file_close, 118 .dev_init = fip_dev_init, 119 .dev_close = fip_dev_close, 120 }; 121 122 /* Locate a file state in the pool, specified by address */ 123 static int find_first_fip_state(const uintptr_t dev_spec, 124 unsigned int *index_out) 125 { 126 int result = -ENOENT; 127 unsigned int index; 128 129 for (index = 0; index < (unsigned int)MAX_FIP_DEVICES; ++index) { 130 /* dev_spec is used as identifier since it's unique */ 131 if (state_pool[index].dev_spec == dev_spec) { 132 result = 0; 133 *index_out = index; 134 break; 135 } 136 } 137 return result; 138 } 139 140 141 /* Allocate a device info from the pool and return a pointer to it */ 142 static int allocate_dev_info(io_dev_info_t **dev_info) 143 { 144 int result = -ENOMEM; 145 146 assert(dev_info != NULL); 147 148 if (fip_dev_count < (unsigned int)MAX_FIP_DEVICES) { 149 unsigned int index = 0; 150 151 result = find_first_fip_state(0, &index); 152 assert(result == 0); 153 /* initialize dev_info */ 154 dev_info_pool[index].funcs = &fip_dev_funcs; 155 dev_info_pool[index].info = 156 (uintptr_t)&state_pool[index]; 157 *dev_info = &dev_info_pool[index]; 158 ++fip_dev_count; 159 } 160 161 return result; 162 } 163 164 /* Release a device info to the pool */ 165 static int free_dev_info(io_dev_info_t *dev_info) 166 { 167 int result; 168 unsigned int index = 0; 169 fip_dev_state_t *state; 170 171 assert(dev_info != NULL); 172 173 state = (fip_dev_state_t *)dev_info->info; 174 result = find_first_fip_state(state->dev_spec, &index); 175 if (result == 0) { 176 /* free if device info is valid */ 177 zeromem(state, sizeof(fip_dev_state_t)); 178 --fip_dev_count; 179 } 180 181 return result; 182 } 183 184 /* 185 * Multiple FIP devices can be opened depending on the value of 186 * MAX_FIP_DEVICES. Given that there is only one backend, only a 187 * single file can be open at a time by any FIP device. 188 */ 189 static int fip_dev_open(const uintptr_t dev_spec, 190 io_dev_info_t **dev_info) 191 { 192 int result; 193 io_dev_info_t *info; 194 fip_dev_state_t *state; 195 196 assert(dev_info != NULL); 197 #if MAX_FIP_DEVICES > 1 198 assert(dev_spec != (uintptr_t)NULL); 199 #endif 200 201 result = allocate_dev_info(&info); 202 if (result != 0) 203 return -ENOMEM; 204 205 state = (fip_dev_state_t *)info->info; 206 207 state->dev_spec = dev_spec; 208 209 *dev_info = info; 210 211 return 0; 212 } 213 214 215 /* Do some basic package checks. */ 216 static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params) 217 { 218 int result; 219 unsigned int image_id = (unsigned int)init_params; 220 uintptr_t backend_handle; 221 fip_toc_header_t header; 222 size_t bytes_read; 223 224 /* Obtain a reference to the image by querying the platform layer */ 225 result = plat_get_image_source(image_id, &backend_dev_handle, 226 &backend_image_spec); 227 if (result != 0) { 228 WARN("Failed to obtain reference to image id=%u (%i)\n", 229 image_id, result); 230 result = -ENOENT; 231 goto fip_dev_init_exit; 232 } 233 234 /* Attempt to access the FIP image */ 235 result = io_open(backend_dev_handle, backend_image_spec, 236 &backend_handle); 237 if (result != 0) { 238 WARN("Failed to access image id=%u (%i)\n", image_id, result); 239 result = -ENOENT; 240 goto fip_dev_init_exit; 241 } 242 243 result = io_read(backend_handle, (uintptr_t)&header, sizeof(header), 244 &bytes_read); 245 if (result == 0) { 246 if (!is_valid_header(&header)) { 247 WARN("Firmware Image Package header check failed.\n"); 248 result = -ENOENT; 249 } else { 250 VERBOSE("FIP header looks OK.\n"); 251 } 252 } 253 254 io_close(backend_handle); 255 256 fip_dev_init_exit: 257 return result; 258 } 259 260 /* Close a connection to the FIP device */ 261 static int fip_dev_close(io_dev_info_t *dev_info) 262 { 263 /* TODO: Consider tracking open files and cleaning them up here */ 264 265 /* Clear the backend. */ 266 backend_dev_handle = (uintptr_t)NULL; 267 backend_image_spec = (uintptr_t)NULL; 268 269 return free_dev_info(dev_info); 270 } 271 272 273 /* Open a file for access from package. */ 274 static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, 275 io_entity_t *entity) 276 { 277 int result; 278 uintptr_t backend_handle; 279 const io_uuid_spec_t *uuid_spec = (io_uuid_spec_t *)spec; 280 size_t bytes_read; 281 int found_file = 0; 282 283 assert(uuid_spec != NULL); 284 assert(entity != NULL); 285 286 /* Can only have one file open at a time for the moment. We need to 287 * track state like file cursor position. We know the header lives at 288 * offset zero, so this entry should never be zero for an active file. 289 * When the system supports dynamic memory allocation we can allow more 290 * than one open file at a time if needed. 291 */ 292 if (current_file.entry.offset_address != 0) { 293 WARN("fip_file_open : Only one open file at a time.\n"); 294 return -ENOMEM; 295 } 296 297 /* Attempt to access the FIP image */ 298 result = io_open(backend_dev_handle, backend_image_spec, 299 &backend_handle); 300 if (result != 0) { 301 WARN("Failed to open Firmware Image Package (%i)\n", result); 302 result = -ENOENT; 303 goto fip_file_open_exit; 304 } 305 306 /* Seek past the FIP header into the Table of Contents */ 307 result = io_seek(backend_handle, IO_SEEK_SET, sizeof(fip_toc_header_t)); 308 if (result != 0) { 309 WARN("fip_file_open: failed to seek\n"); 310 result = -ENOENT; 311 goto fip_file_open_close; 312 } 313 314 found_file = 0; 315 do { 316 result = io_read(backend_handle, 317 (uintptr_t)¤t_file.entry, 318 sizeof(current_file.entry), 319 &bytes_read); 320 if (result == 0) { 321 if (compare_uuids(¤t_file.entry.uuid, 322 &uuid_spec->uuid) == 0) { 323 found_file = 1; 324 break; 325 } 326 } else { 327 WARN("Failed to read FIP (%i)\n", result); 328 goto fip_file_open_close; 329 } 330 } while (compare_uuids(¤t_file.entry.uuid, &uuid_null) != 0); 331 332 if (found_file == 1) { 333 /* All fine. Update entity info with file state and return. Set 334 * the file position to 0. The 'current_file.entry' holds the 335 * base and size of the file. 336 */ 337 current_file.file_pos = 0; 338 entity->info = (uintptr_t)¤t_file; 339 } else { 340 /* Did not find the file in the FIP. */ 341 current_file.entry.offset_address = 0; 342 result = -ENOENT; 343 } 344 345 fip_file_open_close: 346 io_close(backend_handle); 347 348 fip_file_open_exit: 349 return result; 350 } 351 352 353 /* Return the size of a file in package */ 354 static int fip_file_len(io_entity_t *entity, size_t *length) 355 { 356 assert(entity != NULL); 357 assert(length != NULL); 358 359 *length = ((file_state_t *)entity->info)->entry.size; 360 361 return 0; 362 } 363 364 365 /* Read data from a file in package */ 366 static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, 367 size_t *length_read) 368 { 369 int result; 370 file_state_t *fp; 371 size_t file_offset; 372 size_t bytes_read; 373 uintptr_t backend_handle; 374 375 assert(entity != NULL); 376 assert(length_read != NULL); 377 assert(entity->info != (uintptr_t)NULL); 378 379 /* Open the backend, attempt to access the blob image */ 380 result = io_open(backend_dev_handle, backend_image_spec, 381 &backend_handle); 382 if (result != 0) { 383 WARN("Failed to open FIP (%i)\n", result); 384 result = -ENOENT; 385 goto fip_file_read_exit; 386 } 387 388 fp = (file_state_t *)entity->info; 389 390 /* Seek to the position in the FIP where the payload lives */ 391 file_offset = fp->entry.offset_address + fp->file_pos; 392 result = io_seek(backend_handle, IO_SEEK_SET, file_offset); 393 if (result != 0) { 394 WARN("fip_file_read: failed to seek\n"); 395 result = -ENOENT; 396 goto fip_file_read_close; 397 } 398 399 result = io_read(backend_handle, buffer, length, &bytes_read); 400 if (result != 0) { 401 /* We cannot read our data. Fail. */ 402 WARN("Failed to read payload (%i)\n", result); 403 result = -ENOENT; 404 goto fip_file_read_close; 405 } else { 406 /* Set caller length and new file position. */ 407 *length_read = bytes_read; 408 fp->file_pos += bytes_read; 409 } 410 411 /* Close the backend. */ 412 fip_file_read_close: 413 io_close(backend_handle); 414 415 fip_file_read_exit: 416 return result; 417 } 418 419 420 /* Close a file in package */ 421 static int fip_file_close(io_entity_t *entity) 422 { 423 /* Clear our current file pointer. 424 * If we had malloc() we would free() here. 425 */ 426 if (current_file.entry.offset_address != 0) { 427 zeromem(¤t_file, sizeof(current_file)); 428 } 429 430 /* Clear the Entity info. */ 431 entity->info = 0; 432 433 return 0; 434 } 435 436 /* Exported functions */ 437 438 /* Register the Firmware Image Package driver with the IO abstraction */ 439 int register_io_dev_fip(const io_dev_connector_t **dev_con) 440 { 441 int result; 442 assert(dev_con != NULL); 443 444 /* 445 * Since dev_info isn't really used in io_register_device, always 446 * use the same device info at here instead. 447 */ 448 result = io_register_device(&dev_info_pool[0]); 449 if (result == 0) 450 *dev_con = &fip_dev_connector; 451 452 return result; 453 } 454