xref: /illumos-gate/usr/src/uts/intel/io/vmm/io/vlapic.h (revision 3f6fd99d844f7d4b62e4e1ddb0c29a4c2f7eca15)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2011 NetApp, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 /*
32  * Copyright 2018 Joyent, Inc.
33  * Copyright 2020 Oxide Computer Company
34  */
35 
36 #ifndef _VLAPIC_H_
37 #define	_VLAPIC_H_
38 
39 void vlapic_reset(struct vlapic *vlapic);
40 
41 int vlapic_mmio_write(struct vlapic *, uint64_t, uint64_t, uint_t);
42 int vlapic_mmio_read(struct vlapic *, uint64_t, uint64_t *, uint_t);
43 
44 bool vlapic_owned_msr(uint32_t);
45 vm_msr_result_t vlapic_rdmsr(struct vlapic *, uint32_t, uint64_t *);
46 vm_msr_result_t vlapic_wrmsr(struct vlapic *, uint32_t, uint64_t);
47 
48 /*
49  * Returns 0 if there is no eligible vector that can be delivered to the
50  * guest at this time and non-zero otherwise.
51  *
52  * If an eligible vector number is found and 'vecptr' is not NULL then it will
53  * be stored in the location pointed to by 'vecptr'.
54  *
55  * Note that the vector does not automatically transition to the ISR as a
56  * result of calling this function.
57  */
58 int vlapic_pending_intr(struct vlapic *vlapic, int *vecptr);
59 
60 /*
61  * Transition 'vector' from IRR to ISR. This function is called with the
62  * vector returned by 'vlapic_pending_intr()' when the guest is able to
63  * accept this interrupt (i.e. RFLAGS.IF = 1 and no conditions exist that
64  * block interrupt delivery).
65  */
66 void vlapic_intr_accepted(struct vlapic *vlapic, int vector);
67 
68 vcpu_notify_t vlapic_set_intr_ready(struct vlapic *vlapic, int vector,
69     bool level);
70 
71 /*
72  * Post an interrupt to the vcpu running on 'hostcpu'. This will use a
73  * hardware assist if available (e.g. Posted Interrupt) or fall back to
74  * sending an IPI to interrupt the 'hostcpu'.
75  */
76 void vlapic_post_intr(struct vlapic *vlapic, int hostcpu);
77 
78 void vlapic_fire_cmci(struct vlapic *vlapic);
79 int vlapic_trigger_lvt(struct vlapic *vlapic, int vector);
80 
81 void vlapic_sync_tpr(struct vlapic *vlapic);
82 
83 void vlapic_set_x2apic_state(struct vm *vm, int vcpuid, enum x2apic_state s);
84 
85 void vlapic_deliver_intr(struct vm *vm, bool level, uint32_t dest, bool phys,
86     int delmode, int vec);
87 
88 void vlapic_calcdest(struct vm *vm, cpuset_t *dmask, uint32_t dest, bool phys,
89     bool lowprio, bool x2apic_dest);
90 
91 void vlapic_set_cr8(struct vlapic *vlapic, uint64_t val);
92 uint64_t vlapic_get_cr8(const struct vlapic *vlapic);
93 
94 /* APIC write handlers */
95 void vlapic_id_write_handler(struct vlapic *vlapic);
96 void vlapic_ldr_write_handler(struct vlapic *vlapic);
97 void vlapic_dfr_write_handler(struct vlapic *vlapic);
98 void vlapic_svr_write_handler(struct vlapic *vlapic);
99 void vlapic_esr_write_handler(struct vlapic *vlapic);
100 void vlapic_icrlo_write_handler(struct vlapic *vlapic);
101 void vlapic_icrtmr_write_handler(struct vlapic *vlapic);
102 void vlapic_dcr_write_handler(struct vlapic *vlapic);
103 void vlapic_lvt_write_handler(struct vlapic *vlapic, uint32_t offset);
104 void vlapic_self_ipi_handler(struct vlapic *vlapic, uint32_t val);
105 
106 void vlapic_localize_resources(struct vlapic *vlapic);
107 
108 #endif	/* _VLAPIC_H_ */
109