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.71 2004/06/13 22:52:30 njl Exp $
29 * $DragonFly: src/sys/dev/acpica5/acpivar.h,v 1.16 2008/09/29 06:59:45 hasso Exp $
34 #include <sys/eventhandler.h>
35 #include <sys/sysctl.h>
36 #include <sys/globaldata.h>
37 #include <sys/serialize.h>
38 #include <sys/thread2.h>
39 #if __FreeBSD_version >= 500000
41 #include <sys/mutex.h>
49 struct callout acpi_sleep_timer;
50 struct resource *acpi_irq;
52 void *acpi_irq_handle;
56 int acpi_sleep_disabled;
58 struct sysctl_ctx_list acpi_sysctl_ctx;
59 struct sysctl_oid *acpi_sysctl_tree;
60 int acpi_power_button_sx;
61 int acpi_sleep_button_sx;
62 int acpi_lid_switch_sx;
69 int acpi_disable_on_poweroff;
72 bus_dma_tag_t acpi_waketag;
73 bus_dmamap_t acpi_wakemap;
74 vm_offset_t acpi_wakeaddr;
75 vm_paddr_t acpi_wakephys;
77 struct sysctl_ctx_list acpi_battery_sysctl_ctx;
78 struct sysctl_oid *acpi_battery_sysctl_tree;
83 ACPI_HANDLE ad_handle;
88 struct resource_list ad_rl;
91 struct acpi_prw_data {
92 ACPI_HANDLE gpe_handle;
98 /* Flags for each device defined in the AML namespace. */
99 #define ACPI_FLAG_WAKE_CAPABLE 0x1
100 #define ACPI_FLAG_WAKE_ENABLED 0x2
102 #if defined(__DragonFly__)
104 * In DragonFly, ACPI is protected by critical sections.
106 # define ACPI_LOCK crit_enter()
107 # define ACPI_UNLOCK crit_exit()
108 # define ACPI_ASSERTLOCK
109 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
110 # define ACPI_LOCK_DECL
111 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
112 #define ACPI_SERIAL_BEGIN(sys) lwkt_serialize_enter(&acpi_sys##_serializer)
113 #define ACPI_SERIAL_END(sys) lwkt_serialize_exit(&acpi_sys##_serializer)
114 #define ACPI_SERIAL_ASSERT(sys) ASSERT_SERIALIZED(&acpi_sys##_serializer)
115 #define ACPI_SERIAL_DECL(sys, name) static struct lwkt_serialize acpi_sys##_serializer;
116 #define ACPI_SERIAL_INIT(sys) lwkt_serialize_init(&acpi_sys##_serializer)
117 #elif __FreeBSD_version < 500000
119 * In 4.x, ACPI is protected by splhigh().
121 # define ACPI_LOCK s = splhigh()
122 # define ACPI_UNLOCK splx(s)
123 # define ACPI_ASSERTLOCK
124 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
125 # define ACPI_LOCK_DECL int s
126 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
127 # define tc_init(a) init_timecounter(a)
131 # define ACPI_ASSERTLOCK
132 # define ACPI_LOCK_DECL
136 * ACPI CA does not define layers for non-ACPI CA drivers.
137 * We define some here within the range provided.
139 #define ACPI_AC_ADAPTER 0x00010000
140 #define ACPI_BATTERY 0x00020000
141 #define ACPI_BUS 0x00040000
142 #define ACPI_BUTTON 0x00080000
143 #define ACPI_EC 0x00100000
144 #define ACPI_FAN 0x00200000
145 #define ACPI_POWERRES 0x00400000
146 #define ACPI_PROCESSOR 0x00800000
147 #define ACPI_THERMAL 0x01000000
148 #define ACPI_TIMER 0x02000000
149 #define ACPI_OEM 0x04000000
152 * Constants for different interrupt models used with acpi_SetIntrModel().
154 #define ACPI_INTR_PIC 0
155 #define ACPI_INTR_APIC 1
156 #define ACPI_INTR_SAPIC 2
159 * Various features and capabilities for the acpi_get_features() method.
160 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
162 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
163 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
164 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
165 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
166 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
167 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
168 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
169 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
170 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
173 * Note that the low ivar values are reserved to provide
174 * interface compatibility with ISA drivers which can also
177 #define ACPI_IVAR_HANDLE 0x100
178 #define ACPI_IVAR_MAGIC 0x101
179 #define ACPI_IVAR_PRIVATE 0x102
182 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
183 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
185 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
187 static __inline type varp ## _get_ ## var(device_t dev) \
190 BUS_READ_IVAR(device_get_parent(dev), dev, \
191 ivarp ## _IVAR_ ## ivar, &v); \
195 static __inline void varp ## _set_ ## var(device_t dev, type t) \
197 uintptr_t v = (uintptr_t) t; \
198 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
199 ivarp ## _IVAR_ ## ivar, v); \
202 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
203 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
204 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
206 void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
207 static __inline device_t
208 acpi_get_device(ACPI_HANDLE handle)
211 AcpiGetData(handle, acpi_fake_objhandler, &dev);
212 return ((device_t)dev);
215 static __inline ACPI_OBJECT_TYPE
216 acpi_get_type(device_t dev)
221 if ((h = acpi_get_handle(dev)) == NULL)
222 return (ACPI_TYPE_NOT_FOUND);
223 if (AcpiGetType(h, &t) != AE_OK)
224 return (ACPI_TYPE_NOT_FOUND);
229 void acpi_EnterDebugger(void);
233 #include <sys/cons.h>
234 #define STEP(x) do {kprintf x, kprintf("\n"); cngetc();} while (0)
239 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
240 if (acpi_get_verbose(acpi_sc)) \
241 device_printf(dev, x); \
244 #define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9)
245 BOOLEAN acpi_DeviceIsPresent(device_t dev);
246 BOOLEAN acpi_BatteryIsPresent(device_t dev);
247 BOOLEAN acpi_MatchHid(ACPI_HANDLE h, char *hid);
248 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
249 ACPI_HANDLE *result);
250 uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
251 ACPI_BUFFER *acpi_AllocBuffer(int size);
252 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
254 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
256 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
258 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
259 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
260 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
261 ACPI_RESOURCE **resp);
262 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
264 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
265 ACPI_STATUS acpi_SetIntrModel(int model);
266 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
267 int acpi_wake_init(device_t dev, int type);
268 int acpi_wake_set_enable(device_t dev, int enable);
269 int acpi_wake_sleep_prep(device_t dev, int sstate);
270 int acpi_wake_run_prep(device_t dev);
271 ACPI_STATUS acpi_Startup(void);
272 ACPI_STATUS acpi_Enable(struct acpi_softc *sc);
273 ACPI_STATUS acpi_Disable(struct acpi_softc *sc);
274 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
276 struct resource *acpi_bus_alloc_gas(device_t dev, int *rid,
277 const ACPI_GENERIC_ADDRESS *gas, u_int flags);
279 struct acpi_parse_resource_set {
280 void (*set_init)(device_t dev, void *arg, void **context);
281 void (*set_done)(device_t dev, void *context);
282 void (*set_ioport)(device_t dev, void *context, uint32_t base,
284 void (*set_iorange)(device_t dev, void *context, uint32_t low,
285 uint32_t high, uint32_t length, uint32_t align);
286 void (*set_memory)(device_t dev, void *context, uint32_t base,
288 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
289 uint32_t high, uint32_t length, uint32_t align);
290 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
291 int count, int trig, int pol);
292 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
293 int count, int trig, int pol);
294 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
296 void (*set_start_dependant)(device_t dev, void *context,
298 void (*set_end_dependant)(device_t dev, void *context);
301 extern struct acpi_parse_resource_set acpi_res_parse_set;
302 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
303 struct acpi_parse_resource_set *set, void *arg);
304 extern struct rman acpi_rman_io, acpi_rman_mem;
305 struct resource_list_entry *acpi_sysres_find(int type, u_long addr);
307 /* ACPI event handling */
308 UINT32 acpi_event_power_button_sleep(void *context);
309 UINT32 acpi_event_power_button_wake(void *context);
310 UINT32 acpi_event_sleep_button_sleep(void *context);
311 UINT32 acpi_event_sleep_button_wake(void *context);
313 #define ACPI_EVENT_PRI_FIRST 0
314 #define ACPI_EVENT_PRI_DEFAULT 10000
315 #define ACPI_EVENT_PRI_LAST 20000
317 typedef void (*acpi_event_handler_t)(void *, int);
319 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
320 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
322 /* Device power control. */
323 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
326 static __inline struct acpi_softc *
327 acpi_device_get_parent_softc(device_t child)
331 parent = device_get_parent(child);
334 return (device_get_softc(parent));
338 acpi_get_verbose(struct acpi_softc *sc)
341 return (sc->acpi_verbose);
345 char *acpi_name(ACPI_HANDLE handle);
346 int acpi_avoid(ACPI_HANDLE handle);
347 int acpi_disabled(char *subsys);
348 int acpi_enabled(char *subsys);
349 int acpi_machdep_init(device_t dev);
350 void acpi_install_wakeup_handler(struct acpi_softc *sc);
351 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
353 /* Battery Abstraction. */
354 struct acpi_battinfo;
356 int acpi_battery_register(device_t dev);
357 int acpi_battery_remove(device_t dev);
358 int acpi_battery_get_units(void);
359 int acpi_battery_get_info_expire(void);
360 int acpi_battery_bst_valid(struct acpi_bst *bst);
361 int acpi_battery_bif_valid(struct acpi_bif *bif);
362 int acpi_battery_get_battinfo(device_t dev,
363 struct acpi_battinfo *info);
365 /* Embedded controller. */
366 void acpi_ec_ecdt_probe(device_t);
368 /* AC adapter interface. */
369 int acpi_acad_get_acline(int *);
371 /* Package manipulation convenience functions. */
372 #define _ACPI_PKG_VALID(pkg) \
373 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE)
374 #define ACPI_PKG_VALID(pkg, size) \
375 (_ACPI_PKG_VALID((pkg)) && (pkg)->Package.Count >= (size))
376 #define ACPI_PKG_VALID_EQ(pkg, size) \
377 (_ACPI_PKG_VALID((pkg)) && (pkg)->Package.Count == (size))
378 int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
379 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
380 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
381 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *rid,
382 struct resource **dst, u_int flags);
383 int acpi_PkgRawGas(ACPI_OBJECT *res, int idx,
384 ACPI_GENERIC_ADDRESS *gas);
385 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
387 /* ACPI task kernel thread initialization. */
388 int acpi_task_thread_init(void);