1 /****************************************************************************** 2 * xen.h 3 * 4 * Guest OS interface to Xen. 5 * 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: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 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. 23 * 24 * Copyright (c) 2004, K A Fraser 25 */ 26 27 #ifndef __XEN_PUBLIC_XEN_H__ 28 #define __XEN_PUBLIC_XEN_H__ 29 30 #include "xen-compat.h" 31 32 #if defined(__i386) && !defined(__i386__) 33 #define __i386__ /* foo */ 34 #endif 35 36 #if defined(__amd64) && !defined(__x86_64__) 37 #define __x86_64__ 38 #endif 39 40 #if defined(_ASM) && !defined(__ASSEMBLY__) 41 #define __ASSEMBLY__ 42 #endif 43 44 #if defined(__i386__) || defined(__x86_64__) 45 #include "arch-x86/xen.h" 46 #elif defined(__ia64__) 47 #include "arch-ia64.h" 48 #elif defined(__powerpc__) 49 #include "arch-powerpc.h" 50 #else 51 #error "Unsupported architecture" 52 #endif 53 54 /* 55 * HYPERCALLS 56 */ 57 58 #define __HYPERVISOR_set_trap_table 0 59 #define __HYPERVISOR_mmu_update 1 60 #define __HYPERVISOR_set_gdt 2 61 #define __HYPERVISOR_stack_switch 3 62 #define __HYPERVISOR_set_callbacks 4 63 #define __HYPERVISOR_fpu_taskswitch 5 64 #define __HYPERVISOR_sched_op_compat 6 /* compat since 0x00030101 */ 65 #define __HYPERVISOR_platform_op 7 66 #define __HYPERVISOR_set_debugreg 8 67 #define __HYPERVISOR_get_debugreg 9 68 #define __HYPERVISOR_update_descriptor 10 69 #define __HYPERVISOR_memory_op 12 70 #define __HYPERVISOR_multicall 13 71 #define __HYPERVISOR_update_va_mapping 14 72 #define __HYPERVISOR_set_timer_op 15 73 #define __HYPERVISOR_event_channel_op_compat 16 /* compat since 0x00030202 */ 74 #define __HYPERVISOR_xen_version 17 75 #define __HYPERVISOR_console_io 18 76 #define __HYPERVISOR_physdev_op_compat 19 /* compat since 0x00030202 */ 77 #define __HYPERVISOR_grant_table_op 20 78 #define __HYPERVISOR_vm_assist 21 79 #define __HYPERVISOR_update_va_mapping_otherdomain 22 80 #define __HYPERVISOR_iret 23 /* x86 only */ 81 #define __HYPERVISOR_vcpu_op 24 82 #define __HYPERVISOR_set_segment_base 25 /* x86/64 only */ 83 #define __HYPERVISOR_mmuext_op 26 84 #define __HYPERVISOR_acm_op 27 85 #define __HYPERVISOR_nmi_op 28 86 #define __HYPERVISOR_sched_op 29 87 #define __HYPERVISOR_callback_op 30 88 #define __HYPERVISOR_xenoprof_op 31 89 #define __HYPERVISOR_event_channel_op 32 90 #define __HYPERVISOR_physdev_op 33 91 #define __HYPERVISOR_hvm_op 34 92 #define __HYPERVISOR_sysctl 35 93 #define __HYPERVISOR_domctl 36 94 #define __HYPERVISOR_kexec_op 37 95 96 /* Architecture-specific hypercall definitions. */ 97 #define __HYPERVISOR_arch_0 48 98 #define __HYPERVISOR_arch_1 49 99 #define __HYPERVISOR_arch_2 50 100 #define __HYPERVISOR_arch_3 51 101 #define __HYPERVISOR_arch_4 52 102 #define __HYPERVISOR_arch_5 53 103 #define __HYPERVISOR_arch_6 54 104 #define __HYPERVISOR_arch_7 55 105 106 /* 107 * HYPERCALL COMPATIBILITY. 108 */ 109 110 /* New sched_op hypercall introduced in 0x00030101. */ 111 #if __XEN_INTERFACE_VERSION__ < 0x00030101 112 #undef __HYPERVISOR_sched_op 113 #define __HYPERVISOR_sched_op __HYPERVISOR_sched_op_compat 114 #endif 115 116 /* New event-channel and physdev hypercalls introduced in 0x00030202. */ 117 #if __XEN_INTERFACE_VERSION__ < 0x00030202 118 #undef __HYPERVISOR_event_channel_op 119 #define __HYPERVISOR_event_channel_op __HYPERVISOR_event_channel_op_compat 120 #undef __HYPERVISOR_physdev_op 121 #define __HYPERVISOR_physdev_op __HYPERVISOR_physdev_op_compat 122 #endif 123 124 /* New platform_op hypercall introduced in 0x00030204. */ 125 #if __XEN_INTERFACE_VERSION__ < 0x00030204 126 #define __HYPERVISOR_dom0_op __HYPERVISOR_platform_op 127 #endif 128 129 /* 130 * VIRTUAL INTERRUPTS 131 * 132 * Virtual interrupts that a guest OS may receive from Xen. 133 * 134 * In the side comments, 'V.' denotes a per-VCPU VIRQ while 'G.' denotes a 135 * global VIRQ. The former can be bound once per VCPU and cannot be re-bound. 136 * The latter can be allocated only once per guest: they must initially be 137 * allocated to VCPU0 but can subsequently be re-bound. 138 */ 139 #define VIRQ_TIMER 0 /* V. Timebase update, and/or requested timeout. */ 140 #define VIRQ_DEBUG 1 /* V. Request guest to dump debug info. */ 141 #define VIRQ_CONSOLE 2 /* G. (DOM0) Bytes received on emergency console. */ 142 #define VIRQ_DOM_EXC 3 /* G. (DOM0) Exceptional event for some domain. */ 143 #define VIRQ_TBUF 4 /* G. (DOM0) Trace buffer has records available. */ 144 #define VIRQ_DEBUGGER 6 /* G. (DOM0) A domain has paused for debugging. */ 145 #define VIRQ_XENOPROF 7 /* V. XenOprofile interrupt: new sample available */ 146 #define VIRQ_CON_RING 8 /* G. (DOM0) Bytes received on console */ 147 148 /* Architecture-specific VIRQ definitions. */ 149 #define VIRQ_ARCH_0 16 150 #define VIRQ_ARCH_1 17 151 #define VIRQ_ARCH_2 18 152 #define VIRQ_ARCH_3 19 153 #define VIRQ_ARCH_4 20 154 #define VIRQ_ARCH_5 21 155 #define VIRQ_ARCH_6 22 156 #define VIRQ_ARCH_7 23 157 158 #define NR_VIRQS 24 159 160 /* 161 * MMU-UPDATE REQUESTS 162 * 163 * HYPERVISOR_mmu_update() accepts a list of (ptr, val) pairs. 164 * A foreigndom (FD) can be specified (or DOMID_SELF for none). 165 * Where the FD has some effect, it is described below. 166 * ptr[1:0] specifies the appropriate MMU_* command. 167 * 168 * ptr[1:0] == MMU_NORMAL_PT_UPDATE: 169 * Updates an entry in a page table. If updating an L1 table, and the new 170 * table entry is valid/present, the mapped frame must belong to the FD, if 171 * an FD has been specified. If attempting to map an I/O page then the 172 * caller assumes the privilege of the FD. 173 * FD == DOMID_IO: Permit /only/ I/O mappings, at the priv level of the caller. 174 * FD == DOMID_XEN: Map restricted areas of Xen's heap space. 175 * ptr[:2] -- Machine address of the page-table entry to modify. 176 * val -- Value to write. 177 * 178 * ptr[1:0] == MMU_MACHPHYS_UPDATE: 179 * Updates an entry in the machine->pseudo-physical mapping table. 180 * ptr[:2] -- Machine address within the frame whose mapping to modify. 181 * The frame must belong to the FD, if one is specified. 182 * val -- Value to write into the mapping entry. 183 */ 184 #define MMU_NORMAL_PT_UPDATE 0 /* checked '*ptr = val'. ptr is MA. */ 185 #define MMU_MACHPHYS_UPDATE 1 /* ptr = MA of frame to modify entry for */ 186 187 /* 188 * MMU EXTENDED OPERATIONS 189 * 190 * HYPERVISOR_mmuext_op() accepts a list of mmuext_op structures. 191 * A foreigndom (FD) can be specified (or DOMID_SELF for none). 192 * Where the FD has some effect, it is described below. 193 * 194 * cmd: MMUEXT_(UN)PIN_*_TABLE 195 * mfn: Machine frame number to be (un)pinned as a p.t. page. 196 * The frame must belong to the FD, if one is specified. 197 * 198 * cmd: MMUEXT_NEW_BASEPTR 199 * mfn: Machine frame number of new page-table base to install in MMU. 200 * 201 * cmd: MMUEXT_NEW_USER_BASEPTR [x86/64 only] 202 * mfn: Machine frame number of new page-table base to install in MMU 203 * when in user space. 204 * 205 * cmd: MMUEXT_TLB_FLUSH_LOCAL 206 * No additional arguments. Flushes local TLB. 207 * 208 * cmd: MMUEXT_INVLPG_LOCAL 209 * linear_addr: Linear address to be flushed from the local TLB. 210 * 211 * cmd: MMUEXT_TLB_FLUSH_MULTI 212 * vcpumask: Pointer to bitmap of VCPUs to be flushed. 213 * 214 * cmd: MMUEXT_INVLPG_MULTI 215 * linear_addr: Linear address to be flushed. 216 * vcpumask: Pointer to bitmap of VCPUs to be flushed. 217 * 218 * cmd: MMUEXT_TLB_FLUSH_ALL 219 * No additional arguments. Flushes all VCPUs' TLBs. 220 * 221 * cmd: MMUEXT_INVLPG_ALL 222 * linear_addr: Linear address to be flushed from all VCPUs' TLBs. 223 * 224 * cmd: MMUEXT_FLUSH_CACHE 225 * No additional arguments. Writes back and flushes cache contents. 226 * 227 * cmd: MMUEXT_SET_LDT 228 * linear_addr: Linear address of LDT base (NB. must be page-aligned). 229 * nr_ents: Number of entries in LDT. 230 */ 231 #define MMUEXT_PIN_L1_TABLE 0 232 #define MMUEXT_PIN_L2_TABLE 1 233 #define MMUEXT_PIN_L3_TABLE 2 234 #define MMUEXT_PIN_L4_TABLE 3 235 #define MMUEXT_UNPIN_TABLE 4 236 #define MMUEXT_NEW_BASEPTR 5 237 #define MMUEXT_TLB_FLUSH_LOCAL 6 238 #define MMUEXT_INVLPG_LOCAL 7 239 #define MMUEXT_TLB_FLUSH_MULTI 8 240 #define MMUEXT_INVLPG_MULTI 9 241 #define MMUEXT_TLB_FLUSH_ALL 10 242 #define MMUEXT_INVLPG_ALL 11 243 #define MMUEXT_FLUSH_CACHE 12 244 #define MMUEXT_SET_LDT 13 245 #define MMUEXT_NEW_USER_BASEPTR 15 246 247 #ifndef __ASSEMBLY__ 248 struct mmuext_op { 249 unsigned int cmd; 250 union { 251 /* [UN]PIN_TABLE, NEW_BASEPTR, NEW_USER_BASEPTR */ 252 xen_pfn_t mfn; 253 /* INVLPG_LOCAL, INVLPG_ALL, SET_LDT */ 254 unsigned long linear_addr; 255 } arg1; 256 union { 257 /* SET_LDT */ 258 unsigned int nr_ents; 259 /* TLB_FLUSH_MULTI, INVLPG_MULTI */ 260 XEN_GUEST_HANDLE_00030205(void) vcpumask; 261 } arg2; 262 }; 263 typedef struct mmuext_op mmuext_op_t; 264 DEFINE_XEN_GUEST_HANDLE(mmuext_op_t); 265 #endif 266 267 /* These are passed as 'flags' to update_va_mapping. They can be ORed. */ 268 /* When specifying UVMF_MULTI, also OR in a pointer to a CPU bitmap. */ 269 /* UVMF_LOCAL is merely UVMF_MULTI with a NULL bitmap pointer. */ 270 #define UVMF_NONE (0UL<<0) /* No flushing at all. */ 271 #define UVMF_TLB_FLUSH (1UL<<0) /* Flush entire TLB(s). */ 272 #define UVMF_INVLPG (2UL<<0) /* Flush only one entry. */ 273 #define UVMF_FLUSHTYPE_MASK (3UL<<0) 274 #define UVMF_MULTI (0UL<<2) /* Flush subset of TLBs. */ 275 #define UVMF_LOCAL (0UL<<2) /* Flush local TLB. */ 276 #define UVMF_ALL (1UL<<2) /* Flush all TLBs. */ 277 278 /* 279 * Commands to HYPERVISOR_console_io(). 280 */ 281 #define CONSOLEIO_write 0 282 #define CONSOLEIO_read 1 283 #define CONSOLEIO_get_device 32 284 285 /* 286 * Commands to HYPERVISOR_vm_assist(). 287 */ 288 #define VMASST_CMD_enable 0 289 #define VMASST_CMD_disable 1 290 291 /* x86/32 guests: simulate full 4GB segment limits. */ 292 #define VMASST_TYPE_4gb_segments 0 293 294 /* x86/32 guests: trap (vector 15) whenever above vmassist is used. */ 295 #define VMASST_TYPE_4gb_segments_notify 1 296 297 /* 298 * x86 guests: support writes to bottom-level PTEs. 299 * NB1. Page-directory entries cannot be written. 300 * NB2. Guest must continue to remove all writable mappings of PTEs. 301 */ 302 #define VMASST_TYPE_writable_pagetables 2 303 304 /* x86/PAE guests: support PDPTs above 4GB. */ 305 #define VMASST_TYPE_pae_extended_cr3 3 306 307 #define MAX_VMASST_TYPE 3 308 309 #ifndef __ASSEMBLY__ 310 311 typedef uint16_t domid_t; 312 313 /* Domain ids >= DOMID_FIRST_RESERVED cannot be used for ordinary domains. */ 314 #define DOMID_FIRST_RESERVED (0x7FF0U) 315 316 /* DOMID_SELF is used in certain contexts to refer to oneself. */ 317 #define DOMID_SELF (0x7FF0U) 318 319 /* 320 * DOMID_IO is used to restrict page-table updates to mapping I/O memory. 321 * Although no Foreign Domain need be specified to map I/O pages, DOMID_IO 322 * is useful to ensure that no mappings to the OS's own heap are accidentally 323 * installed. (e.g., in Linux this could cause havoc as reference counts 324 * aren't adjusted on the I/O-mapping code path). 325 * This only makes sense in MMUEXT_SET_FOREIGNDOM, but in that context can 326 * be specified by any calling domain. 327 */ 328 #define DOMID_IO (0x7FF1U) 329 330 /* 331 * DOMID_XEN is used to allow privileged domains to map restricted parts of 332 * Xen's heap space (e.g., the machine_to_phys table). 333 * This only makes sense in MMUEXT_SET_FOREIGNDOM, and is only permitted if 334 * the caller is privileged. 335 */ 336 #define DOMID_XEN (0x7FF2U) 337 338 /* 339 * Send an array of these to HYPERVISOR_mmu_update(). 340 * NB. The fields are natural pointer/address size for this architecture. 341 */ 342 struct mmu_update { 343 uint64_t ptr; /* Machine address of PTE. */ 344 uint64_t val; /* New contents of PTE. */ 345 }; 346 typedef struct mmu_update mmu_update_t; 347 DEFINE_XEN_GUEST_HANDLE(mmu_update_t); 348 349 /* 350 * Send an array of these to HYPERVISOR_multicall(). 351 * NB. The fields are natural register size for this architecture. 352 */ 353 struct multicall_entry { 354 unsigned long op, result; 355 unsigned long args[6]; 356 }; 357 typedef struct multicall_entry multicall_entry_t; 358 DEFINE_XEN_GUEST_HANDLE(multicall_entry_t); 359 360 /* 361 * Event channel endpoints per domain: 362 * 1024 if a long is 32 bits; 4096 if a long is 64 bits. 363 */ 364 #define NR_EVENT_CHANNELS (sizeof(unsigned long) * sizeof(unsigned long) * 64) 365 366 struct vcpu_time_info { 367 /* 368 * Updates to the following values are preceded and followed by an 369 * increment of 'version'. The guest can therefore detect updates by 370 * looking for changes to 'version'. If the least-significant bit of 371 * the version number is set then an update is in progress and the guest 372 * must wait to read a consistent set of values. 373 * The correct way to interact with the version number is similar to 374 * Linux's seqlock: see the implementations of read_seqbegin/read_seqretry. 375 */ 376 uint32_t version; 377 uint32_t pad0; 378 uint64_t tsc_timestamp; /* TSC at last update of time vals. */ 379 uint64_t system_time; /* Time, in nanosecs, since boot. */ 380 /* 381 * Current system time: 382 * system_time + 383 * ((((tsc - tsc_timestamp) << tsc_shift) * tsc_to_system_mul) >> 32) 384 * CPU frequency (Hz): 385 * ((10^9 << 32) / tsc_to_system_mul) >> tsc_shift 386 */ 387 uint32_t tsc_to_system_mul; 388 int8_t tsc_shift; 389 int8_t pad1[3]; 390 }; /* 32 bytes */ 391 typedef struct vcpu_time_info vcpu_time_info_t; 392 393 struct vcpu_info { 394 /* 395 * 'evtchn_upcall_pending' is written non-zero by Xen to indicate 396 * a pending notification for a particular VCPU. It is then cleared 397 * by the guest OS /before/ checking for pending work, thus avoiding 398 * a set-and-check race. Note that the mask is only accessed by Xen 399 * on the CPU that is currently hosting the VCPU. This means that the 400 * pending and mask flags can be updated by the guest without special 401 * synchronisation (i.e., no need for the x86 LOCK prefix). 402 * This may seem suboptimal because if the pending flag is set by 403 * a different CPU then an IPI may be scheduled even when the mask 404 * is set. However, note: 405 * 1. The task of 'interrupt holdoff' is covered by the per-event- 406 * channel mask bits. A 'noisy' event that is continually being 407 * triggered can be masked at source at this very precise 408 * granularity. 409 * 2. The main purpose of the per-VCPU mask is therefore to restrict 410 * reentrant execution: whether for concurrency control, or to 411 * prevent unbounded stack usage. Whatever the purpose, we expect 412 * that the mask will be asserted only for short periods at a time, 413 * and so the likelihood of a 'spurious' IPI is suitably small. 414 * The mask is read before making an event upcall to the guest: a 415 * non-zero mask therefore guarantees that the VCPU will not receive 416 * an upcall activation. The mask is cleared when the VCPU requests 417 * to block: this avoids wakeup-waiting races. 418 */ 419 uint8_t evtchn_upcall_pending; 420 uint8_t evtchn_upcall_mask; 421 unsigned long evtchn_pending_sel; 422 struct arch_vcpu_info arch; 423 struct vcpu_time_info time; 424 }; /* 64 bytes (x86) */ 425 #ifndef __XEN__ 426 typedef struct vcpu_info vcpu_info_t; 427 #endif 428 429 /* 430 * Xen/kernel shared data -- pointer provided in start_info. 431 * 432 * This structure is defined to be both smaller than a page, and the 433 * only data on the shared page, but may vary in actual size even within 434 * compatible Xen versions; guests should not rely on the size 435 * of this structure remaining constant. 436 */ 437 struct shared_info { 438 struct vcpu_info vcpu_info[MAX_VIRT_CPUS]; 439 440 /* 441 * A domain can create "event channels" on which it can send and receive 442 * asynchronous event notifications. There are three classes of event that 443 * are delivered by this mechanism: 444 * 1. Bi-directional inter- and intra-domain connections. Domains must 445 * arrange out-of-band to set up a connection (usually by allocating 446 * an unbound 'listener' port and avertising that via a storage service 447 * such as xenstore). 448 * 2. Physical interrupts. A domain with suitable hardware-access 449 * privileges can bind an event-channel port to a physical interrupt 450 * source. 451 * 3. Virtual interrupts ('events'). A domain can bind an event-channel 452 * port to a virtual interrupt source, such as the virtual-timer 453 * device or the emergency console. 454 * 455 * Event channels are addressed by a "port index". Each channel is 456 * associated with two bits of information: 457 * 1. PENDING -- notifies the domain that there is a pending notification 458 * to be processed. This bit is cleared by the guest. 459 * 2. MASK -- if this bit is clear then a 0->1 transition of PENDING 460 * will cause an asynchronous upcall to be scheduled. This bit is only 461 * updated by the guest. It is read-only within Xen. If a channel 462 * becomes pending while the channel is masked then the 'edge' is lost 463 * (i.e., when the channel is unmasked, the guest must manually handle 464 * pending notifications as no upcall will be scheduled by Xen). 465 * 466 * To expedite scanning of pending notifications, any 0->1 pending 467 * transition on an unmasked channel causes a corresponding bit in a 468 * per-vcpu selector word to be set. Each bit in the selector covers a 469 * 'C long' in the PENDING bitfield array. 470 */ 471 unsigned long evtchn_pending[sizeof(unsigned long) * 8]; 472 unsigned long evtchn_mask[sizeof(unsigned long) * 8]; 473 474 /* 475 * Wallclock time: updated only by control software. Guests should base 476 * their gettimeofday() syscall on this wallclock-base value. 477 */ 478 uint32_t wc_version; /* Version counter: see vcpu_time_info_t. */ 479 uint32_t wc_sec; /* Secs 00:00:00 UTC, Jan 1, 1970. */ 480 uint32_t wc_nsec; /* Nsecs 00:00:00 UTC, Jan 1, 1970. */ 481 482 struct arch_shared_info arch; 483 484 }; 485 #ifndef __XEN__ 486 typedef struct shared_info shared_info_t; 487 #endif 488 489 /* 490 * Start-of-day memory layout: 491 * 1. The domain is started within contiguous virtual-memory region. 492 * 2. The contiguous region ends on an aligned 4MB boundary. 493 * 3. This the order of bootstrap elements in the initial virtual region: 494 * a. relocated kernel image 495 * b. initial ram disk [mod_start, mod_len] 496 * c. list of allocated page frames [mfn_list, nr_pages] 497 * d. start_info_t structure [register ESI (x86)] 498 * e. bootstrap page tables [pt_base, CR3 (x86)] 499 * f. bootstrap stack [register ESP (x86)] 500 * 4. Bootstrap elements are packed together, but each is 4kB-aligned. 501 * 5. The initial ram disk may be omitted. 502 * 6. The list of page frames forms a contiguous 'pseudo-physical' memory 503 * layout for the domain. In particular, the bootstrap virtual-memory 504 * region is a 1:1 mapping to the first section of the pseudo-physical map. 505 * 7. All bootstrap elements are mapped read-writable for the guest OS. The 506 * only exception is the bootstrap page table, which is mapped read-only. 507 * 8. There is guaranteed to be at least 512kB padding after the final 508 * bootstrap element. If necessary, the bootstrap virtual region is 509 * extended by an extra 4MB to ensure this. 510 */ 511 512 #define MAX_GUEST_CMDLINE 1024 513 struct start_info { 514 /* THE FOLLOWING ARE FILLED IN BOTH ON INITIAL BOOT AND ON RESUME. */ 515 char magic[32]; /* "xen-<version>-<platform>". */ 516 unsigned long nr_pages; /* Total pages allocated to this domain. */ 517 unsigned long shared_info; /* MACHINE address of shared info struct. */ 518 uint32_t flags; /* SIF_xxx flags. */ 519 xen_pfn_t store_mfn; /* MACHINE page number of shared page. */ 520 uint32_t store_evtchn; /* Event channel for store communication. */ 521 union { 522 struct { 523 xen_pfn_t mfn; /* MACHINE page number of console page. */ 524 uint32_t evtchn; /* Event channel for console page. */ 525 } domU; 526 struct { 527 uint32_t info_off; /* Offset of console_info struct. */ 528 uint32_t info_size; /* Size of console_info struct from start.*/ 529 } dom0; 530 } console; 531 /* THE FOLLOWING ARE ONLY FILLED IN ON INITIAL BOOT (NOT RESUME). */ 532 unsigned long pt_base; /* VIRTUAL address of page directory. */ 533 unsigned long nr_pt_frames; /* Number of bootstrap p.t. frames. */ 534 unsigned long mfn_list; /* VIRTUAL address of page-frame list. */ 535 unsigned long mod_start; /* VIRTUAL address of pre-loaded module. */ 536 unsigned long mod_len; /* Size (bytes) of pre-loaded module. */ 537 int8_t cmd_line[MAX_GUEST_CMDLINE]; 538 }; 539 typedef struct start_info start_info_t; 540 541 /* New console union for dom0 introduced in 0x00030203. */ 542 #if __XEN_INTERFACE_VERSION__ < 0x00030203 543 #define console_mfn console.domU.mfn 544 #define console_evtchn console.domU.evtchn 545 #endif 546 547 /* These flags are passed in the 'flags' field of start_info_t. */ 548 #define SIF_PRIVILEGED (1<<0) /* Is the domain privileged? */ 549 #define SIF_INITDOMAIN (1<<1) /* Is this the initial control domain? */ 550 551 #define XEN_CONSOLE_INVALID -1 552 #define XEN_CONSOLE_COM1 0 553 #define XEN_CONSOLE_COM2 1 554 #define XEN_CONSOLE_VGA 2 555 556 typedef struct dom0_vga_console_info { 557 uint8_t video_type; /* DOM0_VGA_CONSOLE_??? */ 558 #define XEN_VGATYPE_TEXT_MODE_3 0x03 559 #define XEN_VGATYPE_VESA_LFB 0x23 560 561 union { 562 struct { 563 /* Font height, in pixels. */ 564 uint16_t font_height; 565 /* Cursor location (column, row). */ 566 uint16_t cursor_x, cursor_y; 567 /* Number of rows and columns (dimensions in characters). */ 568 uint16_t rows, columns; 569 } text_mode_3; 570 571 struct { 572 /* Width and height, in pixels. */ 573 uint16_t width, height; 574 /* Bytes per scan line. */ 575 uint16_t bytes_per_line; 576 /* Bits per pixel. */ 577 uint16_t bits_per_pixel; 578 /* LFB physical address, and size (in units of 64kB). */ 579 uint32_t lfb_base; 580 uint32_t lfb_size; 581 /* RGB mask offsets and sizes, as defined by VBE 1.2+ */ 582 uint8_t red_pos, red_size; 583 uint8_t green_pos, green_size; 584 uint8_t blue_pos, blue_size; 585 uint8_t rsvd_pos, rsvd_size; 586 } vesa_lfb; 587 } u; 588 } dom0_vga_console_info_t; 589 #define xen_vga_console_info dom0_vga_console_info 590 #define xen_vga_console_info_t dom0_vga_console_info_t 591 592 typedef uint8_t xen_domain_handle_t[16]; 593 594 /* Turn a plain number into a C unsigned long constant. */ 595 #define __mk_unsigned_long(x) x ## UL 596 #define mk_unsigned_long(x) __mk_unsigned_long(x) 597 598 DEFINE_XEN_GUEST_HANDLE(uint8_t); 599 DEFINE_XEN_GUEST_HANDLE(uint16_t); 600 DEFINE_XEN_GUEST_HANDLE(uint32_t); 601 DEFINE_XEN_GUEST_HANDLE(uint64_t); 602 603 #else /* __ASSEMBLY__ */ 604 605 /* In assembly code we cannot use C numeric constant suffixes. */ 606 #define mk_unsigned_long(x) x 607 608 #endif /* !__ASSEMBLY__ */ 609 610 /* Default definitions for macros used by domctl/sysctl. */ 611 /* 612 #if defined(__XEN__) || defined(__XEN_TOOLS__) 613 */ 614 #ifndef uint64_aligned_t 615 #define uint64_aligned_t uint64_t 616 #endif 617 #ifndef XEN_GUEST_HANDLE_64 618 #define XEN_GUEST_HANDLE_64(name) XEN_GUEST_HANDLE(name) 619 #endif 620 /* 621 #endif 622 */ 623 624 625 #endif /* __XEN_PUBLIC_XEN_H__ */ 626 627 /* 628 * Local variables: 629 * mode: C 630 * c-set-style: "BSD" 631 * c-basic-offset: 4 632 * tab-width: 4 633 * indent-tabs-mode: nil 634 * End: 635 */ 636