kernel/acpi: Remove the redefinition of kthread_create().
[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-005.
202  */
203 #define ACPI_PDC_PX_MSR         (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
204 #define ACPI_PDC_MP_C1_IO_HALT  (1 << 1) /* Intel C1 "IO then halt" sequence */
205 #define ACPI_PDC_TX_MSR         (1 << 2) /* Intel OnDemand throttling MSRs */
206 #define ACPI_PDC_MP_C1PXTX      (1 << 3) /* MP C1, Px, and Tx */
207 #define ACPI_PDC_MP_C2C3        (1 << 4) /* MP C2 and C3 */
208 #define ACPI_PDC_MP_PX_SWCOORD  (1 << 5) /* MP Px, using _PSD */
209 #define ACPI_PDC_MP_CX_SWCOORD  (1 << 6) /* MP Cx, using _CSD */
210 #define ACPI_PDC_MP_TX_SWCOORD  (1 << 7) /* MP Tx, using _TSD */
211 #define ACPI_PDC_MP_C1_NATIVE   (1 << 8) /* MP C1 support other than halt */
212 #define ACPI_PDC_MP_C2C3_NATIVE (1 << 9) /* MP C2 and C3 support */
213 #define ACPI_PDC_PX_HWCOORD     (1 << 11)/* Hardware coordination of Px */
214
215 /*
216  * Quirk flags.
217  *
218  * ACPI_Q_BROKEN: Disables all ACPI support.
219  * ACPI_Q_TIMER: Disables support for the ACPI timer.
220  * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
221  *      first APIC and that the MADT should force that by ignoring the PC-AT
222  *      compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
223  */
224 extern int      acpi_quirks;
225 #define ACPI_Q_OK               0
226 #define ACPI_Q_BROKEN           (1 << 0)
227 #define ACPI_Q_TIMER            (1 << 1)
228 #define ACPI_Q_MADT_IRQ0        (1 << 2)
229
230 /*
231  * Note that the low ivar values are reserved to provide
232  * interface compatibility with ISA drivers which can also
233  * attach to ACPI.
234  */
235 #define ACPI_IVAR_HANDLE        0x100
236 #define ACPI_IVAR_MAGIC         0x101
237 #define ACPI_IVAR_PRIVATE       0x102
238 #define ACPI_IVAR_FLAGS         0x103
239
240 /*
241  * Accessor functions for our ivars.  Default value for BUS_READ_IVAR is
242  * (type) 0.  The <sys/bus.h> accessor functions don't check return values.
243  */
244 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type)       \
245                                                                 \
246 static __inline type varp ## _get_ ## var(device_t dev)         \
247 {                                                               \
248     uintptr_t v = 0;                                            \
249     BUS_READ_IVAR(device_get_parent(dev), dev,                  \
250         ivarp ## _IVAR_ ## ivar, &v);                           \
251     return ((type) v);                                          \
252 }                                                               \
253                                                                 \
254 static __inline void varp ## _set_ ## var(device_t dev, type t) \
255 {                                                               \
256     uintptr_t v = (uintptr_t) t;                                \
257     BUS_WRITE_IVAR(device_get_parent(dev), dev,                 \
258         ivarp ## _IVAR_ ## ivar, v);                            \
259 }
260
261 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
262 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, uintptr_t)
263 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
264 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
265
266 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
267 static __inline device_t
268 acpi_get_device(ACPI_HANDLE handle)
269 {
270     void *dev = NULL;
271     AcpiGetData(handle, acpi_fake_objhandler, &dev);
272     return ((device_t)dev);
273 }
274
275 static __inline ACPI_OBJECT_TYPE
276 acpi_get_type(device_t dev)
277 {
278     ACPI_HANDLE         h;
279     ACPI_OBJECT_TYPE    t;
280
281     if ((h = acpi_get_handle(dev)) == NULL)
282         return (ACPI_TYPE_NOT_FOUND);
283     if (AcpiGetType(h, &t) != AE_OK)
284         return (ACPI_TYPE_NOT_FOUND);
285     return (t);
286 }
287
288 #ifdef ACPI_DEBUGGER
289 void            acpi_EnterDebugger(void);
290 #endif
291
292 #ifdef ACPI_DEBUG
293 #include <sys/cons.h>
294 #define STEP(x)         do {printf x, printf("\n"); cngetc();} while (0)
295 #else
296 #define STEP(x)
297 #endif
298
299 #define ACPI_VPRINT(dev, acpi_sc, x...) do {                    \
300     if (acpi_get_verbose(acpi_sc))                              \
301         device_printf(dev, x);                                  \
302 } while (0)
303
304 /* Values for the device _STA (status) method. */
305 #define ACPI_STA_PRESENT        (1 << 0)
306 #define ACPI_STA_ENABLED        (1 << 1)
307 #define ACPI_STA_SHOW_IN_UI     (1 << 2)
308 #define ACPI_STA_FUNCTIONAL     (1 << 3)
309 #define ACPI_STA_BATT_PRESENT   (1 << 4)
310
311 #define ACPI_DEVINFO_PRESENT(x, flags)                                  \
312         (((x) & (flags)) == (flags))
313 #define ACPI_DEVICE_PRESENT(x)                                          \
314         ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
315 #define ACPI_BATTERY_PRESENT(x)                                         \
316         ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
317             ACPI_STA_BATT_PRESENT)
318
319 BOOLEAN         acpi_DeviceIsPresent(device_t dev);
320 BOOLEAN         acpi_BatteryIsPresent(device_t dev);
321 ACPI_STATUS     acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
322                     ACPI_HANDLE *result);
323 uint32_t        acpi_TimerDelta(uint32_t end, uint32_t start);
324 ACPI_BUFFER     *acpi_AllocBuffer(int size);
325 ACPI_STATUS     acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
326                     UINT32 *number);
327 ACPI_STATUS     acpi_GetInteger(ACPI_HANDLE handle, char *path,
328                     UINT32 *number);
329 ACPI_STATUS     acpi_SetInteger(ACPI_HANDLE handle, char *path,
330                     UINT32 number);
331 ACPI_STATUS     acpi_ForeachPackageObject(ACPI_OBJECT *obj, 
332                     void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
333 ACPI_STATUS     acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
334                     ACPI_RESOURCE **resp);
335 ACPI_STATUS     acpi_AppendBufferResource(ACPI_BUFFER *buf,
336                     ACPI_RESOURCE *res);
337 ACPI_STATUS     acpi_SetIntrModel(int model);
338 int             acpi_ReqSleepState(struct acpi_softc *sc, int state);
339 int             acpi_AckSleepState(struct apm_clone_data *clone, int error);
340 ACPI_STATUS     acpi_SetSleepState(struct acpi_softc *sc, int state);
341 int             acpi_wake_set_enable(device_t dev, int enable);
342 int             acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
343 ACPI_STATUS     acpi_Startup(void);
344 void            acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
345                     uint8_t notify);
346 int             acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
347                     ACPI_GENERIC_ADDRESS *gas, struct resource **res,
348                     u_int flags);
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_ */