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