xref: /openbmc/u-boot/arch/x86/include/asm/acpi_table.h (revision d94604d5)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Based on acpi.c from coreboot
4  *
5  * Copyright (C) 2015, Saket Sinha <saket.sinha89@gmail.com>
6  * Copyright (C) 2016, Bin Meng <bmeng.cn@gmail.com>
7  */
8 
9 #ifndef __ASM_ACPI_TABLE_H__
10 #define __ASM_ACPI_TABLE_H__
11 
12 #define RSDP_SIG		"RSD PTR "	/* RSDP pointer signature */
13 #define OEM_ID			"U-BOOT"	/* U-Boot */
14 #define OEM_TABLE_ID		"U-BOOTBL"	/* U-Boot Table */
15 #define ASLC_ID			"INTL"		/* Intel ASL Compiler */
16 
17 #define ACPI_RSDP_REV_ACPI_1_0	0
18 #define ACPI_RSDP_REV_ACPI_2_0	2
19 
20 /*
21  * RSDP (Root System Description Pointer)
22  * Note: ACPI 1.0 didn't have length, xsdt_address, and ext_checksum
23  */
24 struct acpi_rsdp {
25 	char signature[8];	/* RSDP signature */
26 	u8 checksum;		/* Checksum of the first 20 bytes */
27 	char oem_id[6];		/* OEM ID */
28 	u8 revision;		/* 0 for ACPI 1.0, others 2 */
29 	u32 rsdt_address;	/* Physical address of RSDT (32 bits) */
30 	u32 length;		/* Total RSDP length (incl. extended part) */
31 	u64 xsdt_address;	/* Physical address of XSDT (64 bits) */
32 	u8 ext_checksum;	/* Checksum of the whole table */
33 	u8 reserved[3];
34 };
35 
36 /* Generic ACPI header, provided by (almost) all tables */
37 struct acpi_table_header {
38 	char signature[4];	/* ACPI signature (4 ASCII characters) */
39 	u32 length;		/* Table length in bytes (incl. header) */
40 	u8 revision;		/* Table version (not ACPI version!) */
41 	volatile u8 checksum;	/* To make sum of entire table == 0 */
42 	char oem_id[6];		/* OEM identification */
43 	char oem_table_id[8];	/* OEM table identification */
44 	u32 oem_revision;	/* OEM revision number */
45 	char aslc_id[4];	/* ASL compiler vendor ID */
46 	u32 aslc_revision;	/* ASL compiler revision number */
47 };
48 
49 /* A maximum number of 32 ACPI tables ought to be enough for now */
50 #define MAX_ACPI_TABLES		32
51 
52 /* RSDT (Root System Description Table) */
53 struct acpi_rsdt {
54 	struct acpi_table_header header;
55 	u32 entry[MAX_ACPI_TABLES];
56 };
57 
58 /* XSDT (Extended System Description Table) */
59 struct acpi_xsdt {
60 	struct acpi_table_header header;
61 	u64 entry[MAX_ACPI_TABLES];
62 };
63 
64 /* FADT Preferred Power Management Profile */
65 enum acpi_pm_profile {
66 	ACPI_PM_UNSPECIFIED = 0,
67 	ACPI_PM_DESKTOP,
68 	ACPI_PM_MOBILE,
69 	ACPI_PM_WORKSTATION,
70 	ACPI_PM_ENTERPRISE_SERVER,
71 	ACPI_PM_SOHO_SERVER,
72 	ACPI_PM_APPLIANCE_PC,
73 	ACPI_PM_PERFORMANCE_SERVER,
74 	ACPI_PM_TABLET
75 };
76 
77 /* FADT flags for p_lvl2_lat and p_lvl3_lat */
78 #define ACPI_FADT_C2_NOT_SUPPORTED	101
79 #define ACPI_FADT_C3_NOT_SUPPORTED	1001
80 
81 /* FADT Boot Architecture Flags */
82 #define ACPI_FADT_LEGACY_FREE		0x00
83 #define ACPI_FADT_LEGACY_DEVICES	(1 << 0)
84 #define ACPI_FADT_8042			(1 << 1)
85 #define ACPI_FADT_VGA_NOT_PRESENT	(1 << 2)
86 #define ACPI_FADT_MSI_NOT_SUPPORTED	(1 << 3)
87 #define ACPI_FADT_NO_PCIE_ASPM_CONTROL	(1 << 4)
88 
89 /* FADT Feature Flags */
90 #define ACPI_FADT_WBINVD		(1 << 0)
91 #define ACPI_FADT_WBINVD_FLUSH		(1 << 1)
92 #define ACPI_FADT_C1_SUPPORTED		(1 << 2)
93 #define ACPI_FADT_C2_MP_SUPPORTED	(1 << 3)
94 #define ACPI_FADT_POWER_BUTTON		(1 << 4)
95 #define ACPI_FADT_SLEEP_BUTTON		(1 << 5)
96 #define ACPI_FADT_FIXED_RTC		(1 << 6)
97 #define ACPI_FADT_S4_RTC_WAKE		(1 << 7)
98 #define ACPI_FADT_32BIT_TIMER		(1 << 8)
99 #define ACPI_FADT_DOCKING_SUPPORTED	(1 << 9)
100 #define ACPI_FADT_RESET_REGISTER	(1 << 10)
101 #define ACPI_FADT_SEALED_CASE		(1 << 11)
102 #define ACPI_FADT_HEADLESS		(1 << 12)
103 #define ACPI_FADT_SLEEP_TYPE		(1 << 13)
104 #define ACPI_FADT_PCI_EXPRESS_WAKE	(1 << 14)
105 #define ACPI_FADT_PLATFORM_CLOCK	(1 << 15)
106 #define ACPI_FADT_S4_RTC_VALID		(1 << 16)
107 #define ACPI_FADT_REMOTE_POWER_ON	(1 << 17)
108 #define ACPI_FADT_APIC_CLUSTER		(1 << 18)
109 #define ACPI_FADT_APIC_PHYSICAL		(1 << 19)
110 #define ACPI_FADT_HW_REDUCED_ACPI	(1 << 20)
111 #define ACPI_FADT_LOW_PWR_IDLE_S0	(1 << 21)
112 
113 enum acpi_address_space_type {
114 	ACPI_ADDRESS_SPACE_MEMORY = 0,	/* System memory */
115 	ACPI_ADDRESS_SPACE_IO,		/* System I/O */
116 	ACPI_ADDRESS_SPACE_PCI,		/* PCI config space */
117 	ACPI_ADDRESS_SPACE_EC,		/* Embedded controller */
118 	ACPI_ADDRESS_SPACE_SMBUS,	/* SMBus */
119 	ACPI_ADDRESS_SPACE_PCC = 0x0a,	/* Platform Comm. Channel */
120 	ACPI_ADDRESS_SPACE_FIXED = 0x7f	/* Functional fixed hardware */
121 };
122 
123 enum acpi_address_space_size {
124 	ACPI_ACCESS_SIZE_UNDEFINED = 0,
125 	ACPI_ACCESS_SIZE_BYTE_ACCESS,
126 	ACPI_ACCESS_SIZE_WORD_ACCESS,
127 	ACPI_ACCESS_SIZE_DWORD_ACCESS,
128 	ACPI_ACCESS_SIZE_QWORD_ACCESS
129 };
130 
131 struct acpi_gen_regaddr {
132 	u8 space_id;	/* Address space ID */
133 	u8 bit_width;	/* Register size in bits */
134 	u8 bit_offset;	/* Register bit offset */
135 	u8 access_size;	/* Access size */
136 	u32 addrl;	/* Register address, low 32 bits */
137 	u32 addrh;	/* Register address, high 32 bits */
138 };
139 
140 /* FADT (Fixed ACPI Description Table) */
141 struct __packed acpi_fadt {
142 	struct acpi_table_header header;
143 	u32 firmware_ctrl;
144 	u32 dsdt;
145 	u8 res1;
146 	u8 preferred_pm_profile;
147 	u16 sci_int;
148 	u32 smi_cmd;
149 	u8 acpi_enable;
150 	u8 acpi_disable;
151 	u8 s4bios_req;
152 	u8 pstate_cnt;
153 	u32 pm1a_evt_blk;
154 	u32 pm1b_evt_blk;
155 	u32 pm1a_cnt_blk;
156 	u32 pm1b_cnt_blk;
157 	u32 pm2_cnt_blk;
158 	u32 pm_tmr_blk;
159 	u32 gpe0_blk;
160 	u32 gpe1_blk;
161 	u8 pm1_evt_len;
162 	u8 pm1_cnt_len;
163 	u8 pm2_cnt_len;
164 	u8 pm_tmr_len;
165 	u8 gpe0_blk_len;
166 	u8 gpe1_blk_len;
167 	u8 gpe1_base;
168 	u8 cst_cnt;
169 	u16 p_lvl2_lat;
170 	u16 p_lvl3_lat;
171 	u16 flush_size;
172 	u16 flush_stride;
173 	u8 duty_offset;
174 	u8 duty_width;
175 	u8 day_alrm;
176 	u8 mon_alrm;
177 	u8 century;
178 	u16 iapc_boot_arch;
179 	u8 res2;
180 	u32 flags;
181 	struct acpi_gen_regaddr reset_reg;
182 	u8 reset_value;
183 	u16 arm_boot_arch;
184 	u8 minor_revision;
185 	u32 x_firmware_ctl_l;
186 	u32 x_firmware_ctl_h;
187 	u32 x_dsdt_l;
188 	u32 x_dsdt_h;
189 	struct acpi_gen_regaddr x_pm1a_evt_blk;
190 	struct acpi_gen_regaddr x_pm1b_evt_blk;
191 	struct acpi_gen_regaddr x_pm1a_cnt_blk;
192 	struct acpi_gen_regaddr x_pm1b_cnt_blk;
193 	struct acpi_gen_regaddr x_pm2_cnt_blk;
194 	struct acpi_gen_regaddr x_pm_tmr_blk;
195 	struct acpi_gen_regaddr x_gpe0_blk;
196 	struct acpi_gen_regaddr x_gpe1_blk;
197 };
198 
199 /* FACS flags */
200 #define ACPI_FACS_S4BIOS_F	(1 << 0)
201 #define ACPI_FACS_64BIT_WAKE_F	(1 << 1)
202 
203 /* FACS (Firmware ACPI Control Structure) */
204 struct acpi_facs {
205 	char signature[4];		/* "FACS" */
206 	u32 length;			/* Length in bytes (>= 64) */
207 	u32 hardware_signature;		/* Hardware signature */
208 	u32 firmware_waking_vector;	/* Firmware waking vector */
209 	u32 global_lock;		/* Global lock */
210 	u32 flags;			/* FACS flags */
211 	u32 x_firmware_waking_vector_l;	/* X FW waking vector, low */
212 	u32 x_firmware_waking_vector_h;	/* X FW waking vector, high */
213 	u8 version;			/* Version 2 */
214 	u8 res1[3];
215 	u32 ospm_flags;			/* OSPM enabled flags */
216 	u8 res2[24];
217 };
218 
219 /* MADT flags */
220 #define ACPI_MADT_PCAT_COMPAT	(1 << 0)
221 
222 /* MADT (Multiple APIC Description Table) */
223 struct acpi_madt {
224 	struct acpi_table_header header;
225 	u32 lapic_addr;			/* Local APIC address */
226 	u32 flags;			/* Multiple APIC flags */
227 };
228 
229 /* MADT: APIC Structure Type*/
230 enum acpi_apic_types {
231 	ACPI_APIC_LAPIC	= 0,		/* Processor local APIC */
232 	ACPI_APIC_IOAPIC,		/* I/O APIC */
233 	ACPI_APIC_IRQ_SRC_OVERRIDE,	/* Interrupt source override */
234 	ACPI_APIC_NMI_SRC,		/* NMI source */
235 	ACPI_APIC_LAPIC_NMI,		/* Local APIC NMI */
236 	ACPI_APIC_LAPIC_ADDR_OVERRIDE,	/* Local APIC address override */
237 	ACPI_APIC_IOSAPIC,		/* I/O SAPIC */
238 	ACPI_APIC_LSAPIC,		/* Local SAPIC */
239 	ACPI_APIC_PLATFORM_IRQ_SRC,	/* Platform interrupt sources */
240 	ACPI_APIC_LX2APIC,		/* Processor local x2APIC */
241 	ACPI_APIC_LX2APIC_NMI,		/* Local x2APIC NMI */
242 };
243 
244 /* MADT: Processor Local APIC Structure */
245 
246 #define LOCAL_APIC_FLAG_ENABLED	(1 << 0)
247 
248 struct acpi_madt_lapic {
249 	u8 type;		/* Type (0) */
250 	u8 length;		/* Length in bytes (8) */
251 	u8 processor_id;	/* ACPI processor ID */
252 	u8 apic_id;		/* Local APIC ID */
253 	u32 flags;		/* Local APIC flags */
254 };
255 
256 /* MADT: I/O APIC Structure */
257 struct acpi_madt_ioapic {
258 	u8 type;		/* Type (1) */
259 	u8 length;		/* Length in bytes (12) */
260 	u8 ioapic_id;		/* I/O APIC ID */
261 	u8 reserved;
262 	u32 ioapic_addr;	/* I/O APIC address */
263 	u32 gsi_base;		/* Global system interrupt base */
264 };
265 
266 /* MADT: Interrupt Source Override Structure */
267 struct __packed acpi_madt_irqoverride {
268 	u8 type;		/* Type (2) */
269 	u8 length;		/* Length in bytes (10) */
270 	u8 bus;			/* ISA (0) */
271 	u8 source;		/* Bus-relative int. source (IRQ) */
272 	u32 gsirq;		/* Global system interrupt */
273 	u16 flags;		/* MPS INTI flags */
274 };
275 
276 /* MADT: Local APIC NMI Structure */
277 struct __packed acpi_madt_lapic_nmi {
278 	u8 type;		/* Type (4) */
279 	u8 length;		/* Length in bytes (6) */
280 	u8 processor_id;	/* ACPI processor ID */
281 	u16 flags;		/* MPS INTI flags */
282 	u8 lint;		/* Local APIC LINT# */
283 };
284 
285 /* MCFG (PCI Express MMIO config space BAR description table) */
286 struct acpi_mcfg {
287 	struct acpi_table_header header;
288 	u8 reserved[8];
289 };
290 
291 struct acpi_mcfg_mmconfig {
292 	u32 base_address_l;
293 	u32 base_address_h;
294 	u16 pci_segment_group_number;
295 	u8 start_bus_number;
296 	u8 end_bus_number;
297 	u8 reserved[4];
298 };
299 
300 /* PM1_CNT bit defines */
301 #define PM1_CNT_SCI_EN		(1 << 0)
302 
303 /* ACPI global NVS structure */
304 struct acpi_global_nvs;
305 
306 /* DBG2 definitions are partially used for SPCR interface_type */
307 
308 /* Types for port_type field */
309 
310 #define ACPI_DBG2_SERIAL_PORT		0x8000
311 #define ACPI_DBG2_1394_PORT		0x8001
312 #define ACPI_DBG2_USB_PORT		0x8002
313 #define ACPI_DBG2_NET_PORT		0x8003
314 
315 /* Subtypes for port_subtype field */
316 
317 #define ACPI_DBG2_16550_COMPATIBLE	0x0000
318 #define ACPI_DBG2_16550_SUBSET		0x0001
319 #define ACPI_DBG2_ARM_PL011		0x0003
320 #define ACPI_DBG2_ARM_SBSA_32BIT	0x000D
321 #define ACPI_DBG2_ARM_SBSA_GENERIC	0x000E
322 #define ACPI_DBG2_ARM_DCC		0x000F
323 #define ACPI_DBG2_BCM2835		0x0010
324 
325 #define ACPI_DBG2_1394_STANDARD		0x0000
326 
327 #define ACPI_DBG2_USB_XHCI		0x0000
328 #define ACPI_DBG2_USB_EHCI		0x0001
329 
330 #define ACPI_DBG2_UNKNOWN		0x00FF
331 
332 /* SPCR (Serial Port Console Redirection table) */
333 struct __packed acpi_spcr {
334 	struct acpi_table_header header;
335 	u8 interface_type;
336 	u8 reserved[3];
337 	struct acpi_gen_regaddr serial_port;
338 	u8 interrupt_type;
339 	u8 pc_interrupt;
340 	u32 interrupt;		/* Global system interrupt */
341 	u8 baud_rate;
342 	u8 parity;
343 	u8 stop_bits;
344 	u8 flow_control;
345 	u8 terminal_type;
346 	u8 reserved1;
347 	u16 pci_device_id;	/* Must be 0xffff if not PCI device */
348 	u16 pci_vendor_id;	/* Must be 0xffff if not PCI device */
349 	u8 pci_bus;
350 	u8 pci_device;
351 	u8 pci_function;
352 	u32 pci_flags;
353 	u8 pci_segment;
354 	u32 reserved2;
355 };
356 
357 /* These can be used by the target port */
358 
359 void acpi_fill_header(struct acpi_table_header *header, char *signature);
360 void acpi_create_fadt(struct acpi_fadt *fadt, struct acpi_facs *facs,
361 		      void *dsdt);
362 int acpi_create_madt_lapics(u32 current);
363 int acpi_create_madt_ioapic(struct acpi_madt_ioapic *ioapic, u8 id,
364 			    u32 addr, u32 gsi_base);
365 int acpi_create_madt_irqoverride(struct acpi_madt_irqoverride *irqoverride,
366 				 u8 bus, u8 source, u32 gsirq, u16 flags);
367 int acpi_create_madt_lapic_nmi(struct acpi_madt_lapic_nmi *lapic_nmi,
368 			       u8 cpu, u16 flags, u8 lint);
369 u32 acpi_fill_madt(u32 current);
370 int acpi_create_mcfg_mmconfig(struct acpi_mcfg_mmconfig *mmconfig, u32 base,
371 			      u16 seg_nr, u8 start, u8 end);
372 u32 acpi_fill_mcfg(u32 current);
373 void acpi_create_gnvs(struct acpi_global_nvs *gnvs);
374 ulong write_acpi_tables(ulong start);
375 
376 /**
377  * acpi_get_rsdp_addr() - get ACPI RSDP table address
378  *
379  * This routine returns the ACPI RSDP table address in the system memory.
380  *
381  * @return:	ACPI RSDP table address
382  */
383 ulong acpi_get_rsdp_addr(void);
384 
385 #endif /* __ASM_ACPI_TABLE_H__ */
386