1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
|
/*
* Copyright (c) 2018-2020, Arm Limited. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
*/
/* All the APIs defined in this file are used for IPC model. */
#include <inttypes.h>
#include <limits.h>
#include <stdbool.h>
#include <stdlib.h>
#include "psa/client.h"
#include "psa/service.h"
#include "tfm_utils.h"
#include "tfm_spm_hal.h"
#include "spm_api.h"
#include "spm_db.h"
#include "tfm_core_mem_check.h"
#include "tfm_internal_defines.h"
#include "tfm_wait.h"
#include "tfm_message_queue.h"
#include "tfm_list.h"
#include "tfm_pools.h"
#include "tfm_thread.h"
#include "region_defs.h"
#include "tfm_nspm.h"
#include "tfm_memory_utils.h"
#include "tfm_core_utils.h"
#include "tfm_rpc.h"
#include "tfm_irq_list.h"
#include "secure_fw/services/tfm_service_list.inc"
/* Extern service variable */
extern struct tfm_spm_service_t service[];
extern const struct tfm_spm_service_db_t service_db[];
/* Extern SPM variable */
extern struct spm_partition_db_t g_spm_partition_db;
/* Pools */
TFM_POOL_DECLARE(conn_handle_pool, sizeof(struct tfm_conn_handle_t),
TFM_CONN_HANDLE_MAX_NUM);
/********************** SPM functions for handler mode ***********************/
/* Service handle management functions */
psa_handle_t tfm_spm_create_conn_handle(struct tfm_spm_service_t *service,
int32_t client_id)
{
struct tfm_conn_handle_t *p_handle;
TFM_CORE_ASSERT(service);
/* Get buffer for handle list structure from handle pool */
p_handle = (struct tfm_conn_handle_t *)tfm_pool_alloc(conn_handle_pool);
if (!p_handle) {
return PSA_NULL_HANDLE;
}
p_handle->service = service;
p_handle->status = TFM_HANDLE_STATUS_IDLE;
p_handle->client_id = client_id;
/* Add handle node to list for next psa functions */
tfm_list_add_tail(&service->handle_list, &p_handle->list);
return (psa_handle_t)p_handle;
}
int32_t tfm_spm_validate_conn_handle(psa_handle_t conn_handle,
int32_t client_id)
{
/* Check the handle address is validated */
if (is_valid_chunk_data_in_pool(conn_handle_pool,
(uint8_t *)conn_handle) != true) {
return IPC_ERROR_GENERIC;
}
/* Check the handle caller is correct */
if (((struct tfm_conn_handle_t *)conn_handle)->client_id != client_id) {
return IPC_ERROR_GENERIC;
}
return IPC_SUCCESS;
}
static struct tfm_conn_handle_t *
tfm_spm_find_conn_handle_node(struct tfm_spm_service_t *service,
psa_handle_t conn_handle)
{
TFM_CORE_ASSERT(service);
return (struct tfm_conn_handle_t *)conn_handle;
}
int32_t tfm_spm_free_conn_handle(struct tfm_spm_service_t *service,
psa_handle_t conn_handle)
{
struct tfm_conn_handle_t *p_handle;
TFM_CORE_ASSERT(service);
/* There are many handles for each RoT Service */
p_handle = tfm_spm_find_conn_handle_node(service, conn_handle);
if (!p_handle) {
tfm_core_panic();
}
/* Clear magic as the handler is not used anymore */
p_handle->internal_msg.magic = 0;
/* Remove node from handle list */
tfm_list_del_node(&p_handle->list);
/* Back handle buffer to pool */
tfm_pool_free(p_handle);
return IPC_SUCCESS;
}
int32_t tfm_spm_set_rhandle(struct tfm_spm_service_t *service,
psa_handle_t conn_handle,
void *rhandle)
{
struct tfm_conn_handle_t *p_handle;
TFM_CORE_ASSERT(service);
/* Set reverse handle value only be allowed for a connected handle */
TFM_CORE_ASSERT(conn_handle != PSA_NULL_HANDLE);
/* There are many handles for each RoT Service */
p_handle = tfm_spm_find_conn_handle_node(service, conn_handle);
if (!p_handle) {
tfm_core_panic();
}
p_handle->rhandle = rhandle;
return IPC_SUCCESS;
}
void *tfm_spm_get_rhandle(struct tfm_spm_service_t *service,
psa_handle_t conn_handle)
{
struct tfm_conn_handle_t *p_handle;
TFM_CORE_ASSERT(service);
/* Get reverse handle value only be allowed for a connected handle */
TFM_CORE_ASSERT(conn_handle != PSA_NULL_HANDLE);
/* There are many handles for each RoT Service */
p_handle = tfm_spm_find_conn_handle_node(service, conn_handle);
if (!p_handle) {
tfm_core_panic();
}
return p_handle->rhandle;
}
/* Partition management functions */
struct tfm_spm_service_t *
tfm_spm_get_service_by_signal(struct spm_partition_desc_t *partition,
psa_signal_t signal)
{
struct tfm_list_node_t *node, *head;
struct tfm_spm_service_t *service;
TFM_CORE_ASSERT(partition);
if (tfm_list_is_empty(&partition->runtime_data.service_list)) {
tfm_core_panic();
}
head = &partition->runtime_data.service_list;
TFM_LIST_FOR_EACH(node, head) {
service = TFM_GET_CONTAINER_PTR(node, struct tfm_spm_service_t, list);
if (service->service_db->signal == signal) {
return service;
}
}
return NULL;
}
struct tfm_spm_service_t *tfm_spm_get_service_by_sid(uint32_t sid)
{
uint32_t i;
struct tfm_list_node_t *node, *head;
struct tfm_spm_service_t *service;
struct spm_partition_desc_t *partition;
for (i = 0; i < g_spm_partition_db.partition_count; i++) {
partition = &g_spm_partition_db.partitions[i];
/* Skip partition without IPC flag */
if ((tfm_spm_partition_get_flags(i) & SPM_PART_FLAG_IPC) == 0) {
continue;
}
if (tfm_list_is_empty(&partition->runtime_data.service_list)) {
continue;
}
head = &partition->runtime_data.service_list;
TFM_LIST_FOR_EACH(node, head) {
service = TFM_GET_CONTAINER_PTR(node, struct tfm_spm_service_t,
list);
if (service->service_db->sid == sid) {
return service;
}
}
}
return NULL;
}
struct tfm_spm_service_t *
tfm_spm_get_service_by_handle(psa_handle_t conn_handle)
{
return ((struct tfm_conn_handle_t *)conn_handle)->service;
}
struct spm_partition_desc_t *tfm_spm_get_partition_by_id(int32_t partition_id)
{
uint32_t idx = get_partition_idx(partition_id);
if (idx != SPM_INVALID_PARTITION_IDX) {
return &(g_spm_partition_db.partitions[idx]);
}
return NULL;
}
struct spm_partition_desc_t *tfm_spm_get_running_partition(void)
{
uint32_t spid;
spid = tfm_spm_partition_get_running_partition_id();
return tfm_spm_get_partition_by_id(spid);
}
int32_t tfm_spm_check_client_version(struct tfm_spm_service_t *service,
uint32_t version)
{
TFM_CORE_ASSERT(service);
switch (service->service_db->version_policy) {
case TFM_VERSION_POLICY_RELAXED:
if (version > service->service_db->version) {
return IPC_ERROR_VERSION;
}
break;
case TFM_VERSION_POLICY_STRICT:
if (version != service->service_db->version) {
return IPC_ERROR_VERSION;
}
break;
default:
return IPC_ERROR_VERSION;
}
return IPC_SUCCESS;
}
int32_t tfm_spm_check_authorization(uint32_t sid,
struct tfm_spm_service_t *service,
bool ns_caller)
{
struct spm_partition_desc_t *partition = NULL;
int32_t i;
TFM_CORE_ASSERT(service);
if (ns_caller) {
if (!service->service_db->non_secure_client) {
return IPC_ERROR_GENERIC;
}
} else {
partition = tfm_spm_get_running_partition();
if (!partition) {
tfm_core_panic();
}
for (i = 0; i < partition->static_data->dependencies_num; i++) {
if (partition->static_data->p_dependencies[i] == sid) {
break;
}
}
if (i == partition->static_data->dependencies_num) {
return IPC_ERROR_GENERIC;
}
}
return IPC_SUCCESS;
}
/* Message functions */
struct tfm_msg_body_t *tfm_spm_get_msg_from_handle(psa_handle_t msg_handle)
{
/*
* The message handler passed by the caller is considered invalid in the
* following cases:
* 1. Not a valid message handle. (The address of a message is not the
* address of a possible handle from the pool
* 2. Handle not belongs to the caller partition (The handle is either
* unused, or owned by anither partition)
* Check the conditions above
*/
struct tfm_conn_handle_t *connection_handle_address;
struct tfm_msg_body_t *msg;
uint32_t partition_id;
msg = (struct tfm_msg_body_t *)msg_handle;
connection_handle_address =
TFM_GET_CONTAINER_PTR(msg, struct tfm_conn_handle_t, internal_msg);
if (is_valid_chunk_data_in_pool(
conn_handle_pool, (uint8_t *)connection_handle_address) != 1) {
return NULL;
}
/*
* Check that the magic number is correct. This proves that the message
* structure contains an active message.
*/
if (msg->magic != TFM_MSG_MAGIC) {
return NULL;
}
/* Check that the running partition owns the message */
partition_id = tfm_spm_partition_get_running_partition_id();
if (partition_id != msg->service->partition->static_data->partition_id) {
return NULL;
}
/*
* FixMe: For condition 1 it should be checked whether the message belongs
* to the service. Skipping this check isn't a security risk as even if the
* message belongs to another service, the handle belongs to the calling
* partition.
*/
return msg;
}
struct tfm_msg_body_t *
tfm_spm_get_msg_buffer_from_conn_handle(psa_handle_t conn_handle)
{
TFM_CORE_ASSERT(conn_handle != PSA_NULL_HANDLE);
return &(((struct tfm_conn_handle_t *)conn_handle)->internal_msg);
}
void tfm_spm_fill_msg(struct tfm_msg_body_t *msg,
struct tfm_spm_service_t *service,
psa_handle_t handle,
int32_t type, int32_t client_id,
psa_invec *invec, size_t in_len,
psa_outvec *outvec, size_t out_len,
psa_outvec *caller_outvec)
{
uint32_t i;
TFM_CORE_ASSERT(msg);
TFM_CORE_ASSERT(service);
TFM_CORE_ASSERT(!(invec == NULL && in_len != 0));
TFM_CORE_ASSERT(!(outvec == NULL && out_len != 0));
TFM_CORE_ASSERT(in_len <= PSA_MAX_IOVEC);
TFM_CORE_ASSERT(out_len <= PSA_MAX_IOVEC);
TFM_CORE_ASSERT(in_len + out_len <= PSA_MAX_IOVEC);
/* Clear message buffer before using it */
tfm_core_util_memset(msg, 0, sizeof(struct tfm_msg_body_t));
tfm_event_init(&msg->ack_evnt);
msg->magic = TFM_MSG_MAGIC;
msg->service = service;
msg->handle = handle;
msg->caller_outvec = caller_outvec;
msg->msg.client_id = client_id;
/* Copy contents */
msg->msg.type = type;
for (i = 0; i < in_len; i++) {
msg->msg.in_size[i] = invec[i].len;
msg->invec[i].base = invec[i].base;
}
for (i = 0; i < out_len; i++) {
msg->msg.out_size[i] = outvec[i].len;
msg->outvec[i].base = outvec[i].base;
/* Out len is used to record the writed number, set 0 here again */
msg->outvec[i].len = 0;
}
/* Use message address as handle */
msg->msg.handle = (psa_handle_t)msg;
/* For connected handle, set rhandle to every message */
if (handle != PSA_NULL_HANDLE) {
msg->msg.rhandle = tfm_spm_get_rhandle(service, handle);
}
}
int32_t tfm_spm_send_event(struct tfm_spm_service_t *service,
struct tfm_msg_body_t *msg)
{
struct spm_partition_runtime_data_t *p_runtime_data =
&service->partition->runtime_data;
TFM_CORE_ASSERT(service);
TFM_CORE_ASSERT(msg);
/* Enqueue message to service message queue */
if (tfm_msg_enqueue(&service->msg_queue, msg) != IPC_SUCCESS) {
return IPC_ERROR_GENERIC;
}
/* Messages put. Update signals */
p_runtime_data->signals |= service->service_db->signal;
tfm_event_wake(&p_runtime_data->signal_evnt, (p_runtime_data->signals &
p_runtime_data->signal_mask));
/*
* If it is a NS request via RPC, it is unnecessary to block current
* thread.
*/
if (!is_tfm_rpc_msg(msg)) {
tfm_event_wait(&msg->ack_evnt);
}
return IPC_SUCCESS;
}
uint32_t tfm_spm_partition_get_stack_bottom(uint32_t partition_idx)
{
return g_spm_partition_db.partitions[partition_idx].
memory_data->stack_bottom;
}
uint32_t tfm_spm_partition_get_stack_top(uint32_t partition_idx)
{
return g_spm_partition_db.partitions[partition_idx].memory_data->stack_top;
}
uint32_t tfm_spm_partition_get_running_partition_id(void)
{
struct tfm_thrd_ctx *pth = tfm_thrd_curr_thread();
struct spm_partition_desc_t *partition;
struct spm_partition_runtime_data_t *r_data;
r_data = TFM_GET_CONTAINER_PTR(pth, struct spm_partition_runtime_data_t,
sp_thrd);
partition = TFM_GET_CONTAINER_PTR(r_data, struct spm_partition_desc_t,
runtime_data);
return partition->static_data->partition_id;
}
static struct tfm_thrd_ctx *
tfm_spm_partition_get_thread_info(uint32_t partition_idx)
{
return &g_spm_partition_db.partitions[partition_idx].runtime_data.sp_thrd;
}
static tfm_thrd_func_t
tfm_spm_partition_get_init_func(uint32_t partition_idx)
{
return (tfm_thrd_func_t)(g_spm_partition_db.partitions[partition_idx].
static_data->partition_init);
}
static uint32_t tfm_spm_partition_get_priority(uint32_t partition_idx)
{
return g_spm_partition_db.partitions[partition_idx].static_data->
partition_priority;
}
int32_t tfm_memory_check(const void *buffer, size_t len, bool ns_caller,
enum tfm_memory_access_e access,
uint32_t privileged)
{
enum tfm_status_e err;
/* If len is zero, this indicates an empty buffer and base is ignored */
if (len == 0) {
return IPC_SUCCESS;
}
if (!buffer) {
return IPC_ERROR_BAD_PARAMETERS;
}
if ((uintptr_t)buffer > (UINTPTR_MAX - len)) {
return IPC_ERROR_MEMORY_CHECK;
}
if (access == TFM_MEMORY_ACCESS_RW) {
err = tfm_core_has_write_access_to_region(buffer, len, ns_caller,
privileged);
} else {
err = tfm_core_has_read_access_to_region(buffer, len, ns_caller,
privileged);
}
if (err == TFM_SUCCESS) {
return IPC_SUCCESS;
}
return IPC_ERROR_MEMORY_CHECK;
}
uint32_t tfm_spm_partition_get_privileged_mode(uint32_t partition_flags)
{
if (partition_flags & SPM_PART_FLAG_PSA_ROT) {
return TFM_PARTITION_PRIVILEGED_MODE;
} else {
return TFM_PARTITION_UNPRIVILEGED_MODE;
}
}
/********************** SPM functions for thread mode ************************/
void tfm_spm_init(void)
{
uint32_t i, j, num;
struct spm_partition_desc_t *partition;
struct tfm_thrd_ctx *pth, *p_ns_entry_thread = NULL;
const struct tfm_spm_partition_platform_data_t **platform_data_p;
tfm_pool_init(conn_handle_pool,
POOL_BUFFER_SIZE(conn_handle_pool),
sizeof(struct tfm_conn_handle_t),
TFM_CONN_HANDLE_MAX_NUM);
/* Init partition first for it will be used when init service */
for (i = 0; i < g_spm_partition_db.partition_count; i++) {
partition = &g_spm_partition_db.partitions[i];
/* Check if the PSA framework version matches. */
if (partition->static_data->psa_framework_version !=
PSA_FRAMEWORK_VERSION) {
ERROR_MSG("Warning: PSA Framework Verison is not matched!");
continue;
}
platform_data_p = partition->platform_data_list;
if (platform_data_p != NULL) {
while ((*platform_data_p) != NULL) {
tfm_spm_hal_configure_default_isolation(*platform_data_p);
++platform_data_p;
}
}
if ((tfm_spm_partition_get_flags(i) & SPM_PART_FLAG_IPC) == 0) {
continue;
}
/* Add PSA_DOORBELL signal to assigned_signals */
partition->runtime_data.assigned_signals |= PSA_DOORBELL;
/* TODO: This can be optimized by generating the assigned signal
* in code generation time.
*/
for (j = 0; j < tfm_core_irq_signals_count; ++j) {
if (tfm_core_irq_signals[j].partition_id ==
partition->static_data->partition_id) {
partition->runtime_data.assigned_signals |=
tfm_core_irq_signals[j].signal_value;
}
}
tfm_event_init(&partition->runtime_data.signal_evnt);
tfm_list_init(&partition->runtime_data.service_list);
pth = tfm_spm_partition_get_thread_info(i);
if (!pth) {
tfm_core_panic();
}
tfm_thrd_init(pth,
tfm_spm_partition_get_init_func(i),
NULL,
(uintptr_t)tfm_spm_partition_get_stack_top(i),
(uintptr_t)tfm_spm_partition_get_stack_bottom(i));
pth->prior = tfm_spm_partition_get_priority(i);
if (partition->static_data->partition_id == TFM_SP_NON_SECURE_ID) {
p_ns_entry_thread = pth;
pth->param = (void *)tfm_spm_hal_get_ns_entry_point();
}
/* Kick off */
if (tfm_thrd_start(pth) != THRD_SUCCESS) {
tfm_core_panic();
}
}
/* Init Service */
num = sizeof(service) / sizeof(struct tfm_spm_service_t);
for (i = 0; i < num; i++) {
service[i].service_db = &service_db[i];
partition =
tfm_spm_get_partition_by_id(service[i].service_db->partition_id);
if (!partition) {
tfm_core_panic();
}
service[i].partition = partition;
partition->runtime_data.assigned_signals |= service->service_db->signal;
tfm_list_init(&service[i].handle_list);
tfm_list_add_tail(&partition->runtime_data.service_list,
&service[i].list);
}
/*
* All threads initialized, start the scheduler.
*
* NOTE:
* It is worthy to give the thread object to scheduler if the background
* context belongs to one of the threads. Here the background thread is the
* initialization thread who calls SPM SVC, which re-uses the non-secure
* entry thread's stack. After SPM initialization is done, this stack is
* cleaned up and the background context is never going to return. Tell
* the scheduler that the current thread is non-secure entry thread.
*/
tfm_thrd_start_scheduler(p_ns_entry_thread);
}
void tfm_pendsv_do_schedule(struct tfm_state_context_ext *ctxb)
{
#if TFM_LVL == 2
struct spm_partition_desc_t *p_next_partition;
struct spm_partition_runtime_data_t *r_data;
uint32_t is_privileged;
#endif
struct tfm_thrd_ctx *pth_next = tfm_thrd_next_thread();
struct tfm_thrd_ctx *pth_curr = tfm_thrd_curr_thread();
if (pth_next != NULL && pth_curr != pth_next) {
#if TFM_LVL == 2
r_data = TFM_GET_CONTAINER_PTR(pth_next,
struct spm_partition_runtime_data_t,
sp_thrd);
p_next_partition = TFM_GET_CONTAINER_PTR(r_data,
struct spm_partition_desc_t,
runtime_data);
if (p_next_partition->static_data->partition_flags &
SPM_PART_FLAG_PSA_ROT) {
is_privileged = TFM_PARTITION_PRIVILEGED_MODE;
} else {
is_privileged = TFM_PARTITION_UNPRIVILEGED_MODE;
}
tfm_spm_partition_change_privilege(is_privileged);
#endif
tfm_thrd_context_switch(ctxb, pth_curr, pth_next);
}
/*
* Handle pending mailbox message from NS in multi-core topology.
* Empty operation on single Armv8-M platform.
*/
tfm_rpc_client_call_handler();
}
|