Sync ACPICA with Intel's version 20190215.
[dragonfly.git] / sys / dev / acpica / acpivar.h
blob27a7ebf5bc1da98aae97d33f170a8688b91dce3f
1 /*-
2 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
3 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4 * Copyright (c) 2000 BSDi
5 * All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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
26 * SUCH DAMAGE.
28 * $FreeBSD: src/sys/dev/acpica/acpivar.h,v 1.108.8.1 2009/04/15 03:14:26 kensmith Exp $
31 #ifndef _ACPIVAR_H_
32 #define _ACPIVAR_H_
34 #ifdef _KERNEL
37 #include "acpi_if.h"
38 #include "bus_if.h"
39 #include <sys/eventhandler.h>
40 #include <sys/sysctl.h>
41 #include <sys/lock.h>
42 #include <sys/bus.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;
54 struct acpi_softc {
55 device_t acpi_dev;
56 cdev_t acpi_dev_t;
58 struct resource *acpi_irq;
59 int acpi_irq_rid;
60 void *acpi_irq_handle;
62 int acpi_enabled;
63 int acpi_sstate;
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;
72 int acpi_standby_sx;
73 int acpi_suspend_sx;
75 int acpi_sleep_delay;
76 int acpi_s4bios;
77 int acpi_do_disable;
78 int acpi_verbose;
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. */
92 struct acpi_device {
93 /* ACPI ivars */
94 ACPI_HANDLE ad_handle;
95 uintptr_t ad_magic;
96 void *ad_private;
97 int ad_flags;
98 int ad_recheck; /* Should re-check presence. */
100 /* Resources */
101 struct resource_list ad_rl;
104 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
105 struct apm_clone_data {
106 STAILQ_ENTRY(apm_clone_data) entries;
107 struct cdev *cdev;
108 int flags;
109 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
110 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
111 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
112 int notify_status;
113 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
114 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
115 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
116 struct acpi_softc *acpi_sc;
119 #define ACPI_PRW_MAX_POWERRES 8
121 struct acpi_prw_data {
122 ACPI_HANDLE gpe_handle;
123 int gpe_bit;
124 int lowest_wake;
125 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
126 int power_res_count;
129 /* Flags for each device defined in the AML namespace. */
130 #define ACPI_FLAG_WAKE_ENABLED 0x1
132 /* Macros for extracting parts of a PCI address from an _ADR value. */
133 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
134 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
137 * Entry points to ACPI from above are global functions defined in this
138 * file, sysctls, and I/O on the control device. Entry points from below
139 * are interrupts (the SCI), notifies, task queue threads, and the thermal
140 * zone polling thread.
142 * ACPI tables and global shared data are protected by a global lock
143 * (acpi_lock).
145 * Each ACPI device can have its own driver-specific mutex for protecting
146 * shared access to local data. The ACPI_LOCK macros handle mutexes.
148 * Drivers that need to serialize access to functions (e.g., to route
149 * interrupts, get/set control paths, etc.) should use the sx lock macros
150 * (ACPI_SERIAL).
152 * ACPICA handles its own locking and should not be called with locks held.
154 * The most complicated path is:
155 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
157 extern struct lock acpi_lock;
158 extern struct lwkt_token acpi_token;
159 /* acpi_thermal does lock recurs on purpose */
160 /* I bet I should use some other locks here */
161 #define ACPI_LOCK(sys) lockmgr(&sys##_lock, LK_EXCLUSIVE|LK_RETRY|LK_CANRECURSE)
162 #define ACPI_UNLOCK(sys) lockmgr(&sys##_lock, LK_RELEASE)
163 #define ACPI_LOCK_ASSERT(sys) KKASSERT(lockstatus(&sys##_lock, curthread) == LK_EXCLUSIVE)
164 #define ACPI_ASSERTLOCK ACPI_LOCK_ASSERT
165 #define ACPI_LOCK_DECL(sys, name) static struct lock sys##_lock
166 #define ACPI_LOCK_INIT(sys, name) lockinit(&sys##_lock, name, 0, 0)
168 #define ACPI_SERIAL_INIT(sys) lockinit(&sys##_serial, #sys, 0, 0)
169 #define ACPI_SERIAL_BEGIN(sys) lockmgr(&sys##_serial, LK_EXCLUSIVE|LK_RETRY)
170 #define ACPI_SERIAL_END(sys) lockmgr(&sys##_serial, LK_RELEASE)
171 #define ACPI_SERIAL_ASSERT(sys) KKASSERT(lockstatus(&sys##_serial, curthread) == LK_EXCLUSIVE)
172 #define ACPI_SERIAL_DECL(sys, name) static struct lock sys##_serial
175 * ACPICA does not define layers for non-ACPICA drivers.
176 * We define some here within the range provided.
178 #define ACPI_AC_ADAPTER 0x00010000
179 #define ACPI_BATTERY 0x00020000
180 #define ACPI_BUS 0x00040000
181 #define ACPI_BUTTON 0x00080000
182 #define ACPI_EC 0x00100000
183 #define ACPI_FAN 0x00200000
184 #define ACPI_POWERRES 0x00400000
185 #define ACPI_PROCESSOR 0x00800000
186 #define ACPI_THERMAL 0x01000000
187 #define ACPI_TIMER 0x02000000
188 #define ACPI_OEM 0x04000000
191 * Constants for different interrupt models used with acpi_SetIntrModel().
193 #define ACPI_INTR_PIC 0
194 #define ACPI_INTR_APIC 1
195 #define ACPI_INTR_SAPIC 2
198 * Various features and capabilities for the acpi_eval_osc() method.
200 #define ACPI_OSC_QUERY_SUPPORT (1 << 0) /* Query Support Flag */
202 #define ACPI_OSC_ERRMASK 0x0000001e
203 #define ACPI_OSCERR_FAILURE (1 << 1) /* _OSC failure */
204 #define ACPI_OSCERR_BADUUID (1 << 2) /* Unrecognized UUID */
205 #define ACPI_OSCERR_BADREV (1 << 3) /* Unrecognized revision ID */
206 #define ACPI_OSCERR_CAPSMASKED (1 << 4) /* Capabilities have been cleared */
209 * Intel CPU _OSC capabilities, see "Intel Processor Vendor-Specific ACPI",
210 * number 302223-007.
212 #define ACPI_PDC_PX_MSR (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
213 #define ACPI_PDC_MP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
214 #define ACPI_PDC_TX_MSR (1 << 2) /* Intel OnDemand throttling MSRs */
215 #define ACPI_PDC_MP_C1PXTX (1 << 3) /* MP C1, Px, and Tx */
216 #define ACPI_PDC_MP_C2C3 (1 << 4) /* MP C2 and C3 */
217 #define ACPI_PDC_MP_PX_SWCOORD (1 << 5) /* MP Px, using _PSD */
218 #define ACPI_PDC_MP_CX_SWCOORD (1 << 6) /* MP Cx, using _CSD */
219 #define ACPI_PDC_MP_TX_SWCOORD (1 << 7) /* MP Tx, using _TSD */
220 #define ACPI_PDC_MP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
221 #define ACPI_PDC_MP_C2C3_NATIVE (1 << 9) /* MP C2 and C3 support */
222 #define ACPI_PDC_PX_HWCOORD (1 << 11)/* Hardware coordination of Px */
225 * Quirk flags.
227 * ACPI_Q_BROKEN: Disables all ACPI support.
228 * ACPI_Q_TIMER: Disables support for the ACPI timer.
229 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
230 * first APIC and that the MADT should force that by ignoring the PC-AT
231 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
232 * ACPI_Q_BATT_RATE_ABS: Specifies that the DSDT reports a negative 16-bit
233 * value for charging/discharging current and/or 0 as 65536.
235 extern int acpi_quirks;
236 #define ACPI_Q_OK 0
237 #define ACPI_Q_BROKEN (1 << 0)
238 #define ACPI_Q_TIMER (1 << 1)
239 #define ACPI_Q_MADT_IRQ0 (1 << 2)
240 #define ACPI_Q_BATT_RATE_ABS (1 << 3)
243 * Note that the low ivar values are reserved to provide
244 * interface compatibility with ISA drivers which can also
245 * attach to ACPI.
247 #define ACPI_IVAR_HANDLE 0x100
248 #define ACPI_IVAR_MAGIC 0x101
249 #define ACPI_IVAR_PRIVATE 0x102
250 #define ACPI_IVAR_FLAGS 0x103
251 #define ACPI_IVAR_RECHECK 0x104
254 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
255 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
257 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
259 static __inline type varp ## _get_ ## var(device_t dev) \
261 uintptr_t v = 0; \
262 BUS_READ_IVAR(device_get_parent(dev), dev, \
263 ivarp ## _IVAR_ ## ivar, &v); \
264 return ((type) v); \
267 static __inline void varp ## _set_ ## var(device_t dev, type t) \
269 uintptr_t v = (uintptr_t) t; \
270 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
271 ivarp ## _IVAR_ ## ivar, v); \
274 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
275 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, uintptr_t)
276 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
277 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
278 __ACPI_BUS_ACCESSOR(acpi, recheck, ACPI, RECHECK, int)
280 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
281 static __inline device_t
282 acpi_get_device(ACPI_HANDLE handle)
284 void *dev = NULL;
285 AcpiGetData(handle, acpi_fake_objhandler, &dev);
286 return ((device_t)dev);
289 static __inline ACPI_OBJECT_TYPE
290 acpi_get_type(device_t dev)
292 ACPI_HANDLE h;
293 ACPI_OBJECT_TYPE t;
295 if ((h = acpi_get_handle(dev)) == NULL)
296 return (ACPI_TYPE_NOT_FOUND);
297 if (ACPI_FAILURE(AcpiGetType(h, &t)))
298 return (ACPI_TYPE_NOT_FOUND);
299 return (t);
302 /* Find the difference between two PM tick counts. */
303 static __inline uint32_t
304 acpi_TimerDelta(uint32_t end, uint32_t start)
307 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
308 end |= 0x01000000;
309 return (end - start);
312 #ifdef ACPI_DEBUG
313 #include <sys/cons.h>
314 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
315 #else
316 #define STEP(x)
317 #endif
319 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
320 if (acpi_get_verbose(acpi_sc)) \
321 device_printf(dev, x); \
322 } while (0)
324 /* Values for the device _STA (status) method. */
325 #define ACPI_STA_PRESENT (1 << 0)
326 #define ACPI_STA_ENABLED (1 << 1)
327 #define ACPI_STA_SHOW_IN_UI (1 << 2)
328 #define ACPI_STA_FUNCTIONAL (1 << 3)
329 #define ACPI_STA_BATT_PRESENT (1 << 4)
331 #define ACPI_DEVINFO_PRESENT(x, flags) \
332 (((x) & (flags)) == (flags))
333 #define ACPI_DEVICE_PRESENT(x) \
334 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
335 #define ACPI_BATTERY_PRESENT(x) \
336 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
337 ACPI_STA_BATT_PRESENT)
339 BOOLEAN acpi_DeviceIsPresent(device_t dev);
340 BOOLEAN acpi_BatteryIsPresent(device_t dev);
341 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
342 ACPI_HANDLE *result);
343 ACPI_BUFFER *acpi_AllocBuffer(int size);
344 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
345 UINT32 *number);
346 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
347 UINT32 *number);
348 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
349 UINT32 number);
350 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
351 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
352 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
353 ACPI_RESOURCE **resp);
354 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
355 ACPI_RESOURCE *res);
356 ACPI_STATUS acpi_SetIntrModel(int model);
357 int acpi_ReqSleepState(struct acpi_softc *sc, int state);
358 int acpi_AckSleepState(struct apm_clone_data *clone, int error);
359 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
360 int acpi_wake_set_enable(device_t dev, int enable);
361 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
362 ACPI_STATUS acpi_Startup(void);
363 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
364 uint8_t notify);
365 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
366 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
367 u_int flags);
368 ACPI_STATUS acpi_eval_osc(device_t dev, ACPI_HANDLE handle,
369 const char *uuidstr, int revision, uint32_t *buf,
370 int count);
372 struct acpi_parse_resource_set {
373 void (*set_init)(device_t dev, void *arg, void **context);
374 void (*set_done)(device_t dev, void *context);
375 void (*set_ioport)(device_t dev, void *context, uint64_t base,
376 uint64_t length);
377 void (*set_iorange)(device_t dev, void *context, uint64_t low,
378 uint64_t high, uint64_t length, uint64_t align);
379 void (*set_memory)(device_t dev, void *context, uint64_t base,
380 uint64_t length);
381 void (*set_memoryrange)(device_t dev, void *context, uint64_t low,
382 uint64_t high, uint64_t length, uint64_t align);
383 void (*set_irq)(device_t dev, void *context, uint8_t *irq,
384 int count, int trig, int pol);
385 void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
386 int count, int trig, int pol);
387 void (*set_drq)(device_t dev, void *context, uint8_t *drq,
388 int count);
389 void (*set_start_dependent)(device_t dev, void *context,
390 int preference);
391 void (*set_end_dependent)(device_t dev, void *context);
394 extern struct acpi_parse_resource_set acpi_res_parse_set;
396 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
397 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
398 struct resource *res, ACPI_RESOURCE *acpi_res);
399 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
400 struct acpi_parse_resource_set *set, void *arg);
402 /* ACPI event handling */
403 UINT32 acpi_event_power_button_sleep(void *context);
404 UINT32 acpi_event_power_button_wake(void *context);
405 UINT32 acpi_event_sleep_button_sleep(void *context);
406 UINT32 acpi_event_sleep_button_wake(void *context);
408 #define ACPI_EVENT_PRI_FIRST 0
409 #define ACPI_EVENT_PRI_DEFAULT 10000
410 #define ACPI_EVENT_PRI_LAST 20000
412 typedef void (*acpi_event_handler_t)(void *, int);
414 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
415 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
417 /* Device power control. */
418 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
419 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
421 /* Misc. */
422 static __inline struct acpi_softc *
423 acpi_device_get_parent_softc(device_t child)
425 device_t parent;
427 parent = device_get_parent(child);
428 if (parent == NULL)
429 return (NULL);
430 return (device_get_softc(parent));
433 static __inline int
434 acpi_get_verbose(struct acpi_softc *sc)
436 if (sc)
437 return (sc->acpi_verbose);
438 return (0);
441 char *acpi_name(ACPI_HANDLE handle);
442 int acpi_avoid(ACPI_HANDLE handle);
443 int acpi_disabled(char *subsys);
444 int acpi_enabled(char *subsys);
445 int acpi_machdep_init(device_t dev);
446 void acpi_install_wakeup_handler(struct acpi_softc *sc);
447 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
448 int acpi_table_quirks(int *quirks);
449 int acpi_machdep_quirks(int *quirks);
451 /* Battery Abstraction. */
452 struct acpi_battinfo;
454 int acpi_battery_register(device_t dev);
455 int acpi_battery_remove(device_t dev);
456 int acpi_battery_get_units(void);
457 int acpi_battery_get_info_expire(void);
458 int acpi_battery_bst_valid(struct acpi_bst *bst);
459 int acpi_battery_bif_valid(struct acpi_bif *bif);
460 int acpi_battery_get_battinfo(device_t dev,
461 struct acpi_battinfo *info);
463 /* Embedded controller. */
464 void acpi_ec_ecdt_probe(device_t);
466 /* AC adapter interface. */
467 int acpi_acad_get_acline(int *);
469 /* Package manipulation convenience functions. */
470 #define ACPI_PKG_VALID(pkg, size) \
471 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
472 (pkg)->Package.Count >= (size))
473 #define ACPI_PKG_VALID_EQ(pkg, size) \
474 (ACPI_PKG_VALID((pkg), (size)) && (pkg)->Package.Count == (size))
475 int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
476 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
477 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
478 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
479 int *rid, struct resource **dst, u_int flags);
480 int acpi_PkgRawGas(ACPI_OBJECT *res, int idx,
481 ACPI_GENERIC_ADDRESS *gas);
482 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
483 /* ACPI task kernel thread initialization. */
484 int acpi_task_thread_init(void);
485 void acpi_task_thread_schedule(void);
486 extern BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid);
487 extern BOOLEAN acpi_MatchUid(ACPI_HANDLE h, const char *uid);
489 * Base level for BUS_ADD_CHILD. Special devices are added at orders less
490 * than this, and normal devices at or above this level. This keeps the
491 * probe order sorted so that things like sysresource are available before
492 * their children need them.
494 #define ACPI_DEV_BASE_ORDER 10
496 /* Default number of task queue threads to start. */
497 #ifndef ACPI_MAX_THREADS
498 #define ACPI_MAX_THREADS 3
499 #endif
501 SYSCTL_DECL(_debug_acpi);
503 #endif /* _KERNEL */
504 #endif /* !_ACPIVAR_H_ */