xref: /freebsd/sys/arm64/vmm/io/vgic.h (revision e1c4c8dd8d2d10b6104f06856a77bd5b4813a801)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2023 Arm Ltd
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _VGIC_H_
29 #define	_VGIC_H_
30 
31 struct hyp;
32 struct hypctx;
33 struct vm_vgic_descr;
34 
35 extern device_t vgic_dev;
36 
37 bool vgic_present(void);
38 void vgic_init(void);
39 int vgic_attach_to_vm(struct hyp *hyp, struct vm_vgic_descr *descr);
40 void vgic_detach_from_vm(struct hyp *hyp);
41 void vgic_vminit(struct hyp *hyp);
42 void vgic_cpuinit(struct hypctx *hypctx);
43 void vgic_cpucleanup(struct hypctx *hypctx);
44 void vgic_vmcleanup(struct hyp *hyp);
45 int vgic_max_cpu_count(struct hyp *hyp);
46 bool vgic_has_pending_irq(struct hypctx *hypctx);
47 int vgic_inject_irq(struct hyp *hyp, int vcpuid, uint32_t irqid, bool level);
48 int vgic_inject_msi(struct hyp *hyp, uint64_t msg, uint64_t addr);
49 void vgic_flush_hwstate(struct hypctx *hypctx);
50 void vgic_sync_hwstate(struct hypctx *hypctx);
51 
52 #endif /* _VGIC_H_ */
53