1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2016,2017 ARM Limited, All Rights Reserved.
4 * Author: Marc Zyngier <marc.zyngier@arm.com>
7 #include <linux/interrupt.h>
9 #include <linux/irqdomain.h>
10 #include <linux/msi.h>
11 #include <linux/sched.h>
13 #include <linux/irqchip/arm-gic-v4.h>
16 * WARNING: The blurb below assumes that you understand the
17 * intricacies of GICv3, GICv4, and how a guest's view of a GICv3 gets
18 * translated into GICv4 commands. So it effectively targets at most
19 * two individuals. You know who you are.
21 * The core GICv4 code is designed to *avoid* exposing too much of the
22 * core GIC code (that would in turn leak into the hypervisor code),
23 * and instead provide a hypervisor agnostic interface to the HW (of
24 * course, the astute reader will quickly realize that hypervisor
25 * agnostic actually means KVM-specific - what were you thinking?).
27 * In order to achieve a modicum of isolation, we try to hide most of
28 * the GICv4 "stuff" behind normal irqchip operations:
30 * - Any guest-visible VLPI is backed by a Linux interrupt (and a
31 * physical LPI which gets unmapped when the guest maps the
32 * VLPI). This allows the same DevID/EventID pair to be either
33 * mapped to the LPI (host) or the VLPI (guest). Note that this is
34 * exclusive, and you cannot have both.
36 * - Enabling/disabling a VLPI is done by issuing mask/unmask calls.
38 * - Guest INT/CLEAR commands are implemented through
39 * irq_set_irqchip_state().
41 * - The *bizarre* stuff (mapping/unmapping an interrupt to a VLPI, or
42 * issuing an INV after changing a priority) gets shoved into the
43 * irq_set_vcpu_affinity() method. While this is quite horrible
44 * (let's face it, this is the irqchip version of an ioctl), it
45 * confines the crap to a single location. And map/unmap really is
46 * about setting the affinity of a VLPI to a vcpu, so only INV is
47 * majorly out of place. So there.
49 * A number of commands are simply not provided by this interface, as
50 * they do not make direct sense. For example, MAPD is purely local to
51 * the virtual ITS (because it references a virtual device, and the
52 * physical ITS is still very much in charge of the physical
53 * device). Same goes for things like MAPC (the physical ITS deals
54 * with the actual vPE affinity, and not the braindead concept of
55 * collection). SYNC is not provided either, as each and every command
56 * is followed by a VSYNC. This could be relaxed in the future, should
57 * this be seen as a bottleneck (yes, this means *never*).
59 * But handling VLPIs is only one side of the job of the GICv4
60 * code. The other (darker) side is to take care of the doorbell
61 * interrupts which are delivered when a VLPI targeting a non-running
62 * vcpu is being made pending.
64 * The choice made here is that each vcpu (VPE in old northern GICv4
65 * dialect) gets a single doorbell LPI, no matter how many interrupts
66 * are targeting it. This has a nice property, which is that the
67 * interrupt becomes a handle for the VPE, and that the hypervisor
68 * code can manipulate it through the normal interrupt API:
70 * - VMs (or rather the VM abstraction that matters to the GIC)
71 * contain an irq domain where each interrupt maps to a VPE. In
72 * turn, this domain sits on top of the normal LPI allocator, and a
73 * specially crafted irq_chip implementation.
75 * - mask/unmask do what is expected on the doorbell interrupt.
77 * - irq_set_affinity is used to move a VPE from one redistributor to
80 * - irq_set_vcpu_affinity once again gets hijacked for the purpose of
81 * creating a new sub-API, namely scheduling/descheduling a VPE
82 * (which involves programming GICR_V{PROP,PEND}BASER) and
83 * performing INVALL operations.
86 static struct irq_domain
*gic_domain
;
87 static const struct irq_domain_ops
*vpe_domain_ops
;
88 static const struct irq_domain_ops
*sgi_domain_ops
;
90 static bool has_v4_1(void)
92 return !!sgi_domain_ops
;
95 static int its_alloc_vcpu_sgis(struct its_vpe
*vpe
, int idx
)
103 name
= kasprintf(GFP_KERNEL
, "GICv4-sgi-%d", task_pid_nr(current
));
107 vpe
->fwnode
= irq_domain_alloc_named_id_fwnode(name
, idx
);
114 vpe
->sgi_domain
= irq_domain_create_linear(vpe
->fwnode
, 16,
115 sgi_domain_ops
, vpe
);
116 if (!vpe
->sgi_domain
)
119 sgi_base
= __irq_domain_alloc_irqs(vpe
->sgi_domain
, -1, 16,
129 irq_domain_remove(vpe
->sgi_domain
);
131 irq_domain_free_fwnode(vpe
->fwnode
);
136 int its_alloc_vcpu_irqs(struct its_vm
*vm
)
140 vm
->fwnode
= irq_domain_alloc_named_id_fwnode("GICv4-vpe",
141 task_pid_nr(current
));
145 vm
->domain
= irq_domain_create_hierarchy(gic_domain
, 0, vm
->nr_vpes
,
146 vm
->fwnode
, vpe_domain_ops
,
151 for (i
= 0; i
< vm
->nr_vpes
; i
++) {
152 vm
->vpes
[i
]->its_vm
= vm
;
153 vm
->vpes
[i
]->idai
= true;
156 vpe_base_irq
= __irq_domain_alloc_irqs(vm
->domain
, -1, vm
->nr_vpes
,
159 if (vpe_base_irq
<= 0)
162 for (i
= 0; i
< vm
->nr_vpes
; i
++) {
164 vm
->vpes
[i
]->irq
= vpe_base_irq
+ i
;
165 ret
= its_alloc_vcpu_sgis(vm
->vpes
[i
], i
);
174 irq_domain_remove(vm
->domain
);
176 irq_domain_free_fwnode(vm
->fwnode
);
181 static void its_free_sgi_irqs(struct its_vm
*vm
)
188 for (i
= 0; i
< vm
->nr_vpes
; i
++) {
189 unsigned int irq
= irq_find_mapping(vm
->vpes
[i
]->sgi_domain
, 0);
194 irq_domain_free_irqs(irq
, 16);
195 irq_domain_remove(vm
->vpes
[i
]->sgi_domain
);
196 irq_domain_free_fwnode(vm
->vpes
[i
]->fwnode
);
200 void its_free_vcpu_irqs(struct its_vm
*vm
)
202 its_free_sgi_irqs(vm
);
203 irq_domain_free_irqs(vm
->vpes
[0]->irq
, vm
->nr_vpes
);
204 irq_domain_remove(vm
->domain
);
205 irq_domain_free_fwnode(vm
->fwnode
);
208 static int its_send_vpe_cmd(struct its_vpe
*vpe
, struct its_cmd_info
*info
)
210 return irq_set_vcpu_affinity(vpe
->irq
, info
);
213 int its_make_vpe_non_resident(struct its_vpe
*vpe
, bool db
)
215 struct irq_desc
*desc
= irq_to_desc(vpe
->irq
);
216 struct its_cmd_info info
= { };
219 WARN_ON(preemptible());
221 info
.cmd_type
= DESCHEDULE_VPE
;
223 /* GICv4.1 can directly deal with doorbells */
226 /* Undo the nested disable_irq() calls... */
227 while (db
&& irqd_irq_disabled(&desc
->irq_data
))
228 enable_irq(vpe
->irq
);
231 ret
= its_send_vpe_cmd(vpe
, &info
);
233 vpe
->resident
= false;
240 int its_make_vpe_resident(struct its_vpe
*vpe
, bool g0en
, bool g1en
)
242 struct its_cmd_info info
= { };
245 WARN_ON(preemptible());
247 info
.cmd_type
= SCHEDULE_VPE
;
252 /* Disabled the doorbell, as we're about to enter the guest */
253 disable_irq_nosync(vpe
->irq
);
256 ret
= its_send_vpe_cmd(vpe
, &info
);
258 vpe
->resident
= true;
263 int its_commit_vpe(struct its_vpe
*vpe
)
265 struct its_cmd_info info
= {
266 .cmd_type
= COMMIT_VPE
,
270 WARN_ON(preemptible());
272 ret
= its_send_vpe_cmd(vpe
, &info
);
280 int its_invall_vpe(struct its_vpe
*vpe
)
282 struct its_cmd_info info
= {
283 .cmd_type
= INVALL_VPE
,
286 return its_send_vpe_cmd(vpe
, &info
);
289 int its_map_vlpi(int irq
, struct its_vlpi_map
*map
)
291 struct its_cmd_info info
= {
292 .cmd_type
= MAP_VLPI
,
300 * The host will never see that interrupt firing again, so it
301 * is vital that we don't do any lazy masking.
303 irq_set_status_flags(irq
, IRQ_DISABLE_UNLAZY
);
305 ret
= irq_set_vcpu_affinity(irq
, &info
);
307 irq_clear_status_flags(irq
, IRQ_DISABLE_UNLAZY
);
312 int its_get_vlpi(int irq
, struct its_vlpi_map
*map
)
314 struct its_cmd_info info
= {
315 .cmd_type
= GET_VLPI
,
321 return irq_set_vcpu_affinity(irq
, &info
);
324 int its_unmap_vlpi(int irq
)
326 irq_clear_status_flags(irq
, IRQ_DISABLE_UNLAZY
);
327 return irq_set_vcpu_affinity(irq
, NULL
);
330 int its_prop_update_vlpi(int irq
, u8 config
, bool inv
)
332 struct its_cmd_info info
= {
333 .cmd_type
= inv
? PROP_UPDATE_AND_INV_VLPI
: PROP_UPDATE_VLPI
,
339 return irq_set_vcpu_affinity(irq
, &info
);
342 int its_prop_update_vsgi(int irq
, u8 priority
, bool group
)
344 struct its_cmd_info info
= {
345 .cmd_type
= PROP_UPDATE_VSGI
,
347 .priority
= priority
,
352 return irq_set_vcpu_affinity(irq
, &info
);
355 int its_init_v4(struct irq_domain
*domain
,
356 const struct irq_domain_ops
*vpe_ops
,
357 const struct irq_domain_ops
*sgi_ops
)
360 pr_info("ITS: Enabling GICv4 support\n");
362 vpe_domain_ops
= vpe_ops
;
363 sgi_domain_ops
= sgi_ops
;
367 pr_err("ITS: No GICv4 VPE domain allocated\n");