1 /******************************************************************************
2 * arch-ia64/hypervisor-if.h
4 * Guest OS interface to IA64 Xen.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
24 * Copyright by those who contributed. (in alphabetical order)
26 * Anthony Xu <anthony.xu@intel.com>
27 * Eddie Dong <eddie.dong@intel.com>
28 * Fred Yang <fred.yang@intel.com>
29 * Kevin Tian <kevin.tian@intel.com>
30 * Alex Williamson <alex.williamson@hp.com>
31 * Chris Wright <chrisw@sous-sol.org>
32 * Christian Limpach <Christian.Limpach@cl.cam.ac.uk>
33 * Dietmar Hahn <dietmar.hahn@fujitsu-siemens.com>
34 * Hollis Blanchard <hollisb@us.ibm.com>
35 * Isaku Yamahata <yamahata@valinux.co.jp>
36 * Jan Beulich <jbeulich@novell.com>
37 * John Levon <john.levon@sun.com>
38 * Kazuhiro Suzuki <kaz@jp.fujitsu.com>
39 * Keir Fraser <keir.fraser@citrix.com>
40 * Kouya Shimura <kouya@jp.fujitsu.com>
41 * Masaki Kanno <kanno.masaki@jp.fujitsu.com>
42 * Matt Chapman <matthewc@hp.com>
43 * Matthew Chapman <matthewc@hp.com>
44 * Samuel Thibault <samuel.thibault@eu.citrix.com>
45 * Tomonari Horikoshi <t.horikoshi@jp.fujitsu.com>
46 * Tristan Gingold <tgingold@free.fr>
47 * Tsunehisa Doi <Doi.Tsunehisa@jp.fujitsu.com>
48 * Yutaka Ezaki <yutaka.ezaki@jp.fujitsu.com>
49 * Zhang Xin <xing.z.zhang@intel.com>
50 * Zhang xiantao <xiantao.zhang@intel.com>
51 * dan.magenheimer@hp.com
52 * ian.pratt@cl.cam.ac.uk
53 * michael.fetterman@cl.cam.ac.uk
56 #ifndef _ASM_IA64_XEN_INTERFACE_H
57 #define _ASM_IA64_XEN_INTERFACE_H
59 #define __DEFINE_GUEST_HANDLE(name, type) \
60 typedef struct { type *p; } __guest_handle_ ## name
62 #define DEFINE_GUEST_HANDLE_STRUCT(name) \
63 __DEFINE_GUEST_HANDLE(name, struct name)
64 #define DEFINE_GUEST_HANDLE(name) __DEFINE_GUEST_HANDLE(name, name)
65 #define GUEST_HANDLE(name) __guest_handle_ ## name
66 #define GUEST_HANDLE_64(name) GUEST_HANDLE(name)
67 #define set_xen_guest_handle(hnd, val) do { (hnd).p = val; } while (0)
70 /* Guest handles for primitive C types. */
71 __DEFINE_GUEST_HANDLE(uchar, unsigned char);
72 __DEFINE_GUEST_HANDLE(uint, unsigned int);
73 __DEFINE_GUEST_HANDLE(ulong, unsigned long);
74 __DEFINE_GUEST_HANDLE(u64, unsigned long);
75 DEFINE_GUEST_HANDLE(char);
76 DEFINE_GUEST_HANDLE(int);
77 DEFINE_GUEST_HANDLE(long);
78 DEFINE_GUEST_HANDLE(void);
80 typedef unsigned long xen_pfn_t;
81 DEFINE_GUEST_HANDLE(xen_pfn_t);
82 #define PRI_xen_pfn "lx"
85 /* Arch specific VIRQs definition */
86 #define VIRQ_ITC VIRQ_ARCH_0 /* V. Virtual itc timer */
87 #define VIRQ_MCA_CMC VIRQ_ARCH_1 /* MCA cmc interrupt */
88 #define VIRQ_MCA_CPE VIRQ_ARCH_2 /* MCA cpe interrupt */
90 /* Maximum number of virtual CPUs in multi-processor guests. */
91 /* keep sizeof(struct shared_page) <= PAGE_SIZE.
92 * this is checked in arch/ia64/xen/hypervisor.c. */
93 #define MAX_VIRT_CPUS 64
97 #define INVALID_MFN (~0UL)
129 unsigned long virt_env_vaddr;
130 unsigned long reserved1[29];
132 unsigned long reserved2[95];
134 unsigned long vgr[16];
135 unsigned long bank1_regs[16]; /* bank1 regs (r16-r31)
139 unsigned long vbgr[16];
140 unsigned long bank0_regs[16]; /* bank0 regs (r16-r31)
145 unsigned long vcpuid[5];
146 unsigned long reserved3[11];
149 unsigned long reserved4[76];
151 unsigned long vcr[128];
153 unsigned long dcr; /* CR0 */
156 unsigned long rsv1[5];
157 unsigned long pta; /* CR8 */
158 unsigned long rsv2[7];
159 unsigned long ipsr; /* CR16 */
167 unsigned long iim; /* CR24 */
169 unsigned long rsv4[38];
170 unsigned long lid; /* CR64 */
174 unsigned long irr[4];
175 unsigned long itv; /* CR72 */
178 unsigned long rsv5[5];
179 unsigned long lrr0; /* CR80 */
181 unsigned long rsv6[46];
185 unsigned long reserved5[128];
187 unsigned long precover_ifs;
188 unsigned long unat; /* not sure if this is needed
189 until NaT arch is done */
190 int interrupt_collection_enabled; /* virtual psr.ic */
192 /* virtual interrupt deliverable flag is
193 * evtchn_upcall_mask in shared info area now.
194 * interrupt_mask_addr is the address
195 * of evtchn_upcall_mask for current vcpu
197 unsigned char *interrupt_mask_addr;
198 int pending_interruption;
199 unsigned char vpsr_pp;
200 unsigned char vpsr_dfh;
201 unsigned char hpsr_dfh;
202 unsigned char hpsr_mfh;
203 unsigned long reserved5_1[4];
204 int metaphysical_mode; /* 1 = use metaphys mapping
206 int banknum; /* 0 or 1, which virtual
207 register bank is active */
208 unsigned long rrs[8]; /* region registers */
209 unsigned long krs[8]; /* kernel registers */
210 unsigned long tmp[16]; /* temp registers
211 (e.g. for hyperprivops) */
216 struct arch_vcpu_info {
221 * This structure is used for magic page in domain pseudo physical address
222 * space and the result of XENMEM_machine_memory_map.
223 * As the XENMEM_machine_memory_map result,
224 * xen_memory_map::nr_entries indicates the size in bytes
225 * including struct xen_ia64_memmap_info. Not the number of entries.
227 struct xen_ia64_memmap_info {
228 uint64_t efi_memmap_size; /* size of EFI memory map */
229 uint64_t efi_memdesc_size; /* size of an EFI memory map
231 uint32_t efi_memdesc_version; /* memory descriptor version */
232 void *memdesc[0]; /* array of efi_memory_desc_t */
235 struct arch_shared_info {
236 /* PFN of the start_info page. */
237 unsigned long start_info_pfn;
239 /* Interrupt vector for event channel. */
242 /* PFN of memmap_info page */
243 unsigned int memmap_info_num_pages; /* currently only = 1 case is
245 unsigned long memmap_info_pfn;
250 struct xen_callback {
253 typedef struct xen_callback xen_callback_t;
255 #endif /* !__ASSEMBLY__ */
257 /* Size of the shared_info area (this is not related to page size). */
259 #define XSI_SIZE (1 << XSI_SHIFT)
260 /* Log size of mapped_regs area (64 KB - only 4KB is used). */
261 #define XMAPPEDREGS_SHIFT 12
262 #define XMAPPEDREGS_SIZE (1 << XMAPPEDREGS_SHIFT)
263 /* Offset of XASI (Xen arch shared info) wrt XSI_BASE. */
264 #define XMAPPEDREGS_OFS XSI_SIZE
267 #define HYPERPRIVOP_START 0x1
268 #define HYPERPRIVOP_RFI (HYPERPRIVOP_START + 0x0)
269 #define HYPERPRIVOP_RSM_DT (HYPERPRIVOP_START + 0x1)
270 #define HYPERPRIVOP_SSM_DT (HYPERPRIVOP_START + 0x2)
271 #define HYPERPRIVOP_COVER (HYPERPRIVOP_START + 0x3)
272 #define HYPERPRIVOP_ITC_D (HYPERPRIVOP_START + 0x4)
273 #define HYPERPRIVOP_ITC_I (HYPERPRIVOP_START + 0x5)
274 #define HYPERPRIVOP_SSM_I (HYPERPRIVOP_START + 0x6)
275 #define HYPERPRIVOP_GET_IVR (HYPERPRIVOP_START + 0x7)
276 #define HYPERPRIVOP_GET_TPR (HYPERPRIVOP_START + 0x8)
277 #define HYPERPRIVOP_SET_TPR (HYPERPRIVOP_START + 0x9)
278 #define HYPERPRIVOP_EOI (HYPERPRIVOP_START + 0xa)
279 #define HYPERPRIVOP_SET_ITM (HYPERPRIVOP_START + 0xb)
280 #define HYPERPRIVOP_THASH (HYPERPRIVOP_START + 0xc)
281 #define HYPERPRIVOP_PTC_GA (HYPERPRIVOP_START + 0xd)
282 #define HYPERPRIVOP_ITR_D (HYPERPRIVOP_START + 0xe)
283 #define HYPERPRIVOP_GET_RR (HYPERPRIVOP_START + 0xf)
284 #define HYPERPRIVOP_SET_RR (HYPERPRIVOP_START + 0x10)
285 #define HYPERPRIVOP_SET_KR (HYPERPRIVOP_START + 0x11)
286 #define HYPERPRIVOP_FC (HYPERPRIVOP_START + 0x12)
287 #define HYPERPRIVOP_GET_CPUID (HYPERPRIVOP_START + 0x13)
288 #define HYPERPRIVOP_GET_PMD (HYPERPRIVOP_START + 0x14)
289 #define HYPERPRIVOP_GET_EFLAG (HYPERPRIVOP_START + 0x15)
290 #define HYPERPRIVOP_SET_EFLAG (HYPERPRIVOP_START + 0x16)
291 #define HYPERPRIVOP_RSM_BE (HYPERPRIVOP_START + 0x17)
292 #define HYPERPRIVOP_GET_PSR (HYPERPRIVOP_START + 0x18)
293 #define HYPERPRIVOP_SET_RR0_TO_RR4 (HYPERPRIVOP_START + 0x19)
294 #define HYPERPRIVOP_MAX (0x1a)
296 /* Fast and light hypercalls. */
297 #define __HYPERVISOR_ia64_fast_eoi __HYPERVISOR_arch_1
299 /* Xencomm macros. */
300 #define XENCOMM_INLINE_MASK 0xf800000000000000UL
301 #define XENCOMM_INLINE_FLAG 0x8000000000000000UL
306 * Optimization features.
307 * The hypervisor may do some special optimizations for guests. This hypercall
308 * can be used to switch on/of these special optimizations.
310 #define __HYPERVISOR_opt_feature 0x700UL
312 #define XEN_IA64_OPTF_OFF 0x0
313 #define XEN_IA64_OPTF_ON 0x1
316 * If this feature is switched on, the hypervisor inserts the
317 * tlb entries without calling the guests traphandler.
318 * This is useful in guests using region 7 for identity mapping
319 * like the linux kernel does.
321 #define XEN_IA64_OPTF_IDENT_MAP_REG7 1
323 /* Identity mapping of region 4 addresses in HVM. */
324 #define XEN_IA64_OPTF_IDENT_MAP_REG4 2
326 /* Identity mapping of region 5 addresses in HVM. */
327 #define XEN_IA64_OPTF_IDENT_MAP_REG5 3
329 #define XEN_IA64_OPTF_IDENT_MAP_NOT_SET (0)
331 struct xen_ia64_opt_feature {
332 unsigned long cmd; /* Which feature */
333 unsigned char on; /* Switch feature on/off */
336 /* The page protection bit mask of the pte.
337 * This will be or'ed with the pte. */
338 unsigned long pgprot;
339 unsigned long key; /* A protection key for itir.*/
344 #endif /* __ASSEMBLY__ */
346 #endif /* _ASM_IA64_XEN_INTERFACE_H */