29 */
30
31#ifndef _ACPIVAR_H_
32#define _ACPIVAR_H_
33
34#ifdef _KERNEL
35
36#include "acpi_if.h"
37#include "bus_if.h"
38#include <sys/eventhandler.h>
39#include <sys/ktr.h>
40#include <sys/lock.h>
41#include <sys/mutex.h>
42#include <sys/selinfo.h>
43#include <sys/sx.h>
44#include <sys/sysctl.h>
45
46#include <machine/bus.h>
47#include <machine/resource.h>
48
49struct apm_clone_data;
50struct acpi_softc {
51 device_t acpi_dev;
52 struct cdev *acpi_dev_t;
53
54 struct resource *acpi_irq;
55 int acpi_irq_rid;
56 void *acpi_irq_handle;
57
58 int acpi_enabled;
59 int acpi_sstate;
60 int acpi_sleep_disabled;
61
62 struct sysctl_ctx_list acpi_sysctl_ctx;
63 struct sysctl_oid *acpi_sysctl_tree;
64 int acpi_power_button_sx;
65 int acpi_sleep_button_sx;
66 int acpi_lid_switch_sx;
67
68 int acpi_standby_sx;
69 int acpi_suspend_sx;
70
71 int acpi_sleep_delay;
72 int acpi_s4bios;
73 int acpi_do_disable;
74 int acpi_verbose;
75 int acpi_handle_reboot;
76
77 bus_dma_tag_t acpi_waketag;
78 bus_dmamap_t acpi_wakemap;
79 vm_offset_t acpi_wakeaddr;
80 vm_paddr_t acpi_wakephys;
81
82 int acpi_next_sstate; /* Next suspend Sx state. */
83 struct apm_clone_data *acpi_clone; /* Pseudo-dev for devd(8). */
84 STAILQ_HEAD(,apm_clone_data) apm_cdevs; /* All apm/apmctl/acpi cdevs. */
85 struct callout susp_force_to; /* Force suspend if no acks. */
86};
87
88struct acpi_device {
89 /* ACPI ivars */
90 ACPI_HANDLE ad_handle;
91 uintptr_t ad_magic;
92 void *ad_private;
93 int ad_flags;
94
95 /* Resources */
96 struct resource_list ad_rl;
97};
98
99/* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
100struct apm_clone_data {
101 STAILQ_ENTRY(apm_clone_data) entries;
102 struct cdev *cdev;
103 int flags;
104#define ACPI_EVF_NONE 0 /* /dev/apm semantics */
105#define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
106#define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
107 int notify_status;
108#define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
109#define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
110#define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
111 struct acpi_softc *acpi_sc;
112 struct selinfo sel_read;
113};
114
115#define ACPI_PRW_MAX_POWERRES 8
116
117struct acpi_prw_data {
118 ACPI_HANDLE gpe_handle;
119 int gpe_bit;
120 int lowest_wake;
121 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
122 int power_res_count;
123};
124
125/* Flags for each device defined in the AML namespace. */
126#define ACPI_FLAG_WAKE_ENABLED 0x1
127
128/* Macros for extracting parts of a PCI address from an _ADR value. */
129#define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
130#define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
131
132/*
133 * Entry points to ACPI from above are global functions defined in this
134 * file, sysctls, and I/O on the control device. Entry points from below
135 * are interrupts (the SCI), notifies, task queue threads, and the thermal
136 * zone polling thread.
137 *
138 * ACPI tables and global shared data are protected by a global lock
139 * (acpi_mutex).
140 *
141 * Each ACPI device can have its own driver-specific mutex for protecting
142 * shared access to local data. The ACPI_LOCK macros handle mutexes.
143 *
144 * Drivers that need to serialize access to functions (e.g., to route
145 * interrupts, get/set control paths, etc.) should use the sx lock macros
146 * (ACPI_SERIAL).
147 *
148 * ACPI-CA handles its own locking and should not be called with locks held.
149 *
150 * The most complicated path is:
151 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
152 */
153extern struct mtx acpi_mutex;
154#define ACPI_LOCK(sys) mtx_lock(&sys##_mutex)
155#define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex)
156#define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED);
157#define ACPI_LOCK_DECL(sys, name) \
158 static struct mtx sys##_mutex; \
159 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
160#define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock)
161#define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock)
162#define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED);
163#define ACPI_SERIAL_DECL(sys, name) \
164 static struct sx sys##_sxlock; \
165 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
166
167/*
168 * ACPI CA does not define layers for non-ACPI CA drivers.
169 * We define some here within the range provided.
170 */
171#define ACPI_AC_ADAPTER 0x00010000
172#define ACPI_BATTERY 0x00020000
173#define ACPI_BUS 0x00040000
174#define ACPI_BUTTON 0x00080000
175#define ACPI_EC 0x00100000
176#define ACPI_FAN 0x00200000
177#define ACPI_POWERRES 0x00400000
178#define ACPI_PROCESSOR 0x00800000
179#define ACPI_THERMAL 0x01000000
180#define ACPI_TIMER 0x02000000
181#define ACPI_OEM 0x04000000
182
183/*
184 * Constants for different interrupt models used with acpi_SetIntrModel().
185 */
186#define ACPI_INTR_PIC 0
187#define ACPI_INTR_APIC 1
188#define ACPI_INTR_SAPIC 2
189
190/*
191 * Various features and capabilities for the acpi_get_features() method.
192 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
193 * See the Intel document titled "Processor Driver Capabilities Bit
194 * Definitions", number 302223-002.
195 */
196#define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
197#define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
198#define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
199#define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
200#define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
201#define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
202#define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
203#define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
204#define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
205
206/*
207 * Quirk flags.
208 *
209 * ACPI_Q_BROKEN: Disables all ACPI support.
210 * ACPI_Q_TIMER: Disables support for the ACPI timer.
211 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
212 * first APIC and that the MADT should force that by ignoring the PC-AT
213 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
214 */
215extern int acpi_quirks;
216#define ACPI_Q_OK 0
217#define ACPI_Q_BROKEN (1 << 0)
218#define ACPI_Q_TIMER (1 << 1)
219#define ACPI_Q_MADT_IRQ0 (1 << 2)
220
221/*
222 * Note that the low ivar values are reserved to provide
223 * interface compatibility with ISA drivers which can also
224 * attach to ACPI.
225 */
226#define ACPI_IVAR_HANDLE 0x100
227#define ACPI_IVAR_MAGIC 0x101
228#define ACPI_IVAR_PRIVATE 0x102
229#define ACPI_IVAR_FLAGS 0x103
230
231/*
232 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
233 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
234 */
235#define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
236 \
237static __inline type varp ## _get_ ## var(device_t dev) \
238{ \
239 uintptr_t v = 0; \
240 BUS_READ_IVAR(device_get_parent(dev), dev, \
241 ivarp ## _IVAR_ ## ivar, &v); \
242 return ((type) v); \
243} \
244 \
245static __inline void varp ## _set_ ## var(device_t dev, type t) \
246{ \
247 uintptr_t v = (uintptr_t) t; \
248 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
249 ivarp ## _IVAR_ ## ivar, v); \
250}
251
252__ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
253__ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, uintptr_t)
254__ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
255__ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
256
257void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
258static __inline device_t
259acpi_get_device(ACPI_HANDLE handle)
260{
261 void *dev = NULL;
262 AcpiGetData(handle, acpi_fake_objhandler, &dev);
263 return ((device_t)dev);
264}
265
266static __inline ACPI_OBJECT_TYPE
267acpi_get_type(device_t dev)
268{
269 ACPI_HANDLE h;
270 ACPI_OBJECT_TYPE t;
271
272 if ((h = acpi_get_handle(dev)) == NULL)
273 return (ACPI_TYPE_NOT_FOUND);
274 if (AcpiGetType(h, &t) != AE_OK)
275 return (ACPI_TYPE_NOT_FOUND);
276 return (t);
277}
278
279#ifdef ACPI_DEBUGGER
280void acpi_EnterDebugger(void);
281#endif
282
283#ifdef ACPI_DEBUG
284#include <sys/cons.h>
285#define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
286#else
287#define STEP(x)
288#endif
289
290#define ACPI_VPRINT(dev, acpi_sc, x...) do { \
291 if (acpi_get_verbose(acpi_sc)) \
292 device_printf(dev, x); \
293} while (0)
294
295/* Values for the device _STA (status) method. */
296#define ACPI_STA_PRESENT (1 << 0)
297#define ACPI_STA_ENABLED (1 << 1)
298#define ACPI_STA_SHOW_IN_UI (1 << 2)
299#define ACPI_STA_FUNCTIONAL (1 << 3)
300#define ACPI_STA_BATT_PRESENT (1 << 4)
301
302#define ACPI_DEVINFO_PRESENT(x, flags) \
303 (((x) & (flags)) == (flags))
304#define ACPI_DEVICE_PRESENT(x) \
305 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
306#define ACPI_BATTERY_PRESENT(x) \
307 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
308 ACPI_STA_BATT_PRESENT)
309
310BOOLEAN acpi_DeviceIsPresent(device_t dev);
311BOOLEAN acpi_BatteryIsPresent(device_t dev);
312ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
313 ACPI_HANDLE *result);
314uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
315ACPI_BUFFER *acpi_AllocBuffer(int size);
316ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
317 UINT32 *number);
318ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
319 UINT32 *number);
320ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
321 UINT32 number);
322ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
323 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
324ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
325 ACPI_RESOURCE **resp);
326ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
327 ACPI_RESOURCE *res);
328ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
329ACPI_STATUS acpi_SetIntrModel(int model);
330int acpi_ReqSleepState(struct acpi_softc *sc, int state);
331int acpi_AckSleepState(struct apm_clone_data *clone, int error);
332ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
333int acpi_wake_init(device_t dev, int type);
334int acpi_wake_set_enable(device_t dev, int enable);
335int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
336ACPI_STATUS acpi_Startup(void);
337void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
338 uint8_t notify);
339int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
340 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
341 u_int flags);
342
343struct acpi_parse_resource_set {
344 void (*set_init)(device_t dev, void *arg, void **context);
345 void (*set_done)(device_t dev, void *context);
346 void (*set_ioport)(device_t dev, void *context, uint32_t base,
347 uint32_t length);
348 void (*set_iorange)(device_t dev, void *context, uint32_t low,
349 uint32_t high, uint32_t length, uint32_t align);
350 void (*set_memory)(device_t dev, void *context, uint32_t base,
351 uint32_t length);
352 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
353 uint32_t high, uint32_t length, uint32_t align);
354 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
355 int count, int trig, int pol);
356 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
357 int count, int trig, int pol);
358 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
359 int count);
360 void (*set_start_dependent)(device_t dev, void *context,
361 int preference);
362 void (*set_end_dependent)(device_t dev, void *context);
363};
364
365extern struct acpi_parse_resource_set acpi_res_parse_set;
366
367void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
368ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
369 struct resource *res, ACPI_RESOURCE *acpi_res);
370ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
371 struct acpi_parse_resource_set *set, void *arg);
372
373/* ACPI event handling */
374UINT32 acpi_event_power_button_sleep(void *context);
375UINT32 acpi_event_power_button_wake(void *context);
376UINT32 acpi_event_sleep_button_sleep(void *context);
377UINT32 acpi_event_sleep_button_wake(void *context);
378
379#define ACPI_EVENT_PRI_FIRST 0
380#define ACPI_EVENT_PRI_DEFAULT 10000
381#define ACPI_EVENT_PRI_LAST 20000
382
383typedef void (*acpi_event_handler_t)(void *, int);
384
385EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
386EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
387
388/* Device power control. */
389ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
390ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
391
392/* Misc. */
393static __inline struct acpi_softc *
394acpi_device_get_parent_softc(device_t child)
395{
396 device_t parent;
397
398 parent = device_get_parent(child);
399 if (parent == NULL)
400 return (NULL);
401 return (device_get_softc(parent));
402}
403
404static __inline int
405acpi_get_verbose(struct acpi_softc *sc)
406{
407 if (sc)
408 return (sc->acpi_verbose);
409 return (0);
410}
411
412char *acpi_name(ACPI_HANDLE handle);
413int acpi_avoid(ACPI_HANDLE handle);
414int acpi_disabled(char *subsys);
415int acpi_machdep_init(device_t dev);
416void acpi_install_wakeup_handler(struct acpi_softc *sc);
417int acpi_sleep_machdep(struct acpi_softc *sc, int state);
418int acpi_table_quirks(int *quirks);
419int acpi_machdep_quirks(int *quirks);
420
421/* Battery Abstraction. */
422struct acpi_battinfo;
423
424int acpi_battery_register(device_t dev);
425int acpi_battery_remove(device_t dev);
426int acpi_battery_get_units(void);
427int acpi_battery_get_info_expire(void);
428int acpi_battery_bst_valid(struct acpi_bst *bst);
429int acpi_battery_bif_valid(struct acpi_bif *bif);
430int acpi_battery_get_battinfo(device_t dev,
431 struct acpi_battinfo *info);
432
433/* Embedded controller. */
434void acpi_ec_ecdt_probe(device_t);
| 29 */
30
31#ifndef _ACPIVAR_H_
32#define _ACPIVAR_H_
33
34#ifdef _KERNEL
35
36#include "acpi_if.h"
37#include "bus_if.h"
38#include <sys/eventhandler.h>
39#include <sys/ktr.h>
40#include <sys/lock.h>
41#include <sys/mutex.h>
42#include <sys/selinfo.h>
43#include <sys/sx.h>
44#include <sys/sysctl.h>
45
46#include <machine/bus.h>
47#include <machine/resource.h>
48
49struct apm_clone_data;
50struct acpi_softc {
51 device_t acpi_dev;
52 struct cdev *acpi_dev_t;
53
54 struct resource *acpi_irq;
55 int acpi_irq_rid;
56 void *acpi_irq_handle;
57
58 int acpi_enabled;
59 int acpi_sstate;
60 int acpi_sleep_disabled;
61
62 struct sysctl_ctx_list acpi_sysctl_ctx;
63 struct sysctl_oid *acpi_sysctl_tree;
64 int acpi_power_button_sx;
65 int acpi_sleep_button_sx;
66 int acpi_lid_switch_sx;
67
68 int acpi_standby_sx;
69 int acpi_suspend_sx;
70
71 int acpi_sleep_delay;
72 int acpi_s4bios;
73 int acpi_do_disable;
74 int acpi_verbose;
75 int acpi_handle_reboot;
76
77 bus_dma_tag_t acpi_waketag;
78 bus_dmamap_t acpi_wakemap;
79 vm_offset_t acpi_wakeaddr;
80 vm_paddr_t acpi_wakephys;
81
82 int acpi_next_sstate; /* Next suspend Sx state. */
83 struct apm_clone_data *acpi_clone; /* Pseudo-dev for devd(8). */
84 STAILQ_HEAD(,apm_clone_data) apm_cdevs; /* All apm/apmctl/acpi cdevs. */
85 struct callout susp_force_to; /* Force suspend if no acks. */
86};
87
88struct acpi_device {
89 /* ACPI ivars */
90 ACPI_HANDLE ad_handle;
91 uintptr_t ad_magic;
92 void *ad_private;
93 int ad_flags;
94
95 /* Resources */
96 struct resource_list ad_rl;
97};
98
99/* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
100struct apm_clone_data {
101 STAILQ_ENTRY(apm_clone_data) entries;
102 struct cdev *cdev;
103 int flags;
104#define ACPI_EVF_NONE 0 /* /dev/apm semantics */
105#define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
106#define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
107 int notify_status;
108#define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
109#define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
110#define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
111 struct acpi_softc *acpi_sc;
112 struct selinfo sel_read;
113};
114
115#define ACPI_PRW_MAX_POWERRES 8
116
117struct acpi_prw_data {
118 ACPI_HANDLE gpe_handle;
119 int gpe_bit;
120 int lowest_wake;
121 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
122 int power_res_count;
123};
124
125/* Flags for each device defined in the AML namespace. */
126#define ACPI_FLAG_WAKE_ENABLED 0x1
127
128/* Macros for extracting parts of a PCI address from an _ADR value. */
129#define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
130#define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
131
132/*
133 * Entry points to ACPI from above are global functions defined in this
134 * file, sysctls, and I/O on the control device. Entry points from below
135 * are interrupts (the SCI), notifies, task queue threads, and the thermal
136 * zone polling thread.
137 *
138 * ACPI tables and global shared data are protected by a global lock
139 * (acpi_mutex).
140 *
141 * Each ACPI device can have its own driver-specific mutex for protecting
142 * shared access to local data. The ACPI_LOCK macros handle mutexes.
143 *
144 * Drivers that need to serialize access to functions (e.g., to route
145 * interrupts, get/set control paths, etc.) should use the sx lock macros
146 * (ACPI_SERIAL).
147 *
148 * ACPI-CA handles its own locking and should not be called with locks held.
149 *
150 * The most complicated path is:
151 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
152 */
153extern struct mtx acpi_mutex;
154#define ACPI_LOCK(sys) mtx_lock(&sys##_mutex)
155#define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex)
156#define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED);
157#define ACPI_LOCK_DECL(sys, name) \
158 static struct mtx sys##_mutex; \
159 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
160#define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock)
161#define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock)
162#define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED);
163#define ACPI_SERIAL_DECL(sys, name) \
164 static struct sx sys##_sxlock; \
165 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
166
167/*
168 * ACPI CA does not define layers for non-ACPI CA drivers.
169 * We define some here within the range provided.
170 */
171#define ACPI_AC_ADAPTER 0x00010000
172#define ACPI_BATTERY 0x00020000
173#define ACPI_BUS 0x00040000
174#define ACPI_BUTTON 0x00080000
175#define ACPI_EC 0x00100000
176#define ACPI_FAN 0x00200000
177#define ACPI_POWERRES 0x00400000
178#define ACPI_PROCESSOR 0x00800000
179#define ACPI_THERMAL 0x01000000
180#define ACPI_TIMER 0x02000000
181#define ACPI_OEM 0x04000000
182
183/*
184 * Constants for different interrupt models used with acpi_SetIntrModel().
185 */
186#define ACPI_INTR_PIC 0
187#define ACPI_INTR_APIC 1
188#define ACPI_INTR_SAPIC 2
189
190/*
191 * Various features and capabilities for the acpi_get_features() method.
192 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
193 * See the Intel document titled "Processor Driver Capabilities Bit
194 * Definitions", number 302223-002.
195 */
196#define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
197#define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
198#define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
199#define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
200#define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
201#define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
202#define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
203#define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
204#define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
205
206/*
207 * Quirk flags.
208 *
209 * ACPI_Q_BROKEN: Disables all ACPI support.
210 * ACPI_Q_TIMER: Disables support for the ACPI timer.
211 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
212 * first APIC and that the MADT should force that by ignoring the PC-AT
213 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
214 */
215extern int acpi_quirks;
216#define ACPI_Q_OK 0
217#define ACPI_Q_BROKEN (1 << 0)
218#define ACPI_Q_TIMER (1 << 1)
219#define ACPI_Q_MADT_IRQ0 (1 << 2)
220
221/*
222 * Note that the low ivar values are reserved to provide
223 * interface compatibility with ISA drivers which can also
224 * attach to ACPI.
225 */
226#define ACPI_IVAR_HANDLE 0x100
227#define ACPI_IVAR_MAGIC 0x101
228#define ACPI_IVAR_PRIVATE 0x102
229#define ACPI_IVAR_FLAGS 0x103
230
231/*
232 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
233 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
234 */
235#define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
236 \
237static __inline type varp ## _get_ ## var(device_t dev) \
238{ \
239 uintptr_t v = 0; \
240 BUS_READ_IVAR(device_get_parent(dev), dev, \
241 ivarp ## _IVAR_ ## ivar, &v); \
242 return ((type) v); \
243} \
244 \
245static __inline void varp ## _set_ ## var(device_t dev, type t) \
246{ \
247 uintptr_t v = (uintptr_t) t; \
248 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
249 ivarp ## _IVAR_ ## ivar, v); \
250}
251
252__ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
253__ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, uintptr_t)
254__ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
255__ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
256
257void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
258static __inline device_t
259acpi_get_device(ACPI_HANDLE handle)
260{
261 void *dev = NULL;
262 AcpiGetData(handle, acpi_fake_objhandler, &dev);
263 return ((device_t)dev);
264}
265
266static __inline ACPI_OBJECT_TYPE
267acpi_get_type(device_t dev)
268{
269 ACPI_HANDLE h;
270 ACPI_OBJECT_TYPE t;
271
272 if ((h = acpi_get_handle(dev)) == NULL)
273 return (ACPI_TYPE_NOT_FOUND);
274 if (AcpiGetType(h, &t) != AE_OK)
275 return (ACPI_TYPE_NOT_FOUND);
276 return (t);
277}
278
279#ifdef ACPI_DEBUGGER
280void acpi_EnterDebugger(void);
281#endif
282
283#ifdef ACPI_DEBUG
284#include <sys/cons.h>
285#define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
286#else
287#define STEP(x)
288#endif
289
290#define ACPI_VPRINT(dev, acpi_sc, x...) do { \
291 if (acpi_get_verbose(acpi_sc)) \
292 device_printf(dev, x); \
293} while (0)
294
295/* Values for the device _STA (status) method. */
296#define ACPI_STA_PRESENT (1 << 0)
297#define ACPI_STA_ENABLED (1 << 1)
298#define ACPI_STA_SHOW_IN_UI (1 << 2)
299#define ACPI_STA_FUNCTIONAL (1 << 3)
300#define ACPI_STA_BATT_PRESENT (1 << 4)
301
302#define ACPI_DEVINFO_PRESENT(x, flags) \
303 (((x) & (flags)) == (flags))
304#define ACPI_DEVICE_PRESENT(x) \
305 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
306#define ACPI_BATTERY_PRESENT(x) \
307 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
308 ACPI_STA_BATT_PRESENT)
309
310BOOLEAN acpi_DeviceIsPresent(device_t dev);
311BOOLEAN acpi_BatteryIsPresent(device_t dev);
312ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
313 ACPI_HANDLE *result);
314uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
315ACPI_BUFFER *acpi_AllocBuffer(int size);
316ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
317 UINT32 *number);
318ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
319 UINT32 *number);
320ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
321 UINT32 number);
322ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
323 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
324ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
325 ACPI_RESOURCE **resp);
326ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
327 ACPI_RESOURCE *res);
328ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
329ACPI_STATUS acpi_SetIntrModel(int model);
330int acpi_ReqSleepState(struct acpi_softc *sc, int state);
331int acpi_AckSleepState(struct apm_clone_data *clone, int error);
332ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
333int acpi_wake_init(device_t dev, int type);
334int acpi_wake_set_enable(device_t dev, int enable);
335int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
336ACPI_STATUS acpi_Startup(void);
337void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
338 uint8_t notify);
339int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
340 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
341 u_int flags);
342
343struct acpi_parse_resource_set {
344 void (*set_init)(device_t dev, void *arg, void **context);
345 void (*set_done)(device_t dev, void *context);
346 void (*set_ioport)(device_t dev, void *context, uint32_t base,
347 uint32_t length);
348 void (*set_iorange)(device_t dev, void *context, uint32_t low,
349 uint32_t high, uint32_t length, uint32_t align);
350 void (*set_memory)(device_t dev, void *context, uint32_t base,
351 uint32_t length);
352 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
353 uint32_t high, uint32_t length, uint32_t align);
354 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
355 int count, int trig, int pol);
356 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
357 int count, int trig, int pol);
358 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
359 int count);
360 void (*set_start_dependent)(device_t dev, void *context,
361 int preference);
362 void (*set_end_dependent)(device_t dev, void *context);
363};
364
365extern struct acpi_parse_resource_set acpi_res_parse_set;
366
367void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
368ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
369 struct resource *res, ACPI_RESOURCE *acpi_res);
370ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
371 struct acpi_parse_resource_set *set, void *arg);
372
373/* ACPI event handling */
374UINT32 acpi_event_power_button_sleep(void *context);
375UINT32 acpi_event_power_button_wake(void *context);
376UINT32 acpi_event_sleep_button_sleep(void *context);
377UINT32 acpi_event_sleep_button_wake(void *context);
378
379#define ACPI_EVENT_PRI_FIRST 0
380#define ACPI_EVENT_PRI_DEFAULT 10000
381#define ACPI_EVENT_PRI_LAST 20000
382
383typedef void (*acpi_event_handler_t)(void *, int);
384
385EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
386EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
387
388/* Device power control. */
389ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
390ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
391
392/* Misc. */
393static __inline struct acpi_softc *
394acpi_device_get_parent_softc(device_t child)
395{
396 device_t parent;
397
398 parent = device_get_parent(child);
399 if (parent == NULL)
400 return (NULL);
401 return (device_get_softc(parent));
402}
403
404static __inline int
405acpi_get_verbose(struct acpi_softc *sc)
406{
407 if (sc)
408 return (sc->acpi_verbose);
409 return (0);
410}
411
412char *acpi_name(ACPI_HANDLE handle);
413int acpi_avoid(ACPI_HANDLE handle);
414int acpi_disabled(char *subsys);
415int acpi_machdep_init(device_t dev);
416void acpi_install_wakeup_handler(struct acpi_softc *sc);
417int acpi_sleep_machdep(struct acpi_softc *sc, int state);
418int acpi_table_quirks(int *quirks);
419int acpi_machdep_quirks(int *quirks);
420
421/* Battery Abstraction. */
422struct acpi_battinfo;
423
424int acpi_battery_register(device_t dev);
425int acpi_battery_remove(device_t dev);
426int acpi_battery_get_units(void);
427int acpi_battery_get_info_expire(void);
428int acpi_battery_bst_valid(struct acpi_bst *bst);
429int acpi_battery_bif_valid(struct acpi_bif *bif);
430int acpi_battery_get_battinfo(device_t dev,
431 struct acpi_battinfo *info);
432
433/* Embedded controller. */
434void acpi_ec_ecdt_probe(device_t);
|