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 /* 30 * This file and its contents are supplied under the terms of the 31 * Common Development and Distribution License ("CDDL"), version 1.0. 32 * You may only use this file in accordance with the terms of version 33 * 1.0 of the CDDL. 34 * 35 * A full copy of the text of the CDDL should have accompanied this 36 * source. A copy of the CDDL is also available via the Internet at 37 * http://www.illumos.org/license/CDDL. 38 */ 39 /* This file is dual-licensed; see usr/src/contrib/bhyve/LICENSE */ 40 41 /* 42 * Copyright 2018 Joyent, Inc. 43 * Copyright 2022 Oxide Computer Company 44 */ 45 46 #ifndef _VLAPIC_H_ 47 #define _VLAPIC_H_ 48 49 void vlapic_reset(struct vlapic *vlapic); 50 51 int vlapic_mmio_write(struct vlapic *, uint64_t, uint64_t, uint_t); 52 int vlapic_mmio_read(struct vlapic *, uint64_t, uint64_t *, uint_t); 53 54 bool vlapic_owned_msr(uint32_t); 55 vm_msr_result_t vlapic_rdmsr(struct vlapic *, uint32_t, uint64_t *); 56 vm_msr_result_t vlapic_wrmsr(struct vlapic *, uint32_t, uint64_t); 57 58 /* 59 * Returns 0 if there is no eligible vector that can be delivered to the 60 * guest at this time and non-zero otherwise. 61 * 62 * If an eligible vector number is found and 'vecptr' is not NULL then it will 63 * be stored in the location pointed to by 'vecptr'. 64 * 65 * Note that the vector does not automatically transition to the ISR as a 66 * result of calling this function. 67 */ 68 int vlapic_pending_intr(struct vlapic *vlapic, int *vecptr); 69 70 /* 71 * Transition 'vector' from IRR to ISR. This function is called with the 72 * vector returned by 'vlapic_pending_intr()' when the guest is able to 73 * accept this interrupt (i.e. RFLAGS.IF = 1 and no conditions exist that 74 * block interrupt delivery). 75 */ 76 void vlapic_intr_accepted(struct vlapic *vlapic, int vector); 77 78 vcpu_notify_t vlapic_set_intr_ready(struct vlapic *vlapic, int vector, 79 bool level); 80 81 /* 82 * Post an interrupt to the vcpu running on 'hostcpu'. This will use a 83 * hardware assist if available (e.g. Posted Interrupt) or fall back to 84 * sending an IPI to interrupt the 'hostcpu'. 85 */ 86 void vlapic_post_intr(struct vlapic *vlapic, int hostcpu); 87 88 void vlapic_fire_cmci(struct vlapic *vlapic); 89 int vlapic_trigger_lvt(struct vlapic *vlapic, int vector); 90 91 void vlapic_sync_tpr(struct vlapic *vlapic); 92 93 void vlapic_set_x2apic_state(struct vm *vm, int vcpuid, enum x2apic_state s); 94 95 void vlapic_deliver_intr(struct vm *vm, bool level, uint32_t dest, bool phys, 96 int delmode, int vec); 97 98 void vlapic_calcdest(struct vm *vm, cpuset_t *dmask, uint32_t dest, bool phys, 99 bool lowprio, bool x2apic_dest); 100 101 void vlapic_set_cr8(struct vlapic *vlapic, uint64_t val); 102 uint64_t vlapic_get_cr8(const struct vlapic *vlapic); 103 104 /* APIC write handlers */ 105 void vlapic_id_write_handler(struct vlapic *vlapic); 106 void vlapic_ldr_write_handler(struct vlapic *vlapic); 107 void vlapic_dfr_write_handler(struct vlapic *vlapic); 108 void vlapic_svr_write_handler(struct vlapic *vlapic); 109 void vlapic_esr_write_handler(struct vlapic *vlapic); 110 void vlapic_icrlo_write_handler(struct vlapic *vlapic); 111 void vlapic_icrtmr_write_handler(struct vlapic *vlapic); 112 void vlapic_dcr_write_handler(struct vlapic *vlapic); 113 void vlapic_lvt_write_handler(struct vlapic *vlapic, uint32_t offset); 114 void vlapic_self_ipi_handler(struct vlapic *vlapic, uint32_t val); 115 116 void vlapic_localize_resources(struct vlapic *vlapic); 117 void vlapic_pause(struct vlapic *); 118 void vlapic_resume(struct vlapic *); 119 120 bool vlapic_hw_disabled(const struct vlapic *); 121 122 #endif /* _VLAPIC_H_ */ 123