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 #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-unix/include/acmacros.h>
47 #include <contrib/dev/acpica-unix/include/acconfig.h>
48 #include <contrib/dev/acpica-unix/include/aclocal.h>
49 #include <contrib/dev/acpica-unix/include/acobject.h>
50 #include <contrib/dev/acpica-unix/include/acstruct.h>
51 #include <contrib/dev/acpica-unix/include/acutils.h>
52
53 struct apm_clone_data;
54 struct acpi_softc {
55 device_t acpi_dev;
56 cdev_t acpi_dev_t;
57
58 struct resource *acpi_irq;
59 int acpi_irq_rid;
60 void *acpi_irq_handle;
61
62 int acpi_enabled;
63 int acpi_sstate;
64 int acpi_sleep_disabled;
65
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;
71
72 int acpi_standby_sx;
73 int acpi_suspend_sx;
74
75 int acpi_sleep_delay;
76 int acpi_s4bios;
77 int acpi_do_disable;
78 int acpi_verbose;
79 int acpi_handle_reboot;
80
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;
85
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. */
90 };
91
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
99 /* Resources */
100 struct resource_list ad_rl;
101 };
102
103 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
104 struct apm_clone_data {
105 STAILQ_ENTRY(apm_clone_data) entries;
106 struct cdev *cdev;
107 int flags;
108 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
109 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
110 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
111 int notify_status;
112 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
113 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
114 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
115 struct acpi_softc *acpi_sc;
116 };
117
118 #define ACPI_PRW_MAX_POWERRES 8
119
120 struct acpi_prw_data {
121 ACPI_HANDLE gpe_handle;
122 int gpe_bit;
123 int lowest_wake;
124 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
125 int power_res_count;
126 };
127
128 /* Flags for each device defined in the AML namespace. */
129 #define ACPI_FLAG_WAKE_ENABLED 0x1
130
131 /* Macros for extracting parts of a PCI address from an _ADR value. */
132 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
133 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
134
135 /*
136 * Entry points to ACPI from above are global functions defined in this
137 * file, sysctls, and I/O on the control device. Entry points from below
138 * are interrupts (the SCI), notifies, task queue threads, and the thermal
139 * zone polling thread.
140 *
141 * ACPI tables and global shared data are protected by a global lock
142 * (acpi_lock).
143 *
144 * Each ACPI device can have its own driver-specific mutex for protecting
145 * shared access to local data. The ACPI_LOCK macros handle mutexes.
146 *
147 * Drivers that need to serialize access to functions (e.g., to route
148 * interrupts, get/set control paths, etc.) should use the sx lock macros
149 * (ACPI_SERIAL).
150 *
151 * ACPI-CA handles its own locking and should not be called with locks held.
152 *
153 * The most complicated path is:
154 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
155 */
156 extern struct lock acpi_lock;
157 /* acpi_thermal does lock recurs on purpose */
158 /* I bet I should use some other locks here */
159 #define ACPI_LOCK(sys) lockmgr(&sys##_lock, LK_EXCLUSIVE|LK_RETRY|LK_CANRECURSE);
160 #define ACPI_UNLOCK(sys) lockmgr(&sys##_lock, LK_RELEASE);
161 #define ACPI_LOCK_ASSERT(sys) KKASSERT(lockstatus(&sys##_lock, curthread) == LK_EXCLUSIVE);
162 #define ACPI_ASSERTLOCK ACPI_LOCK_ASSERT
163 #define ACPI_LOCK_DECL(sys, name) static struct lock sys##_lock;
164 #define ACPI_LOCK_INIT(sys, name) lockinit(&sys##_lock, name, 0, 0);
165
166 #define ACPI_SERIAL_INIT(sys) lockinit(&sys##_serial, #sys, 0, 0);
167 #define ACPI_SERIAL_BEGIN(sys) lockmgr(&sys##_serial, LK_EXCLUSIVE|LK_RETRY);
168 #define ACPI_SERIAL_END(sys) lockmgr(&sys##_serial, LK_RELEASE);
169 #define ACPI_SERIAL_ASSERT(sys) KKASSERT(lockstatus(&sys##_serial, curthread) == LK_EXCLUSIVE);
170 #define ACPI_SERIAL_DECL(sys, name) static struct lock sys##_serial;
171 /*
172 * ACPI CA does not define layers for non-ACPI CA drivers.
173 * We define some here within the range provided.
174 */
175 #define ACPI_AC_ADAPTER 0x00010000
176 #define ACPI_BATTERY 0x00020000
177 #define ACPI_BUS 0x00040000
178 #define ACPI_BUTTON 0x00080000
179 #define ACPI_EC 0x00100000
180 #define ACPI_FAN 0x00200000
181 #define ACPI_POWERRES 0x00400000
182 #define ACPI_PROCESSOR 0x00800000
183 #define ACPI_THERMAL 0x01000000
184 #define ACPI_TIMER 0x02000000
185 #define ACPI_OEM 0x04000000
186
187 /*
188 * Constants for different interrupt models used with acpi_SetIntrModel().
189 */
190 #define ACPI_INTR_PIC 0
191 #define ACPI_INTR_APIC 1
192 #define ACPI_INTR_SAPIC 2
193
194 /*
195 * Various features and capabilities for the acpi_get_features() method.
196 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
197 * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
198 * number 302223-005.
199 */
200 #define ACPI_PDC_PX_MSR (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
201 #define ACPI_PDC_MP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
202 #define ACPI_PDC_TX_MSR (1 << 2) /* Intel OnDemand throttling MSRs */
203 #define ACPI_PDC_MP_C1PXTX (1 << 3) /* MP C1, Px, and Tx */
204 #define ACPI_PDC_MP_C2C3 (1 << 4) /* MP C2 and C3 */
205 #define ACPI_PDC_MP_PX_SWCOORD (1 << 5) /* MP Px, using _PSD */
206 #define ACPI_PDC_MP_CX_SWCOORD (1 << 6) /* MP Cx, using _CSD */
207 #define ACPI_PDC_MP_TX_SWCOORD (1 << 7) /* MP Tx, using _TSD */
208 #define ACPI_PDC_MP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
209 #define ACPI_PDC_MP_C2C3_NATIVE (1 << 9) /* MP C2 and C3 support */
210 #define ACPI_PDC_PX_HWCOORD (1 << 11)/* Hardware coordination of Px */
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, 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 /* Find the difference between two PM tick counts. */
286 static __inline uint32_t
287 acpi_TimerDelta(uint32_t end, uint32_t start)
288 {
289
290 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
291 end |= 0x01000000;
292 return (end - start);
293 }
294
295 #ifdef ACPI_DEBUGGER
296 void acpi_EnterDebugger(void);
297 #endif
298
299 #ifdef ACPI_DEBUG
300 #include <sys/cons.h>
301 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
302 #else
303 #define STEP(x)
304 #endif
305
306 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
307 if (acpi_get_verbose(acpi_sc)) \
308 device_printf(dev, x); \
309 } while (0)
310
311 /* Values for the device _STA (status) method. */
312 #define ACPI_STA_PRESENT (1 << 0)
313 #define ACPI_STA_ENABLED (1 << 1)
314 #define ACPI_STA_SHOW_IN_UI (1 << 2)
315 #define ACPI_STA_FUNCTIONAL (1 << 3)
316 #define ACPI_STA_BATT_PRESENT (1 << 4)
317
318 #define ACPI_DEVINFO_PRESENT(x, flags) \
319 (((x) & (flags)) == (flags))
320 #define ACPI_DEVICE_PRESENT(x) \
321 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
322 #define ACPI_BATTERY_PRESENT(x) \
323 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
324 ACPI_STA_BATT_PRESENT)
325
326 BOOLEAN acpi_DeviceIsPresent(device_t dev);
327 BOOLEAN acpi_BatteryIsPresent(device_t dev);
328 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
329 ACPI_HANDLE *result);
330 ACPI_BUFFER *acpi_AllocBuffer(int size);
331 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
332 UINT32 *number);
333 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
334 UINT32 *number);
335 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
336 UINT32 number);
337 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
338 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
339 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
340 ACPI_RESOURCE **resp);
341 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
342 ACPI_RESOURCE *res);
343 ACPI_STATUS acpi_SetIntrModel(int model);
344 int acpi_ReqSleepState(struct acpi_softc *sc, int state);
345 int acpi_AckSleepState(struct apm_clone_data *clone, int error);
346 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
347 int acpi_wake_set_enable(device_t dev, int enable);
348 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
349 ACPI_STATUS acpi_Startup(void);
350 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
351 uint8_t notify);
352 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
353 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
354 u_int flags);
355
356 struct acpi_parse_resource_set {
357 void (*set_init)(device_t dev, void *arg, void **context);
358 void (*set_done)(device_t dev, void *context);
359 void (*set_ioport)(device_t dev, void *context, uint32_t base,
360 uint32_t length);
361 void (*set_iorange)(device_t dev, void *context, uint32_t low,
362 uint32_t high, uint32_t length, uint32_t align);
363 void (*set_memory)(device_t dev, void *context, uint32_t base,
364 uint32_t length);
365 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
366 uint32_t high, uint32_t length, uint32_t align);
367 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
368 int count, int trig, int pol);
369 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
370 int count, int trig, int pol);
371 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
372 int count);
373 void (*set_start_dependent)(device_t dev, void *context,
374 int preference);
375 void (*set_end_dependent)(device_t dev, void *context);
376 };
377
378 extern struct acpi_parse_resource_set acpi_res_parse_set;
379
380 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
381 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
382 struct resource *res, ACPI_RESOURCE *acpi_res);
383 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
384 struct acpi_parse_resource_set *set, void *arg);
385
386 /* ACPI event handling */
387 UINT32 acpi_event_power_button_sleep(void *context);
388 UINT32 acpi_event_power_button_wake(void *context);
389 UINT32 acpi_event_sleep_button_sleep(void *context);
390 UINT32 acpi_event_sleep_button_wake(void *context);
391
392 #define ACPI_EVENT_PRI_FIRST 0
393 #define ACPI_EVENT_PRI_DEFAULT 10000
394 #define ACPI_EVENT_PRI_LAST 20000
395
396 typedef void (*acpi_event_handler_t)(void *, int);
397
398 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
399 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
400
401 /* Device power control. */
402 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
403 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
404
405 /* Misc. */
406 static __inline struct acpi_softc *
407 acpi_device_get_parent_softc(device_t child)
408 {
409 device_t parent;
410
411 parent = device_get_parent(child);
412 if (parent == NULL)
413 return (NULL);
414 return (device_get_softc(parent));
415 }
416
417 static __inline int
418 acpi_get_verbose(struct acpi_softc *sc)
419 {
420 if (sc)
421 return (sc->acpi_verbose);
422 return (0);
423 }
424
425 char *acpi_name(ACPI_HANDLE handle);
426 int acpi_avoid(ACPI_HANDLE handle);
427 int acpi_disabled(char *subsys);
428 int acpi_enabled(char *subsys);
429 int acpi_machdep_init(device_t dev);
430 void acpi_install_wakeup_handler(struct acpi_softc *sc);
431 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
432 int acpi_table_quirks(int *quirks);
433 int acpi_machdep_quirks(int *quirks);
434
435 /* Battery Abstraction. */
436 struct acpi_battinfo;
437
438 int acpi_battery_register(device_t dev);
439 int acpi_battery_remove(device_t dev);
440 int acpi_battery_get_units(void);
441 int acpi_battery_get_info_expire(void);
442 int acpi_battery_bst_valid(struct acpi_bst *bst);
443 int acpi_battery_bif_valid(struct acpi_bif *bif);
444 int acpi_battery_get_battinfo(device_t dev,
445 struct acpi_battinfo *info);
446
447 /* Embedded controller. */
448 void acpi_ec_ecdt_probe(device_t);
449
450 /* AC adapter interface. */
451 int acpi_acad_get_acline(int *);
452
453 /* Package manipulation convenience functions. */
454 #define ACPI_PKG_VALID(pkg, size) \
455 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
456 (pkg)->Package.Count >= (size))
457 #define ACPI_PKG_VALID_EQ(pkg, size) \
458 (ACPI_PKG_VALID((pkg), (size)) && (pkg)->Package.Count == (size))
459 int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
460 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
461 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
462 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
463 int *rid, struct resource **dst, u_int flags);
464 int acpi_PkgRawGas(ACPI_OBJECT *res, int idx,
465 ACPI_GENERIC_ADDRESS *gas);
466 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
467 /* ACPI task kernel thread initialization. */
468 int acpi_task_thread_init(void);
469 extern BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid);
470 /*
471 * Base level for BUS_ADD_CHILD. Special devices are added at orders less
472 * than this, and normal devices at or above this level. This keeps the
473 * probe order sorted so that things like sysresource are available before
474 * their children need them.
475 */
476 #define ACPI_DEV_BASE_ORDER 10
477
478 /* Default number of task queue threads to start. */
479 #ifndef ACPI_MAX_THREADS
480 #define ACPI_MAX_THREADS 3
481 #endif
482
483 /* Use the device logging level for ktr(4). */
484 #define KTR_ACPI KTR_DEV
485
486 #endif /* _KERNEL */
487 #endif /* !_ACPIVAR_H_ */
Cache object: d7606b43487425e1d8965238adee10ad
|