1 /* SPDX-License-Identifier: MIT */
2 /******************************************************************************
5 * Hardware platform operations. Intended for use by domain-0 kernel.
7 * Copyright (c) 2002-2006, K Fraser
10 #ifndef __XEN_PUBLIC_PLATFORM_H__
11 #define __XEN_PUBLIC_PLATFORM_H__
13 #include <xen/interface/xen.h>
15 #define XENPF_INTERFACE_VERSION 0x03000001
18 * Set clock such that it would read <secs,nsecs> after 00:00:00 UTC,
19 * 1 January, 1970 if the current system time was <system_time>.
21 #define XENPF_settime32 17
22 struct xenpf_settime32 {
28 DEFINE_GUEST_HANDLE_STRUCT(xenpf_settime32_t);
29 #define XENPF_settime64 62
30 struct xenpf_settime64 {
37 DEFINE_GUEST_HANDLE_STRUCT(xenpf_settime64_t);
40 * Request memory range (@mfn, @mfn+@nr_mfns-1) to have type @type.
41 * On x86, @type is an architecture-defined MTRR memory type.
42 * On success, returns the MTRR that was used (@reg) and a handle that can
43 * be passed to XENPF_DEL_MEMTYPE to accurately tear down the new setting.
46 #define XENPF_add_memtype 31
47 struct xenpf_add_memtype {
56 DEFINE_GUEST_HANDLE_STRUCT(xenpf_add_memtype_t);
59 * Tear down an existing memory-range type. If @handle is remembered then it
60 * should be passed in to accurately tear down the correct setting (in case
61 * of overlapping memory regions with differing types). If it is not known
62 * then @handle should be set to zero. In all cases @reg must be set.
65 #define XENPF_del_memtype 32
66 struct xenpf_del_memtype {
71 DEFINE_GUEST_HANDLE_STRUCT(xenpf_del_memtype_t);
73 /* Read current type of an MTRR (x86-specific). */
74 #define XENPF_read_memtype 33
75 struct xenpf_read_memtype {
83 DEFINE_GUEST_HANDLE_STRUCT(xenpf_read_memtype_t);
85 #define XENPF_microcode_update 35
86 struct xenpf_microcode_update {
88 GUEST_HANDLE(void) data; /* Pointer to microcode data */
89 uint32_t length; /* Length of microcode data. */
91 DEFINE_GUEST_HANDLE_STRUCT(xenpf_microcode_update_t);
93 #define XENPF_platform_quirk 39
94 #define QUIRK_NOIRQBALANCING 1 /* Do not restrict IO-APIC RTE targets */
95 #define QUIRK_IOAPIC_BAD_REGSEL 2 /* IO-APIC REGSEL forgets its value */
96 #define QUIRK_IOAPIC_GOOD_REGSEL 3 /* IO-APIC REGSEL behaves properly */
97 struct xenpf_platform_quirk {
101 DEFINE_GUEST_HANDLE_STRUCT(xenpf_platform_quirk_t);
103 #define XENPF_efi_runtime_call 49
104 #define XEN_EFI_get_time 1
105 #define XEN_EFI_set_time 2
106 #define XEN_EFI_get_wakeup_time 3
107 #define XEN_EFI_set_wakeup_time 4
108 #define XEN_EFI_get_next_high_monotonic_count 5
109 #define XEN_EFI_get_variable 6
110 #define XEN_EFI_set_variable 7
111 #define XEN_EFI_get_next_variable_name 8
112 #define XEN_EFI_query_variable_info 9
113 #define XEN_EFI_query_capsule_capabilities 10
114 #define XEN_EFI_update_capsule 11
116 struct xenpf_efi_runtime_call {
119 * This field is generally used for per sub-function flags (defined
120 * below), except for the XEN_EFI_get_next_high_monotonic_count case,
121 * where it holds the single returned value.
126 #define XEN_EFI_GET_TIME_SET_CLEARS_NS 0x00000001
128 struct xenpf_efi_time {
143 struct xenpf_efi_time set_time;
145 #define XEN_EFI_GET_WAKEUP_TIME_ENABLED 0x00000001
146 #define XEN_EFI_GET_WAKEUP_TIME_PENDING 0x00000002
147 struct xenpf_efi_time get_wakeup_time;
149 #define XEN_EFI_SET_WAKEUP_TIME_ENABLE 0x00000001
150 #define XEN_EFI_SET_WAKEUP_TIME_ENABLE_ONLY 0x00000002
151 struct xenpf_efi_time set_wakeup_time;
153 #define XEN_EFI_VARIABLE_NON_VOLATILE 0x00000001
154 #define XEN_EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
155 #define XEN_EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
157 GUEST_HANDLE(void) name; /* UCS-2/UTF-16 string */
159 GUEST_HANDLE(void) data;
160 struct xenpf_efi_guid {
166 } get_variable, set_variable;
170 GUEST_HANDLE(void) name; /* UCS-2/UTF-16 string */
171 struct xenpf_efi_guid vendor_guid;
172 } get_next_variable_name;
176 uint64_t max_store_size;
177 uint64_t remain_store_size;
179 } query_variable_info;
182 GUEST_HANDLE(void) capsule_header_array;
183 xen_ulong_t capsule_count;
184 uint64_t max_capsule_size;
186 } query_capsule_capabilities;
189 GUEST_HANDLE(void) capsule_header_array;
190 xen_ulong_t capsule_count;
191 uint64_t sg_list; /* machine address */
195 DEFINE_GUEST_HANDLE_STRUCT(xenpf_efi_runtime_call);
197 #define XEN_FW_EFI_VERSION 0
198 #define XEN_FW_EFI_CONFIG_TABLE 1
199 #define XEN_FW_EFI_VENDOR 2
200 #define XEN_FW_EFI_MEM_INFO 3
201 #define XEN_FW_EFI_RT_VERSION 4
203 #define XENPF_firmware_info 50
204 #define XEN_FW_DISK_INFO 1 /* from int 13 AH=08/41/48 */
205 #define XEN_FW_DISK_MBR_SIGNATURE 2 /* from MBR offset 0x1b8 */
206 #define XEN_FW_VBEDDC_INFO 3 /* from int 10 AX=4f15 */
207 #define XEN_FW_EFI_INFO 4 /* from EFI */
208 #define XEN_FW_KBD_SHIFT_FLAGS 5 /* Int16, Fn02: Get keyboard shift flags. */
210 struct xenpf_firmware_info {
217 /* Int13, Fn48: Check Extensions Present. */
218 uint8_t device; /* %dl: bios device number */
219 uint8_t version; /* %ah: major version */
220 uint16_t interface_support; /* %cx: support bitmap */
221 /* Int13, Fn08: Legacy Get Device Parameters. */
222 uint16_t legacy_max_cylinder; /* %cl[7:6]:%ch: max cyl # */
223 uint8_t legacy_max_head; /* %dh: max head # */
224 uint8_t legacy_sectors_per_track; /* %cl[5:0]: max sector # */
225 /* Int13, Fn41: Get Device Parameters (as filled into %ds:%esi). */
226 /* NB. First uint16_t of buffer must be set to buffer size. */
227 GUEST_HANDLE(void) edd_params;
228 } disk_info; /* XEN_FW_DISK_INFO */
230 uint8_t device; /* bios device number */
231 uint32_t mbr_signature; /* offset 0x1b8 in mbr */
232 } disk_mbr_signature; /* XEN_FW_DISK_MBR_SIGNATURE */
234 /* Int10, AX=4F15: Get EDID info. */
235 uint8_t capabilities;
236 uint8_t edid_transfer_time;
237 /* must refer to 128-byte buffer */
238 GUEST_HANDLE(uchar) edid;
239 } vbeddc_info; /* XEN_FW_VBEDDC_INFO */
241 union xenpf_efi_info {
244 uint64_t addr; /* EFI_CONFIGURATION_TABLE */
249 uint32_t bufsz; /* input, in bytes */
250 GUEST_HANDLE(void) name;
251 /* UCS-2/UTF-16 string */
259 } efi_info; /* XEN_FW_EFI_INFO */
261 uint8_t kbd_shift_flags; /* XEN_FW_KBD_SHIFT_FLAGS */
264 DEFINE_GUEST_HANDLE_STRUCT(xenpf_firmware_info_t);
266 #define XENPF_enter_acpi_sleep 51
267 struct xenpf_enter_acpi_sleep {
269 uint16_t val_a; /* PM1a control / sleep type A. */
270 uint16_t val_b; /* PM1b control / sleep type B. */
271 uint32_t sleep_state; /* Which state to enter (Sn). */
272 #define XENPF_ACPI_SLEEP_EXTENDED 0x00000001
273 uint32_t flags; /* XENPF_ACPI_SLEEP_*. */
275 DEFINE_GUEST_HANDLE_STRUCT(xenpf_enter_acpi_sleep_t);
277 #define XENPF_change_freq 52
278 struct xenpf_change_freq {
280 uint32_t flags; /* Must be zero. */
281 uint32_t cpu; /* Physical cpu. */
282 uint64_t freq; /* New frequency (Hz). */
284 DEFINE_GUEST_HANDLE_STRUCT(xenpf_change_freq_t);
287 * Get idle times (nanoseconds since boot) for physical CPUs specified in the
288 * @cpumap_bitmap with range [0..@cpumap_nr_cpus-1]. The @idletime array is
289 * indexed by CPU number; only entries with the corresponding @cpumap_bitmap
290 * bit set are written to. On return, @cpumap_bitmap is modified so that any
291 * non-existent CPUs are cleared. Such CPUs have their @idletime array entry
294 #define XENPF_getidletime 53
295 struct xenpf_getidletime {
296 /* IN/OUT variables */
297 /* IN: CPUs to interrogate; OUT: subset of IN which are present */
298 GUEST_HANDLE(uchar) cpumap_bitmap;
300 /* Size of cpumap bitmap. */
301 uint32_t cpumap_nr_cpus;
302 /* Must be indexable for every cpu in cpumap_bitmap. */
303 GUEST_HANDLE(uint64_t) idletime;
305 /* System time when the idletime snapshots were taken. */
308 DEFINE_GUEST_HANDLE_STRUCT(xenpf_getidletime_t);
310 #define XENPF_set_processor_pminfo 54
313 #define XEN_PROCESSOR_PM_CX 1
314 #define XEN_PROCESSOR_PM_PX 2
315 #define XEN_PROCESSOR_PM_TX 4
322 /* Px sub info type */
328 struct xen_power_register {
332 uint32_t access_size;
336 struct xen_processor_csd {
337 uint32_t domain; /* domain number of one dependent group */
338 uint32_t coord_type; /* coordination type */
339 uint32_t num; /* number of processors in same domain */
341 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_csd);
343 struct xen_processor_cx {
344 struct xen_power_register reg; /* GAS for Cx trigger register */
345 uint8_t type; /* cstate value, c0: 0, c1: 1, ... */
346 uint32_t latency; /* worst latency (ms) to enter/exit this cstate */
347 uint32_t power; /* average power consumption(mW) */
348 uint32_t dpcnt; /* number of dependency entries */
349 GUEST_HANDLE(xen_processor_csd) dp; /* NULL if no dependency */
351 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_cx);
353 struct xen_processor_flags {
354 uint32_t bm_control:1;
357 uint32_t power_setup_done:1;
358 uint32_t bm_rld_set:1;
361 struct xen_processor_power {
362 uint32_t count; /* number of C state entries in array below */
363 struct xen_processor_flags flags; /* global flags of this processor */
364 GUEST_HANDLE(xen_processor_cx) states; /* supported c states */
367 struct xen_pct_register {
377 struct xen_processor_px {
378 uint64_t core_frequency; /* megahertz */
379 uint64_t power; /* milliWatts */
380 uint64_t transition_latency; /* microseconds */
381 uint64_t bus_master_latency; /* microseconds */
382 uint64_t control; /* control value */
383 uint64_t status; /* success indicator */
385 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_px);
387 struct xen_psd_package {
388 uint64_t num_entries;
392 uint64_t num_processors;
395 struct xen_processor_performance {
396 uint32_t flags; /* flag for Px sub info type */
397 uint32_t platform_limit; /* Platform limitation on freq usage */
398 struct xen_pct_register control_register;
399 struct xen_pct_register status_register;
400 uint32_t state_count; /* total available performance states */
401 GUEST_HANDLE(xen_processor_px) states;
402 struct xen_psd_package domain_info;
403 uint32_t shared_type; /* coordination type of this processor */
405 DEFINE_GUEST_HANDLE_STRUCT(xen_processor_performance);
407 struct xenpf_set_processor_pminfo {
409 uint32_t id; /* ACPI CPU ID */
410 uint32_t type; /* {XEN_PM_CX, XEN_PM_PX} */
412 struct xen_processor_power power;/* Cx: _CST/_CSD */
413 struct xen_processor_performance perf; /* Px: _PPC/_PCT/_PSS/_PSD */
414 GUEST_HANDLE(uint32_t) pdc;
417 DEFINE_GUEST_HANDLE_STRUCT(xenpf_set_processor_pminfo);
419 #define XENPF_get_cpuinfo 55
420 struct xenpf_pcpuinfo {
424 /* The maxium cpu_id that is present */
425 uint32_t max_present;
426 #define XEN_PCPU_FLAGS_ONLINE 1
427 /* Correponding xen_cpuid is not present*/
428 #define XEN_PCPU_FLAGS_INVALID 2
433 DEFINE_GUEST_HANDLE_STRUCT(xenpf_pcpuinfo);
435 #define XENPF_cpu_online 56
436 #define XENPF_cpu_offline 57
437 struct xenpf_cpu_ol {
440 DEFINE_GUEST_HANDLE_STRUCT(xenpf_cpu_ol);
442 #define XENPF_cpu_hotadd 58
443 struct xenpf_cpu_hotadd {
449 #define XENPF_mem_hotadd 59
450 struct xenpf_mem_hotadd {
457 #define XENPF_core_parking 60
458 struct xenpf_core_parking {
460 #define XEN_CORE_PARKING_SET 1
461 #define XEN_CORE_PARKING_GET 2
463 /* IN variables: set cpu nums expected to be idled */
464 /* OUT variables: get cpu nums actually be idled */
467 DEFINE_GUEST_HANDLE_STRUCT(xenpf_core_parking);
469 #define XENPF_get_symbol 63
470 struct xenpf_symdata {
471 /* IN/OUT variables */
472 uint32_t namelen; /* size of 'name' buffer */
474 /* IN/OUT variables */
475 uint32_t symnum; /* IN: Symbol to read */
476 /* OUT: Next available symbol. If same as IN */
477 /* then we reached the end */
480 GUEST_HANDLE(char) name;
484 DEFINE_GUEST_HANDLE_STRUCT(xenpf_symdata);
486 #define XENPF_get_dom0_console 64
488 struct xen_platform_op {
490 uint32_t interface_version; /* XENPF_INTERFACE_VERSION */
492 struct xenpf_settime32 settime32;
493 struct xenpf_settime64 settime64;
494 struct xenpf_add_memtype add_memtype;
495 struct xenpf_del_memtype del_memtype;
496 struct xenpf_read_memtype read_memtype;
497 struct xenpf_microcode_update microcode;
498 struct xenpf_platform_quirk platform_quirk;
499 struct xenpf_efi_runtime_call efi_runtime_call;
500 struct xenpf_firmware_info firmware_info;
501 struct xenpf_enter_acpi_sleep enter_acpi_sleep;
502 struct xenpf_change_freq change_freq;
503 struct xenpf_getidletime getidletime;
504 struct xenpf_set_processor_pminfo set_pminfo;
505 struct xenpf_pcpuinfo pcpu_info;
506 struct xenpf_cpu_ol cpu_ol;
507 struct xenpf_cpu_hotadd cpu_add;
508 struct xenpf_mem_hotadd mem_add;
509 struct xenpf_core_parking core_parking;
510 struct xenpf_symdata symdata;
511 struct dom0_vga_console_info dom0_console;
515 DEFINE_GUEST_HANDLE_STRUCT(xen_platform_op_t);
517 #endif /* __XEN_PUBLIC_PLATFORM_H__ */