blob: cbabee3487e14beac4f81705e863800085c4b9bb [file] [log] [blame]
Andrew Scull18834872018-10-12 11:48:09 +01001/*
Andrew Walbran692b3252019-03-07 15:51:31 +00002 * Copyright 2018 The Hafnium Authors.
Andrew Scull18834872018-10-12 11:48:09 +01003 *
Andrew Walbrane959ec12020-06-17 15:01:09 +01004 * Use of this source code is governed by a BSD-style
5 * license that can be found in the LICENSE file or at
6 * https://opensource.org/licenses/BSD-3-Clause.
Andrew Scull18834872018-10-12 11:48:09 +01007 */
8
Andrew Scullfbc938a2018-08-20 14:09:28 +01009#pragma once
Andrew Scullf35a5c92018-08-07 18:09:46 +010010
Andrew Scull6d2db332018-10-10 15:28:17 +010011#include "hf/abi.h"
Andrew Walbranb5ab43c2020-04-30 11:32:54 +010012#include "hf/ffa.h"
Andrew Scull6d2db332018-10-10 15:28:17 +010013#include "hf/types.h"
Andrew Scullf35a5c92018-08-07 18:09:46 +010014
Andrew Scull5ac05f02018-08-10 17:23:22 +010015/**
Fuad Tabba77a4b012019-11-15 12:13:08 +000016 * This function must be implemented to trigger the architecture-specific
Andrew Scull5ac05f02018-08-10 17:23:22 +010017 * mechanism to call to the hypervisor.
Andrew Scullf35a5c92018-08-07 18:09:46 +010018 */
Andrew Walbran4e6bcc72019-09-11 13:57:22 +010019int64_t hf_call(uint64_t arg0, uint64_t arg1, uint64_t arg2, uint64_t arg3);
Andrew Walbranb5ab43c2020-04-30 11:32:54 +010020struct ffa_value ffa_call(struct ffa_value args);
Olivier Deprezc60cc1f2023-07-07 13:18:06 +020021struct ffa_value ffa_call_ext(struct ffa_value args);
Karl Meakin2ad6b662024-07-29 20:45:40 +010022/* NOLINTNEXTLINE(readability-redundant-declaration) */
Maksims Svecovse4700b42022-06-23 16:35:09 +010023void memcpy_s(void *dest, size_t destsz, const void *src, size_t count);
Andrew Scullf35a5c92018-08-07 18:09:46 +010024
Andrew Scull5ac05f02018-08-10 17:23:22 +010025/**
Andrew Scull55c4d8b2018-12-18 18:50:18 +000026 * Returns the VM's own ID.
Andrew Scull5ac05f02018-08-10 17:23:22 +010027 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +010028static inline struct ffa_value ffa_id_get(void)
Andrew Walbrand230f662019-10-07 18:03:36 +010029{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +010030 return ffa_call((struct ffa_value){.func = FFA_ID_GET_32});
Andrew Walbrand230f662019-10-07 18:03:36 +010031}
32
33/**
Olivier Deprez421677d2021-06-18 12:18:53 +020034 * Returns the SPMC FF-A ID at NS virtual/physical and secure virtual
35 * FF-A instances.
36 * DEN0077A FF-A v1.1 Beta0 section 13.9 FFA_SPM_ID_GET.
37 */
38static inline struct ffa_value ffa_spm_id_get(void)
39{
40 return ffa_call((struct ffa_value){.func = FFA_SPM_ID_GET_32});
41}
42
43/**
Raghu Krishnamurthy2957b922022-12-27 10:29:12 -080044 * Requests information for partitions instantiated in the system via registers
45 * (as opposed to rx buffer in the case of ffa_partition_info_get).
46 */
47static inline struct ffa_value ffa_partition_info_get_regs(
48 const struct ffa_uuid *uuid, const uint16_t start_index,
49 const uint16_t tag)
50{
51 uint64_t arg1 = (uint64_t)uuid->uuid[1] << 32 | uuid->uuid[0];
52 uint64_t arg2 = (uint64_t)uuid->uuid[3] << 32 | uuid->uuid[2];
53 uint64_t arg3 = start_index | (uint64_t)tag << 16;
54
Olivier Deprezc60cc1f2023-07-07 13:18:06 +020055 return ffa_call_ext((struct ffa_value){
Raghu Krishnamurthy2957b922022-12-27 10:29:12 -080056 .func = FFA_PARTITION_INFO_GET_REGS_64,
57 .arg1 = arg1,
58 .arg2 = arg2,
59 .arg3 = arg3,
60 });
61}
62
63/**
Daniel Boulby8373fcf2021-12-13 18:00:30 +000064 * Requests information for partitions instantiated in the system. If the
65 * FFA_PARTITION_COUNT_FLAG is not set, the information is returned
66 * in the RX buffer of the caller as an array of partition information
67 * descriptors (struct ffa_partition_info).
Fuad Tabbae4efcc32020-07-16 15:37:27 +010068 *
69 * A Null UUID (UUID that is all zeros) returns information for all partitions,
70 * whereas a non-Null UUID returns information only for partitions that match.
71 *
Daniel Boulby8373fcf2021-12-13 18:00:30 +000072 * Flags may include:
73 * - FFA_PARTITION_COUNT_FLAG, which specifes if the partition info descriptors
74 * are returned in RX buffer or just the count in arg2.
75 * 1 returns just the count.
76 * 0 returns the count with the partition info descriptors.
77 *
Fuad Tabbae4efcc32020-07-16 15:37:27 +010078 * Returns:
79 * - FFA_SUCCESS on success. The count of partition information descriptors
80 * populated in the RX buffer is returned in arg2 (register w2).
81 * - FFA_BUSY if the caller's RX buffer is not free.
82 * - FFA_NO_MEMORY if the results do not fit in the callers RX buffer.
83 * - FFA_INVALID_PARAMETERS for an unrecognized UUID.
84 */
85static inline struct ffa_value ffa_partition_info_get(
Daniel Boulby8373fcf2021-12-13 18:00:30 +000086 const struct ffa_uuid *uuid, const uint32_t flags)
Fuad Tabbae4efcc32020-07-16 15:37:27 +010087{
88 return ffa_call((struct ffa_value){.func = FFA_PARTITION_INFO_GET_32,
89 .arg1 = uuid->uuid[0],
90 .arg2 = uuid->uuid[1],
91 .arg3 = uuid->uuid[2],
Daniel Boulby8373fcf2021-12-13 18:00:30 +000092 .arg4 = uuid->uuid[3],
93 .arg5 = flags});
Fuad Tabbae4efcc32020-07-16 15:37:27 +010094}
Fuad Tabbae4efcc32020-07-16 15:37:27 +010095/**
Olivier Deprez175161a2021-11-23 18:41:09 +010096 * DEN0077A FF-A v1.1 Beta0 section 18.3.2.1
97 * Registers vCPU secondary entry point for the caller VM.
98 * Called from secure virtual FF-A instance.
99 */
100static inline struct ffa_value ffa_secondary_ep_register(uintptr_t address)
101{
102 return ffa_call((struct ffa_value){.func = FFA_SECONDARY_EP_REGISTER_64,
103 .arg1 = address});
104}
105
106/**
Andrew Walbrand230f662019-10-07 18:03:36 +0100107 * Returns the VM's own ID.
108 */
J-Alves19e20cf2023-08-02 12:48:55 +0100109static inline ffa_id_t hf_vm_get_id(void)
Andrew Scull5ac05f02018-08-10 17:23:22 +0100110{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100111 return ffa_id_get().arg2;
Andrew Scull5ac05f02018-08-10 17:23:22 +0100112}
113
114/**
Andrew Walbran27faff32019-10-02 18:20:57 +0100115 * Runs the given vCPU of the given VM.
116 */
J-Alves19e20cf2023-08-02 12:48:55 +0100117static inline struct ffa_value ffa_run(ffa_id_t vm_id,
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100118 ffa_vcpu_index_t vcpu_idx)
Andrew Walbran27faff32019-10-02 18:20:57 +0100119{
Kathleen Capella036cc592023-11-30 18:26:15 -0500120 return ffa_call_ext((struct ffa_value){.func = FFA_RUN_32,
121 ffa_vm_vcpu(vm_id, vcpu_idx)});
Andrew Walbran27faff32019-10-02 18:20:57 +0100122}
123
124/**
Madhukar Pappireddy9fb96ae2023-05-23 17:40:29 -0500125 * Hints that the vCPU is willing to yield its current use of the physical CPU
126 * and intends to be resumed at the expiration of the timeout.
127 */
128static inline struct ffa_value ffa_yield_timeout(uint32_t timeout_low,
129 uint32_t timeout_high)
130{
131 return ffa_call((struct ffa_value){.func = FFA_YIELD_32,
132 .arg2 = timeout_low,
133 .arg3 = timeout_high});
134}
135
136/**
137 * Relinquish the current physical CPU cycles back.
Andrew Scull55c4d8b2018-12-18 18:50:18 +0000138 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100139static inline struct ffa_value ffa_yield(void)
Andrew Scull55c4d8b2018-12-18 18:50:18 +0000140{
Madhukar Pappireddy9fb96ae2023-05-23 17:40:29 -0500141 return ffa_yield_timeout(0, 0);
Andrew Scull55c4d8b2018-12-18 18:50:18 +0000142}
143
144/**
Andrew Scull5ac05f02018-08-10 17:23:22 +0100145 * Configures the pages to send/receive data through. The pages must not be
146 * shared.
Andrew Walbran54afb502018-11-26 16:01:11 +0000147 *
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000148 * Returns:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100149 * - FFA_ERROR FFA_INVALID_PARAMETERS if the given addresses are not properly
Andrew Walbranbfffb0f2019-11-05 14:02:34 +0000150 * aligned or are the same.
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100151 * - FFA_ERROR FFA_NO_MEMORY if the hypervisor was unable to map the buffers
Fuad Tabba9dc276f2020-07-16 09:29:32 +0100152 * due to insufficient page table memory.
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100153 * - FFA_ERROR FFA_DENIED if the pages are already mapped or are not owned by
Andrew Walbranbfffb0f2019-11-05 14:02:34 +0000154 * the caller.
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100155 * - FFA_SUCCESS on success if no further action is needed.
156 * - FFA_RX_RELEASE if it was called by the primary VM and the primary VM now
Andrew Walbranbfffb0f2019-11-05 14:02:34 +0000157 * needs to wake up or kick waiters.
Andrew Scull5ac05f02018-08-10 17:23:22 +0100158 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100159static inline struct ffa_value ffa_rxtx_map(hf_ipaddr_t send, hf_ipaddr_t recv)
Andrew Scull5ac05f02018-08-10 17:23:22 +0100160{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100161 return ffa_call(
162 (struct ffa_value){.func = FFA_RXTX_MAP_64,
163 .arg1 = send,
164 .arg2 = recv,
165 .arg3 = HF_MAILBOX_SIZE / FFA_PAGE_SIZE});
Andrew Scull5ac05f02018-08-10 17:23:22 +0100166}
167
168/**
Daniel Boulby9e420ca2021-07-07 15:03:49 +0100169 * Unmaps the RX/TX buffer pair of an endpoint or Hypervisor from the
170 * translation regime of the callee.
171 *
172 * Returns:
173 * - FFA_ERROR FFA_INVALID_PARAMETERS if there is no buffer pair registered on
174 * behalf of the caller.
175 * - FFA_SUCCESS on success if no further action is needed.
176 */
177static inline struct ffa_value ffa_rxtx_unmap(void)
178{
179 /* Note that allocator ID MBZ at virtual instance. */
180 return ffa_call((struct ffa_value){.func = FFA_RXTX_UNMAP_32});
181}
182
183/**
Andrew Scullaa039b32018-10-04 15:02:26 +0100184 * Copies data from the sender's send buffer to the recipient's receive buffer.
Andrew Walbran54afb502018-11-26 16:01:11 +0000185 *
Wedson Almeida Filho17c997f2019-01-09 18:50:09 +0000186 * If the recipient's receive buffer is busy, it can optionally register the
187 * caller to be notified when the recipient's receive buffer becomes available.
188 *
Andrew Walbran70bc8622019-10-07 14:15:58 +0100189 * Attributes may include:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100190 * - FFA_MSG_SEND_NOTIFY, to notify the caller when it should try again.
191 * - FFA_MSG_SEND_LEGACY_MEMORY_*, to send a legacy architected memory sharing
Andrew Walbran70bc8622019-10-07 14:15:58 +0100192 * message.
193 *
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100194 * Returns FFA_SUCCESS if the message is sent, or an error code otherwise:
Andrew Walbran70bc8622019-10-07 14:15:58 +0100195 * - INVALID_PARAMETERS: one or more of the parameters do not conform.
Jose Marinhoa1dfeda2019-02-27 16:46:03 +0000196 * - BUSY: the message could not be delivered either because the mailbox
Andrew Walbran70bc8622019-10-07 14:15:58 +0100197 * was full or the target VM is not yet set up.
Andrew Scull5ac05f02018-08-10 17:23:22 +0100198 */
J-Alves19e20cf2023-08-02 12:48:55 +0100199static inline struct ffa_value ffa_msg_send(ffa_id_t sender_vm_id,
200 ffa_id_t target_vm_id,
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100201 uint32_t size, uint32_t attributes)
Andrew Scull5ac05f02018-08-10 17:23:22 +0100202{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100203 return ffa_call((struct ffa_value){
204 .func = FFA_MSG_SEND_32,
Andrew Walbran70bc8622019-10-07 14:15:58 +0100205 .arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id,
206 .arg3 = size,
207 .arg4 = attributes});
Andrew Scull5ac05f02018-08-10 17:23:22 +0100208}
209
Federico Recanati25053ee2022-03-14 15:01:53 +0100210/**
211 * Copies data from the sender's send buffer to the recipient's receive buffer
212 * and notifies the receiver.
213 *
214 * `flags` may include a 'Delay Schedule Receiver interrupt'.
215 *
216 * Returns FFA_SUCCESS if the message is sent, or an error code otherwise:
217 * - INVALID_PARAMETERS: one or more of the parameters do not conform.
218 * - BUSY: receiver's mailbox was full.
219 * - DENIED: receiver is not in a state to handle the request or doesn't
220 * support indirect messages.
221 */
222static inline struct ffa_value ffa_msg_send2(uint32_t flags)
223{
224 return ffa_call((struct ffa_value){
225 .func = FFA_MSG_SEND2_32, .arg1 = 0, .arg2 = flags});
226}
227
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100228static inline struct ffa_value ffa_mem_donate(uint32_t length,
Andrew Walbrana65a1322020-04-06 19:32:32 +0100229 uint32_t fragment_length)
Andrew Walbrane908c4a2019-12-02 17:13:47 +0000230{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100231 return ffa_call((struct ffa_value){.func = FFA_MEM_DONATE_32,
232 .arg1 = length,
233 .arg2 = fragment_length});
Andrew Walbrane908c4a2019-12-02 17:13:47 +0000234}
235
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100236static inline struct ffa_value ffa_mem_lend(uint32_t length,
237 uint32_t fragment_length)
Andrew Walbrane908c4a2019-12-02 17:13:47 +0000238{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100239 return ffa_call((struct ffa_value){.func = FFA_MEM_LEND_32,
240 .arg1 = length,
241 .arg2 = fragment_length});
Andrew Walbrane908c4a2019-12-02 17:13:47 +0000242}
243
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100244static inline struct ffa_value ffa_mem_share(uint32_t length,
245 uint32_t fragment_length)
Andrew Walbran82d6d152019-12-24 15:02:06 +0000246{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100247 return ffa_call((struct ffa_value){.func = FFA_MEM_SHARE_32,
248 .arg1 = length,
249 .arg2 = fragment_length});
Andrew Walbran82d6d152019-12-24 15:02:06 +0000250}
251
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100252static inline struct ffa_value ffa_mem_retrieve_req(uint32_t length,
253 uint32_t fragment_length)
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000254{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100255 return ffa_call((struct ffa_value){.func = FFA_MEM_RETRIEVE_REQ_32,
256 .arg1 = length,
257 .arg2 = fragment_length});
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000258}
259
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100260static inline struct ffa_value ffa_mem_relinquish(void)
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000261{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100262 return ffa_call((struct ffa_value){.func = FFA_MEM_RELINQUISH_32});
263}
264
265static inline struct ffa_value ffa_mem_reclaim(ffa_memory_handle_t handle,
266 ffa_memory_region_flags_t flags)
267{
268 return ffa_call((struct ffa_value){.func = FFA_MEM_RECLAIM_32,
269 .arg1 = (uint32_t)handle,
270 .arg2 = (uint32_t)(handle >> 32),
271 .arg3 = flags});
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000272}
273
Andrew Walbranca808b12020-05-15 17:22:28 +0100274static inline struct ffa_value ffa_mem_frag_rx(ffa_memory_handle_t handle,
275 uint32_t fragment_offset)
276{
277 /* Note that sender MBZ at virtual instance. */
278 return ffa_call((struct ffa_value){.func = FFA_MEM_FRAG_RX_32,
279 .arg1 = (uint32_t)handle,
280 .arg2 = (uint32_t)(handle >> 32),
281 .arg3 = fragment_offset});
282}
283
284static inline struct ffa_value ffa_mem_frag_tx(ffa_memory_handle_t handle,
285 uint32_t fragment_length)
286{
287 /* Note that sender MBZ at virtual instance. */
288 return ffa_call((struct ffa_value){.func = FFA_MEM_FRAG_TX_32,
289 .arg1 = (uint32_t)handle,
290 .arg2 = (uint32_t)(handle >> 32),
291 .arg3 = fragment_length});
292}
293
Andrew Scull5ac05f02018-08-10 17:23:22 +0100294/**
Andrew Walbran0de4f162019-09-03 16:44:20 +0100295 * Called by secondary VMs to receive a message. This will block until a message
296 * is received.
Andrew Scull5ac05f02018-08-10 17:23:22 +0100297 *
Andrew Scullaa039b32018-10-04 15:02:26 +0100298 * The mailbox must be cleared before a new message can be received.
Andrew Walbran9311c9a2019-03-12 16:59:04 +0000299 *
Kathleen Capella337dbdf2024-08-20 14:39:42 -0400300 * By default, FFA_MSG_WAIT will release the mailbox back to the SPMC. The
301 * FFA_MSG_WAIT_FLAG_RETAIN_RX flag can be used with `ffa_msg_wait_with_flags`
302 * function to override this default and allow the VM to retain the RX buffer.
303 *
Andrew Walbran0de4f162019-09-03 16:44:20 +0100304 * If no message is immediately available and there are no enabled and pending
305 * interrupts (irrespective of whether interrupts are enabled globally), then
306 * this will block until a message is available or an enabled interrupt becomes
Fuad Tabbab0ef2a42019-12-19 11:19:25 +0000307 * pending. This matches the behaviour of the WFI instruction on AArch64, except
Andrew Walbran0de4f162019-09-03 16:44:20 +0100308 * that a message becoming available is also treated like a wake-up event.
Andrew Walbranc8500812019-06-26 10:36:48 +0100309 *
310 * Returns:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100311 * - FFA_ERROR FFA_NOT_SUPPORTED if called from the primary VM.
312 * - FFA_ERROR FFA_INTERRUPTED if an interrupt happened during the call.
Andrew Scull5ac05f02018-08-10 17:23:22 +0100313 */
Kathleen Capella337dbdf2024-08-20 14:39:42 -0400314static inline struct ffa_value ffa_msg_wait_with_flags(uint32_t flags)
315{
316 return ffa_call_ext(
317 (struct ffa_value){.func = FFA_MSG_WAIT_32, .arg2 = flags});
318}
319
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100320static inline struct ffa_value ffa_msg_wait(void)
Andrew Scull5ac05f02018-08-10 17:23:22 +0100321{
Kathleen Capella337dbdf2024-08-20 14:39:42 -0400322 return ffa_msg_wait_with_flags(0);
Andrew Walbran0de4f162019-09-03 16:44:20 +0100323}
324
325/**
326 * Called by secondary VMs to receive a message. The call will return whether or
327 * not a message is available.
328 *
329 * The mailbox must be cleared before a new message can be received.
330 *
331 * Returns:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100332 * - FFA_MSG_SEND if a message is successfully received.
333 * - FFA_ERROR FFA_NOT_SUPPORTED if called from the primary VM.
334 * - FFA_ERROR FFA_INTERRUPTED if an interrupt happened during the call.
335 * - FFA_ERROR FFA_RETRY if there was no pending message.
Andrew Walbran0de4f162019-09-03 16:44:20 +0100336 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100337static inline struct ffa_value ffa_msg_poll(void)
Andrew Walbran0de4f162019-09-03 16:44:20 +0100338{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100339 return ffa_call((struct ffa_value){.func = FFA_MSG_POLL_32});
Andrew Scull5ac05f02018-08-10 17:23:22 +0100340}
341
342/**
Andrew Walbran8a0f5ca2019-11-05 13:12:23 +0000343 * Releases the caller's mailbox so that a new message can be received. The
344 * caller must have copied out all data they wish to preserve as new messages
345 * will overwrite the old and will arrive asynchronously.
Andrew Walbran54afb502018-11-26 16:01:11 +0000346 *
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000347 * Returns:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100348 * - FFA_ERROR FFA_DENIED on failure, if the mailbox hasn't been read.
349 * - FFA_SUCCESS on success if no further action is needed.
350 * - FFA_RX_RELEASE if it was called by the primary VM and the primary VM now
Andrew Walbran8a0f5ca2019-11-05 13:12:23 +0000351 * needs to wake up or kick waiters. Waiters should be retrieved by calling
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000352 * hf_mailbox_waiter_get.
Andrew Scull5ac05f02018-08-10 17:23:22 +0100353 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100354static inline struct ffa_value ffa_rx_release(void)
Andrew Scull5ac05f02018-08-10 17:23:22 +0100355{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100356 return ffa_call((struct ffa_value){.func = FFA_RX_RELEASE_32});
Andrew Scull5ac05f02018-08-10 17:23:22 +0100357}
Andrew Walbran318f5732018-11-20 16:23:42 +0000358
359/**
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000360 * Retrieves the next VM whose mailbox became writable. For a VM to be notified
361 * by this function, the caller must have called api_mailbox_send before with
362 * the notify argument set to true, and this call must have failed because the
363 * mailbox was not available.
364 *
Wedson Almeida Filhob790f652019-01-22 23:41:56 +0000365 * It should be called repeatedly to retrieve a list of VMs.
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000366 *
367 * Returns -1 if no VM became writable, or the id of the VM whose mailbox
368 * became writable.
369 */
370static inline int64_t hf_mailbox_writable_get(void)
371{
372 return hf_call(HF_MAILBOX_WRITABLE_GET, 0, 0, 0);
373}
374
375/**
376 * Retrieves the next VM waiting to be notified that the mailbox of the
377 * specified VM became writable. Only primary VMs are allowed to call this.
378 *
Wedson Almeida Filhob790f652019-01-22 23:41:56 +0000379 * Returns -1 on failure or if there are no waiters; the VM id of the next
380 * waiter otherwise.
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000381 */
J-Alves19e20cf2023-08-02 12:48:55 +0100382static inline int64_t hf_mailbox_waiter_get(ffa_id_t vm_id)
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +0000383{
384 return hf_call(HF_MAILBOX_WAITER_GET, vm_id, 0, 0);
385}
386
387/**
Andrew Walbran318f5732018-11-20 16:23:42 +0000388 * Enables or disables a given interrupt ID.
389 *
390 * Returns 0 on success, or -1 if the intid is invalid.
391 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000392static inline int64_t hf_interrupt_enable(uint32_t intid, bool enable,
Olivier Deprezc5203fb2022-09-29 13:49:24 +0200393 uint32_t type)
Andrew Walbran318f5732018-11-20 16:23:42 +0000394{
Manish Pandey35e452f2021-02-18 21:36:34 +0000395 return hf_call(HF_INTERRUPT_ENABLE, intid, enable, type);
Andrew Walbran318f5732018-11-20 16:23:42 +0000396}
397
398/**
399 * Gets the ID of the pending interrupt (if any) and acknowledge it.
400 *
401 * Returns HF_INVALID_INTID if there are no pending interrupts.
402 */
Wedson Almeida Filhoc559d132019-01-09 19:33:40 +0000403static inline uint32_t hf_interrupt_get(void)
Andrew Walbran318f5732018-11-20 16:23:42 +0000404{
Wedson Almeida Filhoc559d132019-01-09 19:33:40 +0000405 return hf_call(HF_INTERRUPT_GET, 0, 0, 0);
Andrew Walbran318f5732018-11-20 16:23:42 +0000406}
407
408/**
Madhukar Pappireddy94cc33f2022-12-22 10:06:30 -0600409 * Deactivate the physical interrupt.
410 *
411 * Returns 0 on success, or -1 otherwise.
412 */
413static inline int64_t hf_interrupt_deactivate(uint32_t intid)
414{
415 return hf_call(HF_INTERRUPT_DEACTIVATE, intid, intid, 0);
416}
417
418/**
Andrew Walbran318f5732018-11-20 16:23:42 +0000419 * Injects a virtual interrupt of the given ID into the given target vCPU.
420 * This doesn't cause the vCPU to actually be run immediately; it will be taken
421 * when the vCPU is next run, which is up to the scheduler.
422 *
Andrew Walbran3d84a262018-12-13 14:41:19 +0000423 * Returns:
424 * - -1 on failure because the target VM or vCPU doesn't exist, the interrupt
425 * ID is invalid, or the current VM is not allowed to inject interrupts to
426 * the target VM.
427 * - 0 on success if no further action is needed.
428 * - 1 if it was called by the primary VM and the primary VM now needs to wake
429 * up or kick the target vCPU.
Andrew Walbran318f5732018-11-20 16:23:42 +0000430 */
J-Alves19e20cf2023-08-02 12:48:55 +0100431static inline int64_t hf_interrupt_inject(ffa_id_t target_vm_id,
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100432 ffa_vcpu_index_t target_vcpu_idx,
Andrew Walbran318f5732018-11-20 16:23:42 +0000433 uint32_t intid)
434{
Wedson Almeida Filhoc559d132019-01-09 19:33:40 +0000435 return hf_call(HF_INTERRUPT_INJECT, target_vm_id, target_vcpu_idx,
Andrew Walbran318f5732018-11-20 16:23:42 +0000436 intid);
437}
Andrew Scull6386f252018-12-06 13:29:10 +0000438
Madhukar Pappireddy89ffc2c2023-07-24 16:33:52 -0500439/**
440 * Reconfigure the virtual interrupt belonging to the current SP. Note that the
441 * virtual interrupt is identity mapped to the physical interrupt id.
442 *
443 * Returns -1 on failure, or 0 on success.
444 */
445static inline int64_t hf_interrupt_reconfigure(uint32_t intid, uint32_t command,
446 uint32_t value)
447{
448 return hf_call(HF_INTERRUPT_RECONFIGURE, intid, command, value);
449}
450
451static inline int64_t hf_interrupt_reconfigure_target_cpu(
452 uint32_t intid, ffa_vcpu_index_t target_cpu_index)
453{
454 return hf_interrupt_reconfigure(intid, INT_RECONFIGURE_TARGET_PE,
455 (uint32_t)target_cpu_index);
456}
457
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100458/** Obtains the Hafnium's version of the implemented FF-A specification. */
Karl Meakin0e617d92024-04-05 12:55:22 +0100459static inline enum ffa_version ffa_version(enum ffa_version requested_version)
Jose Marinhofc0b2b62019-06-06 11:18:45 +0100460{
Karl Meakin0e617d92024-04-05 12:55:22 +0100461 return ffa_call((struct ffa_value){
462 .func = FFA_VERSION_32,
463 .arg1 = (uint32_t)requested_version,
464 })
Andrew Walbran9fd29072020-04-22 12:12:14 +0100465 .func;
Jose Marinhofc0b2b62019-06-06 11:18:45 +0100466}
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100467
468/**
469 * Discovery function returning information about the implementation of optional
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100470 * FF-A interfaces.
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100471 *
472 * Returns:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100473 * - FFA_SUCCESS in .func if the optional interface with function_id is
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100474 * implemented.
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100475 * - FFA_ERROR in .func if the optional interface with function_id is not
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100476 * implemented.
477 */
Karl Meakin34b8ae92023-01-13 13:33:07 +0000478static inline struct ffa_value ffa_features(uint64_t function_id)
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100479{
Karl Meakin34b8ae92023-01-13 13:33:07 +0000480 return ffa_call((struct ffa_value){
481 .func = FFA_FEATURES_32,
482 .arg1 = function_id,
483 });
484}
485
486/**
487 * Discovery function returning information about the implementation of optional
488 * FF-A interfaces which require an extra input property
489 *
490 * Returns:
491 * - FFA_SUCCESS in .func if the optional interface with function_id is
492 * implemented.
493 * - FFA_ERROR in .func if the optional interface with function_id is not
494 * implemented.
495 */
496static inline struct ffa_value ffa_features_with_input_property(
497 uint64_t function_id, uint64_t param)
498{
499 return ffa_call((struct ffa_value){
500 .func = FFA_FEATURES_32, .arg1 = function_id, .arg2 = param});
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100501}
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000502
503static inline struct ffa_value ffa_msg_send_direct_req(
J-Alves19e20cf2023-08-02 12:48:55 +0100504 ffa_id_t sender_vm_id, ffa_id_t target_vm_id, uint32_t arg3,
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000505 uint32_t arg4, uint32_t arg5, uint32_t arg6, uint32_t arg7)
506{
507 return ffa_call((struct ffa_value){
508 .func = FFA_MSG_SEND_DIRECT_REQ_32,
509 .arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id,
510 .arg3 = arg3,
511 .arg4 = arg4,
512 .arg5 = arg5,
513 .arg6 = arg6,
514 .arg7 = arg7,
515 });
516}
517
Kathleen Capella734ddc42023-07-28 11:54:06 -0400518static inline struct ffa_value ffa_msg_send_direct_req2(
519 ffa_id_t sender_vm_id, ffa_id_t target_vm_id,
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400520 const struct ffa_uuid *uuid, const uint64_t *msg, size_t count)
Kathleen Capella734ddc42023-07-28 11:54:06 -0400521{
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400522 struct ffa_value args;
523 size_t arg_idx = 0;
524 uint64_t total_args;
525 size_t msg_idx = 0;
526 uint64_t *arg_ptrs[] = {
527 &args.arg4,
528 &args.arg5,
529 &args.arg6,
530 &args.arg7,
531 &args.extended_val.arg8,
532 &args.extended_val.arg9,
533 &args.extended_val.arg10,
534 &args.extended_val.arg11,
535 &args.extended_val.arg12,
536 &args.extended_val.arg13,
537 &args.extended_val.arg14,
538 &args.extended_val.arg15,
539 &args.extended_val.arg16,
540 &args.extended_val.arg17,
541 };
Kathleen Capella734ddc42023-07-28 11:54:06 -0400542
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400543 args.func = FFA_MSG_SEND_DIRECT_REQ2_64;
544 args.arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id;
545 args.arg2 = (uint64_t)uuid->uuid[1] << 32 | uuid->uuid[0];
546 args.arg3 = (uint64_t)uuid->uuid[3] << 32 | uuid->uuid[2];
547
548 total_args = (sizeof(arg_ptrs) / sizeof(uint64_t *));
549
550 while (arg_idx < total_args && msg_idx < count) {
551 *arg_ptrs[arg_idx++] = msg[msg_idx++];
552 }
553
Kathleen Capella0abd8872024-02-02 18:01:12 -0500554 while (arg_idx < total_args) {
555 *arg_ptrs[arg_idx++] = 0;
556 }
557
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400558 return ffa_call_ext(args);
Kathleen Capella734ddc42023-07-28 11:54:06 -0400559}
560
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000561static inline struct ffa_value ffa_msg_send_direct_resp(
J-Alves19e20cf2023-08-02 12:48:55 +0100562 ffa_id_t sender_vm_id, ffa_id_t target_vm_id, uint32_t arg3,
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000563 uint32_t arg4, uint32_t arg5, uint32_t arg6, uint32_t arg7)
564{
Kathleen Capella35238872024-01-12 15:05:52 -0500565 return ffa_call_ext((struct ffa_value){
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000566 .func = FFA_MSG_SEND_DIRECT_RESP_32,
567 .arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id,
568 .arg3 = arg3,
569 .arg4 = arg4,
570 .arg5 = arg5,
571 .arg6 = arg6,
572 .arg7 = arg7,
573 });
574}
J-Alvesef69ac92021-08-26 09:21:27 +0100575
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400576static inline struct ffa_value ffa_msg_send_direct_resp2(ffa_id_t sender_vm_id,
577 ffa_id_t target_vm_id,
578 const uint64_t *msg,
579 size_t count)
580{
581 struct ffa_value args;
582 size_t arg_idx = 0;
583 size_t total_args;
584 size_t msg_idx = 0;
585 uint64_t *arg_ptrs[] = {
586 &args.arg4,
587 &args.arg5,
588 &args.arg6,
589 &args.arg7,
590 &args.extended_val.arg8,
591 &args.extended_val.arg9,
592 &args.extended_val.arg10,
593 &args.extended_val.arg11,
594 &args.extended_val.arg12,
595 &args.extended_val.arg13,
596 &args.extended_val.arg14,
597 &args.extended_val.arg15,
598 &args.extended_val.arg16,
599 &args.extended_val.arg17,
600 };
601
602 args.func = FFA_MSG_SEND_DIRECT_RESP2_64;
603 args.arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id;
604 args.arg2 = 0;
605 args.arg3 = 0;
606
607 total_args = sizeof(arg_ptrs) / sizeof(uint64_t *);
608
609 while (arg_idx < total_args && msg_idx < count) {
610 *arg_ptrs[arg_idx++] = msg[msg_idx++];
611 }
612
Kathleen Capella0abd8872024-02-02 18:01:12 -0500613 while (arg_idx < total_args) {
614 *arg_ptrs[arg_idx++] = 0;
615 }
616
Kathleen Capellade0b0da2023-10-04 13:46:27 -0400617 return ffa_call_ext(args);
618}
619
J-Alvesef69ac92021-08-26 09:21:27 +0100620static inline struct ffa_value ffa_notification_bind(
J-Alves19e20cf2023-08-02 12:48:55 +0100621 ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id, uint32_t flags,
J-Alvesef69ac92021-08-26 09:21:27 +0100622 ffa_notifications_bitmap_t bitmap)
623{
624 return ffa_call((struct ffa_value){
625 .func = FFA_NOTIFICATION_BIND_32,
626 .arg1 = (sender_vm_id << 16) | (receiver_vm_id),
627 .arg2 = flags,
628 .arg3 = (uint32_t)(bitmap),
629 .arg4 = (uint32_t)(bitmap >> 32),
630 });
631}
632
633static inline struct ffa_value ffa_notification_unbind(
J-Alves19e20cf2023-08-02 12:48:55 +0100634 ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id,
J-Alvesef69ac92021-08-26 09:21:27 +0100635 ffa_notifications_bitmap_t bitmap)
636{
637 return ffa_call((struct ffa_value){
638 .func = FFA_NOTIFICATION_UNBIND_32,
639 .arg1 = (sender_vm_id << 16) | (receiver_vm_id),
640 .arg3 = (uint32_t)(bitmap),
641 .arg4 = (uint32_t)(bitmap >> 32),
642 });
643}
644
645static inline struct ffa_value ffa_notification_set(
J-Alves19e20cf2023-08-02 12:48:55 +0100646 ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id, uint32_t flags,
J-Alvesef69ac92021-08-26 09:21:27 +0100647 ffa_notifications_bitmap_t bitmap)
648{
649 return ffa_call((struct ffa_value){
650 .func = FFA_NOTIFICATION_SET_32,
651 .arg1 = (sender_vm_id << 16) | (receiver_vm_id),
652 .arg2 = flags,
653 .arg3 = (uint32_t)(bitmap),
654 .arg4 = (uint32_t)(bitmap >> 32),
655 });
656}
657
J-Alves19e20cf2023-08-02 12:48:55 +0100658static inline struct ffa_value ffa_notification_get(ffa_id_t receiver_vm_id,
J-Alvesef69ac92021-08-26 09:21:27 +0100659 ffa_vcpu_index_t vcpu_id,
660 uint32_t flags)
661{
662 return ffa_call((struct ffa_value){
663 .func = FFA_NOTIFICATION_GET_32,
J-Alvesbe6e3032021-11-30 14:54:12 +0000664 .arg1 = (vcpu_id << 16) | (receiver_vm_id),
J-Alvesef69ac92021-08-26 09:21:27 +0100665 .arg2 = flags,
666 });
667}
668
669static inline struct ffa_value ffa_notification_info_get(void)
670{
671 return ffa_call((struct ffa_value){
672 .func = FFA_NOTIFICATION_INFO_GET_64,
673 });
674}
Raghu Krishnamurthyea6d25f2021-09-14 15:27:06 -0700675
676static inline struct ffa_value ffa_mem_perm_get(uint64_t base_va)
677{
678 return ffa_call((struct ffa_value){.func = FFA_MEM_PERM_GET_32,
679 .arg1 = base_va});
680}
681
682static inline struct ffa_value ffa_mem_perm_set(uint64_t base_va,
683 uint32_t page_count,
684 uint32_t mem_perm)
685{
686 return ffa_call((struct ffa_value){.func = FFA_MEM_PERM_SET_32,
687 .arg1 = base_va,
688 .arg2 = page_count,
689 .arg3 = mem_perm});
690}
Maksims Svecovse4700b42022-06-23 16:35:09 +0100691
692static inline struct ffa_value ffa_console_log_32(const char *src, size_t size)
693{
694 struct ffa_value req = {
695 .func = FFA_CONSOLE_LOG_32,
696 .arg1 = size,
697 };
Kathleen Capella7928b922023-02-08 14:14:30 -0500698
699 uint64_t *arg_addrs[] = {&req.arg2, &req.arg3, &req.arg4,
700 &req.arg5, &req.arg6, &req.arg7};
701
702 uint32_t src_index = 0;
703 uint32_t arg_idx = 0;
704
705 while (size > 0 && arg_idx < 6) {
706 size_t arg_size =
707 size < sizeof(uint32_t) ? size : sizeof(uint32_t);
708 memcpy_s(arg_addrs[arg_idx++], sizeof(uint32_t),
709 &src[src_index], arg_size);
710 src_index += arg_size;
711 size -= arg_size;
712 }
Maksims Svecovse4700b42022-06-23 16:35:09 +0100713
714 return ffa_call(req);
715}
716
717static inline struct ffa_value ffa_console_log_64(const char *src, size_t size)
718{
719 struct ffa_value req = {
720 .func = FFA_CONSOLE_LOG_64,
721 .arg1 = size,
722 };
Karl Meakin587cd292024-03-11 15:13:44 +0000723 const size_t destsz = sizeof(uint64_t) * 6;
724 const size_t count = size > destsz ? destsz : size;
725
726 memcpy_s(&req.arg2, destsz, src, count);
Maksims Svecovse4700b42022-06-23 16:35:09 +0100727
728 return ffa_call(req);
729}
Karl Meakin587cd292024-03-11 15:13:44 +0000730
731static inline struct ffa_value ffa_console_log_64_extended(const char *src,
732 size_t size)
733{
734 struct ffa_value req = {
735 .func = FFA_CONSOLE_LOG_64,
736 .arg1 = size,
737 };
738 const size_t destsz = sizeof(uint64_t) * 16;
739 const size_t count = size > destsz ? destsz : size;
740
741 memcpy_s(&req.arg2, destsz, src, count);
742
743 return ffa_call_ext(req);
744}