Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / include / acpi / actbl1.h
bloba1b1b2ee3e512d0c1d3a338c2cd1aca50dee2372
1 /******************************************************************************
3 * Name: actbl1.h - Additional ACPI table definitions
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2007, R. Byron Moore
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACTBL1_H__
45 #define __ACTBL1_H__
47 /*******************************************************************************
49 * Additional ACPI Tables
51 * These tables are not consumed directly by the ACPICA subsystem, but are
52 * included here to support device drivers and the AML disassembler.
54 ******************************************************************************/
57 * Values for description table header signatures. Useful because they make
58 * it more difficult to inadvertently type in the wrong signature.
60 #define ACPI_SIG_ASF "ASF!" /* Alert Standard Format table */
61 #define ACPI_SIG_BOOT "BOOT" /* Simple Boot Flag Table */
62 #define ACPI_SIG_CPEP "CPEP" /* Corrected Platform Error Polling table */
63 #define ACPI_SIG_DBGP "DBGP" /* Debug Port table */
64 #define ACPI_SIG_DMAR "DMAR" /* DMA Remapping table */
65 #define ACPI_SIG_ECDT "ECDT" /* Embedded Controller Boot Resources Table */
66 #define ACPI_SIG_HPET "HPET" /* High Precision Event Timer table */
67 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
68 #define ACPI_SIG_MCFG "MCFG" /* PCI Memory Mapped Configuration table */
69 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
70 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
71 #define ACPI_SIG_SPCR "SPCR" /* Serial Port Console Redirection table */
72 #define ACPI_SIG_SPMI "SPMI" /* Server Platform Management Interface table */
73 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
74 #define ACPI_SIG_TCPA "TCPA" /* Trusted Computing Platform Alliance table */
75 #define ACPI_SIG_WDRT "WDRT" /* Watchdog Resource Table */
78 * All tables must be byte-packed to match the ACPI specification, since
79 * the tables are provided by the system BIOS.
81 #pragma pack(1)
84 * Note about bitfields: The u8 type is used for bitfields in ACPI tables.
85 * This is the only type that is even remotely portable. Anything else is not
86 * portable, so do not use any other bitfield types.
89 /* Common Sub-table header (used in MADT, SRAT, etc.) */
91 struct acpi_subtable_header {
92 u8 type;
93 u8 length;
96 /*******************************************************************************
98 * ASF - Alert Standard Format table (Signature "ASF!")
100 * Conforms to the Alert Standard Format Specification V2.0, 23 April 2003
102 ******************************************************************************/
104 struct acpi_table_asf {
105 struct acpi_table_header header; /* Common ACPI table header */
108 /* ASF subtable header */
110 struct acpi_asf_header {
111 u8 type;
112 u8 reserved;
113 u16 length;
116 /* Values for Type field above */
118 enum acpi_asf_type {
119 ACPI_ASF_TYPE_INFO = 0,
120 ACPI_ASF_TYPE_ALERT = 1,
121 ACPI_ASF_TYPE_CONTROL = 2,
122 ACPI_ASF_TYPE_BOOT = 3,
123 ACPI_ASF_TYPE_ADDRESS = 4,
124 ACPI_ASF_TYPE_RESERVED = 5
128 * ASF subtables
131 /* 0: ASF Information */
133 struct acpi_asf_info {
134 struct acpi_asf_header header;
135 u8 min_reset_value;
136 u8 min_poll_interval;
137 u16 system_id;
138 u32 mfg_id;
139 u8 flags;
140 u8 reserved2[3];
143 /* 1: ASF Alerts */
145 struct acpi_asf_alert {
146 struct acpi_asf_header header;
147 u8 assert_mask;
148 u8 deassert_mask;
149 u8 alerts;
150 u8 data_length;
153 struct acpi_asf_alert_data {
154 u8 address;
155 u8 command;
156 u8 mask;
157 u8 value;
158 u8 sensor_type;
159 u8 type;
160 u8 offset;
161 u8 source_type;
162 u8 severity;
163 u8 sensor_number;
164 u8 entity;
165 u8 instance;
168 /* 2: ASF Remote Control */
170 struct acpi_asf_remote {
171 struct acpi_asf_header header;
172 u8 controls;
173 u8 data_length;
174 u16 reserved2;
177 struct acpi_asf_control_data {
178 u8 function;
179 u8 address;
180 u8 command;
181 u8 value;
184 /* 3: ASF RMCP Boot Options */
186 struct acpi_asf_rmcp {
187 struct acpi_asf_header header;
188 u8 capabilities[7];
189 u8 completion_code;
190 u32 enterprise_id;
191 u8 command;
192 u16 parameter;
193 u16 boot_options;
194 u16 oem_parameters;
197 /* 4: ASF Address */
199 struct acpi_asf_address {
200 struct acpi_asf_header header;
201 u8 eprom_address;
202 u8 devices;
205 /*******************************************************************************
207 * BOOT - Simple Boot Flag Table
209 ******************************************************************************/
211 struct acpi_table_boot {
212 struct acpi_table_header header; /* Common ACPI table header */
213 u8 cmos_index; /* Index in CMOS RAM for the boot register */
214 u8 reserved[3];
217 /*******************************************************************************
219 * CPEP - Corrected Platform Error Polling table
221 ******************************************************************************/
223 struct acpi_table_cpep {
224 struct acpi_table_header header; /* Common ACPI table header */
225 u64 reserved;
228 /* Subtable */
230 struct acpi_cpep_polling {
231 u8 type;
232 u8 length;
233 u8 id; /* Processor ID */
234 u8 eid; /* Processor EID */
235 u32 interval; /* Polling interval (msec) */
238 /*******************************************************************************
240 * DBGP - Debug Port table
242 ******************************************************************************/
244 struct acpi_table_dbgp {
245 struct acpi_table_header header; /* Common ACPI table header */
246 u8 type; /* 0=full 16550, 1=subset of 16550 */
247 u8 reserved[3];
248 struct acpi_generic_address debug_port;
251 /*******************************************************************************
253 * DMAR - DMA Remapping table
255 ******************************************************************************/
257 struct acpi_table_dmar {
258 struct acpi_table_header header; /* Common ACPI table header */
259 u8 width; /* Host Address Width */
260 u8 flags;
261 u8 reserved[10];
264 /* DMAR subtable header */
266 struct acpi_dmar_header {
267 u16 type;
268 u16 length;
271 /* Values for subtable type in struct acpi_dmar_header */
273 enum acpi_dmar_type {
274 ACPI_DMAR_TYPE_HARDWARE_UNIT = 0,
275 ACPI_DMAR_TYPE_RESERVED_MEMORY = 1,
276 ACPI_DMAR_TYPE_ATSR = 2,
277 ACPI_DMAR_TYPE_RESERVED = 3 /* 3 and greater are reserved */
280 struct acpi_dmar_device_scope {
281 u8 entry_type;
282 u8 length;
283 u16 reserved;
284 u8 enumeration_id;
285 u8 bus;
288 /* Values for entry_type in struct acpi_dmar_device_scope */
290 enum acpi_dmar_scope_type {
291 ACPI_DMAR_SCOPE_TYPE_NOT_USED = 0,
292 ACPI_DMAR_SCOPE_TYPE_ENDPOINT = 1,
293 ACPI_DMAR_SCOPE_TYPE_BRIDGE = 2,
294 ACPI_DMAR_SCOPE_TYPE_IOAPIC = 3,
295 ACPI_DMAR_SCOPE_TYPE_HPET = 4,
296 ACPI_DMAR_SCOPE_TYPE_RESERVED = 5 /* 5 and greater are reserved */
299 struct acpi_dmar_pci_path {
300 u8 dev;
301 u8 fn;
305 * DMAR Sub-tables, correspond to Type in struct acpi_dmar_header
308 /* 0: Hardware Unit Definition */
310 struct acpi_dmar_hardware_unit {
311 struct acpi_dmar_header header;
312 u8 flags;
313 u8 reserved;
314 u16 segment;
315 u64 address; /* Register Base Address */
318 /* Flags */
320 #define ACPI_DMAR_INCLUDE_ALL (1)
322 /* 1: Reserved Memory Defininition */
324 struct acpi_dmar_reserved_memory {
325 struct acpi_dmar_header header;
326 u16 reserved;
327 u16 segment;
328 u64 base_address; /* 4_k aligned base address */
329 u64 end_address; /* 4_k aligned limit address */
332 /* Flags */
334 #define ACPI_DMAR_ALLOW_ALL (1)
336 /*******************************************************************************
338 * ECDT - Embedded Controller Boot Resources Table
340 ******************************************************************************/
342 struct acpi_table_ecdt {
343 struct acpi_table_header header; /* Common ACPI table header */
344 struct acpi_generic_address control; /* Address of EC command/status register */
345 struct acpi_generic_address data; /* Address of EC data register */
346 u32 uid; /* Unique ID - must be same as the EC _UID method */
347 u8 gpe; /* The GPE for the EC */
348 u8 id[1]; /* Full namepath of the EC in the ACPI namespace */
351 /*******************************************************************************
353 * HPET - High Precision Event Timer table
355 ******************************************************************************/
357 struct acpi_table_hpet {
358 struct acpi_table_header header; /* Common ACPI table header */
359 u32 id; /* Hardware ID of event timer block */
360 struct acpi_generic_address address; /* Address of event timer block */
361 u8 sequence; /* HPET sequence number */
362 u16 minimum_tick; /* Main counter min tick, periodic mode */
363 u8 flags;
366 /*! Flags */
368 #define ACPI_HPET_PAGE_PROTECT (1) /* 00: No page protection */
369 #define ACPI_HPET_PAGE_PROTECT_4 (1<<1) /* 01: 4KB page protected */
370 #define ACPI_HPET_PAGE_PROTECT_64 (1<<2) /* 02: 64KB page protected */
372 /*! [End] no source code translation !*/
374 /*******************************************************************************
376 * MADT - Multiple APIC Description Table
378 ******************************************************************************/
380 struct acpi_table_madt {
381 struct acpi_table_header header; /* Common ACPI table header */
382 u32 address; /* Physical address of local APIC */
383 u32 flags;
386 /* Flags */
388 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
390 /* Values for PCATCompat flag */
392 #define ACPI_MADT_DUAL_PIC 0
393 #define ACPI_MADT_MULTIPLE_APIC 1
395 /* Values for subtable type in struct acpi_subtable_header */
397 enum acpi_madt_type {
398 ACPI_MADT_TYPE_LOCAL_APIC = 0,
399 ACPI_MADT_TYPE_IO_APIC = 1,
400 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
401 ACPI_MADT_TYPE_NMI_SOURCE = 3,
402 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
403 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
404 ACPI_MADT_TYPE_IO_SAPIC = 6,
405 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
406 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
407 ACPI_MADT_TYPE_RESERVED = 9 /* 9 and greater are reserved */
411 * MADT Sub-tables, correspond to Type in struct acpi_subtable_header
414 /* 0: Processor Local APIC */
416 struct acpi_madt_local_apic {
417 struct acpi_subtable_header header;
418 u8 processor_id; /* ACPI processor id */
419 u8 id; /* Processor's local APIC id */
420 u32 lapic_flags;
423 /* 1: IO APIC */
425 struct acpi_madt_io_apic {
426 struct acpi_subtable_header header;
427 u8 id; /* I/O APIC ID */
428 u8 reserved; /* Reserved - must be zero */
429 u32 address; /* APIC physical address */
430 u32 global_irq_base; /* Global system interrupt where INTI lines start */
433 /* 2: Interrupt Override */
435 struct acpi_madt_interrupt_override {
436 struct acpi_subtable_header header;
437 u8 bus; /* 0 - ISA */
438 u8 source_irq; /* Interrupt source (IRQ) */
439 u32 global_irq; /* Global system interrupt */
440 u16 inti_flags;
443 /* 3: NMI Source */
445 struct acpi_madt_nmi_source {
446 struct acpi_subtable_header header;
447 u16 inti_flags;
448 u32 global_irq; /* Global system interrupt */
451 /* 4: Local APIC NMI */
453 struct acpi_madt_local_apic_nmi {
454 struct acpi_subtable_header header;
455 u8 processor_id; /* ACPI processor id */
456 u16 inti_flags;
457 u8 lint; /* LINTn to which NMI is connected */
460 /* 5: Address Override */
462 struct acpi_madt_local_apic_override {
463 struct acpi_subtable_header header;
464 u16 reserved; /* Reserved, must be zero */
465 u64 address; /* APIC physical address */
468 /* 6: I/O Sapic */
470 struct acpi_madt_io_sapic {
471 struct acpi_subtable_header header;
472 u8 id; /* I/O SAPIC ID */
473 u8 reserved; /* Reserved, must be zero */
474 u32 global_irq_base; /* Global interrupt for SAPIC start */
475 u64 address; /* SAPIC physical address */
478 /* 7: Local Sapic */
480 struct acpi_madt_local_sapic {
481 struct acpi_subtable_header header;
482 u8 processor_id; /* ACPI processor id */
483 u8 id; /* SAPIC ID */
484 u8 eid; /* SAPIC EID */
485 u8 reserved[3]; /* Reserved, must be zero */
486 u32 lapic_flags;
487 u32 uid; /* Numeric UID - ACPI 3.0 */
488 char uid_string[1]; /* String UID - ACPI 3.0 */
491 /* 8: Platform Interrupt Source */
493 struct acpi_madt_interrupt_source {
494 struct acpi_subtable_header header;
495 u16 inti_flags;
496 u8 type; /* 1=PMI, 2=INIT, 3=corrected */
497 u8 id; /* Processor ID */
498 u8 eid; /* Processor EID */
499 u8 io_sapic_vector; /* Vector value for PMI interrupts */
500 u32 global_irq; /* Global system interrupt */
501 u32 flags; /* Interrupt Source Flags */
504 /* Flags field above */
506 #define ACPI_MADT_CPEI_OVERRIDE (1)
509 * Common flags fields for MADT subtables
512 /* MADT Local APIC flags (lapic_flags) */
514 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
516 /* MADT MPS INTI flags (inti_flags) */
518 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
519 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
521 /* Values for MPS INTI flags */
523 #define ACPI_MADT_POLARITY_CONFORMS 0
524 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
525 #define ACPI_MADT_POLARITY_RESERVED 2
526 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
528 #define ACPI_MADT_TRIGGER_CONFORMS (0)
529 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
530 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
531 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
533 /*******************************************************************************
535 * MCFG - PCI Memory Mapped Configuration table and sub-table
537 ******************************************************************************/
539 struct acpi_table_mcfg {
540 struct acpi_table_header header; /* Common ACPI table header */
541 u8 reserved[8];
544 /* Subtable */
546 struct acpi_mcfg_allocation {
547 u64 address; /* Base address, processor-relative */
548 u16 pci_segment; /* PCI segment group number */
549 u8 start_bus_number; /* Starting PCI Bus number */
550 u8 end_bus_number; /* Final PCI Bus number */
551 u32 reserved;
554 /*******************************************************************************
556 * SBST - Smart Battery Specification Table
558 ******************************************************************************/
560 struct acpi_table_sbst {
561 struct acpi_table_header header; /* Common ACPI table header */
562 u32 warning_level;
563 u32 low_level;
564 u32 critical_level;
567 /*******************************************************************************
569 * SLIT - System Locality Distance Information Table
571 ******************************************************************************/
573 struct acpi_table_slit {
574 struct acpi_table_header header; /* Common ACPI table header */
575 u64 locality_count;
576 u8 entry[1]; /* Real size = localities^2 */
579 /*******************************************************************************
581 * SPCR - Serial Port Console Redirection table
583 ******************************************************************************/
585 struct acpi_table_spcr {
586 struct acpi_table_header header; /* Common ACPI table header */
587 u8 interface_type; /* 0=full 16550, 1=subset of 16550 */
588 u8 reserved[3];
589 struct acpi_generic_address serial_port;
590 u8 interrupt_type;
591 u8 pc_interrupt;
592 u32 interrupt;
593 u8 baud_rate;
594 u8 parity;
595 u8 stop_bits;
596 u8 flow_control;
597 u8 terminal_type;
598 u8 reserved1;
599 u16 pci_device_id;
600 u16 pci_vendor_id;
601 u8 pci_bus;
602 u8 pci_device;
603 u8 pci_function;
604 u32 pci_flags;
605 u8 pci_segment;
606 u32 reserved2;
609 /*******************************************************************************
611 * SPMI - Server Platform Management Interface table
613 ******************************************************************************/
615 struct acpi_table_spmi {
616 struct acpi_table_header header; /* Common ACPI table header */
617 u8 reserved;
618 u8 interface_type;
619 u16 spec_revision; /* Version of IPMI */
620 u8 interrupt_type;
621 u8 gpe_number; /* GPE assigned */
622 u8 reserved1;
623 u8 pci_device_flag;
624 u32 interrupt;
625 struct acpi_generic_address ipmi_register;
626 u8 pci_segment;
627 u8 pci_bus;
628 u8 pci_device;
629 u8 pci_function;
632 /*******************************************************************************
634 * SRAT - System Resource Affinity Table
636 ******************************************************************************/
638 struct acpi_table_srat {
639 struct acpi_table_header header; /* Common ACPI table header */
640 u32 table_revision; /* Must be value '1' */
641 u64 reserved; /* Reserved, must be zero */
644 /* Values for subtable type in struct acpi_subtable_header */
646 enum acpi_srat_type {
647 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
648 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
649 ACPI_SRAT_TYPE_RESERVED = 2
652 /* SRAT sub-tables */
654 struct acpi_srat_cpu_affinity {
655 struct acpi_subtable_header header;
656 u8 proximity_domain_lo;
657 u8 apic_id;
658 u32 flags;
659 u8 local_sapic_eid;
660 u8 proximity_domain_hi[3];
661 u32 reserved; /* Reserved, must be zero */
664 /* Flags */
666 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
668 struct acpi_srat_mem_affinity {
669 struct acpi_subtable_header header;
670 u32 proximity_domain;
671 u16 reserved; /* Reserved, must be zero */
672 u64 base_address;
673 u64 length;
674 u32 memory_type; /* See acpi_address_range_id */
675 u32 flags;
676 u64 reserved1; /* Reserved, must be zero */
679 /* Flags */
681 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
682 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
683 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
685 /*******************************************************************************
687 * TCPA - Trusted Computing Platform Alliance table
689 ******************************************************************************/
691 struct acpi_table_tcpa {
692 struct acpi_table_header header; /* Common ACPI table header */
693 u16 reserved;
694 u32 max_log_length; /* Maximum length for the event log area */
695 u64 log_address; /* Address of the event log area */
698 /*******************************************************************************
700 * WDRT - Watchdog Resource Table
702 ******************************************************************************/
704 struct acpi_table_wdrt {
705 struct acpi_table_header header; /* Common ACPI table header */
706 u32 header_length; /* Watchdog Header Length */
707 u8 pci_segment; /* PCI Segment number */
708 u8 pci_bus; /* PCI Bus number */
709 u8 pci_device; /* PCI Device number */
710 u8 pci_function; /* PCI Function number */
711 u32 timer_period; /* Period of one timer count (msec) */
712 u32 max_count; /* Maximum counter value supported */
713 u32 min_count; /* Minimum counter value */
714 u8 flags;
715 u8 reserved[3];
716 u32 entries; /* Number of watchdog entries that follow */
719 /* Flags */
721 #define ACPI_WDRT_TIMER_ENABLED (1) /* 00: Timer enabled */
723 /* Reset to default packing */
725 #pragma pack()
727 #endif /* __ACTBL1_H__ */