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