platform.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. /* SPDX-License-Identifier: MIT */
  2. /******************************************************************************
  3. * platform.h
  4. *
  5. * Hardware platform operations. Intended for use by domain-0 kernel.
  6. *
  7. * Copyright (c) 2002-2006, K Fraser
  8. */
  9. #ifndef __XEN_PUBLIC_PLATFORM_H__
  10. #define __XEN_PUBLIC_PLATFORM_H__
  11. #include <xen/interface/xen.h>
  12. #define XENPF_INTERFACE_VERSION 0x03000001
  13. /*
  14. * Set clock such that it would read <secs,nsecs> after 00:00:00 UTC,
  15. * 1 January, 1970 if the current system time was <system_time>.
  16. */
  17. #define XENPF_settime32 17
  18. struct xenpf_settime32 {
  19. /* IN variables. */
  20. uint32_t secs;
  21. uint32_t nsecs;
  22. uint64_t system_time;
  23. };
  24. DEFINE_GUEST_HANDLE_STRUCT(xenpf_settime32_t);
  25. #define XENPF_settime64 62
  26. struct xenpf_settime64 {
  27. /* IN variables. */
  28. uint64_t secs;
  29. uint32_t nsecs;
  30. uint32_t mbz;
  31. uint64_t system_time;
  32. };
  33. DEFINE_GUEST_HANDLE_STRUCT(xenpf_settime64_t);
  34. /*
  35. * Request memory range (@mfn, @mfn+@nr_mfns-1) to have type @type.
  36. * On x86, @type is an architecture-defined MTRR memory type.
  37. * On success, returns the MTRR that was used (@reg) and a handle that can
  38. * be passed to XENPF_DEL_MEMTYPE to accurately tear down the new setting.
  39. * (x86-specific).
  40. */
  41. #define XENPF_add_memtype 31
  42. struct xenpf_add_memtype {
  43. /* IN variables. */
  44. xen_pfn_t mfn;
  45. uint64_t nr_mfns;
  46. uint32_t type;
  47. /* OUT variables. */
  48. uint32_t handle;
  49. uint32_t reg;
  50. };
  51. DEFINE_GUEST_HANDLE_STRUCT(xenpf_add_memtype_t);
  52. /*
  53. * Tear down an existing memory-range type. If @handle is remembered then it
  54. * should be passed in to accurately tear down the correct setting (in case
  55. * of overlapping memory regions with differing types). If it is not known
  56. * then @handle should be set to zero. In all cases @reg must be set.
  57. * (x86-specific).
  58. */
  59. #define XENPF_del_memtype 32
  60. struct xenpf_del_memtype {
  61. /* IN variables. */
  62. uint32_t handle;
  63. uint32_t reg;
  64. };
  65. DEFINE_GUEST_HANDLE_STRUCT(xenpf_del_memtype_t);
  66. /* Read current type of an MTRR (x86-specific). */
  67. #define XENPF_read_memtype 33
  68. struct xenpf_read_memtype {
  69. /* IN variables. */
  70. uint32_t reg;
  71. /* OUT variables. */
  72. xen_pfn_t mfn;
  73. uint64_t nr_mfns;
  74. uint32_t type;
  75. };
  76. DEFINE_GUEST_HANDLE_STRUCT(xenpf_read_memtype_t);
  77. #define XENPF_microcode_update 35
  78. struct xenpf_microcode_update {
  79. /* IN variables. */
  80. GUEST_HANDLE(void) data; /* Pointer to microcode data */
  81. uint32_t length; /* Length of microcode data. */
  82. };
  83. DEFINE_GUEST_HANDLE_STRUCT(xenpf_microcode_update_t);
  84. #define XENPF_platform_quirk 39
  85. #define QUIRK_NOIRQBALANCING 1 /* Do not restrict IO-APIC RTE targets */
  86. #define QUIRK_IOAPIC_BAD_REGSEL 2 /* IO-APIC REGSEL forgets its value */
  87. #define QUIRK_IOAPIC_GOOD_REGSEL 3 /* IO-APIC REGSEL behaves properly */
  88. struct xenpf_platform_quirk {
  89. /* IN variables. */
  90. uint32_t quirk_id;
  91. };
  92. DEFINE_GUEST_HANDLE_STRUCT(xenpf_platform_quirk_t);
  93. #define XENPF_efi_runtime_call 49
  94. #define XEN_EFI_get_time 1
  95. #define XEN_EFI_set_time 2
  96. #define XEN_EFI_get_wakeup_time 3
  97. #define XEN_EFI_set_wakeup_time 4
  98. #define XEN_EFI_get_next_high_monotonic_count 5
  99. #define XEN_EFI_get_variable 6
  100. #define XEN_EFI_set_variable 7
  101. #define XEN_EFI_get_next_variable_name 8
  102. #define XEN_EFI_query_variable_info 9
  103. #define XEN_EFI_query_capsule_capabilities 10
  104. #define XEN_EFI_update_capsule 11
  105. struct xenpf_efi_runtime_call {
  106. uint32_t function;
  107. /*
  108. * This field is generally used for per sub-function flags (defined
  109. * below), except for the XEN_EFI_get_next_high_monotonic_count case,
  110. * where it holds the single returned value.
  111. */
  112. uint32_t misc;
  113. xen_ulong_t status;
  114. union {
  115. #define XEN_EFI_GET_TIME_SET_CLEARS_NS 0x00000001
  116. struct {
  117. struct xenpf_efi_time {
  118. uint16_t year;
  119. uint8_t month;
  120. uint8_t day;
  121. uint8_t hour;
  122. uint8_t min;
  123. uint8_t sec;
  124. uint32_t ns;
  125. int16_t tz;
  126. uint8_t daylight;
  127. } time;
  128. uint32_t resolution;
  129. uint32_t accuracy;
  130. } get_time;
  131. struct xenpf_efi_time set_time;
  132. #define XEN_EFI_GET_WAKEUP_TIME_ENABLED 0x00000001
  133. #define XEN_EFI_GET_WAKEUP_TIME_PENDING 0x00000002
  134. struct xenpf_efi_time get_wakeup_time;
  135. #define XEN_EFI_SET_WAKEUP_TIME_ENABLE 0x00000001
  136. #define XEN_EFI_SET_WAKEUP_TIME_ENABLE_ONLY 0x00000002
  137. struct xenpf_efi_time set_wakeup_time;
  138. #define XEN_EFI_VARIABLE_NON_VOLATILE 0x00000001
  139. #define XEN_EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
  140. #define XEN_EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
  141. struct {
  142. GUEST_HANDLE(void) name; /* UCS-2/UTF-16 string */
  143. xen_ulong_t size;
  144. GUEST_HANDLE(void) data;
  145. struct xenpf_efi_guid {
  146. uint32_t data1;
  147. uint16_t data2;
  148. uint16_t data3;
  149. uint8_t data4[8];
  150. } vendor_guid;
  151. } get_variable, set_variable;
  152. struct {
  153. xen_ulong_t size;
  154. GUEST_HANDLE(void) name; /* UCS-2/UTF-16 string */
  155. struct xenpf_efi_guid vendor_guid;
  156. } get_next_variable_name;
  157. struct {
  158. uint32_t attr;
  159. uint64_t max_store_size;
  160. uint64_t remain_store_size;
  161. uint64_t max_size;
  162. } query_variable_info;
  163. struct {
  164. GUEST_HANDLE(void) capsule_header_array;
  165. xen_ulong_t capsule_count;
  166. uint64_t max_capsule_size;
  167. uint32_t reset_type;
  168. } query_capsule_capabilities;
  169. struct {
  170. GUEST_HANDLE(void) capsule_header_array;
  171. xen_ulong_t capsule_count;
  172. uint64_t sg_list; /* machine address */
  173. } update_capsule;
  174. } u;
  175. };
  176. DEFINE_GUEST_HANDLE_STRUCT(xenpf_efi_runtime_call);
  177. #define XEN_FW_EFI_VERSION 0
  178. #define XEN_FW_EFI_CONFIG_TABLE 1
  179. #define XEN_FW_EFI_VENDOR 2
  180. #define XEN_FW_EFI_MEM_INFO 3
  181. #define XEN_FW_EFI_RT_VERSION 4
  182. #define XENPF_firmware_info 50
  183. #define XEN_FW_DISK_INFO 1 /* from int 13 AH=08/41/48 */
  184. #define XEN_FW_DISK_MBR_SIGNATURE 2 /* from MBR offset 0x1b8 */
  185. #define XEN_FW_VBEDDC_INFO 3 /* from int 10 AX=4f15 */
  186. #define XEN_FW_EFI_INFO 4 /* from EFI */
  187. #define XEN_FW_KBD_SHIFT_FLAGS 5 /* Int16, Fn02: Get keyboard shift flags. */
  188. struct xenpf_firmware_info {
  189. /* IN variables. */
  190. uint32_t type;
  191. uint32_t index;
  192. /* OUT variables. */
  193. union {
  194. struct {
  195. /* Int13, Fn48: Check Extensions Present. */
  196. uint8_t device; /* %dl: bios device number */
  197. uint8_t version; /* %ah: major version */
  198. uint16_t interface_support; /* %cx: support bitmap */
  199. /* Int13, Fn08: Legacy Get Device Parameters. */
  200. uint16_t legacy_max_cylinder; /* %cl[7:6]:%ch: max cyl # */
  201. uint8_t legacy_max_head; /* %dh: max head # */
  202. uint8_t legacy_sectors_per_track; /* %cl[5:0]: max sector # */
  203. /* Int13, Fn41: Get Device Parameters (as filled into %ds:%esi). */
  204. /* NB. First uint16_t of buffer must be set to buffer size. */
  205. GUEST_HANDLE(void) edd_params;
  206. } disk_info; /* XEN_FW_DISK_INFO */
  207. struct {
  208. uint8_t device; /* bios device number */
  209. uint32_t mbr_signature; /* offset 0x1b8 in mbr */
  210. } disk_mbr_signature; /* XEN_FW_DISK_MBR_SIGNATURE */
  211. struct {
  212. /* Int10, AX=4F15: Get EDID info. */
  213. uint8_t capabilities;
  214. uint8_t edid_transfer_time;
  215. /* must refer to 128-byte buffer */
  216. GUEST_HANDLE(uchar) edid;
  217. } vbeddc_info; /* XEN_FW_VBEDDC_INFO */
  218. union xenpf_efi_info {
  219. uint32_t version;
  220. struct {
  221. uint64_t addr; /* EFI_CONFIGURATION_TABLE */
  222. uint32_t nent;
  223. } cfg;
  224. struct {
  225. uint32_t revision;
  226. uint32_t bufsz; /* input, in bytes */
  227. GUEST_HANDLE(void) name;
  228. /* UCS-2/UTF-16 string */
  229. } vendor;
  230. struct {
  231. uint64_t addr;
  232. uint64_t size;
  233. uint64_t attr;
  234. uint32_t type;
  235. } mem;
  236. } efi_info; /* XEN_FW_EFI_INFO */
  237. uint8_t kbd_shift_flags; /* XEN_FW_KBD_SHIFT_FLAGS */
  238. } u;
  239. };
  240. DEFINE_GUEST_HANDLE_STRUCT(xenpf_firmware_info_t);
  241. #define XENPF_enter_acpi_sleep 51
  242. struct xenpf_enter_acpi_sleep {
  243. /* IN variables */
  244. uint16_t val_a; /* PM1a control / sleep type A. */
  245. uint16_t val_b; /* PM1b control / sleep type B. */
  246. uint32_t sleep_state; /* Which state to enter (Sn). */
  247. #define XENPF_ACPI_SLEEP_EXTENDED 0x00000001
  248. uint32_t flags; /* XENPF_ACPI_SLEEP_*. */
  249. };
  250. DEFINE_GUEST_HANDLE_STRUCT(xenpf_enter_acpi_sleep_t);
  251. #define XENPF_change_freq 52
  252. struct xenpf_change_freq {
  253. /* IN variables */
  254. uint32_t flags; /* Must be zero. */
  255. uint32_t cpu; /* Physical cpu. */
  256. uint64_t freq; /* New frequency (Hz). */
  257. };
  258. DEFINE_GUEST_HANDLE_STRUCT(xenpf_change_freq_t);
  259. /*
  260. * Get idle times (nanoseconds since boot) for physical CPUs specified in the
  261. * @cpumap_bitmap with range [0..@cpumap_nr_cpus-1]. The @idletime array is
  262. * indexed by CPU number; only entries with the corresponding @cpumap_bitmap
  263. * bit set are written to. On return, @cpumap_bitmap is modified so that any
  264. * non-existent CPUs are cleared. Such CPUs have their @idletime array entry
  265. * cleared.
  266. */
  267. #define XENPF_getidletime 53
  268. struct xenpf_getidletime {
  269. /* IN/OUT variables */
  270. /* IN: CPUs to interrogate; OUT: subset of IN which are present */
  271. GUEST_HANDLE(uchar) cpumap_bitmap;
  272. /* IN variables */
  273. /* Size of cpumap bitmap. */
  274. uint32_t cpumap_nr_cpus;
  275. /* Must be indexable for every cpu in cpumap_bitmap. */
  276. GUEST_HANDLE(uint64_t) idletime;
  277. /* OUT variables */
  278. /* System time when the idletime snapshots were taken. */
  279. uint64_t now;
  280. };
  281. DEFINE_GUEST_HANDLE_STRUCT(xenpf_getidletime_t);
  282. #define XENPF_set_processor_pminfo 54
  283. /* ability bits */
  284. #define XEN_PROCESSOR_PM_CX 1
  285. #define XEN_PROCESSOR_PM_PX 2
  286. #define XEN_PROCESSOR_PM_TX 4
  287. /* cmd type */
  288. #define XEN_PM_CX 0
  289. #define XEN_PM_PX 1
  290. #define XEN_PM_TX 2
  291. #define XEN_PM_PDC 3
  292. /* Px sub info type */
  293. #define XEN_PX_PCT 1
  294. #define XEN_PX_PSS 2
  295. #define XEN_PX_PPC 4
  296. #define XEN_PX_PSD 8
  297. struct xen_power_register {
  298. uint32_t space_id;
  299. uint32_t bit_width;
  300. uint32_t bit_offset;
  301. uint32_t access_size;
  302. uint64_t address;
  303. };
  304. struct xen_processor_csd {
  305. uint32_t domain; /* domain number of one dependent group */
  306. uint32_t coord_type; /* coordination type */
  307. uint32_t num; /* number of processors in same domain */
  308. };
  309. DEFINE_GUEST_HANDLE_STRUCT(xen_processor_csd);
  310. struct xen_processor_cx {
  311. struct xen_power_register reg; /* GAS for Cx trigger register */
  312. uint8_t type; /* cstate value, c0: 0, c1: 1, ... */
  313. uint32_t latency; /* worst latency (ms) to enter/exit this cstate */
  314. uint32_t power; /* average power consumption(mW) */
  315. uint32_t dpcnt; /* number of dependency entries */
  316. GUEST_HANDLE(xen_processor_csd) dp; /* NULL if no dependency */
  317. };
  318. DEFINE_GUEST_HANDLE_STRUCT(xen_processor_cx);
  319. struct xen_processor_flags {
  320. uint32_t bm_control:1;
  321. uint32_t bm_check:1;
  322. uint32_t has_cst:1;
  323. uint32_t power_setup_done:1;
  324. uint32_t bm_rld_set:1;
  325. };
  326. struct xen_processor_power {
  327. uint32_t count; /* number of C state entries in array below */
  328. struct xen_processor_flags flags; /* global flags of this processor */
  329. GUEST_HANDLE(xen_processor_cx) states; /* supported c states */
  330. };
  331. struct xen_pct_register {
  332. uint8_t descriptor;
  333. uint16_t length;
  334. uint8_t space_id;
  335. uint8_t bit_width;
  336. uint8_t bit_offset;
  337. uint8_t reserved;
  338. uint64_t address;
  339. };
  340. struct xen_processor_px {
  341. uint64_t core_frequency; /* megahertz */
  342. uint64_t power; /* milliWatts */
  343. uint64_t transition_latency; /* microseconds */
  344. uint64_t bus_master_latency; /* microseconds */
  345. uint64_t control; /* control value */
  346. uint64_t status; /* success indicator */
  347. };
  348. DEFINE_GUEST_HANDLE_STRUCT(xen_processor_px);
  349. struct xen_psd_package {
  350. uint64_t num_entries;
  351. uint64_t revision;
  352. uint64_t domain;
  353. uint64_t coord_type;
  354. uint64_t num_processors;
  355. };
  356. struct xen_processor_performance {
  357. uint32_t flags; /* flag for Px sub info type */
  358. uint32_t platform_limit; /* Platform limitation on freq usage */
  359. struct xen_pct_register control_register;
  360. struct xen_pct_register status_register;
  361. uint32_t state_count; /* total available performance states */
  362. GUEST_HANDLE(xen_processor_px) states;
  363. struct xen_psd_package domain_info;
  364. uint32_t shared_type; /* coordination type of this processor */
  365. };
  366. DEFINE_GUEST_HANDLE_STRUCT(xen_processor_performance);
  367. struct xenpf_set_processor_pminfo {
  368. /* IN variables */
  369. uint32_t id; /* ACPI CPU ID */
  370. uint32_t type; /* {XEN_PM_CX, XEN_PM_PX} */
  371. union {
  372. struct xen_processor_power power;/* Cx: _CST/_CSD */
  373. struct xen_processor_performance perf; /* Px: _PPC/_PCT/_PSS/_PSD */
  374. GUEST_HANDLE(uint32_t) pdc;
  375. };
  376. };
  377. DEFINE_GUEST_HANDLE_STRUCT(xenpf_set_processor_pminfo);
  378. #define XENPF_get_cpuinfo 55
  379. struct xenpf_pcpuinfo {
  380. /* IN */
  381. uint32_t xen_cpuid;
  382. /* OUT */
  383. /* The maxium cpu_id that is present */
  384. uint32_t max_present;
  385. #define XEN_PCPU_FLAGS_ONLINE 1
  386. /* Correponding xen_cpuid is not present*/
  387. #define XEN_PCPU_FLAGS_INVALID 2
  388. uint32_t flags;
  389. uint32_t apic_id;
  390. uint32_t acpi_id;
  391. };
  392. DEFINE_GUEST_HANDLE_STRUCT(xenpf_pcpuinfo);
  393. #define XENPF_cpu_online 56
  394. #define XENPF_cpu_offline 57
  395. struct xenpf_cpu_ol {
  396. uint32_t cpuid;
  397. };
  398. DEFINE_GUEST_HANDLE_STRUCT(xenpf_cpu_ol);
  399. #define XENPF_cpu_hotadd 58
  400. struct xenpf_cpu_hotadd {
  401. uint32_t apic_id;
  402. uint32_t acpi_id;
  403. uint32_t pxm;
  404. };
  405. #define XENPF_mem_hotadd 59
  406. struct xenpf_mem_hotadd {
  407. uint64_t spfn;
  408. uint64_t epfn;
  409. uint32_t pxm;
  410. uint32_t flags;
  411. };
  412. #define XENPF_core_parking 60
  413. struct xenpf_core_parking {
  414. /* IN variables */
  415. #define XEN_CORE_PARKING_SET 1
  416. #define XEN_CORE_PARKING_GET 2
  417. uint32_t type;
  418. /* IN variables: set cpu nums expected to be idled */
  419. /* OUT variables: get cpu nums actually be idled */
  420. uint32_t idle_nums;
  421. };
  422. DEFINE_GUEST_HANDLE_STRUCT(xenpf_core_parking);
  423. #define XENPF_get_symbol 63
  424. struct xenpf_symdata {
  425. /* IN/OUT variables */
  426. uint32_t namelen; /* size of 'name' buffer */
  427. /* IN/OUT variables */
  428. uint32_t symnum; /* IN: Symbol to read */
  429. /* OUT: Next available symbol. If same as IN */
  430. /* then we reached the end */
  431. /* OUT variables */
  432. GUEST_HANDLE(char) name;
  433. uint64_t address;
  434. char type;
  435. };
  436. DEFINE_GUEST_HANDLE_STRUCT(xenpf_symdata);
  437. #define XENPF_get_dom0_console 64
  438. struct xen_platform_op {
  439. uint32_t cmd;
  440. uint32_t interface_version; /* XENPF_INTERFACE_VERSION */
  441. union {
  442. struct xenpf_settime32 settime32;
  443. struct xenpf_settime64 settime64;
  444. struct xenpf_add_memtype add_memtype;
  445. struct xenpf_del_memtype del_memtype;
  446. struct xenpf_read_memtype read_memtype;
  447. struct xenpf_microcode_update microcode;
  448. struct xenpf_platform_quirk platform_quirk;
  449. struct xenpf_efi_runtime_call efi_runtime_call;
  450. struct xenpf_firmware_info firmware_info;
  451. struct xenpf_enter_acpi_sleep enter_acpi_sleep;
  452. struct xenpf_change_freq change_freq;
  453. struct xenpf_getidletime getidletime;
  454. struct xenpf_set_processor_pminfo set_pminfo;
  455. struct xenpf_pcpuinfo pcpu_info;
  456. struct xenpf_cpu_ol cpu_ol;
  457. struct xenpf_cpu_hotadd cpu_add;
  458. struct xenpf_mem_hotadd mem_add;
  459. struct xenpf_core_parking core_parking;
  460. struct xenpf_symdata symdata;
  461. struct dom0_vga_console_info dom0_console;
  462. uint8_t pad[128];
  463. } u;
  464. };
  465. DEFINE_GUEST_HANDLE_STRUCT(xen_platform_op_t);
  466. #endif /* __XEN_PUBLIC_PLATFORM_H__ */