blob: d4cd8487ccac7be338f4703f9bd6aba5916c1b8d [file] [log] [blame]
David Brazdil7a462ec2019-08-15 12:27:47 +01001/*
2 * Copyright 2019 The Hafnium Authors.
3 *
Andrew Walbrane959ec12020-06-17 15:01:09 +01004 * Use of this source code is governed by a BSD-style
5 * license that can be found in the LICENSE file or at
6 * https://opensource.org/licenses/BSD-3-Clause.
David Brazdil7a462ec2019-08-15 12:27:47 +01007 */
8
9#include "hf/manifest.h"
10
J-Alvesd8a1d362023-03-08 11:15:28 +000011#include <stddef.h>
J-Alves77b6f4f2023-03-15 11:34:49 +000012#include <stdint.h>
J-Alvesd8a1d362023-03-08 11:15:28 +000013
J-Alves35315782022-01-25 17:58:32 +000014#include "hf/arch/types.h"
J-Alves77b6f4f2023-03-15 11:34:49 +000015#include "hf/arch/vmid_base.h"
J-Alves35315782022-01-25 17:58:32 +000016
David Brazdil7a462ec2019-08-15 12:27:47 +010017#include "hf/addr.h"
Daniel Boulbya2f8c662021-11-26 17:52:53 +000018#include "hf/assert.h"
J-Alves35315782022-01-25 17:58:32 +000019#include "hf/boot_info.h"
J-Alves77b6f4f2023-03-15 11:34:49 +000020#include "hf/boot_params.h"
David Brazdil7a462ec2019-08-15 12:27:47 +010021#include "hf/check.h"
Andrew Scullae9962e2019-10-03 16:51:16 +010022#include "hf/dlog.h"
J-Alves77b6f4f2023-03-15 11:34:49 +000023#include "hf/fdt.h"
24#include "hf/mm.h"
25#include "hf/mpool.h"
J-Alves2f86c1e2022-02-23 18:44:19 +000026#include "hf/sp_pkg.h"
David Brazdil7a462ec2019-08-15 12:27:47 +010027#include "hf/static_assert.h"
28#include "hf/std.h"
29
30#define TRY(expr) \
31 do { \
32 enum manifest_return_code ret_code = (expr); \
33 if (ret_code != MANIFEST_SUCCESS) { \
34 return ret_code; \
35 } \
36 } while (0)
37
David Brazdilb856be62020-03-25 10:14:55 +000038#define VM_ID_MAX (HF_VM_ID_OFFSET + MAX_VMS - 1)
39#define VM_ID_MAX_DIGITS (5)
40#define VM_NAME_EXTRA_CHARS (3) /* "vm" + number + '\0' */
41#define VM_NAME_MAX_SIZE (VM_ID_MAX_DIGITS + VM_NAME_EXTRA_CHARS)
42static_assert(VM_NAME_MAX_SIZE <= STRING_MAX_SIZE,
43 "VM name does not fit into a struct string.");
44static_assert(VM_ID_MAX <= 99999, "Insufficient VM_NAME_BUF_SIZE");
Olivier Deprez2a8ee342020-08-03 15:10:44 +020045static_assert((HF_OTHER_WORLD_ID > VM_ID_MAX) ||
46 (HF_OTHER_WORLD_ID < HF_VM_ID_BASE),
Andrew Walbran9daa57e2019-09-27 13:33:20 +010047 "TrustZone VM ID clashes with normal VM range.");
David Brazdil7a462ec2019-08-15 12:27:47 +010048
Daniel Boulby801f8ef2022-06-27 14:21:01 +010049/**
J-Alves596049f2023-03-15 11:40:24 +000050 * A struct to keep track of the partitions properties during early boot
51 * manifest parsing:
52 * - Interrupts ID.
53 * - Physical memory ranges.
Daniel Boulby801f8ef2022-06-27 14:21:01 +010054 */
Olivier Deprez93644652022-09-09 11:01:12 +020055struct manifest_data {
56 struct manifest manifest;
Daniel Boulby4ca50f02022-07-29 18:29:34 +010057 struct interrupt_bitmap intids;
J-Alves596049f2023-03-15 11:40:24 +000058 /*
59 * Allocate enough for the maximum amount of memory regions defined via
60 * the partitions manifest, and regions for each partition
61 * address-space.
62 */
63 struct mem_range
64 mem_regions[PARTITION_MAX_MEMORY_REGIONS * MAX_VMS + MAX_VMS];
Daniel Boulby801f8ef2022-06-27 14:21:01 +010065};
Olivier Deprez93644652022-09-09 11:01:12 +020066
Daniel Boulby801f8ef2022-06-27 14:21:01 +010067/**
Daniel Boulbya7e9e182022-06-27 14:21:01 +010068 * Calculate the number of entries in the ppool that are required to
Olivier Deprez93644652022-09-09 11:01:12 +020069 * store the manifest_data struct.
Daniel Boulby801f8ef2022-06-27 14:21:01 +010070 */
J-Alves596049f2023-03-15 11:40:24 +000071static const size_t manifest_data_ppool_entries =
Olivier Deprez93644652022-09-09 11:01:12 +020072 (align_up(sizeof(struct manifest_data), MM_PPOOL_ENTRY_SIZE) /
Daniel Boulbya7e9e182022-06-27 14:21:01 +010073 MM_PPOOL_ENTRY_SIZE);
74
Olivier Deprez93644652022-09-09 11:01:12 +020075static struct manifest_data *manifest_data;
76/* Index used to track the number of memory regions allocated. */
Daniel Boulbya7e9e182022-06-27 14:21:01 +010077static size_t allocated_mem_regions_index = 0;
Daniel Boulby801f8ef2022-06-27 14:21:01 +010078
79/**
Olivier Deprez93644652022-09-09 11:01:12 +020080 * Allocates and clear memory for the manifest data in the given memory pool.
Daniel Boulby801f8ef2022-06-27 14:21:01 +010081 * Returns true if the memory is successfully allocated.
82 */
Olivier Deprez93644652022-09-09 11:01:12 +020083static bool manifest_data_init(struct mpool *ppool)
Daniel Boulby801f8ef2022-06-27 14:21:01 +010084{
Olivier Deprez93644652022-09-09 11:01:12 +020085 manifest_data = (struct manifest_data *)mpool_alloc_contiguous(
86 ppool, manifest_data_ppool_entries, 1);
87 memset_s(manifest_data, sizeof(struct manifest_data), 0,
88 sizeof(struct manifest_data));
Daniel Boulbya7e9e182022-06-27 14:21:01 +010089
Olivier Deprez93644652022-09-09 11:01:12 +020090 return manifest_data != NULL;
Daniel Boulby801f8ef2022-06-27 14:21:01 +010091}
92
93/**
Olivier Deprez93644652022-09-09 11:01:12 +020094 * Frees the memory used for the manifest data in the given memory pool.
Daniel Boulby801f8ef2022-06-27 14:21:01 +010095 */
Olivier Deprez93644652022-09-09 11:01:12 +020096static void manifest_data_deinit(struct mpool *ppool)
Daniel Boulby801f8ef2022-06-27 14:21:01 +010097{
Daniel Boulbya7e9e182022-06-27 14:21:01 +010098 /**
Olivier Deprez93644652022-09-09 11:01:12 +020099 * Clear and return the memory used for the manifest_data struct to the
100 * memory pool.
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100101 */
Olivier Deprez93644652022-09-09 11:01:12 +0200102 memset_s(manifest_data, sizeof(struct manifest_data), 0,
103 sizeof(struct manifest_data));
104 mpool_add_chunk(ppool, manifest_data, manifest_data_ppool_entries);
105
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100106 /**
107 * Reset the index used for tracking the number of memory regions
108 * allocated.
109 */
110 allocated_mem_regions_index = 0;
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100111}
112
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100113static inline size_t count_digits(ffa_vm_id_t vm_id)
David Brazdilb856be62020-03-25 10:14:55 +0000114{
115 size_t digits = 0;
116
117 do {
118 digits++;
119 vm_id /= 10;
120 } while (vm_id);
121 return digits;
122}
123
David Brazdil7a462ec2019-08-15 12:27:47 +0100124/**
125 * Generates a string with the two letters "vm" followed by an integer.
126 * Assumes `buf` is of size VM_NAME_BUF_SIZE.
127 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100128static void generate_vm_node_name(struct string *str, ffa_vm_id_t vm_id)
David Brazdil7a462ec2019-08-15 12:27:47 +0100129{
130 static const char *digits = "0123456789";
David Brazdilb856be62020-03-25 10:14:55 +0000131 size_t vm_id_digits = count_digits(vm_id);
132 char *base = str->data;
133 char *ptr = base + (VM_NAME_EXTRA_CHARS + vm_id_digits);
David Brazdil7a462ec2019-08-15 12:27:47 +0100134
Daniel Boulbya2f8c662021-11-26 17:52:53 +0000135 assert(vm_id_digits <= VM_ID_MAX_DIGITS);
David Brazdil7a462ec2019-08-15 12:27:47 +0100136 *(--ptr) = '\0';
137 do {
138 *(--ptr) = digits[vm_id % 10];
139 vm_id /= 10;
140 } while (vm_id);
141 *(--ptr) = 'm';
142 *(--ptr) = 'v';
Daniel Boulbya2f8c662021-11-26 17:52:53 +0000143 assert(ptr == base);
David Brazdil7a462ec2019-08-15 12:27:47 +0100144}
145
Andrew Scullae9962e2019-10-03 16:51:16 +0100146/**
Andrew Scullb2c3a242019-11-04 13:52:36 +0000147 * Read a boolean property: true if present; false if not. If present, the value
148 * of the property must be empty else it is considered malformed.
Andrew Scullae9962e2019-10-03 16:51:16 +0100149 */
Andrew Scullb2c3a242019-11-04 13:52:36 +0000150static enum manifest_return_code read_bool(const struct fdt_node *node,
151 const char *property, bool *out)
Andrew Scullae9962e2019-10-03 16:51:16 +0100152{
David Brazdilb856be62020-03-25 10:14:55 +0000153 struct memiter data;
154 bool present = fdt_read_property(node, property, &data);
Andrew Scullae9962e2019-10-03 16:51:16 +0100155
David Brazdilb856be62020-03-25 10:14:55 +0000156 if (present && memiter_size(&data) != 0) {
Andrew Scullb2c3a242019-11-04 13:52:36 +0000157 return MANIFEST_ERROR_MALFORMED_BOOLEAN;
158 }
159
160 *out = present;
161 return MANIFEST_SUCCESS;
Andrew Scullae9962e2019-10-03 16:51:16 +0100162}
163
Andrew Scull72b43c02019-09-18 13:53:45 +0100164static enum manifest_return_code read_string(const struct fdt_node *node,
David Brazdil136f2942019-09-23 14:11:03 +0100165 const char *property,
166 struct string *out)
Andrew Scull72b43c02019-09-18 13:53:45 +0100167{
David Brazdilb856be62020-03-25 10:14:55 +0000168 struct memiter data;
Andrew Scull72b43c02019-09-18 13:53:45 +0100169
David Brazdilb856be62020-03-25 10:14:55 +0000170 if (!fdt_read_property(node, property, &data)) {
Andrew Scull72b43c02019-09-18 13:53:45 +0100171 return MANIFEST_ERROR_PROPERTY_NOT_FOUND;
172 }
173
David Brazdilb856be62020-03-25 10:14:55 +0000174 switch (string_init(out, &data)) {
David Brazdil136f2942019-09-23 14:11:03 +0100175 case STRING_SUCCESS:
176 return MANIFEST_SUCCESS;
177 case STRING_ERROR_INVALID_INPUT:
178 return MANIFEST_ERROR_MALFORMED_STRING;
179 case STRING_ERROR_TOO_LONG:
180 return MANIFEST_ERROR_STRING_TOO_LONG;
181 }
Andrew Scull72b43c02019-09-18 13:53:45 +0100182}
183
184static enum manifest_return_code read_optional_string(
David Brazdil136f2942019-09-23 14:11:03 +0100185 const struct fdt_node *node, const char *property, struct string *out)
Andrew Scull72b43c02019-09-18 13:53:45 +0100186{
David Brazdil136f2942019-09-23 14:11:03 +0100187 enum manifest_return_code ret;
Andrew Scull72b43c02019-09-18 13:53:45 +0100188
David Brazdil136f2942019-09-23 14:11:03 +0100189 ret = read_string(node, property, out);
190 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
191 string_init_empty(out);
192 ret = MANIFEST_SUCCESS;
Andrew Scull72b43c02019-09-18 13:53:45 +0100193 }
David Brazdil136f2942019-09-23 14:11:03 +0100194 return ret;
Andrew Scull72b43c02019-09-18 13:53:45 +0100195}
196
David Brazdil7a462ec2019-08-15 12:27:47 +0100197static enum manifest_return_code read_uint64(const struct fdt_node *node,
198 const char *property,
199 uint64_t *out)
200{
David Brazdilb856be62020-03-25 10:14:55 +0000201 struct memiter data;
David Brazdil7a462ec2019-08-15 12:27:47 +0100202
David Brazdilb856be62020-03-25 10:14:55 +0000203 if (!fdt_read_property(node, property, &data)) {
David Brazdil7a462ec2019-08-15 12:27:47 +0100204 return MANIFEST_ERROR_PROPERTY_NOT_FOUND;
205 }
206
David Brazdilb856be62020-03-25 10:14:55 +0000207 if (!fdt_parse_number(&data, memiter_size(&data), out)) {
David Brazdil7a462ec2019-08-15 12:27:47 +0100208 return MANIFEST_ERROR_MALFORMED_INTEGER;
209 }
210
211 return MANIFEST_SUCCESS;
212}
213
David Brazdil080ee312020-02-25 15:30:30 -0800214static enum manifest_return_code read_optional_uint64(
215 const struct fdt_node *node, const char *property,
216 uint64_t default_value, uint64_t *out)
217{
218 enum manifest_return_code ret;
219
220 ret = read_uint64(node, property, out);
221 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
222 *out = default_value;
223 return MANIFEST_SUCCESS;
224 }
225 return ret;
226}
227
Olivier Deprez62d99e32020-01-09 15:58:07 +0100228static enum manifest_return_code read_uint32(const struct fdt_node *node,
229 const char *property,
230 uint32_t *out)
231{
232 uint64_t value;
233
234 TRY(read_uint64(node, property, &value));
235
236 if (value > UINT32_MAX) {
237 return MANIFEST_ERROR_INTEGER_OVERFLOW;
238 }
239
240 *out = (uint32_t)value;
241 return MANIFEST_SUCCESS;
242}
243
Manish Pandeye68e7932020-04-23 15:29:28 +0100244static enum manifest_return_code read_optional_uint32(
245 const struct fdt_node *node, const char *property,
246 uint32_t default_value, uint32_t *out)
247{
248 enum manifest_return_code ret;
249
250 ret = read_uint32(node, property, out);
251 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
252 *out = default_value;
253 return MANIFEST_SUCCESS;
254 }
255 return ret;
256}
257
David Brazdil7a462ec2019-08-15 12:27:47 +0100258static enum manifest_return_code read_uint16(const struct fdt_node *node,
259 const char *property,
260 uint16_t *out)
261{
262 uint64_t value;
263
264 TRY(read_uint64(node, property, &value));
265
266 if (value > UINT16_MAX) {
267 return MANIFEST_ERROR_INTEGER_OVERFLOW;
268 }
269
270 *out = (uint16_t)value;
271 return MANIFEST_SUCCESS;
272}
273
J-Alvesb37fd082020-10-22 12:29:21 +0100274static enum manifest_return_code read_optional_uint16(
275 const struct fdt_node *node, const char *property,
276 uint16_t default_value, uint16_t *out)
277{
278 enum manifest_return_code ret;
279
280 ret = read_uint16(node, property, out);
281 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
282 *out = default_value;
283 return MANIFEST_SUCCESS;
284 }
285
286 return MANIFEST_SUCCESS;
287}
288
Olivier Deprez62d99e32020-01-09 15:58:07 +0100289static enum manifest_return_code read_uint8(const struct fdt_node *node,
290 const char *property, uint8_t *out)
291{
292 uint64_t value;
293
294 TRY(read_uint64(node, property, &value));
295
296 if (value > UINT8_MAX) {
297 return MANIFEST_ERROR_INTEGER_OVERFLOW;
298 }
299
300 *out = (uint8_t)value;
301 return MANIFEST_SUCCESS;
302}
303
J-Alves4369bd92020-08-07 16:35:36 +0100304static enum manifest_return_code read_optional_uint8(
305 const struct fdt_node *node, const char *property,
306 uint8_t default_value, uint8_t *out)
307{
308 enum manifest_return_code ret;
309
310 ret = read_uint8(node, property, out);
311 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
312 *out = default_value;
313 return MANIFEST_SUCCESS;
314 }
315
316 return MANIFEST_SUCCESS;
317}
318
Andrew Scullae9962e2019-10-03 16:51:16 +0100319struct uint32list_iter {
320 struct memiter mem_it;
321};
322
J-Alves4369bd92020-08-07 16:35:36 +0100323static enum manifest_return_code read_uint32list(const struct fdt_node *node,
324 const char *property,
325 struct uint32list_iter *out)
Andrew Scullae9962e2019-10-03 16:51:16 +0100326{
David Brazdilb856be62020-03-25 10:14:55 +0000327 struct memiter data;
Andrew Scullae9962e2019-10-03 16:51:16 +0100328
David Brazdilb856be62020-03-25 10:14:55 +0000329 if (!fdt_read_property(node, property, &data)) {
Andrew Scullae9962e2019-10-03 16:51:16 +0100330 memiter_init(&out->mem_it, NULL, 0);
J-Alves4369bd92020-08-07 16:35:36 +0100331 return MANIFEST_ERROR_PROPERTY_NOT_FOUND;
Andrew Scullae9962e2019-10-03 16:51:16 +0100332 }
333
David Brazdilb856be62020-03-25 10:14:55 +0000334 if ((memiter_size(&data) % sizeof(uint32_t)) != 0) {
Andrew Scullae9962e2019-10-03 16:51:16 +0100335 return MANIFEST_ERROR_MALFORMED_INTEGER_LIST;
336 }
337
David Brazdilb856be62020-03-25 10:14:55 +0000338 out->mem_it = data;
Andrew Scullae9962e2019-10-03 16:51:16 +0100339 return MANIFEST_SUCCESS;
340}
341
J-Alves4369bd92020-08-07 16:35:36 +0100342static enum manifest_return_code read_optional_uint32list(
343 const struct fdt_node *node, const char *property,
344 struct uint32list_iter *out)
345{
346 enum manifest_return_code ret = read_uint32list(node, property, out);
347
348 if (ret == MANIFEST_ERROR_PROPERTY_NOT_FOUND) {
349 return MANIFEST_SUCCESS;
350 }
351 return ret;
352}
353
Andrew Scullae9962e2019-10-03 16:51:16 +0100354static bool uint32list_has_next(const struct uint32list_iter *list)
355{
356 return memiter_size(&list->mem_it) > 0;
357}
358
David Brazdil5ea99462020-03-25 13:01:47 +0000359static enum manifest_return_code uint32list_get_next(
360 struct uint32list_iter *list, uint32_t *out)
Andrew Scullae9962e2019-10-03 16:51:16 +0100361{
Andrew Scullae9962e2019-10-03 16:51:16 +0100362 uint64_t num;
363
364 CHECK(uint32list_has_next(list));
David Brazdilb856be62020-03-25 10:14:55 +0000365 if (!fdt_parse_number(&list->mem_it, sizeof(uint32_t), &num)) {
Andrew Scullae9962e2019-10-03 16:51:16 +0100366 return MANIFEST_ERROR_MALFORMED_INTEGER;
367 }
368
David Brazdil5ea99462020-03-25 13:01:47 +0000369 *out = (uint32_t)num;
370 return MANIFEST_SUCCESS;
Andrew Scullae9962e2019-10-03 16:51:16 +0100371}
372
Olivier Deprez62d99e32020-01-09 15:58:07 +0100373static enum manifest_return_code parse_vm_common(const struct fdt_node *node,
374 struct manifest_vm *vm,
375 ffa_vm_id_t vm_id)
David Brazdil7a462ec2019-08-15 12:27:47 +0100376{
Andrew Scullae9962e2019-10-03 16:51:16 +0100377 struct uint32list_iter smcs;
David Brazdil5ea99462020-03-25 13:01:47 +0000378 size_t idx;
Andrew Scullae9962e2019-10-03 16:51:16 +0100379
Olivier Deprez62d99e32020-01-09 15:58:07 +0100380 TRY(read_bool(node, "is_ffa_partition", &vm->is_ffa_partition));
381
Raghu Krishnamurthyb49549e2021-07-02 08:27:38 -0700382 TRY(read_bool(node, "hyp_loaded", &vm->is_hyp_loaded));
383
David Brazdil136f2942019-09-23 14:11:03 +0100384 TRY(read_string(node, "debug_name", &vm->debug_name));
Andrew Scullae9962e2019-10-03 16:51:16 +0100385
386 TRY(read_optional_uint32list(node, "smc_whitelist", &smcs));
387 while (uint32list_has_next(&smcs) &&
388 vm->smc_whitelist.smc_count < MAX_SMCS) {
David Brazdil5ea99462020-03-25 13:01:47 +0000389 idx = vm->smc_whitelist.smc_count++;
390 TRY(uint32list_get_next(&smcs, &vm->smc_whitelist.smcs[idx]));
Andrew Scullae9962e2019-10-03 16:51:16 +0100391 }
392
393 if (uint32list_has_next(&smcs)) {
Andrew Walbran17eebf92020-02-05 16:35:49 +0000394 dlog_warning("%s SMC whitelist too long.\n", vm->debug_name);
Andrew Scullae9962e2019-10-03 16:51:16 +0100395 }
396
Andrew Scullb2c3a242019-11-04 13:52:36 +0000397 TRY(read_bool(node, "smc_whitelist_permissive",
398 &vm->smc_whitelist.permissive));
Andrew Scullae9962e2019-10-03 16:51:16 +0100399
Olivier Deprez62d99e32020-01-09 15:58:07 +0100400 if (vm_id != HF_PRIMARY_VM_ID) {
401 TRY(read_uint64(node, "mem_size", &vm->secondary.mem_size));
402 TRY(read_uint16(node, "vcpu_count", &vm->secondary.vcpu_count));
Fuad Tabba50469e02020-06-30 15:14:28 +0100403 TRY(read_optional_string(node, "fdt_filename",
404 &vm->secondary.fdt_filename));
Olivier Deprez62d99e32020-01-09 15:58:07 +0100405 }
406
407 return MANIFEST_SUCCESS;
408}
409
410static enum manifest_return_code parse_vm(struct fdt_node *node,
411 struct manifest_vm *vm,
412 ffa_vm_id_t vm_id)
413{
414 TRY(read_optional_string(node, "kernel_filename",
415 &vm->kernel_filename));
416
David Brazdile6f83222019-09-23 14:47:37 +0100417 if (vm_id == HF_PRIMARY_VM_ID) {
418 TRY(read_optional_string(node, "ramdisk_filename",
419 &vm->primary.ramdisk_filename));
David Brazdil080ee312020-02-25 15:30:30 -0800420 TRY(read_optional_uint64(node, "boot_address",
421 MANIFEST_INVALID_ADDRESS,
422 &vm->primary.boot_address));
David Brazdil7a462ec2019-08-15 12:27:47 +0100423 }
Raghu Krishnamurthy988a5e72021-02-27 21:46:06 -0800424 TRY(read_optional_uint8(node, "exception-level", (uint8_t)EL1,
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700425 (uint8_t *)&vm->partition.run_time_el));
Olivier Deprez62d99e32020-01-09 15:58:07 +0100426
David Brazdil7a462ec2019-08-15 12:27:47 +0100427 return MANIFEST_SUCCESS;
428}
429
J-Alves77b6f4f2023-03-15 11:34:49 +0000430static bool is_memory_region_within_ranges(uintptr_t base_address,
431 uint32_t page_count,
432 const struct mem_range *ranges,
433 const size_t ranges_size)
434{
435 uintptr_t region_end =
436 base_address + ((uintptr_t)page_count * PAGE_SIZE - 1);
437
438 for (size_t i = 0; i < ranges_size; i++) {
439 uintptr_t base = (uintptr_t)pa_addr(ranges[i].begin);
440 uintptr_t end = (uintptr_t)pa_addr(ranges[i].end);
441
442 if ((base_address >= base && base_address <= end) ||
443 (region_end >= base && region_end <= end)) {
444 return true;
445 }
446 }
447
448 return false;
449}
450
451void dump_memory_ranges(const struct mem_range *ranges,
452 const size_t ranges_size, bool ns)
453{
454 if (LOG_LEVEL < LOG_LEVEL_VERBOSE) {
455 return;
456 }
457
458 dlog("%s Memory ranges:\n", ns ? "NS" : "S");
459
460 for (size_t i = 0; i < ranges_size; i++) {
461 uintptr_t begin = pa_addr(ranges[i].begin);
462 uintptr_t end = pa_addr(ranges[i].end);
463 size_t page_count =
464 align_up(pa_difference(ranges[i].begin, ranges[i].end),
465 PAGE_SIZE) /
466 PAGE_SIZE;
467
468 dlog(" [%x - %x (%u pages)]\n", begin, end, page_count);
469 }
470}
471
472/**
473 * Check the partition's assigned memory is contained in the memory ranges
474 * configured for the SWd, in the SPMC's manifest.
475 */
476static enum manifest_return_code check_partition_memory_is_valid(
477 uintptr_t base_address, uint32_t page_count, uint32_t attributes,
478 const struct boot_params *params)
479{
480 bool is_secure_region =
481 (attributes & MANIFEST_REGION_ATTR_SECURITY) == 0U;
482 const struct mem_range *ranges_from_manifest =
483 is_secure_region ? params->mem_ranges : params->ns_mem_ranges;
484 size_t ranges_count = is_secure_region ? params->mem_ranges_count
485 : params->ns_mem_ranges_count;
486 bool within_ranges = is_memory_region_within_ranges(
487 base_address, page_count, ranges_from_manifest, ranges_count);
488
489 return within_ranges ? MANIFEST_SUCCESS
490 : MANIFEST_ERROR_MEM_REGION_INVALID;
491}
492
493/*
494 * Keep track of the memory allocated by partitions. This includes memory region
495 * nodes defined in their respective partition manifests, as well address space
496 * defined from their load address.
497 */
498static enum manifest_return_code check_and_record_memory_used(
Varun Wadekar4afbfd72022-10-13 14:30:18 +0100499 uintptr_t base_address, uint32_t page_count)
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100500{
J-Alves77b6f4f2023-03-15 11:34:49 +0000501 bool overlap_of_regions;
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100502
Varun Wadekar4afbfd72022-10-13 14:30:18 +0100503 if (page_count == 0U) {
504 dlog_error(
Daniel Boulbyc1a613d2022-10-18 11:26:17 +0100505 "Empty memory region defined with base address: %#x.\n",
Varun Wadekar4afbfd72022-10-13 14:30:18 +0100506 base_address);
507 return MANIFEST_ERROR_MEM_REGION_EMPTY;
508 }
509
Daniel Boulbyc1a613d2022-10-18 11:26:17 +0100510 if (!is_aligned(base_address, PAGE_SIZE)) {
511 dlog_error("base_address (%#x) is not aligned to page size.\n",
512 base_address);
513 return MANIFEST_ERROR_MEM_REGION_UNALIGNED;
514 }
515
J-Alves77b6f4f2023-03-15 11:34:49 +0000516 overlap_of_regions = is_memory_region_within_ranges(
517 base_address, page_count, manifest_data->mem_regions,
518 allocated_mem_regions_index);
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100519
J-Alves77b6f4f2023-03-15 11:34:49 +0000520 if (!overlap_of_regions) {
521 paddr_t begin = pa_init(base_address);
522
523 manifest_data->mem_regions[allocated_mem_regions_index].begin =
524 begin;
525 manifest_data->mem_regions[allocated_mem_regions_index].end =
526 pa_add(begin, page_count * PAGE_SIZE - 1);
527 allocated_mem_regions_index++;
528
529 return MANIFEST_SUCCESS;
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100530 }
531
J-Alves77b6f4f2023-03-15 11:34:49 +0000532 return MANIFEST_ERROR_MEM_REGION_OVERLAP;
Daniel Boulbya7e9e182022-06-27 14:21:01 +0100533}
534
Manish Pandey6542f5c2020-04-27 14:37:46 +0100535static enum manifest_return_code parse_ffa_memory_region_node(
Manish Pandeyfa1f2912020-05-05 12:57:01 +0100536 struct fdt_node *mem_node, struct memory_region *mem_regions,
J-Alves77b6f4f2023-03-15 11:34:49 +0000537 uint16_t *count, struct rx_tx *rxtx,
538 const struct boot_params *boot_params)
Manish Pandey6542f5c2020-04-27 14:37:46 +0100539{
Manish Pandeyfa1f2912020-05-05 12:57:01 +0100540 uint32_t phandle;
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700541 uint16_t i = 0;
Manish Pandey6542f5c2020-04-27 14:37:46 +0100542
543 dlog_verbose(" Partition memory regions\n");
544
545 if (!fdt_is_compatible(mem_node, "arm,ffa-manifest-memory-regions")) {
546 return MANIFEST_ERROR_NOT_COMPATIBLE;
547 }
548
549 if (!fdt_first_child(mem_node)) {
550 return MANIFEST_ERROR_MEMORY_REGION_NODE_EMPTY;
551 }
552
553 do {
554 dlog_verbose(" Memory Region[%u]\n", i);
555
556 TRY(read_optional_string(mem_node, "description",
557 &mem_regions[i].name));
558 dlog_verbose(" Name: %s\n",
559 string_data(&mem_regions[i].name));
560
J-Alvesd8a1d362023-03-08 11:15:28 +0000561 TRY(read_uint64(mem_node, "base-address",
562 &mem_regions[i].base_address));
Manish Pandey6542f5c2020-04-27 14:37:46 +0100563 dlog_verbose(" Base address: %#x\n",
564 mem_regions[i].base_address);
565
566 TRY(read_uint32(mem_node, "pages-count",
567 &mem_regions[i].page_count));
568 dlog_verbose(" Pages_count: %u\n",
569 mem_regions[i].page_count);
570
571 TRY(read_uint32(mem_node, "attributes",
572 &mem_regions[i].attributes));
Raghu Krishnamurthy384693c2021-10-11 13:56:24 -0700573
Olivier Deprez035fa152022-03-14 11:19:10 +0100574 /*
575 * Check RWX permission attributes.
576 * Security attribute is checked at load phase.
577 */
578 uint32_t permissions = mem_regions[i].attributes &
579 (MANIFEST_REGION_ATTR_READ |
580 MANIFEST_REGION_ATTR_WRITE |
581 MANIFEST_REGION_ATTR_EXEC);
582 if (permissions != MANIFEST_REGION_ATTR_READ &&
583 permissions != (MANIFEST_REGION_ATTR_READ |
584 MANIFEST_REGION_ATTR_WRITE) &&
585 permissions != (MANIFEST_REGION_ATTR_READ |
586 MANIFEST_REGION_ATTR_EXEC)) {
Raghu Krishnamurthy384693c2021-10-11 13:56:24 -0700587 return MANIFEST_ERROR_INVALID_MEM_PERM;
588 }
589
Olivier Deprez035fa152022-03-14 11:19:10 +0100590 /* Filter memory region attributes. */
591 mem_regions[i].attributes &= MANIFEST_REGION_ALL_ATTR_MASK;
592
593 dlog_verbose(" Attributes: %#x\n",
Manish Pandey6542f5c2020-04-27 14:37:46 +0100594 mem_regions[i].attributes);
Manish Pandeyfa1f2912020-05-05 12:57:01 +0100595
J-Alves77b6f4f2023-03-15 11:34:49 +0000596 TRY(check_partition_memory_is_valid(
597 mem_regions[i].base_address, mem_regions[i].page_count,
598 mem_regions[i].attributes, boot_params));
599
600 TRY(check_and_record_memory_used(mem_regions[i].base_address,
601 mem_regions[i].page_count));
602
Manish Pandeya70a4192020-10-07 22:05:04 +0100603 if (rxtx->available) {
604 TRY(read_optional_uint32(
605 mem_node, "phandle",
606 (uint32_t)MANIFEST_INVALID_ADDRESS, &phandle));
607 if (phandle == rxtx->rx_phandle) {
608 dlog_verbose(" Assigned as RX buffer\n");
609 rxtx->rx_buffer = &mem_regions[i];
610 } else if (phandle == rxtx->tx_phandle) {
611 dlog_verbose(" Assigned as TX buffer\n");
612 rxtx->tx_buffer = &mem_regions[i];
613 }
Manish Pandeyfa1f2912020-05-05 12:57:01 +0100614 }
615
Manish Pandey6542f5c2020-04-27 14:37:46 +0100616 i++;
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700617 } while (fdt_next_sibling(mem_node) &&
618 (i < PARTITION_MAX_MEMORY_REGIONS));
Manish Pandey6542f5c2020-04-27 14:37:46 +0100619
Manish Pandeya70a4192020-10-07 22:05:04 +0100620 if (rxtx->available &&
621 (rxtx->rx_buffer->page_count != rxtx->tx_buffer->page_count)) {
Manish Pandeyf06c9072020-09-29 15:41:58 +0100622 return MANIFEST_ERROR_RXTX_SIZE_MISMATCH;
623 }
624
Manish Pandey2145c212020-05-01 16:04:22 +0100625 *count = i;
Manish Pandey6542f5c2020-04-27 14:37:46 +0100626
627 return MANIFEST_SUCCESS;
628}
629
Raghu Krishnamurthy98da1ca2022-10-04 08:59:01 -0700630static struct interrupt_info *device_region_get_interrupt_info(
631 struct device_region *dev_regions, uint32_t intid)
632{
633 for (uint32_t i = 0; i < ARRAY_SIZE(dev_regions->interrupts); i++) {
634 if (dev_regions->interrupts[i].id == intid) {
635 return &(dev_regions->interrupts[i]);
636 }
637 }
638 return NULL;
639}
640
Manish Pandeye68e7932020-04-23 15:29:28 +0100641static enum manifest_return_code parse_ffa_device_region_node(
Manish Pandey2145c212020-05-01 16:04:22 +0100642 struct fdt_node *dev_node, struct device_region *dev_regions,
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700643 uint16_t *count)
Manish Pandeye68e7932020-04-23 15:29:28 +0100644{
645 struct uint32list_iter list;
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700646 uint16_t i = 0;
Madhukar Pappireddy5fc8be12021-08-03 11:42:53 -0500647 uint32_t j = 0;
Olivier Deprez93644652022-09-09 11:01:12 +0200648 struct interrupt_bitmap allocated_intids = manifest_data->intids;
Manish Pandeye68e7932020-04-23 15:29:28 +0100649
650 dlog_verbose(" Partition Device Regions\n");
651
652 if (!fdt_is_compatible(dev_node, "arm,ffa-manifest-device-regions")) {
653 return MANIFEST_ERROR_NOT_COMPATIBLE;
654 }
655
656 if (!fdt_first_child(dev_node)) {
657 return MANIFEST_ERROR_DEVICE_REGION_NODE_EMPTY;
658 }
659
660 do {
661 dlog_verbose(" Device Region[%u]\n", i);
662
663 TRY(read_optional_string(dev_node, "description",
664 &dev_regions[i].name));
665 dlog_verbose(" Name: %s\n",
666 string_data(&dev_regions[i].name));
667
668 TRY(read_uint64(dev_node, "base-address",
669 &dev_regions[i].base_address));
670 dlog_verbose(" Base address: %#x\n",
671 dev_regions[i].base_address);
672
673 TRY(read_uint32(dev_node, "pages-count",
674 &dev_regions[i].page_count));
675 dlog_verbose(" Pages_count: %u\n",
676 dev_regions[i].page_count);
677
678 TRY(read_uint32(dev_node, "attributes",
679 &dev_regions[i].attributes));
Raghu Krishnamurthy384693c2021-10-11 13:56:24 -0700680
Olivier Deprez035fa152022-03-14 11:19:10 +0100681 /*
682 * Check RWX permission attributes.
683 * Security attribute is checked at load phase.
684 */
685 uint32_t permissions = dev_regions[i].attributes &
686 (MANIFEST_REGION_ATTR_READ |
687 MANIFEST_REGION_ATTR_WRITE |
688 MANIFEST_REGION_ATTR_EXEC);
689
690 if (permissions != MANIFEST_REGION_ATTR_READ &&
691 permissions != (MANIFEST_REGION_ATTR_READ |
692 MANIFEST_REGION_ATTR_WRITE)) {
Raghu Krishnamurthy384693c2021-10-11 13:56:24 -0700693 return MANIFEST_ERROR_INVALID_MEM_PERM;
694 }
695
Olivier Deprez035fa152022-03-14 11:19:10 +0100696 /* Filer device region attributes. */
697 dev_regions[i].attributes = dev_regions[i].attributes &
698 MANIFEST_REGION_ALL_ATTR_MASK;
699
700 dlog_verbose(" Attributes: %#x\n",
Manish Pandeye68e7932020-04-23 15:29:28 +0100701 dev_regions[i].attributes);
702
703 TRY(read_optional_uint32list(dev_node, "interrupts", &list));
704 dlog_verbose(" Interrupt List:\n");
705 j = 0;
706 while (uint32list_has_next(&list) &&
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700707 j < PARTITION_MAX_INTERRUPTS_PER_DEVICE) {
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100708 uint32_t intid;
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100709
Manish Pandeye68e7932020-04-23 15:29:28 +0100710 TRY(uint32list_get_next(
711 &list, &dev_regions[i].interrupts[j].id));
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100712 intid = dev_regions[i].interrupts[j].id;
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100713
714 dlog_verbose(" ID = %u\n", intid);
715
Daniel Boulby4ca50f02022-07-29 18:29:34 +0100716 if (interrupt_bitmap_get_value(&allocated_intids,
717 intid) == 1U) {
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100718 return MANIFEST_ERROR_INTERRUPT_ID_REPEATED;
719 }
720
Daniel Boulby4ca50f02022-07-29 18:29:34 +0100721 interrupt_bitmap_set_value(&allocated_intids, intid);
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100722
Manish Pandeye68e7932020-04-23 15:29:28 +0100723 if (uint32list_has_next(&list)) {
724 TRY(uint32list_get_next(&list,
725 &dev_regions[i]
726 .interrupts[j]
727 .attributes));
728 } else {
729 return MANIFEST_ERROR_MALFORMED_INTEGER_LIST;
730 }
731
Raghu Krishnamurthy98da1ca2022-10-04 08:59:01 -0700732 dev_regions[i].interrupts[j].mpidr_valid = false;
733 dev_regions[i].interrupts[j].mpidr = 0;
734
Daniel Boulby801f8ef2022-06-27 14:21:01 +0100735 dlog_verbose(" attributes = %u\n",
Manish Pandeye68e7932020-04-23 15:29:28 +0100736 dev_regions[i].interrupts[j].attributes);
737 j++;
738 }
Madhukar Pappireddy5fc8be12021-08-03 11:42:53 -0500739
740 dev_regions[i].interrupt_count = j;
Manish Pandeye68e7932020-04-23 15:29:28 +0100741 if (j == 0) {
742 dlog_verbose(" Empty\n");
Raghu Krishnamurthy98da1ca2022-10-04 08:59:01 -0700743 } else {
744 TRY(read_optional_uint32list(
745 dev_node, "interrupts-target", &list));
746 dlog_verbose(" Interrupt Target List:\n");
747
748 while (uint32list_has_next(&list)) {
749 uint32_t intid;
750 uint64_t mpidr = 0;
751 uint32_t mpidr_lower = 0;
752 uint32_t mpidr_upper = 0;
753 struct interrupt_info *info = NULL;
754
755 TRY(uint32list_get_next(&list, &intid));
756
757 dlog_verbose(" ID = %u\n", intid);
758
759 if (interrupt_bitmap_get_value(
760 &allocated_intids, intid) != 1U) {
761 return MANIFEST_ERROR_INTERRUPT_ID_NOT_IN_LIST;
762 }
763
764 TRY(uint32list_get_next(&list, &mpidr_upper));
765 TRY(uint32list_get_next(&list, &mpidr_lower));
766 mpidr = mpidr_upper;
767 mpidr <<= 32;
768 mpidr |= mpidr_lower;
769
770 info = device_region_get_interrupt_info(
771 &dev_regions[i], intid);
772 /*
773 * We should find info since
774 * interrupt_bitmap_get_value already ensures
775 * that we saw the interrupt and allocated ids
776 * for it.
777 */
778 assert(info != NULL);
779 info->mpidr = mpidr;
780 info->mpidr_valid = true;
781 dlog_verbose(" MPIDR = %#x\n", mpidr);
782 }
Manish Pandeye68e7932020-04-23 15:29:28 +0100783 }
784
785 TRY(read_optional_uint32(dev_node, "smmu-id",
Madhukar Pappireddy54680c72020-10-23 15:02:38 -0500786 MANIFEST_INVALID_ID,
Manish Pandeye68e7932020-04-23 15:29:28 +0100787 &dev_regions[i].smmu_id));
Olivier Deprez86d87ae2021-08-19 14:27:46 +0200788 if (dev_regions[i].smmu_id != MANIFEST_INVALID_ID) {
789 dlog_verbose(" smmu-id: %u\n",
790 dev_regions[i].smmu_id);
791 }
Manish Pandeye68e7932020-04-23 15:29:28 +0100792
793 TRY(read_optional_uint32list(dev_node, "stream-ids", &list));
794 dlog_verbose(" Stream IDs assigned:\n");
795
796 j = 0;
797 while (uint32list_has_next(&list) &&
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700798 j < PARTITION_MAX_STREAMS_PER_DEVICE) {
Manish Pandeye68e7932020-04-23 15:29:28 +0100799 TRY(uint32list_get_next(&list,
800 &dev_regions[i].stream_ids[j]));
801 dlog_verbose(" %u\n",
802 dev_regions[i].stream_ids[j]);
803 j++;
804 }
805 if (j == 0) {
806 dlog_verbose(" None\n");
807 }
Madhukar Pappireddy54680c72020-10-23 15:02:38 -0500808 dev_regions[i].stream_count = j;
Manish Pandeye68e7932020-04-23 15:29:28 +0100809
810 TRY(read_bool(dev_node, "exclusive-access",
811 &dev_regions[i].exclusive_access));
J-Alves4369bd92020-08-07 16:35:36 +0100812 dlog_verbose(" Exclusive_access: %u\n",
Manish Pandeye68e7932020-04-23 15:29:28 +0100813 dev_regions[i].exclusive_access);
814
815 i++;
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700816 } while (fdt_next_sibling(dev_node) &&
817 (i < PARTITION_MAX_DEVICE_REGIONS));
Manish Pandeye68e7932020-04-23 15:29:28 +0100818
Manish Pandey2145c212020-05-01 16:04:22 +0100819 *count = i;
Manish Pandeye68e7932020-04-23 15:29:28 +0100820
821 return MANIFEST_SUCCESS;
822}
823
J-Alvesabebe432022-05-31 14:40:50 +0100824static enum manifest_return_code sanity_check_ffa_manifest(
825 struct manifest_vm *vm)
826{
827 uint16_t ffa_version_major;
828 uint16_t ffa_version_minor;
829 enum manifest_return_code ret_code = MANIFEST_SUCCESS;
830 const char *error_string = "specified in manifest is unsupported";
831 uint32_t k = 0;
832
833 /* ensure that the SPM version is compatible */
834 ffa_version_major = (vm->partition.ffa_version & 0xffff0000) >>
835 FFA_VERSION_MAJOR_OFFSET;
836 ffa_version_minor = vm->partition.ffa_version & 0xffff;
837
838 if (ffa_version_major != FFA_VERSION_MAJOR ||
839 ffa_version_minor > FFA_VERSION_MINOR) {
840 dlog_error("FF-A partition manifest version %s: %u.%u\n",
841 error_string, ffa_version_major, ffa_version_minor);
842 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
843 }
844
845 if (vm->partition.xlat_granule != PAGE_4KB) {
846 dlog_error("Translation granule %s: %u\n", error_string,
847 vm->partition.xlat_granule);
848 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
849 }
850
851 if (vm->partition.execution_state != AARCH64) {
852 dlog_error("Execution state %s: %u\n", error_string,
853 vm->partition.execution_state);
854 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
855 }
856
857 if (vm->partition.run_time_el != EL1 &&
858 vm->partition.run_time_el != S_EL1 &&
859 vm->partition.run_time_el != S_EL0) {
860 dlog_error("Exception level %s: %d\n", error_string,
861 vm->partition.run_time_el);
862 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
863 }
864
865 if ((vm->partition.messaging_method &
866 ~(FFA_PARTITION_DIRECT_REQ_RECV | FFA_PARTITION_DIRECT_REQ_SEND |
867 FFA_PARTITION_INDIRECT_MSG)) != 0U) {
868 dlog_error("Messaging method %s: %x\n", error_string,
869 vm->partition.messaging_method);
870 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
871 }
872
873 if (vm->partition.run_time_el == S_EL0 &&
874 vm->partition.execution_ctx_count != 1) {
875 dlog_error(
876 "Exception level and execution context count %s: %d "
877 "%d\n",
878 error_string, vm->partition.run_time_el,
879 vm->partition.execution_ctx_count);
880 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
881 }
882
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700883 for (uint16_t i = 0; i < vm->partition.dev_region_count; i++) {
J-Alvesabebe432022-05-31 14:40:50 +0100884 struct device_region dev_region;
885
886 dev_region = vm->partition.dev_regions[i];
887
Raghu Krishnamurthy641dcd82022-07-19 23:21:20 -0700888 if (dev_region.interrupt_count >
889 PARTITION_MAX_INTERRUPTS_PER_DEVICE) {
J-Alvesabebe432022-05-31 14:40:50 +0100890 dlog_error(
891 "Interrupt count for device region exceeds "
892 "limit.\n");
893 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
894 continue;
895 }
896
897 for (uint8_t j = 0; j < dev_region.interrupt_count; j++) {
898 k++;
899 if (k > VM_MANIFEST_MAX_INTERRUPTS) {
900 dlog_error(
901 "Interrupt count for VM exceeds "
902 "limit.\n");
903 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
904 continue;
905 }
906 }
907 }
908
909 /* GP register is restricted to one of x0 - x3. */
910 if (vm->partition.gp_register_num != -1 &&
911 vm->partition.gp_register_num > 3) {
912 dlog_error("GP register number %s: %u\n", error_string,
913 vm->partition.gp_register_num);
914 ret_code = MANIFEST_ERROR_NOT_COMPATIBLE;
915 }
916
917 return ret_code;
918}
919
J-Alves77b6f4f2023-03-15 11:34:49 +0000920enum manifest_return_code parse_ffa_manifest(
921 struct fdt *fdt, struct manifest_vm *vm,
922 struct fdt_node *boot_info_node, const struct boot_params *boot_params)
Olivier Deprez62d99e32020-01-09 15:58:07 +0100923{
924 unsigned int i = 0;
925 struct uint32list_iter uuid;
926 uint32_t uuid_word;
927 struct fdt_node root;
928 struct fdt_node ffa_node;
929 struct string rxtx_node_name = STRING_INIT("rx_tx-info");
Manish Pandey6542f5c2020-04-27 14:37:46 +0100930 struct string mem_region_node_name = STRING_INIT("memory-regions");
Manish Pandeye68e7932020-04-23 15:29:28 +0100931 struct string dev_region_node_name = STRING_INIT("device-regions");
J-Alves35315782022-01-25 17:58:32 +0000932 struct string boot_info_node_name = STRING_INIT("boot-info");
Madhukar Pappireddy84154052022-06-21 18:30:25 -0500933 bool managed_exit_field_present = false;
Olivier Deprez62d99e32020-01-09 15:58:07 +0100934
935 if (!fdt_find_node(fdt, "/", &root)) {
936 return MANIFEST_ERROR_NO_ROOT_NODE;
937 }
938
939 /* Check "compatible" property. */
940 if (!fdt_is_compatible(&root, "arm,ffa-manifest-1.0")) {
941 return MANIFEST_ERROR_NOT_COMPATIBLE;
942 }
943
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700944 TRY(read_uint32(&root, "ffa-version", &vm->partition.ffa_version));
J-Alves4369bd92020-08-07 16:35:36 +0100945 dlog_verbose(" Expected FF-A version %u.%u\n",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700946 vm->partition.ffa_version >> 16,
947 vm->partition.ffa_version & 0xffff);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100948
J-Alves4369bd92020-08-07 16:35:36 +0100949 TRY(read_uint32list(&root, "uuid", &uuid));
Olivier Deprez62d99e32020-01-09 15:58:07 +0100950
951 while (uint32list_has_next(&uuid) && i < 4) {
952 TRY(uint32list_get_next(&uuid, &uuid_word));
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700953 vm->partition.uuid.uuid[i] = uuid_word;
Olivier Deprez62d99e32020-01-09 15:58:07 +0100954 i++;
955 }
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700956 dlog_verbose(" UUID %#x-%x-%x-%x\n", vm->partition.uuid.uuid[0],
957 vm->partition.uuid.uuid[1], vm->partition.uuid.uuid[2],
958 vm->partition.uuid.uuid[3]);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100959
960 TRY(read_uint16(&root, "execution-ctx-count",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700961 &vm->partition.execution_ctx_count));
J-Alves4369bd92020-08-07 16:35:36 +0100962 dlog_verbose(" Number of execution context %u\n",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700963 vm->partition.execution_ctx_count);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100964
965 TRY(read_uint8(&root, "exception-level",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700966 (uint8_t *)&vm->partition.run_time_el));
967 dlog_verbose(" Run-time EL %u\n", vm->partition.run_time_el);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100968
969 TRY(read_uint8(&root, "execution-state",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700970 (uint8_t *)&vm->partition.execution_state));
971 dlog_verbose(" Execution state %u\n", vm->partition.execution_state);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100972
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700973 TRY(read_optional_uint64(&root, "load-address", 0,
974 &vm->partition.load_addr));
975 dlog_verbose(" Load address %#x\n", vm->partition.load_addr);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100976
J-Alves4369bd92020-08-07 16:35:36 +0100977 TRY(read_optional_uint64(&root, "entrypoint-offset", 0,
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700978 &vm->partition.ep_offset));
979 dlog_verbose(" Entry point offset %#x\n", vm->partition.ep_offset);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100980
J-Alves35315782022-01-25 17:58:32 +0000981 TRY(read_optional_uint32(&root, "gp-register-num",
982 DEFAULT_BOOT_GP_REGISTER,
983 &vm->partition.gp_register_num));
984 dlog_verbose(" Boot GP register: %#x\n",
985 vm->partition.gp_register_num);
986
J-Alvesb37fd082020-10-22 12:29:21 +0100987 TRY(read_optional_uint16(&root, "boot-order", DEFAULT_BOOT_ORDER,
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700988 &vm->partition.boot_order));
989 dlog_verbose(" Boot order %#u\n", vm->partition.boot_order);
J-Alvesb37fd082020-10-22 12:29:21 +0100990
J-Alves4369bd92020-08-07 16:35:36 +0100991 TRY(read_optional_uint8(&root, "xlat-granule", 0,
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -0700992 (uint8_t *)&vm->partition.xlat_granule));
993 dlog_verbose(" Translation granule %u\n", vm->partition.xlat_granule);
Olivier Deprez62d99e32020-01-09 15:58:07 +0100994
995 ffa_node = root;
996 if (fdt_find_child(&ffa_node, &rxtx_node_name)) {
997 if (!fdt_is_compatible(&ffa_node,
998 "arm,ffa-manifest-rx_tx-buffer")) {
999 return MANIFEST_ERROR_NOT_COMPATIBLE;
1000 }
1001
Manish Pandeyfa1f2912020-05-05 12:57:01 +01001002 /*
1003 * Read only phandles for now, it will be used to update buffers
1004 * while parsing memory regions.
1005 */
1006 TRY(read_uint32(&ffa_node, "rx-buffer",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001007 &vm->partition.rxtx.rx_phandle));
Olivier Deprez62d99e32020-01-09 15:58:07 +01001008
Manish Pandeyfa1f2912020-05-05 12:57:01 +01001009 TRY(read_uint32(&ffa_node, "tx-buffer",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001010 &vm->partition.rxtx.tx_phandle));
Olivier Deprez62d99e32020-01-09 15:58:07 +01001011
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001012 vm->partition.rxtx.available = true;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001013 }
1014
1015 TRY(read_uint8(&root, "messaging-method",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001016 (uint8_t *)&vm->partition.messaging_method));
1017 dlog_verbose(" Messaging method %u\n", vm->partition.messaging_method);
Olivier Deprez62d99e32020-01-09 15:58:07 +01001018
Madhukar Pappireddy84154052022-06-21 18:30:25 -05001019 TRY(read_bool(&root, "managed-exit", &managed_exit_field_present));
1020
1021 TRY(read_optional_uint8(
1022 &root, "ns-interrupts-action", NS_ACTION_SIGNALED,
1023 (uint8_t *)&vm->partition.ns_interrupts_action));
1024
1025 /*
1026 * An SP manifest can specify one of the fields listed below:
1027 * `managed-exit`: Introduced in FF-A v1.0 spec.
1028 * `ns-interrupts-action`: Introduced in FF-A v1.1 EAC0 spec.
1029 * If both are missing from the manifest, the default response is
1030 * NS_ACTION_SIGNALED.
1031 */
1032 if (managed_exit_field_present) {
1033 vm->partition.ns_interrupts_action = NS_ACTION_ME;
1034 }
1035
1036 if (vm->partition.ns_interrupts_action != NS_ACTION_QUEUED &&
1037 vm->partition.ns_interrupts_action != NS_ACTION_ME &&
1038 vm->partition.ns_interrupts_action != NS_ACTION_SIGNALED) {
Madhukar Pappireddy5c04a382022-12-28 11:29:26 -06001039 return MANIFEST_ERROR_ILLEGAL_NS_INT_ACTION;
Madhukar Pappireddy84154052022-06-21 18:30:25 -05001040 }
1041
1042 dlog_verbose(
1043 "NS Interrupts %s\n",
1044 (vm->partition.ns_interrupts_action == NS_ACTION_QUEUED)
1045 ? "Queued"
1046 : (vm->partition.ns_interrupts_action == NS_ACTION_SIGNALED)
1047 ? "Signaled"
1048 : "Managed exit");
1049
1050 if (vm->partition.ns_interrupts_action == NS_ACTION_ME) {
1051 /* Managed exit only supported by S_EL1 partitions. */
1052 if (vm->partition.run_time_el != S_EL1) {
1053 dlog_error(
1054 "Managed exit cannot be supported by this "
1055 "partition\n");
Madhukar Pappireddy5c04a382022-12-28 11:29:26 -06001056 return MANIFEST_ERROR_ILLEGAL_NS_INT_ACTION;
Madhukar Pappireddy84154052022-06-21 18:30:25 -05001057 }
Madhukar Pappireddy046dad02022-06-21 18:43:33 -05001058
1059 TRY(read_bool(&root, "managed-exit-virq",
1060 &vm->partition.me_signal_virq));
1061 if (vm->partition.me_signal_virq) {
1062 dlog_verbose(" Managed Exit signaled through vIRQ\n");
1063 }
J-Alvesa4730db2021-11-02 10:31:01 +00001064 }
1065
1066 TRY(read_bool(&root, "notification-support",
1067 &vm->partition.notification_support));
1068 if (vm->partition.notification_support) {
1069 dlog_verbose(" Notifications Receipt Supported\n");
1070 }
Maksims Svecovs9ddf86a2021-05-06 17:17:21 +01001071
Madhukar Pappireddy5c04a382022-12-28 11:29:26 -06001072 TRY(read_optional_uint8(
1073 &root, "other-s-interrupts-action", OTHER_S_INT_ACTION_SIGNALED,
1074 (uint8_t *)&vm->partition.other_s_interrupts_action));
1075
1076 if (vm->partition.other_s_interrupts_action ==
1077 OTHER_S_INT_ACTION_QUEUED) {
1078 if (vm->partition.ns_interrupts_action != NS_ACTION_QUEUED) {
1079 dlog_error(
1080 "Choice of the fields 'ns-interrupts-action' "
1081 "and 'other-s-interrupts-action' not "
1082 "compatible\n");
1083 return MANIFEST_ERROR_NOT_COMPATIBLE;
1084 }
1085 } else if (vm->partition.other_s_interrupts_action >
1086 OTHER_S_INT_ACTION_SIGNALED) {
1087 dlog_error(
1088 "Illegal value specified for the field"
1089 " 'other-s-interrupts-action': %u\n",
1090 vm->partition.other_s_interrupts_action);
1091 return MANIFEST_ERROR_ILLEGAL_OTHER_S_INT_ACTION;
1092 }
1093
J-Alves35315782022-01-25 17:58:32 +00001094 /* Parse boot info node. */
1095 if (boot_info_node != NULL) {
1096 ffa_node = root;
1097 vm->partition.boot_info =
1098 fdt_find_child(&ffa_node, &boot_info_node_name);
1099 if (vm->partition.boot_info) {
1100 *boot_info_node = ffa_node;
1101 }
1102 } else {
1103 vm->partition.boot_info = false;
1104 }
1105
Olivier Depreza15f2352022-09-26 09:17:24 +02001106 TRY(read_optional_uint32(
1107 &root, "power-management-messages",
1108 MANIFEST_POWER_MANAGEMENT_CPU_OFF_SUPPORTED |
1109 MANIFEST_POWER_MANAGEMENT_CPU_ON_SUPPORTED,
1110 &vm->partition.power_management));
1111 vm->partition.power_management &= MANIFEST_POWER_MANAGEMENT_ALL_MASK;
1112 if (vm->partition.execution_ctx_count == 1 ||
1113 vm->partition.run_time_el == S_EL0) {
1114 vm->partition.power_management =
1115 MANIFEST_POWER_MANAGEMENT_NONE_MASK;
1116 }
1117
1118 dlog_verbose(" Power management messages %#x\n",
1119 vm->partition.power_management);
1120
Manish Pandey6542f5c2020-04-27 14:37:46 +01001121 /* Parse memory-regions */
1122 ffa_node = root;
1123 if (fdt_find_child(&ffa_node, &mem_region_node_name)) {
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001124 TRY(parse_ffa_memory_region_node(
1125 &ffa_node, vm->partition.mem_regions,
J-Alves77b6f4f2023-03-15 11:34:49 +00001126 &vm->partition.mem_region_count, &vm->partition.rxtx,
1127 boot_params));
Manish Pandey6542f5c2020-04-27 14:37:46 +01001128 }
Manish Pandey2145c212020-05-01 16:04:22 +01001129 dlog_verbose(" Total %u memory regions found\n",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001130 vm->partition.mem_region_count);
Manish Pandey6542f5c2020-04-27 14:37:46 +01001131
Manish Pandeye68e7932020-04-23 15:29:28 +01001132 /* Parse Device-regions */
1133 ffa_node = root;
1134 if (fdt_find_child(&ffa_node, &dev_region_node_name)) {
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001135 TRY(parse_ffa_device_region_node(
1136 &ffa_node, vm->partition.dev_regions,
1137 &vm->partition.dev_region_count));
Manish Pandeye68e7932020-04-23 15:29:28 +01001138 }
Manish Pandey2145c212020-05-01 16:04:22 +01001139 dlog_verbose(" Total %u device regions found\n",
Raghu Krishnamurthy8c250a92021-07-02 12:16:42 -07001140 vm->partition.dev_region_count);
Manish Pandeye68e7932020-04-23 15:29:28 +01001141
J-Alves4eb7b542022-03-02 15:21:52 +00001142 return sanity_check_ffa_manifest(vm);
Olivier Deprez62d99e32020-01-09 15:58:07 +01001143}
1144
Olivier Deprez62d99e32020-01-09 15:58:07 +01001145static enum manifest_return_code parse_ffa_partition_package(
1146 struct mm_stage1_locked stage1_locked, struct fdt_node *node,
J-Alves77b6f4f2023-03-15 11:34:49 +00001147 struct manifest_vm *vm, ffa_vm_id_t vm_id,
1148 const struct boot_params *boot_params, struct mpool *ppool)
Olivier Deprez62d99e32020-01-09 15:58:07 +01001149{
1150 enum manifest_return_code ret = MANIFEST_ERROR_NOT_COMPATIBLE;
J-Alves2f86c1e2022-02-23 18:44:19 +00001151 uintpaddr_t load_address;
1152 struct sp_pkg_header header;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001153 struct fdt sp_fdt;
J-Alves2f86c1e2022-02-23 18:44:19 +00001154 vaddr_t pkg_start;
1155 vaddr_t manifest_address;
J-Alves35315782022-01-25 17:58:32 +00001156 struct fdt_node boot_info_node;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001157
1158 /*
1159 * This must have been hinted as being an FF-A partition,
1160 * return straight with failure if this is not the case.
1161 */
1162 if (!vm->is_ffa_partition) {
J-Alves2f86c1e2022-02-23 18:44:19 +00001163 return ret;
1164 }
1165
1166 TRY(read_uint64(node, "load_address", &load_address));
1167 if (!is_aligned(load_address, PAGE_SIZE)) {
Olivier Deprez62d99e32020-01-09 15:58:07 +01001168 return MANIFEST_ERROR_NOT_COMPATIBLE;
1169 }
1170
J-Alves2f86c1e2022-02-23 18:44:19 +00001171 assert(load_address != 0U);
1172
1173 if (!sp_pkg_init(stage1_locked, pa_init(load_address), &header,
1174 ppool)) {
1175 return ret;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001176 }
1177
J-Alves2f86c1e2022-02-23 18:44:19 +00001178 pkg_start = va_init(load_address);
Olivier Deprez62d99e32020-01-09 15:58:07 +01001179
J-Alves2f86c1e2022-02-23 18:44:19 +00001180 if (vm_id != HF_PRIMARY_VM_ID &&
1181 sp_pkg_get_mem_size(&header) >= vm->secondary.mem_size) {
J-Alves4369bd92020-08-07 16:35:36 +01001182 dlog_error("Invalid package header or DT size.\n");
J-Alves2f86c1e2022-02-23 18:44:19 +00001183 goto out;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001184 }
1185
J-Alves2f86c1e2022-02-23 18:44:19 +00001186 manifest_address = va_add(va_init(load_address), header.pm_offset);
1187 if (!fdt_init_from_ptr(&sp_fdt, ptr_from_va(manifest_address),
1188 header.pm_size)) {
Olivier Deprez62d99e32020-01-09 15:58:07 +01001189 dlog_error("FDT failed validation.\n");
J-Alves2f86c1e2022-02-23 18:44:19 +00001190 goto out;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001191 }
1192
J-Alves77b6f4f2023-03-15 11:34:49 +00001193 ret = parse_ffa_manifest(&sp_fdt, vm, &boot_info_node, boot_params);
Olivier Deprez62d99e32020-01-09 15:58:07 +01001194 if (ret != MANIFEST_SUCCESS) {
J-Alves4eb7b542022-03-02 15:21:52 +00001195 dlog_error("Error parsing partition manifest: %s.\n",
1196 manifest_strerror(ret));
J-Alves2f86c1e2022-02-23 18:44:19 +00001197 goto out;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001198 }
1199
J-Alves2f86c1e2022-02-23 18:44:19 +00001200 if (vm->partition.load_addr != load_address) {
J-Alvesa26ea212021-03-22 14:33:47 +00001201 dlog_warning(
1202 "Partition's load address at its manifest differs"
1203 " from specified in partition's package.\n");
J-Alves2f86c1e2022-02-23 18:44:19 +00001204 vm->partition.load_addr = load_address;
J-Alvesa26ea212021-03-22 14:33:47 +00001205 }
1206
J-Alves889a1d72022-05-13 11:38:27 +01001207 if (vm->partition.gp_register_num != DEFAULT_BOOT_GP_REGISTER) {
1208 if (header.version == SP_PKG_HEADER_VERSION_2 &&
1209 vm->partition.boot_info &&
1210 !ffa_boot_info_node(&boot_info_node, pkg_start, &header)) {
1211 dlog_error("Failed to process boot information.\n");
1212 }
J-Alves35315782022-01-25 17:58:32 +00001213 }
J-Alves2f86c1e2022-02-23 18:44:19 +00001214out:
1215 sp_pkg_deinit(stage1_locked, pkg_start, &header, ppool);
Olivier Deprez62d99e32020-01-09 15:58:07 +01001216 return ret;
1217}
1218
David Brazdil7a462ec2019-08-15 12:27:47 +01001219/**
1220 * Parse manifest from FDT.
1221 */
Olivier Deprez62d99e32020-01-09 15:58:07 +01001222enum manifest_return_code manifest_init(struct mm_stage1_locked stage1_locked,
Olivier Deprez93644652022-09-09 11:01:12 +02001223 struct manifest **manifest_ret,
Olivier Deprez62d99e32020-01-09 15:58:07 +01001224 struct memiter *manifest_fdt,
J-Alves77b6f4f2023-03-15 11:34:49 +00001225 struct boot_params *boot_params,
Olivier Deprez62d99e32020-01-09 15:58:07 +01001226 struct mpool *ppool)
David Brazdil7a462ec2019-08-15 12:27:47 +01001227{
Olivier Deprez93644652022-09-09 11:01:12 +02001228 struct manifest *manifest;
David Brazdilb856be62020-03-25 10:14:55 +00001229 struct string vm_name;
1230 struct fdt fdt;
David Brazdil7a462ec2019-08-15 12:27:47 +01001231 struct fdt_node hyp_node;
1232 size_t i = 0;
1233 bool found_primary_vm = false;
1234
J-Alves77b6f4f2023-03-15 11:34:49 +00001235 dump_memory_ranges(boot_params->mem_ranges,
1236 boot_params->mem_ranges_count, false);
1237 dump_memory_ranges(boot_params->ns_mem_ranges,
1238 boot_params->ns_mem_ranges_count, true);
1239
Olivier Deprez93644652022-09-09 11:01:12 +02001240 /* Allocate space in the ppool for the manifest data. */
1241 if (!manifest_data_init(ppool)) {
1242 panic("Unable to allocate manifest data.\n");
Daniel Boulby801f8ef2022-06-27 14:21:01 +01001243 }
1244
Olivier Deprez93644652022-09-09 11:01:12 +02001245 manifest = &manifest_data->manifest;
1246 *manifest_ret = manifest;
1247
David Brazdilb856be62020-03-25 10:14:55 +00001248 if (!fdt_init_from_memiter(&fdt, manifest_fdt)) {
1249 return MANIFEST_ERROR_FILE_SIZE; /* TODO */
David Brazdila2358d42020-01-27 18:51:38 +00001250 }
1251
David Brazdil7a462ec2019-08-15 12:27:47 +01001252 /* Find hypervisor node. */
David Brazdilb856be62020-03-25 10:14:55 +00001253 if (!fdt_find_node(&fdt, "/hypervisor", &hyp_node)) {
David Brazdil7a462ec2019-08-15 12:27:47 +01001254 return MANIFEST_ERROR_NO_HYPERVISOR_FDT_NODE;
1255 }
1256
David Brazdil74e9c3b2019-08-28 11:09:08 +01001257 /* Check "compatible" property. */
David Brazdilf4925382020-03-25 13:33:51 +00001258 if (!fdt_is_compatible(&hyp_node, "hafnium,hafnium")) {
David Brazdil74e9c3b2019-08-28 11:09:08 +01001259 return MANIFEST_ERROR_NOT_COMPATIBLE;
1260 }
1261
Olivier Deprez622ab8d2021-08-02 12:15:45 +02001262 TRY(read_bool(&hyp_node, "ffa_tee_enabled",
1263 &manifest->ffa_tee_enabled));
Andrew Walbran41a49d82020-01-10 17:46:38 +00001264
David Brazdil7a462ec2019-08-15 12:27:47 +01001265 /* Iterate over reserved VM IDs and check no such nodes exist. */
Olivier Deprez2a8ee342020-08-03 15:10:44 +02001266 for (i = HF_VM_ID_BASE; i < HF_VM_ID_OFFSET; i++) {
1267 ffa_vm_id_t vm_id = (ffa_vm_id_t)i - HF_VM_ID_BASE;
David Brazdil7a462ec2019-08-15 12:27:47 +01001268 struct fdt_node vm_node = hyp_node;
David Brazdil7a462ec2019-08-15 12:27:47 +01001269
David Brazdilb856be62020-03-25 10:14:55 +00001270 generate_vm_node_name(&vm_name, vm_id);
1271 if (fdt_find_child(&vm_node, &vm_name)) {
David Brazdil7a462ec2019-08-15 12:27:47 +01001272 return MANIFEST_ERROR_RESERVED_VM_ID;
1273 }
1274 }
1275
1276 /* Iterate over VM nodes until we find one that does not exist. */
1277 for (i = 0; i <= MAX_VMS; ++i) {
Andrew Walbranb5ab43c2020-04-30 11:32:54 +01001278 ffa_vm_id_t vm_id = HF_VM_ID_OFFSET + i;
David Brazdil7a462ec2019-08-15 12:27:47 +01001279 struct fdt_node vm_node = hyp_node;
David Brazdil7a462ec2019-08-15 12:27:47 +01001280
Olivier Deprez2a8ee342020-08-03 15:10:44 +02001281 generate_vm_node_name(&vm_name, vm_id - HF_VM_ID_BASE);
David Brazdilb856be62020-03-25 10:14:55 +00001282 if (!fdt_find_child(&vm_node, &vm_name)) {
David Brazdil7a462ec2019-08-15 12:27:47 +01001283 break;
1284 }
1285
1286 if (i == MAX_VMS) {
1287 return MANIFEST_ERROR_TOO_MANY_VMS;
1288 }
1289
1290 if (vm_id == HF_PRIMARY_VM_ID) {
1291 CHECK(found_primary_vm == false); /* sanity check */
1292 found_primary_vm = true;
1293 }
1294
David Brazdil0251b942019-09-10 15:59:50 +01001295 manifest->vm_count = i + 1;
Olivier Deprez62d99e32020-01-09 15:58:07 +01001296
1297 TRY(parse_vm_common(&vm_node, &manifest->vm[i], vm_id));
1298
Raghu Krishnamurthyb49549e2021-07-02 08:27:38 -07001299 CHECK(!manifest->vm[i].is_hyp_loaded ||
1300 manifest->vm[i].is_ffa_partition);
1301
1302 if (manifest->vm[i].is_ffa_partition &&
1303 !manifest->vm[i].is_hyp_loaded) {
Olivier Deprez62d99e32020-01-09 15:58:07 +01001304 TRY(parse_ffa_partition_package(stage1_locked, &vm_node,
1305 &manifest->vm[i], vm_id,
J-Alves77b6f4f2023-03-15 11:34:49 +00001306 boot_params, ppool));
J-Alves596049f2023-03-15 11:40:24 +00001307 size_t page_count =
1308 align_up(manifest->vm[i].secondary.mem_size,
1309 PAGE_SIZE) /
1310 PAGE_SIZE;
1311
1312 if (vm_id == HF_PRIMARY_VM_ID) {
1313 continue;
1314 }
1315
1316 TRY(check_partition_memory_is_valid(
1317 manifest->vm[i].partition.load_addr, page_count,
1318 0, boot_params));
1319
1320 /*
1321 * Check if memory from load-address until (load-address
1322 * + memory size) has been used by other partition.
1323 */
1324 TRY(check_and_record_memory_used(
1325 manifest->vm[i].partition.load_addr,
1326 page_count));
Olivier Deprez62d99e32020-01-09 15:58:07 +01001327 } else {
1328 TRY(parse_vm(&vm_node, &manifest->vm[i], vm_id));
1329 }
David Brazdil7a462ec2019-08-15 12:27:47 +01001330 }
1331
Olivier Deprezfb05f3c2020-11-10 17:48:04 +01001332 if (!found_primary_vm && vm_id_is_current_world(HF_PRIMARY_VM_ID)) {
David Brazdil7a462ec2019-08-15 12:27:47 +01001333 return MANIFEST_ERROR_NO_PRIMARY_VM;
1334 }
1335
1336 return MANIFEST_SUCCESS;
1337}
1338
Olivier Deprez93644652022-09-09 11:01:12 +02001339/**
1340 * Free manifest data resources, called once manifest parsing has
1341 * completed and VMs are loaded.
1342 */
Daniel Boulby801f8ef2022-06-27 14:21:01 +01001343void manifest_deinit(struct mpool *ppool)
1344{
Olivier Deprez93644652022-09-09 11:01:12 +02001345 manifest_data_deinit(ppool);
Daniel Boulby801f8ef2022-06-27 14:21:01 +01001346}
1347
David Brazdil7a462ec2019-08-15 12:27:47 +01001348const char *manifest_strerror(enum manifest_return_code ret_code)
1349{
1350 switch (ret_code) {
1351 case MANIFEST_SUCCESS:
1352 return "Success";
David Brazdila2358d42020-01-27 18:51:38 +00001353 case MANIFEST_ERROR_FILE_SIZE:
1354 return "Total size in header does not match file size";
Olivier Deprez62d99e32020-01-09 15:58:07 +01001355 case MANIFEST_ERROR_MALFORMED_DTB:
1356 return "Malformed device tree blob";
David Brazdila2358d42020-01-27 18:51:38 +00001357 case MANIFEST_ERROR_NO_ROOT_NODE:
1358 return "Could not find root node in manifest";
David Brazdil7a462ec2019-08-15 12:27:47 +01001359 case MANIFEST_ERROR_NO_HYPERVISOR_FDT_NODE:
1360 return "Could not find \"hypervisor\" node in manifest";
David Brazdil74e9c3b2019-08-28 11:09:08 +01001361 case MANIFEST_ERROR_NOT_COMPATIBLE:
1362 return "Hypervisor manifest entry not compatible with Hafnium";
David Brazdil7a462ec2019-08-15 12:27:47 +01001363 case MANIFEST_ERROR_RESERVED_VM_ID:
1364 return "Manifest defines a VM with a reserved ID";
1365 case MANIFEST_ERROR_NO_PRIMARY_VM:
1366 return "Manifest does not contain a primary VM entry";
1367 case MANIFEST_ERROR_TOO_MANY_VMS:
1368 return "Manifest specifies more VMs than Hafnium has "
1369 "statically allocated space for";
1370 case MANIFEST_ERROR_PROPERTY_NOT_FOUND:
1371 return "Property not found";
1372 case MANIFEST_ERROR_MALFORMED_STRING:
1373 return "Malformed string property";
David Brazdil0dbb41f2019-09-09 18:03:35 +01001374 case MANIFEST_ERROR_STRING_TOO_LONG:
1375 return "String too long";
David Brazdil7a462ec2019-08-15 12:27:47 +01001376 case MANIFEST_ERROR_MALFORMED_INTEGER:
1377 return "Malformed integer property";
1378 case MANIFEST_ERROR_INTEGER_OVERFLOW:
1379 return "Integer overflow";
Andrew Scullae9962e2019-10-03 16:51:16 +01001380 case MANIFEST_ERROR_MALFORMED_INTEGER_LIST:
1381 return "Malformed integer list property";
Andrew Scullb2c3a242019-11-04 13:52:36 +00001382 case MANIFEST_ERROR_MALFORMED_BOOLEAN:
1383 return "Malformed boolean property";
Manish Pandey6542f5c2020-04-27 14:37:46 +01001384 case MANIFEST_ERROR_MEMORY_REGION_NODE_EMPTY:
1385 return "Memory-region node should have at least one entry";
Manish Pandeye68e7932020-04-23 15:29:28 +01001386 case MANIFEST_ERROR_DEVICE_REGION_NODE_EMPTY:
1387 return "Device-region node should have at least one entry";
Manish Pandeyf06c9072020-09-29 15:41:58 +01001388 case MANIFEST_ERROR_RXTX_SIZE_MISMATCH:
1389 return "RX and TX buffers should be of same size";
Varun Wadekar4afbfd72022-10-13 14:30:18 +01001390 case MANIFEST_ERROR_MEM_REGION_EMPTY:
1391 return "Memory region should have at least one page";
Daniel Boulbya7e9e182022-06-27 14:21:01 +01001392 case MANIFEST_ERROR_MEM_REGION_OVERLAP:
1393 return "Memory region overlaps with one already allocated";
Daniel Boulbyc1a613d2022-10-18 11:26:17 +01001394 case MANIFEST_ERROR_MEM_REGION_UNALIGNED:
1395 return "Memory region is not aligned to a page boundary";
Raghu Krishnamurthy384693c2021-10-11 13:56:24 -07001396 case MANIFEST_ERROR_INVALID_MEM_PERM:
1397 return "Memory permission should be RO, RW or RX";
J-Alves35315782022-01-25 17:58:32 +00001398 case MANIFEST_ERROR_ARGUMENTS_LIST_EMPTY:
1399 return "Arguments-list node should have at least one argument";
Daniel Boulby801f8ef2022-06-27 14:21:01 +01001400 case MANIFEST_ERROR_INTERRUPT_ID_REPEATED:
1401 return "Interrupt ID already assigned to another endpoint";
Madhukar Pappireddy5c04a382022-12-28 11:29:26 -06001402 case MANIFEST_ERROR_ILLEGAL_NS_INT_ACTION:
Madhukar Pappireddy84154052022-06-21 18:30:25 -05001403 return "Illegal value specidied for the field: Action in "
1404 "response to NS Interrupt";
Raghu Krishnamurthy98da1ca2022-10-04 08:59:01 -07001405 case MANIFEST_ERROR_INTERRUPT_ID_NOT_IN_LIST:
1406 return "Interrupt ID is not in the list of interrupts";
Madhukar Pappireddy5c04a382022-12-28 11:29:26 -06001407 case MANIFEST_ERROR_ILLEGAL_OTHER_S_INT_ACTION:
1408 return "Illegal value specified for the field: Action in "
1409 "response to Other-S Interrupt";
J-Alves77b6f4f2023-03-15 11:34:49 +00001410 case MANIFEST_ERROR_MEMORY_MISSING:
1411 return "Memory nodes must be defined in the SPMC manifest "
1412 "('memory' and 'ns-memory').";
1413 case MANIFEST_ERROR_PARTITION_ADDRESS_OVERLAP:
1414 return "Partition's memory [load address: load address + "
1415 "memory size[ overlap with other allocated "
1416 "regions.";
1417 case MANIFEST_ERROR_MEM_REGION_INVALID:
1418 return "Memory region must within memory ranges defined "
1419 "in the SPMC manifest.";
David Brazdil7a462ec2019-08-15 12:27:47 +01001420 }
1421
1422 panic("Unexpected manifest return code.");
1423}