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