blob: 740fee58b089ee2f06ee9b8b9fb7729ceb4c75d4 [file] [log] [blame]
Antonio Nino Diazc41f2062017-10-24 10:07:35 +01001/*
Antonio Nino Diaz37f97a52019-03-27 11:10:31 +00002 * Copyright (c) 2017-2019, ARM Limited and Contributors. All rights reserved.
Antonio Nino Diazc41f2062017-10-24 10:07:35 +01003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef SPM_PRIVATE_H
8#define SPM_PRIVATE_H
Antonio Nino Diazc41f2062017-10-24 10:07:35 +01009
10#include <context.h>
11
12/*******************************************************************************
13 * Constants that allow assembler code to preserve callee-saved registers of the
14 * C runtime context while performing a security state switch.
15 ******************************************************************************/
16#define SP_C_RT_CTX_X19 0x0
17#define SP_C_RT_CTX_X20 0x8
18#define SP_C_RT_CTX_X21 0x10
19#define SP_C_RT_CTX_X22 0x18
20#define SP_C_RT_CTX_X23 0x20
21#define SP_C_RT_CTX_X24 0x28
22#define SP_C_RT_CTX_X25 0x30
23#define SP_C_RT_CTX_X26 0x38
24#define SP_C_RT_CTX_X27 0x40
25#define SP_C_RT_CTX_X28 0x48
26#define SP_C_RT_CTX_X29 0x50
27#define SP_C_RT_CTX_X30 0x58
28
29#define SP_C_RT_CTX_SIZE 0x60
30#define SP_C_RT_CTX_ENTRIES (SP_C_RT_CTX_SIZE >> DWORD_SHIFT)
31
Antonio Nino Diazfb763962018-07-03 16:54:33 +010032/* Value returned by spm_sp_synchronous_entry() when a partition is preempted */
33#define SPM_SECURE_PARTITION_PREEMPTED U(0x1234)
34
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010035#ifndef __ASSEMBLY__
36
37#include <stdint.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000038
39#include <lib/xlat_tables/xlat_tables_v2.h>
40#include <lib/spinlock.h>
41#include <services/sp_res_desc.h>
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010042
Antonio Nino Diazda50cd02018-06-15 16:21:01 +010043typedef enum sp_state {
Antonio Nino Diazc4f27522018-05-23 09:09:41 +010044 SP_STATE_RESET = 0,
45 SP_STATE_IDLE,
46 SP_STATE_BUSY
47} sp_state_t;
48
Antonio Nino Diaz28759312018-05-22 16:26:48 +010049typedef struct sp_context {
Antonio Nino Diaz8cc23f92018-10-30 11:35:30 +000050 /* 1 if the partition is present, 0 otherwise */
51 int is_present;
52
Antonio Nino Diaz840627f2018-11-27 08:36:02 +000053 /* Location of the image in physical memory */
54 unsigned long long image_base;
55 size_t image_size;
56
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010057 uint64_t c_rt_ctx;
58 cpu_context_t cpu_ctx;
Antonio Nino Diaz840627f2018-11-27 08:36:02 +000059 struct sp_res_desc rd;
Antonio Nino Diazc4f27522018-05-23 09:09:41 +010060
Antonio Nino Diaz124a1fc2018-11-30 10:52:09 +000061 /* Translation tables context */
62 xlat_ctx_t *xlat_ctx_handle;
63 spinlock_t xlat_ctx_lock;
64
Antonio Nino Diazc4f27522018-05-23 09:09:41 +010065 sp_state_t state;
66 spinlock_t state_lock;
Antonio Nino Diazbb7d1cd2018-10-30 11:34:23 +000067
Antonio Nino Diaz44ef4eb2018-07-03 19:54:59 +010068 unsigned int request_count;
69 spinlock_t request_count_lock;
70
Antonio Nino Diazbb7d1cd2018-10-30 11:34:23 +000071 /* Base and size of the shared SPM<->SP buffer */
72 uintptr_t spm_sp_buffer_base;
73 size_t spm_sp_buffer_size;
Antonio Nino Diaz8c83ad82018-11-08 14:21:19 +000074 spinlock_t spm_sp_buffer_lock;
Antonio Nino Diaz28759312018-05-22 16:26:48 +010075} sp_context_t;
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010076
Antonio Nino Diaz8c83ad82018-11-08 14:21:19 +000077/* Functions used to enter/exit a Secure Partition synchronously */
Antonio Nino Diazfb763962018-07-03 16:54:33 +010078uint64_t spm_sp_synchronous_entry(sp_context_t *sp_ctx, int can_preempt);
Antonio Nino Diaz8c83ad82018-11-08 14:21:19 +000079__dead2 void spm_sp_synchronous_exit(uint64_t rc);
80
Antonio Nino Diaz2ac9a442018-05-23 11:40:46 +010081/* Assembly helpers */
Antonio Nino Diazc41f2062017-10-24 10:07:35 +010082uint64_t spm_secure_partition_enter(uint64_t *c_rt_ctx);
83void __dead2 spm_secure_partition_exit(uint64_t c_rt_ctx, uint64_t ret);
Antonio Nino Diaz2ac9a442018-05-23 11:40:46 +010084
Antonio Nino Diazbb7d1cd2018-10-30 11:34:23 +000085/* Secure Partition setup */
Antonio Nino Diaz28759312018-05-22 16:26:48 +010086void spm_sp_setup(sp_context_t *sp_ctx);
Antonio Nino Diaz2ac9a442018-05-23 11:40:46 +010087
Antonio Nino Diaz8c83ad82018-11-08 14:21:19 +000088/* Secure Partition state management helpers */
89void sp_state_set(sp_context_t *sp_ptr, sp_state_t state);
90void sp_state_wait_switch(sp_context_t *sp_ptr, sp_state_t from, sp_state_t to);
91int sp_state_try_switch(sp_context_t *sp_ptr, sp_state_t from, sp_state_t to);
92
Antonio Nino Diaz44ef4eb2018-07-03 19:54:59 +010093/* Functions to keep track of the number of active requests per SP */
94void spm_sp_request_increase(sp_context_t *sp_ctx);
95void spm_sp_request_decrease(sp_context_t *sp_ctx);
96int spm_sp_request_increase_if_zero(sp_context_t *sp_ctx);
97
Antonio Nino Diaz37f97a52019-03-27 11:10:31 +000098/* Functions related to the shim layer translation tables */
99void spm_exceptions_xlat_init_context(void);
100uint64_t *spm_exceptions_xlat_get_base_table(void);
101
Antonio Nino Diazbb7d1cd2018-10-30 11:34:23 +0000102/* Functions related to the translation tables management */
Antonio Nino Diaz18e312d2019-03-27 13:04:46 +0000103void spm_sp_xlat_context_alloc(sp_context_t *sp_ctx);
Antonio Nino Diazbb7d1cd2018-10-30 11:34:23 +0000104void sp_map_memory_regions(sp_context_t *sp_ctx);
Antonio Nino Diaz7b28b542018-05-22 16:45:35 +0100105
Antonio Nino Diaz8cc23f92018-10-30 11:35:30 +0000106/* Functions to handle Secure Partition contexts */
107void spm_cpu_set_sp_ctx(unsigned int linear_id, sp_context_t *sp_ctx);
108sp_context_t *spm_cpu_get_sp_ctx(unsigned int linear_id);
Antonio Nino Diazb5b585a2018-11-08 14:20:07 +0000109sp_context_t *spm_sp_get_by_uuid(const uint32_t (*svc_uuid)[4]);
Antonio Nino Diaz8cc23f92018-10-30 11:35:30 +0000110
Antonio Nino Diaz89036412018-10-18 14:54:57 +0100111/* Functions to manipulate response and requests buffers */
112int spm_response_add(uint16_t client_id, uint16_t handle, uint32_t token,
113 u_register_t x1, u_register_t x2, u_register_t x3);
114int spm_response_get(uint16_t client_id, uint16_t handle, uint32_t token,
115 u_register_t *x1, u_register_t *x2, u_register_t *x3);
116
Antonio Nino Diazc41f2062017-10-24 10:07:35 +0100117#endif /* __ASSEMBLY__ */
118
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000119#endif /* SPM_PRIVATE_H */