blob: 0cec80448ee30ec6f3979ee55182ee861bbc143c [file] [log] [blame]
Harry Liebel561cd332014-02-14 14:42:48 +00001/*
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
Harry Liebel561cd332014-02-14 14:42:48 +000031#include <assert.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010032#include <bl_common.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010033#include <debug.h>
34#include <errno.h>
Dan Handley714a0d22014-04-09 13:13:04 +010035#include <firmware_image_package.h>
Dan Handley714a0d22014-04-09 13:13:04 +010036#include <io_driver.h>
37#include <io_fip.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010038#include <io_storage.h>
39#include <platform.h>
Dan Handleyed6ff952014-05-14 17:44:19 +010040#include <platform_def.h>
Dan Handley2bd4ef22014-04-09 13:14:54 +010041#include <stdint.h>
42#include <string.h>
43#include <uuid.h>
Harry Liebel561cd332014-02-14 14:42:48 +000044
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
53typedef struct {
54 const char *name;
55 const uuid_t uuid;
Dan Handleye2712bc2014-04-10 15:37:22 +010056} plat_fip_name_uuid_t;
Harry Liebel561cd332014-02-14 14:42:48 +000057
58typedef 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;
Dan Handleye2712bc2014-04-10 15:37:22 +010064 fip_toc_entry_t entry;
65} file_state_t;
Harry Liebel561cd332014-02-14 14:42:48 +000066
Dan Handleya4cb68e2014-04-23 13:47:06 +010067static const plat_fip_name_uuid_t name_uuid[] = {
Harry Liebel561cd332014-02-14 14:42:48 +000068 {BL2_IMAGE_NAME, UUID_TRUSTED_BOOT_FIRMWARE_BL2},
Sandrine Bailleuxf841ef02014-06-24 14:19:36 +010069#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 */
Harry Liebel561cd332014-02-14 14:42:48 +000073 {BL31_IMAGE_NAME, UUID_EL3_RUNTIME_FIRMWARE_BL31},
Dan Handley21a30ab2014-04-15 11:38:38 +010074#ifdef BL32_IMAGE_NAME
75 /* BL3-2 is optional in the platform */
Harry Liebel561cd332014-02-14 14:42:48 +000076 {BL32_IMAGE_NAME, UUID_SECURE_PAYLOAD_BL32},
Dan Handley21a30ab2014-04-15 11:38:38 +010077#endif /* BL32_IMAGE_NAME */
Harry Liebel561cd332014-02-14 14:42:48 +000078 {BL33_IMAGE_NAME, UUID_NON_TRUSTED_FIRMWARE_BL33},
Juan Castillod227d8b2015-01-07 13:49:59 +000079#if TRUSTED_BOARD_BOOT
80 /* Certificates */
81 {BL2_CERT_NAME, UUID_TRUSTED_BOOT_FIRMWARE_BL2_CERT},
Juan Castillo9246ab82015-01-28 16:46:57 +000082 {TRUSTED_KEY_CERT_NAME, UUID_TRUSTED_KEY_CERT},
83#ifdef BL30_KEY_CERT_NAME
84 {BL30_KEY_CERT_NAME, UUID_SCP_FIRMWARE_BL30_KEY_CERT},
85#endif
86 {BL31_KEY_CERT_NAME, UUID_EL3_RUNTIME_FIRMWARE_BL31_KEY_CERT},
87 {BL32_KEY_CERT_NAME, UUID_SECURE_PAYLOAD_BL32_KEY_CERT},
88 {BL33_KEY_CERT_NAME, UUID_NON_TRUSTED_FIRMWARE_BL33_KEY_CERT},
89#ifdef BL30_CERT_NAME
90 {BL30_CERT_NAME, UUID_SCP_FIRMWARE_BL30_CERT},
91#endif
92 {BL31_CERT_NAME, UUID_EL3_RUNTIME_FIRMWARE_BL31_CERT},
93 {BL32_CERT_NAME, UUID_SECURE_PAYLOAD_BL32_CERT},
94 {BL33_CERT_NAME, UUID_NON_TRUSTED_FIRMWARE_BL33_CERT},
Juan Castillod227d8b2015-01-07 13:49:59 +000095#endif /* TRUSTED_BOARD_BOOT */
Harry Liebel561cd332014-02-14 14:42:48 +000096};
97
98static const uuid_t uuid_null = {0};
Dan Handleye2712bc2014-04-10 15:37:22 +010099static file_state_t current_file = {0};
Dan Handleya4cb68e2014-04-23 13:47:06 +0100100static uintptr_t backend_dev_handle;
101static uintptr_t backend_image_spec;
Harry Liebel561cd332014-02-14 14:42:48 +0000102
103
104/* Firmware Image Package driver functions */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100105static int fip_dev_open(const uintptr_t dev_spec, io_dev_info_t **dev_info);
106static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +0100107 io_entity_t *entity);
108static int fip_file_len(io_entity_t *entity, size_t *length);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100109static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
Harry Liebel561cd332014-02-14 14:42:48 +0000110 size_t *length_read);
Dan Handleye2712bc2014-04-10 15:37:22 +0100111static int fip_file_close(io_entity_t *entity);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100112static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params);
Dan Handleye2712bc2014-04-10 15:37:22 +0100113static int fip_dev_close(io_dev_info_t *dev_info);
Harry Liebel561cd332014-02-14 14:42:48 +0000114
115
116static inline int copy_uuid(uuid_t *dst, const uuid_t *src)
117{
118 memcpy(dst, src, sizeof(uuid_t));
119 return 0;
120}
121
122
123/* Return 0 for equal uuids. */
124static inline int compare_uuids(const uuid_t *uuid1, const uuid_t *uuid2)
125{
126 return memcmp(uuid1, uuid2, sizeof(uuid_t));
127}
128
129
130/* TODO: We could check version numbers or do a package checksum? */
Dan Handleye2712bc2014-04-10 15:37:22 +0100131static inline int is_valid_header(fip_toc_header_t *header)
Harry Liebel561cd332014-02-14 14:42:48 +0000132{
133 if ((header->name == TOC_HEADER_NAME) && (header->serial_number != 0)) {
134 return 1;
135 } else {
136 return 0;
137 }
138}
139
140
141static int file_to_uuid(const char *filename, uuid_t *uuid)
142{
143 int i;
144 int status = -EINVAL;
145
Sandrine Bailleux0c51e072014-03-19 16:03:48 +0000146 for (i = 0; i < (sizeof(name_uuid) / sizeof(name_uuid[0])); i++) {
Harry Liebel561cd332014-02-14 14:42:48 +0000147 if (strcmp(filename, name_uuid[i].name) == 0) {
148 copy_uuid(uuid, &name_uuid[i].uuid);
149 status = 0;
150 break;
151 }
152 }
153 return status;
154}
155
156
157/* Identify the device type as a virtual driver */
Dan Handleye2712bc2014-04-10 15:37:22 +0100158io_type_t device_type_fip(void)
Harry Liebel561cd332014-02-14 14:42:48 +0000159{
160 return IO_TYPE_FIRMWARE_IMAGE_PACKAGE;
161}
162
163
Dan Handleya4cb68e2014-04-23 13:47:06 +0100164static const io_dev_connector_t fip_dev_connector = {
Harry Liebel561cd332014-02-14 14:42:48 +0000165 .dev_open = fip_dev_open
166};
167
168
Dan Handleya4cb68e2014-04-23 13:47:06 +0100169static const io_dev_funcs_t fip_dev_funcs = {
Harry Liebel561cd332014-02-14 14:42:48 +0000170 .type = device_type_fip,
171 .open = fip_file_open,
172 .seek = NULL,
173 .size = fip_file_len,
174 .read = fip_file_read,
175 .write = NULL,
176 .close = fip_file_close,
177 .dev_init = fip_dev_init,
178 .dev_close = fip_dev_close,
179};
180
181
Dan Handleya4cb68e2014-04-23 13:47:06 +0100182/* No state associated with this device so structure can be const */
183static const io_dev_info_t fip_dev_info = {
Harry Liebel561cd332014-02-14 14:42:48 +0000184 .funcs = &fip_dev_funcs,
185 .info = (uintptr_t)NULL
186};
187
188
189/* Open a connection to the FIP device */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100190static int fip_dev_open(const uintptr_t dev_spec __attribute__((unused)),
Dan Handleye2712bc2014-04-10 15:37:22 +0100191 io_dev_info_t **dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000192{
193 assert(dev_info != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100194 *dev_info = (io_dev_info_t *)&fip_dev_info; /* cast away const */
Harry Liebel561cd332014-02-14 14:42:48 +0000195
196 return IO_SUCCESS;
197}
198
199
200/* Do some basic package checks. */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100201static int fip_dev_init(io_dev_info_t *dev_info, const uintptr_t init_params)
Harry Liebel561cd332014-02-14 14:42:48 +0000202{
203 int result = IO_FAIL;
204 char *image_name = (char *)init_params;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100205 uintptr_t backend_handle;
Dan Handleye2712bc2014-04-10 15:37:22 +0100206 fip_toc_header_t header;
Harry Liebel561cd332014-02-14 14:42:48 +0000207 size_t bytes_read;
208
209 /* Obtain a reference to the image by querying the platform layer */
210 result = plat_get_image_source(image_name, &backend_dev_handle,
211 &backend_image_spec);
212 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000213 WARN("Failed to obtain reference to image '%s' (%i)\n",
Harry Liebel561cd332014-02-14 14:42:48 +0000214 image_name, result);
215 result = IO_FAIL;
216 goto fip_dev_init_exit;
217 }
218
219 /* Attempt to access the FIP image */
220 result = io_open(backend_dev_handle, backend_image_spec,
221 &backend_handle);
222 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000223 WARN("Failed to access image '%s' (%i)\n", image_name, result);
Harry Liebel561cd332014-02-14 14:42:48 +0000224 result = IO_FAIL;
225 goto fip_dev_init_exit;
226 }
227
Dan Handleya4cb68e2014-04-23 13:47:06 +0100228 result = io_read(backend_handle, (uintptr_t)&header, sizeof(header),
229 &bytes_read);
Harry Liebel561cd332014-02-14 14:42:48 +0000230 if (result == IO_SUCCESS) {
231 if (!is_valid_header(&header)) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000232 WARN("Firmware Image Package header check failed.\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000233 result = IO_FAIL;
234 } else {
Dan Handley91b624e2014-07-29 17:14:00 +0100235 VERBOSE("FIP header looks OK.\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000236 }
237 }
238
239 io_close(backend_handle);
240
241 fip_dev_init_exit:
242 return result;
243}
244
245/* Close a connection to the FIP device */
Dan Handleye2712bc2014-04-10 15:37:22 +0100246static int fip_dev_close(io_dev_info_t *dev_info)
Harry Liebel561cd332014-02-14 14:42:48 +0000247{
248 /* TODO: Consider tracking open files and cleaning them up here */
249
250 /* Clear the backend. */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100251 backend_dev_handle = (uintptr_t)NULL;
252 backend_image_spec = (uintptr_t)NULL;
Harry Liebel561cd332014-02-14 14:42:48 +0000253
254 return IO_SUCCESS;
255}
256
257
258/* Open a file for access from package. */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100259static int fip_file_open(io_dev_info_t *dev_info, const uintptr_t spec,
Dan Handleye2712bc2014-04-10 15:37:22 +0100260 io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000261{
262 int result = IO_FAIL;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100263 uintptr_t backend_handle;
Harry Liebel561cd332014-02-14 14:42:48 +0000264 uuid_t file_uuid;
Dan Handleye2712bc2014-04-10 15:37:22 +0100265 const io_file_spec_t *file_spec = (io_file_spec_t *)spec;
Harry Liebel561cd332014-02-14 14:42:48 +0000266 size_t bytes_read;
267 int found_file = 0;
268
269 assert(file_spec != NULL);
270 assert(entity != NULL);
271
272 /* Can only have one file open at a time for the moment. We need to
273 * track state like file cursor position. We know the header lives at
274 * offset zero, so this entry should never be zero for an active file.
275 * When the system supports dynamic memory allocation we can allow more
276 * than one open file at a time if needed.
277 */
278 if (current_file.entry.offset_address != 0) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000279 WARN("fip_file_open : Only one open file at a time.\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000280 return IO_RESOURCES_EXHAUSTED;
281 }
282
283 /* Attempt to access the FIP image */
284 result = io_open(backend_dev_handle, backend_image_spec,
285 &backend_handle);
286 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000287 WARN("Failed to open Firmware Image Package (%i)\n", result);
Harry Liebel561cd332014-02-14 14:42:48 +0000288 result = IO_FAIL;
289 goto fip_file_open_exit;
290 }
291
292 /* Seek past the FIP header into the Table of Contents */
Dan Handleye2712bc2014-04-10 15:37:22 +0100293 result = io_seek(backend_handle, IO_SEEK_SET, sizeof(fip_toc_header_t));
Harry Liebel561cd332014-02-14 14:42:48 +0000294 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000295 WARN("fip_file_open: failed to seek\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000296 result = IO_FAIL;
297 goto fip_file_open_close;
298 }
299
300 file_to_uuid(file_spec->path, &file_uuid);
301
302 found_file = 0;
303 do {
Dan Handleya4cb68e2014-04-23 13:47:06 +0100304 result = io_read(backend_handle,
305 (uintptr_t)&current_file.entry,
Harry Liebel561cd332014-02-14 14:42:48 +0000306 sizeof(current_file.entry),
307 &bytes_read);
308 if (result == IO_SUCCESS) {
309 if (compare_uuids(&current_file.entry.uuid,
310 &file_uuid) == 0) {
311 found_file = 1;
312 break;
313 }
314 } else {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000315 WARN("Failed to read FIP (%i)\n", result);
Harry Liebel561cd332014-02-14 14:42:48 +0000316 goto fip_file_open_close;
317 }
318 } while (compare_uuids(&current_file.entry.uuid, &uuid_null) != 0);
319
320 if (found_file == 1) {
321 /* All fine. Update entity info with file state and return. Set
322 * the file position to 0. The 'current_file.entry' holds the
323 * base and size of the file.
324 */
325 current_file.file_pos = 0;
326 entity->info = (uintptr_t)&current_file;
327 } else {
328 /* Did not find the file in the FIP. */
Jeenu Viswambharandd3dc322014-02-20 11:51:00 +0000329 current_file.entry.offset_address = 0;
Harry Liebel561cd332014-02-14 14:42:48 +0000330 result = IO_FAIL;
331 }
332
333 fip_file_open_close:
334 io_close(backend_handle);
335
336 fip_file_open_exit:
337 return result;
338}
339
340
341/* Return the size of a file in package */
Dan Handleye2712bc2014-04-10 15:37:22 +0100342static int fip_file_len(io_entity_t *entity, size_t *length)
Harry Liebel561cd332014-02-14 14:42:48 +0000343{
344 assert(entity != NULL);
345 assert(length != NULL);
346
Dan Handleye2712bc2014-04-10 15:37:22 +0100347 *length = ((file_state_t *)entity->info)->entry.size;
Harry Liebel561cd332014-02-14 14:42:48 +0000348
349 return IO_SUCCESS;
350}
351
352
353/* Read data from a file in package */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100354static int fip_file_read(io_entity_t *entity, uintptr_t buffer, size_t length,
Harry Liebel561cd332014-02-14 14:42:48 +0000355 size_t *length_read)
356{
357 int result = IO_FAIL;
Dan Handleye2712bc2014-04-10 15:37:22 +0100358 file_state_t *fp;
Harry Liebel561cd332014-02-14 14:42:48 +0000359 size_t file_offset;
360 size_t bytes_read;
Dan Handleya4cb68e2014-04-23 13:47:06 +0100361 uintptr_t backend_handle;
Harry Liebel561cd332014-02-14 14:42:48 +0000362
363 assert(entity != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100364 assert(buffer != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000365 assert(length_read != NULL);
Dan Handleya4cb68e2014-04-23 13:47:06 +0100366 assert(entity->info != (uintptr_t)NULL);
Harry Liebel561cd332014-02-14 14:42:48 +0000367
368 /* Open the backend, attempt to access the blob image */
369 result = io_open(backend_dev_handle, backend_image_spec,
370 &backend_handle);
371 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000372 WARN("Failed to open FIP (%i)\n", result);
Harry Liebel561cd332014-02-14 14:42:48 +0000373 result = IO_FAIL;
374 goto fip_file_read_exit;
375 }
376
Dan Handleye2712bc2014-04-10 15:37:22 +0100377 fp = (file_state_t *)entity->info;
Harry Liebel561cd332014-02-14 14:42:48 +0000378
379 /* Seek to the position in the FIP where the payload lives */
380 file_offset = fp->entry.offset_address + fp->file_pos;
381 result = io_seek(backend_handle, IO_SEEK_SET, file_offset);
382 if (result != IO_SUCCESS) {
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000383 WARN("fip_file_read: failed to seek\n");
Harry Liebel561cd332014-02-14 14:42:48 +0000384 result = IO_FAIL;
385 goto fip_file_read_close;
386 }
387
388 result = io_read(backend_handle, buffer, length, &bytes_read);
389 if (result != IO_SUCCESS) {
390 /* We cannot read our data. Fail. */
Jeenu Viswambharan08c28d52014-02-20 12:03:31 +0000391 WARN("Failed to read payload (%i)\n", result);
Harry Liebel561cd332014-02-14 14:42:48 +0000392 result = IO_FAIL;
393 goto fip_file_read_close;
394 } else {
395 /* Set caller length and new file position. */
396 *length_read = bytes_read;
397 fp->file_pos += bytes_read;
398 }
399
400/* Close the backend. */
401 fip_file_read_close:
402 io_close(backend_handle);
403
404 fip_file_read_exit:
405 return result;
406}
407
408
409/* Close a file in package */
Dan Handleye2712bc2014-04-10 15:37:22 +0100410static int fip_file_close(io_entity_t *entity)
Harry Liebel561cd332014-02-14 14:42:48 +0000411{
412 /* Clear our current file pointer.
413 * If we had malloc() we would free() here.
414 */
415 if (current_file.entry.offset_address != 0) {
416 memset(&current_file, 0, sizeof(current_file));
417 }
418
419 /* Clear the Entity info. */
420 entity->info = 0;
421
422 return IO_SUCCESS;
423}
424
425/* Exported functions */
426
427/* Register the Firmware Image Package driver with the IO abstraction */
Dan Handleya4cb68e2014-04-23 13:47:06 +0100428int register_io_dev_fip(const io_dev_connector_t **dev_con)
Harry Liebel561cd332014-02-14 14:42:48 +0000429{
430 int result = IO_FAIL;
431 assert(dev_con != NULL);
432
433 result = io_register_device(&fip_dev_info);
434 if (result == IO_SUCCESS)
435 *dev_con = &fip_dev_connector;
436
437 return result;
438}