blob: ecf7cc0576342e4fcfb6f860eefddd2f0434bff0 [file] [log] [blame]
Summer Qin9db8f2e2017-04-24 16:49:28 +01001/*
2 * Copyright (c) 2017, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#include <arch_helpers.h>
8#include <assert.h>
9#include <debug.h>
10#include <desc_image_load.h>
11#include <errno.h>
12#include <optee_utils.h>
13
14/*
15 * load_addr_hi and load_addr_lo: image load address.
16 * image_id: 0 - pager, 1 - paged
17 * size: image size in bytes.
18 */
19typedef struct optee_image {
20 uint32_t load_addr_hi;
21 uint32_t load_addr_lo;
22 uint32_t image_id;
23 uint32_t size;
24} optee_image_t;
25
26#define OPTEE_PAGER_IMAGE_ID 0
27#define OPTEE_PAGED_IMAGE_ID 1
28#define OPTEE_MAX_IMAGE_NUM 2
29
30#define TEE_MAGIC_NUM_OPTEE 0x4554504f
31/*
32 * magic: header magic number.
33 * version: OPTEE header version:
34 * 1 - not supported
35 * 2 - supported
36 * arch: OPTEE os architecture type: 0 - AARCH32, 1 - AARCH64.
37 * flags: unused currently.
38 * nb_images: number of images.
39 */
40typedef struct optee_header {
41 uint32_t magic;
42 uint8_t version;
43 uint8_t arch;
44 uint16_t flags;
45 uint32_t nb_images;
Daniel Boulbyc5259cc2018-05-15 11:41:55 +010046 optee_image_t optee_image_list[];
Summer Qin9db8f2e2017-04-24 16:49:28 +010047} optee_header_t;
48
49/*******************************************************************************
50 * Check if it is a valid tee header
51 * Return 1 if valid
52 * Return 0 if invalid
53 ******************************************************************************/
Daniel Boulbyc5259cc2018-05-15 11:41:55 +010054static inline int tee_validate_header(optee_header_t *header)
Summer Qin9db8f2e2017-04-24 16:49:28 +010055{
Daniel Boulbyc5259cc2018-05-15 11:41:55 +010056 if ((header->magic == TEE_MAGIC_NUM_OPTEE) &&
57 (header->version == 2) &&
58 (header->nb_images <= OPTEE_MAX_IMAGE_NUM)) {
Summer Qin9db8f2e2017-04-24 16:49:28 +010059 return 1;
60 }
61
62 WARN("Not a known TEE, use default loading options.\n");
63 return 0;
64}
65
66/*******************************************************************************
67 * Parse the OPTEE image
68 * Return 0 on success or a negative error code otherwise.
69 ******************************************************************************/
70static int parse_optee_image(image_info_t *image_info,
Daniel Boulbyc5259cc2018-05-15 11:41:55 +010071 optee_image_t *image)
Summer Qin9db8f2e2017-04-24 16:49:28 +010072{
73 uintptr_t init_load_addr, free_end, requested_end;
74 size_t init_size;
75
Daniel Boulbyc5259cc2018-05-15 11:41:55 +010076 init_load_addr = ((uint64_t)image->load_addr_hi << 32) |
77 image->load_addr_lo;
78 init_size = image->size;
Summer Qin9db8f2e2017-04-24 16:49:28 +010079
80 /*
81 * -1 indicates loader decided address; take our pre-mapped area
82 * for current image since arm-tf could not allocate memory dynamically
83 */
84 if (init_load_addr == -1)
85 init_load_addr = image_info->image_base;
86
87 /* Check that the default end address doesn't overflow */
88 if (check_uptr_overflow(image_info->image_base,
89 image_info->image_max_size - 1))
90 return -1;
91 free_end = image_info->image_base + (image_info->image_max_size - 1);
92
93 /* Check that the image end address doesn't overflow */
94 if (check_uptr_overflow(init_load_addr, init_size - 1))
95 return -1;
96 requested_end = init_load_addr + (init_size - 1);
97 /*
98 * Check that the requested RAM location is within reserved
99 * space for OPTEE.
100 */
101 if (!((init_load_addr >= image_info->image_base) &&
102 (requested_end <= free_end))) {
103 WARN("The load address in optee header %p - %p is not in reserved area: %p - %p.\n",
104 (void *)init_load_addr,
105 (void *)(init_load_addr + init_size),
106 (void *)image_info->image_base,
107 (void *)(image_info->image_base +
108 image_info->image_max_size));
109 return -1;
110 }
111
112 /*
113 * Remove the skip attr from image_info, the image will be loaded.
114 * The default attr in image_info is "IMAGE_ATTRIB_SKIP_LOADING", which
115 * mean the image will not be loaded. Here, we parse the header image to
116 * know that the extra image need to be loaded, so remove the skip attr.
117 */
118 image_info->h.attr &= ~IMAGE_ATTRIB_SKIP_LOADING;
119
120 /* Update image base and size of image_info */
121 image_info->image_base = init_load_addr;
122 image_info->image_size = init_size;
123
124 return 0;
125}
126
127/*******************************************************************************
128 * Parse the OPTEE header
129 * Return 0 on success or a negative error code otherwise.
130 ******************************************************************************/
131int parse_optee_header(entry_point_info_t *header_ep,
132 image_info_t *pager_image_info,
133 image_info_t *paged_image_info)
134
135{
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100136 optee_header_t *header;
Summer Qin9db8f2e2017-04-24 16:49:28 +0100137 int num, ret;
138
139 assert(header_ep);
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100140 header = (optee_header_t *)header_ep->pc;
141 assert(header);
Summer Qin9db8f2e2017-04-24 16:49:28 +0100142
Victor Chongeb3dcd62018-01-26 16:10:07 +0900143 /* Print the OPTEE header information */
144 INFO("OPTEE ep=0x%x\n", (unsigned int)header_ep->pc);
145 INFO("OPTEE header info:\n");
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100146 INFO(" magic=0x%x\n", header->magic);
147 INFO(" version=0x%x\n", header->version);
148 INFO(" arch=0x%x\n", header->arch);
149 INFO(" flags=0x%x\n", header->flags);
150 INFO(" nb_images=0x%x\n", header->nb_images);
Victor Chongeb3dcd62018-01-26 16:10:07 +0900151
Summer Qin9db8f2e2017-04-24 16:49:28 +0100152 /*
153 * OPTEE image has 3 types:
154 *
155 * 1. Plain OPTEE bin without header.
156 * Original bin without header, return directly,
157 * BL32_EXTRA1_IMAGE_ID and BL32_EXTRA2_IMAGE_ID will be skipped.
158 *
159 * 2. OPTEE bin with header bin, but no paging.
160 * Header available and nb_images = 1, remove skip attr for
161 * BL32_EXTRA1_IMAGE_ID. BL32_EXTRA1_IMAGE_ID will be loaded,
162 * and BL32_EXTRA2_IMAGE_ID be skipped.
163 *
164 * 3. OPTEE image with paging support.
165 * Header available and nb_images = 2, there are 3 bins: header,
166 * pager and pageable. Remove skip attr for BL32_EXTRA1_IMAGE_ID
167 * and BL32_EXTRA2_IMAGE_ID to load pager and paged bin.
168 */
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100169 if (!tee_validate_header(header)) {
Etienne Carrieredc8bbb42018-02-05 10:42:42 +0100170 INFO("Invalid OPTEE header, set legacy mode.\n");
171#ifdef AARCH64
Summer Qin9db8f2e2017-04-24 16:49:28 +0100172 header_ep->args.arg0 = MODE_RW_64;
Etienne Carrieredc8bbb42018-02-05 10:42:42 +0100173#else
174 header_ep->args.arg0 = MODE_RW_32;
175#endif
Summer Qin9db8f2e2017-04-24 16:49:28 +0100176 return 0;
177 }
178
Summer Qin9db8f2e2017-04-24 16:49:28 +0100179 /* Parse OPTEE image */
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100180 for (num = 0; num < header->nb_images; num++) {
181 if (header->optee_image_list[num].image_id ==
Summer Qin9db8f2e2017-04-24 16:49:28 +0100182 OPTEE_PAGER_IMAGE_ID) {
183 ret = parse_optee_image(pager_image_info,
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100184 &header->optee_image_list[num]);
185 } else if (header->optee_image_list[num].image_id ==
Summer Qin9db8f2e2017-04-24 16:49:28 +0100186 OPTEE_PAGED_IMAGE_ID) {
187 ret = parse_optee_image(paged_image_info,
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100188 &header->optee_image_list[num]);
Summer Qin9db8f2e2017-04-24 16:49:28 +0100189 } else {
190 ERROR("Parse optee image failed.\n");
191 return -1;
192 }
193
194 if (ret != 0)
195 return -1;
196 }
197
198 /*
199 * Update "pc" value which should comes from pager image. After the
200 * header image is parsed, it will be unuseful, and the actual
201 * execution image after BL31 is pager image.
202 */
203 header_ep->pc = pager_image_info->image_base;
204
205 /*
206 * The paged load address and size are populated in
207 * header image arguments so that can be read by the
208 * BL32 SPD.
209 */
210 header_ep->args.arg1 = paged_image_info->image_base;
211 header_ep->args.arg2 = paged_image_info->image_size;
212
213 /* Set OPTEE runtime arch - aarch32/aarch64 */
Daniel Boulbyc5259cc2018-05-15 11:41:55 +0100214 if (header->arch == 0) {
Summer Qin9db8f2e2017-04-24 16:49:28 +0100215 header_ep->args.arg0 = MODE_RW_32;
Etienne Carrieredc8bbb42018-02-05 10:42:42 +0100216 } else {
217#ifdef AARCH64
Summer Qin9db8f2e2017-04-24 16:49:28 +0100218 header_ep->args.arg0 = MODE_RW_64;
Etienne Carrieredc8bbb42018-02-05 10:42:42 +0100219#else
220 ERROR("Cannot boot an AArch64 OP-TEE\n");
221 return -1;
222#endif
223 }
Summer Qin9db8f2e2017-04-24 16:49:28 +0100224
225 return 0;
226}