xref: /openbsd/sys/dev/acpi/acpireg.h (revision 5a38ef86)
1 /*	$OpenBSD: acpireg.h,v 1.56 2021/10/23 16:39:03 dv Exp $	*/
2 /*
3  * Copyright (c) 2005 Thorsten Lockert <tholo@sigmasoft.com>
4  * Copyright (c) 2005 Marco Peereboom <marco@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #ifndef _DEV_ACPI_ACPIREG_H_
20 #define _DEV_ACPI_ACPIREG_H_
21 
22 /*	Root System Descriptor Pointer */
23 struct acpi_rsdp1 {
24 	uint8_t		signature[8];
25 #define	RSDP_SIG	"RSD PTR "
26 #define	rsdp_signaturee	rsdp1.signature
27 	uint8_t		checksum;	/* make sum == 0 */
28 #define	rsdp_checksum	rsdp1.checksum
29 	uint8_t		oemid[6];
30 #define	rsdp_oemid	rsdp1.oemid
31 	uint8_t		revision;	/* 0 for 1, 2 for 2 */
32 #define	rsdp_revision	rsdp1.revision
33 	uint32_t	rsdt;		/* physical */
34 #define	rsdp_rsdt	rsdp1.rsdt
35 } __packed;
36 
37 struct acpi_rsdp {
38 	struct acpi_rsdp1 rsdp1;
39 	/*
40 	 * The following values are only valid
41 	 * when rsdp_revision == 2
42 	 */
43 	uint32_t	rsdp_length;		/* length of rsdp */
44 	uint64_t	rsdp_xsdt;		/* physical */
45 	uint8_t		rsdp_extchecksum;	/* entire table */
46 	uint8_t		rsdp_reserved[3];	/* must be zero */
47 } __packed;
48 
49 struct acpi_table_header {
50 	uint8_t		signature[4];
51 #define	hdr_signature		hdr.signature
52 	uint32_t	length;
53 #define	hdr_length		hdr.length
54 	uint8_t		revision;
55 #define	hdr_revision		hdr.revision
56 	uint8_t		checksum;
57 #define	hdr_checksum		hdr.checksum
58 	uint8_t		oemid[6];
59 #define hdr_oemid		hdr.oemid
60 	uint8_t		oemtableid[8];
61 #define hdr_oemtableid		hdr.oemtableid
62 	uint32_t	oemrevision;
63 #define	hdr_oemrevision		hdr.oemrevision
64 	uint8_t		aslcompilerid[4];
65 #define hdr_aslcompilerid	hdr.aslcompilerid
66 	uint32_t	aslcompilerrevision;
67 #define	hdr_aslcompilerrevision	hdr.aslcompilerrevision
68 } __packed;
69 
70 struct acpi_rsdt {
71 	struct acpi_table_header	hdr;
72 #define RSDT_SIG	"RSDT"
73 	uint32_t			table_offsets[1];
74 } __packed;
75 
76 struct acpi_xsdt {
77 	struct acpi_table_header	hdr;
78 #define XSDT_SIG	"XSDT"
79 	uint64_t			table_offsets[1];
80 } __packed;
81 
82 struct acpi_gas {
83 	uint8_t		address_space_id;
84 #define GAS_SYSTEM_MEMORY	0
85 #define GAS_SYSTEM_IOSPACE	1
86 #define GAS_PCI_CFG_SPACE	2
87 #define GAS_EMBEDDED		3
88 #define GAS_SMBUS		4
89 #define GAS_FUNCTIONAL_FIXED	127
90 	uint8_t		register_bit_width;
91 	uint8_t		register_bit_offset;
92 	uint8_t		access_size;
93 #define GAS_ACCESS_UNDEFINED	0
94 #define GAS_ACCESS_BYTE		1
95 #define GAS_ACCESS_WORD		2
96 #define GAS_ACCESS_DWORD	3
97 #define GAS_ACCESS_QWORD	4
98 	uint64_t	address;
99 } __packed;
100 
101 struct acpi_fadt {
102 	struct acpi_table_header	hdr;
103 #define	FADT_SIG	"FACP"
104 	uint32_t	firmware_ctl;	/* phys addr FACS */
105 	uint32_t	dsdt;		/* phys addr DSDT */
106 	uint8_t		int_model;	/* interrupt model (hdr_revision < 3) */
107 #define	FADT_INT_DUAL_PIC	0
108 #define	FADT_INT_MULTI_APIC	1
109 	uint8_t		pm_profile;	/* power mgmt profile */
110 #define	FADT_PM_UNSPEC		0
111 #define	FADT_PM_DESKTOP		1
112 #define	FADT_PM_MOBILE		2
113 #define	FADT_PM_WORKSTATION	3
114 #define	FADT_PM_ENT_SERVER	4
115 #define	FADT_PM_SOHO_SERVER	5
116 #define	FADT_PM_APPLIANCE	6
117 #define	FADT_PM_PERF_SERVER	7
118 	uint16_t	sci_int;	/* SCI interrupt */
119 	uint32_t	smi_cmd;	/* SMI command port */
120 	uint8_t		acpi_enable;	/* value to enable */
121 	uint8_t		acpi_disable;	/* value to disable */
122 	uint8_t		s4bios_req;	/* value for S4 */
123 	uint8_t		pstate_cnt;	/* value for performance (hdr_revision > 2) */
124 	uint32_t	pm1a_evt_blk;	/* power management 1a */
125 	uint32_t	pm1b_evt_blk;	/* power mangement 1b */
126 	uint32_t	pm1a_cnt_blk;	/* pm control 1a */
127 	uint32_t	pm1b_cnt_blk;	/* pm control 1b */
128 	uint32_t	pm2_cnt_blk;	/* pm control 2 */
129 	uint32_t	pm_tmr_blk;
130 	uint32_t	gpe0_blk;
131 	uint32_t	gpe1_blk;
132 	uint8_t		pm1_evt_len;
133 	uint8_t		pm1_cnt_len;
134 	uint8_t		pm2_cnt_len;
135 	uint8_t		pm_tmr_len;
136 	uint8_t		gpe0_blk_len;
137 	uint8_t		gpe1_blk_len;
138 	uint8_t		gpe1_base;
139 	uint8_t		cst_cnt;	/* (hdr_revision > 2) */
140 	uint16_t	p_lvl2_lat;
141 	uint16_t	p_lvl3_lat;
142 	uint16_t	flush_size;
143 	uint16_t	flush_stride;
144 	uint8_t		duty_offset;
145 	uint8_t		duty_width;
146 	uint8_t		day_alrm;
147 	uint8_t		mon_alrm;
148 	uint8_t		century;
149 	uint16_t	iapc_boot_arch;	/* (hdr_revision > 2) */
150 #define	FADT_LEGACY_DEVICES		0x0001	/* Legacy devices supported */
151 #define	FADT_i8042			0x0002	/* Keyboard controller present */
152 #define	FADT_NO_VGA			0x0004	/* Do not probe VGA */
153 #define	FADT_NO_MSI			0x0008	/* Do not enable MSI */
154 	uint8_t		reserved1;
155 	uint32_t	flags;
156 #define	FADT_WBINVD			0x00000001
157 #define	FADT_WBINVD_FLUSH		0x00000002
158 #define	FADT_PROC_C1			0x00000004
159 #define	FADT_P_LVL2_UP			0x00000008
160 #define	FADT_PWR_BUTTON			0x00000010
161 #define	FADT_SLP_BUTTON			0x00000020
162 #define	FADT_FIX_RTC			0x00000040
163 #define	FADT_RTC_S4			0x00000080
164 #define	FADT_TMR_VAL_EXT		0x00000100
165 #define	FADT_DCK_CAP			0x00000200
166 #define	FADT_RESET_REG_SUP		0x00000400
167 #define	FADT_SEALED_CASE		0x00000800
168 #define	FADT_HEADLESS			0x00001000
169 #define	FADT_CPU_SW_SLP			0x00002000
170 #define	FADT_PCI_EXP_WAK		0x00004000
171 #define	FADT_USE_PLATFORM_CLOCK		0x00008000
172 #define	FADT_S4_RTC_STS_VALID		0x00010000
173 #define	FADT_REMOTE_POWER_ON_CAPABLE	0x00020000
174 #define	FADT_FORCE_APIC_CLUSTER_MODEL	0x00040000
175 #define	FADT_FORCE_APIC_PHYS_DEST_MODE	0x00080000
176 #define	FADT_HW_REDUCED_ACPI		0x00100000
177 #define	FADT_POWER_S0_IDLE_CAPABLE	0x00200000
178 	/*
179 	 * Following values only exist when rev > 1
180 	 * If the extended addresses exists, they
181 	 * must be used in preferense to the non-
182 	 * extended values above
183 	 */
184 	struct acpi_gas	reset_reg;
185 	uint8_t		reset_value;
186 	uint8_t		reserved2a;
187 	uint8_t		reserved2b;
188 	uint8_t		fadt_minor;
189 	uint64_t	x_firmware_ctl;
190 	uint64_t	x_dsdt;
191 	struct acpi_gas	x_pm1a_evt_blk;
192 	struct acpi_gas	x_pm1b_evt_blk;
193 	struct acpi_gas	x_pm1a_cnt_blk;
194 	struct acpi_gas	x_pm1b_cnt_blk;
195 	struct acpi_gas	x_pm2_cnt_blk;
196 	struct acpi_gas	x_pm_tmr_blk;
197 	struct acpi_gas	x_gpe0_blk;
198 	struct acpi_gas	x_gpe1_blk;
199 	struct acpi_gas sleep_control_reg;
200 	struct acpi_gas sleep_status_reg;
201 } __packed;
202 
203 struct acpi_dsdt {
204 	struct acpi_table_header	hdr;
205 #define DSDT_SIG	"DSDT"
206 	uint8_t		aml[1];
207 } __packed;
208 
209 struct acpi_ssdt {
210 	struct acpi_table_header	hdr;
211 #define SSDT_SIG	"SSDT"
212 	uint8_t		aml[1];
213 } __packed;
214 
215 /*
216  * Table deprecated by ACPI 2.0
217  */
218 struct acpi_psdt {
219 	struct acpi_table_header	hdr;
220 #define PSDT_SIG	"PSDT"
221 } __packed;
222 
223 struct acpi_madt {
224 	struct acpi_table_header	hdr;
225 #define MADT_SIG	"APIC"
226 	uint32_t	local_apic_address;
227 	uint32_t	flags;
228 #define ACPI_APIC_PCAT_COMPAT	0x00000001
229 } __packed;
230 
231 struct acpi_madt_lapic {
232 	uint8_t		apic_type;
233 #define	ACPI_MADT_LAPIC		0
234 	uint8_t		length;
235 	uint8_t		acpi_proc_id;
236 	uint8_t		apic_id;
237 	uint32_t	flags;
238 #define	ACPI_PROC_ENABLE	0x00000001
239 } __packed;
240 
241 struct acpi_madt_ioapic {
242 	uint8_t		apic_type;
243 #define	ACPI_MADT_IOAPIC	1
244 	uint8_t		length;
245 	uint8_t		acpi_ioapic_id;
246 	uint8_t		reserved;
247 	uint32_t	address;
248 	uint32_t	global_int_base;
249 } __packed;
250 
251 struct acpi_madt_override {
252 	uint8_t		apic_type;
253 #define	ACPI_MADT_OVERRIDE	2
254 	uint8_t		length;
255 	uint8_t		bus;
256 #define	ACPI_OVERRIDE_BUS_ISA	0
257 	uint8_t		source;
258 	uint32_t	global_int;
259 	uint16_t	flags;
260 #define	ACPI_OVERRIDE_POLARITY_BITS	0x3
261 #define	ACPI_OVERRIDE_POLARITY_BUS		0x0
262 #define	ACPI_OVERRIDE_POLARITY_HIGH		0x1
263 #define	ACPI_OVERRIDE_POLARITY_LOW		0x3
264 #define	ACPI_OVERRIDE_TRIGGER_BITS	0xc
265 #define	ACPI_OVERRIDE_TRIGGER_BUS		0x0
266 #define	ACPI_OVERRIDE_TRIGGER_EDGE		0x4
267 #define	ACPI_OVERRIDE_TRIGGER_LEVEL		0xc
268 } __packed;
269 
270 struct acpi_madt_nmi {
271 	uint8_t		apic_type;
272 #define	ACPI_MADT_NMI		3
273 	uint8_t		length;
274 	uint16_t	flags;		/* Same flags as acpi_madt_override */
275 	uint32_t	global_int;
276 } __packed;
277 
278 struct acpi_madt_lapic_nmi {
279 	uint8_t		apic_type;
280 #define	ACPI_MADT_LAPIC_NMI	4
281 	uint8_t		length;
282 	uint8_t		acpi_proc_id;
283 	uint16_t	flags;		/* Same flags as acpi_madt_override */
284 	uint8_t		local_apic_lint;
285 } __packed;
286 
287 struct acpi_madt_lapic_override {
288 	uint8_t		apic_type;
289 #define	ACPI_MADT_LAPIC_OVERRIDE	5
290 	uint8_t		length;
291 	uint16_t	reserved;
292 	uint64_t	lapic_address;
293 } __packed;
294 
295 struct acpi_madt_io_sapic {
296 	uint8_t		apic_type;
297 #define	ACPI_MADT_IO_SAPIC	6
298 	uint8_t		length;
299 	uint8_t		iosapic_id;
300 	uint8_t		reserved;
301 	uint32_t	global_int_base;
302 	uint64_t	iosapic_address;
303 } __packed;
304 
305 struct acpi_madt_local_sapic {
306 	uint8_t		apic_type;
307 #define	ACPI_MADT_LOCAL_SAPIC	7
308 	uint8_t		length;
309 	uint8_t		acpi_proc_id;
310 	uint8_t		local_sapic_id;
311 	uint8_t		local_sapic_eid;
312 	uint8_t		reserved[3];
313 	uint32_t	flags;		/* Same flags as acpi_madt_lapic */
314 	uint32_t	acpi_proc_uid;
315 	uint8_t		acpi_proc_uid_string[1];
316 } __packed;
317 
318 struct acpi_madt_platform_int {
319 	uint8_t		apic_type;
320 #define	ACPI_MADT_PLATFORM_INT	8
321 	uint8_t		length;
322 	uint16_t	flags;		/* Same flags as acpi_madt_override */
323 	uint8_t		int_type;
324 #define	ACPI_MADT_PLATFORM_PMI		1
325 #define	ACPI_MADT_PLATFORM_INIT		2
326 #define	ACPI_MADT_PLATFORM_CORR_ERROR	3
327 	uint8_t		proc_id;
328 	uint8_t		proc_eid;
329 	uint8_t		io_sapic_vec;
330 	uint32_t	global_int;
331 	uint32_t	platform_int_flags;
332 #define	ACPI_MADT_PLATFORM_CPEI		0x00000001
333 } __packed;
334 
335 struct acpi_madt_x2apic {
336 	uint8_t		apic_type;
337 #define	ACPI_MADT_X2APIC	9
338 	uint8_t		length;
339 	uint8_t		reserved[2];
340 	uint32_t	apic_id;
341 	uint32_t	flags;		/* Same flags as acpi_madt_lapic */
342 	uint32_t	acpi_proc_uid;
343 } __packed;
344 
345 struct acpi_madt_x2apic_nmi {
346 	uint8_t		apic_type;
347 #define	ACPI_MADT_X2APIC_NMI	10
348 	uint8_t		length;
349 	uint16_t	flags;		/* Same flags as acpi_madt_override */
350 	uint32_t	apic_proc_uid;
351 	uint8_t		local_x2apic_lint;
352 	uint8_t		reserved[3];
353 } __packed;
354 
355 union acpi_madt_entry {
356 	struct acpi_madt_lapic		madt_lapic;
357 	struct acpi_madt_ioapic		madt_ioapic;
358 	struct acpi_madt_override	madt_override;
359 	struct acpi_madt_nmi		madt_nmi;
360 	struct acpi_madt_lapic_nmi	madt_lapic_nmi;
361 	struct acpi_madt_lapic_override	madt_lapic_override;
362 	struct acpi_madt_io_sapic	madt_io_sapic;
363 	struct acpi_madt_local_sapic	madt_local_sapic;
364 	struct acpi_madt_platform_int	madt_platform_int;
365 	struct acpi_madt_x2apic		madt_x2apic;
366 	struct acpi_madt_x2apic_nmi	madt_x2apic_nmi;
367 } __packed;
368 
369 struct acpi_sbst {
370 	struct acpi_table_header	hdr;
371 #define SBST_SIG	"SBST"
372 	uint32_t	warning_energy_level;
373 	uint32_t	low_energy_level;
374 	uint32_t	critical_energy_level;
375 } __packed;
376 
377 struct acpi_ecdt {
378 	struct acpi_table_header	hdr;
379 #define ECDT_SIG	"ECDT"
380 	struct acpi_gas	ec_control;
381 	struct acpi_gas ec_data;
382 	uint32_t	uid;
383 	uint8_t		gpe_bit;
384 	uint8_t		ec_id[1];
385 } __packed;
386 
387 struct acpi_srat {
388 	struct acpi_table_header	hdr;
389 #define SRAT_SIG	"SRAT"
390 	uint32_t	reserved1;
391 	uint64_t	reserved2;
392 } __packed;
393 
394 struct acpi_slit {
395 	struct acpi_table_header	hdr;
396 #define SLIT_SIG	"SLIT"
397 	uint64_t	number_of_localities;
398 } __packed;
399 
400 struct acpi_hpet {
401 	struct acpi_table_header	hdr;
402 #define HPET_SIG	"HPET"
403 	uint32_t	event_timer_block_id;
404 	struct acpi_gas	base_address;
405 	uint8_t		hpet_number;
406 	uint16_t	main_counter_min_clock_tick;
407 	uint8_t		page_protection;
408 } __packed;
409 
410 struct acpi_mcfg {
411 	struct acpi_table_header	hdr;
412 #define MCFG_SIG	"MCFG"
413 	uint8_t		reserved[8];
414 } __packed;
415 
416 struct acpi_mcfg_entry {
417 	uint64_t	base_address;
418 	uint16_t	segment;
419 	uint8_t		min_bus_number;
420 	uint8_t		max_bus_number;
421 	uint32_t	reserved1;
422 } __packed;
423 
424 struct acpi_spcr {
425 	struct acpi_table_header	hdr;
426 #define SPCR_SIG	"SPCR"
427 	uint8_t		interface_type;
428 #define SPCR_16550	0
429 #define SPCR_16450	1
430 #define SPCR_ARM_PL011	3
431 #define SPCR_ARM_SBSA	14
432 	uint8_t		reserved1[3];
433 	struct acpi_gas	base_address;
434 	uint8_t		interrupt_type;
435 	uint8_t		irq;
436 	uint32_t	gsiv;
437 	uint8_t		baud_rate;
438 	uint8_t		parity;
439 	uint8_t		stop_bits;
440 	uint8_t		flow_control;
441 	uint8_t		terminal_type;
442 	uint8_t		reserved2;
443 	uint16_t	pci_device_id;
444 	uint16_t	pci_vendor_id;
445 	uint8_t		pci_bus;
446 	uint8_t		pci_device;
447 	uint8_t		pci_function;
448 	uint32_t	pci_flags;
449 	uint8_t		pci_segment;
450 	uint32_t	reserved3;
451 } __packed;
452 
453 struct acpi_facs {
454 	uint8_t		signature[4];
455 #define	FACS_SIG	"FACS"
456 	uint32_t	length;
457 	uint32_t	hardware_signature;
458 	uint32_t	wakeup_vector;
459 	uint32_t	global_lock;
460 #define	FACS_LOCK_PENDING	0x00000001
461 #define	FACS_LOCK_OWNED		0x00000002
462 	uint32_t	flags;
463 #define	FACS_S4BIOS_F		0x00000001	/* S4BIOS_REQ supported */
464 	uint64_t	x_wakeup_vector;
465 	uint8_t		version;
466 	uint8_t		reserved[31];
467 } __packed;
468 
469 struct acpi_tpm2 {
470 	struct acpi_table_header	hdr;
471 #define TPM2_SIG	"TPM2"
472 	uint32_t	reserved;
473 	uint64_t	control_addr;
474 	uint32_t	start_method;
475 } __packed;
476 
477 /*
478  * Intel ACPI DMA Remapping Entries
479  */
480 struct acpidmar_devpath {
481 	uint8_t		device;
482 	uint8_t		function;
483 } __packed;
484 
485 struct acpidmar_devscope {
486 	uint8_t		type;
487 #define DMAR_ENDPOINT			0x1
488 #define DMAR_BRIDGE			0x2
489 #define DMAR_IOAPIC			0x3
490 #define DMAR_HPET			0x4
491 	uint8_t		length;
492 	uint16_t	reserved;
493 	uint8_t		enumid;
494 	uint8_t		bus;
495 } __packed;
496 
497 /* DMA Remapping Hardware Unit */
498 struct acpidmar_drhd {
499 	uint16_t	type;
500 	uint16_t	length;
501 
502 	uint8_t		flags;
503 	uint8_t		reserved;
504 	uint16_t	segment;
505 	uint64_t	address;
506 	/* struct acpidmar_devscope[]; */
507 } __packed;
508 
509 /* Reserved Memory Region Reporting */
510 struct acpidmar_rmrr {
511 	uint16_t	type;
512 	uint16_t	length;
513 
514 	uint16_t	reserved;
515 	uint16_t	segment;
516 	uint64_t	base;
517 	uint64_t	limit;
518 	/* struct acpidmar_devscope[]; */
519 } __packed;
520 
521 /* Root Port ATS Capability Reporting */
522 struct acpidmar_atsr {
523 	uint16_t	type;
524 	uint16_t	length;
525 
526 	uint8_t		flags;
527 	uint8_t		reserved;
528 	uint16_t	segment;
529 	/* struct acpidmar_devscope[]; */
530 } __packed;
531 
532 union acpidmar_entry {
533 	struct {
534 		uint16_t	type;
535 #define DMAR_DRHD			0x0
536 #define DMAR_RMRR			0x1
537 #define DMAR_ATSR			0x2
538 #define DMAR_RHSA			0x3
539 		uint16_t	length;
540 	} __packed;
541 	struct acpidmar_drhd	drhd;
542 	struct acpidmar_rmrr	rmrr;
543 	struct acpidmar_atsr	atsr;
544 } __packed;
545 
546 struct acpi_dmar {
547 	struct acpi_table_header	hdr;
548 #define DMAR_SIG	"DMAR"
549 	uint8_t		haw;
550 	uint8_t		flags;
551 	uint8_t		reserved[10];
552 	/* struct acpidmar_entry[]; */
553 } __packed;
554 
555 /*
556  * AMD I/O Virtualization Remapping Entries
557  */
558 union acpi_ivhd_entry {
559 	uint8_t		type;
560 #define IVHD_ALL			1
561 #define IVHD_SEL			2
562 #define IVHD_SOR			3
563 #define IVHD_EOR			4
564 #define IVHD_ALIAS_SEL			66
565 #define IVHD_ALIAS_SOR			67
566 #define IVHD_EXT_SEL			70
567 #define IVHD_EXT_SOR			71
568 #define IVHD_SPECIAL			72
569 	struct {
570 		uint8_t		type;
571 		uint16_t	resvd;
572 		uint8_t		data;
573 	} __packed all;
574 	struct {
575 		uint8_t		type;
576 		uint16_t	devid;
577 		uint8_t		data;
578 	} __packed sel;
579 	struct {
580 		uint8_t		type;
581 		uint16_t	devid;
582 		uint8_t		data;
583 	} __packed sor;
584 	struct {
585 		uint8_t		type;
586 		uint16_t	devid;
587 		uint8_t		resvd;
588 	} __packed eor;
589 	struct {
590 		uint8_t		type;
591 		uint16_t	devid;
592 		uint8_t		data;
593 		uint8_t		resvd1;
594 		uint16_t	srcid;
595 		uint8_t		resvd2;
596 	} __packed alias;
597 	struct {
598 		uint8_t		type;
599 		uint16_t	devid;
600 		uint8_t		data;
601 		uint32_t	extdata;
602 #define IVHD_ATS_DIS			(1L << 31)
603 	} __packed ext;
604 	struct {
605 		uint8_t		type;
606 		uint16_t	resvd;
607 		uint8_t		data;
608 		uint8_t		handle;
609 		uint16_t	devid;
610 		uint8_t		variety;
611 #define IVHD_IOAPIC			0x01
612 #define IVHD_HPET			0x02
613 	} __packed special;
614 } __packed;
615 
616 struct acpi_ivmd {
617 	uint8_t		type;
618 	uint8_t		flags;
619 #define	IVMD_EXCLRANGE			(1L << 3)
620 #define IVMD_IW				(1L << 2)
621 #define IVMD_IR				(1L << 1)
622 #define IVMD_UNITY			(1L << 0)
623 	uint16_t	length;
624 	uint16_t	devid;
625 	uint16_t	auxdata;
626 	uint8_t		reserved[8];
627 	uint64_t	base;
628 	uint64_t	limit;
629 } __packed;
630 
631 struct acpi_ivhd {
632 	uint8_t		type;
633 	uint8_t		flags;
634 #define IVHD_PPRSUP		(1L << 7)
635 #define IVHD_PREFSUP		(1L << 6)
636 #define IVHD_COHERENT		(1L << 5)
637 #define IVHD_IOTLB		(1L << 4)
638 #define IVHD_ISOC		(1L << 3)
639 #define IVHD_RESPASSPW		(1L << 2)
640 #define IVHD_PASSPW		(1L << 1)
641 #define IVHD_HTTUNEN		(1L << 0)
642 	uint16_t	length;
643 	uint16_t	devid;
644 	uint16_t	cap;
645 	uint64_t	address;
646 	uint16_t	segment;
647 	uint16_t	info;
648 #define IVHD_UNITID_SHIFT	8
649 #define IVHD_UNITID_MASK	0x1F
650 #define IVHD_MSINUM_SHIFT	0
651 #define IVHD_MSINUM_MASK	0x1F
652 	uint32_t	feature;
653 } __packed;
654 
655 struct acpi_ivhd_ext {
656 	uint8_t		type;
657 	uint8_t		flags;
658 	uint16_t	length;
659 	uint16_t	devid;
660 	uint16_t	cap;
661 	uint64_t	address;
662 	uint16_t	segment;
663 	uint16_t	info;
664 	uint32_t	attrib;
665 	uint64_t	efr;
666 	uint8_t		reserved[8];
667 } __packed;
668 
669 union acpi_ivrs_entry {
670 	struct {
671 		uint8_t		type;
672 #define IVRS_IVHD			0x10
673 #define IVRS_IVHD_EXT			0x11
674 #define IVRS_IVMD_ALL			0x20
675 #define IVRS_IVMD_SPECIFIED		0x21
676 #define IVRS_IVMD_RANGE			0x22
677 		uint8_t		flags;
678 		uint16_t	length;
679 	} __packed;
680 	struct acpi_ivhd	ivhd;
681 	struct acpi_ivhd_ext	ivhd_ext;
682 	struct acpi_ivmd	ivmd;
683 } __packed;
684 
685 struct acpi_ivrs {
686 	struct acpi_table_header	hdr;
687 #define IVRS_SIG	"IVRS"
688 	uint32_t		ivinfo;
689 #define IVRS_ATSRNG		(1L << 22)
690 #define IVRS_VASIZE_SHIFT	15
691 #define IVRS_VASIZE_MASK	0x7F
692 #define IVRS_PASIZE_SHIFT	8
693 #define IVRS_PASIZE_MASK	0x7F
694 	uint8_t			reserved[8];
695 } __packed;
696 
697 struct acpi_iort {
698 	struct acpi_table_header	hdr;
699 #define IORT_SIG	"IORT"
700 	uint32_t	number_of_nodes;
701 	uint32_t	offset;
702 	uint32_t	reserved;
703 } __packed;
704 
705 struct acpi_iort_node {
706 	uint8_t		type;
707 #define ACPI_IORT_ITS			0
708 #define ACPI_IORT_NAMED_COMPONENT	1
709 #define ACPI_IORT_ROOT_COMPLEX		2
710 #define ACPI_IORT_SMMU			3
711 #define ACPI_IORT_SMMU_V3		4
712 	uint16_t	length;
713 	uint8_t		revision;
714 	uint32_t	reserved1;
715 	uint32_t	number_of_mappings;
716 	uint32_t	mapping_offset;
717 } __packed;
718 
719 struct acpi_iort_nc_node {
720 	uint32_t	node_flags;
721 	uint64_t	memory_access_properties;
722 	uint8_t		device_memory_address_size_limit;
723 	char		device_object_name[];
724 } __packed;
725 
726 struct acpi_iort_rc_node {
727 	uint64_t	memory_access_properties;
728 	uint32_t	ats_attributes;
729 	uint32_t	segment;
730 	uint8_t		memory_address_size_limit;
731 	uint8_t		reserved2[3];
732 } __packed;
733 
734 struct acpi_iort_smmu_node {
735 	uint64_t	base_address;
736 	uint64_t	span;
737 	uint32_t	model;
738 #define ACPI_IORT_SMMU_V1		0
739 #define ACPI_IORT_SMMU_V2		1
740 #define ACPI_IORT_SMMU_CORELINK_MMU400	2
741 #define ACPI_IORT_SMMU_CORELINK_MMU500	3
742 #define ACPI_IORT_SMMU_CORELINK_MMU401	4
743 #define ACPI_IORT_SMMU_CAVIUM_THUNDERX	5
744 	uint32_t	flags;
745 #define ACPI_IORT_SMMU_DVM		0x00000001
746 #define ACPI_IORT_SMMU_COHERENT		0x00000002
747 	uint32_t	global_interrupt_offset;
748 	uint32_t	number_of_context_interrupts;
749 	uint32_t	context_interrupt_offset;
750 	uint32_t	number_of_pmu_interrupts;
751 	uint32_t	pmu_interrupt_offset;
752 } __packed;
753 
754 struct acpi_iort_smmu_global_interrupt {
755 	uint32_t	nsgirpt_gsiv;
756 	uint32_t	nsgirpt_flags;
757 #define ACPI_IORT_SMMU_INTR_EDGE	(1 << 0)
758 	uint32_t	nscfgirpt_gsiv;
759 	uint32_t	nscfgirpt_flags;
760 } __packed;
761 
762 struct acpi_iort_smmu_context_interrupt {
763 	uint32_t	gsiv;
764 	uint32_t	flags;
765 } __packed;
766 
767 struct acpi_iort_smmu_pmu_interrupt {
768 	uint32_t	gsiv;
769 	uint32_t	flags;
770 } __packed;
771 
772 struct acpi_iort_mapping {
773 	uint32_t	input_base;
774 	uint32_t	number_of_ids;
775 	uint32_t	output_base;
776 	uint32_t	output_reference;
777 	uint32_t	flags;
778 #define ACPI_IORT_MAPPING_SINGLE	0x00000001
779 } __packed;
780 
781 #define ACPI_FREQUENCY	3579545		/* Per ACPI spec */
782 
783 /*
784  * PCI Configuration space
785  */
786 #define ACPI_ADR_PCIDEV(addr)	(uint16_t)(addr >> 16)
787 #define ACPI_ADR_PCIFUN(addr)	(uint16_t)(addr & 0xFFFF)
788 
789 #define ACPI_PCI_SEG(addr) (uint16_t)((addr) >> 48)
790 #define ACPI_PCI_BUS(addr) (uint8_t)((addr) >> 40)
791 #define ACPI_PCI_DEV(addr) (uint8_t)((addr) >> 32)
792 #define ACPI_PCI_FN(addr)  (uint16_t)((addr) >> 16)
793 #define ACPI_PCI_REG(addr) (uint16_t)(addr)
794 
795 /*
796  * PM1 Status Registers Fixed Hardware Feature Status Bits
797  */
798 #define	ACPI_PM1_STATUS			0x00
799 #define		ACPI_PM1_TMR_STS		0x0001
800 #define		ACPI_PM1_BM_STS			0x0010
801 #define		ACPI_PM1_GBL_STS		0x0020
802 #define		ACPI_PM1_PWRBTN_STS		0x0100
803 #define		ACPI_PM1_SLPBTN_STS		0x0200
804 #define		ACPI_PM1_RTC_STS		0x0400
805 #define		ACPI_PM1_PCIEXP_WAKE_STS	0x4000
806 #define		ACPI_PM1_WAK_STS		0x8000
807 
808 #define	ACPI_PM1_ALL_STS (ACPI_PM1_TMR_STS | ACPI_PM1_BM_STS | \
809 	    ACPI_PM1_GBL_STS | ACPI_PM1_PWRBTN_STS | \
810 	    ACPI_PM1_SLPBTN_STS | ACPI_PM1_RTC_STS | \
811 	    ACPI_PM1_PCIEXP_WAKE_STS | ACPI_PM1_WAK_STS )
812 
813 /*
814  * PM1 Enable Registers
815  */
816 #define	ACPI_PM1_ENABLE			0x02
817 #define		ACPI_PM1_TMR_EN			0x0001
818 #define		ACPI_PM1_GBL_EN			0x0020
819 #define		ACPI_PM1_PWRBTN_EN		0x0100
820 #define		ACPI_PM1_SLPBTN_EN		0x0200
821 #define		ACPI_PM1_RTC_EN			0x0400
822 #define		ACPI_PM1_PCIEXP_WAKE_DIS	0x4000
823 
824 /*
825  * PM1 Control Registers
826  */
827 #define	ACPI_PM1_CONTROL		0x00
828 #define		ACPI_PM1_SCI_EN			0x0001
829 #define		ACPI_PM1_BM_RLD			0x0002
830 #define		ACPI_PM1_GBL_RLS		0x0004
831 #define		ACPI_PM1_SLP_TYPX(x)		((x) << 10)
832 #define		ACPI_PM1_SLP_TYPX_MASK		0x1c00
833 #define		ACPI_PM1_SLP_EN			0x2000
834 
835 /*
836  * PM2 Control Registers
837  */
838 #define ACPI_PM2_CONTROL		0x06
839 #define	ACPI_PM2_ARB_DIS		0x0001
840 
841 /*
842  * Operation Region Address Space Identifiers
843  */
844 #define ACPI_OPREG_SYSMEM	0	/* SystemMemory */
845 #define ACPI_OPREG_SYSIO	1	/* SystemIO */
846 #define ACPI_OPREG_PCICFG	2	/* PCI_Config */
847 #define ACPI_OPREG_EC		3	/* EmbeddedControl */
848 #define ACPI_OPREG_SMBUS	4	/* SMBus */
849 #define ACPI_OPREG_CMOS		5	/* CMOS */
850 #define ACPI_OPREG_PCIBAR	6	/* PCIBARTarget */
851 #define ACPI_OPREG_IPMI		7	/* IPMI */
852 #define ACPI_OPREG_GPIO		8	/* GeneralPurposeIO */
853 #define ACPI_OPREG_GSB		9	/* GenericSerialBus */
854 
855 /*
856  * Sleeping States
857  */
858 #define ACPI_STATE_S0		0
859 #define ACPI_STATE_S1		1
860 #define ACPI_STATE_S2		2
861 #define ACPI_STATE_S3		3
862 #define ACPI_STATE_S4		4
863 #define ACPI_STATE_S5		5
864 
865 /*
866  * Device Power States
867  */
868 #define ACPI_STATE_D0		0
869 #define ACPI_STATE_D1		1
870 #define ACPI_STATE_D2		2
871 #define ACPI_STATE_D3		3
872 
873 /*
874  * ACPI Device IDs
875  */
876 #define ACPI_DEV_TIM	"PNP0100"	/* System timer */
877 #define ACPI_DEV_ACPI	"PNP0C08"	/* ACPI device */
878 #define ACPI_DEV_PCIB	"PNP0A03"	/* PCI bus */
879 #define ACPI_DEV_GISAB	"PNP0A05"	/* Generic ISA Bus */
880 #define ACPI_DEV_EIOB	"PNP0A06"	/* Extended I/O Bus */
881 #define ACPI_DEV_PCIEB	"PNP0A08"	/* PCIe bus */
882 #define ACPI_DEV_MR	"PNP0C02"	/* Motherboard resources */
883 #define ACPI_DEV_NPROC	"PNP0C04"	/* Numeric data processor */
884 #define ACPI_DEV_CS	"PNP0C08"	/* ACPI-Compliant System */
885 #define ACPI_DEV_ECD	"PNP0C09"	/* Embedded Controller Device */
886 #define ACPI_DEV_CMB	"PNP0C0A"	/* Control Method Battery */
887 #define ACPI_DEV_FAN	"PNP0C0B"	/* Fan Device */
888 #define ACPI_DEV_PBD	"PNP0C0C"	/* Power Button Device */
889 #define ACPI_DEV_LD	"PNP0C0D"	/* Lid Device */
890 #define ACPI_DEV_SBD	"PNP0C0E"	/* Sleep Button Device */
891 #define ACPI_DEV_PILD	"PNP0C0F"	/* PCI Interrupt Link Device */
892 #define ACPI_DEV_MEMD	"PNP0C80"	/* Memory Device */
893 #define ACPI_DEV_MOUSE	"PNP0F13"	/* PS/2 Mouse */
894 #define ACPI_DEV_SHC	"ACPI0001"	/* SMBus 1.0 Host Controller */
895 #define ACPI_DEV_SBS	"ACPI0002"	/* Smart Battery Subsystem */
896 #define ACPI_DEV_AC	"ACPI0003"	/* AC Device */
897 #define ACPI_DEV_MD	"ACPI0004"	/* Module Device */
898 #define ACPI_DEV_SMBUS	"ACPI0005"	/* SMBus 2.0 Host Controller */
899 #define ACPI_DEV_GBD	"ACPI0006"	/* GPE Block Device */
900 #define ACPI_DEV_PD	"ACPI0007"	/* Processor Device */
901 #define ACPI_DEV_ALSD	"ACPI0008"	/* Ambient Light Sensor Device */
902 #define ACPI_DEV_IOXA	"ACPI0009"	/* IO x APIC Device */
903 #define ACPI_DEV_IOA	"ACPI000A"	/* IO APIC Device */
904 #define ACPI_DEV_IOSA	"ACPI000B"	/* IO SAPIC Device */
905 #define ACPI_DEV_THZ	"THERMALZONE"	/* Thermal Zone */
906 #define ACPI_DEV_FFB	"FIXEDBUTTON"	/* Fixed Feature Button */
907 #define ACPI_DEV_IPMI	"IPI0001"	/* IPMI */
908 
909 #endif	/* !_DEV_ACPI_ACPIREG_H_ */
910