sys/amd64/vmm/io/vlapic.h

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