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
|
/** @file
Library definition for FF-A memory management protocol.
Copyright (c) 2020 - 2022, Arm Ltd. All rights reserved.<BR>
Copyright (c), Microsoft Corporation.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#pragma once
#include <Uefi.h>
/**
Starts a transaction to transfer of ownership of a memory region from a Sender
endpoint to a Receiver endpoint.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[in] BufferAddr Base address of a buffer allocated by the Owner and
distinct from the TX buffer
@param[in] PageCount Number of 4K pages in the buffer allocated by the
Owner and distinct from the TX buffer
@param[out] Handle Globally unique Handle to identify the memory region
upon successful transmission of the transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibDonate (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
IN VOID *BufferAddr,
IN UINT32 PageCount,
OUT UINT64 *Handle
);
/**
Starts a transaction to transfer of ownership of a memory region from a Sender
endpoint to a Receiver endpoint.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[out] Handle Globally unique Handle to identify the memory region
upon successful transmission of the transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibDonateRxTx (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
OUT UINT64 *Handle
);
/**
Starts a transaction to transfer an Owner's access to a memory region and grant
access to it to one or more Borrowers.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction
descriptor passed in this ABI invocation
@param[in] BufferAddr Base address of a buffer allocated by the Owner
and distinct from the TX buffer
@param[in] PageCount Number of 4K pages in the buffer allocated by
the Owner and distinct from the TX buffer
@param[out] Handle Globally unique Handle to identify the memory
region upon successful transmission of the
transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibLend (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
IN VOID *BufferAddr,
IN UINT32 PageCount,
OUT UINT64 *Handle
);
/**
Starts a transaction to transfer an Owner's access to a memory region and grant
access to it to one or more Borrowers through Rx/Tx buffer.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[out] Handle Globally unique Handle to identify the memory region
upon successful transmission of the transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibLendRxTx (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
OUT UINT64 *Handle
);
/**
Starts a transaction to grant access to a memory region to one or more Borrowers.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[in] BufferAddr Base address of a buffer allocated by the Owner and
distinct from the TX buffer
@param[in] PageCount Number of 4K pages in the buffer allocated by the
Owner and distinct from the TX buffer
@param[out] Handle Globally unique Handle to identify the memory region
upon successful transmission of the transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibShare (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
IN VOID *BufferAddr,
IN UINT32 PageCount,
OUT UINT64 *Handle
);
/**
Starts a transaction to grant access to a memory region to one or more Borrowers
through Rx/Tx buffer.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[out] Handle Globally unique Handle to identify the memory region
upon successful transmission of the transaction descriptor.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibShareRxTx (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
OUT UINT64 *Handle
);
/**
Requests completion of a donate, lend or share memory management transaction.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[in] BufferAddr Base address of a buffer allocated by the Owner
and distinct from the TX buffer
@param[in] PageCount Number of 4K pages in the buffer allocated by
the Owner and distinct from the TX buffer
@param[out] RespTotalLength Total length of the response memory transaction
descriptor in bytes
@param[out] RespFragmentLength Length in bytes of the response memory transaction
descriptor passed in this ABI invocation
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibRetrieveReq (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
IN VOID *BufferAddr,
IN UINT32 PageCount,
OUT UINT32 *RespTotalLength,
OUT UINT32 *RespFragmentLength
);
/**
Requests completion of a donate, lend or share memory management transaction
through Rx/Tx buffer.
@param[in] TotalLength Total length of the memory transaction descriptor
in bytes
@param[in] FragmentLength Length in bytes of the memory transaction descriptor
passed in this ABI invocation
@param[out] RespTotalLength Total length of the response memory transaction
descriptor in bytes
@param[out] RespFragmentLength Length in bytes of the response memory transaction
descriptor passed in this ABI invocation
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibRetrieveReqRxTx (
IN UINT32 TotalLength,
IN UINT32 FragmentLength,
OUT UINT32 *RespTotalLength,
OUT UINT32 *RespFragmentLength
);
/**
Starts a transaction to transfer access to a shared or lent memory region from
a Borrower back to its Owner.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibRelinquish (
VOID
);
/**
Restores exclusive access to a memory region back to its Owner.
@param[in] Handle Globally unique Handle to identify the memory region
@param[in] Flags Flags for modifying the reclaim behavior
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibReclaim (
IN UINT64 Handle,
IN UINT32 Flags
);
/**
Queries the memory attributes of a memory region. This function can only access
the regions of the SP's own translation regine. Moreover this interface is only
available in the boot phase, i.e. before invoking FFA_MSG_WAIT interface.
@param[in] BaseAddr Base VA of a translation granule whose
permission attributes must be returned.
@param[in] PageCount Number of translation granule size pages from the
Base address whose permissions must be returned.
This is calculated as Input Page count + 1.
@param[out] MemoryPerm Permission attributes of the memory region
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibPermGet (
IN CONST VOID *BaseAddr,
IN UINT32 PageCount,
OUT UINT32 *MemoryPerm
);
/**
Sets the memory attributes of a memory regions. This function can only access
the regions of the SP's own translation regine. Moreover this interface is only
available in the boot phase, i.e. before invoking FFA_MSG_WAIT interface.
@param[in] BaseAddr Base VA of a memory region whose permission
attributes must be set.
@param[in] PageCount Number of translation granule size pages
starting from the Base address whose permissions
must be set.
@param[in] MemoryPerm Permission attributes to be set for the memory
region.
@retval The translated FF-A error status code
**/
EFI_STATUS
EFIAPI
ArmFfaMemLibPermSet (
IN CONST VOID *BaseAddr,
IN UINT32 PageCount,
IN UINT32 MemoryPerm
);
|
