1 /******************************************************************************
4 * Hardware platform operations. Intended for use by domain-0 kernel.
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 (c) 2002-2006, K Fraser
27 #ifndef __XEN_PUBLIC_PLATFORM_H__
28 #define __XEN_PUBLIC_PLATFORM_H__
32 #define XENPF_INTERFACE_VERSION 0x03000001
35 * Set clock such that it would read <secs,nsecs> after 00:00:00 UTC,
36 * 1 January, 1970 if the current system time was <system_time>.
38 #define XENPF_settime 17
39 struct xenpf_settime {
45 typedef struct xenpf_settime xenpf_settime_t;
46 DEFINE_XEN_GUEST_HANDLE(xenpf_settime_t);
49 * Request memory range (@mfn, @mfn+@nr_mfns-1) to have type @type.
50 * On x86, @type is an architecture-defined MTRR memory type.
51 * On success, returns the MTRR that was used (@reg) and a handle that can
52 * be passed to XENPF_DEL_MEMTYPE to accurately tear down the new setting.
55 #define XENPF_add_memtype 31
56 struct xenpf_add_memtype {
65 typedef struct xenpf_add_memtype xenpf_add_memtype_t;
66 DEFINE_XEN_GUEST_HANDLE(xenpf_add_memtype_t);
69 * Tear down an existing memory-range type. If @handle is remembered then it
70 * should be passed in to accurately tear down the correct setting (in case
71 * of overlapping memory regions with differing types). If it is not known
72 * then @handle should be set to zero. In all cases @reg must be set.
75 #define XENPF_del_memtype 32
76 struct xenpf_del_memtype {
81 typedef struct xenpf_del_memtype xenpf_del_memtype_t;
82 DEFINE_XEN_GUEST_HANDLE(xenpf_del_memtype_t);
84 /* Read current type of an MTRR (x86-specific). */
85 #define XENPF_read_memtype 33
86 struct xenpf_read_memtype {
94 typedef struct xenpf_read_memtype xenpf_read_memtype_t;
95 DEFINE_XEN_GUEST_HANDLE(xenpf_read_memtype_t);
97 #define XENPF_microcode_update 35
98 struct xenpf_microcode_update {
100 XEN_GUEST_HANDLE(const_void) data;/* Pointer to microcode data */
101 uint32_t length; /* Length of microcode data. */
103 typedef struct xenpf_microcode_update xenpf_microcode_update_t;
104 DEFINE_XEN_GUEST_HANDLE(xenpf_microcode_update_t);
106 #define XENPF_platform_quirk 39
107 #define QUIRK_NOIRQBALANCING 1 /* Do not restrict IO-APIC RTE targets */
108 #define QUIRK_IOAPIC_BAD_REGSEL 2 /* IO-APIC REGSEL forgets its value */
109 #define QUIRK_IOAPIC_GOOD_REGSEL 3 /* IO-APIC REGSEL behaves properly */
110 struct xenpf_platform_quirk {
114 typedef struct xenpf_platform_quirk xenpf_platform_quirk_t;
115 DEFINE_XEN_GUEST_HANDLE(xenpf_platform_quirk_t);
117 #define XENPF_firmware_info 50
118 #define XEN_FW_DISK_INFO 1 /* from int 13 AH=08/41/48 */
119 #define XEN_FW_DISK_MBR_SIGNATURE 2 /* from MBR offset 0x1b8 */
120 #define XEN_FW_VBEDDC_INFO 3 /* from int 10 AX=4f15 */
121 struct xenpf_firmware_info {
128 /* Int13, Fn48: Check Extensions Present. */
129 uint8_t device; /* %dl: bios device number */
130 uint8_t version; /* %ah: major version */
131 uint16_t interface_support; /* %cx: support bitmap */
132 /* Int13, Fn08: Legacy Get Device Parameters. */
133 uint16_t legacy_max_cylinder; /* %cl[7:6]:%ch: max cyl # */
134 uint8_t legacy_max_head; /* %dh: max head # */
135 uint8_t legacy_sectors_per_track; /* %cl[5:0]: max sector # */
136 /* Int13, Fn41: Get Device Parameters (as filled into %ds:%esi). */
137 /* NB. First uint16_t of buffer must be set to buffer size. */
138 XEN_GUEST_HANDLE(void) edd_params;
139 } disk_info; /* XEN_FW_DISK_INFO */
141 uint8_t device; /* bios device number */
142 uint32_t mbr_signature; /* offset 0x1b8 in mbr */
143 } disk_mbr_signature; /* XEN_FW_DISK_MBR_SIGNATURE */
145 /* Int10, AX=4F15: Get EDID info. */
146 uint8_t capabilities;
147 uint8_t edid_transfer_time;
148 /* must refer to 128-byte buffer */
149 XEN_GUEST_HANDLE(uint8) edid;
150 } vbeddc_info; /* XEN_FW_VBEDDC_INFO */
153 typedef struct xenpf_firmware_info xenpf_firmware_info_t;
154 DEFINE_XEN_GUEST_HANDLE(xenpf_firmware_info_t);
156 #define XENPF_enter_acpi_sleep 51
157 struct xenpf_enter_acpi_sleep {
159 uint16_t pm1a_cnt_val; /* PM1a control value. */
160 uint16_t pm1b_cnt_val; /* PM1b control value. */
161 uint32_t sleep_state; /* Which state to enter (Sn). */
162 uint32_t flags; /* Must be zero. */
164 typedef struct xenpf_enter_acpi_sleep xenpf_enter_acpi_sleep_t;
165 DEFINE_XEN_GUEST_HANDLE(xenpf_enter_acpi_sleep_t);
167 #define XENPF_change_freq 52
168 struct xenpf_change_freq {
170 uint32_t flags; /* Must be zero. */
171 uint32_t cpu; /* Physical cpu. */
172 uint64_t freq; /* New frequency (Hz). */
174 typedef struct xenpf_change_freq xenpf_change_freq_t;
175 DEFINE_XEN_GUEST_HANDLE(xenpf_change_freq_t);
178 * Get idle times (nanoseconds since boot) for physical CPUs specified in the
179 * @cpumap_bitmap with range [0..@cpumap_nr_cpus-1]. The @idletime array is
180 * indexed by CPU number; only entries with the corresponding @cpumap_bitmap
181 * bit set are written to. On return, @cpumap_bitmap is modified so that any
182 * non-existent CPUs are cleared. Such CPUs have their @idletime array entry
185 #define XENPF_getidletime 53
186 struct xenpf_getidletime {
187 /* IN/OUT variables */
188 /* IN: CPUs to interrogate; OUT: subset of IN which are present */
189 XEN_GUEST_HANDLE(uint8) cpumap_bitmap;
191 /* Size of cpumap bitmap. */
192 uint32_t cpumap_nr_cpus;
193 /* Must be indexable for every cpu in cpumap_bitmap. */
194 XEN_GUEST_HANDLE(uint64) idletime;
196 /* System time when the idletime snapshots were taken. */
199 typedef struct xenpf_getidletime xenpf_getidletime_t;
200 DEFINE_XEN_GUEST_HANDLE(xenpf_getidletime_t);
202 #define XENPF_set_processor_pminfo 54
205 #define XEN_PROCESSOR_PM_CX 1
206 #define XEN_PROCESSOR_PM_PX 2
207 #define XEN_PROCESSOR_PM_TX 4
214 /* Px sub info type */
220 struct xen_power_register {
224 uint32_t access_size;
228 struct xen_processor_csd {
229 uint32_t domain; /* domain number of one dependent group */
230 uint32_t coord_type; /* coordination type */
231 uint32_t num; /* number of processors in same domain */
233 typedef struct xen_processor_csd xen_processor_csd_t;
234 DEFINE_XEN_GUEST_HANDLE(xen_processor_csd_t);
236 struct xen_processor_cx {
237 struct xen_power_register reg; /* GAS for Cx trigger register */
238 uint8_t type; /* cstate value, c0: 0, c1: 1, ... */
239 uint32_t latency; /* worst latency (ms) to enter/exit this cstate */
240 uint32_t power; /* average power consumption(mW) */
241 uint32_t dpcnt; /* number of dependency entries */
242 XEN_GUEST_HANDLE(xen_processor_csd_t) dp; /* NULL if no dependency */
244 typedef struct xen_processor_cx xen_processor_cx_t;
245 DEFINE_XEN_GUEST_HANDLE(xen_processor_cx_t);
247 struct xen_processor_flags {
248 uint32_t bm_control:1;
251 uint32_t power_setup_done:1;
252 uint32_t bm_rld_set:1;
255 struct xen_processor_power {
256 uint32_t count; /* number of C state entries in array below */
257 struct xen_processor_flags flags; /* global flags of this processor */
258 XEN_GUEST_HANDLE(xen_processor_cx_t) states; /* supported c states */
261 struct xen_pct_register {
271 struct xen_processor_px {
272 uint64_t core_frequency; /* megahertz */
273 uint64_t power; /* milliWatts */
274 uint64_t transition_latency; /* microseconds */
275 uint64_t bus_master_latency; /* microseconds */
276 uint64_t control; /* control value */
277 uint64_t status; /* success indicator */
279 typedef struct xen_processor_px xen_processor_px_t;
280 DEFINE_XEN_GUEST_HANDLE(xen_processor_px_t);
282 struct xen_psd_package {
283 uint64_t num_entries;
287 uint64_t num_processors;
290 struct xen_processor_performance {
291 uint32_t flags; /* flag for Px sub info type */
292 uint32_t platform_limit; /* Platform limitation on freq usage */
293 struct xen_pct_register control_register;
294 struct xen_pct_register status_register;
295 uint32_t state_count; /* total available performance states */
296 XEN_GUEST_HANDLE(xen_processor_px_t) states;
297 struct xen_psd_package domain_info;
298 uint32_t shared_type; /* coordination type of this processor */
300 typedef struct xen_processor_performance xen_processor_performance_t;
301 DEFINE_XEN_GUEST_HANDLE(xen_processor_performance_t);
303 struct xenpf_set_processor_pminfo {
305 uint32_t id; /* ACPI CPU ID */
306 uint32_t type; /* {XEN_PM_CX, XEN_PM_PX} */
308 struct xen_processor_power power;/* Cx: _CST/_CSD */
309 struct xen_processor_performance perf; /* Px: _PPC/_PCT/_PSS/_PSD */
312 typedef struct xenpf_set_processor_pminfo xenpf_set_processor_pminfo_t;
313 DEFINE_XEN_GUEST_HANDLE(xenpf_set_processor_pminfo_t);
315 struct xen_platform_op {
317 uint32_t interface_version; /* XENPF_INTERFACE_VERSION */
319 struct xenpf_settime settime;
320 struct xenpf_add_memtype add_memtype;
321 struct xenpf_del_memtype del_memtype;
322 struct xenpf_read_memtype read_memtype;
323 struct xenpf_microcode_update microcode;
324 struct xenpf_platform_quirk platform_quirk;
325 struct xenpf_firmware_info firmware_info;
326 struct xenpf_enter_acpi_sleep enter_acpi_sleep;
327 struct xenpf_change_freq change_freq;
328 struct xenpf_getidletime getidletime;
329 struct xenpf_set_processor_pminfo set_pminfo;
333 typedef struct xen_platform_op xen_platform_op_t;
334 DEFINE_XEN_GUEST_HANDLE(xen_platform_op_t);
336 #endif /* __XEN_PUBLIC_PLATFORM_H__ */
344 * indent-tabs-mode: nil