xref: /freebsd/sys/riscv/vmm/vmm_aplic.h (revision b59017c5cad90d0f09a59e68c00457b7faf93e7c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2024 Ruslan Bukin <br@bsdpad.com>
5  *
6  * This software was developed by the University of Cambridge Computer
7  * Laboratory (Department of Computer Science and Technology) under Innovate
8  * UK project 105694, "Digital Security by Design (DSbD) Technology Platform
9  * Prototype".
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _VMM_APLIC_H_
34 #define _VMM_APLIC_H_
35 
36 struct hyp;
37 struct hypctx;
38 struct vm_aplic_descr;
39 
40 int aplic_attach_to_vm(struct hyp *hyp, struct vm_aplic_descr *descr);
41 void aplic_detach_from_vm(struct hyp *hyp);
42 int aplic_inject_irq(struct hyp *hyp, int vcpuid, uint32_t irqid, bool level);
43 int aplic_inject_msi(struct hyp *hyp, uint64_t msg, uint64_t addr);
44 void aplic_vminit(struct hyp *hyp);
45 void aplic_vmcleanup(struct hyp *hyp);
46 int aplic_check_pending(struct hypctx *hypctx);
47 
48 void aplic_cpuinit(struct hypctx *hypctx);
49 void aplic_cpucleanup(struct hypctx *hypctx);
50 void aplic_flush_hwstate(struct hypctx *hypctx);
51 void aplic_sync_hwstate(struct hypctx *hypctx);
52 int aplic_max_cpu_count(struct hyp *hyp);
53 
54 #endif /* !_VMM_APLIC_H_ */
55