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.11 2007/01/17 17:31:19 y0netan1 Exp $
33 #include <sys/eventhandler.h>
34 #include <sys/sysctl.h>
35 #if __FreeBSD_version >= 500000
37 #include <sys/mutex.h>
45 struct callout acpi_sleep_timer;
46 struct resource *acpi_irq;
48 void *acpi_irq_handle;
52 int acpi_sleep_disabled;
54 struct sysctl_ctx_list acpi_sysctl_ctx;
55 struct sysctl_oid *acpi_sysctl_tree;
56 int acpi_power_button_sx;
57 int acpi_sleep_button_sx;
58 int acpi_lid_switch_sx;
65 int acpi_disable_on_poweroff;
68 bus_dma_tag_t acpi_waketag;
69 bus_dmamap_t acpi_wakemap;
70 vm_offset_t acpi_wakeaddr;
71 vm_paddr_t acpi_wakephys;
73 struct sysctl_ctx_list acpi_battery_sysctl_ctx;
74 struct sysctl_oid *acpi_battery_sysctl_tree;
79 ACPI_HANDLE ad_handle;
84 struct resource_list ad_rl;
87 struct acpi_prw_data {
88 ACPI_HANDLE gpe_handle;
94 /* Flags for each device defined in the AML namespace. */
95 #define ACPI_FLAG_WAKE_CAPABLE 0x1
96 #define ACPI_FLAG_WAKE_ENABLED 0x2
98 #if defined(__DragonFly__)
100 * In DragonFly, ACPI is protected by critical sections.
102 # define ACPI_LOCK crit_enter()
103 # define ACPI_UNLOCK crit_exit()
104 # define ACPI_ASSERTLOCK
105 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
106 # define ACPI_LOCK_DECL
107 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
108 #elif __FreeBSD_version < 500000
110 * In 4.x, ACPI is protected by splhigh().
112 # define ACPI_LOCK s = splhigh()
113 # define ACPI_UNLOCK splx(s)
114 # define ACPI_ASSERTLOCK
115 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
116 # define ACPI_LOCK_DECL int s
117 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
118 # define tc_init(a) init_timecounter(a)
122 # define ACPI_ASSERTLOCK
123 # define ACPI_LOCK_DECL
127 * ACPI CA does not define layers for non-ACPI CA drivers.
128 * We define some here within the range provided.
130 #define ACPI_AC_ADAPTER 0x00010000
131 #define ACPI_BATTERY 0x00020000
132 #define ACPI_BUS 0x00040000
133 #define ACPI_BUTTON 0x00080000
134 #define ACPI_EC 0x00100000
135 #define ACPI_FAN 0x00200000
136 #define ACPI_POWERRES 0x00400000
137 #define ACPI_PROCESSOR 0x00800000
138 #define ACPI_THERMAL 0x01000000
139 #define ACPI_TIMER 0x02000000
140 #define ACPI_ASUS 0x04000000
143 * Constants for different interrupt models used with acpi_SetIntrModel().
145 #define ACPI_INTR_PIC 0
146 #define ACPI_INTR_APIC 1
147 #define ACPI_INTR_SAPIC 2
150 * Note that the low ivar values are reserved to provide
151 * interface compatibility with ISA drivers which can also
154 #define ACPI_IVAR_HANDLE 0x100
155 #define ACPI_IVAR_MAGIC 0x101
156 #define ACPI_IVAR_PRIVATE 0x102
159 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
160 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
162 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
164 static __inline type varp ## _get_ ## var(device_t dev) \
167 BUS_READ_IVAR(device_get_parent(dev), dev, \
168 ivarp ## _IVAR_ ## ivar, &v); \
172 static __inline void varp ## _set_ ## var(device_t dev, type t) \
174 uintptr_t v = (uintptr_t) t; \
175 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
176 ivarp ## _IVAR_ ## ivar, v); \
179 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
180 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
181 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
183 static __inline ACPI_OBJECT_TYPE
184 acpi_get_type(device_t dev)
189 if ((h = acpi_get_handle(dev)) == NULL)
190 return (ACPI_TYPE_NOT_FOUND);
191 if (AcpiGetType(h, &t) != AE_OK)
192 return (ACPI_TYPE_NOT_FOUND);
197 void acpi_EnterDebugger(void);
201 #include <sys/cons.h>
202 #define STEP(x) do {kprintf x, kprintf("\n"); cngetc();} while (0)
207 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
208 if (acpi_get_verbose(acpi_sc)) \
209 device_printf(dev, x); \
212 #define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9)
213 BOOLEAN acpi_DeviceIsPresent(device_t dev);
214 BOOLEAN acpi_BatteryIsPresent(device_t dev);
215 BOOLEAN acpi_MatchHid(device_t dev, char *hid);
216 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
217 ACPI_HANDLE *result);
218 uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
219 ACPI_BUFFER *acpi_AllocBuffer(int size);
220 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
222 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
224 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
226 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
227 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
228 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
229 ACPI_RESOURCE **resp);
230 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
232 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
233 ACPI_STATUS acpi_SetIntrModel(int model);
234 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
235 int acpi_wake_init(device_t dev, int type);
236 int acpi_wake_set_enable(device_t dev, int enable);
237 int acpi_wake_sleep_prep(device_t dev, int sstate);
238 int acpi_wake_run_prep(device_t dev);
239 ACPI_STATUS acpi_Startup(void);
240 ACPI_STATUS acpi_Enable(struct acpi_softc *sc);
241 ACPI_STATUS acpi_Disable(struct acpi_softc *sc);
242 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
244 struct resource *acpi_bus_alloc_gas(device_t dev, int *rid,
245 ACPI_GENERIC_ADDRESS *gas);
247 struct acpi_parse_resource_set {
248 void (*set_init)(device_t dev, void *arg, void **context);
249 void (*set_done)(device_t dev, void *context);
250 void (*set_ioport)(device_t dev, void *context, uint32_t base,
252 void (*set_iorange)(device_t dev, void *context, uint32_t low,
253 uint32_t high, uint32_t length, uint32_t align);
254 void (*set_memory)(device_t dev, void *context, uint32_t base,
256 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
257 uint32_t high, uint32_t length, uint32_t align);
258 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
259 int count, int trig, int pol);
260 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
261 int count, int trig, int pol);
262 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
264 void (*set_start_dependant)(device_t dev, void *context,
266 void (*set_end_dependant)(device_t dev, void *context);
269 extern struct acpi_parse_resource_set acpi_res_parse_set;
270 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
271 struct acpi_parse_resource_set *set, void *arg);
273 /* ACPI event handling */
274 UINT32 acpi_event_power_button_sleep(void *context);
275 UINT32 acpi_event_power_button_wake(void *context);
276 UINT32 acpi_event_sleep_button_sleep(void *context);
277 UINT32 acpi_event_sleep_button_wake(void *context);
279 #define ACPI_EVENT_PRI_FIRST 0
280 #define ACPI_EVENT_PRI_DEFAULT 10000
281 #define ACPI_EVENT_PRI_LAST 20000
283 typedef void (*acpi_event_handler_t)(void *, int);
285 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
286 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
288 /* Device power control. */
289 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
292 static __inline struct acpi_softc *
293 acpi_device_get_parent_softc(device_t child)
297 parent = device_get_parent(child);
300 return (device_get_softc(parent));
304 acpi_get_verbose(struct acpi_softc *sc)
307 return (sc->acpi_verbose);
311 char *acpi_name(ACPI_HANDLE handle);
312 int acpi_avoid(ACPI_HANDLE handle);
313 int acpi_disabled(char *subsys);
314 int acpi_enabled(char *subsys);
315 int acpi_machdep_init(device_t dev);
316 void acpi_install_wakeup_handler(struct acpi_softc *sc);
317 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
319 /* Battery Abstraction. */
320 struct acpi_battinfo;
321 struct acpi_battdesc;
323 int acpi_battery_register(int, int);
324 int acpi_battery_get_battinfo(int, struct acpi_battinfo *);
325 int acpi_battery_get_units(void);
326 int acpi_battery_get_info_expire(void);
327 int acpi_battery_get_battdesc(int, struct acpi_battdesc *);
329 int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *);
331 /* Embedded controller. */
332 void acpi_ec_ecdt_probe(device_t);
334 /* AC adapter interface. */
335 int acpi_acad_get_acline(int *);
337 /* Package manipulation convenience functions. */
338 #define ACPI_PKG_VALID(pkg, size) \
339 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
340 (pkg)->Package.Count >= (size))
341 int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
342 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
343 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
344 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *rid,
345 struct resource **dst);
346 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
348 /* ACPI task kernel thread initialization. */
349 int acpi_task_thread_init(void);