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