2 * Based on acpi.c from coreboot
4 * Copyright (C) 2015, Saket Sinha <saket.sinha89@gmail.com>
6 * SPDX-License-Identifier: GPL-2.0+
9 #define RSDP_SIG "RSD PTR " /* RSDT pointer signature */
10 #define ACPI_TABLE_CREATOR "UBOOT " /* Must be 8 bytes long! */
11 #define OEM_ID "UBOOT " /* Must be 6 bytes long! */
12 #define ASLC "INTL" /* Must be 4 bytes long! */
14 #define OEM_REVISION 42
15 #define ASL_COMPILER_REVISION 42
17 #define ACPI_REV_ACPI_1_0 1
18 #define ACPI_REV_ACPI_2_0 1
19 #define ACPI_REV_ACPI_3_0 2
20 #define ACPI_REV_ACPI_4_0 3
21 #define ACPI_REV_ACPI_5_0 5
23 #define ACPI_RSDP_REV_ACPI_1_0 0
24 #define ACPI_RSDP_REV_ACPI_2_0 2
26 typedef struct acpi_gen_regaddr {
27 u8 space_id; /* Address space ID */
28 u8 bit_width; /* Register size in bits */
29 u8 bit_offset; /* Register bit offset */
31 /* Reserved in ACPI 2.0 - 2.0b */
33 /* Access size in ACPI 2.0c/3.0/4.0/5.0 */
36 u32 addrl; /* Register address, low 32 bits */
37 u32 addrh; /* Register address, high 32 bits */
42 * RSDP (Root System Description Pointer)
43 * Note: ACPI 1.0 didn't have length, xsdt_address, and ext_checksum
46 char signature[8]; /* RSDP signature */
47 u8 checksum; /* Checksum of the first 20 bytes */
48 char oem_id[6]; /* OEM ID */
49 u8 revision; /* 0 for ACPI 1.0, 2 for ACPI 2.0/3.0/4.0 */
50 u32 rsdt_address; /* Physical address of RSDT (32 bits) */
51 u32 length; /* Total RSDP length (incl. extended part) */
52 u64 xsdt_address; /* Physical address of XSDT (64 bits) */
53 u8 ext_checksum; /* Checksum of the whole table */
57 enum acpi_address_space_type {
58 ACPI_ADDRESS_SPACE_MEMORY = 0, /* System memory */
59 ACPI_ADDRESS_SPACE_IO, /* System I/O */
60 ACPI_ADDRESS_SPACE_PCI, /* PCI config space */
61 ACPI_ADDRESS_SPACE_EC, /* Embedded controller */
62 ACPI_ADDRESS_SPACE_SMBUS, /* SMBus */
63 ACPI_ADDRESS_SPACE_PCC = 0x0a, /* Platform Comm. Channel */
64 ACPI_ADDRESS_SPACE_FIXED = 0x7f /* Functional fixed hardware */
67 /* Access size definitions for Generic address structure */
68 enum acpi_address_space_size {
69 ACPI_ACCESS_SIZE_UNDEFINED = 0, /* Undefined (legacy reasons) */
70 ACPI_ACCESS_SIZE_BYTE_ACCESS = 1,
71 ACPI_ACCESS_SIZE_WORD_ACCESS = 2,
72 ACPI_ACCESS_SIZE_DWORD_ACCESS = 3,
73 ACPI_ACCESS_SIZE_QWORD_ACCESS = 4
76 /* Generic ACPI header, provided by (almost) all tables */
77 typedef struct acpi_table_header {
78 char signature[4]; /* ACPI signature (4 ASCII characters) */
79 u32 length; /* Table length in bytes (incl. header) */
80 u8 revision; /* Table version (not ACPI version!) */
81 volatile u8 checksum; /* To make sum of entire table == 0 */
82 char oem_id[6]; /* OEM identification */
83 char oem_table_id[8]; /* OEM table identification */
84 u32 oem_revision; /* OEM revision number */
85 char asl_compiler_id[4]; /* ASL compiler vendor ID */
86 u32 asl_compiler_revision; /* ASL compiler revision number */
89 /* A maximum number of 32 ACPI tables ought to be enough for now */
90 #define MAX_ACPI_TABLES 32
92 /* RSDT (Root System Description Table) */
94 struct acpi_table_header header;
95 u32 entry[MAX_ACPI_TABLES];
98 /* XSDT (Extended System Description Table) */
100 struct acpi_table_header header;
101 u64 entry[MAX_ACPI_TABLES];
104 /* MCFG (PCI Express MMIO config space BAR description table) */
106 struct acpi_table_header header;
110 struct acpi_mcfg_mmconfig {
113 u16 pci_segment_group_number;
119 /* MADT (Multiple APIC Description Table) */
121 struct acpi_table_header header;
122 u32 lapic_addr; /* Local APIC address */
123 u32 flags; /* Multiple APIC flags */
126 /* MADT: APIC Structure Type*/
127 enum acpi_apic_types {
128 LOCALAPIC = 0, /* Processor local APIC */
129 IOAPIC, /* I/O APIC */
130 IRQSOURCEOVERRIDE, /* Interrupt source override */
131 NMITYPE, /* NMI source */
132 LOCALNMITYPE, /* Local APIC NMI */
133 LAPICADDRESSOVERRIDE, /* Local APIC address override */
134 IOSAPIC, /* I/O SAPIC */
135 LOCALSAPIC, /* Local SAPIC */
136 PLATFORMIRQSOURCES, /* Platform interrupt sources */
137 LOCALX2SAPIC, /* Processor local x2APIC */
138 LOCALX2APICNMI, /* Local x2APIC NMI */
141 /* MADT: Processor Local APIC Structure */
142 struct acpi_madt_lapic {
143 u8 type; /* Type (0) */
144 u8 length; /* Length in bytes (8) */
145 u8 processor_id; /* ACPI processor ID */
146 u8 apic_id; /* Local APIC ID */
147 u32 flags; /* Local APIC flags */
150 #define LOCAL_APIC_FLAG_ENABLED (1 << 0)
151 /* bits 1-31: reserved */
152 #define PCAT_COMPAT (1 << 0)
153 /* bits 1-31: reserved */
155 /* MADT: Local APIC NMI Structure */
156 struct acpi_madt_lapic_nmi {
157 u8 type; /* Type (4) */
158 u8 length; /* Length in bytes (6) */
159 u8 processor_id; /* ACPI processor ID */
160 u16 flags; /* MPS INTI flags */
161 u8 lint; /* Local APIC LINT# */
164 /* MADT: I/O APIC Structure */
165 struct acpi_madt_ioapic {
166 u8 type; /* Type (1) */
167 u8 length; /* Length in bytes (12) */
168 u8 ioapic_id; /* I/O APIC ID */
170 u32 ioapic_addr; /* I/O APIC address */
171 u32 gsi_base; /* Global system interrupt base */
174 /* MADT: Interrupt Source Override Structure */
175 struct acpi_madt_irqoverride {
176 u8 type; /* Type (2) */
177 u8 length; /* Length in bytes (10) */
178 u8 bus; /* ISA (0) */
179 u8 source; /* Bus-relative int. source (IRQ) */
180 u32 gsirq; /* Global system interrupt */
181 u16 flags; /* MPS INTI flags */
184 /* FADT (Fixed ACPI Description Table) */
185 struct __packed acpi_fadt {
186 struct acpi_table_header header;
190 u8 preferred_pm_profile;
225 struct acpi_gen_regaddr reset_reg;
230 u32 x_firmware_ctl_l;
231 u32 x_firmware_ctl_h;
234 struct acpi_gen_regaddr x_pm1a_evt_blk;
235 struct acpi_gen_regaddr x_pm1b_evt_blk;
236 struct acpi_gen_regaddr x_pm1a_cnt_blk;
237 struct acpi_gen_regaddr x_pm1b_cnt_blk;
238 struct acpi_gen_regaddr x_pm2_cnt_blk;
239 struct acpi_gen_regaddr x_pm_tmr_blk;
240 struct acpi_gen_regaddr x_gpe0_blk;
241 struct acpi_gen_regaddr x_gpe1_blk;
244 /* Flags for p_lvl2_lat and p_lvl3_lat */
245 #define ACPI_FADT_C2_NOT_SUPPORTED 101
246 #define ACPI_FADT_C3_NOT_SUPPORTED 1001
248 /* FADT Feature Flags */
249 #define ACPI_FADT_WBINVD (1 << 0)
250 #define ACPI_FADT_WBINVD_FLUSH (1 << 1)
251 #define ACPI_FADT_C1_SUPPORTED (1 << 2)
252 #define ACPI_FADT_C2_MP_SUPPORTED (1 << 3)
253 #define ACPI_FADT_POWER_BUTTON (1 << 4)
254 #define ACPI_FADT_SLEEP_BUTTON (1 << 5)
255 #define ACPI_FADT_FIXED_RTC (1 << 6)
256 #define ACPI_FADT_S4_RTC_WAKE (1 << 7)
257 #define ACPI_FADT_32BIT_TIMER (1 << 8)
258 #define ACPI_FADT_DOCKING_SUPPORTED (1 << 9)
259 #define ACPI_FADT_RESET_REGISTER (1 << 10)
260 #define ACPI_FADT_SEALED_CASE (1 << 11)
261 #define ACPI_FADT_HEADLESS (1 << 12)
262 #define ACPI_FADT_SLEEP_TYPE (1 << 13)
263 #define ACPI_FADT_PCI_EXPRESS_WAKE (1 << 14)
264 #define ACPI_FADT_PLATFORM_CLOCK (1 << 15)
265 #define ACPI_FADT_S4_RTC_VALID (1 << 16)
266 #define ACPI_FADT_REMOTE_POWER_ON (1 << 17)
267 #define ACPI_FADT_APIC_CLUSTER (1 << 18)
268 #define ACPI_FADT_APIC_PHYSICAL (1 << 19)
269 /* Bits 20-31: reserved ACPI 3.0 & 4.0 */
270 #define ACPI_FADT_HW_REDUCED_ACPI (1 << 20)
271 #define ACPI_FADT_LOW_PWR_IDLE_S0 (1 << 21)
272 /* bits 22-31: reserved ACPI 5.0 */
274 /* FADT Boot Architecture Flags */
275 #define ACPI_FADT_LEGACY_DEVICES (1 << 0)
276 #define ACPI_FADT_8042 (1 << 1)
277 #define ACPI_FADT_VGA_NOT_PRESENT (1 << 2)
278 #define ACPI_FADT_MSI_NOT_SUPPORTED (1 << 3)
279 #define ACPI_FADT_NO_PCIE_ASPM_CONTROL (1 << 4)
280 /* No legacy devices (including 8042) */
281 #define ACPI_FADT_LEGACY_FREE 0x00
283 /* FADT Preferred Power Management Profile */
284 #define PM_UNSPECIFIED 0
287 #define PM_WORKSTATION 3
288 #define PM_ENTERPRISE_SERVER 4
289 #define PM_SOHO_SERVER 5
290 #define PM_APPLIANCE_PC 6
291 #define PM_PERFORMANCE_SERVER 7
292 #define PM_TABLET 8 /* ACPI 5.0 */
294 /* FACS (Firmware ACPI Control Structure) */
296 char signature[4]; /* "FACS" */
297 u32 length; /* Length in bytes (>= 64) */
298 u32 hardware_signature; /* Hardware signature */
299 u32 firmware_waking_vector; /* Firmware waking vector */
300 u32 global_lock; /* Global lock */
301 u32 flags; /* FACS flags */
302 u32 x_firmware_waking_vector_l; /* X FW waking vector, low */
303 u32 x_firmware_waking_vector_h; /* X FW waking vector, high */
304 u8 version; /* ACPI 4.0: 2 */
305 u8 resv[31]; /* FIXME: 4.0: ospm_flags */
309 #define ACPI_FACS_S4BIOS_F (1 << 0)
310 #define ACPI_FACS_64BIT_WAKE_F (1 << 1)
311 /* Bits 31..2: reserved */
313 /* These can be used by the target port */
315 unsigned long acpi_create_madt_lapics(unsigned long current);
316 int acpi_create_madt_ioapic(struct acpi_madt_ioapic *ioapic, u8 id, u32 addr,
318 int acpi_create_madt_irqoverride(struct acpi_madt_irqoverride *irqoverride,
319 u8 bus, u8 source, u32 gsirq, u16 flags);
320 unsigned long acpi_fill_madt(unsigned long current);
321 void acpi_create_fadt(struct acpi_fadt *fadt, struct acpi_facs *facs,
323 int acpi_create_madt_lapic_nmi(struct acpi_madt_lapic_nmi *lapic_nmi, u8 cpu,
325 u32 write_acpi_tables(u32 start);