xref: /netbsd-src/usr.sbin/acpitools/acpidump/acpidump.h (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /*	$NetBSD: acpidump.h,v 1.1 2007/01/14 04:36:13 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 Doug Rabson
5  * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	Id: acpidump.h,v 1.3 2000/08/09 14:47:52 iwasaki Exp
30  *	$FreeBSD: src/usr.sbin/acpi/acpidump/acpidump.h,v 1.5 2002/10/09 19:46:09 jhb Exp $
31  */
32 
33 #ifndef _ACPIDUMP_H_
34 #define _ACPIDUMP_H_
35 
36 /* Generic Address structure */
37 struct ACPIgas {
38 	u_int8_t	address_space_id;
39 #define ACPI_GAS_MEMORY		0
40 #define ACPI_GAS_IO		1
41 #define ACPI_GAS_PCI		2
42 #define ACPI_GAS_EMBEDDED	3
43 #define ACPI_GAS_SMBUS		4
44 #define ACPI_GAS_FIXED		0x7f
45 	u_int8_t	register_bit_width;
46 	u_int8_t	register_bit_offset;
47 	u_int8_t	res;
48 	u_int64_t	address;
49 } __packed;
50 
51 /* Root System Description Pointer */
52 struct ACPIrsdp {
53 	u_char		signature[8];
54 	u_char		sum;
55 	u_char		oem[6];
56 	u_char		res;
57 	u_int32_t	addr;
58 } __packed;
59 
60 /* System Description Table */
61 struct ACPIsdt {
62 	u_char		signature[4];
63 	u_int32_t	len;
64 	u_char		rev;
65 	u_char		check;
66 	u_char		oemid[6];
67 	u_char		oemtblid[8];
68 	u_int32_t	oemrev;
69 	u_char		creator[4];
70 	u_int32_t	crerev;
71 #define SIZEOF_SDT_HDR 36	/* struct size except body */
72 	u_int32_t	body[1];/* This member should be casted */
73 } __packed;
74 
75 /* Fixed ACPI Description Table (body) */
76 struct FACPbody {
77 	u_int32_t	facs_ptr;
78 	u_int32_t	dsdt_ptr;
79 	u_int8_t	int_model;
80 #define ACPI_FACP_INTMODEL_PIC	0	/* Standard PC-AT PIC */
81 #define ACPI_FACP_INTMODEL_APIC	1	/* Multiple APIC */
82 	u_char		reserved1;
83 	u_int16_t	sci_int;
84 	u_int32_t	smi_cmd;
85 	u_int8_t	acpi_enable;
86 	u_int8_t	acpi_disable;
87 	u_int8_t	s4biosreq;
88 	u_int8_t	reserved2;
89 	u_int32_t	pm1a_evt_blk;
90 	u_int32_t	pm1b_evt_blk;
91 	u_int32_t	pm1a_cnt_blk;
92 	u_int32_t	pm1b_cnt_blk;
93 	u_int32_t	pm2_cnt_blk;
94 	u_int32_t	pm_tmr_blk;
95 	u_int32_t	gpe0_blk;
96 	u_int32_t	gpe1_blk;
97 	u_int8_t	pm1_evt_len;
98 	u_int8_t	pm1_cnt_len;
99 	u_int8_t	pm2_cnt_len;
100 	u_int8_t	pm_tmr_len;
101 	u_int8_t	gpe0_len;
102 	u_int8_t	gpe1_len;
103 	u_int8_t	gpe1_base;
104 	u_int8_t	reserved3;
105 	u_int16_t	p_lvl2_lat;
106 	u_int16_t	p_lvl3_lat;
107 	u_int16_t	flush_size;
108 	u_int16_t	flush_stride;
109 	u_int8_t	duty_off;
110 	u_int8_t	duty_width;
111 	u_int8_t	day_alrm;
112 	u_int8_t	mon_alrm;
113 	u_int8_t	century;
114 	u_int16_t	iapc_boot_arch;
115 	u_char		reserved4[1];
116 	u_int32_t	flags;
117 #define ACPI_FACP_FLAG_WBINVD	1	/* WBINVD is correctly supported */
118 #define ACPI_FACP_FLAG_WBINVD_FLUSH 2	/* WBINVD flushes caches */
119 #define ACPI_FACP_FLAG_PROC_C1	4	/* C1 power state supported */
120 #define ACPI_FACP_FLAG_P_LVL2_UP 8	/* C2 power state works on SMP */
121 #define ACPI_FACP_FLAG_PWR_BUTTON 16	/* Power button uses control method */
122 #define ACPI_FACP_FLAG_SLP_BUTTON 32	/* Sleep button uses control method */
123 #define ACPI_FACP_FLAG_FIX_RTC	64	/* RTC wakeup not supported */
124 #define ACPI_FACP_FLAG_RTC_S4	128	/* RTC can wakeup from S4 state */
125 #define ACPI_FACP_FLAG_TMR_VAL_EXT 256	/* TMR_VAL is 32bit */
126 #define ACPI_FACP_FLAG_DCK_CAP	512	/* Can support docking */
127 	struct ACPIgas	reset_reg;
128 	u_int8_t	reset_value;
129 	u_int8_t	reserved5[3];
130 	u_int64_t	x_firmware_ctrl;
131 	u_int64_t	x_dsdt;
132 	struct ACPIgas	x_pm1a_evt_blk;
133 	struct ACPIgas	x_pm1b_evt_blk;
134 	struct ACPIgas	x_pm1a_cnt_blk;
135 	struct ACPIgas	x_pm1b_cnt_blk;
136 	struct ACPIgas	x_pm2_cnt_blk;
137 	struct ACPIgas	x_pm_tmr_blk;
138 	struct ACPIgas	x_gpe0_blk;
139 	struct ACPIgas	x_gpe1_blk;
140 } __packed;
141 
142 /* Firmware ACPI Control Structure */
143 struct FACS {
144 	u_char		signature[4];
145 	u_int32_t	len;
146 	u_char		hard_sig[4];
147 	/*
148 	 * NOTE This should be filled with physical address below 1MB!!
149 	 * sigh....
150 	 */
151 	u_int32_t	firm_wake_vec;
152 	u_int32_t	g_lock;		/* bit field */
153 	/* 5.2.6.1 Global Lock */
154 #define ACPI_GLOBAL_LOCK_PENDING 1
155 #define ACPI_GLOBAL_LOCK_OWNED 2
156 	u_int32_t	flags;		/* bit field */
157 #define ACPI_FACS_FLAG_S4BIOS_F	1	/* Supports S4BIOS_SEQ */
158 	char		reserved[40];
159 } __packed;
160 
161 void		*acpi_map_physical(vm_offset_t, size_t);
162 struct ACPIrsdp	*acpi_find_rsd_ptr(void);
163 int		 acpi_checksum(void *, size_t);
164 struct ACPIsdt	*acpi_map_sdt(vm_offset_t);
165 void		 acpi_print_rsd_ptr(struct ACPIrsdp *);
166 void		 acpi_print_sdt(struct ACPIsdt *);
167 void		 acpi_print_rsdt(struct ACPIsdt *);
168 void		 acpi_print_facp(struct FACPbody *);
169 void		 acpi_print_dsdt(struct ACPIsdt *);
170 
171 void		 asl_dump_termobj(u_int8_t **, int);
172 void		 asl_dump_objectlist(u_int8_t **, u_int8_t *, int);
173 
174 void		 aml_dump(struct ACPIsdt *);
175 
176 void    	 acpi_handle_rsdt(struct ACPIsdt *);
177 void		 acpi_load_dsdt(char *, u_int8_t **, u_int8_t **);
178 void		 acpi_dump_dsdt(u_int8_t *, u_int8_t *);
179 extern char	*aml_dumpfile;
180 extern struct	ACPIsdt dsdt_header;
181 extern int	rflag;
182 
183 #endif	/* !_ACPIDUMP_H_ */
184