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
|
/*
* Copyright (c) 2014-2023, ARM Limited and Contributors. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/* Copyright (c) 2014, Linaro Limited. All rights reserved. */
#ifndef TEESMC_OPTEED_H
#define TEESMC_OPTEED_H
#include "teesmc_opteed_macros.h"
/*
* This section specifies SMC function IDs used when returning from TEE to the
* secure monitor.
*
* All SMC Function IDs indicates SMC32 Calling Convention but will carry
* full 64 bit values in the argument registers if invoked from Aarch64
* mode. This violates the SMC Calling Convention, but since this
* convention only coveres API towards Normal World it's something that
* only concerns the OP-TEE Dispatcher in Trusted Firmware-A and OP-TEE
* OS at Secure EL1.
*/
/*
* Issued when returning from initial entry.
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_ENTRY_DONE
* r1/x1 Pointer to entry vector
*/
#define TEESMC_OPTEED_FUNCID_RETURN_ENTRY_DONE 0
#define TEESMC_OPTEED_RETURN_ENTRY_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_ENTRY_DONE)
/*
* Issued when returning from "cpu_on" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_ON_DONE
* r1/x1 0 on success and anything else to indicate error condition
*/
#define TEESMC_OPTEED_FUNCID_RETURN_ON_DONE 1
#define TEESMC_OPTEED_RETURN_ON_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_ON_DONE)
/*
* Issued when returning from "cpu_off" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_OFF_DONE
* r1/x1 0 on success and anything else to indicate error condition
*/
#define TEESMC_OPTEED_FUNCID_RETURN_OFF_DONE 2
#define TEESMC_OPTEED_RETURN_OFF_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_OFF_DONE)
/*
* Issued when returning from "cpu_suspend" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_SUSPEND_DONE
* r1/x1 0 on success and anything else to indicate error condition
*/
#define TEESMC_OPTEED_FUNCID_RETURN_SUSPEND_DONE 3
#define TEESMC_OPTEED_RETURN_SUSPEND_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_SUSPEND_DONE)
/*
* Issued when returning from "cpu_resume" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_RESUME_DONE
* r1/x1 0 on success and anything else to indicate error condition
*/
#define TEESMC_OPTEED_FUNCID_RETURN_RESUME_DONE 4
#define TEESMC_OPTEED_RETURN_RESUME_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_RESUME_DONE)
/*
* Issued when returning from "std_smc" or "fast_smc" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_CALL_DONE
* r1-4/x1-4 Return value 0-3 which will passed to normal world in
* r0-3/x0-3
*/
#define TEESMC_OPTEED_FUNCID_RETURN_CALL_DONE 5
#define TEESMC_OPTEED_RETURN_CALL_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_CALL_DONE)
/*
* Issued when returning from "fiq" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_FIQ_DONE
*/
#define TEESMC_OPTEED_FUNCID_RETURN_FIQ_DONE 6
#define TEESMC_OPTEED_RETURN_FIQ_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_FIQ_DONE)
/*
* Issued when returning from "system_off" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_SYSTEM_OFF_DONE
*/
#define TEESMC_OPTEED_FUNCID_RETURN_SYSTEM_OFF_DONE 7
#define TEESMC_OPTEED_RETURN_SYSTEM_OFF_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_SYSTEM_OFF_DONE)
/*
* Issued when returning from "system_reset" vector
*
* Register usage:
* r0/x0 SMC Function ID, TEESMC_OPTEED_RETURN_SYSTEM_RESET_DONE
*/
#define TEESMC_OPTEED_FUNCID_RETURN_SYSTEM_RESET_DONE 8
#define TEESMC_OPTEED_RETURN_SYSTEM_RESET_DONE \
TEESMC_OPTEED_RV(TEESMC_OPTEED_FUNCID_RETURN_SYSTEM_RESET_DONE)
/*
* This section specifies SMC function IDs used when the secure monitor is
* invoked from the non-secure world.
*/
/*
* Load OP-TEE image from the payload specified in the registers.
*
* WARNING: Use this cautiously as it could lead to insecure loading of the
* Trusted OS. Further details are in opteed.mk.
*
* Call register usage:
* x0 SMC Function ID, OPTEE_SMC_CALL_LOAD_IMAGE
* x1 Upper 32bit of a 64bit size for the payload
* x2 Lower 32bit of a 64bit size for the payload
* x3 Upper 32bit of the physical address for the payload
* x4 Lower 32bit of the physical address for the payload
*
* The payload consists of a optee_header struct that contains optee_image
* structs in a flex array, immediately following that in memory is the data
* referenced by the optee_image structs.
* Example:
*
* struct optee_header (with n images specified)
* image 0 data
* image 1 data
* ...
* image n-1 data
*
* Returns 0 on success and an error code otherwise.
*/
#define NSSMC_OPTEED_FUNCID_LOAD_IMAGE 2
#define NSSMC_OPTEED_CALL_LOAD_IMAGE \
NSSMC_OPTEED_CALL(NSSMC_OPTEED_FUNCID_LOAD_IMAGE)
/*
* Returns the UID of the OP-TEE image loading service if image loading is
* enabled and the image had not been loaded yet. Otherwise this call will be
* passed through to OP-TEE where it will return the OP-TEE UID.
*/
#define NSSMC_OPTEED_FUNCID_CALLS_UID 0xFF01
#define NSSMC_OPTEED_CALL_UID \
NSSMC_OPTEED_CALL(NSSMC_OPTEED_FUNCID_CALLS_UID)
#endif /*TEESMC_OPTEED_H*/
|
