1 /* $NetBSD: hypervisor.h,v 1.49 2019/02/04 18:14:53 cherry Exp $ */ 2 3 /* 4 * Copyright (c) 2006 Manuel Bouyer. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 */ 27 28 /* 29 * 30 * Communication to/from hypervisor. 31 * 32 * Copyright (c) 2002-2004, K A Fraser 33 * 34 * Permission is hereby granted, free of charge, to any person obtaining a copy 35 * of this source file (the "Software"), to deal in the Software without 36 * restriction, including without limitation the rights to use, copy, modify, 37 * merge, publish, distribute, sublicense, and/or sell copies of the Software, 38 * and to permit persons to whom the Software is furnished to do so, subject to 39 * the following conditions: 40 * 41 * The above copyright notice and this permission notice shall be included in 42 * all copies or substantial portions of the Software. 43 * 44 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 45 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 46 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 47 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 48 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 49 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 50 * IN THE SOFTWARE. 51 */ 52 53 54 #ifndef _XEN_HYPERVISOR_H_ 55 #define _XEN_HYPERVISOR_H_ 56 57 #include "opt_xen.h" 58 #include "isa.h" 59 #include "pci.h" 60 61 struct hypervisor_attach_args { 62 const char *haa_busname; 63 }; 64 65 struct xencons_attach_args { 66 const char *xa_device; 67 }; 68 69 struct xen_npx_attach_args { 70 const char *xa_device; 71 }; 72 73 74 #define u8 uint8_t 75 #define u16 uint16_t 76 #define u32 uint32_t 77 #define u64 uint64_t 78 #define s8 int8_t 79 #define s16 int16_t 80 #define s32 int32_t 81 #define s64 int64_t 82 83 #include <sys/atomic.h> 84 85 #include <xen/include/public/xen.h> 86 #include <xen/include/public/sched.h> 87 #include <xen/include/public/platform.h> 88 #if __XEN_INTERFACE_VERSION__ < 0x00030204 89 #include <xen/include/public/dom0_ops.h> 90 #endif 91 #include <xen/include/public/event_channel.h> 92 #include <xen/include/public/physdev.h> 93 #include <xen/include/public/memory.h> 94 #include <xen/include/public/io/netif.h> 95 #include <xen/include/public/io/blkif.h> 96 97 #if __XEN_INTERFACE_VERSION < 0x00030208 98 /* Undo namespace damage from xen/include/public/io/ring.h 99 * The proper fix is to get upstream to stop assuming that all OSs use 100 * mb(), rmb(), wmb(). 101 */ 102 #undef xen_mb 103 #undef xen_rmb 104 #undef xen_wmb 105 106 #define xen_mb() membar_sync() 107 #define xen_rmb() membar_producer() 108 #define xen_wmb() membar_consumer() 109 #endif /* __XEN_INTERFACE_VERSION */ 110 111 #include <machine/hypercalls.h> 112 113 #undef u8 114 #undef u16 115 #undef u32 116 #undef u64 117 #undef s8 118 #undef s16 119 #undef s32 120 #undef s64 121 122 123 124 /* 125 * a placeholder for the start of day information passed up from the hypervisor 126 */ 127 union start_info_union 128 { 129 start_info_t start_info; 130 char padding[512]; 131 }; 132 extern union start_info_union start_info_union; 133 #define xen_start_info (start_info_union.start_info) 134 135 /* For use in guest OSes. */ 136 extern volatile shared_info_t *HYPERVISOR_shared_info; 137 138 139 /* Structural guest handles introduced in 0x00030201. */ 140 #if __XEN_INTERFACE_VERSION__ >= 0x00030201 141 #define xenguest_handle(hnd) (hnd).p 142 #else 143 #define xenguest_handle(hnd) hnd 144 #endif 145 146 /* hypervisor.c */ 147 struct intrframe; 148 struct cpu_info; 149 void do_hypervisor_callback(struct intrframe *regs); 150 #if NPCI > 0 || NISA > 0 151 void hypervisor_prime_pirq_event(int, unsigned int); 152 void hypervisor_ack_pirq_event(unsigned int); 153 #endif /* NPCI > 0 || NISA > 0 */ 154 155 extern int xen_version; 156 #define XEN_MAJOR(x) (((x) & 0xffff0000) >> 16) 157 #define XEN_MINOR(x) ((x) & 0x0000ffff) 158 159 /* 160 * Does the hypervisor we're running on support an api 161 * call at the requested version number ? 162 */ 163 #define XEN_VERSION_SUPPORTED(major, minor) \ 164 (XEN_MAJOR(xen_version) > (major) || \ 165 (XEN_MAJOR(xen_version) == (major) && \ 166 XEN_MINOR(xen_version) >= (minor))) 167 168 /* hypervisor_machdep.c */ 169 void hypervisor_send_event(struct cpu_info *, unsigned int); 170 void hypervisor_unmask_event(unsigned int); 171 void hypervisor_mask_event(unsigned int); 172 void hypervisor_clear_event(unsigned int); 173 void hypervisor_enable_ipl(unsigned int); 174 void hypervisor_set_ipending(uint32_t, int, int); 175 void hypervisor_machdep_attach(void); 176 void hypervisor_machdep_resume(void); 177 178 /* 179 * Force a proper event-channel callback from Xen after clearing the 180 * callback mask. We do this in a very simple manner, by making a call 181 * down into Xen. The pending flag will be checked by Xen on return. 182 */ 183 static __inline void hypervisor_force_callback(void) 184 { 185 (void)HYPERVISOR_xen_version(0, (void*)0); 186 } __attribute__((no_instrument_function)) /* used by mcount */ 187 188 static __inline void 189 hypervisor_notify_via_evtchn(unsigned int port) 190 { 191 evtchn_op_t op; 192 193 op.cmd = EVTCHNOP_send; 194 op.u.send.port = port; 195 (void)HYPERVISOR_event_channel_op(&op); 196 } 197 198 #endif /* _XEN_HYPERVISOR_H_ */ 199