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.108.8.1 2009/04/15 03:14:26 kensmith Exp $
39 #include <sys/eventhandler.h>
40 #include <sys/sysctl.h>
43 #include <sys/spinlock.h>
44 #include <sys/spinlock2.h>
45 #include <sys/serialize.h>
46 #include <contrib/dev/acpica/source/include/acmacros.h>
47 #include <contrib/dev/acpica/source/include/acconfig.h>
48 #include <contrib/dev/acpica/source/include/aclocal.h>
49 #include <contrib/dev/acpica/source/include/acobject.h>
50 #include <contrib/dev/acpica/source/include/acstruct.h>
51 #include <contrib/dev/acpica/source/include/acutils.h>
53 struct apm_clone_data
;
58 struct resource
*acpi_irq
;
60 void *acpi_irq_handle
;
64 int acpi_sleep_disabled
;
66 struct sysctl_ctx_list acpi_sysctl_ctx
;
67 struct sysctl_oid
*acpi_sysctl_tree
;
68 int acpi_power_button_sx
;
69 int acpi_sleep_button_sx
;
70 int acpi_lid_switch_sx
;
79 int acpi_handle_reboot
;
81 bus_dma_tag_t acpi_waketag
;
82 bus_dmamap_t acpi_wakemap
;
83 vm_offset_t acpi_wakeaddr
;
84 vm_paddr_t acpi_wakephys
;
86 int acpi_next_sstate
; /* Next suspend Sx state. */
87 struct apm_clone_data
*acpi_clone
; /* Pseudo-dev for devd(8). */
88 STAILQ_HEAD(,apm_clone_data
) apm_cdevs
; /* All apm/apmctl/acpi cdevs. */
89 struct callout susp_force_to
; /* Force suspend if no acks. */
94 ACPI_HANDLE ad_handle
;
100 struct resource_list ad_rl
;
103 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
104 struct apm_clone_data
{
105 STAILQ_ENTRY(apm_clone_data
) entries
;
108 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
109 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
110 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
112 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
113 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
114 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
115 struct acpi_softc
*acpi_sc
;
118 #define ACPI_PRW_MAX_POWERRES 8
120 struct acpi_prw_data
{
121 ACPI_HANDLE gpe_handle
;
124 ACPI_OBJECT power_res
[ACPI_PRW_MAX_POWERRES
];
128 /* Flags for each device defined in the AML namespace. */
129 #define ACPI_FLAG_WAKE_ENABLED 0x1
131 /* Macros for extracting parts of a PCI address from an _ADR value. */
132 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
133 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
136 * Entry points to ACPI from above are global functions defined in this
137 * file, sysctls, and I/O on the control device. Entry points from below
138 * are interrupts (the SCI), notifies, task queue threads, and the thermal
139 * zone polling thread.
141 * ACPI tables and global shared data are protected by a global lock
144 * Each ACPI device can have its own driver-specific mutex for protecting
145 * shared access to local data. The ACPI_LOCK macros handle mutexes.
147 * Drivers that need to serialize access to functions (e.g., to route
148 * interrupts, get/set control paths, etc.) should use the sx lock macros
151 * ACPICA handles its own locking and should not be called with locks held.
153 * The most complicated path is:
154 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
156 extern struct lock acpi_lock
;
157 /* acpi_thermal does lock recurs on purpose */
158 /* I bet I should use some other locks here */
159 #define ACPI_LOCK(sys) lockmgr(&sys##_lock, LK_EXCLUSIVE|LK_RETRY|LK_CANRECURSE)
160 #define ACPI_UNLOCK(sys) lockmgr(&sys##_lock, LK_RELEASE)
161 #define ACPI_LOCK_ASSERT(sys) KKASSERT(lockstatus(&sys##_lock, curthread) == LK_EXCLUSIVE)
162 #define ACPI_ASSERTLOCK ACPI_LOCK_ASSERT
163 #define ACPI_LOCK_DECL(sys, name) static struct lock sys##_lock
164 #define ACPI_LOCK_INIT(sys, name) lockinit(&sys##_lock, name, 0, 0)
166 #define ACPI_SERIAL_INIT(sys) lockinit(&sys##_serial, #sys, 0, 0)
167 #define ACPI_SERIAL_BEGIN(sys) lockmgr(&sys##_serial, LK_EXCLUSIVE|LK_RETRY)
168 #define ACPI_SERIAL_END(sys) lockmgr(&sys##_serial, LK_RELEASE)
169 #define ACPI_SERIAL_ASSERT(sys) KKASSERT(lockstatus(&sys##_serial, curthread) == LK_EXCLUSIVE)
170 #define ACPI_SERIAL_DECL(sys, name) static struct lock sys##_serial
173 * ACPICA does not define layers for non-ACPICA drivers.
174 * We define some here within the range provided.
176 #define ACPI_AC_ADAPTER 0x00010000
177 #define ACPI_BATTERY 0x00020000
178 #define ACPI_BUS 0x00040000
179 #define ACPI_BUTTON 0x00080000
180 #define ACPI_EC 0x00100000
181 #define ACPI_FAN 0x00200000
182 #define ACPI_POWERRES 0x00400000
183 #define ACPI_PROCESSOR 0x00800000
184 #define ACPI_THERMAL 0x01000000
185 #define ACPI_TIMER 0x02000000
186 #define ACPI_OEM 0x04000000
189 * Constants for different interrupt models used with acpi_SetIntrModel().
191 #define ACPI_INTR_PIC 0
192 #define ACPI_INTR_APIC 1
193 #define ACPI_INTR_SAPIC 2
196 * Various features and capabilities for the acpi_get_features() method.
197 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
198 * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
201 #define ACPI_PDC_PX_MSR (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
202 #define ACPI_PDC_MP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
203 #define ACPI_PDC_TX_MSR (1 << 2) /* Intel OnDemand throttling MSRs */
204 #define ACPI_PDC_MP_C1PXTX (1 << 3) /* MP C1, Px, and Tx */
205 #define ACPI_PDC_MP_C2C3 (1 << 4) /* MP C2 and C3 */
206 #define ACPI_PDC_MP_PX_SWCOORD (1 << 5) /* MP Px, using _PSD */
207 #define ACPI_PDC_MP_CX_SWCOORD (1 << 6) /* MP Cx, using _CSD */
208 #define ACPI_PDC_MP_TX_SWCOORD (1 << 7) /* MP Tx, using _TSD */
209 #define ACPI_PDC_MP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
210 #define ACPI_PDC_MP_C2C3_NATIVE (1 << 9) /* MP C2 and C3 support */
211 #define ACPI_PDC_PX_HWCOORD (1 << 11)/* Hardware coordination of Px */
213 #define ACPI_OSC_QUERY_SUPPORT (1 << 0) /* Query Support Flag */
215 #define ACPI_OSCERR_OSCFAIL (1 << 1) /* _OSC failure */
216 #define ACPI_OSCERR_UUID (1 << 2) /* Unrecognized UUID */
217 #define ACPI_OSCERR_REVISION (1 << 3) /* Unrecognized revision ID */
218 #define ACPI_OSCERR_CAPSMASKED (1 << 4) /* Capabilities have been cleared */
219 #define ACPI_OSCERR_MASK 0x0000001e
224 * ACPI_Q_BROKEN: Disables all ACPI support.
225 * ACPI_Q_TIMER: Disables support for the ACPI timer.
226 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
227 * first APIC and that the MADT should force that by ignoring the PC-AT
228 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
229 * ACPI_Q_BATT_RATE_ABS: Specifies that the DSDT reports a negative 16-bit
230 * value for charging/discharging current and/or 0 as 65536.
232 extern int acpi_quirks
;
234 #define ACPI_Q_BROKEN (1 << 0)
235 #define ACPI_Q_TIMER (1 << 1)
236 #define ACPI_Q_MADT_IRQ0 (1 << 2)
237 #define ACPI_Q_BATT_RATE_ABS (1 << 3)
240 * Note that the low ivar values are reserved to provide
241 * interface compatibility with ISA drivers which can also
244 #define ACPI_IVAR_HANDLE 0x100
245 #define ACPI_IVAR_MAGIC 0x101
246 #define ACPI_IVAR_PRIVATE 0x102
247 #define ACPI_IVAR_FLAGS 0x103
250 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
251 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
253 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
255 static __inline type varp ## _get_ ## var(device_t dev) \
258 BUS_READ_IVAR(device_get_parent(dev), dev, \
259 ivarp ## _IVAR_ ## ivar, &v); \
263 static __inline void varp ## _set_ ## var(device_t dev, type t) \
265 uintptr_t v = (uintptr_t) t; \
266 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
267 ivarp ## _IVAR_ ## ivar, v); \
270 __ACPI_BUS_ACCESSOR(acpi
, handle
, ACPI
, HANDLE
, ACPI_HANDLE
)
271 __ACPI_BUS_ACCESSOR(acpi
, magic
, ACPI
, MAGIC
, uintptr_t)
272 __ACPI_BUS_ACCESSOR(acpi
, private, ACPI
, PRIVATE
, void *)
273 __ACPI_BUS_ACCESSOR(acpi
, flags
, ACPI
, FLAGS
, int)
275 void acpi_fake_objhandler(ACPI_HANDLE h
, void *data
);
276 static __inline device_t
277 acpi_get_device(ACPI_HANDLE handle
)
280 AcpiGetData(handle
, acpi_fake_objhandler
, &dev
);
281 return ((device_t
)dev
);
284 static __inline ACPI_OBJECT_TYPE
285 acpi_get_type(device_t dev
)
290 if ((h
= acpi_get_handle(dev
)) == NULL
)
291 return (ACPI_TYPE_NOT_FOUND
);
292 if (ACPI_FAILURE(AcpiGetType(h
, &t
)))
293 return (ACPI_TYPE_NOT_FOUND
);
297 /* Find the difference between two PM tick counts. */
298 static __inline
uint32_t
299 acpi_TimerDelta(uint32_t end
, uint32_t start
)
302 if (end
< start
&& (AcpiGbl_FADT
.Flags
& ACPI_FADT_32BIT_TIMER
) == 0)
304 return (end
- start
);
308 #include <sys/cons.h>
309 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
314 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
315 if (acpi_get_verbose(acpi_sc)) \
316 device_printf(dev, x); \
319 /* Values for the device _STA (status) method. */
320 #define ACPI_STA_PRESENT (1 << 0)
321 #define ACPI_STA_ENABLED (1 << 1)
322 #define ACPI_STA_SHOW_IN_UI (1 << 2)
323 #define ACPI_STA_FUNCTIONAL (1 << 3)
324 #define ACPI_STA_BATT_PRESENT (1 << 4)
326 #define ACPI_DEVINFO_PRESENT(x, flags) \
327 (((x) & (flags)) == (flags))
328 #define ACPI_DEVICE_PRESENT(x) \
329 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
330 #define ACPI_BATTERY_PRESENT(x) \
331 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
332 ACPI_STA_BATT_PRESENT)
334 BOOLEAN
acpi_DeviceIsPresent(device_t dev
);
335 BOOLEAN
acpi_BatteryIsPresent(device_t dev
);
336 ACPI_STATUS
acpi_GetHandleInScope(ACPI_HANDLE parent
, char *path
,
337 ACPI_HANDLE
*result
);
338 ACPI_BUFFER
*acpi_AllocBuffer(int size
);
339 ACPI_STATUS
acpi_ConvertBufferToInteger(ACPI_BUFFER
*bufp
,
341 ACPI_STATUS
acpi_GetInteger(ACPI_HANDLE handle
, char *path
,
343 ACPI_STATUS
acpi_SetInteger(ACPI_HANDLE handle
, char *path
,
345 ACPI_STATUS
acpi_ForeachPackageObject(ACPI_OBJECT
*obj
,
346 void (*func
)(ACPI_OBJECT
*comp
, void *arg
), void *arg
);
347 ACPI_STATUS
acpi_FindIndexedResource(ACPI_BUFFER
*buf
, int index
,
348 ACPI_RESOURCE
**resp
);
349 ACPI_STATUS
acpi_AppendBufferResource(ACPI_BUFFER
*buf
,
351 ACPI_STATUS
acpi_SetIntrModel(int model
);
352 int acpi_ReqSleepState(struct acpi_softc
*sc
, int state
);
353 int acpi_AckSleepState(struct apm_clone_data
*clone
, int error
);
354 ACPI_STATUS
acpi_SetSleepState(struct acpi_softc
*sc
, int state
);
355 int acpi_wake_set_enable(device_t dev
, int enable
);
356 int acpi_parse_prw(ACPI_HANDLE h
, struct acpi_prw_data
*prw
);
357 ACPI_STATUS
acpi_Startup(void);
358 void acpi_UserNotify(const char *subsystem
, ACPI_HANDLE h
,
360 int acpi_bus_alloc_gas(device_t dev
, int *type
, int *rid
,
361 ACPI_GENERIC_ADDRESS
*gas
, struct resource
**res
,
363 ACPI_STATUS
acpi_eval_osc(device_t dev
, ACPI_HANDLE handle
,
364 const char *uuidstr
, int revision
, uint32_t *buf
,
367 struct acpi_parse_resource_set
{
368 void (*set_init
)(device_t dev
, void *arg
, void **context
);
369 void (*set_done
)(device_t dev
, void *context
);
370 void (*set_ioport
)(device_t dev
, void *context
, uint64_t base
,
372 void (*set_iorange
)(device_t dev
, void *context
, uint64_t low
,
373 uint64_t high
, uint64_t length
, uint64_t align
);
374 void (*set_memory
)(device_t dev
, void *context
, uint64_t base
,
376 void (*set_memoryrange
)(device_t dev
, void *context
, uint64_t low
,
377 uint64_t high
, uint64_t length
, uint64_t align
);
378 void (*set_irq
)(device_t dev
, void *context
, uint8_t *irq
,
379 int count
, int trig
, int pol
);
380 void (*set_ext_irq
)(device_t dev
, void *context
, uint32_t *irq
,
381 int count
, int trig
, int pol
);
382 void (*set_drq
)(device_t dev
, void *context
, uint8_t *drq
,
384 void (*set_start_dependent
)(device_t dev
, void *context
,
386 void (*set_end_dependent
)(device_t dev
, void *context
);
389 extern struct acpi_parse_resource_set acpi_res_parse_set
;
391 void acpi_config_intr(device_t dev
, ACPI_RESOURCE
*res
);
392 ACPI_STATUS
acpi_lookup_irq_resource(device_t dev
, int rid
,
393 struct resource
*res
, ACPI_RESOURCE
*acpi_res
);
394 ACPI_STATUS
acpi_parse_resources(device_t dev
, ACPI_HANDLE handle
,
395 struct acpi_parse_resource_set
*set
, void *arg
);
397 /* ACPI event handling */
398 UINT32
acpi_event_power_button_sleep(void *context
);
399 UINT32
acpi_event_power_button_wake(void *context
);
400 UINT32
acpi_event_sleep_button_sleep(void *context
);
401 UINT32
acpi_event_sleep_button_wake(void *context
);
403 #define ACPI_EVENT_PRI_FIRST 0
404 #define ACPI_EVENT_PRI_DEFAULT 10000
405 #define ACPI_EVENT_PRI_LAST 20000
407 typedef void (*acpi_event_handler_t
)(void *, int);
409 EVENTHANDLER_DECLARE(acpi_sleep_event
, acpi_event_handler_t
);
410 EVENTHANDLER_DECLARE(acpi_wakeup_event
, acpi_event_handler_t
);
412 /* Device power control. */
413 ACPI_STATUS
acpi_pwr_wake_enable(ACPI_HANDLE consumer
, int enable
);
414 ACPI_STATUS
acpi_pwr_switch_consumer(ACPI_HANDLE consumer
, int state
);
417 static __inline
struct acpi_softc
*
418 acpi_device_get_parent_softc(device_t child
)
422 parent
= device_get_parent(child
);
425 return (device_get_softc(parent
));
429 acpi_get_verbose(struct acpi_softc
*sc
)
432 return (sc
->acpi_verbose
);
436 char *acpi_name(ACPI_HANDLE handle
);
437 int acpi_avoid(ACPI_HANDLE handle
);
438 int acpi_disabled(char *subsys
);
439 int acpi_enabled(char *subsys
);
440 int acpi_machdep_init(device_t dev
);
441 void acpi_install_wakeup_handler(struct acpi_softc
*sc
);
442 int acpi_sleep_machdep(struct acpi_softc
*sc
, int state
);
443 int acpi_table_quirks(int *quirks
);
444 int acpi_machdep_quirks(int *quirks
);
446 /* Battery Abstraction. */
447 struct acpi_battinfo
;
449 int acpi_battery_register(device_t dev
);
450 int acpi_battery_remove(device_t dev
);
451 int acpi_battery_get_units(void);
452 int acpi_battery_get_info_expire(void);
453 int acpi_battery_bst_valid(struct acpi_bst
*bst
);
454 int acpi_battery_bif_valid(struct acpi_bif
*bif
);
455 int acpi_battery_get_battinfo(device_t dev
,
456 struct acpi_battinfo
*info
);
458 /* Embedded controller. */
459 void acpi_ec_ecdt_probe(device_t
);
461 /* AC adapter interface. */
462 int acpi_acad_get_acline(int *);
464 /* Package manipulation convenience functions. */
465 #define ACPI_PKG_VALID(pkg, size) \
466 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
467 (pkg)->Package.Count >= (size))
468 #define ACPI_PKG_VALID_EQ(pkg, size) \
469 (ACPI_PKG_VALID((pkg), (size)) && (pkg)->Package.Count == (size))
470 int acpi_PkgInt(ACPI_OBJECT
*res
, int idx
, UINT64
*dst
);
471 int acpi_PkgInt32(ACPI_OBJECT
*res
, int idx
, uint32_t *dst
);
472 int acpi_PkgStr(ACPI_OBJECT
*res
, int idx
, void *dst
, size_t size
);
473 int acpi_PkgGas(device_t dev
, ACPI_OBJECT
*res
, int idx
, int *type
,
474 int *rid
, struct resource
**dst
, u_int flags
);
475 int acpi_PkgRawGas(ACPI_OBJECT
*res
, int idx
,
476 ACPI_GENERIC_ADDRESS
*gas
);
477 ACPI_HANDLE
acpi_GetReference(ACPI_HANDLE scope
, ACPI_OBJECT
*obj
);
478 /* ACPI task kernel thread initialization. */
479 int acpi_task_thread_init(void);
480 void acpi_task_thread_schedule(void);
481 extern BOOLEAN
acpi_MatchHid(ACPI_HANDLE h
, const char *hid
);
482 extern BOOLEAN
acpi_MatchUid(ACPI_HANDLE h
, const char *uid
);
484 * Base level for BUS_ADD_CHILD. Special devices are added at orders less
485 * than this, and normal devices at or above this level. This keeps the
486 * probe order sorted so that things like sysresource are available before
487 * their children need them.
489 #define ACPI_DEV_BASE_ORDER 10
491 /* Default number of task queue threads to start. */
492 #ifndef ACPI_MAX_THREADS
493 #define ACPI_MAX_THREADS 3
496 SYSCTL_DECL(_debug_acpi
);
499 #endif /* !_ACPIVAR_H_ */