1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Helpers for ACPI table generation
5 * Based on acpi.c from coreboot
7 * Copyright 2019 Google LLC
9 * Copyright (C) 2015, Saket Sinha <saket.sinha89@gmail.com>
10 * Copyright (C) 2016, Bin Meng <bmeng.cn@gmail.com>
13 #ifndef __ACPI_TABLE_H__
14 #define __ACPI_TABLE_H__
18 #define RSDP_SIG "RSD PTR " /* RSDP pointer signature */
19 #define OEM_ID "U-BOOT" /* U-Boot */
20 #define OEM_TABLE_ID "U-BOOTBL" /* U-Boot Table */
21 #define ASLC_ID "INTL" /* Intel ASL Compiler */
23 /* TODO(sjg@chromium.org): Figure out how to get compiler revision */
24 #define ASL_REVISION 0
26 #define ACPI_RSDP_REV_ACPI_1_0 0
27 #define ACPI_RSDP_REV_ACPI_2_0 2
29 #if !defined(__ACPI__)
31 #include <linux/bitops.h>
36 * RSDP (Root System Description Pointer)
37 * Note: ACPI 1.0 didn't have length, xsdt_address, and ext_checksum
40 char signature[8]; /* RSDP signature */
41 u8 checksum; /* Checksum of the first 20 bytes */
42 char oem_id[6]; /* OEM ID */
43 u8 revision; /* 0 for ACPI 1.0, others 2 */
44 u32 rsdt_address; /* Physical address of RSDT (32 bits) */
45 u32 length; /* Total RSDP length (incl. extended part) */
46 u64 xsdt_address; /* Physical address of XSDT (64 bits) */
47 u8 ext_checksum; /* Checksum of the whole table */
51 /* Generic ACPI header, provided by (almost) all tables */
52 struct __packed acpi_table_header {
53 char signature[ACPI_NAME_LEN]; /* ACPI signature (4 ASCII chars) */
54 u32 length; /* Table length in bytes (incl. header) */
55 u8 revision; /* Table version (not ACPI version!) */
56 volatile u8 checksum; /* To make sum of entire table == 0 */
57 char oem_id[6]; /* OEM identification */
58 char oem_table_id[8]; /* OEM table identification */
59 u32 oem_revision; /* OEM revision number */
60 char aslc_id[4]; /* ASL compiler vendor ID */
61 u32 aslc_revision; /* ASL compiler revision number */
64 struct acpi_gen_regaddr {
65 u8 space_id; /* Address space ID */
66 u8 bit_width; /* Register size in bits */
67 u8 bit_offset; /* Register bit offset */
68 u8 access_size; /* Access size */
69 u32 addrl; /* Register address, low 32 bits */
70 u32 addrh; /* Register address, high 32 bits */
73 /* A maximum number of 32 ACPI tables ought to be enough for now */
74 #define MAX_ACPI_TABLES 32
76 /* RSDT (Root System Description Table) */
78 struct acpi_table_header header;
79 u32 entry[MAX_ACPI_TABLES];
82 /* XSDT (Extended System Description Table) */
84 struct acpi_table_header header;
85 u64 entry[MAX_ACPI_TABLES];
89 struct __packed acpi_hpet {
90 struct acpi_table_header header;
92 struct acpi_gen_regaddr addr;
98 struct __packed acpi_tpm2 {
99 struct acpi_table_header header;
109 struct __packed acpi_tcpa {
110 struct acpi_table_header header;
116 /* FADT Preferred Power Management Profile */
117 enum acpi_pm_profile {
118 ACPI_PM_UNSPECIFIED = 0,
122 ACPI_PM_ENTERPRISE_SERVER,
124 ACPI_PM_APPLIANCE_PC,
125 ACPI_PM_PERFORMANCE_SERVER,
129 /* FADT flags for p_lvl2_lat and p_lvl3_lat */
130 #define ACPI_FADT_C2_NOT_SUPPORTED 101
131 #define ACPI_FADT_C3_NOT_SUPPORTED 1001
133 /* FADT Boot Architecture Flags */
134 #define ACPI_FADT_LEGACY_FREE 0x00
135 #define ACPI_FADT_LEGACY_DEVICES BIT(0)
136 #define ACPI_FADT_8042 BIT(1)
137 #define ACPI_FADT_VGA_NOT_PRESENT BIT(2)
138 #define ACPI_FADT_MSI_NOT_SUPPORTED BIT(3)
139 #define ACPI_FADT_NO_PCIE_ASPM_CONTROL BIT(4)
141 /* FADT Feature Flags */
142 #define ACPI_FADT_WBINVD BIT(0)
143 #define ACPI_FADT_WBINVD_FLUSH BIT(1)
144 #define ACPI_FADT_C1_SUPPORTED BIT(2)
145 #define ACPI_FADT_C2_MP_SUPPORTED BIT(3)
146 #define ACPI_FADT_POWER_BUTTON BIT(4)
147 #define ACPI_FADT_SLEEP_BUTTON BIT(5)
148 #define ACPI_FADT_FIXED_RTC BIT(6)
149 #define ACPI_FADT_S4_RTC_WAKE BIT(7)
150 #define ACPI_FADT_32BIT_TIMER BIT(8)
151 #define ACPI_FADT_DOCKING_SUPPORTED BIT(9)
152 #define ACPI_FADT_RESET_REGISTER BIT(10)
153 #define ACPI_FADT_SEALED_CASE BIT(11)
154 #define ACPI_FADT_HEADLESS BIT(12)
155 #define ACPI_FADT_SLEEP_TYPE BIT(13)
156 #define ACPI_FADT_PCI_EXPRESS_WAKE BIT(14)
157 #define ACPI_FADT_PLATFORM_CLOCK BIT(15)
158 #define ACPI_FADT_S4_RTC_VALID BIT(16)
159 #define ACPI_FADT_REMOTE_POWER_ON BIT(17)
160 #define ACPI_FADT_APIC_CLUSTER BIT(18)
161 #define ACPI_FADT_APIC_PHYSICAL BIT(19)
162 #define ACPI_FADT_HW_REDUCED_ACPI BIT(20)
163 #define ACPI_FADT_LOW_PWR_IDLE_S0 BIT(21)
165 enum acpi_address_space_type {
166 ACPI_ADDRESS_SPACE_MEMORY = 0, /* System memory */
167 ACPI_ADDRESS_SPACE_IO, /* System I/O */
168 ACPI_ADDRESS_SPACE_PCI, /* PCI config space */
169 ACPI_ADDRESS_SPACE_EC, /* Embedded controller */
170 ACPI_ADDRESS_SPACE_SMBUS, /* SMBus */
171 ACPI_ADDRESS_SPACE_PCC = 0x0a, /* Platform Comm. Channel */
172 ACPI_ADDRESS_SPACE_FIXED = 0x7f /* Functional fixed hardware */
175 enum acpi_address_space_size {
176 ACPI_ACCESS_SIZE_UNDEFINED = 0,
177 ACPI_ACCESS_SIZE_BYTE_ACCESS,
178 ACPI_ACCESS_SIZE_WORD_ACCESS,
179 ACPI_ACCESS_SIZE_DWORD_ACCESS,
180 ACPI_ACCESS_SIZE_QWORD_ACCESS
183 /* FADT (Fixed ACPI Description Table) */
184 struct __packed acpi_fadt {
185 struct acpi_table_header header;
189 u8 preferred_pm_profile;
224 struct acpi_gen_regaddr reset_reg;
228 u32 x_firmware_ctl_l;
229 u32 x_firmware_ctl_h;
232 struct acpi_gen_regaddr x_pm1a_evt_blk;
233 struct acpi_gen_regaddr x_pm1b_evt_blk;
234 struct acpi_gen_regaddr x_pm1a_cnt_blk;
235 struct acpi_gen_regaddr x_pm1b_cnt_blk;
236 struct acpi_gen_regaddr x_pm2_cnt_blk;
237 struct acpi_gen_regaddr x_pm_tmr_blk;
238 struct acpi_gen_regaddr x_gpe0_blk;
239 struct acpi_gen_regaddr x_gpe1_blk;
242 /* FADT TABLE Revision values - note these do not match the ACPI revision */
243 #define ACPI_FADT_REV_ACPI_1_0 1
244 #define ACPI_FADT_REV_ACPI_2_0 3
245 #define ACPI_FADT_REV_ACPI_3_0 4
246 #define ACPI_FADT_REV_ACPI_4_0 4
247 #define ACPI_FADT_REV_ACPI_5_0 5
248 #define ACPI_FADT_REV_ACPI_6_0 6
250 /* MADT TABLE Revision values - note these do not match the ACPI revision */
251 #define ACPI_MADT_REV_ACPI_3_0 2
252 #define ACPI_MADT_REV_ACPI_4_0 3
253 #define ACPI_MADT_REV_ACPI_5_0 3
254 #define ACPI_MADT_REV_ACPI_6_0 5
256 #define ACPI_MCFG_REV_ACPI_3_0 1
258 /* IVRS Revision Field */
259 #define IVRS_FORMAT_FIXED 0x01 /* Type 10h & 11h only */
260 #define IVRS_FORMAT_MIXED 0x02 /* Type 10h, 11h, & 40h */
263 #define ACPI_FACS_S4BIOS_F BIT(0)
264 #define ACPI_FACS_64BIT_WAKE_F BIT(1)
266 /* FACS (Firmware ACPI Control Structure) */
268 char signature[ACPI_NAME_LEN]; /* "FACS" */
269 u32 length; /* Length in bytes (>= 64) */
270 u32 hardware_signature; /* Hardware signature */
271 u32 firmware_waking_vector; /* Firmware waking vector */
272 u32 global_lock; /* Global lock */
273 u32 flags; /* FACS flags */
274 u32 x_firmware_waking_vector_l; /* X FW waking vector, low */
275 u32 x_firmware_waking_vector_h; /* X FW waking vector, high */
276 u8 version; /* Version 2 */
278 u32 ospm_flags; /* OSPM enabled flags */
283 #define ACPI_MADT_PCAT_COMPAT BIT(0)
285 /* MADT (Multiple APIC Description Table) */
287 struct acpi_table_header header;
288 u32 lapic_addr; /* Local APIC address */
289 u32 flags; /* Multiple APIC flags */
292 /* MADT: APIC Structure Type*/
293 enum acpi_apic_types {
294 ACPI_APIC_LAPIC = 0, /* Processor local APIC */
295 ACPI_APIC_IOAPIC, /* I/O APIC */
296 ACPI_APIC_IRQ_SRC_OVERRIDE, /* Interrupt source override */
297 ACPI_APIC_NMI_SRC, /* NMI source */
298 ACPI_APIC_LAPIC_NMI, /* Local APIC NMI */
299 ACPI_APIC_LAPIC_ADDR_OVERRIDE, /* Local APIC address override */
300 ACPI_APIC_IOSAPIC, /* I/O SAPIC */
301 ACPI_APIC_LSAPIC, /* Local SAPIC */
302 ACPI_APIC_PLATFORM_IRQ_SRC, /* Platform interrupt sources */
303 ACPI_APIC_LX2APIC, /* Processor local x2APIC */
304 ACPI_APIC_LX2APIC_NMI, /* Local x2APIC NMI */
307 /* MADT: Processor Local APIC Structure */
309 #define LOCAL_APIC_FLAG_ENABLED BIT(0)
311 struct acpi_madt_lapic {
312 u8 type; /* Type (0) */
313 u8 length; /* Length in bytes (8) */
314 u8 processor_id; /* ACPI processor ID */
315 u8 apic_id; /* Local APIC ID */
316 u32 flags; /* Local APIC flags */
319 /* MADT: I/O APIC Structure */
320 struct acpi_madt_ioapic {
321 u8 type; /* Type (1) */
322 u8 length; /* Length in bytes (12) */
323 u8 ioapic_id; /* I/O APIC ID */
325 u32 ioapic_addr; /* I/O APIC address */
326 u32 gsi_base; /* Global system interrupt base */
329 /* MADT: Interrupt Source Override Structure */
330 struct __packed acpi_madt_irqoverride {
331 u8 type; /* Type (2) */
332 u8 length; /* Length in bytes (10) */
333 u8 bus; /* ISA (0) */
334 u8 source; /* Bus-relative int. source (IRQ) */
335 u32 gsirq; /* Global system interrupt */
336 u16 flags; /* MPS INTI flags */
339 /* MADT: Local APIC NMI Structure */
340 struct __packed acpi_madt_lapic_nmi {
341 u8 type; /* Type (4) */
342 u8 length; /* Length in bytes (6) */
343 u8 processor_id; /* ACPI processor ID */
344 u16 flags; /* MPS INTI flags */
345 u8 lint; /* Local APIC LINT# */
348 /* MCFG (PCI Express MMIO config space BAR description table) */
350 struct acpi_table_header header;
354 struct acpi_mcfg_mmconfig {
357 u16 pci_segment_group_number;
363 /* PM1_CNT bit defines */
364 #define PM1_CNT_SCI_EN BIT(0)
366 /* ACPI global NVS structure */
367 struct acpi_global_nvs;
369 /* CSRT (Core System Resource Table) */
371 struct acpi_table_header header;
374 struct acpi_csrt_group {
382 u32 shared_info_length;
385 struct acpi_csrt_shared_info {
391 u8 interrupt_polarity;
394 u8 dma_address_width;
395 u16 base_request_line;
396 u16 num_handshake_signals;
400 /* Port types for ACPI _UPC object */
404 UPC_TYPE_EXPRESSCARD,
407 UPC_TYPE_USB3_MICRO_B,
408 UPC_TYPE_USB3_MICRO_AB,
409 UPC_TYPE_USB3_POWER_B,
410 UPC_TYPE_C_USB2_ONLY,
411 UPC_TYPE_C_USB2_SS_SWITCH,
413 UPC_TYPE_PROPRIETARY = 0xff,
415 * The following types are not directly defined in the ACPI
416 * spec but are used by coreboot to identify a USB device type.
418 UPC_TYPE_INTERNAL = 0xff,
423 enum dev_scope_type {
424 SCOPE_PCI_ENDPOINT = 1,
428 SCOPE_ACPI_NAMESPACE_DEVICE = 5
431 struct __packed dev_scope {
452 DRHD_INCLUDE_PCI_ALL = BIT(0)
456 DMAR_INTR_REMAP = BIT(0),
457 DMAR_X2APIC_OPT_OUT = BIT(1),
458 DMAR_CTRL_PLATFORM_OPT_IN_FLAG = BIT(2),
470 struct dmar_rmrr_entry {
479 /* DMAR (DMA Remapping Reporting Structure) */
480 struct __packed acpi_dmar {
481 struct acpi_table_header header;
482 u8 host_address_width;
485 struct dmar_entry structure[0];
488 /* DBG2 definitions are partially used for SPCR interface_type */
490 /* Types for port_type field */
492 #define ACPI_DBG2_SERIAL_PORT 0x8000
493 #define ACPI_DBG2_1394_PORT 0x8001
494 #define ACPI_DBG2_USB_PORT 0x8002
495 #define ACPI_DBG2_NET_PORT 0x8003
497 /* Subtypes for port_subtype field */
499 #define ACPI_DBG2_16550_COMPATIBLE 0x0000
500 #define ACPI_DBG2_16550_SUBSET 0x0001
501 #define ACPI_DBG2_ARM_PL011 0x0003
502 #define ACPI_DBG2_ARM_SBSA_32BIT 0x000D
503 #define ACPI_DBG2_ARM_SBSA_GENERIC 0x000E
504 #define ACPI_DBG2_ARM_DCC 0x000F
505 #define ACPI_DBG2_BCM2835 0x0010
507 #define ACPI_DBG2_1394_STANDARD 0x0000
509 #define ACPI_DBG2_USB_XHCI 0x0000
510 #define ACPI_DBG2_USB_EHCI 0x0001
512 #define ACPI_DBG2_UNKNOWN 0x00FF
514 /* DBG2: Microsoft Debug Port Table 2 header */
515 struct __packed acpi_dbg2_header {
516 struct acpi_table_header header;
521 /* DBG2: Microsoft Debug Port Table 2 device entry */
522 struct __packed acpi_dbg2_device {
526 u16 namespace_string_length;
527 u16 namespace_string_offset;
533 u16 base_address_offset;
534 u16 address_size_offset;
537 /* SPCR (Serial Port Console Redirection table) */
538 struct __packed acpi_spcr {
539 struct acpi_table_header header;
542 struct acpi_gen_regaddr serial_port;
545 u32 interrupt; /* Global system interrupt */
552 u16 pci_device_id; /* Must be 0xffff if not PCI device */
553 u16 pci_vendor_id; /* Must be 0xffff if not PCI device */
562 /* Tables defined/reserved by ACPI and generated by U-Boot */
593 * acpi_get_table_revision() - Get the revision number generated for a table
595 * This keeps the version-number information in one place
597 * @table: ACPI table to check
598 * Return: version number that U-Boot generates
600 int acpi_get_table_revision(enum acpi_tables table);
603 * acpi_create_dmar() - Create a DMA Remapping Reporting (DMAR) table
605 * @dmar: Place to put the table
606 * @flags: DMAR flags to use
607 * Return: 0 if OK, -ve on error
609 int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags);
612 * acpi_create_dbg2() - Create a DBG2 table
614 * This table describes how to access the debug UART
616 * @dbg2: Place to put information
617 * @port_type: Serial port type (see ACPI_DBG2_...)
618 * @port_subtype: Serial port sub-type (see ACPI_DBG2_...)
619 * @address: ACPI address of port
620 * @address_size: Size of address space
621 * @device_path: Path of device (created using acpi_device_path())
623 void acpi_create_dbg2(struct acpi_dbg2_header *dbg2,
624 int port_type, int port_subtype,
625 struct acpi_gen_regaddr *address, uint32_t address_size,
626 const char *device_path);
629 * acpi_fill_header() - Set up a new table header
631 * This sets all fields except length, revision, checksum and aslc_revision
633 * @header: ACPI header to update
634 * @signature: Table signature to use (4 characters)
636 void acpi_fill_header(struct acpi_table_header *header, char *signature);
639 * acpi_align() - Align the ACPI output pointer to a 16-byte boundary
643 void acpi_align(struct acpi_ctx *ctx);
646 * acpi_align64() - Align the ACPI output pointer to a 64-byte boundary
650 void acpi_align64(struct acpi_ctx *ctx);
653 * acpi_inc() - Increment the ACPI output pointer by a bit
655 * The pointer is NOT aligned afterwards.
658 * @amount: Amount to increment by
660 void acpi_inc(struct acpi_ctx *ctx, uint amount);
663 * acpi_inc_align() - Increment the ACPI output pointer by a bit and align
665 * The pointer is aligned afterwards to a 16-byte boundary
668 * @amount: Amount to increment by
670 void acpi_inc_align(struct acpi_ctx *ctx, uint amount);
673 * acpi_add_table() - Add a new table to the RSDP and XSDT
676 * @table: Table to add
677 * Return: 0 if OK, -E2BIG if too many tables
679 int acpi_add_table(struct acpi_ctx *ctx, void *table);
682 * acpi_setup_base_tables() - Set up context along with RSDP, RSDT and XSDT
684 * Set up the context with the given start position. Some basic tables are
685 * always needed, so set them up as well.
687 * @ctx: Context to set up
689 void acpi_setup_base_tables(struct acpi_ctx *ctx, void *start);
692 * acpi_write_rsdp() - Write out an RSDP indicating where the ACPI tables are
694 * @rsdp: Address to write RSDP
695 * @rsdt: Address of RSDT
696 * @xsdt: Address of XSDT
698 void acpi_write_rsdp(struct acpi_rsdp *rsdp, struct acpi_rsdt *rsdt,
699 struct acpi_xsdt *xsdt);
701 #endif /* !__ACPI__*/
703 #include <asm/acpi_table.h>
705 #endif /* __ACPI_TABLE_H__ */