blob: 5f3812d2956a03d8cc5710ae0aeab5bf09106698 [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 Scullc960c032018-10-24 15:13:35 +01009#include <stdnoreturn.h>
10
Andrew Walbran1f32e722019-06-07 17:57:26 +010011#include "hf/arch/barriers.h"
Madhukar Pappireddy77d3bcd2023-03-01 17:26:22 -060012#include "hf/arch/gicv3.h"
Andrew Scullc960c032018-10-24 15:13:35 +010013#include "hf/arch/init.h"
J-Alvesa2d1c3b2024-03-28 12:46:58 +000014#include "hf/arch/memcpy_trapped.h"
Olivier Deprez98ad2d22020-05-20 09:52:43 +020015#include "hf/arch/mmu.h"
Maksims Svecovs9ddf86a2021-05-06 17:17:21 +010016#include "hf/arch/plat/ffa.h"
Andrew Scull07b6bd32019-12-12 17:19:55 +000017#include "hf/arch/plat/smc.h"
J-Alves03edf402023-07-21 15:13:49 +010018#include "hf/arch/vmid_base.h"
Andrew Scullc960c032018-10-24 15:13:35 +010019
Andrew Scull18c78fc2018-08-20 12:57:41 +010020#include "hf/api.h"
Fuad Tabbac76466d2019-09-06 10:42:12 +010021#include "hf/check.h"
Andrew Scull18c78fc2018-08-20 12:57:41 +010022#include "hf/cpu.h"
23#include "hf/dlog.h"
Andrew Walbranb5ab43c2020-04-30 11:32:54 +010024#include "hf/ffa.h"
J-Alvesb37fd082020-10-22 12:29:21 +010025#include "hf/ffa_internal.h"
Andrew Sculla9c172d2019-04-03 14:10:00 +010026#include "hf/panic.h"
Manish Pandeya5f39fb2020-09-11 09:47:11 +010027#include "hf/plat/interrupts.h"
Andrew Scull18c78fc2018-08-20 12:57:41 +010028#include "hf/vm.h"
29
Andrew Scullf35a5c92018-08-07 18:09:46 +010030#include "vmapi/hf/call.h"
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +010031
Fuad Tabbac76466d2019-09-06 10:42:12 +010032#include "debug_el1.h"
Fuad Tabba77a4b012019-11-15 12:13:08 +000033#include "feature_id.h"
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +010034#include "perfmon.h"
Andrew Scull18c78fc2018-08-20 12:57:41 +010035#include "psci.h"
Andrew Walbran33645652019-04-15 12:29:31 +010036#include "psci_handler.h"
Andrew Scull7fd4bb72018-12-08 23:40:12 +000037#include "smc.h"
Fuad Tabbaba8c44d2019-09-23 14:38:58 +010038#include "sysregs.h"
Karl Meakin5a133552024-05-30 16:06:27 +010039#include "sysregs_defs.h"
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +010040
Fuad Tabbac76466d2019-09-06 10:42:12 +010041/**
Olivier Deprez98ad2d22020-05-20 09:52:43 +020042 * Hypervisor Fault Address Register Non-Secure.
43 */
44#define HPFAR_EL2_NS (UINT64_C(0x1) << 63)
45
46/**
47 * Hypervisor Fault Address Register Faulting IPA.
48 */
49#define HPFAR_EL2_FIPA (UINT64_C(0xFFFFFFFFFF0))
50
51/**
Fuad Tabbac76466d2019-09-06 10:42:12 +010052 * Gets the value to increment for the next PC.
53 * The ESR encodes whether the instruction is 2 bytes or 4 bytes long.
54 */
Fuad Tabba3e9b0222019-11-11 16:47:50 +000055#define GET_NEXT_PC_INC(esr) (GET_ESR_IL(esr) ? 4 : 2)
Fuad Tabbac76466d2019-09-06 10:42:12 +010056
Fuad Tabbac76466d2019-09-06 10:42:12 +010057/**
Andrew Walbran0dd67ff2019-09-12 16:38:50 +010058 * The Client ID field within X7 for an SMC64 call.
59 */
60#define CLIENT_ID_MASK UINT64_C(0xffff)
61
Daniel Boulbyefa381f2022-01-18 14:49:40 +000062/*
63 * Target function IDs for framework messages from the SPMD.
64 */
Olivier Deprezb76307d2022-06-09 17:17:45 +020065#define SPMD_FWK_MSG_BIT (UINT64_C(1) << 31)
Daniel Boulbyefa381f2022-01-18 14:49:40 +000066#define SPMD_FWK_MSG_FUNC_MASK UINT64_C(0xFF)
Olivier Depreza67ab882023-01-10 15:00:54 +010067#define SPMD_FWK_MSG_PSCI_REQ UINT8_C(0x0)
68#define SPMD_FWK_MSG_PSCI_RESP UINT8_C(0x2)
Daniel Boulbyefa381f2022-01-18 14:49:40 +000069#define SPMD_FWK_MSG_FFA_VERSION_REQ UINT8_C(0x8)
70#define SPMD_FWK_MSG_FFA_VERSION_RESP UINT8_C(0x9)
71
Andrew Walbran0dd67ff2019-09-12 16:38:50 +010072/**
Fuad Tabbac76466d2019-09-06 10:42:12 +010073 * Returns a reference to the currently executing vCPU.
74 */
Andrew Scullc960c032018-10-24 15:13:35 +010075static struct vcpu *current(void)
Andrew Walbran3d84a262018-12-13 14:41:19 +000076{
Daniel Boulby3f784262021-09-27 13:02:54 +010077 // NOLINTNEXTLINE(performance-no-int-to-ptr)
Andrew Walbran3d84a262018-12-13 14:41:19 +000078 return (struct vcpu *)read_msr(tpidr_el2);
79}
80
Andrew Walbran1f8d4872018-12-20 11:21:32 +000081/**
82 * Saves the state of per-vCPU peripherals, such as the virtual timer, and
83 * informs the arch-independent sections that registers have been saved.
84 */
85void complete_saving_state(struct vcpu *vcpu)
86{
Raghu Krishnamurthy32626c92021-01-17 09:57:29 -080087 if (has_vhe_support()) {
88 vcpu->regs.peripherals.cntv_cval_el0 =
89 read_msr(MSR_CNTV_CVAL_EL02);
90 vcpu->regs.peripherals.cntv_ctl_el0 =
91 read_msr(MSR_CNTV_CTL_EL02);
92 } else {
93 vcpu->regs.peripherals.cntv_cval_el0 = read_msr(cntv_cval_el0);
94 vcpu->regs.peripherals.cntv_ctl_el0 = read_msr(cntv_ctl_el0);
95 }
Andrew Walbran1f8d4872018-12-20 11:21:32 +000096
97 api_regs_state_saved(vcpu);
98
99 /*
100 * If switching away from the primary, copy the current EL0 virtual
101 * timer registers to the corresponding EL2 physical timer registers.
102 * This is used to emulate the virtual timer for the primary in case it
103 * should fire while the secondary is running.
104 */
Karl Meakin5e996992024-05-20 11:27:07 +0100105 if (vm_is_primary(vcpu->vm)) {
Andrew Walbran1f8d4872018-12-20 11:21:32 +0000106 /*
107 * Clear timer control register before copying compare value, to
108 * avoid a spurious timer interrupt. This could be a problem if
109 * the interrupt is configured as edge-triggered, as it would
110 * then be latched in.
111 */
112 write_msr(cnthp_ctl_el2, 0);
Raghu Krishnamurthy32626c92021-01-17 09:57:29 -0800113
114 if (has_vhe_support()) {
115 write_msr(cnthp_cval_el2, read_msr(MSR_CNTV_CVAL_EL02));
116 write_msr(cnthp_ctl_el2, read_msr(MSR_CNTV_CTL_EL02));
117 } else {
118 write_msr(cnthp_cval_el2, read_msr(cntv_cval_el0));
119 write_msr(cnthp_ctl_el2, read_msr(cntv_ctl_el0));
120 }
Andrew Walbran1f8d4872018-12-20 11:21:32 +0000121 }
122}
123
124/**
125 * Restores the state of per-vCPU peripherals, such as the virtual timer.
126 */
127void begin_restoring_state(struct vcpu *vcpu)
128{
129 /*
130 * Clear timer control register before restoring compare value, to avoid
131 * a spurious timer interrupt. This could be a problem if the interrupt
132 * is configured as edge-triggered, as it would then be latched in.
133 */
Raghu Krishnamurthy32626c92021-01-17 09:57:29 -0800134 if (has_vhe_support()) {
135 write_msr(MSR_CNTV_CTL_EL02, 0);
136 write_msr(MSR_CNTV_CVAL_EL02,
137 vcpu->regs.peripherals.cntv_cval_el0);
138 write_msr(MSR_CNTV_CTL_EL02,
139 vcpu->regs.peripherals.cntv_ctl_el0);
140 } else {
141 write_msr(cntv_ctl_el0, 0);
142 write_msr(cntv_cval_el0, vcpu->regs.peripherals.cntv_cval_el0);
143 write_msr(cntv_ctl_el0, vcpu->regs.peripherals.cntv_ctl_el0);
144 }
Andrew Walbran1f8d4872018-12-20 11:21:32 +0000145
146 /*
147 * If we are switching (back) to the primary, disable the EL2 physical
148 * timer which was being used to emulate the EL0 virtual timer, as the
149 * virtual timer is now running for the primary again.
150 */
Karl Meakin5e996992024-05-20 11:27:07 +0100151 if (vm_is_primary(vcpu->vm)) {
Andrew Walbran1f8d4872018-12-20 11:21:32 +0000152 write_msr(cnthp_ctl_el2, 0);
153 write_msr(cnthp_cval_el2, 0);
154 }
155}
156
Andrew Walbran1f32e722019-06-07 17:57:26 +0100157/**
Andrew Walbran1f32e722019-06-07 17:57:26 +0100158 * Invalidate all stage 1 TLB entries on the current (physical) CPU for the
159 * current VMID.
160 */
161static void invalidate_vm_tlb(void)
162{
Andrew Walbrancff1f682019-07-04 14:52:45 +0100163 /*
164 * Ensure that the last VTTBR write has taken effect so we invalidate
165 * the right set of TLB entries.
166 */
Andrew Walbran1f32e722019-06-07 17:57:26 +0100167 isb();
Andrew Walbrancff1f682019-07-04 14:52:45 +0100168
Olivier Deprez0b0ba8c2023-03-17 11:11:53 +0100169 tlbi(vmalle1);
Andrew Walbrancff1f682019-07-04 14:52:45 +0100170
171 /*
172 * Ensure that no instructions are fetched for the VM until after the
173 * TLB invalidation has taken effect.
174 */
Andrew Walbran1f32e722019-06-07 17:57:26 +0100175 isb();
Andrew Walbrancff1f682019-07-04 14:52:45 +0100176
177 /*
178 * Ensure that no data reads or writes for the VM happen until after the
Fuad Tabba77a4b012019-11-15 12:13:08 +0000179 * TLB invalidation has taken effect. Non-shareable is enough because
180 * the TLB is local to the CPU.
Andrew Walbrancff1f682019-07-04 14:52:45 +0100181 */
David Brazdil851948e2019-08-09 12:02:12 +0100182 dsb(nsh);
Andrew Walbran1f32e722019-06-07 17:57:26 +0100183}
184
185/**
186 * Invalidates the TLB if a different vCPU is being run than the last vCPU of
187 * the same VM which was run on the current pCPU.
188 *
189 * This is necessary because VMs may (contrary to the architecture
190 * specification) use inconsistent ASIDs across vCPUs. c.f. KVM's similar
191 * workaround:
192 * https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=94d0e5980d6791b9
193 */
194void maybe_invalidate_tlb(struct vcpu *vcpu)
195{
196 size_t current_cpu_index = cpu_index(vcpu->cpu);
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100197 ffa_vcpu_index_t new_vcpu_index = vcpu_index(vcpu);
Andrew Walbran1f32e722019-06-07 17:57:26 +0100198
199 if (vcpu->vm->arch.last_vcpu_on_cpu[current_cpu_index] !=
200 new_vcpu_index) {
201 /*
202 * The vCPU has changed since the last time this VM was run on
203 * this pCPU, so we need to invalidate the TLB.
204 */
205 invalidate_vm_tlb();
206
207 /* Record the fact that this vCPU is now running on this CPU. */
208 vcpu->vm->arch.last_vcpu_on_cpu[current_cpu_index] =
209 new_vcpu_index;
210 }
211}
212
David Brazdil768f69c2019-12-19 15:46:12 +0000213noreturn void irq_current_exception_noreturn(uintreg_t elr, uintreg_t spsr)
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +0100214{
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000215 (void)elr;
216 (void)spsr;
217
Fuad Tabbad1d67982020-01-08 11:28:29 +0000218 panic("IRQ from current exception level.");
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +0100219}
220
David Brazdil768f69c2019-12-19 15:46:12 +0000221noreturn void fiq_current_exception_noreturn(uintreg_t elr, uintreg_t spsr)
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +0100222{
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000223 (void)elr;
224 (void)spsr;
225
Fuad Tabbad1d67982020-01-08 11:28:29 +0000226 panic("FIQ from current exception level.");
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000227}
228
David Brazdil768f69c2019-12-19 15:46:12 +0000229noreturn void serr_current_exception_noreturn(uintreg_t elr, uintreg_t spsr)
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000230{
231 (void)elr;
232 (void)spsr;
233
Fuad Tabbad1d67982020-01-08 11:28:29 +0000234 panic("SError from current exception level.");
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000235}
236
J-Alvesa2d1c3b2024-03-28 12:46:58 +0000237/**
238 * Returns true if ELR_EL2 is not to be restored from stack.
239 * Currently function doesn't return false, as for all other cases
240 * panics.
241 */
242bool sync_current_exception(uintreg_t elr, uintreg_t spsr)
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000243{
244 uintreg_t esr = read_msr(esr_el2);
Fuad Tabba3e9b0222019-11-11 16:47:50 +0000245 uintreg_t ec = GET_ESR_EC(esr);
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +0000246 (void)spsr;
247
Fuad Tabbac76466d2019-09-06 10:42:12 +0100248 switch (ec) {
J-Alvesa2d1c3b2024-03-28 12:46:58 +0000249 case EC_DATA_ABORT_SAME_EL: {
250 uint64_t iss = GET_ESR_ISS(esr);
251 uint64_t dfsc = GET_ESR_ISS_DFSC(iss);
252 uint64_t far = read_msr(far_el2);
253
254 /* Handle Granule Protection Fault. */
255 if (is_arch_feat_rme_supported() && dfsc == DFSC_GPF) {
256 dlog_verbose(
Karl Meakine8937d92024-03-19 16:04:25 +0000257 "Granule Protection Fault: esr=%#lx, ec=%#lx, "
258 "far=%#lx, elr=%#lx\n",
J-Alvesa2d1c3b2024-03-28 12:46:58 +0000259 esr, ec, far, elr);
260
261 /*
262 * Change ELR_EL2 only if failed whilst either
263 * reading or writing within 'memcpy_trapped'.
264 */
265 if (elr == (uintptr_t)memcpy_trapped_read ||
266 elr == (uintptr_t)memcpy_trapped_write) {
267 dlog_verbose(
268 "GPF due to data abort on %s.\n",
269 (elr == (uintptr_t)memcpy_trapped_read)
270 ? "read"
271 : "write");
272
273 /*
274 * Update the ELR_EL2 with the return
275 * address, to return error from the
276 * call to 'memcpy_trapped'.
277 */
278 write_msr(ELR_EL2, memcpy_trapped_aborted);
279 return true;
280 }
281 }
282
Kathleen Capellad1c34b52024-04-01 21:27:15 -0400283#if ENABLE_MTE
284 if (dfsc == DFSC_SYNC_TAG_CHECK_FAULT) {
285 dlog_error(
286 "Data abort due to synchronous tag check "
287 "fault: pc=%#lx, esr=%#lx, ec=%#lx, "
288 "far=%#lx, dfsc = %#lx\n",
289 elr, esr, ec, far, dfsc);
290 }
291 break;
292#endif
Karl Meakin5a133552024-05-30 16:06:27 +0100293 if (!GET_ESR_FNV(esr)) {
Andrew Walbran17eebf92020-02-05 16:35:49 +0000294 dlog_error(
Karl Meakine8937d92024-03-19 16:04:25 +0000295 "Data abort: pc=%#lx, esr=%#lx, ec=%#lx, "
296 "far=%#lx\n",
J-Alvesa2d1c3b2024-03-28 12:46:58 +0000297 elr, esr, ec, far);
298
Andrew Scull7364a8e2018-07-19 15:39:29 +0100299 } else {
Andrew Walbran17eebf92020-02-05 16:35:49 +0000300 dlog_error(
Karl Meakine8937d92024-03-19 16:04:25 +0000301 "Data abort: pc=%#lx, esr=%#lx, ec=%#lx, "
Andrew Walbran17eebf92020-02-05 16:35:49 +0000302 "far=invalid\n",
303 elr, esr, ec);
Andrew Scull7364a8e2018-07-19 15:39:29 +0100304 }
J-Alvesa2d1c3b2024-03-28 12:46:58 +0000305 } break;
Wedson Almeida Filhofed69022018-07-11 15:39:12 +0100306 default:
Andrew Walbran17eebf92020-02-05 16:35:49 +0000307 dlog_error(
Karl Meakine8937d92024-03-19 16:04:25 +0000308 "Unknown current sync exception pc=%#lx, esr=%#lx, "
309 "ec=%#lx\n",
Andrew Walbran17eebf92020-02-05 16:35:49 +0000310 elr, esr, ec);
Andrew Scullc960c032018-10-24 15:13:35 +0100311 break;
Wedson Almeida Filhofed69022018-07-11 15:39:12 +0100312 }
Wedson Almeida Filho81568c42019-01-04 13:33:02 +0000313
Andrew Sculla9c172d2019-04-03 14:10:00 +0100314 panic("EL2 exception");
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +0100315}
316
Wedson Almeida Filho03e767a2018-07-30 15:32:03 +0100317/**
Andrew Walbran3d84a262018-12-13 14:41:19 +0000318 * Sets or clears the VI bit in the HCR_EL2 register saved in the given
319 * arch_regs.
320 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000321static void set_virtual_irq(struct arch_regs *r, bool enable)
Andrew Walbran3d84a262018-12-13 14:41:19 +0000322{
323 if (enable) {
Olivier Deprez6d408f92022-08-08 19:14:23 +0200324 r->hyp_state.hcr_el2 |= HCR_EL2_VI;
Andrew Walbran3d84a262018-12-13 14:41:19 +0000325 } else {
Olivier Deprez6d408f92022-08-08 19:14:23 +0200326 r->hyp_state.hcr_el2 &= ~HCR_EL2_VI;
Andrew Walbran3d84a262018-12-13 14:41:19 +0000327 }
328}
329
330/**
331 * Sets or clears the VI bit in the HCR_EL2 register.
332 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000333static void set_virtual_irq_current(bool enable)
Andrew Walbran3d84a262018-12-13 14:41:19 +0000334{
Olivier Deprez6d408f92022-08-08 19:14:23 +0200335 struct vcpu *vcpu = current();
336 uintreg_t hcr_el2 = vcpu->regs.hyp_state.hcr_el2;
Wedson Almeida Filho81568c42019-01-04 13:33:02 +0000337
Andrew Walbran3d84a262018-12-13 14:41:19 +0000338 if (enable) {
339 hcr_el2 |= HCR_EL2_VI;
340 } else {
341 hcr_el2 &= ~HCR_EL2_VI;
342 }
Olivier Deprez6d408f92022-08-08 19:14:23 +0200343 vcpu->regs.hyp_state.hcr_el2 = hcr_el2;
Andrew Walbran3d84a262018-12-13 14:41:19 +0000344}
345
Manish Pandey35e452f2021-02-18 21:36:34 +0000346/**
347 * Sets or clears the VF bit in the HCR_EL2 register saved in the given
348 * arch_regs.
349 */
350static void set_virtual_fiq(struct arch_regs *r, bool enable)
351{
352 if (enable) {
Olivier Deprez6d408f92022-08-08 19:14:23 +0200353 r->hyp_state.hcr_el2 |= HCR_EL2_VF;
Manish Pandey35e452f2021-02-18 21:36:34 +0000354 } else {
Olivier Deprez6d408f92022-08-08 19:14:23 +0200355 r->hyp_state.hcr_el2 &= ~HCR_EL2_VF;
Manish Pandey35e452f2021-02-18 21:36:34 +0000356 }
357}
358
359/**
360 * Sets or clears the VF bit in the HCR_EL2 register.
361 */
362static void set_virtual_fiq_current(bool enable)
363{
Olivier Deprez6d408f92022-08-08 19:14:23 +0200364 struct vcpu *vcpu = current();
365 uintreg_t hcr_el2 = vcpu->regs.hyp_state.hcr_el2;
Manish Pandey35e452f2021-02-18 21:36:34 +0000366
367 if (enable) {
368 hcr_el2 |= HCR_EL2_VF;
369 } else {
370 hcr_el2 &= ~HCR_EL2_VF;
371 }
Olivier Deprez6d408f92022-08-08 19:14:23 +0200372 vcpu->regs.hyp_state.hcr_el2 = hcr_el2;
Manish Pandey35e452f2021-02-18 21:36:34 +0000373}
374
J-Alvesb37fd082020-10-22 12:29:21 +0100375#if SECURE_WORLD == 1
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100376
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100377/**
378 * Handle special direct messages from SPMD to SPMC. For now related to power
379 * management only.
380 */
381static bool spmd_handler(struct ffa_value *args, struct vcpu *current)
382{
J-Alves19e20cf2023-08-02 12:48:55 +0100383 ffa_id_t sender = ffa_sender(*args);
384 ffa_id_t receiver = ffa_receiver(*args);
385 ffa_id_t current_vm_id = current->vm->id;
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000386 uint32_t fwk_msg = ffa_fwk_msg(*args);
387 uint8_t fwk_msg_func_id = fwk_msg & SPMD_FWK_MSG_FUNC_MASK;
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100388
389 /*
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000390 * Check if direct message request is originating from the SPMD,
391 * directed to the SPMC and the message is a framework message.
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100392 */
393 if (!(sender == HF_SPMD_VM_ID && receiver == HF_SPMC_VM_ID &&
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000394 current_vm_id == HF_OTHER_WORLD_ID) ||
395 (fwk_msg & SPMD_FWK_MSG_BIT) == 0) {
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100396 return false;
397 }
398
Olivier Depreza67ab882023-01-10 15:00:54 +0100399 /*
400 * The framework message is conveyed by EL3/SPMD to SPMC so the
401 * current VM id must match to the other world VM id.
402 */
403 CHECK(current->vm->id == HF_HYPERVISOR_VM_ID);
404
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000405 switch (fwk_msg_func_id) {
Olivier Depreza67ab882023-01-10 15:00:54 +0100406 case SPMD_FWK_MSG_PSCI_REQ: {
407 uint32_t psci_msg_response = PSCI_ERROR_NOT_SUPPORTED;
Olivier Deprez181074b2023-02-02 14:53:23 +0100408 struct vcpu *boot_vcpu = vcpu_get_boot_vcpu();
409 struct vm *vm = boot_vcpu->vm;
Olivier Deprez98f151e2023-01-10 15:08:54 +0100410 struct vcpu_locked vcpu_locked;
Olivier Deprez181074b2023-02-02 14:53:23 +0100411
Olivier Depreza67ab882023-01-10 15:00:54 +0100412 /*
413 * TODO: the power management event reached the SPMC.
414 * In a later iteration, the power management event can
415 * be passed to the SP by resuming it.
416 */
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000417 switch (args->arg3) {
418 case PSCI_CPU_OFF: {
Olivier Deprez98f151e2023-01-10 15:08:54 +0100419 if (vm_power_management_cpu_off_requested(vm) == true) {
Daniel Boulby5fe882d2023-08-07 10:36:53 +0100420 struct vcpu *vcpu;
421
Olivier Deprez98f151e2023-01-10 15:08:54 +0100422 /* Allow only S-EL1 MP SPs to reach here. */
423 CHECK(vm->el0_partition == false);
424 CHECK(vm->vcpu_count > 1);
425
426 vcpu = vm_get_vcpu(vm, vcpu_index(current));
427 vcpu_locked = vcpu_lock(vcpu);
428 vcpu->state = VCPU_STATE_OFF;
429 vcpu_unlock(&vcpu_locked);
430 cpu_off(vcpu->cpu);
Daniel Boulby5fe882d2023-08-07 10:36:53 +0100431 dlog_verbose("cpu%u off notification!\n",
432 vcpu_index(vcpu));
Olivier Deprez98f151e2023-01-10 15:08:54 +0100433 }
434
Olivier Depreza67ab882023-01-10 15:00:54 +0100435 psci_msg_response = PSCI_RETURN_SUCCESS;
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000436 break;
437 }
438 default:
Olivier Depreza67ab882023-01-10 15:00:54 +0100439 dlog_error(
440 "FF-A PSCI framework message not handled "
Karl Meakine8937d92024-03-19 16:04:25 +0000441 "%#lx %#lx %#lx %#lx\n",
Olivier Depreza67ab882023-01-10 15:00:54 +0100442 args->func, args->arg1, args->arg2, args->arg3);
443 psci_msg_response = PSCI_ERROR_NOT_SUPPORTED;
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000444 }
Olivier Depreza67ab882023-01-10 15:00:54 +0100445
446 *args = (struct ffa_value){
447 .func = FFA_MSG_SEND_DIRECT_RESP_32,
448 .arg1 = ((uint64_t)HF_SPMC_VM_ID << 16) | HF_SPMD_VM_ID,
449 .arg2 = SPMD_FWK_MSG_BIT | SPMD_FWK_MSG_PSCI_RESP,
450 .arg3 = psci_msg_response};
451
452 return true;
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000453 }
454 case SPMD_FWK_MSG_FFA_VERSION_REQ: {
455 struct ffa_value ret = api_ffa_version(current, args->arg3);
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100456 *args = (struct ffa_value){
457 .func = FFA_MSG_SEND_DIRECT_RESP_32,
458 .arg1 = ((uint64_t)HF_SPMC_VM_ID << 16) | HF_SPMD_VM_ID,
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000459 /* Set bit 31 since this is a framework message. */
460 .arg2 = SPMD_FWK_MSG_BIT |
461 SPMD_FWK_MSG_FFA_VERSION_RESP,
462 .arg3 = ret.func};
Olivier Depreza67ab882023-01-10 15:00:54 +0100463 return true;
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100464 }
465 default:
Karl Meakine8937d92024-03-19 16:04:25 +0000466 dlog_error("FF-A framework message not handled %#lx\n",
Olivier Depreza67ab882023-01-10 15:00:54 +0100467 args->arg2);
468
469 /*
470 * TODO: the framework message that was conveyed by a direct
471 * request is not handled although we still want to complete
472 * by a direct response. However, there is no defined error
473 * response to state that the message couldn't be handled.
474 * An alternative would be to return FFA_ERROR.
475 */
Daniel Boulbyefa381f2022-01-18 14:49:40 +0000476 *args = (struct ffa_value){
477 .func = FFA_MSG_SEND_DIRECT_RESP_32,
478 .arg1 = ((uint64_t)HF_SPMC_VM_ID << 16) | HF_SPMD_VM_ID,
479 /* Set bit 31 since this is a framework message. */
480 .arg2 = SPMD_FWK_MSG_BIT | fwk_msg_func_id};
Olivier Depreza67ab882023-01-10 15:00:54 +0100481
482 return true;
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100483 }
484
Olivier Depreza67ab882023-01-10 15:00:54 +0100485 /* Should not reach this point. */
486 assert(false);
487
488 return false;
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100489}
490
J-Alvesb37fd082020-10-22 12:29:21 +0100491#endif
492
Andrew Scullae9962e2019-10-03 16:51:16 +0100493/**
494 * Checks whether to block an SMC being forwarded from a VM.
495 */
496static bool smc_is_blocked(const struct vm *vm, uint32_t func)
Andrew Walbranc1ad4ce2019-05-09 11:41:39 +0100497{
Andrew Scullae9962e2019-10-03 16:51:16 +0100498 bool block_by_default = !vm->smc_whitelist.permissive;
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100499
Andrew Scullae9962e2019-10-03 16:51:16 +0100500 for (size_t i = 0; i < vm->smc_whitelist.smc_count; ++i) {
501 if (func == vm->smc_whitelist.smcs[i]) {
502 return false;
503 }
504 }
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100505
Olivier Deprezf92e5d42020-11-13 16:00:54 +0100506 dlog_notice("SMC %#010x attempted from VM %#x, blocked=%u\n", func,
Andrew Walbran17eebf92020-02-05 16:35:49 +0000507 vm->id, block_by_default);
Andrew Scullae9962e2019-10-03 16:51:16 +0100508
509 /* Access is still allowed in permissive mode. */
510 return block_by_default;
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100511}
512
513/**
Andrew Scullae9962e2019-10-03 16:51:16 +0100514 * Applies SMC access control according to manifest and forwards the call if
515 * access is granted.
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100516 */
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100517static void smc_forwarder(const struct vm *vm, struct ffa_value *args)
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100518{
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100519 struct ffa_value ret;
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000520 uint32_t client_id = vm->id;
521 uintreg_t arg7 = args->arg7;
Andrew Scullae9962e2019-10-03 16:51:16 +0100522
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000523 if (smc_is_blocked(vm, args->func)) {
524 args->func = SMCCC_ERROR_UNKNOWN;
Andrew Scullae9962e2019-10-03 16:51:16 +0100525 return;
526 }
527
Andrew Walbran0dd67ff2019-09-12 16:38:50 +0100528 /*
529 * Set the Client ID but keep the existing Secure OS ID and anything
530 * else (currently unspecified) that the client may have passed in the
531 * upper bits.
532 */
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000533 args->arg7 = client_id | (arg7 & ~CLIENT_ID_MASK);
Andrew Scull07b6bd32019-12-12 17:19:55 +0000534 ret = smc_forward(args->func, args->arg1, args->arg2, args->arg3,
535 args->arg4, args->arg5, args->arg6, args->arg7);
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100536
Andrew Scullae9962e2019-10-03 16:51:16 +0100537 /*
Fuad Tabbab0ef2a42019-12-19 11:19:25 +0000538 * Preserve the value passed by the caller, rather than the generated
539 * client_id. Note that this would also overwrite any return value that
Andrew Scullae9962e2019-10-03 16:51:16 +0100540 * may be in x7, but the SMCs that we are forwarding are legacy calls
541 * from before SMCCC 1.2 so won't have more than 4 return values anyway.
542 */
Andrew Scull07b6bd32019-12-12 17:19:55 +0000543 ret.arg7 = arg7;
544
545 plat_smc_post_forward(*args, &ret);
546
547 *args = ret;
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100548}
549
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200550/**
551 * In the normal world, ffa_handler is always called from the virtual FF-A
Andrew Walbran8e8bf3f2020-10-07 17:58:20 +0100552 * instance (from a VM in EL1). In the secure world, ffa_handler may be called
553 * from the virtual (a secure partition in S-EL1) or physical FF-A instance
554 * (from the normal world via EL3). The function returns true when the call is
555 * handled. The *next pointer is updated to the next vCPU to run, which might be
556 * the 'other world' vCPU if the call originated from the virtual FF-A instance
557 * and has to be forwarded down to EL3, or left as is to resume the current
558 * vCPU.
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200559 */
560static bool ffa_handler(struct ffa_value *args, struct vcpu *current,
561 struct vcpu **next)
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100562{
J-Alvesbc3de8b2020-12-07 14:32:04 +0000563 uint32_t func = args->func;
Andrew Walbrane7ad3c02019-12-24 17:03:04 +0000564
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100565 /*
566 * NOTE: When adding new methods to this handler update
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100567 * api_ffa_features accordingly.
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100568 */
Andrew Walbrane7ad3c02019-12-24 17:03:04 +0000569 switch (func) {
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100570 case FFA_VERSION_32:
Daniel Boulbybaeaf2e2021-12-09 11:42:36 +0000571 *args = api_ffa_version(current, args->arg1);
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100572 return true;
Fuad Tabbae4efcc32020-07-16 15:37:27 +0100573 case FFA_PARTITION_INFO_GET_32: {
574 struct ffa_uuid uuid;
575
576 ffa_uuid_init(args->arg1, args->arg2, args->arg3, args->arg4,
577 &uuid);
Daniel Boulbyb46cad12021-12-13 17:47:21 +0000578 *args = api_ffa_partition_info_get(current, &uuid, args->arg5);
Fuad Tabbae4efcc32020-07-16 15:37:27 +0100579 return true;
580 }
Raghu Krishnamurthy7592bcb2022-12-25 13:09:00 -0800581 case FFA_PARTITION_INFO_GET_REGS_64: {
582 struct ffa_uuid uuid;
583 uint32_t w0;
584 uint32_t w1;
585 uint32_t w2;
586 uint32_t w3;
587 uint16_t start_index;
588 uint16_t tag;
589
590 w0 = (uint32_t)(args->arg1 & 0xFFFFFFFF);
591 w1 = (uint32_t)(args->arg1 >> 32);
592 w2 = (uint32_t)(args->arg2 & 0xFFFFFFFF);
593 w3 = (uint32_t)(args->arg2 >> 32);
594 ffa_uuid_init(w0, w1, w2, w3, &uuid);
595
Raghu Krishnamurthyd29411a2023-02-17 17:22:04 -0800596 start_index = args->arg3 & 0xFFFF;
597 tag = (args->arg3 >> 16) & 0xFFFF;
Raghu Krishnamurthy7592bcb2022-12-25 13:09:00 -0800598 *args = api_ffa_partition_info_get_regs(current, &uuid,
599 start_index, tag);
600 return true;
601 }
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100602 case FFA_ID_GET_32:
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200603 *args = api_ffa_id_get(current);
Andrew Walbrand230f662019-10-07 18:03:36 +0100604 return true;
Daniel Boulbyb2fb80e2021-02-03 15:09:23 +0000605 case FFA_SPM_ID_GET_32:
606 *args = api_ffa_spm_id_get();
607 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100608 case FFA_FEATURES_32:
Karl Meakinf1ed5f12024-02-22 15:57:36 +0000609 *args = api_ffa_features(args->arg1, args->arg2, current);
Jose Marinhoc0f4ff22019-10-09 10:37:42 +0100610 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100611 case FFA_RX_RELEASE_32:
J-Alvese8c8c2b2022-12-16 15:34:48 +0000612 *args = api_ffa_rx_release(ffa_receiver(*args), current);
Andrew Walbran8a0f5ca2019-11-05 13:12:23 +0000613 return true;
J-Alvesbc3de8b2020-12-07 14:32:04 +0000614 case FFA_RXTX_MAP_64:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100615 *args = api_ffa_rxtx_map(ipa_init(args->arg1),
616 ipa_init(args->arg2), args->arg3,
Federico Recanati9f1b6532022-04-14 13:15:28 +0200617 current);
Andrew Walbranbfffb0f2019-11-05 14:02:34 +0000618 return true;
Daniel Boulby9e420ca2021-07-07 15:03:49 +0100619 case FFA_RXTX_UNMAP_32:
J-Alves70079932022-12-07 17:32:20 +0000620 *args = api_ffa_rxtx_unmap(ffa_vm_id(*args), current);
Daniel Boulby9e420ca2021-07-07 15:03:49 +0100621 return true;
Federico Recanati644f0462022-03-17 12:04:00 +0100622 case FFA_RX_ACQUIRE_32:
623 *args = api_ffa_rx_acquire(ffa_receiver(*args), current);
624 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100625 case FFA_YIELD_32:
Madhukar Pappireddy184501c2023-05-23 17:24:06 -0500626 *args = api_yield(current, next, args);
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100627 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100628 case FFA_MSG_SEND_32:
J-Alves27b71962022-12-12 15:29:58 +0000629 *args = plat_ffa_msg_send(
630 ffa_sender(*args), ffa_receiver(*args),
631 ffa_msg_send_size(*args), current, next);
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100632 return true;
Federico Recanati25053ee2022-03-14 15:01:53 +0100633 case FFA_MSG_SEND2_32:
634 *args = api_ffa_msg_send2(ffa_sender(*args),
635 ffa_msg_send2_flags(*args), current);
636 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100637 case FFA_MSG_WAIT_32:
Madhukar Pappireddy5522c672021-12-17 16:35:51 -0600638 *args = api_ffa_msg_wait(current, next, args);
Andrew Walbran0de4f162019-09-03 16:44:20 +0100639 return true;
J-Alvesbc7ab4f2022-12-13 12:09:25 +0000640#if SECURE_WORLD == 0
Madhukar Pappireddybd10e572023-03-06 16:39:49 -0600641 case FFA_MSG_POLL_32: {
642 struct vcpu_locked current_locked;
643
644 current_locked = vcpu_lock(current);
J-Alves2ced1672022-12-12 14:35:38 +0000645 *args = plat_ffa_msg_recv(false, current_locked, next);
Madhukar Pappireddybd10e572023-03-06 16:39:49 -0600646 vcpu_unlock(&current_locked);
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100647 return true;
Madhukar Pappireddybd10e572023-03-06 16:39:49 -0600648 }
J-Alvesbc7ab4f2022-12-13 12:09:25 +0000649#endif
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100650 case FFA_RUN_32:
Kathleen Capella036cc592023-11-30 18:26:15 -0500651 /**
652 * Ensure that an FF-A v1.2 endpoint preserves the
653 * runtime state of the calling partition by setting
654 * the extended registers (x8-x17) to zero.
655 */
Karl Meakin0e617d92024-04-05 12:55:22 +0100656 if (current->vm->ffa_version >= FFA_VERSION_1_2 &&
Kathleen Capella036cc592023-11-30 18:26:15 -0500657 !api_extended_args_are_zero(args)) {
658 *args = ffa_error(FFA_INVALID_PARAMETERS);
659 return false;
660 }
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100661 *args = api_ffa_run(ffa_vm_id(*args), ffa_vcpu_index(*args),
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200662 current, next);
Andrew Walbranf0c314d2019-10-02 14:24:26 +0100663 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100664 case FFA_MEM_DONATE_32:
J-Alves95fbb312024-03-20 15:19:16 +0000665 case FFA_MEM_DONATE_64:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100666 case FFA_MEM_LEND_32:
J-Alves95fbb312024-03-20 15:19:16 +0000667 case FFA_MEM_LEND_64:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100668 case FFA_MEM_SHARE_32:
J-Alves95fbb312024-03-20 15:19:16 +0000669 case FFA_MEM_SHARE_64:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100670 *args = api_ffa_mem_send(func, args->arg1, args->arg2,
671 ipa_init(args->arg3), args->arg4,
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200672 current);
Andrew Walbran82d6d152019-12-24 15:02:06 +0000673 return true;
J-Alves95fbb312024-03-20 15:19:16 +0000674 case FFA_MEM_RETRIEVE_REQ_64:
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100675 case FFA_MEM_RETRIEVE_REQ_32:
676 *args = api_ffa_mem_retrieve_req(args->arg1, args->arg2,
677 ipa_init(args->arg3),
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200678 args->arg4, current);
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000679 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100680 case FFA_MEM_RELINQUISH_32:
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200681 *args = api_ffa_mem_relinquish(current);
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000682 return true;
Andrew Walbranb5ab43c2020-04-30 11:32:54 +0100683 case FFA_MEM_RECLAIM_32:
684 *args = api_ffa_mem_reclaim(
Andrew Walbran1bbe9402020-04-30 16:47:13 +0100685 ffa_assemble_handle(args->arg1, args->arg2), args->arg3,
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200686 current);
Andrew Walbran5de9c3d2020-02-10 13:35:29 +0000687 return true;
Andrew Walbranca808b12020-05-15 17:22:28 +0100688 case FFA_MEM_FRAG_RX_32:
689 *args = api_ffa_mem_frag_rx(ffa_frag_handle(*args), args->arg3,
690 (args->arg4 >> 16) & 0xffff,
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200691 current);
Andrew Walbranca808b12020-05-15 17:22:28 +0100692 return true;
693 case FFA_MEM_FRAG_TX_32:
694 *args = api_ffa_mem_frag_tx(ffa_frag_handle(*args), args->arg3,
695 (args->arg4 >> 16) & 0xffff,
Olivier Deprezf33a6c72020-06-09 18:28:45 +0200696 current);
Andrew Walbranca808b12020-05-15 17:22:28 +0100697 return true;
J-Alvesbc3de8b2020-12-07 14:32:04 +0000698 case FFA_MSG_SEND_DIRECT_REQ_64:
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100699 case FFA_MSG_SEND_DIRECT_REQ_32: {
700#if SECURE_WORLD == 1
701 if (spmd_handler(args, current)) {
702 return true;
703 }
704#endif
J-Alvesd6f4e142021-03-05 13:33:59 +0000705 *args = api_ffa_msg_send_direct_req(ffa_sender(*args),
706 ffa_receiver(*args), *args,
707 current, next);
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000708 return true;
Max Shvetsov1ae74f12020-09-18 13:52:20 +0100709 }
Kathleen Capella41fea932023-06-23 17:39:28 -0400710 case FFA_MSG_SEND_DIRECT_REQ2_64:
711 *args = api_ffa_msg_send_direct_req(ffa_sender(*args),
712 ffa_receiver(*args), *args,
713 current, next);
714 return true;
J-Alvesbc3de8b2020-12-07 14:32:04 +0000715 case FFA_MSG_SEND_DIRECT_RESP_64:
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000716 case FFA_MSG_SEND_DIRECT_RESP_32:
Kathleen Capella087e5022023-09-07 18:04:15 -0400717 case FFA_MSG_SEND_DIRECT_RESP2_64:
J-Alvesd6f4e142021-03-05 13:33:59 +0000718 *args = api_ffa_msg_send_direct_resp(ffa_sender(*args),
719 ffa_receiver(*args), *args,
720 current, next);
Olivier Deprezee9d6a92019-11-26 09:14:11 +0000721 return true;
J-Alvesbc3de8b2020-12-07 14:32:04 +0000722 case FFA_SECONDARY_EP_REGISTER_64:
Olivier Deprezd614d322021-06-18 15:21:00 +0200723 /*
724 * DEN0077A FF-A v1.1 Beta0 section 18.3.2.1.1
725 * The callee must return NOT_SUPPORTED if this function is
726 * invoked by a caller that implements version v1.0 of
727 * the Framework.
728 */
Max Shvetsov40108e72020-08-27 12:39:50 +0100729 *args = api_ffa_secondary_ep_register(ipa_init(args->arg1),
730 current);
731 return true;
J-Alvesa0f317d2021-06-09 13:31:59 +0100732 case FFA_NOTIFICATION_BITMAP_CREATE_32:
733 *args = api_ffa_notification_bitmap_create(
J-Alves19e20cf2023-08-02 12:48:55 +0100734 (ffa_id_t)args->arg1, (ffa_vcpu_count_t)args->arg2,
J-Alvesa0f317d2021-06-09 13:31:59 +0100735 current);
736 return true;
737 case FFA_NOTIFICATION_BITMAP_DESTROY_32:
738 *args = api_ffa_notification_bitmap_destroy(
J-Alves19e20cf2023-08-02 12:48:55 +0100739 (ffa_id_t)args->arg1, current);
J-Alvesa0f317d2021-06-09 13:31:59 +0100740 return true;
J-Alvesc003a7a2021-03-18 13:06:53 +0000741 case FFA_NOTIFICATION_BIND_32:
742 *args = api_ffa_notification_update_bindings(
743 ffa_sender(*args), ffa_receiver(*args), args->arg2,
744 ffa_notifications_bitmap(args->arg3, args->arg4), true,
745 current);
746 return true;
747 case FFA_NOTIFICATION_UNBIND_32:
748 *args = api_ffa_notification_update_bindings(
749 ffa_sender(*args), ffa_receiver(*args), 0,
750 ffa_notifications_bitmap(args->arg3, args->arg4), false,
751 current);
752 return true;
Raghu Krishnamurthyea6d25f2021-09-14 15:27:06 -0700753 case FFA_MEM_PERM_SET_32:
754 case FFA_MEM_PERM_SET_64:
755 *args = api_ffa_mem_perm_set(va_init(args->arg1), args->arg2,
756 args->arg3, current);
757 return true;
758 case FFA_MEM_PERM_GET_32:
759 case FFA_MEM_PERM_GET_64:
760 *args = api_ffa_mem_perm_get(va_init(args->arg1), current);
761 return true;
J-Alvesaa79c012021-07-09 14:29:45 +0100762 case FFA_NOTIFICATION_SET_32:
763 *args = api_ffa_notification_set(
764 ffa_sender(*args), ffa_receiver(*args), args->arg2,
765 ffa_notifications_bitmap(args->arg3, args->arg4),
766 current);
767 return true;
768 case FFA_NOTIFICATION_GET_32:
769 *args = api_ffa_notification_get(
J-Alvesbe6e3032021-11-30 14:54:12 +0000770 ffa_receiver(*args), ffa_notifications_get_vcpu(*args),
771 args->arg2, current);
J-Alvesaa79c012021-07-09 14:29:45 +0100772 return true;
J-Alvesc8e8a222021-06-08 17:33:52 +0100773 case FFA_NOTIFICATION_INFO_GET_64:
774 *args = api_ffa_notification_info_get(current);
775 return true;
Madhukar Pappireddy9e7a11f2021-08-03 13:59:42 -0500776 case FFA_INTERRUPT_32:
J-Alves03edf402023-07-21 15:13:49 +0100777 /*
778 * A malicious SP could invoke a HVC/SMC call with
779 * FFA_INTERRUPT_32 as the function argument. Return error to
780 * avoid DoS.
781 */
782 if (current->vm->id != HF_OTHER_WORLD_ID) {
783 *args = ffa_error(FFA_DENIED);
784 return true;
785 }
J-Alvescf0c4712023-08-04 14:41:50 +0100786
787 plat_ffa_handle_secure_interrupt(current, next);
788
789 /*
790 * If the next vCPU belongs to an SP, the next time the NWd
791 * gets resumed these values will be overwritten by the ABI
792 * that used to handover execution back to the NWd.
793 * If the NWd is to be resumed from here, then it will
794 * receive the FFA_NORMAL_WORLD_RESUME ABI which is to signal
795 * that an interrupt has occured, thought it wasn't handled.
796 * This happens when the target vCPU was in preempted state,
797 * and the SP couldn't not be resumed to handle the interrupt.
798 */
799 *args = (struct ffa_value){.func = FFA_NORMAL_WORLD_RESUME};
Madhukar Pappireddy9e7a11f2021-08-03 13:59:42 -0500800 return true;
Maksims Svecovs71b76702022-05-20 15:32:58 +0100801 case FFA_CONSOLE_LOG_32:
802 case FFA_CONSOLE_LOG_64:
803 *args = api_ffa_console_log(*args, current);
804 return true;
Kathleen Capella6ab05132023-05-10 12:27:35 -0400805 case FFA_ERROR_32:
806 *args = plat_ffa_error_32(current, next, args->arg2);
807 return true;
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100808
Karl Meakina5ea9092024-05-28 15:40:33 +0100809 default:
810 dlog_verbose("Unsupported function %#x (%s)\n", func,
811 ffa_func_name(func));
812 return false;
813 }
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100814}
815
816/**
Manish Pandey35e452f2021-02-18 21:36:34 +0000817 * Set or clear VI/VF bits according to pending interrupts.
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100818 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000819static void vcpu_update_virtual_interrupts(struct vcpu *next)
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100820{
Manish Pandey35e452f2021-02-18 21:36:34 +0000821 struct vcpu_locked vcpu_locked;
822
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100823 if (next == NULL) {
Raghu Krishnamurthydce438c2021-02-28 15:01:03 -0800824 if (current()->vm->el0_partition) {
825 return;
826 }
827
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100828 /*
829 * Not switching vCPUs, set the bit for the current vCPU
830 * directly in the register.
831 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000832 vcpu_locked = vcpu_lock(current());
833 set_virtual_irq_current(
834 vcpu_interrupt_irq_count_get(vcpu_locked) > 0);
835 set_virtual_fiq_current(
836 vcpu_interrupt_fiq_count_get(vcpu_locked) > 0);
837 vcpu_unlock(&vcpu_locked);
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100838 } else if (vm_id_is_current_world(next->vm->id)) {
Raghu Krishnamurthydce438c2021-02-28 15:01:03 -0800839 if (next->vm->el0_partition) {
840 return;
841 }
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100842 /*
843 * About to switch vCPUs, set the bit for the vCPU to which we
844 * are switching in the saved copy of the register.
845 */
Manish Pandey35e452f2021-02-18 21:36:34 +0000846
847 vcpu_locked = vcpu_lock(next);
848 set_virtual_irq(&next->regs,
849 vcpu_interrupt_irq_count_get(vcpu_locked) > 0);
850 set_virtual_fiq(&next->regs,
851 vcpu_interrupt_fiq_count_get(vcpu_locked) > 0);
852 vcpu_unlock(&vcpu_locked);
Andrew Walbran7d28d9a2019-08-30 16:24:58 +0100853 }
854}
855
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100856/**
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100857 * Handles PSCI and FF-A calls and writes the return value back to the registers
858 * of the vCPU. This is shared between smc_handler and hvc_handler.
859 *
860 * Returns true if the call was handled.
861 */
862static bool hvc_smc_handler(struct ffa_value args, struct vcpu *vcpu,
863 struct vcpu **next)
864{
Karl Meakin6eeec8e2024-03-07 18:07:20 +0000865 const uint32_t func = args.func;
866
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100867 /* Do not expect PSCI calls emitted from within the secure world. */
868#if SECURE_WORLD == 0
Karl Meakin6eeec8e2024-03-07 18:07:20 +0000869 if (psci_handler(vcpu, func, args.arg1, args.arg2, args.arg3,
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100870 &vcpu->regs.r[0], next)) {
871 return true;
872 }
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100873#endif
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100874
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100875 if (ffa_handler(&args, vcpu, next)) {
J-Alves13394022021-06-30 13:48:49 +0100876#if SECURE_WORLD == 1
877 /*
878 * If giving back execution to the NWd, check if the Schedule
Olivier Deprez618c8fc2022-05-30 15:27:49 +0200879 * Receiver Interrupt has been delayed, and trigger it on
880 * current core if so.
J-Alves13394022021-06-30 13:48:49 +0100881 */
882 if ((*next != NULL && (*next)->vm->id == HF_OTHER_WORLD_ID) ||
883 (*next == NULL && vcpu->vm->id == HF_OTHER_WORLD_ID)) {
884 plat_ffa_sri_trigger_if_delayed(vcpu->cpu);
885 }
886#endif
Karl Meakin6eeec8e2024-03-07 18:07:20 +0000887 if (func != FFA_VERSION_32) {
888 struct vm_locked vm_locked = vm_lock(vcpu->vm);
889
890 vm_locked.vm->ffa_version_negotiated = true;
891 vm_unlock(&vm_locked);
892 }
893
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100894 arch_regs_set_retval(&vcpu->regs, args);
Manish Pandey35e452f2021-02-18 21:36:34 +0000895 vcpu_update_virtual_interrupts(*next);
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100896 return true;
897 }
898
899 return false;
900}
901
902/**
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100903 * Processes SMC instruction calls.
904 */
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000905static struct vcpu *smc_handler(struct vcpu *vcpu)
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100906{
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100907 struct ffa_value args = arch_regs_get_args(&vcpu->regs);
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000908 struct vcpu *next = NULL;
Fuad Tabba8176e3e2019-08-01 10:40:36 +0100909
Olivier Deprez79dbd6f2023-11-29 16:12:36 +0100910 /* Mask out SMCCC SVE hint bit from function id. */
911 args.func &= ~SMCCC_SVE_HINT_MASK;
912
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +0100913 if (hvc_smc_handler(args, vcpu, &next)) {
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000914 return next;
Andrew Walbran4579f7002019-08-30 16:24:58 +0100915 }
916
Andrew Walbran9dadaf22019-12-05 16:50:55 +0000917 smc_forwarder(vcpu->vm, &args);
918 arch_regs_set_retval(&vcpu->regs, args);
Andrew Scull07b6bd32019-12-12 17:19:55 +0000919 return NULL;
Andrew Walbranc1ad4ce2019-05-09 11:41:39 +0100920}
921
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100922#if SECURE_WORLD == 1
923
924/**
925 * Called from other_world_loop return from SMC.
926 * Processes SMC calls originating from the NWd.
927 */
928struct vcpu *smc_handler_from_nwd(struct vcpu *vcpu)
929{
Olivier Deprez79dbd6f2023-11-29 16:12:36 +0100930 struct ffa_value args = arch_regs_get_args(&vcpu->regs);
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100931 struct vcpu *next = NULL;
932
Olivier Deprez5b588332023-09-05 15:08:48 +0200933 plat_save_ns_simd_context(vcpu);
934
Olivier Deprez79dbd6f2023-11-29 16:12:36 +0100935 /* Mask out SMCCC SVE hint bit from function id. */
936 args.func &= ~SMCCC_SVE_HINT_MASK;
937
Olivier Deprez3caed1c2021-02-05 12:07:36 +0100938 if (hvc_smc_handler(args, vcpu, &next)) {
939 return next;
940 }
941
942 /*
943 * If the SMC emitted by the normal world is not handled in the secure
944 * world then return an error stating such ABI is not supported. Only
945 * FF-A calls are supported. We cannot return SMCCC_ERROR_UNKNOWN
946 * directly because the SPMD smc handler would not recognize it as a
947 * standard FF-A call returning from the SPMC.
948 */
949 arch_regs_set_retval(&vcpu->regs, ffa_error(FFA_NOT_SUPPORTED));
950
951 return NULL;
952}
953
954#endif
955
Fuad Tabbaa48d1222019-12-09 15:42:32 +0000956/*
957 * Exception vector offsets.
958 * See Arm Architecture Reference Manual Armv8-A, D1.10.2.
959 */
960
961/**
962 * Offset for synchronous exceptions at current EL with SPx.
963 */
964#define OFFSET_CURRENT_SPX UINT64_C(0x200)
965
966/**
967 * Offset for synchronous exceptions at lower EL using AArch64.
968 */
969#define OFFSET_LOWER_EL_64 UINT64_C(0x400)
970
971/**
972 * Offset for synchronous exceptions at lower EL using AArch32.
973 */
974#define OFFSET_LOWER_EL_32 UINT64_C(0x600)
975
976/**
977 * Returns the address for the exception handler at EL1.
978 */
979static uintreg_t get_el1_exception_handler_addr(const struct vcpu *vcpu)
980{
Raghu Krishnamurthy32626c92021-01-17 09:57:29 -0800981 uintreg_t base_addr = has_vhe_support() ? read_msr(MSR_VBAR_EL12)
982 : read_msr(vbar_el1);
Fuad Tabbaa48d1222019-12-09 15:42:32 +0000983 uintreg_t pe_mode = vcpu->regs.spsr & PSR_PE_MODE_MASK;
984 bool is_arch32 = vcpu->regs.spsr & PSR_ARCH_MODE_32;
985
986 if (pe_mode == PSR_PE_MODE_EL0T) {
987 if (is_arch32) {
988 base_addr += OFFSET_LOWER_EL_32;
989 } else {
990 base_addr += OFFSET_LOWER_EL_64;
991 }
992 } else {
993 CHECK(!is_arch32);
994 base_addr += OFFSET_CURRENT_SPX;
995 }
996
997 return base_addr;
998}
999
1000/**
Fuad Tabbab86325a2020-01-10 13:38:15 +00001001 * Injects an exception with the specified Exception Syndrom Register value into
1002 * the EL1.
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001003 *
1004 * NOTE: This function assumes that the lazy registers haven't been saved, and
1005 * writes to the lazy registers of the CPU directly instead of the vCPU.
1006 */
Fuad Tabbac3847c72020-08-11 09:32:25 +01001007static void inject_el1_exception(struct vcpu *vcpu, uintreg_t esr_el1_value,
1008 uintreg_t far_el1_value)
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001009{
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001010 uintreg_t handler_address = get_el1_exception_handler_addr(vcpu);
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001011
1012 /* Update the CPU state to inject the exception. */
Raghu Krishnamurthy32626c92021-01-17 09:57:29 -08001013 if (has_vhe_support()) {
1014 write_msr(MSR_ESR_EL12, esr_el1_value);
1015 write_msr(MSR_FAR_EL12, far_el1_value);
1016 write_msr(MSR_ELR_EL12, vcpu->regs.pc);
1017 write_msr(MSR_SPSR_EL12, vcpu->regs.spsr);
1018 } else {
1019 write_msr(esr_el1, esr_el1_value);
1020 write_msr(far_el1, far_el1_value);
1021 write_msr(elr_el1, vcpu->regs.pc);
1022 write_msr(spsr_el1, vcpu->regs.spsr);
1023 }
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001024
1025 /*
1026 * Mask (disable) interrupts and run in EL1h mode.
1027 * EL1h mode is used because by default, taking an exception selects the
1028 * stack pointer for the target Exception level. The software can change
1029 * that later in the handler if needed.
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001030 */
1031 vcpu->regs.spsr = PSR_D | PSR_A | PSR_I | PSR_F | PSR_PE_MODE_EL1H;
1032
1033 /* Transfer control to the exception hander. */
1034 vcpu->regs.pc = handler_address;
Fuad Tabbab86325a2020-01-10 13:38:15 +00001035}
1036
1037/**
1038 * Injects a Data Abort exception (same exception level).
1039 */
1040static void inject_el1_data_abort_exception(struct vcpu *vcpu,
Fuad Tabbac3847c72020-08-11 09:32:25 +01001041 uintreg_t esr_el2,
1042 uintreg_t far_el2)
Fuad Tabbab86325a2020-01-10 13:38:15 +00001043{
1044 /*
1045 * ISS encoding remains the same, but the EC is changed to reflect
1046 * where the exception came from.
1047 * See Arm Architecture Reference Manual Armv8-A, pages D13-2943/2982.
1048 */
1049 uintreg_t esr_el1_value = GET_ESR_ISS(esr_el2) | GET_ESR_IL(esr_el2) |
1050 (EC_DATA_ABORT_SAME_EL << ESR_EC_OFFSET);
1051
Olivier Deprezf92e5d42020-11-13 16:00:54 +01001052 dlog_notice("Injecting Data Abort exception into VM %#x.\n",
Andrew Walbran17eebf92020-02-05 16:35:49 +00001053 vcpu->vm->id);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001054
Fuad Tabbac3847c72020-08-11 09:32:25 +01001055 inject_el1_exception(vcpu, esr_el1_value, far_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001056}
1057
1058/**
1059 * Injects a Data Abort exception (same exception level).
1060 */
1061static void inject_el1_instruction_abort_exception(struct vcpu *vcpu,
Fuad Tabbac3847c72020-08-11 09:32:25 +01001062 uintreg_t esr_el2,
1063 uintreg_t far_el2)
Fuad Tabbab86325a2020-01-10 13:38:15 +00001064{
1065 /*
1066 * ISS encoding remains the same, but the EC is changed to reflect
1067 * where the exception came from.
1068 * See Arm Architecture Reference Manual Armv8-A, pages D13-2941/2980.
1069 */
1070 uintreg_t esr_el1_value =
1071 GET_ESR_ISS(esr_el2) | GET_ESR_IL(esr_el2) |
1072 (EC_INSTRUCTION_ABORT_SAME_EL << ESR_EC_OFFSET);
1073
Olivier Deprezf92e5d42020-11-13 16:00:54 +01001074 dlog_notice("Injecting Instruction Abort exception into VM %#x.\n",
Andrew Walbran17eebf92020-02-05 16:35:49 +00001075 vcpu->vm->id);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001076
Fuad Tabbac3847c72020-08-11 09:32:25 +01001077 inject_el1_exception(vcpu, esr_el1_value, far_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001078}
1079
1080/**
1081 * Injects an exception with an unknown reason into the EL1.
1082 */
1083static void inject_el1_unknown_exception(struct vcpu *vcpu, uintreg_t esr_el2)
1084{
1085 uintreg_t esr_el1_value =
1086 GET_ESR_IL(esr_el2) | (EC_UNKNOWN << ESR_EC_OFFSET);
Fuad Tabbac3847c72020-08-11 09:32:25 +01001087
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001088 dlog_notice("Injecting Unknown Reason exception into VM %#x.\n",
1089 vcpu->vm->id);
1090
Fuad Tabbac3847c72020-08-11 09:32:25 +01001091 /*
1092 * The value of the far_el2 register is UNKNOWN in this case,
1093 * therefore, don't propagate it to avoid leaking sensitive information.
1094 */
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001095 inject_el1_exception(vcpu, esr_el1_value, 0);
1096}
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001097
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001098/**
1099 * Injects an exception because of a system register trap.
1100 */
1101static void inject_el1_sysreg_trap_exception(struct vcpu *vcpu,
1102 uintreg_t esr_el2)
1103{
1104 char *direction_str = ISS_IS_READ(esr_el2) ? "read" : "write";
1105
Andrew Walbran17eebf92020-02-05 16:35:49 +00001106 dlog_notice(
Karl Meakine8937d92024-03-19 16:04:25 +00001107 "Trapped access to system register %s: op0=%lu, op1=%lu, "
1108 "crn=%lu, "
1109 "crm=%lu, op2=%lu, rt=%lu.\n",
Andrew Walbran17eebf92020-02-05 16:35:49 +00001110 direction_str, GET_ISS_OP0(esr_el2), GET_ISS_OP1(esr_el2),
1111 GET_ISS_CRN(esr_el2), GET_ISS_CRM(esr_el2),
1112 GET_ISS_OP2(esr_el2), GET_ISS_RT(esr_el2));
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001113
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001114 inject_el1_unknown_exception(vcpu, esr_el2);
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001115}
1116
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +01001117static struct vcpu *hvc_handler(struct vcpu *vcpu)
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001118{
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +01001119 struct ffa_value args = arch_regs_get_args(&vcpu->regs);
Andrew Walbran59182d52019-09-23 17:55:39 +01001120 struct vcpu *next = NULL;
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001121
Olivier Deprez79dbd6f2023-11-29 16:12:36 +01001122 /* Mask out SMCCC SVE hint bit from function id. */
1123 args.func &= ~SMCCC_SVE_HINT_MASK;
1124
Andrew Walbrand8d3f5d2020-10-07 18:23:01 +01001125 if (hvc_smc_handler(args, vcpu, &next)) {
Andrew Walbran59182d52019-09-23 17:55:39 +01001126 return next;
Andrew Walbran7d28d9a2019-08-30 16:24:58 +01001127 }
Jose Marinhofc0b2b62019-06-06 11:18:45 +01001128
Andrew Walbran7f920af2019-09-03 17:09:30 +01001129 switch (args.func) {
J-Alvesbc7ab4f2022-12-13 12:09:25 +00001130#if SECURE_WORLD == 0
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +00001131 case HF_MAILBOX_WRITABLE_GET:
J-Alvesbc7ab4f2022-12-13 12:09:25 +00001132 vcpu->regs.r[0] = plat_ffa_mailbox_writable_get(vcpu);
Wedson Almeida Filhoea62e2e2019-01-09 19:14:59 +00001133 break;
1134
1135 case HF_MAILBOX_WAITER_GET:
J-Alvesbc7ab4f2022-12-13 12:09:25 +00001136 vcpu->regs.r[0] = plat_ffa_mailbox_waiter_get(args.arg1, vcpu);
Wedson Almeida Filho2f94ec12018-07-26 16:00:48 +01001137 break;
Andrew Walbran318f5732018-11-20 16:23:42 +00001138
Wedson Almeida Filhoc559d132019-01-09 19:33:40 +00001139 case HF_INTERRUPT_INJECT:
Andrew Walbran7f920af2019-09-03 17:09:30 +01001140 vcpu->regs.r[0] = api_interrupt_inject(args.arg1, args.arg2,
1141 args.arg3, vcpu, &next);
Andrew Walbran318f5732018-11-20 16:23:42 +00001142 break;
Olivier Deprez109c6d42023-11-29 14:58:47 +01001143#else
Madhukar Pappireddyf675bb62021-08-03 12:57:10 -05001144 case HF_INTERRUPT_DEACTIVATE:
1145 vcpu->regs.r[0] = plat_ffa_interrupt_deactivate(
1146 args.arg1, args.arg2, vcpu);
1147 break;
Madhukar Pappireddy72d23932023-07-24 15:57:28 -05001148
1149 case HF_INTERRUPT_RECONFIGURE:
1150 vcpu->regs.r[0] = plat_ffa_interrupt_reconfigure(
1151 args.arg1, args.arg2, args.arg3, vcpu);
1152 break;
Madhukar Pappireddyf675bb62021-08-03 12:57:10 -05001153#endif
Olivier Deprez109c6d42023-11-29 14:58:47 +01001154 case HF_INTERRUPT_ENABLE:
1155 vcpu->regs.r[0] = api_interrupt_enable(args.arg1, args.arg2,
1156 args.arg3, vcpu);
1157 break;
1158
1159 case HF_INTERRUPT_GET:
1160 vcpu->regs.r[0] = api_interrupt_get(vcpu);
1161 break;
Madhukar Pappireddyf675bb62021-08-03 12:57:10 -05001162
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001163 default:
Andrew Walbran59182d52019-09-23 17:55:39 +01001164 vcpu->regs.r[0] = SMCCC_ERROR_UNKNOWN;
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001165 }
1166
Manish Pandey35e452f2021-02-18 21:36:34 +00001167 vcpu_update_virtual_interrupts(next);
Andrew Walbran3d84a262018-12-13 14:41:19 +00001168
Andrew Walbran59182d52019-09-23 17:55:39 +01001169 return next;
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001170}
1171
Wedson Almeida Filho87009642018-07-02 10:20:07 +01001172struct vcpu *irq_lower(void)
1173{
Madhukar Pappireddycbecc962021-08-03 13:11:57 -05001174#if SECURE_WORLD == 1
1175 struct vcpu *next = NULL;
1176
J-Alves03edf402023-07-21 15:13:49 +01001177 plat_ffa_handle_secure_interrupt(current(), &next);
Madhukar Pappireddycbecc962021-08-03 13:11:57 -05001178
1179 /*
1180 * Since we are in interrupt context, set the bit for the
1181 * next vCPU directly in the register.
1182 */
1183 vcpu_update_virtual_interrupts(next);
1184
1185 return next;
1186#else
Andrew Scull9726c252019-01-23 13:44:19 +00001187 /*
1188 * Switch back to primary VM, interrupts will be handled there.
1189 *
1190 * If the VM has aborted, this vCPU will be aborted when the scheduler
1191 * tries to run it again. This means the interrupt will not be delayed
1192 * by the aborted VM.
1193 *
1194 * TODO: Only switch when the interrupt isn't for the current VM.
1195 */
Andrew Scull33fecd32019-01-08 14:48:27 +00001196 return api_preempt(current());
Madhukar Pappireddycbecc962021-08-03 13:11:57 -05001197#endif
Wedson Almeida Filho87009642018-07-02 10:20:07 +01001198}
1199
Madhukar Pappireddy7fc585e2023-03-02 14:31:22 -06001200#if SECURE_WORLD == 1
1201static void spmd_group0_intr_delegate(void)
1202{
1203 struct ffa_value ret;
1204
1205 dlog_verbose("Delegating Group0 interrupt to SPMD\n");
1206
1207 ret = smc_ffa_call((struct ffa_value){.func = FFA_EL3_INTR_HANDLE_32});
1208
1209 /* Check if the Group0 interrupt was handled successfully. */
1210 CHECK(ret.func == FFA_SUCCESS_32);
1211}
1212#endif
1213
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +00001214struct vcpu *fiq_lower(void)
1215{
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001216#if SECURE_WORLD == 1
1217 struct vcpu_locked current_locked;
1218 struct vcpu *current_vcpu = current();
Daniel Boulby4dd3f532021-09-21 09:57:08 +01001219 int64_t ret;
Madhukar Pappireddy77d3bcd2023-03-01 17:26:22 -06001220 uint32_t intid;
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001221
Madhukar Pappireddy77d3bcd2023-03-01 17:26:22 -06001222 intid = get_highest_pending_g0_interrupt_id();
1223
1224 /* Check for the highest priority pending Group0 interrupt. */
1225 if (intid != SPURIOUS_INTID_OTHER_WORLD) {
Madhukar Pappireddy7fc585e2023-03-02 14:31:22 -06001226 /* Delegate handling of Group0 interrupt to EL3 firmware. */
1227 spmd_group0_intr_delegate();
1228
1229 /* Resume current vCPU. */
1230 return NULL;
Madhukar Pappireddy77d3bcd2023-03-01 17:26:22 -06001231 }
1232
1233 /*
1234 * A special interrupt indicating there is no pending interrupt
1235 * with sufficient priority for current security state. This
1236 * means a non-secure interrupt is pending.
1237 */
Madhukar Pappireddyc40f55f2022-06-22 11:00:41 -05001238 assert(current_vcpu->vm->ns_interrupts_action != NS_ACTION_QUEUED);
1239
Maksims Svecovs9ddf86a2021-05-06 17:17:21 +01001240 if (plat_ffa_vm_managed_exit_supported(current_vcpu->vm)) {
Madhukar Pappireddydd6fdfb2021-12-14 12:30:36 -06001241 uint8_t pmr = plat_interrupts_get_priority_mask();
1242
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001243 /* Mask all interrupts */
1244 plat_interrupts_set_priority_mask(0x0);
1245
1246 current_locked = vcpu_lock(current_vcpu);
Madhukar Pappireddydd6fdfb2021-12-14 12:30:36 -06001247 current_vcpu->priority_mask = pmr;
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001248 ret = api_interrupt_inject_locked(current_locked,
1249 HF_MANAGED_EXIT_INTID,
Madhukar Pappireddybd10e572023-03-06 16:39:49 -06001250 current_locked, NULL);
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001251 if (ret != 0) {
1252 panic("Failed to inject managed exit interrupt\n");
1253 }
1254
1255 /* Entering managed exit sequence. */
1256 current_vcpu->processing_managed_exit = true;
1257
1258 vcpu_unlock(&current_locked);
1259
1260 /*
1261 * Since we are in interrupt context, set the bit for the
1262 * current vCPU directly in the register.
1263 */
1264 vcpu_update_virtual_interrupts(NULL);
1265
1266 /* Resume current vCPU. */
1267 return NULL;
1268 }
Manish Pandeya5f39fb2020-09-11 09:47:11 +01001269
Madhukar Pappireddyd46c06e2022-06-21 18:14:52 -05001270 /*
1271 * Unwind Normal World Scheduled Call chain in response to NS
1272 * Interrupt.
1273 */
1274 return plat_ffa_unwind_nwd_call_chain_interrupt(current_vcpu);
Madhukar Pappireddycbecc962021-08-03 13:11:57 -05001275#else
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +00001276 return irq_lower();
Madhukar Pappireddycbecc962021-08-03 13:11:57 -05001277#endif
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +00001278}
1279
Fuad Tabbad1d67982020-01-08 11:28:29 +00001280noreturn struct vcpu *serr_lower(void)
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +00001281{
Fuad Tabbad1d67982020-01-08 11:28:29 +00001282 /*
1283 * SError exceptions should be isolated and handled by the responsible
1284 * VM/exception level. Getting here indicates a bug, that isolation is
1285 * not working, or a processor that does not support ARMv8.2-IESB, in
1286 * which case Hafnium routes SError exceptions to EL2 (here).
1287 */
1288 panic("SError from a lower exception level.");
Wedson Almeida Filho9d5040f2018-10-29 08:41:27 +00001289}
1290
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001291/**
1292 * Initialises a fault info structure. It assumes that an FnV bit exists at
1293 * bit offset 10 of the ESR, and that it is only valid when the bottom 6 bits of
1294 * the ESR (the fault status code) are 010000; this is the case for both
1295 * instruction and data aborts, but not necessarily for other exception reasons.
1296 */
1297static struct vcpu_fault_info fault_info_init(uintreg_t esr,
Andrew Walbran1281ed42019-10-22 17:23:40 +01001298 const struct vcpu *vcpu,
1299 uint32_t mode)
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001300{
1301 uint32_t fsc = esr & 0x3f;
1302 struct vcpu_fault_info r;
Olivier Deprez98ad2d22020-05-20 09:52:43 +02001303 uint64_t hpfar_el2_val;
1304 uint64_t hpfar_el2_fipa;
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001305
1306 r.mode = mode;
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001307 r.pc = va_init(vcpu->regs.pc);
1308
Olivier Deprez98ad2d22020-05-20 09:52:43 +02001309 /* Get Hypervisor IPA Fault Address value. */
1310 hpfar_el2_val = read_msr(hpfar_el2);
1311
1312 /* Extract Faulting IPA. */
1313 hpfar_el2_fipa = (hpfar_el2_val & HPFAR_EL2_FIPA) << 8;
1314
1315#if SECURE_WORLD == 1
1316
1317 /**
1318 * Determine if faulting IPA targets NS space.
1319 * At NS-EL2 hpfar_el2 bit 63 is RES0. At S-EL2, this bit determines if
1320 * the faulting Stage-1 address output is a secure or non-secure IPA.
1321 */
1322 if ((hpfar_el2_val & HPFAR_EL2_NS) != 0) {
1323 r.mode |= MM_MODE_NS;
1324 }
1325
1326#endif
1327
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001328 /*
1329 * Check the FnV bit, which is only valid if dfsc/ifsc is 010000. It
1330 * indicates that we cannot rely on far_el2.
1331 */
Karl Meakin5a133552024-05-30 16:06:27 +01001332 if (fsc == 0x10 && GET_ESR_FNV(esr)) {
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001333 r.vaddr = va_init(0);
Olivier Deprez98ad2d22020-05-20 09:52:43 +02001334 r.ipaddr = ipa_init(hpfar_el2_fipa);
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001335 } else {
1336 r.vaddr = va_init(read_msr(far_el2));
Olivier Deprez98ad2d22020-05-20 09:52:43 +02001337 r.ipaddr = ipa_init(hpfar_el2_fipa |
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001338 (read_msr(far_el2) & (PAGE_SIZE - 1)));
1339 }
1340
1341 return r;
1342}
1343
Fuad Tabbac3847c72020-08-11 09:32:25 +01001344struct vcpu *sync_lower_exception(uintreg_t esr, uintreg_t far)
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001345{
Wedson Almeida Filho00df6c72018-10-18 11:19:24 +01001346 struct vcpu *vcpu = current();
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001347 struct vcpu_fault_info info;
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001348 struct vcpu *new_vcpu = NULL;
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001349 uintreg_t ec = GET_ESR_EC(esr);
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001350 bool is_el0_partition = vcpu->vm->el0_partition;
Raghu Krishnamurthyf16b2ce2021-11-02 07:48:38 -07001351 bool resume = false;
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001352
Fuad Tabbac76466d2019-09-06 10:42:12 +01001353 switch (ec) {
Fuad Tabbab86325a2020-01-10 13:38:15 +00001354 case EC_WFI_WFE:
Andrew Walbran48196eb2019-03-04 14:56:24 +00001355 /* Skip the instruction. */
Fuad Tabbac76466d2019-09-06 10:42:12 +01001356 vcpu->regs.pc += GET_NEXT_PC_INC(esr);
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001357
1358 /*
1359 * For EL0 partitions, treat both WFI and WFE the same way so
1360 * that FFA_RUN can be called on the partition to resume it. If
1361 * we treat WFI using api_wait_for_interrupt, the VCPU will be
1362 * in blocked waiting for interrupt but we cannot inject
1363 * interrupts into EL0 partitions.
1364 */
1365 if (is_el0_partition) {
Madhukar Pappireddy184501c2023-05-23 17:24:06 -05001366 api_yield(vcpu, &new_vcpu, NULL);
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001367 return new_vcpu;
1368 }
1369
Wedson Almeida Filho87009642018-07-02 10:20:07 +01001370 /* Check TI bit of ISS, 0 = WFI, 1 = WFE. */
Andrew Scull7364a8e2018-07-19 15:39:29 +01001371 if (esr & 1) {
Andrew Walbran48196eb2019-03-04 14:56:24 +00001372 /* WFE */
1373 /*
1374 * TODO: consider giving the scheduler more context,
1375 * somehow.
1376 */
Madhukar Pappireddy184501c2023-05-23 17:24:06 -05001377 api_yield(vcpu, &new_vcpu, NULL);
Jose Marinho135dff32019-02-28 10:25:57 +00001378 return new_vcpu;
Andrew Scull7364a8e2018-07-19 15:39:29 +01001379 }
Andrew Walbran48196eb2019-03-04 14:56:24 +00001380 /* WFI */
Andrew Scull9726c252019-01-23 13:44:19 +00001381 return api_wait_for_interrupt(vcpu);
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001382
Fuad Tabbab86325a2020-01-10 13:38:15 +00001383 case EC_DATA_ABORT_LOWER_EL:
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001384 info = fault_info_init(
Andrew Walbrane52006c2019-10-22 18:01:28 +01001385 esr, vcpu, (esr & (1U << 6)) ? MM_MODE_W : MM_MODE_R);
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001386
Raghu Krishnamurthyf16b2ce2021-11-02 07:48:38 -07001387 resume = vcpu_handle_page_fault(vcpu, &info);
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001388 if (is_el0_partition) {
1389 dlog_warning("Data abort on EL0 partition\n");
Raghu Krishnamurthyf16b2ce2021-11-02 07:48:38 -07001390 /*
1391 * Abort EL0 context if we should not resume the
1392 * context, or it is an alignment fault.
1393 * vcpu_handle_page_fault() only checks the mode of the
1394 * page in an architecture agnostic way but alignment
1395 * faults on aarch64 can happen on a correctly mapped
1396 * page.
1397 */
1398 if (!resume || ((esr & 0x3f) == 0x21)) {
1399 return api_abort(vcpu);
1400 }
1401 }
1402
1403 if (resume) {
1404 return NULL;
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001405 }
1406
Fuad Tabbab86325a2020-01-10 13:38:15 +00001407 /* Inform the EL1 of the data abort. */
Fuad Tabbac3847c72020-08-11 09:32:25 +01001408 inject_el1_data_abort_exception(vcpu, esr, far);
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001409
Fuad Tabbab86325a2020-01-10 13:38:15 +00001410 /* Schedule the same VM to continue running. */
1411 return NULL;
1412
1413 case EC_INSTRUCTION_ABORT_LOWER_EL:
Andrew Sculld3cfaad2019-04-04 11:34:10 +01001414 info = fault_info_init(esr, vcpu, MM_MODE_X);
Raghu Krishnamurthyf16b2ce2021-11-02 07:48:38 -07001415
Wedson Almeida Filho99d2d4c2019-02-14 12:53:46 +00001416 if (vcpu_handle_page_fault(vcpu, &info)) {
1417 return NULL;
1418 }
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001419
1420 if (is_el0_partition) {
1421 dlog_warning("Instruction abort on EL0 partition\n");
1422 return api_abort(vcpu);
1423 }
1424
Fuad Tabbab86325a2020-01-10 13:38:15 +00001425 /* Inform the EL1 of the instruction abort. */
Fuad Tabbac3847c72020-08-11 09:32:25 +01001426 inject_el1_instruction_abort_exception(vcpu, esr, far);
Wedson Almeida Filho2f94ec12018-07-26 16:00:48 +01001427
Fuad Tabbab86325a2020-01-10 13:38:15 +00001428 /* Schedule the same VM to continue running. */
1429 return NULL;
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001430 case EC_SVC:
1431 CHECK(is_el0_partition);
1432 return hvc_handler(vcpu);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001433 case EC_HVC:
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001434 if (is_el0_partition) {
1435 dlog_warning("Unexpected HVC Trap on EL0 partition\n");
1436 return api_abort(vcpu);
1437 }
Andrew Walbran59182d52019-09-23 17:55:39 +01001438 return hvc_handler(vcpu);
1439
Fuad Tabbab86325a2020-01-10 13:38:15 +00001440 case EC_SMC: {
Andrew Scullc960c032018-10-24 15:13:35 +01001441 uintreg_t smc_pc = vcpu->regs.pc;
Andrew Walbran9dadaf22019-12-05 16:50:55 +00001442 struct vcpu *next = smc_handler(vcpu);
Wedson Almeida Filho03e767a2018-07-30 15:32:03 +01001443
1444 /* Skip the SMC instruction. */
Fuad Tabbac76466d2019-09-06 10:42:12 +01001445 vcpu->regs.pc = smc_pc + GET_NEXT_PC_INC(esr);
Andrew Walbran9dadaf22019-12-05 16:50:55 +00001446
Andrew Walbran33645652019-04-15 12:29:31 +01001447 return next;
Andrew Scullc960c032018-10-24 15:13:35 +01001448 }
Wedson Almeida Filho03e767a2018-07-30 15:32:03 +01001449
Fuad Tabbab86325a2020-01-10 13:38:15 +00001450 case EC_MSR:
Fuad Tabbac76466d2019-09-06 10:42:12 +01001451 /*
1452 * NOTE: This should never be reached because it goes through a
1453 * separate path handled by handle_system_register_access().
1454 */
1455 panic("Handled by handle_system_register_access().");
1456
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001457 default:
Andrew Walbran17eebf92020-02-05 16:35:49 +00001458 dlog_notice(
Karl Meakine8937d92024-03-19 16:04:25 +00001459 "Unknown lower sync exception pc=%#lx, esr=%#lx, "
1460 "ec=%#lx\n",
Andrew Walbran17eebf92020-02-05 16:35:49 +00001461 vcpu->regs.pc, esr, ec);
Andrew Scull9726c252019-01-23 13:44:19 +00001462 break;
Wedson Almeida Filho987c0ff2018-06-20 16:34:38 +01001463 }
1464
Raghu Krishnamurthyb5775d22021-02-26 18:54:40 -08001465 if (is_el0_partition) {
1466 return api_abort(vcpu);
1467 }
1468
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001469 /*
Fuad Tabbaa48d1222019-12-09 15:42:32 +00001470 * The exception wasn't handled. Inject to the VM to give it chance to
1471 * handle as an unknown exception.
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001472 */
Fuad Tabbab86325a2020-01-10 13:38:15 +00001473 inject_el1_unknown_exception(vcpu, esr);
1474
1475 /* Schedule the same VM to continue running. */
1476 return NULL;
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001477}
1478
Fuad Tabbac76466d2019-09-06 10:42:12 +01001479/**
Fuad Tabbab0ef2a42019-12-19 11:19:25 +00001480 * Handles EC = 011000, MSR, MRS instruction traps.
Fuad Tabbaed294af2019-12-20 10:43:01 +00001481 * Returns non-null ONLY if the access failed and the vCPU is changing.
Fuad Tabbac76466d2019-09-06 10:42:12 +01001482 */
Fuad Tabbab86325a2020-01-10 13:38:15 +00001483void handle_system_register_access(uintreg_t esr_el2)
Fuad Tabbac76466d2019-09-06 10:42:12 +01001484{
1485 struct vcpu *vcpu = current();
J-Alves19e20cf2023-08-02 12:48:55 +01001486 ffa_id_t vm_id = vcpu->vm->id;
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001487 uintreg_t ec = GET_ESR_EC(esr_el2);
Fuad Tabbac76466d2019-09-06 10:42:12 +01001488
Fuad Tabbab86325a2020-01-10 13:38:15 +00001489 CHECK(ec == EC_MSR);
Fuad Tabbac76466d2019-09-06 10:42:12 +01001490 /*
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +01001491 * Handle accesses to debug and performance monitor registers.
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001492 * Inject an exception for unhandled/unsupported registers.
Fuad Tabbac76466d2019-09-06 10:42:12 +01001493 */
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001494 if (debug_el1_is_register_access(esr_el2)) {
1495 if (!debug_el1_process_access(vcpu, vm_id, esr_el2)) {
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001496 inject_el1_sysreg_trap_exception(vcpu, esr_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001497 return;
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +01001498 }
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001499 } else if (perfmon_is_register_access(esr_el2)) {
1500 if (!perfmon_process_access(vcpu, vm_id, esr_el2)) {
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001501 inject_el1_sysreg_trap_exception(vcpu, esr_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001502 return;
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +01001503 }
Fuad Tabba77a4b012019-11-15 12:13:08 +00001504 } else if (feature_id_is_register_access(esr_el2)) {
1505 if (!feature_id_process_access(vcpu, esr_el2)) {
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001506 inject_el1_sysreg_trap_exception(vcpu, esr_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001507 return;
Fuad Tabba77a4b012019-11-15 12:13:08 +00001508 }
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +01001509 } else {
Olivier Deprezda14ddc2022-08-11 14:14:41 +02001510 inject_el1_sysreg_trap_exception(vcpu, esr_el2);
Fuad Tabbab86325a2020-01-10 13:38:15 +00001511 return;
Fuad Tabbac76466d2019-09-06 10:42:12 +01001512 }
1513
Fuad Tabbaf1d6dc52019-09-18 17:33:14 +01001514 /* Instruction was fulfilled. Skip it and run the next one. */
Fuad Tabba3e9b0222019-11-11 16:47:50 +00001515 vcpu->regs.pc += GET_NEXT_PC_INC(esr_el2);
Fuad Tabbac76466d2019-09-06 10:42:12 +01001516}