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 #ifndef _VLAPIC_H_ 32 #define _VLAPIC_H_ 33 34 struct vm; 35 struct vm_snapshot_meta; 36 enum x2apic_state; 37 38 int vlapic_write(struct vlapic *vlapic, int mmio_access, uint64_t offset, 39 uint64_t data, bool *retu); 40 int vlapic_read(struct vlapic *vlapic, int mmio_access, uint64_t offset, 41 uint64_t *data, bool *retu); 42 43 /* 44 * Returns 0 if there is no eligible vector that can be delivered to the 45 * guest at this time and non-zero otherwise. 46 * 47 * If an eligible vector number is found and 'vecptr' is not NULL then it will 48 * be stored in the location pointed to by 'vecptr'. 49 * 50 * Note that the vector does not automatically transition to the ISR as a 51 * result of calling this function. 52 */ 53 int vlapic_pending_intr(struct vlapic *vlapic, int *vecptr); 54 55 /* 56 * Transition 'vector' from IRR to ISR. This function is called with the 57 * vector returned by 'vlapic_pending_intr()' when the guest is able to 58 * accept this interrupt (i.e. RFLAGS.IF = 1 and no conditions exist that 59 * block interrupt delivery). 60 */ 61 void vlapic_intr_accepted(struct vlapic *vlapic, int vector); 62 63 /* 64 * Returns 1 if the vcpu needs to be notified of the interrupt and 0 otherwise. 65 */ 66 int vlapic_set_intr_ready(struct vlapic *vlapic, int vector, bool level); 67 68 /* 69 * Post an interrupt to the vcpu running on 'hostcpu'. This will use a 70 * hardware assist if available (e.g. Posted Interrupt) or fall back to 71 * sending an 'ipinum' to interrupt the 'hostcpu'. 72 */ 73 void vlapic_post_intr(struct vlapic *vlapic, int hostcpu, int ipinum); 74 75 void vlapic_fire_cmci(struct vlapic *vlapic); 76 int vlapic_trigger_lvt(struct vlapic *vlapic, int vector); 77 78 void vlapic_sync_tpr(struct vlapic *vlapic); 79 80 uint64_t vlapic_get_apicbase(struct vlapic *vlapic); 81 int vlapic_set_apicbase(struct vlapic *vlapic, uint64_t val); 82 void vlapic_set_x2apic_state(struct vcpu *vcpu, enum x2apic_state s); 83 bool vlapic_enabled(struct vlapic *vlapic); 84 85 void vlapic_deliver_intr(struct vm *vm, bool level, uint32_t dest, bool phys, 86 int delmode, int vec); 87 88 /* Reset the trigger-mode bits for all vectors to be edge-triggered */ 89 void vlapic_reset_tmr(struct vlapic *vlapic); 90 91 /* 92 * Set the trigger-mode bit associated with 'vector' to level-triggered if 93 * the (dest,phys,delmode) tuple resolves to an interrupt being delivered to 94 * this 'vlapic'. 95 */ 96 void vlapic_set_tmr_level(struct vlapic *vlapic, uint32_t dest, bool phys, 97 int delmode, int vector); 98 99 void vlapic_set_cr8(struct vlapic *vlapic, uint64_t val); 100 uint64_t vlapic_get_cr8(struct vlapic *vlapic); 101 102 /* APIC write handlers */ 103 void vlapic_id_write_handler(struct vlapic *vlapic); 104 void vlapic_ldr_write_handler(struct vlapic *vlapic); 105 void vlapic_dfr_write_handler(struct vlapic *vlapic); 106 void vlapic_svr_write_handler(struct vlapic *vlapic); 107 void vlapic_esr_write_handler(struct vlapic *vlapic); 108 int vlapic_icrlo_write_handler(struct vlapic *vlapic, bool *retu); 109 void vlapic_icrtmr_write_handler(struct vlapic *vlapic); 110 void vlapic_dcr_write_handler(struct vlapic *vlapic); 111 void vlapic_lvt_write_handler(struct vlapic *vlapic, uint32_t offset); 112 void vlapic_self_ipi_handler(struct vlapic *vlapic, uint64_t val); 113 114 #ifdef BHYVE_SNAPSHOT 115 int vlapic_snapshot(struct vm *vm, struct vm_snapshot_meta *meta); 116 #endif 117 118 int vm_handle_ipi(struct vcpu *vcpu, struct vm_exit *vme, bool *retu); 119 120 #endif /* _VLAPIC_H_ */ 121