ACPI: Add definitions for the SPCR table
[qemu.git] / include / hw / acpi / acpi-defs.h
blob7b4bfb749471756cea567713e9f449e67db064f2
1 /*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License along
13 * with this program; if not, see <http://www.gnu.org/licenses/>.
15 #ifndef QEMU_ACPI_DEFS_H
16 #define QEMU_ACPI_DEFS_H
18 enum {
19 ACPI_FADT_F_WBINVD,
20 ACPI_FADT_F_WBINVD_FLUSH,
21 ACPI_FADT_F_PROC_C1,
22 ACPI_FADT_F_P_LVL2_UP,
23 ACPI_FADT_F_PWR_BUTTON,
24 ACPI_FADT_F_SLP_BUTTON,
25 ACPI_FADT_F_FIX_RTC,
26 ACPI_FADT_F_RTC_S4,
27 ACPI_FADT_F_TMR_VAL_EXT,
28 ACPI_FADT_F_DCK_CAP,
29 ACPI_FADT_F_RESET_REG_SUP,
30 ACPI_FADT_F_SEALED_CASE,
31 ACPI_FADT_F_HEADLESS,
32 ACPI_FADT_F_CPU_SW_SLP,
33 ACPI_FADT_F_PCI_EXP_WAK,
34 ACPI_FADT_F_USE_PLATFORM_CLOCK,
35 ACPI_FADT_F_S4_RTC_STS_VALID,
36 ACPI_FADT_F_REMOTE_POWER_ON_CAPABLE,
37 ACPI_FADT_F_FORCE_APIC_CLUSTER_MODEL,
38 ACPI_FADT_F_FORCE_APIC_PHYSICAL_DESTINATION_MODE,
39 ACPI_FADT_F_HW_REDUCED_ACPI,
40 ACPI_FADT_F_LOW_POWER_S0_IDLE_CAPABLE,
44 * ACPI 2.0 Generic Address Space definition.
46 struct Acpi20GenericAddress {
47 uint8_t address_space_id;
48 uint8_t register_bit_width;
49 uint8_t register_bit_offset;
50 uint8_t reserved;
51 uint64_t address;
52 } QEMU_PACKED;
53 typedef struct Acpi20GenericAddress Acpi20GenericAddress;
55 struct AcpiRsdpDescriptor { /* Root System Descriptor Pointer */
56 uint64_t signature; /* ACPI signature, contains "RSD PTR " */
57 uint8_t checksum; /* To make sum of struct == 0 */
58 uint8_t oem_id [6]; /* OEM identification */
59 uint8_t revision; /* Must be 0 for 1.0, 2 for 2.0 */
60 uint32_t rsdt_physical_address; /* 32-bit physical address of RSDT */
61 uint32_t length; /* XSDT Length in bytes including hdr */
62 uint64_t xsdt_physical_address; /* 64-bit physical address of XSDT */
63 uint8_t extended_checksum; /* Checksum of entire table */
64 uint8_t reserved [3]; /* Reserved field must be 0 */
65 } QEMU_PACKED;
66 typedef struct AcpiRsdpDescriptor AcpiRsdpDescriptor;
68 /* Table structure from Linux kernel (the ACPI tables are under the
69 BSD license) */
72 #define ACPI_TABLE_HEADER_DEF /* ACPI common table header */ \
73 uint32_t signature; /* ACPI signature (4 ASCII characters) */ \
74 uint32_t length; /* Length of table, in bytes, including header */ \
75 uint8_t revision; /* ACPI Specification minor version # */ \
76 uint8_t checksum; /* To make sum of entire table == 0 */ \
77 uint8_t oem_id [6]; /* OEM identification */ \
78 uint8_t oem_table_id [8]; /* OEM table identification */ \
79 uint32_t oem_revision; /* OEM revision number */ \
80 uint8_t asl_compiler_id [4]; /* ASL compiler vendor ID */ \
81 uint32_t asl_compiler_revision; /* ASL compiler revision number */
84 struct AcpiTableHeader /* ACPI common table header */
86 ACPI_TABLE_HEADER_DEF
87 } QEMU_PACKED;
88 typedef struct AcpiTableHeader AcpiTableHeader;
91 * ACPI Fixed ACPI Description Table (FADT)
93 #define ACPI_FADT_COMMON_DEF /* FADT common definition */ \
94 ACPI_TABLE_HEADER_DEF /* ACPI common table header */ \
95 uint32_t firmware_ctrl; /* Physical address of FACS */ \
96 uint32_t dsdt; /* Physical address of DSDT */ \
97 uint8_t model; /* System Interrupt Model */ \
98 uint8_t reserved1; /* Reserved */ \
99 uint16_t sci_int; /* System vector of SCI interrupt */ \
100 uint32_t smi_cmd; /* Port address of SMI command port */ \
101 uint8_t acpi_enable; /* Value to write to smi_cmd to enable ACPI */ \
102 uint8_t acpi_disable; /* Value to write to smi_cmd to disable ACPI */ \
103 /* Value to write to SMI CMD to enter S4BIOS state */ \
104 uint8_t S4bios_req; \
105 uint8_t reserved2; /* Reserved - must be zero */ \
106 /* Port address of Power Mgt 1a acpi_event Reg Blk */ \
107 uint32_t pm1a_evt_blk; \
108 /* Port address of Power Mgt 1b acpi_event Reg Blk */ \
109 uint32_t pm1b_evt_blk; \
110 uint32_t pm1a_cnt_blk; /* Port address of Power Mgt 1a Control Reg Blk */ \
111 uint32_t pm1b_cnt_blk; /* Port address of Power Mgt 1b Control Reg Blk */ \
112 uint32_t pm2_cnt_blk; /* Port address of Power Mgt 2 Control Reg Blk */ \
113 uint32_t pm_tmr_blk; /* Port address of Power Mgt Timer Ctrl Reg Blk */ \
114 /* Port addr of General Purpose acpi_event 0 Reg Blk */ \
115 uint32_t gpe0_blk; \
116 /* Port addr of General Purpose acpi_event 1 Reg Blk */ \
117 uint32_t gpe1_blk; \
118 uint8_t pm1_evt_len; /* Byte length of ports at pm1_x_evt_blk */ \
119 uint8_t pm1_cnt_len; /* Byte length of ports at pm1_x_cnt_blk */ \
120 uint8_t pm2_cnt_len; /* Byte Length of ports at pm2_cnt_blk */ \
121 uint8_t pm_tmr_len; /* Byte Length of ports at pm_tm_blk */ \
122 uint8_t gpe0_blk_len; /* Byte Length of ports at gpe0_blk */ \
123 uint8_t gpe1_blk_len; /* Byte Length of ports at gpe1_blk */ \
124 uint8_t gpe1_base; /* Offset in gpe model where gpe1 events start */ \
125 uint8_t reserved3; /* Reserved */ \
126 uint16_t plvl2_lat; /* Worst case HW latency to enter/exit C2 state */ \
127 uint16_t plvl3_lat; /* Worst case HW latency to enter/exit C3 state */ \
128 uint16_t flush_size; /* Size of area read to flush caches */ \
129 uint16_t flush_stride; /* Stride used in flushing caches */ \
130 uint8_t duty_offset; /* Bit location of duty cycle field in p_cnt reg */ \
131 uint8_t duty_width; /* Bit width of duty cycle field in p_cnt reg */ \
132 uint8_t day_alrm; /* Index to day-of-month alarm in RTC CMOS RAM */ \
133 uint8_t mon_alrm; /* Index to month-of-year alarm in RTC CMOS RAM */ \
134 uint8_t century; /* Index to century in RTC CMOS RAM */
136 struct AcpiFadtDescriptorRev1
138 ACPI_FADT_COMMON_DEF
139 uint8_t reserved4; /* Reserved */
140 uint8_t reserved4a; /* Reserved */
141 uint8_t reserved4b; /* Reserved */
142 uint32_t flags;
143 } QEMU_PACKED;
144 typedef struct AcpiFadtDescriptorRev1 AcpiFadtDescriptorRev1;
146 struct AcpiGenericAddress {
147 uint8_t space_id; /* Address space where struct or register exists */
148 uint8_t bit_width; /* Size in bits of given register */
149 uint8_t bit_offset; /* Bit offset within the register */
150 uint8_t access_width; /* Minimum Access size (ACPI 3.0) */
151 uint64_t address; /* 64-bit address of struct or register */
152 } QEMU_PACKED;
154 struct AcpiFadtDescriptorRev5_1 {
155 ACPI_FADT_COMMON_DEF
156 /* IA-PC Boot Architecture Flags (see below for individual flags) */
157 uint16_t boot_flags;
158 uint8_t reserved; /* Reserved, must be zero */
159 /* Miscellaneous flag bits (see below for individual flags) */
160 uint32_t flags;
161 /* 64-bit address of the Reset register */
162 struct AcpiGenericAddress reset_register;
163 /* Value to write to the reset_register port to reset the system */
164 uint8_t reset_value;
165 /* ARM-Specific Boot Flags (see below for individual flags) (ACPI 5.1) */
166 uint16_t arm_boot_flags;
167 uint8_t minor_revision; /* FADT Minor Revision (ACPI 5.1) */
168 uint64_t Xfacs; /* 64-bit physical address of FACS */
169 uint64_t Xdsdt; /* 64-bit physical address of DSDT */
170 /* 64-bit Extended Power Mgt 1a Event Reg Blk address */
171 struct AcpiGenericAddress xpm1a_event_block;
172 /* 64-bit Extended Power Mgt 1b Event Reg Blk address */
173 struct AcpiGenericAddress xpm1b_event_block;
174 /* 64-bit Extended Power Mgt 1a Control Reg Blk address */
175 struct AcpiGenericAddress xpm1a_control_block;
176 /* 64-bit Extended Power Mgt 1b Control Reg Blk address */
177 struct AcpiGenericAddress xpm1b_control_block;
178 /* 64-bit Extended Power Mgt 2 Control Reg Blk address */
179 struct AcpiGenericAddress xpm2_control_block;
180 /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */
181 struct AcpiGenericAddress xpm_timer_block;
182 /* 64-bit Extended General Purpose Event 0 Reg Blk address */
183 struct AcpiGenericAddress xgpe0_block;
184 /* 64-bit Extended General Purpose Event 1 Reg Blk address */
185 struct AcpiGenericAddress xgpe1_block;
186 /* 64-bit Sleep Control register (ACPI 5.0) */
187 struct AcpiGenericAddress sleep_control;
188 /* 64-bit Sleep Status register (ACPI 5.0) */
189 struct AcpiGenericAddress sleep_status;
190 } QEMU_PACKED;
192 typedef struct AcpiFadtDescriptorRev5_1 AcpiFadtDescriptorRev5_1;
194 enum {
195 ACPI_FADT_ARM_USE_PSCI_G_0_2 = 0,
196 ACPI_FADT_ARM_PSCI_USE_HVC = 1,
200 * Serial Port Console Redirection Table (SPCR), Rev. 1.02
202 * For .interface_type see Debug Port Table 2 (DBG2) serial port
203 * subtypes in Table 3, Rev. May 22, 2012
205 struct AcpiSerialPortConsoleRedirection {
206 ACPI_TABLE_HEADER_DEF
207 uint8_t interface_type;
208 uint8_t reserved1[3];
209 struct AcpiGenericAddress base_address;
210 uint8_t interrupt_types;
211 uint8_t irq;
212 uint32_t gsi;
213 uint8_t baud;
214 uint8_t parity;
215 uint8_t stopbits;
216 uint8_t flowctrl;
217 uint8_t term_type;
218 uint8_t reserved2;
219 uint16_t pci_device_id;
220 uint16_t pci_vendor_id;
221 uint8_t pci_bus;
222 uint8_t pci_slot;
223 uint8_t pci_func;
224 uint32_t pci_flags;
225 uint8_t pci_seg;
226 uint32_t reserved3;
227 } QEMU_PACKED;
228 typedef struct AcpiSerialPortConsoleRedirection
229 AcpiSerialPortConsoleRedirection;
232 * ACPI 1.0 Root System Description Table (RSDT)
234 struct AcpiRsdtDescriptorRev1
236 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
237 uint32_t table_offset_entry[0]; /* Array of pointers to other */
238 /* ACPI tables */
239 } QEMU_PACKED;
240 typedef struct AcpiRsdtDescriptorRev1 AcpiRsdtDescriptorRev1;
243 * ACPI 1.0 Firmware ACPI Control Structure (FACS)
245 struct AcpiFacsDescriptorRev1
247 uint32_t signature; /* ACPI Signature */
248 uint32_t length; /* Length of structure, in bytes */
249 uint32_t hardware_signature; /* Hardware configuration signature */
250 uint32_t firmware_waking_vector; /* ACPI OS waking vector */
251 uint32_t global_lock; /* Global Lock */
252 uint32_t flags;
253 uint8_t resverved3 [40]; /* Reserved - must be zero */
254 } QEMU_PACKED;
255 typedef struct AcpiFacsDescriptorRev1 AcpiFacsDescriptorRev1;
258 * Differentiated System Description Table (DSDT)
262 * MADT values and structures
265 /* Values for MADT PCATCompat */
267 #define ACPI_DUAL_PIC 0
268 #define ACPI_MULTIPLE_APIC 1
270 /* Master MADT */
272 struct AcpiMultipleApicTable
274 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
275 uint32_t local_apic_address; /* Physical address of local APIC */
276 uint32_t flags;
277 } QEMU_PACKED;
278 typedef struct AcpiMultipleApicTable AcpiMultipleApicTable;
280 /* Values for Type in APIC sub-headers */
282 #define ACPI_APIC_PROCESSOR 0
283 #define ACPI_APIC_IO 1
284 #define ACPI_APIC_XRUPT_OVERRIDE 2
285 #define ACPI_APIC_NMI 3
286 #define ACPI_APIC_LOCAL_NMI 4
287 #define ACPI_APIC_ADDRESS_OVERRIDE 5
288 #define ACPI_APIC_IO_SAPIC 6
289 #define ACPI_APIC_LOCAL_SAPIC 7
290 #define ACPI_APIC_XRUPT_SOURCE 8
291 #define ACPI_APIC_LOCAL_X2APIC 9
292 #define ACPI_APIC_LOCAL_X2APIC_NMI 10
293 #define ACPI_APIC_GENERIC_INTERRUPT 11
294 #define ACPI_APIC_GENERIC_DISTRIBUTOR 12
295 #define ACPI_APIC_GENERIC_MSI_FRAME 13
296 #define ACPI_APIC_GENERIC_REDISTRIBUTOR 14
297 #define ACPI_APIC_RESERVED 15 /* 15 and greater are reserved */
300 * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE)
302 #define ACPI_SUB_HEADER_DEF /* Common ACPI sub-structure header */\
303 uint8_t type; \
304 uint8_t length;
306 /* Sub-structures for MADT */
308 struct AcpiMadtProcessorApic
310 ACPI_SUB_HEADER_DEF
311 uint8_t processor_id; /* ACPI processor id */
312 uint8_t local_apic_id; /* Processor's local APIC id */
313 uint32_t flags;
314 } QEMU_PACKED;
315 typedef struct AcpiMadtProcessorApic AcpiMadtProcessorApic;
317 struct AcpiMadtIoApic
319 ACPI_SUB_HEADER_DEF
320 uint8_t io_apic_id; /* I/O APIC ID */
321 uint8_t reserved; /* Reserved - must be zero */
322 uint32_t address; /* APIC physical address */
323 uint32_t interrupt; /* Global system interrupt where INTI
324 * lines start */
325 } QEMU_PACKED;
326 typedef struct AcpiMadtIoApic AcpiMadtIoApic;
328 struct AcpiMadtIntsrcovr {
329 ACPI_SUB_HEADER_DEF
330 uint8_t bus;
331 uint8_t source;
332 uint32_t gsi;
333 uint16_t flags;
334 } QEMU_PACKED;
335 typedef struct AcpiMadtIntsrcovr AcpiMadtIntsrcovr;
337 struct AcpiMadtLocalNmi {
338 ACPI_SUB_HEADER_DEF
339 uint8_t processor_id; /* ACPI processor id */
340 uint16_t flags; /* MPS INTI flags */
341 uint8_t lint; /* Local APIC LINT# */
342 } QEMU_PACKED;
343 typedef struct AcpiMadtLocalNmi AcpiMadtLocalNmi;
345 struct AcpiMadtGenericInterrupt {
346 ACPI_SUB_HEADER_DEF
347 uint16_t reserved;
348 uint32_t cpu_interface_number;
349 uint32_t uid;
350 uint32_t flags;
351 uint32_t parking_version;
352 uint32_t performance_interrupt;
353 uint64_t parked_address;
354 uint64_t base_address;
355 uint64_t gicv_base_address;
356 uint64_t gich_base_address;
357 uint32_t vgic_interrupt;
358 uint64_t gicr_base_address;
359 uint64_t arm_mpidr;
360 } QEMU_PACKED;
362 typedef struct AcpiMadtGenericInterrupt AcpiMadtGenericInterrupt;
364 struct AcpiMadtGenericDistributor {
365 ACPI_SUB_HEADER_DEF
366 uint16_t reserved;
367 uint32_t gic_id;
368 uint64_t base_address;
369 uint32_t global_irq_base;
370 uint32_t reserved2;
371 } QEMU_PACKED;
373 typedef struct AcpiMadtGenericDistributor AcpiMadtGenericDistributor;
376 * Generic Timer Description Table (GTDT)
379 #define ACPI_GTDT_INTERRUPT_MODE (1 << 0)
380 #define ACPI_GTDT_INTERRUPT_POLARITY (1 << 1)
381 #define ACPI_GTDT_ALWAYS_ON (1 << 2)
383 /* Triggering */
385 #define ACPI_LEVEL_SENSITIVE ((uint8_t) 0x00)
386 #define ACPI_EDGE_SENSITIVE ((uint8_t) 0x01)
388 /* Polarity */
390 #define ACPI_ACTIVE_HIGH ((uint8_t) 0x00)
391 #define ACPI_ACTIVE_LOW ((uint8_t) 0x01)
392 #define ACPI_ACTIVE_BOTH ((uint8_t) 0x02)
394 struct AcpiGenericTimerTable {
395 ACPI_TABLE_HEADER_DEF
396 uint64_t counter_block_addresss;
397 uint32_t reserved;
398 uint32_t secure_el1_interrupt;
399 uint32_t secure_el1_flags;
400 uint32_t non_secure_el1_interrupt;
401 uint32_t non_secure_el1_flags;
402 uint32_t virtual_timer_interrupt;
403 uint32_t virtual_timer_flags;
404 uint32_t non_secure_el2_interrupt;
405 uint32_t non_secure_el2_flags;
406 uint64_t counter_read_block_address;
407 uint32_t platform_timer_count;
408 uint32_t platform_timer_offset;
409 } QEMU_PACKED;
410 typedef struct AcpiGenericTimerTable AcpiGenericTimerTable;
413 * HPET Description Table
415 struct Acpi20Hpet {
416 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
417 uint32_t timer_block_id;
418 Acpi20GenericAddress addr;
419 uint8_t hpet_number;
420 uint16_t min_tick;
421 uint8_t page_protect;
422 } QEMU_PACKED;
423 typedef struct Acpi20Hpet Acpi20Hpet;
426 * SRAT (NUMA topology description) table
429 struct AcpiSystemResourceAffinityTable
431 ACPI_TABLE_HEADER_DEF
432 uint32_t reserved1;
433 uint32_t reserved2[2];
434 } QEMU_PACKED;
435 typedef struct AcpiSystemResourceAffinityTable AcpiSystemResourceAffinityTable;
437 #define ACPI_SRAT_PROCESSOR 0
438 #define ACPI_SRAT_MEMORY 1
440 struct AcpiSratProcessorAffinity
442 ACPI_SUB_HEADER_DEF
443 uint8_t proximity_lo;
444 uint8_t local_apic_id;
445 uint32_t flags;
446 uint8_t local_sapic_eid;
447 uint8_t proximity_hi[3];
448 uint32_t reserved;
449 } QEMU_PACKED;
450 typedef struct AcpiSratProcessorAffinity AcpiSratProcessorAffinity;
452 struct AcpiSratMemoryAffinity
454 ACPI_SUB_HEADER_DEF
455 uint8_t proximity[4];
456 uint16_t reserved1;
457 uint64_t base_addr;
458 uint64_t range_length;
459 uint32_t reserved2;
460 uint32_t flags;
461 uint32_t reserved3[2];
462 } QEMU_PACKED;
463 typedef struct AcpiSratMemoryAffinity AcpiSratMemoryAffinity;
465 /* PCI fw r3.0 MCFG table. */
466 /* Subtable */
467 struct AcpiMcfgAllocation {
468 uint64_t address; /* Base address, processor-relative */
469 uint16_t pci_segment; /* PCI segment group number */
470 uint8_t start_bus_number; /* Starting PCI Bus number */
471 uint8_t end_bus_number; /* Final PCI Bus number */
472 uint32_t reserved;
473 } QEMU_PACKED;
474 typedef struct AcpiMcfgAllocation AcpiMcfgAllocation;
476 struct AcpiTableMcfg {
477 ACPI_TABLE_HEADER_DEF;
478 uint8_t reserved[8];
479 AcpiMcfgAllocation allocation[0];
480 } QEMU_PACKED;
481 typedef struct AcpiTableMcfg AcpiTableMcfg;
484 * TCPA Description Table
486 * Following Level 00, Rev 00.37 of specs:
487 * http://www.trustedcomputinggroup.org/resources/tcg_acpi_specification
489 struct Acpi20Tcpa {
490 ACPI_TABLE_HEADER_DEF /* ACPI common table header */
491 uint16_t platform_class;
492 uint32_t log_area_minimum_length;
493 uint64_t log_area_start_address;
494 } QEMU_PACKED;
495 typedef struct Acpi20Tcpa Acpi20Tcpa;
498 * TPM2
500 * Following Level 00, Rev 00.37 of specs:
501 * http://www.trustedcomputinggroup.org/resources/tcg_acpi_specification
503 struct Acpi20TPM2 {
504 ACPI_TABLE_HEADER_DEF
505 uint16_t platform_class;
506 uint16_t reserved;
507 uint64_t control_area_address;
508 uint32_t start_method;
509 } QEMU_PACKED;
510 typedef struct Acpi20TPM2 Acpi20TPM2;
512 /* DMAR - DMA Remapping table r2.2 */
513 struct AcpiTableDmar {
514 ACPI_TABLE_HEADER_DEF
515 uint8_t host_address_width; /* Maximum DMA physical addressability */
516 uint8_t flags;
517 uint8_t reserved[10];
518 } QEMU_PACKED;
519 typedef struct AcpiTableDmar AcpiTableDmar;
521 /* Masks for Flags field above */
522 #define ACPI_DMAR_INTR_REMAP 1
523 #define ACPI_DMAR_X2APIC_OPT_OUT (1 << 1)
525 /* Values for sub-structure type for DMAR */
526 enum {
527 ACPI_DMAR_TYPE_HARDWARE_UNIT = 0, /* DRHD */
528 ACPI_DMAR_TYPE_RESERVED_MEMORY = 1, /* RMRR */
529 ACPI_DMAR_TYPE_ATSR = 2, /* ATSR */
530 ACPI_DMAR_TYPE_HARDWARE_AFFINITY = 3, /* RHSR */
531 ACPI_DMAR_TYPE_ANDD = 4, /* ANDD */
532 ACPI_DMAR_TYPE_RESERVED = 5 /* Reserved for furture use */
536 * Sub-structures for DMAR
538 /* Type 0: Hardware Unit Definition */
539 struct AcpiDmarHardwareUnit {
540 uint16_t type;
541 uint16_t length;
542 uint8_t flags;
543 uint8_t reserved;
544 uint16_t pci_segment; /* The PCI Segment associated with this unit */
545 uint64_t address; /* Base address of remapping hardware register-set */
546 } QEMU_PACKED;
547 typedef struct AcpiDmarHardwareUnit AcpiDmarHardwareUnit;
549 /* Masks for Flags field above */
550 #define ACPI_DMAR_INCLUDE_PCI_ALL 1
552 #endif