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__
30 #include <xen/interface/xen.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 DEFINE_GUEST_HANDLE_STRUCT(xenpf_settime_t
);
48 * Request memory range (@mfn, @mfn+@nr_mfns-1) to have type @type.
49 * On x86, @type is an architecture-defined MTRR memory type.
50 * On success, returns the MTRR that was used (@reg) and a handle that can
51 * be passed to XENPF_DEL_MEMTYPE to accurately tear down the new setting.
54 #define XENPF_add_memtype 31
55 struct xenpf_add_memtype
{
64 DEFINE_GUEST_HANDLE_STRUCT(xenpf_add_memtype_t
);
67 * Tear down an existing memory-range type. If @handle is remembered then it
68 * should be passed in to accurately tear down the correct setting (in case
69 * of overlapping memory regions with differing types). If it is not known
70 * then @handle should be set to zero. In all cases @reg must be set.
73 #define XENPF_del_memtype 32
74 struct xenpf_del_memtype
{
79 DEFINE_GUEST_HANDLE_STRUCT(xenpf_del_memtype_t
);
81 /* Read current type of an MTRR (x86-specific). */
82 #define XENPF_read_memtype 33
83 struct xenpf_read_memtype
{
91 DEFINE_GUEST_HANDLE_STRUCT(xenpf_read_memtype_t
);
93 #define XENPF_microcode_update 35
94 struct xenpf_microcode_update
{
96 GUEST_HANDLE(void) data
; /* Pointer to microcode data */
97 uint32_t length
; /* Length of microcode data. */
99 DEFINE_GUEST_HANDLE_STRUCT(xenpf_microcode_update_t
);
101 #define XENPF_platform_quirk 39
102 #define QUIRK_NOIRQBALANCING 1 /* Do not restrict IO-APIC RTE targets */
103 #define QUIRK_IOAPIC_BAD_REGSEL 2 /* IO-APIC REGSEL forgets its value */
104 #define QUIRK_IOAPIC_GOOD_REGSEL 3 /* IO-APIC REGSEL behaves properly */
105 struct xenpf_platform_quirk
{
109 DEFINE_GUEST_HANDLE_STRUCT(xenpf_platform_quirk_t
);
111 #define XENPF_firmware_info 50
112 #define XEN_FW_DISK_INFO 1 /* from int 13 AH=08/41/48 */
113 #define XEN_FW_DISK_MBR_SIGNATURE 2 /* from MBR offset 0x1b8 */
114 #define XEN_FW_VBEDDC_INFO 3 /* from int 10 AX=4f15 */
115 #define XEN_FW_KBD_SHIFT_FLAGS 5 /* Int16, Fn02: Get keyboard shift flags. */
116 struct xenpf_firmware_info
{
123 /* Int13, Fn48: Check Extensions Present. */
124 uint8_t device
; /* %dl: bios device number */
125 uint8_t version
; /* %ah: major version */
126 uint16_t interface_support
; /* %cx: support bitmap */
127 /* Int13, Fn08: Legacy Get Device Parameters. */
128 uint16_t legacy_max_cylinder
; /* %cl[7:6]:%ch: max cyl # */
129 uint8_t legacy_max_head
; /* %dh: max head # */
130 uint8_t legacy_sectors_per_track
; /* %cl[5:0]: max sector # */
131 /* Int13, Fn41: Get Device Parameters (as filled into %ds:%esi). */
132 /* NB. First uint16_t of buffer must be set to buffer size. */
133 GUEST_HANDLE(void) edd_params
;
134 } disk_info
; /* XEN_FW_DISK_INFO */
136 uint8_t device
; /* bios device number */
137 uint32_t mbr_signature
; /* offset 0x1b8 in mbr */
138 } disk_mbr_signature
; /* XEN_FW_DISK_MBR_SIGNATURE */
140 /* Int10, AX=4F15: Get EDID info. */
141 uint8_t capabilities
;
142 uint8_t edid_transfer_time
;
143 /* must refer to 128-byte buffer */
144 GUEST_HANDLE(uchar
) edid
;
145 } vbeddc_info
; /* XEN_FW_VBEDDC_INFO */
147 uint8_t kbd_shift_flags
; /* XEN_FW_KBD_SHIFT_FLAGS */
150 DEFINE_GUEST_HANDLE_STRUCT(xenpf_firmware_info_t
);
152 #define XENPF_enter_acpi_sleep 51
153 struct xenpf_enter_acpi_sleep
{
155 uint16_t pm1a_cnt_val
; /* PM1a control value. */
156 uint16_t pm1b_cnt_val
; /* PM1b control value. */
157 uint32_t sleep_state
; /* Which state to enter (Sn). */
158 uint32_t flags
; /* Must be zero. */
160 DEFINE_GUEST_HANDLE_STRUCT(xenpf_enter_acpi_sleep_t
);
162 #define XENPF_change_freq 52
163 struct xenpf_change_freq
{
165 uint32_t flags
; /* Must be zero. */
166 uint32_t cpu
; /* Physical cpu. */
167 uint64_t freq
; /* New frequency (Hz). */
169 DEFINE_GUEST_HANDLE_STRUCT(xenpf_change_freq_t
);
172 * Get idle times (nanoseconds since boot) for physical CPUs specified in the
173 * @cpumap_bitmap with range [0..@cpumap_nr_cpus-1]. The @idletime array is
174 * indexed by CPU number; only entries with the corresponding @cpumap_bitmap
175 * bit set are written to. On return, @cpumap_bitmap is modified so that any
176 * non-existent CPUs are cleared. Such CPUs have their @idletime array entry
179 #define XENPF_getidletime 53
180 struct xenpf_getidletime
{
181 /* IN/OUT variables */
182 /* IN: CPUs to interrogate; OUT: subset of IN which are present */
183 GUEST_HANDLE(uchar
) cpumap_bitmap
;
185 /* Size of cpumap bitmap. */
186 uint32_t cpumap_nr_cpus
;
187 /* Must be indexable for every cpu in cpumap_bitmap. */
188 GUEST_HANDLE(uint64_t) idletime
;
190 /* System time when the idletime snapshots were taken. */
193 DEFINE_GUEST_HANDLE_STRUCT(xenpf_getidletime_t
);
195 #define XENPF_set_processor_pminfo 54
198 #define XEN_PROCESSOR_PM_CX 1
199 #define XEN_PROCESSOR_PM_PX 2
200 #define XEN_PROCESSOR_PM_TX 4
207 /* Px sub info type */
213 struct xen_power_register
{
217 uint32_t access_size
;
221 struct xen_processor_csd
{
222 uint32_t domain
; /* domain number of one dependent group */
223 uint32_t coord_type
; /* coordination type */
224 uint32_t num
; /* number of processors in same domain */
226 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_csd
);
228 struct xen_processor_cx
{
229 struct xen_power_register reg
; /* GAS for Cx trigger register */
230 uint8_t type
; /* cstate value, c0: 0, c1: 1, ... */
231 uint32_t latency
; /* worst latency (ms) to enter/exit this cstate */
232 uint32_t power
; /* average power consumption(mW) */
233 uint32_t dpcnt
; /* number of dependency entries */
234 GUEST_HANDLE(xen_processor_csd
) dp
; /* NULL if no dependency */
236 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_cx
);
238 struct xen_processor_flags
{
239 uint32_t bm_control
:1;
242 uint32_t power_setup_done
:1;
243 uint32_t bm_rld_set
:1;
246 struct xen_processor_power
{
247 uint32_t count
; /* number of C state entries in array below */
248 struct xen_processor_flags flags
; /* global flags of this processor */
249 GUEST_HANDLE(xen_processor_cx
) states
; /* supported c states */
252 struct xen_pct_register
{
262 struct xen_processor_px
{
263 uint64_t core_frequency
; /* megahertz */
264 uint64_t power
; /* milliWatts */
265 uint64_t transition_latency
; /* microseconds */
266 uint64_t bus_master_latency
; /* microseconds */
267 uint64_t control
; /* control value */
268 uint64_t status
; /* success indicator */
270 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_px
);
272 struct xen_psd_package
{
273 uint64_t num_entries
;
277 uint64_t num_processors
;
280 struct xen_processor_performance
{
281 uint32_t flags
; /* flag for Px sub info type */
282 uint32_t platform_limit
; /* Platform limitation on freq usage */
283 struct xen_pct_register control_register
;
284 struct xen_pct_register status_register
;
285 uint32_t state_count
; /* total available performance states */
286 GUEST_HANDLE(xen_processor_px
) states
;
287 struct xen_psd_package domain_info
;
288 uint32_t shared_type
; /* coordination type of this processor */
290 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_performance
);
292 struct xenpf_set_processor_pminfo
{
294 uint32_t id
; /* ACPI CPU ID */
295 uint32_t type
; /* {XEN_PM_CX, XEN_PM_PX} */
297 struct xen_processor_power power
;/* Cx: _CST/_CSD */
298 struct xen_processor_performance perf
; /* Px: _PPC/_PCT/_PSS/_PSD */
299 GUEST_HANDLE(uint32_t) pdc
;
302 DEFINE_GUEST_HANDLE_STRUCT(xenpf_set_processor_pminfo
);
304 #define XENPF_get_cpuinfo 55
305 struct xenpf_pcpuinfo
{
309 /* The maxium cpu_id that is present */
310 uint32_t max_present
;
311 #define XEN_PCPU_FLAGS_ONLINE 1
312 /* Correponding xen_cpuid is not present*/
313 #define XEN_PCPU_FLAGS_INVALID 2
318 DEFINE_GUEST_HANDLE_STRUCT(xenpf_pcpuinfo
);
320 #define XENPF_cpu_online 56
321 #define XENPF_cpu_offline 57
322 struct xenpf_cpu_ol
{
325 DEFINE_GUEST_HANDLE_STRUCT(xenpf_cpu_ol
);
327 #define XENPF_cpu_hotadd 58
328 struct xenpf_cpu_hotadd
{
334 #define XENPF_mem_hotadd 59
335 struct xenpf_mem_hotadd
{
342 #define XENPF_core_parking 60
343 struct xenpf_core_parking
{
345 #define XEN_CORE_PARKING_SET 1
346 #define XEN_CORE_PARKING_GET 2
348 /* IN variables: set cpu nums expected to be idled */
349 /* OUT variables: get cpu nums actually be idled */
352 DEFINE_GUEST_HANDLE_STRUCT(xenpf_core_parking
);
354 struct xen_platform_op
{
356 uint32_t interface_version
; /* XENPF_INTERFACE_VERSION */
358 struct xenpf_settime settime
;
359 struct xenpf_add_memtype add_memtype
;
360 struct xenpf_del_memtype del_memtype
;
361 struct xenpf_read_memtype read_memtype
;
362 struct xenpf_microcode_update microcode
;
363 struct xenpf_platform_quirk platform_quirk
;
364 struct xenpf_firmware_info firmware_info
;
365 struct xenpf_enter_acpi_sleep enter_acpi_sleep
;
366 struct xenpf_change_freq change_freq
;
367 struct xenpf_getidletime getidletime
;
368 struct xenpf_set_processor_pminfo set_pminfo
;
369 struct xenpf_pcpuinfo pcpu_info
;
370 struct xenpf_cpu_ol cpu_ol
;
371 struct xenpf_cpu_hotadd cpu_add
;
372 struct xenpf_mem_hotadd mem_add
;
373 struct xenpf_core_parking core_parking
;
377 DEFINE_GUEST_HANDLE_STRUCT(xen_platform_op_t
);
379 #endif /* __XEN_PUBLIC_PLATFORM_H__ */