Andrew Scull | 1883487 | 2018-10-12 11:48:09 +0100 | [diff] [blame] | 1 | /* |
Andrew Walbran | 692b325 | 2019-03-07 15:51:31 +0000 | [diff] [blame] | 2 | * Copyright 2018 The Hafnium Authors. |
Andrew Scull | 1883487 | 2018-10-12 11:48:09 +0100 | [diff] [blame] | 3 | * |
Andrew Walbran | e959ec1 | 2020-06-17 15:01:09 +0100 | [diff] [blame] | 4 | * 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 Scull | 1883487 | 2018-10-12 11:48:09 +0100 | [diff] [blame] | 7 | */ |
| 8 | |
Andrew Scull | fbc938a | 2018-08-20 14:09:28 +0100 | [diff] [blame] | 9 | #pragma once |
Andrew Scull | f35a5c9 | 2018-08-07 18:09:46 +0100 | [diff] [blame] | 10 | |
Andrew Scull | 6d2db33 | 2018-10-10 15:28:17 +0100 | [diff] [blame] | 11 | #include "hf/abi.h" |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 12 | #include "hf/ffa.h" |
Andrew Scull | 6d2db33 | 2018-10-10 15:28:17 +0100 | [diff] [blame] | 13 | #include "hf/types.h" |
Andrew Scull | f35a5c9 | 2018-08-07 18:09:46 +0100 | [diff] [blame] | 14 | |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 15 | /** |
Fuad Tabba | 77a4b01 | 2019-11-15 12:13:08 +0000 | [diff] [blame] | 16 | * This function must be implemented to trigger the architecture-specific |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 17 | * mechanism to call to the hypervisor. |
Andrew Scull | f35a5c9 | 2018-08-07 18:09:46 +0100 | [diff] [blame] | 18 | */ |
Andrew Walbran | 4e6bcc7 | 2019-09-11 13:57:22 +0100 | [diff] [blame] | 19 | int64_t hf_call(uint64_t arg0, uint64_t arg1, uint64_t arg2, uint64_t arg3); |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 20 | struct ffa_value ffa_call(struct ffa_value args); |
Olivier Deprez | c60cc1f | 2023-07-07 13:18:06 +0200 | [diff] [blame] | 21 | struct ffa_value ffa_call_ext(struct ffa_value args); |
Karl Meakin | 2ad6b66 | 2024-07-29 20:45:40 +0100 | [diff] [blame] | 22 | /* NOLINTNEXTLINE(readability-redundant-declaration) */ |
Maksims Svecovs | e4700b4 | 2022-06-23 16:35:09 +0100 | [diff] [blame] | 23 | void memcpy_s(void *dest, size_t destsz, const void *src, size_t count); |
Andrew Scull | f35a5c9 | 2018-08-07 18:09:46 +0100 | [diff] [blame] | 24 | |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 25 | /** |
Andrew Scull | 55c4d8b | 2018-12-18 18:50:18 +0000 | [diff] [blame] | 26 | * Returns the VM's own ID. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 27 | */ |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 28 | static inline struct ffa_value ffa_id_get(void) |
Andrew Walbran | d230f66 | 2019-10-07 18:03:36 +0100 | [diff] [blame] | 29 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 30 | return ffa_call((struct ffa_value){.func = FFA_ID_GET_32}); |
Andrew Walbran | d230f66 | 2019-10-07 18:03:36 +0100 | [diff] [blame] | 31 | } |
| 32 | |
| 33 | /** |
Olivier Deprez | 421677d | 2021-06-18 12:18:53 +0200 | [diff] [blame] | 34 | * 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 | */ |
| 38 | static 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 Krishnamurthy | 2957b92 | 2022-12-27 10:29:12 -0800 | [diff] [blame] | 44 | * 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 | */ |
| 47 | static 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 Deprez | c60cc1f | 2023-07-07 13:18:06 +0200 | [diff] [blame] | 55 | return ffa_call_ext((struct ffa_value){ |
Raghu Krishnamurthy | 2957b92 | 2022-12-27 10:29:12 -0800 | [diff] [blame] | 56 | .func = FFA_PARTITION_INFO_GET_REGS_64, |
| 57 | .arg1 = arg1, |
| 58 | .arg2 = arg2, |
| 59 | .arg3 = arg3, |
| 60 | }); |
| 61 | } |
| 62 | |
| 63 | /** |
Daniel Boulby | 8373fcf | 2021-12-13 18:00:30 +0000 | [diff] [blame] | 64 | * 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 Tabba | e4efcc3 | 2020-07-16 15:37:27 +0100 | [diff] [blame] | 68 | * |
| 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 Boulby | 8373fcf | 2021-12-13 18:00:30 +0000 | [diff] [blame] | 72 | * 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 Tabba | e4efcc3 | 2020-07-16 15:37:27 +0100 | [diff] [blame] | 78 | * 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 | */ |
| 85 | static inline struct ffa_value ffa_partition_info_get( |
Daniel Boulby | 8373fcf | 2021-12-13 18:00:30 +0000 | [diff] [blame] | 86 | const struct ffa_uuid *uuid, const uint32_t flags) |
Fuad Tabba | e4efcc3 | 2020-07-16 15:37:27 +0100 | [diff] [blame] | 87 | { |
| 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 Boulby | 8373fcf | 2021-12-13 18:00:30 +0000 | [diff] [blame] | 92 | .arg4 = uuid->uuid[3], |
| 93 | .arg5 = flags}); |
Fuad Tabba | e4efcc3 | 2020-07-16 15:37:27 +0100 | [diff] [blame] | 94 | } |
Fuad Tabba | e4efcc3 | 2020-07-16 15:37:27 +0100 | [diff] [blame] | 95 | /** |
Olivier Deprez | 175161a | 2021-11-23 18:41:09 +0100 | [diff] [blame] | 96 | * 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 | */ |
| 100 | static 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 Walbran | d230f66 | 2019-10-07 18:03:36 +0100 | [diff] [blame] | 107 | * Returns the VM's own ID. |
| 108 | */ |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 109 | static inline ffa_id_t hf_vm_get_id(void) |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 110 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 111 | return ffa_id_get().arg2; |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | /** |
Andrew Walbran | 27faff3 | 2019-10-02 18:20:57 +0100 | [diff] [blame] | 115 | * Runs the given vCPU of the given VM. |
| 116 | */ |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 117 | static inline struct ffa_value ffa_run(ffa_id_t vm_id, |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 118 | ffa_vcpu_index_t vcpu_idx) |
Andrew Walbran | 27faff3 | 2019-10-02 18:20:57 +0100 | [diff] [blame] | 119 | { |
Kathleen Capella | 036cc59 | 2023-11-30 18:26:15 -0500 | [diff] [blame] | 120 | return ffa_call_ext((struct ffa_value){.func = FFA_RUN_32, |
| 121 | ffa_vm_vcpu(vm_id, vcpu_idx)}); |
Andrew Walbran | 27faff3 | 2019-10-02 18:20:57 +0100 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | /** |
Madhukar Pappireddy | 9fb96ae | 2023-05-23 17:40:29 -0500 | [diff] [blame] | 125 | * 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 | */ |
| 128 | static 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 Scull | 55c4d8b | 2018-12-18 18:50:18 +0000 | [diff] [blame] | 138 | */ |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 139 | static inline struct ffa_value ffa_yield(void) |
Andrew Scull | 55c4d8b | 2018-12-18 18:50:18 +0000 | [diff] [blame] | 140 | { |
Madhukar Pappireddy | 9fb96ae | 2023-05-23 17:40:29 -0500 | [diff] [blame] | 141 | return ffa_yield_timeout(0, 0); |
Andrew Scull | 55c4d8b | 2018-12-18 18:50:18 +0000 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | /** |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 145 | * Configures the pages to send/receive data through. The pages must not be |
| 146 | * shared. |
Andrew Walbran | 54afb50 | 2018-11-26 16:01:11 +0000 | [diff] [blame] | 147 | * |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 148 | * Returns: |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 149 | * - FFA_ERROR FFA_INVALID_PARAMETERS if the given addresses are not properly |
Andrew Walbran | bfffb0f | 2019-11-05 14:02:34 +0000 | [diff] [blame] | 150 | * aligned or are the same. |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 151 | * - FFA_ERROR FFA_NO_MEMORY if the hypervisor was unable to map the buffers |
Fuad Tabba | 9dc276f | 2020-07-16 09:29:32 +0100 | [diff] [blame] | 152 | * due to insufficient page table memory. |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 153 | * - FFA_ERROR FFA_DENIED if the pages are already mapped or are not owned by |
Andrew Walbran | bfffb0f | 2019-11-05 14:02:34 +0000 | [diff] [blame] | 154 | * the caller. |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 155 | * - 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 Walbran | bfffb0f | 2019-11-05 14:02:34 +0000 | [diff] [blame] | 157 | * needs to wake up or kick waiters. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 158 | */ |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 159 | static inline struct ffa_value ffa_rxtx_map(hf_ipaddr_t send, hf_ipaddr_t recv) |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 160 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 161 | 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 Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | /** |
Daniel Boulby | 9e420ca | 2021-07-07 15:03:49 +0100 | [diff] [blame] | 169 | * 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 | */ |
| 177 | static 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 Scull | aa039b3 | 2018-10-04 15:02:26 +0100 | [diff] [blame] | 184 | * Copies data from the sender's send buffer to the recipient's receive buffer. |
Andrew Walbran | 54afb50 | 2018-11-26 16:01:11 +0000 | [diff] [blame] | 185 | * |
Wedson Almeida Filho | 17c997f | 2019-01-09 18:50:09 +0000 | [diff] [blame] | 186 | * 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 Walbran | 70bc862 | 2019-10-07 14:15:58 +0100 | [diff] [blame] | 189 | * Attributes may include: |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 190 | * - 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 Walbran | 70bc862 | 2019-10-07 14:15:58 +0100 | [diff] [blame] | 192 | * message. |
| 193 | * |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 194 | * Returns FFA_SUCCESS if the message is sent, or an error code otherwise: |
Andrew Walbran | 70bc862 | 2019-10-07 14:15:58 +0100 | [diff] [blame] | 195 | * - INVALID_PARAMETERS: one or more of the parameters do not conform. |
Jose Marinho | a1dfeda | 2019-02-27 16:46:03 +0000 | [diff] [blame] | 196 | * - BUSY: the message could not be delivered either because the mailbox |
Andrew Walbran | 70bc862 | 2019-10-07 14:15:58 +0100 | [diff] [blame] | 197 | * was full or the target VM is not yet set up. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 198 | */ |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 199 | static inline struct ffa_value ffa_msg_send(ffa_id_t sender_vm_id, |
| 200 | ffa_id_t target_vm_id, |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 201 | uint32_t size, uint32_t attributes) |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 202 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 203 | return ffa_call((struct ffa_value){ |
| 204 | .func = FFA_MSG_SEND_32, |
Andrew Walbran | 70bc862 | 2019-10-07 14:15:58 +0100 | [diff] [blame] | 205 | .arg1 = ((uint64_t)sender_vm_id << 16) | target_vm_id, |
| 206 | .arg3 = size, |
| 207 | .arg4 = attributes}); |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 208 | } |
| 209 | |
Federico Recanati | 25053ee | 2022-03-14 15:01:53 +0100 | [diff] [blame] | 210 | /** |
| 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 | */ |
| 222 | static 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 Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 228 | static inline struct ffa_value ffa_mem_donate(uint32_t length, |
Andrew Walbran | a65a132 | 2020-04-06 19:32:32 +0100 | [diff] [blame] | 229 | uint32_t fragment_length) |
Andrew Walbran | e908c4a | 2019-12-02 17:13:47 +0000 | [diff] [blame] | 230 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 231 | return ffa_call((struct ffa_value){.func = FFA_MEM_DONATE_32, |
| 232 | .arg1 = length, |
| 233 | .arg2 = fragment_length}); |
Andrew Walbran | e908c4a | 2019-12-02 17:13:47 +0000 | [diff] [blame] | 234 | } |
| 235 | |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 236 | static inline struct ffa_value ffa_mem_lend(uint32_t length, |
| 237 | uint32_t fragment_length) |
Andrew Walbran | e908c4a | 2019-12-02 17:13:47 +0000 | [diff] [blame] | 238 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 239 | return ffa_call((struct ffa_value){.func = FFA_MEM_LEND_32, |
| 240 | .arg1 = length, |
| 241 | .arg2 = fragment_length}); |
Andrew Walbran | e908c4a | 2019-12-02 17:13:47 +0000 | [diff] [blame] | 242 | } |
| 243 | |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 244 | static inline struct ffa_value ffa_mem_share(uint32_t length, |
| 245 | uint32_t fragment_length) |
Andrew Walbran | 82d6d15 | 2019-12-24 15:02:06 +0000 | [diff] [blame] | 246 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 247 | return ffa_call((struct ffa_value){.func = FFA_MEM_SHARE_32, |
| 248 | .arg1 = length, |
| 249 | .arg2 = fragment_length}); |
Andrew Walbran | 82d6d15 | 2019-12-24 15:02:06 +0000 | [diff] [blame] | 250 | } |
| 251 | |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 252 | static inline struct ffa_value ffa_mem_retrieve_req(uint32_t length, |
| 253 | uint32_t fragment_length) |
Andrew Walbran | 5de9c3d | 2020-02-10 13:35:29 +0000 | [diff] [blame] | 254 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 255 | return ffa_call((struct ffa_value){.func = FFA_MEM_RETRIEVE_REQ_32, |
| 256 | .arg1 = length, |
| 257 | .arg2 = fragment_length}); |
Andrew Walbran | 5de9c3d | 2020-02-10 13:35:29 +0000 | [diff] [blame] | 258 | } |
| 259 | |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 260 | static inline struct ffa_value ffa_mem_relinquish(void) |
Andrew Walbran | 5de9c3d | 2020-02-10 13:35:29 +0000 | [diff] [blame] | 261 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 262 | return ffa_call((struct ffa_value){.func = FFA_MEM_RELINQUISH_32}); |
| 263 | } |
| 264 | |
| 265 | static 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 Walbran | 5de9c3d | 2020-02-10 13:35:29 +0000 | [diff] [blame] | 272 | } |
| 273 | |
Andrew Walbran | ca808b1 | 2020-05-15 17:22:28 +0100 | [diff] [blame] | 274 | static 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 | |
| 284 | static 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 Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 294 | /** |
Andrew Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 295 | * Called by secondary VMs to receive a message. This will block until a message |
| 296 | * is received. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 297 | * |
Andrew Scull | aa039b3 | 2018-10-04 15:02:26 +0100 | [diff] [blame] | 298 | * The mailbox must be cleared before a new message can be received. |
Andrew Walbran | 9311c9a | 2019-03-12 16:59:04 +0000 | [diff] [blame] | 299 | * |
Kathleen Capella | 337dbdf | 2024-08-20 14:39:42 -0400 | [diff] [blame^] | 300 | * 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 Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 304 | * 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 Tabba | b0ef2a4 | 2019-12-19 11:19:25 +0000 | [diff] [blame] | 307 | * pending. This matches the behaviour of the WFI instruction on AArch64, except |
Andrew Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 308 | * that a message becoming available is also treated like a wake-up event. |
Andrew Walbran | c850081 | 2019-06-26 10:36:48 +0100 | [diff] [blame] | 309 | * |
| 310 | * Returns: |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 311 | * - FFA_ERROR FFA_NOT_SUPPORTED if called from the primary VM. |
| 312 | * - FFA_ERROR FFA_INTERRUPTED if an interrupt happened during the call. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 313 | */ |
Kathleen Capella | 337dbdf | 2024-08-20 14:39:42 -0400 | [diff] [blame^] | 314 | static 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 Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 320 | static inline struct ffa_value ffa_msg_wait(void) |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 321 | { |
Kathleen Capella | 337dbdf | 2024-08-20 14:39:42 -0400 | [diff] [blame^] | 322 | return ffa_msg_wait_with_flags(0); |
Andrew Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 323 | } |
| 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 Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 332 | * - 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 Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 336 | */ |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 337 | static inline struct ffa_value ffa_msg_poll(void) |
Andrew Walbran | 0de4f16 | 2019-09-03 16:44:20 +0100 | [diff] [blame] | 338 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 339 | return ffa_call((struct ffa_value){.func = FFA_MSG_POLL_32}); |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 340 | } |
| 341 | |
| 342 | /** |
Andrew Walbran | 8a0f5ca | 2019-11-05 13:12:23 +0000 | [diff] [blame] | 343 | * 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 Walbran | 54afb50 | 2018-11-26 16:01:11 +0000 | [diff] [blame] | 346 | * |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 347 | * Returns: |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 348 | * - 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 Walbran | 8a0f5ca | 2019-11-05 13:12:23 +0000 | [diff] [blame] | 351 | * needs to wake up or kick waiters. Waiters should be retrieved by calling |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 352 | * hf_mailbox_waiter_get. |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 353 | */ |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 354 | static inline struct ffa_value ffa_rx_release(void) |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 355 | { |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 356 | return ffa_call((struct ffa_value){.func = FFA_RX_RELEASE_32}); |
Andrew Scull | 5ac05f0 | 2018-08-10 17:23:22 +0100 | [diff] [blame] | 357 | } |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 358 | |
| 359 | /** |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 360 | * 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 Filho | b790f65 | 2019-01-22 23:41:56 +0000 | [diff] [blame] | 365 | * It should be called repeatedly to retrieve a list of VMs. |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 366 | * |
| 367 | * Returns -1 if no VM became writable, or the id of the VM whose mailbox |
| 368 | * became writable. |
| 369 | */ |
| 370 | static 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 Filho | b790f65 | 2019-01-22 23:41:56 +0000 | [diff] [blame] | 379 | * Returns -1 on failure or if there are no waiters; the VM id of the next |
| 380 | * waiter otherwise. |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 381 | */ |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 382 | static inline int64_t hf_mailbox_waiter_get(ffa_id_t vm_id) |
Wedson Almeida Filho | ea62e2e | 2019-01-09 19:14:59 +0000 | [diff] [blame] | 383 | { |
| 384 | return hf_call(HF_MAILBOX_WAITER_GET, vm_id, 0, 0); |
| 385 | } |
| 386 | |
| 387 | /** |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 388 | * Enables or disables a given interrupt ID. |
| 389 | * |
| 390 | * Returns 0 on success, or -1 if the intid is invalid. |
| 391 | */ |
Manish Pandey | 35e452f | 2021-02-18 21:36:34 +0000 | [diff] [blame] | 392 | static inline int64_t hf_interrupt_enable(uint32_t intid, bool enable, |
Olivier Deprez | c5203fb | 2022-09-29 13:49:24 +0200 | [diff] [blame] | 393 | uint32_t type) |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 394 | { |
Manish Pandey | 35e452f | 2021-02-18 21:36:34 +0000 | [diff] [blame] | 395 | return hf_call(HF_INTERRUPT_ENABLE, intid, enable, type); |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 396 | } |
| 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 Filho | c559d13 | 2019-01-09 19:33:40 +0000 | [diff] [blame] | 403 | static inline uint32_t hf_interrupt_get(void) |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 404 | { |
Wedson Almeida Filho | c559d13 | 2019-01-09 19:33:40 +0000 | [diff] [blame] | 405 | return hf_call(HF_INTERRUPT_GET, 0, 0, 0); |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 406 | } |
| 407 | |
| 408 | /** |
Madhukar Pappireddy | 94cc33f | 2022-12-22 10:06:30 -0600 | [diff] [blame] | 409 | * Deactivate the physical interrupt. |
| 410 | * |
| 411 | * Returns 0 on success, or -1 otherwise. |
| 412 | */ |
| 413 | static inline int64_t hf_interrupt_deactivate(uint32_t intid) |
| 414 | { |
| 415 | return hf_call(HF_INTERRUPT_DEACTIVATE, intid, intid, 0); |
| 416 | } |
| 417 | |
| 418 | /** |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 419 | * 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 Walbran | 3d84a26 | 2018-12-13 14:41:19 +0000 | [diff] [blame] | 423 | * 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 Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 430 | */ |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 431 | static inline int64_t hf_interrupt_inject(ffa_id_t target_vm_id, |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 432 | ffa_vcpu_index_t target_vcpu_idx, |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 433 | uint32_t intid) |
| 434 | { |
Wedson Almeida Filho | c559d13 | 2019-01-09 19:33:40 +0000 | [diff] [blame] | 435 | return hf_call(HF_INTERRUPT_INJECT, target_vm_id, target_vcpu_idx, |
Andrew Walbran | 318f573 | 2018-11-20 16:23:42 +0000 | [diff] [blame] | 436 | intid); |
| 437 | } |
Andrew Scull | 6386f25 | 2018-12-06 13:29:10 +0000 | [diff] [blame] | 438 | |
Madhukar Pappireddy | 89ffc2c | 2023-07-24 16:33:52 -0500 | [diff] [blame] | 439 | /** |
| 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 | */ |
| 445 | static 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 | |
| 451 | static 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 Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 458 | /** Obtains the Hafnium's version of the implemented FF-A specification. */ |
Karl Meakin | 0e617d9 | 2024-04-05 12:55:22 +0100 | [diff] [blame] | 459 | static inline enum ffa_version ffa_version(enum ffa_version requested_version) |
Jose Marinho | fc0b2b6 | 2019-06-06 11:18:45 +0100 | [diff] [blame] | 460 | { |
Karl Meakin | 0e617d9 | 2024-04-05 12:55:22 +0100 | [diff] [blame] | 461 | return ffa_call((struct ffa_value){ |
| 462 | .func = FFA_VERSION_32, |
| 463 | .arg1 = (uint32_t)requested_version, |
| 464 | }) |
Andrew Walbran | 9fd2907 | 2020-04-22 12:12:14 +0100 | [diff] [blame] | 465 | .func; |
Jose Marinho | fc0b2b6 | 2019-06-06 11:18:45 +0100 | [diff] [blame] | 466 | } |
Jose Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 467 | |
| 468 | /** |
| 469 | * Discovery function returning information about the implementation of optional |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 470 | * FF-A interfaces. |
Jose Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 471 | * |
| 472 | * Returns: |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 473 | * - FFA_SUCCESS in .func if the optional interface with function_id is |
Jose Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 474 | * implemented. |
Andrew Walbran | b5ab43c | 2020-04-30 11:32:54 +0100 | [diff] [blame] | 475 | * - FFA_ERROR in .func if the optional interface with function_id is not |
Jose Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 476 | * implemented. |
| 477 | */ |
Karl Meakin | 34b8ae9 | 2023-01-13 13:33:07 +0000 | [diff] [blame] | 478 | static inline struct ffa_value ffa_features(uint64_t function_id) |
Jose Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 479 | { |
Karl Meakin | 34b8ae9 | 2023-01-13 13:33:07 +0000 | [diff] [blame] | 480 | 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 | */ |
| 496 | static 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 Marinho | c0f4ff2 | 2019-10-09 10:37:42 +0100 | [diff] [blame] | 501 | } |
Olivier Deprez | ee9d6a9 | 2019-11-26 09:14:11 +0000 | [diff] [blame] | 502 | |
| 503 | static inline struct ffa_value ffa_msg_send_direct_req( |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 504 | ffa_id_t sender_vm_id, ffa_id_t target_vm_id, uint32_t arg3, |
Olivier Deprez | ee9d6a9 | 2019-11-26 09:14:11 +0000 | [diff] [blame] | 505 | 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 Capella | 734ddc4 | 2023-07-28 11:54:06 -0400 | [diff] [blame] | 518 | static inline struct ffa_value ffa_msg_send_direct_req2( |
| 519 | ffa_id_t sender_vm_id, ffa_id_t target_vm_id, |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 520 | const struct ffa_uuid *uuid, const uint64_t *msg, size_t count) |
Kathleen Capella | 734ddc4 | 2023-07-28 11:54:06 -0400 | [diff] [blame] | 521 | { |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 522 | 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 Capella | 734ddc4 | 2023-07-28 11:54:06 -0400 | [diff] [blame] | 542 | |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 543 | 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 Capella | 0abd887 | 2024-02-02 18:01:12 -0500 | [diff] [blame] | 554 | while (arg_idx < total_args) { |
| 555 | *arg_ptrs[arg_idx++] = 0; |
| 556 | } |
| 557 | |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 558 | return ffa_call_ext(args); |
Kathleen Capella | 734ddc4 | 2023-07-28 11:54:06 -0400 | [diff] [blame] | 559 | } |
| 560 | |
Olivier Deprez | ee9d6a9 | 2019-11-26 09:14:11 +0000 | [diff] [blame] | 561 | static inline struct ffa_value ffa_msg_send_direct_resp( |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 562 | ffa_id_t sender_vm_id, ffa_id_t target_vm_id, uint32_t arg3, |
Olivier Deprez | ee9d6a9 | 2019-11-26 09:14:11 +0000 | [diff] [blame] | 563 | uint32_t arg4, uint32_t arg5, uint32_t arg6, uint32_t arg7) |
| 564 | { |
Kathleen Capella | 3523887 | 2024-01-12 15:05:52 -0500 | [diff] [blame] | 565 | return ffa_call_ext((struct ffa_value){ |
Olivier Deprez | ee9d6a9 | 2019-11-26 09:14:11 +0000 | [diff] [blame] | 566 | .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-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 575 | |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 576 | static 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 Capella | 0abd887 | 2024-02-02 18:01:12 -0500 | [diff] [blame] | 613 | while (arg_idx < total_args) { |
| 614 | *arg_ptrs[arg_idx++] = 0; |
| 615 | } |
| 616 | |
Kathleen Capella | de0b0da | 2023-10-04 13:46:27 -0400 | [diff] [blame] | 617 | return ffa_call_ext(args); |
| 618 | } |
| 619 | |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 620 | static inline struct ffa_value ffa_notification_bind( |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 621 | ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id, uint32_t flags, |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 622 | 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 | |
| 633 | static inline struct ffa_value ffa_notification_unbind( |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 634 | ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id, |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 635 | 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 | |
| 645 | static inline struct ffa_value ffa_notification_set( |
J-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 646 | ffa_id_t sender_vm_id, ffa_id_t receiver_vm_id, uint32_t flags, |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 647 | 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-Alves | 19e20cf | 2023-08-02 12:48:55 +0100 | [diff] [blame] | 658 | static inline struct ffa_value ffa_notification_get(ffa_id_t receiver_vm_id, |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 659 | 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-Alves | be6e303 | 2021-11-30 14:54:12 +0000 | [diff] [blame] | 664 | .arg1 = (vcpu_id << 16) | (receiver_vm_id), |
J-Alves | ef69ac9 | 2021-08-26 09:21:27 +0100 | [diff] [blame] | 665 | .arg2 = flags, |
| 666 | }); |
| 667 | } |
| 668 | |
| 669 | static 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 Krishnamurthy | ea6d25f | 2021-09-14 15:27:06 -0700 | [diff] [blame] | 675 | |
| 676 | static 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 | |
| 682 | static 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 Svecovs | e4700b4 | 2022-06-23 16:35:09 +0100 | [diff] [blame] | 691 | |
| 692 | static 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 Capella | 7928b92 | 2023-02-08 14:14:30 -0500 | [diff] [blame] | 698 | |
| 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 Svecovs | e4700b4 | 2022-06-23 16:35:09 +0100 | [diff] [blame] | 713 | |
| 714 | return ffa_call(req); |
| 715 | } |
| 716 | |
| 717 | static 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 Meakin | 587cd29 | 2024-03-11 15:13:44 +0000 | [diff] [blame] | 723 | 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 Svecovs | e4700b4 | 2022-06-23 16:35:09 +0100 | [diff] [blame] | 727 | |
| 728 | return ffa_call(req); |
| 729 | } |
Karl Meakin | 587cd29 | 2024-03-11 15:13:44 +0000 | [diff] [blame] | 730 | |
| 731 | static 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 | } |