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__
16 #include <linux/bitops.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__)
34 * RSDP (Root System Description Pointer)
35 * Note: ACPI 1.0 didn't have length, xsdt_address, and ext_checksum
38 char signature
[8]; /* RSDP signature */
39 u8 checksum
; /* Checksum of the first 20 bytes */
40 char oem_id
[6]; /* OEM ID */
41 u8 revision
; /* 0 for ACPI 1.0, others 2 */
42 u32 rsdt_address
; /* Physical address of RSDT (32 bits) */
43 u32 length
; /* Total RSDP length (incl. extended part) */
44 u64 xsdt_address
; /* Physical address of XSDT (64 bits) */
45 u8 ext_checksum
; /* Checksum of the whole table */
49 /* Generic ACPI header, provided by (almost) all tables */
50 struct __packed acpi_table_header
{
51 char signature
[4]; /* ACPI signature (4 ASCII characters) */
52 u32 length
; /* Table length in bytes (incl. header) */
53 u8 revision
; /* Table version (not ACPI version!) */
54 volatile u8 checksum
; /* To make sum of entire table == 0 */
55 char oem_id
[6]; /* OEM identification */
56 char oem_table_id
[8]; /* OEM table identification */
57 u32 oem_revision
; /* OEM revision number */
58 char aslc_id
[4]; /* ASL compiler vendor ID */
59 u32 aslc_revision
; /* ASL compiler revision number */
62 struct acpi_gen_regaddr
{
63 u8 space_id
; /* Address space ID */
64 u8 bit_width
; /* Register size in bits */
65 u8 bit_offset
; /* Register bit offset */
66 u8 access_size
; /* Access size */
67 u32 addrl
; /* Register address, low 32 bits */
68 u32 addrh
; /* Register address, high 32 bits */
71 /* A maximum number of 32 ACPI tables ought to be enough for now */
72 #define MAX_ACPI_TABLES 32
74 /* RSDT (Root System Description Table) */
76 struct acpi_table_header header
;
77 u32 entry
[MAX_ACPI_TABLES
];
80 /* XSDT (Extended System Description Table) */
82 struct acpi_table_header header
;
83 u64 entry
[MAX_ACPI_TABLES
];
87 struct __packed acpi_hpet
{
88 struct acpi_table_header header
;
90 struct acpi_gen_regaddr addr
;
96 /* FADT Preferred Power Management Profile */
97 enum acpi_pm_profile
{
98 ACPI_PM_UNSPECIFIED
= 0,
102 ACPI_PM_ENTERPRISE_SERVER
,
104 ACPI_PM_APPLIANCE_PC
,
105 ACPI_PM_PERFORMANCE_SERVER
,
109 /* FADT flags for p_lvl2_lat and p_lvl3_lat */
110 #define ACPI_FADT_C2_NOT_SUPPORTED 101
111 #define ACPI_FADT_C3_NOT_SUPPORTED 1001
113 /* FADT Boot Architecture Flags */
114 #define ACPI_FADT_LEGACY_FREE 0x00
115 #define ACPI_FADT_LEGACY_DEVICES BIT(0)
116 #define ACPI_FADT_8042 BIT(1)
117 #define ACPI_FADT_VGA_NOT_PRESENT BIT(2)
118 #define ACPI_FADT_MSI_NOT_SUPPORTED BIT(3)
119 #define ACPI_FADT_NO_PCIE_ASPM_CONTROL BIT(4)
121 /* FADT Feature Flags */
122 #define ACPI_FADT_WBINVD BIT(0)
123 #define ACPI_FADT_WBINVD_FLUSH BIT(1)
124 #define ACPI_FADT_C1_SUPPORTED BIT(2)
125 #define ACPI_FADT_C2_MP_SUPPORTED BIT(3)
126 #define ACPI_FADT_POWER_BUTTON BIT(4)
127 #define ACPI_FADT_SLEEP_BUTTON BIT(5)
128 #define ACPI_FADT_FIXED_RTC BIT(6)
129 #define ACPI_FADT_S4_RTC_WAKE BIT(7)
130 #define ACPI_FADT_32BIT_TIMER BIT(8)
131 #define ACPI_FADT_DOCKING_SUPPORTED BIT(9)
132 #define ACPI_FADT_RESET_REGISTER BIT(10)
133 #define ACPI_FADT_SEALED_CASE BIT(11)
134 #define ACPI_FADT_HEADLESS BIT(12)
135 #define ACPI_FADT_SLEEP_TYPE BIT(13)
136 #define ACPI_FADT_PCI_EXPRESS_WAKE BIT(14)
137 #define ACPI_FADT_PLATFORM_CLOCK BIT(15)
138 #define ACPI_FADT_S4_RTC_VALID BIT(16)
139 #define ACPI_FADT_REMOTE_POWER_ON BIT(17)
140 #define ACPI_FADT_APIC_CLUSTER BIT(18)
141 #define ACPI_FADT_APIC_PHYSICAL BIT(19)
142 #define ACPI_FADT_HW_REDUCED_ACPI BIT(20)
143 #define ACPI_FADT_LOW_PWR_IDLE_S0 BIT(21)
145 enum acpi_address_space_type
{
146 ACPI_ADDRESS_SPACE_MEMORY
= 0, /* System memory */
147 ACPI_ADDRESS_SPACE_IO
, /* System I/O */
148 ACPI_ADDRESS_SPACE_PCI
, /* PCI config space */
149 ACPI_ADDRESS_SPACE_EC
, /* Embedded controller */
150 ACPI_ADDRESS_SPACE_SMBUS
, /* SMBus */
151 ACPI_ADDRESS_SPACE_PCC
= 0x0a, /* Platform Comm. Channel */
152 ACPI_ADDRESS_SPACE_FIXED
= 0x7f /* Functional fixed hardware */
155 enum acpi_address_space_size
{
156 ACPI_ACCESS_SIZE_UNDEFINED
= 0,
157 ACPI_ACCESS_SIZE_BYTE_ACCESS
,
158 ACPI_ACCESS_SIZE_WORD_ACCESS
,
159 ACPI_ACCESS_SIZE_DWORD_ACCESS
,
160 ACPI_ACCESS_SIZE_QWORD_ACCESS
163 /* FADT (Fixed ACPI Description Table) */
164 struct __packed acpi_fadt
{
165 struct acpi_table_header header
;
169 u8 preferred_pm_profile
;
204 struct acpi_gen_regaddr reset_reg
;
208 u32 x_firmware_ctl_l
;
209 u32 x_firmware_ctl_h
;
212 struct acpi_gen_regaddr x_pm1a_evt_blk
;
213 struct acpi_gen_regaddr x_pm1b_evt_blk
;
214 struct acpi_gen_regaddr x_pm1a_cnt_blk
;
215 struct acpi_gen_regaddr x_pm1b_cnt_blk
;
216 struct acpi_gen_regaddr x_pm2_cnt_blk
;
217 struct acpi_gen_regaddr x_pm_tmr_blk
;
218 struct acpi_gen_regaddr x_gpe0_blk
;
219 struct acpi_gen_regaddr x_gpe1_blk
;
222 /* FADT TABLE Revision values - note these do not match the ACPI revision */
223 #define ACPI_FADT_REV_ACPI_1_0 1
224 #define ACPI_FADT_REV_ACPI_2_0 3
225 #define ACPI_FADT_REV_ACPI_3_0 4
226 #define ACPI_FADT_REV_ACPI_4_0 4
227 #define ACPI_FADT_REV_ACPI_5_0 5
228 #define ACPI_FADT_REV_ACPI_6_0 6
230 /* MADT TABLE Revision values - note these do not match the ACPI revision */
231 #define ACPI_MADT_REV_ACPI_3_0 2
232 #define ACPI_MADT_REV_ACPI_4_0 3
233 #define ACPI_MADT_REV_ACPI_5_0 3
234 #define ACPI_MADT_REV_ACPI_6_0 5
236 #define ACPI_MCFG_REV_ACPI_3_0 1
238 /* IVRS Revision Field */
239 #define IVRS_FORMAT_FIXED 0x01 /* Type 10h & 11h only */
240 #define IVRS_FORMAT_MIXED 0x02 /* Type 10h, 11h, & 40h */
243 #define ACPI_FACS_S4BIOS_F BIT(0)
244 #define ACPI_FACS_64BIT_WAKE_F BIT(1)
246 /* FACS (Firmware ACPI Control Structure) */
248 char signature
[4]; /* "FACS" */
249 u32 length
; /* Length in bytes (>= 64) */
250 u32 hardware_signature
; /* Hardware signature */
251 u32 firmware_waking_vector
; /* Firmware waking vector */
252 u32 global_lock
; /* Global lock */
253 u32 flags
; /* FACS flags */
254 u32 x_firmware_waking_vector_l
; /* X FW waking vector, low */
255 u32 x_firmware_waking_vector_h
; /* X FW waking vector, high */
256 u8 version
; /* Version 2 */
258 u32 ospm_flags
; /* OSPM enabled flags */
263 #define ACPI_MADT_PCAT_COMPAT BIT(0)
265 /* MADT (Multiple APIC Description Table) */
267 struct acpi_table_header header
;
268 u32 lapic_addr
; /* Local APIC address */
269 u32 flags
; /* Multiple APIC flags */
272 /* MADT: APIC Structure Type*/
273 enum acpi_apic_types
{
274 ACPI_APIC_LAPIC
= 0, /* Processor local APIC */
275 ACPI_APIC_IOAPIC
, /* I/O APIC */
276 ACPI_APIC_IRQ_SRC_OVERRIDE
, /* Interrupt source override */
277 ACPI_APIC_NMI_SRC
, /* NMI source */
278 ACPI_APIC_LAPIC_NMI
, /* Local APIC NMI */
279 ACPI_APIC_LAPIC_ADDR_OVERRIDE
, /* Local APIC address override */
280 ACPI_APIC_IOSAPIC
, /* I/O SAPIC */
281 ACPI_APIC_LSAPIC
, /* Local SAPIC */
282 ACPI_APIC_PLATFORM_IRQ_SRC
, /* Platform interrupt sources */
283 ACPI_APIC_LX2APIC
, /* Processor local x2APIC */
284 ACPI_APIC_LX2APIC_NMI
, /* Local x2APIC NMI */
287 /* MADT: Processor Local APIC Structure */
289 #define LOCAL_APIC_FLAG_ENABLED BIT(0)
291 struct acpi_madt_lapic
{
292 u8 type
; /* Type (0) */
293 u8 length
; /* Length in bytes (8) */
294 u8 processor_id
; /* ACPI processor ID */
295 u8 apic_id
; /* Local APIC ID */
296 u32 flags
; /* Local APIC flags */
299 /* MADT: I/O APIC Structure */
300 struct acpi_madt_ioapic
{
301 u8 type
; /* Type (1) */
302 u8 length
; /* Length in bytes (12) */
303 u8 ioapic_id
; /* I/O APIC ID */
305 u32 ioapic_addr
; /* I/O APIC address */
306 u32 gsi_base
; /* Global system interrupt base */
309 /* MADT: Interrupt Source Override Structure */
310 struct __packed acpi_madt_irqoverride
{
311 u8 type
; /* Type (2) */
312 u8 length
; /* Length in bytes (10) */
313 u8 bus
; /* ISA (0) */
314 u8 source
; /* Bus-relative int. source (IRQ) */
315 u32 gsirq
; /* Global system interrupt */
316 u16 flags
; /* MPS INTI flags */
319 /* MADT: Local APIC NMI Structure */
320 struct __packed acpi_madt_lapic_nmi
{
321 u8 type
; /* Type (4) */
322 u8 length
; /* Length in bytes (6) */
323 u8 processor_id
; /* ACPI processor ID */
324 u16 flags
; /* MPS INTI flags */
325 u8 lint
; /* Local APIC LINT# */
328 /* MCFG (PCI Express MMIO config space BAR description table) */
330 struct acpi_table_header header
;
334 struct acpi_mcfg_mmconfig
{
337 u16 pci_segment_group_number
;
343 /* PM1_CNT bit defines */
344 #define PM1_CNT_SCI_EN BIT(0)
346 /* ACPI global NVS structure */
347 struct acpi_global_nvs
;
349 /* CSRT (Core System Resource Table) */
351 struct acpi_table_header header
;
354 struct acpi_csrt_group
{
362 u32 shared_info_length
;
365 struct acpi_csrt_shared_info
{
371 u8 interrupt_polarity
;
374 u8 dma_address_width
;
375 u16 base_request_line
;
376 u16 num_handshake_signals
;
389 DRHD_INCLUDE_PCI_ALL
= BIT(0)
393 DMAR_INTR_REMAP
= BIT(0),
394 DMAR_X2APIC_OPT_OUT
= BIT(1),
395 DMAR_CTRL_PLATFORM_OPT_IN_FLAG
= BIT(2),
407 struct dmar_rmrr_entry
{
416 /* DMAR (DMA Remapping Reporting Structure) */
417 struct __packed acpi_dmar
{
418 struct acpi_table_header header
;
419 u8 host_address_width
;
422 struct dmar_entry structure
[0];
425 /* DBG2 definitions are partially used for SPCR interface_type */
427 /* Types for port_type field */
429 #define ACPI_DBG2_SERIAL_PORT 0x8000
430 #define ACPI_DBG2_1394_PORT 0x8001
431 #define ACPI_DBG2_USB_PORT 0x8002
432 #define ACPI_DBG2_NET_PORT 0x8003
434 /* Subtypes for port_subtype field */
436 #define ACPI_DBG2_16550_COMPATIBLE 0x0000
437 #define ACPI_DBG2_16550_SUBSET 0x0001
438 #define ACPI_DBG2_ARM_PL011 0x0003
439 #define ACPI_DBG2_ARM_SBSA_32BIT 0x000D
440 #define ACPI_DBG2_ARM_SBSA_GENERIC 0x000E
441 #define ACPI_DBG2_ARM_DCC 0x000F
442 #define ACPI_DBG2_BCM2835 0x0010
444 #define ACPI_DBG2_1394_STANDARD 0x0000
446 #define ACPI_DBG2_USB_XHCI 0x0000
447 #define ACPI_DBG2_USB_EHCI 0x0001
449 #define ACPI_DBG2_UNKNOWN 0x00FF
451 /* SPCR (Serial Port Console Redirection table) */
452 struct __packed acpi_spcr
{
453 struct acpi_table_header header
;
456 struct acpi_gen_regaddr serial_port
;
459 u32 interrupt
; /* Global system interrupt */
466 u16 pci_device_id
; /* Must be 0xffff if not PCI device */
467 u16 pci_vendor_id
; /* Must be 0xffff if not PCI device */
476 /* Tables defined/reserved by ACPI and generated by U-Boot */
507 * acpi_get_table_revision() - Get the revision number generated for a table
509 * This keeps the version-number information in one place
511 * @table: ACPI table to check
512 * @return version number that U-Boot generates
514 int acpi_get_table_revision(enum acpi_tables table
);
517 * acpi_create_dmar() - Create a DMA Remapping Reporting (DMAR) table
519 * @dmar: Place to put the table
520 * @flags: DMAR flags to use
521 * @return 0 if OK, -ve on error
523 int acpi_create_dmar(struct acpi_dmar
*dmar
, enum dmar_flags flags
);
526 * acpi_fill_header() - Set up a new table header
528 * This sets all fields except length, revision, checksum and aslc_revision
530 * @header: ACPI header to update
531 * @signature: Table signature to use (4 characters)
533 void acpi_fill_header(struct acpi_table_header
*header
, char *signature
);
536 * acpi_align() - Align the ACPI output pointer to a 16-byte boundary
540 void acpi_align(struct acpi_ctx
*ctx
);
543 * acpi_align64() - Align the ACPI output pointer to a 64-byte boundary
547 void acpi_align64(struct acpi_ctx
*ctx
);
550 * acpi_inc() - Increment the ACPI output pointer by a bit
552 * The pointer is NOT aligned afterwards.
555 * @amount: Amount to increment by
557 void acpi_inc(struct acpi_ctx
*ctx
, uint amount
);
560 * acpi_inc_align() - Increment the ACPI output pointer by a bit and align
562 * The pointer is aligned afterwards to a 16-byte boundary
565 * @amount: Amount to increment by
567 void acpi_inc_align(struct acpi_ctx
*ctx
, uint amount
);
570 * acpi_add_table() - Add a new table to the RSDP and XSDT
573 * @table: Table to add
574 * @return 0 if OK, -E2BIG if too many tables
576 int acpi_add_table(struct acpi_ctx
*ctx
, void *table
);
579 * acpi_setup_base_tables() - Set up context along with RSDP, RSDT and XSDT
581 * Set up the context with the given start position. Some basic tables are
582 * always needed, so set them up as well.
584 * @ctx: Context to set up
586 void acpi_setup_base_tables(struct acpi_ctx
*ctx
, void *start
);
588 #endif /* !__ACPI__*/
590 #include <asm/acpi_table.h>
592 #endif /* __ACPI_TABLE_H__ */