xref: /freebsd/sys/dev/acpica/acpivar.h (revision 7660b554bc59a07be0431c17e0e33815818baa69)
1 /*-
2  * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
3  * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4  * Copyright (c) 2000 BSDi
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  *	$FreeBSD$
29  */
30 
31 #include "bus_if.h"
32 #include <sys/eventhandler.h>
33 #include <sys/sysctl.h>
34 #if __FreeBSD_version >= 500000
35 #include <sys/lock.h>
36 #include <sys/mutex.h>
37 #endif
38 
39 #include <machine/bus.h>
40 #include <machine/resource.h>
41 
42 #if __FreeBSD_version < 500000
43 typedef vm_offset_t vm_paddr_t;
44 #endif
45 
46 struct acpi_softc {
47     device_t		acpi_dev;
48     dev_t		acpi_dev_t;
49 
50     struct resource	*acpi_irq;
51     int			acpi_irq_rid;
52     void		*acpi_irq_handle;
53 
54     int			acpi_enabled;
55     int			acpi_sstate;
56     int			acpi_sleep_disabled;
57 
58     struct sysctl_ctx_list acpi_sysctl_ctx;
59     struct sysctl_oid	*acpi_sysctl_tree;
60 #define ACPI_POWER_BUTTON_DEFAULT_SX	ACPI_STATE_S5;
61 #define ACPI_SLEEP_BUTTON_DEFAULT_SX	ACPI_STATE_S1;
62 #define ACPI_LID_SWITCH_DEFAULT_SX	ACPI_STATE_S1;
63     int			acpi_power_button_sx;
64     int			acpi_sleep_button_sx;
65     int			acpi_lid_switch_sx;
66 
67     int			acpi_standby_sx;
68     int			acpi_suspend_sx;
69 
70     int			acpi_sleep_delay;
71     int			acpi_s4bios;
72     int			acpi_disable_on_poweroff;
73 
74     int			acpi_verbose;
75 
76     bus_dma_tag_t	acpi_waketag;
77     bus_dmamap_t	acpi_wakemap;
78     vm_offset_t		acpi_wakeaddr;
79     vm_paddr_t		acpi_wakephys;
80 
81     struct sysctl_ctx_list	 acpi_battery_sysctl_ctx;
82     struct sysctl_oid		*acpi_battery_sysctl_tree;
83 };
84 
85 struct acpi_device {
86     /* ACPI ivars */
87     ACPI_HANDLE			ad_handle;
88     int				ad_magic;
89     void			*ad_private;
90 
91     /* resources */
92     struct resource_list	ad_rl;
93 
94 };
95 
96 #if __FreeBSD_version < 500000
97 /*
98  * In 4.x, ACPI is protected by splhigh().
99  */
100 # define ACPI_LOCK			s = splhigh()
101 # define ACPI_UNLOCK			splx(s)
102 # define ACPI_ASSERTLOCK
103 # define ACPI_MSLEEP(a, b, c, d, e)	tsleep(a, c, d, e)
104 # define ACPI_LOCK_DECL			int s
105 # define kthread_create(a, b, c, d, e, f)	kthread_create(a, b, c, f)
106 # define tc_init(a)			init_timecounter(a)
107 #else
108 # define ACPI_LOCK
109 # define ACPI_UNLOCK
110 # define ACPI_ASSERTLOCK
111 # define ACPI_LOCK_DECL
112 #endif
113 
114 /*
115  * ACPI CA does not define layers for non-ACPI CA drivers.
116  * We define some here within the range provided.
117  */
118 #define	ACPI_BUS		0x00010000
119 #define	ACPI_SYSTEM		0x00020000
120 #define	ACPI_POWER		0x00040000
121 #define	ACPI_EC			0x00080000
122 #define	ACPI_AC_ADAPTER		0x00100000
123 #define	ACPI_BATTERY		0x00110000
124 #define	ACPI_BUTTON		0x00120000
125 #define	ACPI_PROCESSOR		0x00140000
126 #define	ACPI_THERMAL		0x00180000
127 #define	ACPI_FAN		0x00200000
128 
129 /*
130  * Constants for different interrupt models used with acpi_SetIntrModel().
131  */
132 #define	ACPI_INTR_PIC		0
133 #define	ACPI_INTR_APIC		1
134 #define	ACPI_INTR_SAPIC		2
135 
136 /*
137  * Note that the low ivar values are reserved to provide
138  * interface compatibility with ISA drivers which can also
139  * attach to ACPI.
140  */
141 #define ACPI_IVAR_HANDLE	0x100
142 #define ACPI_IVAR_MAGIC		0x101
143 #define ACPI_IVAR_PRIVATE	0x102
144 
145 extern ACPI_HANDLE	acpi_get_handle(device_t dev);
146 extern int		acpi_set_handle(device_t dev, ACPI_HANDLE h);
147 extern int		acpi_get_magic(device_t dev);
148 extern int		acpi_set_magic(device_t dev, int m);
149 extern void *		acpi_get_private(device_t dev);
150 extern int		acpi_set_private(device_t dev, void *p);
151 extern ACPI_OBJECT_TYPE	acpi_get_type(device_t dev);
152 
153 #ifdef ACPI_DEBUGGER
154 extern void		acpi_EnterDebugger(void);
155 #endif
156 
157 #ifdef ACPI_DEBUG
158 #include <sys/cons.h>
159 #define STEP(x)		do {printf x, printf("\n"); cngetc();} while (0)
160 #else
161 #define STEP(x)
162 #endif
163 
164 #define ACPI_VPRINT(dev, acpi_sc, x...) do {			\
165     if (acpi_get_verbose(acpi_sc))				\
166 	device_printf(dev, x);					\
167 } while (0)
168 
169 #define ACPI_DEVINFO_PRESENT(x)	(((x) & 0x9) == 9)
170 extern BOOLEAN		acpi_DeviceIsPresent(device_t dev);
171 extern BOOLEAN		acpi_BatteryIsPresent(device_t dev);
172 extern BOOLEAN		acpi_MatchHid(device_t dev, char *hid);
173 extern ACPI_STATUS	acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
174 					      ACPI_HANDLE *result);
175 extern ACPI_BUFFER	*acpi_AllocBuffer(int size);
176 extern ACPI_STATUS	acpi_EvaluateInteger(ACPI_HANDLE handle, char *path,
177 					     int *number);
178 extern ACPI_STATUS	acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
179 						    int *number);
180 extern ACPI_STATUS	acpi_ForeachPackageObject(ACPI_OBJECT *obj,
181 				void (*func)(ACPI_OBJECT *comp, void *arg),
182 				void *arg);
183 extern ACPI_STATUS	acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
184 						 ACPI_RESOURCE **resp);
185 extern ACPI_STATUS	acpi_AppendBufferResource(ACPI_BUFFER *buf,
186 						  ACPI_RESOURCE *res);
187 extern ACPI_STATUS	acpi_SetIntrModel(int model);
188 extern ACPI_STATUS	acpi_SetSleepState(struct acpi_softc *sc, int state);
189 extern ACPI_STATUS	acpi_Enable(struct acpi_softc *sc);
190 extern ACPI_STATUS	acpi_Disable(struct acpi_softc *sc);
191 
192 struct acpi_parse_resource_set {
193     void	(*set_init)(device_t dev, void **context);
194     void	(*set_done)(device_t dev, void *context);
195     void	(*set_ioport)(device_t dev, void *context, u_int32_t base,
196 			      u_int32_t length);
197     void	(*set_iorange)(device_t dev, void *context,
198 			       u_int32_t low, u_int32_t high,
199 			       u_int32_t length, u_int32_t align);
200     void	(*set_memory)(device_t dev, void *context, u_int32_t base,
201 			      u_int32_t length);
202     void	(*set_memoryrange)(device_t dev, void *context, u_int32_t low,
203 				   u_int32_t high, u_int32_t length,
204 				   u_int32_t align);
205     void	(*set_irq)(device_t dev, void *context, u_int32_t *irq,
206 			   int count, int trig, int pol);
207     void	(*set_drq)(device_t dev, void *context, u_int32_t *drq,
208 			   int count);
209     void	(*set_start_dependant)(device_t dev, void *context,
210 				       int preference);
211     void	(*set_end_dependant)(device_t dev, void *context);
212 };
213 
214 extern struct acpi_parse_resource_set	acpi_res_parse_set;
215 extern ACPI_STATUS	acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
216 			    struct acpi_parse_resource_set *set);
217 /* XXX until Intel fix this in their headers, based on NEXT_RESOURCE */
218 #define ACPI_RESOURCE_NEXT(Res) (ACPI_RESOURCE *)((UINT8 *)Res + Res->Length)
219 
220 /* ACPI event handling */
221 extern UINT32	acpi_eventhandler_power_button_for_sleep(void *context);
222 extern UINT32	acpi_eventhandler_power_button_for_wakeup(void *context);
223 extern UINT32	acpi_eventhandler_sleep_button_for_sleep(void *context);
224 extern UINT32	acpi_eventhandler_sleep_button_for_wakeup(void *context);
225 
226 #define ACPI_EVENT_PRI_FIRST      0
227 #define ACPI_EVENT_PRI_DEFAULT    10000
228 #define ACPI_EVENT_PRI_LAST       20000
229 
230 typedef void (*acpi_event_handler_t)(void *, int);
231 
232 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
233 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
234 
235 /* Device power control. */
236 extern ACPI_STATUS	acpi_pwr_switch_consumer(ACPI_HANDLE consumer,
237 						 int state);
238 
239 /* Misc. */
240 static __inline struct acpi_softc *
241 acpi_device_get_parent_softc(device_t child)
242 {
243     device_t	parent;
244 
245     parent = device_get_parent(child);
246     if (parent == NULL)
247 	return (NULL);
248     return (device_get_softc(parent));
249 }
250 
251 static __inline int
252 acpi_get_verbose(struct acpi_softc *sc)
253 {
254     if (sc)
255 	return (sc->acpi_verbose);
256     return (0);
257 }
258 
259 extern char	*acpi_name(ACPI_HANDLE handle);
260 extern int	acpi_avoid(ACPI_HANDLE handle);
261 extern int	acpi_disabled(char *subsys);
262 extern void	acpi_device_enable_wake_capability(ACPI_HANDLE h, int enable);
263 extern void	acpi_device_enable_wake_event(ACPI_HANDLE h);
264 extern int	acpi_machdep_init(device_t dev);
265 extern void	acpi_install_wakeup_handler(struct acpi_softc *sc);
266 extern int	acpi_sleep_machdep(struct acpi_softc *sc, int state);
267 
268 /* Battery Abstraction. */
269 struct acpi_battinfo;
270 struct acpi_battdesc;
271 
272 extern int	acpi_battery_register(int, int);
273 extern int	acpi_battery_get_battinfo(int, struct acpi_battinfo *);
274 extern int	acpi_battery_get_units(void);
275 extern int	acpi_battery_get_info_expire(void);
276 extern int	acpi_battery_get_battdesc(int, struct acpi_battdesc *);
277 
278 extern int	acpi_cmbat_get_battinfo(int, struct acpi_battinfo *);
279 
280 /* Embedded controller. */
281 extern void	acpi_ec_ecdt_probe(device_t);
282 
283 /* AC adapter interface. */
284 extern int	acpi_acad_get_acline(int *);
285 
286 #if __FreeBSD_version >= 500000
287 #ifndef ACPI_MAX_THREADS
288 #define ACPI_MAX_THREADS	3
289 #endif
290 #if ACPI_MAX_THREADS > 0
291 #define ACPI_USE_THREADS
292 #endif
293 #endif
294 
295 #ifdef ACPI_USE_THREADS
296 /* ACPI task kernel thread initialization. */
297 extern int	acpi_task_thread_init(void);
298 #endif
299