15db2f26eSSascha Wildner /*-
25db2f26eSSascha Wildner * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
35db2f26eSSascha Wildner * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
45db2f26eSSascha Wildner * Copyright (c) 2000 BSDi
55db2f26eSSascha Wildner * All rights reserved.
65db2f26eSSascha Wildner *
75db2f26eSSascha Wildner * Redistribution and use in source and binary forms, with or without
85db2f26eSSascha Wildner * modification, are permitted provided that the following conditions
95db2f26eSSascha Wildner * are met:
105db2f26eSSascha Wildner * 1. Redistributions of source code must retain the above copyright
115db2f26eSSascha Wildner * notice, this list of conditions and the following disclaimer.
125db2f26eSSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
135db2f26eSSascha Wildner * notice, this list of conditions and the following disclaimer in the
145db2f26eSSascha Wildner * documentation and/or other materials provided with the distribution.
155db2f26eSSascha Wildner *
165db2f26eSSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
175db2f26eSSascha Wildner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
185db2f26eSSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
195db2f26eSSascha Wildner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
205db2f26eSSascha Wildner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
215db2f26eSSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
225db2f26eSSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
235db2f26eSSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
245db2f26eSSascha Wildner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
255db2f26eSSascha Wildner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
265db2f26eSSascha Wildner * SUCH DAMAGE.
275db2f26eSSascha Wildner *
285db2f26eSSascha Wildner * $FreeBSD: src/sys/dev/acpica/acpivar.h,v 1.108.8.1 2009/04/15 03:14:26 kensmith Exp $
295db2f26eSSascha Wildner */
305db2f26eSSascha Wildner
315db2f26eSSascha Wildner #ifndef _ACPIVAR_H_
325db2f26eSSascha Wildner #define _ACPIVAR_H_
335db2f26eSSascha Wildner
345db2f26eSSascha Wildner #ifdef _KERNEL
355db2f26eSSascha Wildner
365db2f26eSSascha Wildner
375db2f26eSSascha Wildner #include <sys/eventhandler.h>
385db2f26eSSascha Wildner #include <sys/sysctl.h>
395db2f26eSSascha Wildner #include <sys/lock.h>
405db2f26eSSascha Wildner #include <sys/bus.h>
415db2f26eSSascha Wildner #include <sys/spinlock.h>
425db2f26eSSascha Wildner #include <sys/spinlock2.h>
435db2f26eSSascha Wildner #include <sys/serialize.h>
447eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/acmacros.h>
457eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/acconfig.h>
467eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/aclocal.h>
477eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/acobject.h>
487eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/acstruct.h>
497eacbf00SSascha Wildner #include <contrib/dev/acpica/source/include/acutils.h>
505db2f26eSSascha Wildner
51*f87c2a86SSascha Wildner #include "acpi_if.h"
52*f87c2a86SSascha Wildner
535db2f26eSSascha Wildner struct apm_clone_data;
545db2f26eSSascha Wildner struct acpi_softc {
555db2f26eSSascha Wildner device_t acpi_dev;
565db2f26eSSascha Wildner cdev_t acpi_dev_t;
575db2f26eSSascha Wildner
585db2f26eSSascha Wildner struct resource *acpi_irq;
595db2f26eSSascha Wildner int acpi_irq_rid;
605db2f26eSSascha Wildner void *acpi_irq_handle;
615db2f26eSSascha Wildner
625db2f26eSSascha Wildner int acpi_enabled;
635db2f26eSSascha Wildner int acpi_sstate;
645db2f26eSSascha Wildner int acpi_sleep_disabled;
655db2f26eSSascha Wildner
665db2f26eSSascha Wildner struct sysctl_ctx_list acpi_sysctl_ctx;
675db2f26eSSascha Wildner struct sysctl_oid *acpi_sysctl_tree;
685db2f26eSSascha Wildner int acpi_power_button_sx;
695db2f26eSSascha Wildner int acpi_sleep_button_sx;
705db2f26eSSascha Wildner int acpi_lid_switch_sx;
715db2f26eSSascha Wildner
725db2f26eSSascha Wildner int acpi_standby_sx;
735db2f26eSSascha Wildner int acpi_suspend_sx;
745db2f26eSSascha Wildner
755db2f26eSSascha Wildner int acpi_sleep_delay;
765db2f26eSSascha Wildner int acpi_s4bios;
775db2f26eSSascha Wildner int acpi_do_disable;
785db2f26eSSascha Wildner int acpi_verbose;
795db2f26eSSascha Wildner int acpi_handle_reboot;
805db2f26eSSascha Wildner
815db2f26eSSascha Wildner bus_dma_tag_t acpi_waketag;
825db2f26eSSascha Wildner bus_dmamap_t acpi_wakemap;
835db2f26eSSascha Wildner vm_offset_t acpi_wakeaddr;
845db2f26eSSascha Wildner vm_paddr_t acpi_wakephys;
855db2f26eSSascha Wildner
865db2f26eSSascha Wildner int acpi_next_sstate; /* Next suspend Sx state. */
875db2f26eSSascha Wildner struct apm_clone_data *acpi_clone; /* Pseudo-dev for devd(8). */
885db2f26eSSascha Wildner STAILQ_HEAD(,apm_clone_data) apm_cdevs; /* All apm/apmctl/acpi cdevs. */
895db2f26eSSascha Wildner struct callout susp_force_to; /* Force suspend if no acks. */
905db2f26eSSascha Wildner };
915db2f26eSSascha Wildner
925db2f26eSSascha Wildner struct acpi_device {
935db2f26eSSascha Wildner /* ACPI ivars */
945db2f26eSSascha Wildner ACPI_HANDLE ad_handle;
955db2f26eSSascha Wildner uintptr_t ad_magic;
965db2f26eSSascha Wildner void *ad_private;
975db2f26eSSascha Wildner int ad_flags;
98ebb7869eSImre Vadász int ad_recheck; /* Should re-check presence. */
995db2f26eSSascha Wildner
1005db2f26eSSascha Wildner /* Resources */
1015db2f26eSSascha Wildner struct resource_list ad_rl;
1025db2f26eSSascha Wildner };
1035db2f26eSSascha Wildner
1045db2f26eSSascha Wildner /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
1055db2f26eSSascha Wildner struct apm_clone_data {
1065db2f26eSSascha Wildner STAILQ_ENTRY(apm_clone_data) entries;
1075db2f26eSSascha Wildner struct cdev *cdev;
1085db2f26eSSascha Wildner int flags;
1095db2f26eSSascha Wildner #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
1105db2f26eSSascha Wildner #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
1115db2f26eSSascha Wildner #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
1125db2f26eSSascha Wildner int notify_status;
1135db2f26eSSascha Wildner #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
1145db2f26eSSascha Wildner #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
1155db2f26eSSascha Wildner #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
1165db2f26eSSascha Wildner struct acpi_softc *acpi_sc;
1175db2f26eSSascha Wildner };
1185db2f26eSSascha Wildner
1195db2f26eSSascha Wildner #define ACPI_PRW_MAX_POWERRES 8
1205db2f26eSSascha Wildner
1215db2f26eSSascha Wildner struct acpi_prw_data {
1225db2f26eSSascha Wildner ACPI_HANDLE gpe_handle;
1235db2f26eSSascha Wildner int gpe_bit;
1245db2f26eSSascha Wildner int lowest_wake;
1255db2f26eSSascha Wildner ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
1265db2f26eSSascha Wildner int power_res_count;
1275db2f26eSSascha Wildner };
1285db2f26eSSascha Wildner
1295db2f26eSSascha Wildner /* Flags for each device defined in the AML namespace. */
1305db2f26eSSascha Wildner #define ACPI_FLAG_WAKE_ENABLED 0x1
1315db2f26eSSascha Wildner
1325db2f26eSSascha Wildner /* Macros for extracting parts of a PCI address from an _ADR value. */
1335db2f26eSSascha Wildner #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
1345db2f26eSSascha Wildner #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
1355db2f26eSSascha Wildner
1365db2f26eSSascha Wildner /*
1375db2f26eSSascha Wildner * Entry points to ACPI from above are global functions defined in this
1385db2f26eSSascha Wildner * file, sysctls, and I/O on the control device. Entry points from below
1395db2f26eSSascha Wildner * are interrupts (the SCI), notifies, task queue threads, and the thermal
1405db2f26eSSascha Wildner * zone polling thread.
1415db2f26eSSascha Wildner *
1425db2f26eSSascha Wildner * ACPI tables and global shared data are protected by a global lock
1435db2f26eSSascha Wildner * (acpi_lock).
1445db2f26eSSascha Wildner *
1455db2f26eSSascha Wildner * Each ACPI device can have its own driver-specific mutex for protecting
1465db2f26eSSascha Wildner * shared access to local data. The ACPI_LOCK macros handle mutexes.
1475db2f26eSSascha Wildner *
1485db2f26eSSascha Wildner * Drivers that need to serialize access to functions (e.g., to route
1495db2f26eSSascha Wildner * interrupts, get/set control paths, etc.) should use the sx lock macros
1505db2f26eSSascha Wildner * (ACPI_SERIAL).
1515db2f26eSSascha Wildner *
1529d1f0c52SSascha Wildner * ACPICA handles its own locking and should not be called with locks held.
1535db2f26eSSascha Wildner *
1545db2f26eSSascha Wildner * The most complicated path is:
1555db2f26eSSascha Wildner * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
1565db2f26eSSascha Wildner */
1575db2f26eSSascha Wildner extern struct lock acpi_lock;
158a639f788SMatthew Dillon extern struct lwkt_token acpi_token;
1595db2f26eSSascha Wildner /* acpi_thermal does lock recurs on purpose */
1605db2f26eSSascha Wildner /* I bet I should use some other locks here */
16192ebfd66SSascha Wildner #define ACPI_LOCK(sys) lockmgr(&sys##_lock, LK_EXCLUSIVE|LK_RETRY|LK_CANRECURSE)
16292ebfd66SSascha Wildner #define ACPI_UNLOCK(sys) lockmgr(&sys##_lock, LK_RELEASE)
16392ebfd66SSascha Wildner #define ACPI_LOCK_ASSERT(sys) KKASSERT(lockstatus(&sys##_lock, curthread) == LK_EXCLUSIVE)
1645db2f26eSSascha Wildner #define ACPI_ASSERTLOCK ACPI_LOCK_ASSERT
16592ebfd66SSascha Wildner #define ACPI_LOCK_DECL(sys, name) static struct lock sys##_lock
16692ebfd66SSascha Wildner #define ACPI_LOCK_INIT(sys, name) lockinit(&sys##_lock, name, 0, 0)
1675db2f26eSSascha Wildner
16892ebfd66SSascha Wildner #define ACPI_SERIAL_INIT(sys) lockinit(&sys##_serial, #sys, 0, 0)
16992ebfd66SSascha Wildner #define ACPI_SERIAL_BEGIN(sys) lockmgr(&sys##_serial, LK_EXCLUSIVE|LK_RETRY)
17092ebfd66SSascha Wildner #define ACPI_SERIAL_END(sys) lockmgr(&sys##_serial, LK_RELEASE)
17192ebfd66SSascha Wildner #define ACPI_SERIAL_ASSERT(sys) KKASSERT(lockstatus(&sys##_serial, curthread) == LK_EXCLUSIVE)
17292ebfd66SSascha Wildner #define ACPI_SERIAL_DECL(sys, name) static struct lock sys##_serial
17392ebfd66SSascha Wildner
1745db2f26eSSascha Wildner /*
1755db2f26eSSascha Wildner * ACPICA does not define layers for non-ACPICA drivers.
1765db2f26eSSascha Wildner * We define some here within the range provided.
1775db2f26eSSascha Wildner */
1785db2f26eSSascha Wildner #define ACPI_AC_ADAPTER 0x00010000
1795db2f26eSSascha Wildner #define ACPI_BATTERY 0x00020000
1805db2f26eSSascha Wildner #define ACPI_BUS 0x00040000
1815db2f26eSSascha Wildner #define ACPI_BUTTON 0x00080000
1825db2f26eSSascha Wildner #define ACPI_EC 0x00100000
1835db2f26eSSascha Wildner #define ACPI_FAN 0x00200000
1845db2f26eSSascha Wildner #define ACPI_POWERRES 0x00400000
1855db2f26eSSascha Wildner #define ACPI_PROCESSOR 0x00800000
1865db2f26eSSascha Wildner #define ACPI_THERMAL 0x01000000
1875db2f26eSSascha Wildner #define ACPI_TIMER 0x02000000
1885db2f26eSSascha Wildner #define ACPI_OEM 0x04000000
1895db2f26eSSascha Wildner
1905db2f26eSSascha Wildner /*
1915db2f26eSSascha Wildner * Constants for different interrupt models used with acpi_SetIntrModel().
1925db2f26eSSascha Wildner */
1935db2f26eSSascha Wildner #define ACPI_INTR_PIC 0
1945db2f26eSSascha Wildner #define ACPI_INTR_APIC 1
1955db2f26eSSascha Wildner #define ACPI_INTR_SAPIC 2
1965db2f26eSSascha Wildner
1975db2f26eSSascha Wildner /*
198f48d5ffcSSascha Wildner * Various features and capabilities for the acpi_eval_osc() method.
199f48d5ffcSSascha Wildner */
200f48d5ffcSSascha Wildner #define ACPI_OSC_QUERY_SUPPORT (1 << 0) /* Query Support Flag */
201f48d5ffcSSascha Wildner
202f48d5ffcSSascha Wildner #define ACPI_OSC_ERRMASK 0x0000001e
203f48d5ffcSSascha Wildner #define ACPI_OSCERR_FAILURE (1 << 1) /* _OSC failure */
204f48d5ffcSSascha Wildner #define ACPI_OSCERR_BADUUID (1 << 2) /* Unrecognized UUID */
205f48d5ffcSSascha Wildner #define ACPI_OSCERR_BADREV (1 << 3) /* Unrecognized revision ID */
206f48d5ffcSSascha Wildner #define ACPI_OSCERR_CAPSMASKED (1 << 4) /* Capabilities have been cleared */
207f48d5ffcSSascha Wildner
208f48d5ffcSSascha Wildner /*
209f48d5ffcSSascha Wildner * Intel CPU _OSC capabilities, see "Intel Processor Vendor-Specific ACPI",
210f48d5ffcSSascha Wildner * number 302223-007.
2115db2f26eSSascha Wildner */
2125db2f26eSSascha Wildner #define ACPI_PDC_PX_MSR (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
2135db2f26eSSascha Wildner #define ACPI_PDC_MP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
2145db2f26eSSascha Wildner #define ACPI_PDC_TX_MSR (1 << 2) /* Intel OnDemand throttling MSRs */
2155db2f26eSSascha Wildner #define ACPI_PDC_MP_C1PXTX (1 << 3) /* MP C1, Px, and Tx */
2165db2f26eSSascha Wildner #define ACPI_PDC_MP_C2C3 (1 << 4) /* MP C2 and C3 */
2175db2f26eSSascha Wildner #define ACPI_PDC_MP_PX_SWCOORD (1 << 5) /* MP Px, using _PSD */
2185db2f26eSSascha Wildner #define ACPI_PDC_MP_CX_SWCOORD (1 << 6) /* MP Cx, using _CSD */
2195db2f26eSSascha Wildner #define ACPI_PDC_MP_TX_SWCOORD (1 << 7) /* MP Tx, using _TSD */
2205db2f26eSSascha Wildner #define ACPI_PDC_MP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
2215db2f26eSSascha Wildner #define ACPI_PDC_MP_C2C3_NATIVE (1 << 9) /* MP C2 and C3 support */
2225db2f26eSSascha Wildner #define ACPI_PDC_PX_HWCOORD (1 << 11)/* Hardware coordination of Px */
2235db2f26eSSascha Wildner
2245db2f26eSSascha Wildner /*
2255db2f26eSSascha Wildner * Quirk flags.
2265db2f26eSSascha Wildner *
2275db2f26eSSascha Wildner * ACPI_Q_BROKEN: Disables all ACPI support.
2285db2f26eSSascha Wildner * ACPI_Q_TIMER: Disables support for the ACPI timer.
2295db2f26eSSascha Wildner * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
2305db2f26eSSascha Wildner * first APIC and that the MADT should force that by ignoring the PC-AT
2315db2f26eSSascha Wildner * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
2323bb5af08SSascha Wildner * ACPI_Q_BATT_RATE_ABS: Specifies that the DSDT reports a negative 16-bit
2333bb5af08SSascha Wildner * value for charging/discharging current and/or 0 as 65536.
2345db2f26eSSascha Wildner */
2355db2f26eSSascha Wildner extern int acpi_quirks;
2365db2f26eSSascha Wildner #define ACPI_Q_OK 0
2375db2f26eSSascha Wildner #define ACPI_Q_BROKEN (1 << 0)
2385db2f26eSSascha Wildner #define ACPI_Q_TIMER (1 << 1)
2395db2f26eSSascha Wildner #define ACPI_Q_MADT_IRQ0 (1 << 2)
2403bb5af08SSascha Wildner #define ACPI_Q_BATT_RATE_ABS (1 << 3)
2415db2f26eSSascha Wildner
2425db2f26eSSascha Wildner /*
2435db2f26eSSascha Wildner * Note that the low ivar values are reserved to provide
2445db2f26eSSascha Wildner * interface compatibility with ISA drivers which can also
2455db2f26eSSascha Wildner * attach to ACPI.
2465db2f26eSSascha Wildner */
2475db2f26eSSascha Wildner #define ACPI_IVAR_HANDLE 0x100
2485db2f26eSSascha Wildner #define ACPI_IVAR_MAGIC 0x101
2495db2f26eSSascha Wildner #define ACPI_IVAR_PRIVATE 0x102
2505db2f26eSSascha Wildner #define ACPI_IVAR_FLAGS 0x103
251ebb7869eSImre Vadász #define ACPI_IVAR_RECHECK 0x104
2525db2f26eSSascha Wildner
2535db2f26eSSascha Wildner /*
2545db2f26eSSascha Wildner * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
2555db2f26eSSascha Wildner * (type) 0. The <sys/bus.h> accessor functions don't check return values.
2565db2f26eSSascha Wildner */
2575db2f26eSSascha Wildner #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
2585db2f26eSSascha Wildner \
2595db2f26eSSascha Wildner static __inline type varp ## _get_ ## var(device_t dev) \
2605db2f26eSSascha Wildner { \
2615db2f26eSSascha Wildner uintptr_t v = 0; \
2625db2f26eSSascha Wildner BUS_READ_IVAR(device_get_parent(dev), dev, \
2635db2f26eSSascha Wildner ivarp ## _IVAR_ ## ivar, &v); \
2645db2f26eSSascha Wildner return ((type) v); \
2655db2f26eSSascha Wildner } \
2665db2f26eSSascha Wildner \
2675db2f26eSSascha Wildner static __inline void varp ## _set_ ## var(device_t dev, type t) \
2685db2f26eSSascha Wildner { \
2695db2f26eSSascha Wildner uintptr_t v = (uintptr_t) t; \
2705db2f26eSSascha Wildner BUS_WRITE_IVAR(device_get_parent(dev), dev, \
2715db2f26eSSascha Wildner ivarp ## _IVAR_ ## ivar, v); \
2725db2f26eSSascha Wildner }
2735db2f26eSSascha Wildner
2745db2f26eSSascha Wildner __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
2755db2f26eSSascha Wildner __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, uintptr_t)
2765db2f26eSSascha Wildner __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
2775db2f26eSSascha Wildner __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
278ebb7869eSImre Vadász __ACPI_BUS_ACCESSOR(acpi, recheck, ACPI, RECHECK, int)
2795db2f26eSSascha Wildner
2805db2f26eSSascha Wildner void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
2815db2f26eSSascha Wildner static __inline device_t
acpi_get_device(ACPI_HANDLE handle)2825db2f26eSSascha Wildner acpi_get_device(ACPI_HANDLE handle)
2835db2f26eSSascha Wildner {
2845db2f26eSSascha Wildner void *dev = NULL;
2855db2f26eSSascha Wildner AcpiGetData(handle, acpi_fake_objhandler, &dev);
2865db2f26eSSascha Wildner return ((device_t)dev);
2875db2f26eSSascha Wildner }
2885db2f26eSSascha Wildner
2895db2f26eSSascha Wildner static __inline ACPI_OBJECT_TYPE
acpi_get_type(device_t dev)2905db2f26eSSascha Wildner acpi_get_type(device_t dev)
2915db2f26eSSascha Wildner {
2925db2f26eSSascha Wildner ACPI_HANDLE h;
2935db2f26eSSascha Wildner ACPI_OBJECT_TYPE t;
2945db2f26eSSascha Wildner
2955db2f26eSSascha Wildner if ((h = acpi_get_handle(dev)) == NULL)
2965db2f26eSSascha Wildner return (ACPI_TYPE_NOT_FOUND);
297b08525dbSSascha Wildner if (ACPI_FAILURE(AcpiGetType(h, &t)))
2985db2f26eSSascha Wildner return (ACPI_TYPE_NOT_FOUND);
2995db2f26eSSascha Wildner return (t);
3005db2f26eSSascha Wildner }
3015db2f26eSSascha Wildner
3025db2f26eSSascha Wildner /* Find the difference between two PM tick counts. */
3035db2f26eSSascha Wildner static __inline uint32_t
acpi_TimerDelta(uint32_t end,uint32_t start)3045db2f26eSSascha Wildner acpi_TimerDelta(uint32_t end, uint32_t start)
3055db2f26eSSascha Wildner {
3065db2f26eSSascha Wildner
3075db2f26eSSascha Wildner if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
3085db2f26eSSascha Wildner end |= 0x01000000;
3095db2f26eSSascha Wildner return (end - start);
3105db2f26eSSascha Wildner }
3115db2f26eSSascha Wildner
3125db2f26eSSascha Wildner #ifdef ACPI_DEBUG
3135db2f26eSSascha Wildner #include <sys/cons.h>
3145db2f26eSSascha Wildner #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
3155db2f26eSSascha Wildner #else
3165db2f26eSSascha Wildner #define STEP(x)
3175db2f26eSSascha Wildner #endif
3185db2f26eSSascha Wildner
3195db2f26eSSascha Wildner #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
3205db2f26eSSascha Wildner if (acpi_get_verbose(acpi_sc)) \
3215db2f26eSSascha Wildner device_printf(dev, x); \
3225db2f26eSSascha Wildner } while (0)
3235db2f26eSSascha Wildner
3245db2f26eSSascha Wildner /* Values for the device _STA (status) method. */
3255db2f26eSSascha Wildner #define ACPI_STA_PRESENT (1 << 0)
3265db2f26eSSascha Wildner #define ACPI_STA_ENABLED (1 << 1)
3275db2f26eSSascha Wildner #define ACPI_STA_SHOW_IN_UI (1 << 2)
3285db2f26eSSascha Wildner #define ACPI_STA_FUNCTIONAL (1 << 3)
3295db2f26eSSascha Wildner #define ACPI_STA_BATT_PRESENT (1 << 4)
3305db2f26eSSascha Wildner
3315db2f26eSSascha Wildner #define ACPI_DEVINFO_PRESENT(x, flags) \
3325db2f26eSSascha Wildner (((x) & (flags)) == (flags))
3335db2f26eSSascha Wildner #define ACPI_DEVICE_PRESENT(x) \
3345db2f26eSSascha Wildner ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
3355db2f26eSSascha Wildner #define ACPI_BATTERY_PRESENT(x) \
3365db2f26eSSascha Wildner ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
3375db2f26eSSascha Wildner ACPI_STA_BATT_PRESENT)
3385db2f26eSSascha Wildner
3395db2f26eSSascha Wildner BOOLEAN acpi_DeviceIsPresent(device_t dev);
3405db2f26eSSascha Wildner BOOLEAN acpi_BatteryIsPresent(device_t dev);
3415db2f26eSSascha Wildner ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
3425db2f26eSSascha Wildner ACPI_HANDLE *result);
3435db2f26eSSascha Wildner ACPI_BUFFER *acpi_AllocBuffer(int size);
3445db2f26eSSascha Wildner ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
3455db2f26eSSascha Wildner UINT32 *number);
3465db2f26eSSascha Wildner ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
3475db2f26eSSascha Wildner UINT32 *number);
3485db2f26eSSascha Wildner ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
3495db2f26eSSascha Wildner UINT32 number);
3505db2f26eSSascha Wildner ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
3515db2f26eSSascha Wildner void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
3525db2f26eSSascha Wildner ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
3535db2f26eSSascha Wildner ACPI_RESOURCE **resp);
3545db2f26eSSascha Wildner ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
3555db2f26eSSascha Wildner ACPI_RESOURCE *res);
3565db2f26eSSascha Wildner ACPI_STATUS acpi_SetIntrModel(int model);
3575db2f26eSSascha Wildner int acpi_ReqSleepState(struct acpi_softc *sc, int state);
3585db2f26eSSascha Wildner int acpi_AckSleepState(struct apm_clone_data *clone, int error);
3595db2f26eSSascha Wildner ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
3605db2f26eSSascha Wildner int acpi_wake_set_enable(device_t dev, int enable);
3615db2f26eSSascha Wildner int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
3625db2f26eSSascha Wildner ACPI_STATUS acpi_Startup(void);
3635db2f26eSSascha Wildner void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
3645db2f26eSSascha Wildner uint8_t notify);
3655db2f26eSSascha Wildner int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
3665db2f26eSSascha Wildner ACPI_GENERIC_ADDRESS *gas, struct resource **res,
3675db2f26eSSascha Wildner u_int flags);
3685ca62c87SSascha Wildner ACPI_STATUS acpi_eval_osc(device_t dev, ACPI_HANDLE handle,
3695ca62c87SSascha Wildner const char *uuidstr, int revision, uint32_t *buf,
3705ca62c87SSascha Wildner int count);
3715db2f26eSSascha Wildner
3725db2f26eSSascha Wildner struct acpi_parse_resource_set {
3735db2f26eSSascha Wildner void (*set_init)(device_t dev, void *arg, void **context);
3745db2f26eSSascha Wildner void (*set_done)(device_t dev, void *context);
375ad52dd32SSascha Wildner void (*set_ioport)(device_t dev, void *context, uint64_t base,
376ad52dd32SSascha Wildner uint64_t length);
377ad52dd32SSascha Wildner void (*set_iorange)(device_t dev, void *context, uint64_t low,
378ad52dd32SSascha Wildner uint64_t high, uint64_t length, uint64_t align);
379ad52dd32SSascha Wildner void (*set_memory)(device_t dev, void *context, uint64_t base,
380ad52dd32SSascha Wildner uint64_t length);
381ad52dd32SSascha Wildner void (*set_memoryrange)(device_t dev, void *context, uint64_t low,
382ad52dd32SSascha Wildner uint64_t high, uint64_t length, uint64_t align);
3833905511eSSascha Wildner void (*set_irq)(device_t dev, void *context, uint8_t *irq,
3845db2f26eSSascha Wildner int count, int trig, int pol);
3853905511eSSascha Wildner void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
3865db2f26eSSascha Wildner int count, int trig, int pol);
3873905511eSSascha Wildner void (*set_drq)(device_t dev, void *context, uint8_t *drq,
3885db2f26eSSascha Wildner int count);
3895db2f26eSSascha Wildner void (*set_start_dependent)(device_t dev, void *context,
3905db2f26eSSascha Wildner int preference);
3915db2f26eSSascha Wildner void (*set_end_dependent)(device_t dev, void *context);
3925db2f26eSSascha Wildner };
3935db2f26eSSascha Wildner
3945db2f26eSSascha Wildner extern struct acpi_parse_resource_set acpi_res_parse_set;
3955db2f26eSSascha Wildner
3965db2f26eSSascha Wildner void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
3975db2f26eSSascha Wildner ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
3985db2f26eSSascha Wildner struct resource *res, ACPI_RESOURCE *acpi_res);
3995db2f26eSSascha Wildner ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
4005db2f26eSSascha Wildner struct acpi_parse_resource_set *set, void *arg);
4015db2f26eSSascha Wildner
4025db2f26eSSascha Wildner /* ACPI event handling */
4035db2f26eSSascha Wildner UINT32 acpi_event_power_button_sleep(void *context);
4045db2f26eSSascha Wildner UINT32 acpi_event_power_button_wake(void *context);
4055db2f26eSSascha Wildner UINT32 acpi_event_sleep_button_sleep(void *context);
4065db2f26eSSascha Wildner UINT32 acpi_event_sleep_button_wake(void *context);
4075db2f26eSSascha Wildner
4085db2f26eSSascha Wildner #define ACPI_EVENT_PRI_FIRST 0
4095db2f26eSSascha Wildner #define ACPI_EVENT_PRI_DEFAULT 10000
4105db2f26eSSascha Wildner #define ACPI_EVENT_PRI_LAST 20000
4115db2f26eSSascha Wildner
4125db2f26eSSascha Wildner typedef void (*acpi_event_handler_t)(void *, int);
4135db2f26eSSascha Wildner
4145db2f26eSSascha Wildner EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
4155db2f26eSSascha Wildner EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
4165db2f26eSSascha Wildner
4175db2f26eSSascha Wildner /* Device power control. */
4185db2f26eSSascha Wildner ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
4195db2f26eSSascha Wildner ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
4205db2f26eSSascha Wildner
4215db2f26eSSascha Wildner /* Misc. */
4225db2f26eSSascha Wildner static __inline struct acpi_softc *
acpi_device_get_parent_softc(device_t child)4235db2f26eSSascha Wildner acpi_device_get_parent_softc(device_t child)
4245db2f26eSSascha Wildner {
4255db2f26eSSascha Wildner device_t parent;
4265db2f26eSSascha Wildner
4275db2f26eSSascha Wildner parent = device_get_parent(child);
4285db2f26eSSascha Wildner if (parent == NULL)
4295db2f26eSSascha Wildner return (NULL);
4305db2f26eSSascha Wildner return (device_get_softc(parent));
4315db2f26eSSascha Wildner }
4325db2f26eSSascha Wildner
4335db2f26eSSascha Wildner static __inline int
acpi_get_verbose(struct acpi_softc * sc)4345db2f26eSSascha Wildner acpi_get_verbose(struct acpi_softc *sc)
4355db2f26eSSascha Wildner {
4365db2f26eSSascha Wildner if (sc)
4375db2f26eSSascha Wildner return (sc->acpi_verbose);
4385db2f26eSSascha Wildner return (0);
4395db2f26eSSascha Wildner }
4405db2f26eSSascha Wildner
4415db2f26eSSascha Wildner char *acpi_name(ACPI_HANDLE handle);
4425db2f26eSSascha Wildner int acpi_avoid(ACPI_HANDLE handle);
4435db2f26eSSascha Wildner int acpi_disabled(char *subsys);
4445db2f26eSSascha Wildner int acpi_enabled(char *subsys);
4455db2f26eSSascha Wildner int acpi_machdep_init(device_t dev);
4465db2f26eSSascha Wildner void acpi_install_wakeup_handler(struct acpi_softc *sc);
4475db2f26eSSascha Wildner int acpi_sleep_machdep(struct acpi_softc *sc, int state);
4485db2f26eSSascha Wildner int acpi_table_quirks(int *quirks);
4495db2f26eSSascha Wildner int acpi_machdep_quirks(int *quirks);
4505db2f26eSSascha Wildner
4515db2f26eSSascha Wildner /* Battery Abstraction. */
4525db2f26eSSascha Wildner struct acpi_battinfo;
4535db2f26eSSascha Wildner
4545db2f26eSSascha Wildner int acpi_battery_register(device_t dev);
4555db2f26eSSascha Wildner int acpi_battery_remove(device_t dev);
4565db2f26eSSascha Wildner int acpi_battery_get_units(void);
4575db2f26eSSascha Wildner int acpi_battery_get_info_expire(void);
4585db2f26eSSascha Wildner int acpi_battery_bst_valid(struct acpi_bst *bst);
4595db2f26eSSascha Wildner int acpi_battery_bif_valid(struct acpi_bif *bif);
4605db2f26eSSascha Wildner int acpi_battery_get_battinfo(device_t dev,
4615db2f26eSSascha Wildner struct acpi_battinfo *info);
4625db2f26eSSascha Wildner
4635db2f26eSSascha Wildner /* Embedded controller. */
4645db2f26eSSascha Wildner void acpi_ec_ecdt_probe(device_t);
4655db2f26eSSascha Wildner
4665db2f26eSSascha Wildner /* AC adapter interface. */
4675db2f26eSSascha Wildner int acpi_acad_get_acline(int *);
4685db2f26eSSascha Wildner
4695db2f26eSSascha Wildner /* Package manipulation convenience functions. */
4705db2f26eSSascha Wildner #define ACPI_PKG_VALID(pkg, size) \
4715db2f26eSSascha Wildner ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
4725db2f26eSSascha Wildner (pkg)->Package.Count >= (size))
4735db2f26eSSascha Wildner #define ACPI_PKG_VALID_EQ(pkg, size) \
4745db2f26eSSascha Wildner (ACPI_PKG_VALID((pkg), (size)) && (pkg)->Package.Count == (size))
475417dc5a4SSascha Wildner int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
4765db2f26eSSascha Wildner int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
4775db2f26eSSascha Wildner int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
4785db2f26eSSascha Wildner int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
4795db2f26eSSascha Wildner int *rid, struct resource **dst, u_int flags);
4805db2f26eSSascha Wildner int acpi_PkgRawGas(ACPI_OBJECT *res, int idx,
4815db2f26eSSascha Wildner ACPI_GENERIC_ADDRESS *gas);
4825db2f26eSSascha Wildner ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
4835db2f26eSSascha Wildner /* ACPI task kernel thread initialization. */
4845db2f26eSSascha Wildner int acpi_task_thread_init(void);
485bde01544SSepherosa Ziehau void acpi_task_thread_schedule(void);
4865db2f26eSSascha Wildner extern BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid);
48791912fdfSImre Vadász extern BOOLEAN acpi_MatchUid(ACPI_HANDLE h, const char *uid);
4885db2f26eSSascha Wildner /*
4895db2f26eSSascha Wildner * Base level for BUS_ADD_CHILD. Special devices are added at orders less
4905db2f26eSSascha Wildner * than this, and normal devices at or above this level. This keeps the
4915db2f26eSSascha Wildner * probe order sorted so that things like sysresource are available before
4925db2f26eSSascha Wildner * their children need them.
4935db2f26eSSascha Wildner */
4945db2f26eSSascha Wildner #define ACPI_DEV_BASE_ORDER 10
4955db2f26eSSascha Wildner
4965db2f26eSSascha Wildner /* Default number of task queue threads to start. */
4975db2f26eSSascha Wildner #ifndef ACPI_MAX_THREADS
4985db2f26eSSascha Wildner #define ACPI_MAX_THREADS 3
4995db2f26eSSascha Wildner #endif
5005db2f26eSSascha Wildner
5018db79487SSascha Wildner SYSCTL_DECL(_debug_acpi);
5028db79487SSascha Wildner
5035db2f26eSSascha Wildner #endif /* _KERNEL */
5045db2f26eSSascha Wildner #endif /* !_ACPIVAR_H_ */
505