Deleted Added
sdiff udiff text old ( 128046 ) new ( 128225 )
full compact
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: head/sys/dev/acpica/acpivar.h 128046 2004-04-09 06:53:50Z njl $
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
43typedef vm_offset_t vm_paddr_t;
44#endif
45
46struct 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
85struct 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_AC_ADAPTER 0x00010000
119#define ACPI_BATTERY 0x00020000
120#define ACPI_BUS 0x00040000
121#define ACPI_BUTTON 0x00080000
122#define ACPI_EC 0x00100000
123#define ACPI_FAN 0x00200000
124#define ACPI_POWERRES 0x00400000
125#define ACPI_PROCESSOR 0x00800000
126#define ACPI_THERMAL 0x01000000
127#define ACPI_TIMER 0x02000000
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
145static __inline ACPI_HANDLE
146acpi_get_handle(device_t dev)
147{
148 uintptr_t up;
149
150 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, &up))
151 return (NULL);
152 return ((ACPI_HANDLE)up);
153}
154
155static __inline int
156acpi_set_handle(device_t dev, ACPI_HANDLE h)
157{
158 uintptr_t up;
159
160 up = (uintptr_t)h;
161 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, up));
162}
163
164static __inline int
165acpi_get_magic(device_t dev)
166{
167 uintptr_t up;
168
169 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, &up))
170 return(0);
171 return ((int)up);
172}
173
174static __inline int
175acpi_set_magic(device_t dev, int m)
176{
177 uintptr_t up;
178
179 up = (uintptr_t)m;
180 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, up));
181}
182
183static __inline void *
184acpi_get_private(device_t dev)
185{
186 uintptr_t up;
187
188 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, &up))
189 return (NULL);
190 return ((void *)up);
191}
192
193static __inline int
194acpi_set_private(device_t dev, void *p)
195{
196 uintptr_t up;
197
198 up = (uintptr_t)p;
199 return (BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, up));
200}
201
202static __inline ACPI_OBJECT_TYPE
203acpi_get_type(device_t dev)
204{
205 ACPI_HANDLE h;
206 ACPI_OBJECT_TYPE t;
207
208 if ((h = acpi_get_handle(dev)) == NULL)
209 return (ACPI_TYPE_NOT_FOUND);
210 if (AcpiGetType(h, &t) != AE_OK)
211 return (ACPI_TYPE_NOT_FOUND);
212 return (t);
213}
214
215#ifdef ACPI_DEBUGGER
216extern void acpi_EnterDebugger(void);
217#endif
218
219#ifdef ACPI_DEBUG
220#include <sys/cons.h>
221#define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
222#else
223#define STEP(x)
224#endif
225
226#define ACPI_VPRINT(dev, acpi_sc, x...) do { \
227 if (acpi_get_verbose(acpi_sc)) \
228 device_printf(dev, x); \
229} while (0)
230
231#define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9)
232extern BOOLEAN acpi_DeviceIsPresent(device_t dev);
233extern BOOLEAN acpi_BatteryIsPresent(device_t dev);
234extern BOOLEAN acpi_MatchHid(device_t dev, char *hid);
235extern ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
236 ACPI_HANDLE *result);
237extern ACPI_BUFFER *acpi_AllocBuffer(int size);
238extern ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
239 UINT32 *number);
240extern ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
241 UINT32 *number);
242extern ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
243 UINT32 number);
244extern ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
245 void (*func)(ACPI_OBJECT *comp, void *arg),
246 void *arg);
247extern ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
248 ACPI_RESOURCE **resp);
249extern ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
250 ACPI_RESOURCE *res);
251extern ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
252extern ACPI_STATUS acpi_SetIntrModel(int model);
253extern ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
254extern ACPI_STATUS acpi_Startup(void);
255extern ACPI_STATUS acpi_Enable(struct acpi_softc *sc);
256extern ACPI_STATUS acpi_Disable(struct acpi_softc *sc);
257extern void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
258 uint8_t notify);
259struct resource * acpi_bus_alloc_gas(device_t dev, int *rid,
260 ACPI_GENERIC_ADDRESS *gas);
261
262struct acpi_parse_resource_set {
263 void (*set_init)(device_t dev, void *arg, void **context);
264 void (*set_done)(device_t dev, void *context);
265 void (*set_ioport)(device_t dev, void *context, u_int32_t base,
266 u_int32_t length);
267 void (*set_iorange)(device_t dev, void *context,
268 u_int32_t low, u_int32_t high,
269 u_int32_t length, u_int32_t align);
270 void (*set_memory)(device_t dev, void *context, u_int32_t base,
271 u_int32_t length);
272 void (*set_memoryrange)(device_t dev, void *context, u_int32_t low,
273 u_int32_t high, u_int32_t length,
274 u_int32_t align);
275 void (*set_irq)(device_t dev, void *context, u_int32_t *irq,
276 int count, int trig, int pol);
277 void (*set_drq)(device_t dev, void *context, u_int32_t *drq,
278 int count);
279 void (*set_start_dependant)(device_t dev, void *context,
280 int preference);
281 void (*set_end_dependant)(device_t dev, void *context);
282};
283
284extern struct acpi_parse_resource_set acpi_res_parse_set;
285extern ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
286 struct acpi_parse_resource_set *set, void *arg);
287
288/* ACPI event handling */
289extern UINT32 acpi_event_power_button_sleep(void *context);
290extern UINT32 acpi_event_power_button_wake(void *context);
291extern UINT32 acpi_event_sleep_button_sleep(void *context);
292extern UINT32 acpi_event_sleep_button_wake(void *context);
293
294#define ACPI_EVENT_PRI_FIRST 0
295#define ACPI_EVENT_PRI_DEFAULT 10000
296#define ACPI_EVENT_PRI_LAST 20000
297
298typedef void (*acpi_event_handler_t)(void *, int);
299
300EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
301EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
302
303/* Device power control. */
304extern ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer,
305 int state);
306
307/* Misc. */
308static __inline struct acpi_softc *
309acpi_device_get_parent_softc(device_t child)
310{
311 device_t parent;
312
313 parent = device_get_parent(child);
314 if (parent == NULL)
315 return (NULL);
316 return (device_get_softc(parent));
317}
318
319static __inline int
320acpi_get_verbose(struct acpi_softc *sc)
321{
322 if (sc)
323 return (sc->acpi_verbose);
324 return (0);
325}
326
327extern char *acpi_name(ACPI_HANDLE handle);
328extern int acpi_avoid(ACPI_HANDLE handle);
329extern int acpi_disabled(char *subsys);
330extern void acpi_device_enable_wake_capability(ACPI_HANDLE h, int enable);
331extern void acpi_device_enable_wake_event(ACPI_HANDLE h);
332extern int acpi_machdep_init(device_t dev);
333extern void acpi_install_wakeup_handler(struct acpi_softc *sc);
334extern int acpi_sleep_machdep(struct acpi_softc *sc, int state);
335
336/* Battery Abstraction. */
337struct acpi_battinfo;
338struct acpi_battdesc;
339
340extern int acpi_battery_register(int, int);
341extern int acpi_battery_get_battinfo(int, struct acpi_battinfo *);
342extern int acpi_battery_get_units(void);
343extern int acpi_battery_get_info_expire(void);
344extern int acpi_battery_get_battdesc(int, struct acpi_battdesc *);
345
346extern int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *);
347
348/* Embedded controller. */
349extern void acpi_ec_ecdt_probe(device_t);
350
351/* AC adapter interface. */
352extern int acpi_acad_get_acline(int *);
353
354/* Package manipulation convenience functions. */
355#define ACPI_PKG_VALID(pkg, size) \
356 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
357 (pkg)->Package.Count >= (size))
358int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
359int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
360int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
361int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *rid,
362 struct resource **dst);
363ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
364
365#if __FreeBSD_version >= 500000
366#ifndef ACPI_MAX_THREADS
367#define ACPI_MAX_THREADS 3
368#endif
369#if ACPI_MAX_THREADS > 0
370#define ACPI_USE_THREADS
371#endif
372#endif
373
374#ifdef ACPI_USE_THREADS
375/* ACPI task kernel thread initialization. */
376extern int acpi_task_thread_init(void);
377#endif