1 /******************************************************************************
2  * hvm/hvm_info_table.h
3  *
4  * HVM parameter and information table, written into guest memory map.
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) 2006, Keir Fraser
25  */
26 
27 #ifndef __XEN_PUBLIC_HVM_HVM_INFO_TABLE_H__
28 #define __XEN_PUBLIC_HVM_HVM_INFO_TABLE_H__
29 
30 #define HVM_INFO_PFN         0x09F
31 #define HVM_INFO_OFFSET      0x800
32 #define HVM_INFO_PADDR       ((HVM_INFO_PFN << 12) + HVM_INFO_OFFSET)
33 
34 /* Maximum we can support with current vLAPIC ID mapping. */
35 #define HVM_MAX_VCPUS        128
36 
37 /*
38  * In some cases SMP HVM guests may require knowledge of Xen's idea of vCPU ids
39  * for their vCPUs. For example, HYPERVISOR_vcpu_op and some EVTCHNOP_*
40  * hypercalls take vcpu id as a parameter. It is valid for HVM guests to assume
41  * that Xen's vCPU id always equals to ACPI (not APIC!) id in MADT table which
42  * is always present for SMP guests.
43  */
44 
45 struct hvm_info_table {
46     char        signature[8]; /* "HVM INFO" */
47     uint32_t    length;
48     uint8_t     checksum;
49 
50     /* Should firmware build APIC descriptors (APIC MADT / MP BIOS)? */
51     uint8_t     apic_mode;
52 
53     /* How many CPUs does this domain have? */
54     uint32_t    nr_vcpus;
55 
56     /*
57      * MEMORY MAP provided by HVM domain builder.
58      * Notes:
59      *  1. page_to_phys(x) = x << 12
60      *  2. If a field is zero, the corresponding range does not exist.
61      */
62     /*
63      *  0x0 to page_to_phys(low_mem_pgend)-1:
64      *    RAM below 4GB (except for VGA hole 0xA0000-0xBFFFF)
65      */
66     uint32_t    low_mem_pgend;
67     /*
68      *  page_to_phys(reserved_mem_pgstart) to 0xFFFFFFFF:
69      *    Reserved for special memory mappings
70      */
71     uint32_t    reserved_mem_pgstart;
72     /*
73      *  0x100000000 to page_to_phys(high_mem_pgend)-1:
74      *    RAM above 4GB
75      */
76     uint32_t    high_mem_pgend;
77 
78     /* Bitmap of which CPUs are online at boot time. */
79     uint8_t     vcpu_online[(HVM_MAX_VCPUS + 7)/8];
80 };
81 
82 #endif /* __XEN_PUBLIC_HVM_HVM_INFO_TABLE_H__ */
83