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 /* Put file_pos above the struct to allow {0} on static init. 55 * It is a workaround for a known bug in GCC 56 * http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53119 57 */ 58 unsigned int file_pos; 59 fip_toc_entry_t entry; 60 } file_state_t; 61 62 static const uuid_t uuid_null = {0}; 63 static file_state_t current_file = {0}; 64 static uintptr_t backend_dev_handle; 65 static uintptr_t backend_image_spec; 66 67 68 /* Firmware Image Package driver functions */ 69 static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info); 70 static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, 71 io_entity_t *entity); 72 static int fip_file_len(io_entity_t *entity, size_t *length); 73 static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, 74 size_t *length_read); 75 static int fip_file_close(io_entity_t *entity); 76 static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params); 77 static int fip_dev_close(io_dev_info_t *dev_info); 78 79 80 /* Return 0 for equal uuids. */ 81 static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2) 82 { 83 return memcmp(uuid1, uuid2, sizeof(uuid_t)); 84 } 85 86 87 /* TODO: We could check version numbers or do a package checksum? */ 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 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 123 /* No state associated with this device so structure can be const */ 124 static const io_dev_info_t fip_dev_info = { 125 .funcs = &fip_dev_funcs, 126 .info = (uintptr_t)NULL 127 }; 128 129 130 /* Open a connection to the FIP device */ 131 static int fip_dev_open(const uintptr_t dev_spec __unused, 132 io_dev_info_t **dev_info) 133 { 134 assert(dev_info != NULL); 135 *dev_info = (io_dev_info_t *)&fip_dev_info; /* cast away const */ 136 137 return 0; 138 } 139 140 141 /* Do some basic package checks. */ 142 static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params) 143 { 144 int result; 145 unsigned int image_id = (unsigned int)init_params; 146 uintptr_t backend_handle; 147 fip_toc_header_t header; 148 size_t bytes_read; 149 150 /* Obtain a reference to the image by querying the platform layer */ 151 result = plat_get_image_source(image_id, &backend_dev_handle, 152 &backend_image_spec); 153 if (result != 0) { 154 WARN("Failed to obtain reference to image id=%u (%i)\n", 155 image_id, result); 156 result = -ENOENT; 157 goto fip_dev_init_exit; 158 } 159 160 /* Attempt to access the FIP image */ 161 result = io_open(backend_dev_handle, backend_image_spec, 162 &backend_handle); 163 if (result != 0) { 164 WARN("Failed to access image id=%u (%i)\n", image_id, result); 165 result = -ENOENT; 166 goto fip_dev_init_exit; 167 } 168 169 result = io_read(backend_handle, (uintptr_t)&header, sizeof(header), 170 &bytes_read); 171 if (result == 0) { 172 if (!is_valid_header(&header)) { 173 WARN("Firmware Image Package header check failed.\n"); 174 result = -ENOENT; 175 } else { 176 VERBOSE("FIP header looks OK.\n"); 177 } 178 } 179 180 io_close(backend_handle); 181 182 fip_dev_init_exit: 183 return result; 184 } 185 186 /* Close a connection to the FIP device */ 187 static int fip_dev_close(io_dev_info_t *dev_info) 188 { 189 /* TODO: Consider tracking open files and cleaning them up here */ 190 191 /* Clear the backend. */ 192 backend_dev_handle = (uintptr_t)NULL; 193 backend_image_spec = (uintptr_t)NULL; 194 195 return 0; 196 } 197 198 199 /* Open a file for access from package. */ 200 static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec, 201 io_entity_t *entity) 202 { 203 int result; 204 uintptr_t backend_handle; 205 const io_uuid_spec_t *uuid_spec = (io_uuid_spec_t *)spec; 206 size_t bytes_read; 207 int found_file = 0; 208 209 assert(uuid_spec != NULL); 210 assert(entity != NULL); 211 212 /* Can only have one file open at a time for the moment. We need to 213 * track state like file cursor position. We know the header lives at 214 * offset zero, so this entry should never be zero for an active file. 215 * When the system supports dynamic memory allocation we can allow more 216 * than one open file at a time if needed. 217 */ 218 if (current_file.entry.offset_address != 0) { 219 WARN("fip_file_open : Only one open file at a time.\n"); 220 return -ENOMEM; 221 } 222 223 /* Attempt to access the FIP image */ 224 result = io_open(backend_dev_handle, backend_image_spec, 225 &backend_handle); 226 if (result != 0) { 227 WARN("Failed to open Firmware Image Package (%i)\n", result); 228 result = -ENOENT; 229 goto fip_file_open_exit; 230 } 231 232 /* Seek past the FIP header into the Table of Contents */ 233 result = io_seek(backend_handle, IO_SEEK_SET, sizeof(fip_toc_header_t)); 234 if (result != 0) { 235 WARN("fip_file_open: failed to seek\n"); 236 result = -ENOENT; 237 goto fip_file_open_close; 238 } 239 240 found_file = 0; 241 do { 242 result = io_read(backend_handle, 243 (uintptr_t)¤t_file.entry, 244 sizeof(current_file.entry), 245 &bytes_read); 246 if (result == 0) { 247 if (compare_uuids(¤t_file.entry.uuid, 248 &uuid_spec->uuid) == 0) { 249 found_file = 1; 250 break; 251 } 252 } else { 253 WARN("Failed to read FIP (%i)\n", result); 254 goto fip_file_open_close; 255 } 256 } while (compare_uuids(¤t_file.entry.uuid, &uuid_null) != 0); 257 258 if (found_file == 1) { 259 /* All fine. Update entity info with file state and return. Set 260 * the file position to 0. The 'current_file.entry' holds the 261 * base and size of the file. 262 */ 263 current_file.file_pos = 0; 264 entity->info = (uintptr_t)¤t_file; 265 } else { 266 /* Did not find the file in the FIP. */ 267 current_file.entry.offset_address = 0; 268 result = -ENOENT; 269 } 270 271 fip_file_open_close: 272 io_close(backend_handle); 273 274 fip_file_open_exit: 275 return result; 276 } 277 278 279 /* Return the size of a file in package */ 280 static int fip_file_len(io_entity_t *entity, size_t *length) 281 { 282 assert(entity != NULL); 283 assert(length != NULL); 284 285 *length = ((file_state_t *)entity->info)->entry.size; 286 287 return 0; 288 } 289 290 291 /* Read data from a file in package */ 292 static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length, 293 size_t *length_read) 294 { 295 int result; 296 file_state_t *fp; 297 size_t file_offset; 298 size_t bytes_read; 299 uintptr_t backend_handle; 300 301 assert(entity != NULL); 302 assert(buffer != (uintptr_t)NULL); 303 assert(length_read != NULL); 304 assert(entity->info != (uintptr_t)NULL); 305 306 /* Open the backend, attempt to access the blob image */ 307 result = io_open(backend_dev_handle, backend_image_spec, 308 &backend_handle); 309 if (result != 0) { 310 WARN("Failed to open FIP (%i)\n", result); 311 result = -ENOENT; 312 goto fip_file_read_exit; 313 } 314 315 fp = (file_state_t *)entity->info; 316 317 /* Seek to the position in the FIP where the payload lives */ 318 file_offset = fp->entry.offset_address + fp->file_pos; 319 result = io_seek(backend_handle, IO_SEEK_SET, file_offset); 320 if (result != 0) { 321 WARN("fip_file_read: failed to seek\n"); 322 result = -ENOENT; 323 goto fip_file_read_close; 324 } 325 326 result = io_read(backend_handle, buffer, length, &bytes_read); 327 if (result != 0) { 328 /* We cannot read our data. Fail. */ 329 WARN("Failed to read payload (%i)\n", result); 330 result = -ENOENT; 331 goto fip_file_read_close; 332 } else { 333 /* Set caller length and new file position. */ 334 *length_read = bytes_read; 335 fp->file_pos += bytes_read; 336 } 337 338 /* Close the backend. */ 339 fip_file_read_close: 340 io_close(backend_handle); 341 342 fip_file_read_exit: 343 return result; 344 } 345 346 347 /* Close a file in package */ 348 static int fip_file_close(io_entity_t *entity) 349 { 350 /* Clear our current file pointer. 351 * If we had malloc() we would free() here. 352 */ 353 if (current_file.entry.offset_address != 0) { 354 memset(¤t_file, 0, sizeof(current_file)); 355 } 356 357 /* Clear the Entity info. */ 358 entity->info = 0; 359 360 return 0; 361 } 362 363 /* Exported functions */ 364 365 /* Register the Firmware Image Package driver with the IO abstraction */ 366 int register_io_dev_fip(const io_dev_connector_t **dev_con) 367 { 368 int result; 369 assert(dev_con != NULL); 370 371 result = io_register_device(&fip_dev_info); 372 if (result == 0) 373 *dev_con = &fip_dev_connector; 374 375 return result; 376 } 377