2 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
3 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4 * Copyright (c) 2000 BSDi
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
28 * $FreeBSD: src/sys/dev/acpica/acpivar.h,v 1.69 2004/05/28 07:15:55 njl Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpivar.h,v 1.4 2004/08/02 19:51:07 dillon Exp $
33 #include <sys/eventhandler.h>
34 #include <sys/sysctl.h>
35 #if __FreeBSD_version >= 500000
37 #include <sys/mutex.h>
40 #include <machine/bus.h>
41 #include <machine/resource.h>
47 struct resource *acpi_irq;
49 void *acpi_irq_handle;
53 int acpi_sleep_disabled;
55 struct sysctl_ctx_list acpi_sysctl_ctx;
56 struct sysctl_oid *acpi_sysctl_tree;
57 int acpi_power_button_sx;
58 int acpi_sleep_button_sx;
59 int acpi_lid_switch_sx;
66 int acpi_disable_on_poweroff;
69 bus_dma_tag_t acpi_waketag;
70 bus_dmamap_t acpi_wakemap;
71 vm_offset_t acpi_wakeaddr;
72 vm_paddr_t acpi_wakephys;
74 struct sysctl_ctx_list acpi_battery_sysctl_ctx;
75 struct sysctl_oid *acpi_battery_sysctl_tree;
80 ACPI_HANDLE ad_handle;
85 struct resource_list ad_rl;
88 struct acpi_prw_data {
89 ACPI_HANDLE gpe_handle;
95 /* Flags for each device defined in the AML namespace. */
96 #define ACPI_FLAG_WAKE_CAPABLE 0x1
97 #define ACPI_FLAG_WAKE_ENABLED 0x2
99 #if defined(__DragonFly__)
101 * In 4.x, ACPI is protected by splhigh().
103 # define ACPI_LOCK s = splhigh()
104 # define ACPI_UNLOCK splx(s)
105 # define ACPI_ASSERTLOCK
106 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
107 # define ACPI_LOCK_DECL int s
108 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
109 #elif __FreeBSD_version < 500000
111 * In 4.x, ACPI is protected by splhigh().
113 # define ACPI_LOCK s = splhigh()
114 # define ACPI_UNLOCK splx(s)
115 # define ACPI_ASSERTLOCK
116 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
117 # define ACPI_LOCK_DECL int s
118 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
119 # define tc_init(a) init_timecounter(a)
123 # define ACPI_ASSERTLOCK
124 # define ACPI_LOCK_DECL
128 * ACPI CA does not define layers for non-ACPI CA drivers.
129 * We define some here within the range provided.
131 #define ACPI_AC_ADAPTER 0x00010000
132 #define ACPI_BATTERY 0x00020000
133 #define ACPI_BUS 0x00040000
134 #define ACPI_BUTTON 0x00080000
135 #define ACPI_EC 0x00100000
136 #define ACPI_FAN 0x00200000
137 #define ACPI_POWERRES 0x00400000
138 #define ACPI_PROCESSOR 0x00800000
139 #define ACPI_THERMAL 0x01000000
140 #define ACPI_TIMER 0x02000000
141 #define ACPI_ASUS 0x04000000
144 * Constants for different interrupt models used with acpi_SetIntrModel().
146 #define ACPI_INTR_PIC 0
147 #define ACPI_INTR_APIC 1
148 #define ACPI_INTR_SAPIC 2
151 * Note that the low ivar values are reserved to provide
152 * interface compatibility with ISA drivers which can also
155 #define ACPI_IVAR_HANDLE 0x100
156 #define ACPI_IVAR_MAGIC 0x101
157 #define ACPI_IVAR_PRIVATE 0x102
160 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
161 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
163 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
165 static __inline type varp ## _get_ ## var(device_t dev) \
168 BUS_READ_IVAR(device_get_parent(dev), dev, \
169 ivarp ## _IVAR_ ## ivar, &v); \
173 static __inline void varp ## _set_ ## var(device_t dev, type t) \
175 uintptr_t v = (uintptr_t) t; \
176 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
177 ivarp ## _IVAR_ ## ivar, v); \
180 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
181 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
182 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
184 static __inline ACPI_OBJECT_TYPE
185 acpi_get_type(device_t dev)
190 if ((h = acpi_get_handle(dev)) == NULL)
191 return (ACPI_TYPE_NOT_FOUND);
192 if (AcpiGetType(h, &t) != AE_OK)
193 return (ACPI_TYPE_NOT_FOUND);
198 void acpi_EnterDebugger(void);
202 #include <sys/cons.h>
203 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
208 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
209 if (acpi_get_verbose(acpi_sc)) \
210 device_printf(dev, x); \
213 #define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9)
214 BOOLEAN acpi_DeviceIsPresent(device_t dev);
215 BOOLEAN acpi_BatteryIsPresent(device_t dev);
216 BOOLEAN acpi_MatchHid(device_t dev, char *hid);
217 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
218 ACPI_HANDLE *result);
219 uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
220 ACPI_BUFFER *acpi_AllocBuffer(int size);
221 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
223 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
225 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
227 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
228 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
229 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
230 ACPI_RESOURCE **resp);
231 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
233 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
234 ACPI_STATUS acpi_SetIntrModel(int model);
235 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
236 int acpi_wake_init(device_t dev, int type);
237 int acpi_wake_set_enable(device_t dev, int enable);
238 int acpi_wake_sleep_prep(device_t dev, int sstate);
239 int acpi_wake_run_prep(device_t dev);
240 ACPI_STATUS acpi_Startup(void);
241 ACPI_STATUS acpi_Enable(struct acpi_softc *sc);
242 ACPI_STATUS acpi_Disable(struct acpi_softc *sc);
243 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
245 struct resource *acpi_bus_alloc_gas(device_t dev, int *rid,
246 ACPI_GENERIC_ADDRESS *gas);
248 struct acpi_parse_resource_set {
249 void (*set_init)(device_t dev, void *arg, void **context);
250 void (*set_done)(device_t dev, void *context);
251 void (*set_ioport)(device_t dev, void *context, uint32_t base,
253 void (*set_iorange)(device_t dev, void *context, uint32_t low,
254 uint32_t high, uint32_t length, uint32_t align);
255 void (*set_memory)(device_t dev, void *context, uint32_t base,
257 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
258 uint32_t high, uint32_t length, uint32_t align);
259 void (*set_irq)(device_t dev, void *context, u_int32_t *irq,
260 int count, int trig, int pol);
261 void (*set_drq)(device_t dev, void *context, u_int32_t *drq,
263 void (*set_start_dependant)(device_t dev, void *context,
265 void (*set_end_dependant)(device_t dev, void *context);
268 extern struct acpi_parse_resource_set acpi_res_parse_set;
269 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
270 struct acpi_parse_resource_set *set, void *arg);
272 /* ACPI event handling */
273 UINT32 acpi_event_power_button_sleep(void *context);
274 UINT32 acpi_event_power_button_wake(void *context);
275 UINT32 acpi_event_sleep_button_sleep(void *context);
276 UINT32 acpi_event_sleep_button_wake(void *context);
278 #define ACPI_EVENT_PRI_FIRST 0
279 #define ACPI_EVENT_PRI_DEFAULT 10000
280 #define ACPI_EVENT_PRI_LAST 20000
282 typedef void (*acpi_event_handler_t)(void *, int);
284 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
285 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
287 /* Device power control. */
288 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
291 static __inline struct acpi_softc *
292 acpi_device_get_parent_softc(device_t child)
296 parent = device_get_parent(child);
299 return (device_get_softc(parent));
303 acpi_get_verbose(struct acpi_softc *sc)
306 return (sc->acpi_verbose);
310 char *acpi_name(ACPI_HANDLE handle);
311 int acpi_avoid(ACPI_HANDLE handle);
312 int acpi_disabled(char *subsys);
313 int acpi_machdep_init(device_t dev);
314 void acpi_install_wakeup_handler(struct acpi_softc *sc);
315 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
317 /* Battery Abstraction. */
318 struct acpi_battinfo;
319 struct acpi_battdesc;
321 int acpi_battery_register(int, int);
322 int acpi_battery_get_battinfo(int, struct acpi_battinfo *);
323 int acpi_battery_get_units(void);
324 int acpi_battery_get_info_expire(void);
325 int acpi_battery_get_battdesc(int, struct acpi_battdesc *);
327 int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *);
329 /* Embedded controller. */
330 void acpi_ec_ecdt_probe(device_t);
332 /* AC adapter interface. */
333 int acpi_acad_get_acline(int *);
335 /* Package manipulation convenience functions. */
336 #define ACPI_PKG_VALID(pkg, size) \
337 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
338 (pkg)->Package.Count >= (size))
339 int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
340 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
341 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
342 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *rid,
343 struct resource **dst);
344 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
346 /* ACPI task kernel thread initialization. */
347 int acpi_task_thread_init(void);