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
|
/* SPDX-License-Identifier: BSD-2-Clause */
/*
* Copyright (c) 2019, Linaro Limited
*/
/*
* This file is exported by OP-TEE and is kept in sync between secure world
* and normal world drivers. We're using ARM FF-A 1.0 EAC specification.
*/
#ifndef __OPTEE_FFA_H
#define __OPTEE_FFA_H
#include <ffa.h>
/*
* Normal world sends requests with FFA_MSG_SEND_DIRECT_REQ and
* responses are returned with FFA_MSG_SEND_DIRECT_RESP for normal
* messages.
*
* All requests with FFA_MSG_SEND_DIRECT_REQ and FFA_MSG_SEND_DIRECT_RESP
* are using the AArch32 SMC calling convention with register usage as
* defined in FF-A specification:
* w0: Function ID (0x8400006F or 0x84000070)
* w1: Source/Destination IDs
* w2: Reserved (MBZ)
* w3-w7: Implementation defined, free to be used below
*/
#define OPTEE_FFA_VERSION_MAJOR UINT32_C(0)
#define OPTEE_FFA_VERSION_MINOR UINT32_C(9)
#define OPTEE_FFA_BLOCKING_CALL(id) UINT32_C(id)
#define OPTEE_FFA_YIELDING_CALL_BIT 31
#define OPTEE_FFA_YIELDING_CALL(id) (UINT32_C(id) | \
BIT32(OPTEE_FFA_YIELDING_CALL_BIT))
/*
* Returns the API version implemented, currently follows the FF-A version.
* Call register usage:
* w3: Service ID, OPTEE_FFA_GET_API_VERSION
* w4-w7: Not used (MBZ)
*
* Return register usage:
* w3: OPTEE_FFA_VERSION_MAJOR
* w4: OPTEE_FFA_VERSION_MINOR
* w5-w7: Not used (MBZ)
*/
#define OPTEE_FFA_GET_API_VERSION OPTEE_FFA_BLOCKING_CALL(0)
/*
* Returns the revision of OP-TEE.
*
* Used by non-secure world to figure out which version of the Trusted OS
* is installed. Note that the returned revision is the revision of the
* Trusted OS, not of the API.
*
* Call register usage:
* w3: Service ID, OPTEE_FFA_GET_OS_VERSION
* w4-w7: Unused (MBZ)
*
* Return register usage:
* w3: CFG_OPTEE_REVISION_MAJOR
* w4: CFG_OPTEE_REVISION_MINOR
* w5: TEE_IMPL_GIT_SHA1 (or zero if not supported)
*/
#define OPTEE_FFA_GET_OS_VERSION OPTEE_FFA_BLOCKING_CALL(1)
/*
* Exchange capabilities between normal world and secure world.
*
* Currently there are no defined capabilities. When features are added new
* capabilities may be added.
*
* Call register usage:
* w3: Service ID, OPTEE_FFA_EXCHANGE_CAPABILITIES
* w4-w7: Note used (MBZ)
*
* Return register usage:
* w3: Error code, 0 on success
* w4: Bit[1:0]: Number of 4kB pages of shared memory to register with
* OPTEE_FFA_REGISTER_RPC_SHM to support RPC
* Bit[31:2]: Reserved (MBZ)
* w5-w7: Note used (MBZ)
*/
#define OPTEE_FFA_EXCHANGE_CAPABILITIES OPTEE_FFA_BLOCKING_CALL(2)
/*
* Call with struct optee_msg_arg as argument in the supplied shared memory
* with a zero internal offset and normal cached memory attributes.
* Register usage:
* w3: Service ID, OPTEE_FFA_YIELDING_CALL_WITH_ARG
* w4: Lower 32 bits of a 64-bit Shared memory handle
* w5: Upper 32 bits of a 64-bit Shared memory handle
* w6: Offset into shared memory pointing to a struct optee_msg_arg
* w7: Not used (MBZ)
*
* Call to register shared memory. The data is supplied in shared
* memory with a zero internal offset and normal cached memory attributes.
* The data is formatted as described in FF-A 1.0 EAC Table 44
* "Lend, donate or share memory transaction descriptor".
* Register usage:
* w3: Service ID, OPTEE_FFA_YIELDING_CALL_REGISTER_SHM
* w4: Lower 32 bits of a 64-bit Shared memory handle
* w5: Upper 32 bits of a 64-bit Shared memory handle
* w6-w7: Not used (MBZ)
*
* Call to unregister shared memory. Register usage:
* w3: Service ID, OPTEE_FFA_YIELDING_CALL_UNREGISTER_SHM
* w4: Lower 32 bits of a 64-bit Shared memory handle
* w5: Upper 32 bits of a 64-bit Shared memory handle
* w6-w7: Not used (MBZ)
*
* Resume from RPC. Register usage:
* w3: Service ID, OPTEE_FFA_YIELDING_CALL_RESUME
* If returning from OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_SHM:
* w4: Lower 32 bits of a 64-bit Shared memory handle
* w5: Upper 32 bits of a 64-bit Shared memory handle
* If the allocation failed both w4 and w5 are 0
* w6: Offset into shared memory pointing the table. If internal
* offset > 0 then one more 4kB page than requested has been
* allocated.
* else if resuming from another RPC:
* w4-w6: Not used (MBZ)
* w7: Resume info
*
* Normal return (yielding call is completed). Register usage:
* w3: Error code, 0 on success
* w4: OPTEE_FFA_YIELDING_CALL_RETURN_DONE
* w5-w7: Not used (MBZ)
*
* Alloc SHM return (RPC from secure world). Register usage:
* w3: Error code == 0
* w4: OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_KERN_SHM or
* OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_SUPPL_SHM
* allocate kernel private or supplicant memory respectively.
* w5: Number of 4kB pages of shared memory
* w6: Not used (MBZ)
* w7: Resume info
*
* Free SHM return (RPC from secure world). Register usage:
* w3: Error code == 0
* w4: OPTEE_FFA_YIELDING_CALL_RETURN_FREE_KERN_SHM or
* OPTEE_FFA_YIELDING_CALL_RETURN_FREE_SUPPL_SHM
* free kernel private or supplicant memory respectively.
* w5: Lower 32 bits of a 64-bit Shared memory handle
* w6: Upper 32 bits of a 64-bit Shared memory handle
* The handle previously allocated with
* OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_KERN_SHM or
* OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_SUPPL_SHM.
* w7: Resume info
*
* RPC cmd return (RPC from secure world). Register usage:
* w3: Error code == 0
* w4: OPTEE_FFA_YIELDING_CALL_RETURN_RPC_CMD
* w5: Lower 32 bits of a 64-bit Shared memory handle
* w6: Upper 32 bits of a 64-bit Shared memory handle
* The handle contains aed the RPC.
* w7: Resume info
*
* RPC interrupt return (RPC from secure world). Register usage:
* w3: Error code == 0
* w4: OPTEE_FFA_YIELDING_CALL_RETURN_INTERRUPT
* w5-w6: Not used (MBZ)
* w7: Resume info
*
* Possible error codes in register w3:
* 0: Success
* FFA_DENIED: w4 isn't one of OPTEE_FFA_YIELDING_CALL_START
* OPTEE_FFA_YIELDING_CALL_REGISTER_SHM,
* OPTEE_FFA_YIELDING_CALL_UNREGISTER_SHM or
* OPTEE_FFA_YIELDING_CALL_RESUME
*
* Possible error codes for OPTEE_FFA_YIELDING_CALL_START,
* OPTEE_FFA_YIELDING_CALL_REGISTER_SHM and
* OPTEE_FFA_YIELDING_CALL_UNREGISTER_SHM
* FFA_BUSY: Number of OP-TEE OS threads exceeded,
* try again later
* FFA_DENIED: RPC shared memory object not found
* FFA_INVALID_PARAMETER: Bad shared memory handle or offset into the memory
*
* Possible error codes for OPTEE_FFA_YIELDING_CALL_RESUME
* FFA_INVALID_PARAMETER: Bad resume info
*/
#define OPTEE_FFA_YIELDING_CALL_WITH_ARG OPTEE_FFA_YIELDING_CALL(0)
#define OPTEE_FFA_YIELDING_CALL_REGISTER_SHM OPTEE_FFA_YIELDING_CALL(1)
#define OPTEE_FFA_YIELDING_CALL_UNREGISTER_SHM OPTEE_FFA_YIELDING_CALL(2)
#define OPTEE_FFA_YIELDING_CALL_RESUME OPTEE_FFA_YIELDING_CALL(3)
#define OPTEE_FFA_YIELDING_CALL_RETURN_DONE 0
#define OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_KERN_SHM 1
#define OPTEE_FFA_YIELDING_CALL_RETURN_ALLOC_SUPPL_SHM 2
#define OPTEE_FFA_YIELDING_CALL_RETURN_RESERVED0 3
#define OPTEE_FFA_YIELDING_CALL_RETURN_FREE_KERN_SHM 4
#define OPTEE_FFA_YIELDING_CALL_RETURN_FREE_SUPPL_SHM 5
#define OPTEE_FFA_YIELDING_CALL_RETURN_RESERVED1 6
#define OPTEE_FFA_YIELDING_CALL_RETURN_RPC_CMD 7
#define OPTEE_FFA_YIELDING_CALL_RETURN_INTERRUPT 8
#endif /*__OPTEE_FFA_H*/
|
