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: releng/9.0/sys/dev/acpica/acpivar.h 227397 2011-11-09 18:12:42Z jhb $
29 */
30
31 #ifndef _ACPIVAR_H_
32 #define _ACPIVAR_H_
33
34 #ifdef _KERNEL
35
36 #include "acpi_if.h"
37 #include "bus_if.h"
38 #include <sys/eventhandler.h>
39 #include <sys/ktr.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/selinfo.h>
43 #include <sys/sx.h>
44 #include <sys/sysctl.h>
45
46 #include <machine/bus.h>
47 #include <machine/resource.h>
48
49 struct apm_clone_data;
50 struct acpi_softc {
51 device_t acpi_dev;
52 struct cdev *acpi_dev_t;
53
54 int acpi_enabled;
55 int acpi_sstate;
56 int acpi_sleep_disabled;
57 int acpi_resources_reserved;
58
59 struct sysctl_ctx_list acpi_sysctl_ctx;
60 struct sysctl_oid *acpi_sysctl_tree;
61 int acpi_power_button_sx;
62 int acpi_sleep_button_sx;
63 int acpi_lid_switch_sx;
64
65 int acpi_standby_sx;
66 int acpi_suspend_sx;
67
68 int acpi_sleep_delay;
69 int acpi_s4bios;
70 int acpi_do_disable;
71 int acpi_verbose;
72 int acpi_handle_reboot;
73
74 bus_dma_tag_t acpi_waketag;
75 bus_dmamap_t acpi_wakemap;
76 vm_offset_t acpi_wakeaddr;
77 vm_paddr_t acpi_wakephys;
78
79 int acpi_next_sstate; /* Next suspend Sx state. */
80 struct apm_clone_data *acpi_clone; /* Pseudo-dev for devd(8). */
81 STAILQ_HEAD(,apm_clone_data) apm_cdevs; /* All apm/apmctl/acpi cdevs. */
82 struct callout susp_force_to; /* Force suspend if no acks. */
83 };
84
85 struct acpi_device {
86 /* ACPI ivars */
87 ACPI_HANDLE ad_handle;
88 void *ad_private;
89 int ad_flags;
90
91 /* Resources */
92 struct resource_list ad_rl;
93 };
94
95 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
96 struct apm_clone_data {
97 STAILQ_ENTRY(apm_clone_data) entries;
98 struct cdev *cdev;
99 int flags;
100 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
101 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
102 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
103 int notify_status;
104 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
105 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
106 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
107 struct acpi_softc *acpi_sc;
108 struct selinfo sel_read;
109 };
110
111 #define ACPI_PRW_MAX_POWERRES 8
112
113 struct acpi_prw_data {
114 ACPI_HANDLE gpe_handle;
115 int gpe_bit;
116 int lowest_wake;
117 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
118 int power_res_count;
119 };
120
121 /* Flags for each device defined in the AML namespace. */
122 #define ACPI_FLAG_WAKE_ENABLED 0x1
123
124 /* Macros for extracting parts of a PCI address from an _ADR value. */
125 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
126 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
127
128 /*
129 * Entry points to ACPI from above are global functions defined in this
130 * file, sysctls, and I/O on the control device. Entry points from below
131 * are interrupts (the SCI), notifies, task queue threads, and the thermal
132 * zone polling thread.
133 *
134 * ACPI tables and global shared data are protected by a global lock
135 * (acpi_mutex).
136 *
137 * Each ACPI device can have its own driver-specific mutex for protecting
138 * shared access to local data. The ACPI_LOCK macros handle mutexes.
139 *
140 * Drivers that need to serialize access to functions (e.g., to route
141 * interrupts, get/set control paths, etc.) should use the sx lock macros
142 * (ACPI_SERIAL).
143 *
144 * ACPI-CA handles its own locking and should not be called with locks held.
145 *
146 * The most complicated path is:
147 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
148 */
149 extern struct mtx acpi_mutex;
150 #define ACPI_LOCK(sys) mtx_lock(&sys##_mutex)
151 #define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex)
152 #define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED);
153 #define ACPI_LOCK_DECL(sys, name) \
154 static struct mtx sys##_mutex; \
155 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
156 #define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock)
157 #define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock)
158 #define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED);
159 #define ACPI_SERIAL_DECL(sys, name) \
160 static struct sx sys##_sxlock; \
161 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
162
163 /*
164 * ACPI CA does not define layers for non-ACPI CA drivers.
165 * We define some here within the range provided.
166 */
167 #define ACPI_AC_ADAPTER 0x00010000
168 #define ACPI_BATTERY 0x00020000
169 #define ACPI_BUS 0x00040000
170 #define ACPI_BUTTON 0x00080000
171 #define ACPI_EC 0x00100000
172 #define ACPI_FAN 0x00200000
173 #define ACPI_POWERRES 0x00400000
174 #define ACPI_PROCESSOR 0x00800000
175 #define ACPI_THERMAL 0x01000000
176 #define ACPI_TIMER 0x02000000
177 #define ACPI_OEM 0x04000000
178
179 /*
180 * Constants for different interrupt models used with acpi_SetIntrModel().
181 */
182 #define ACPI_INTR_PIC 0
183 #define ACPI_INTR_APIC 1
184 #define ACPI_INTR_SAPIC 2
185
186 /*
187 * Various features and capabilities for the acpi_get_features() method.
188 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
189 * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
190 * number 302223-005.
191 */
192 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
193 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
194 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
195 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
196 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
197 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
198 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
199 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
200 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
201 #define ACPI_CAP_SMP_C3_NATIVE (1 << 9) /* MP C2 and C3 support */
202 #define ACPI_CAP_PX_HW_COORD (1 << 11) /* Intel P-state HW coordination */
203
204 /*
205 * Quirk flags.
206 *
207 * ACPI_Q_BROKEN: Disables all ACPI support.
208 * ACPI_Q_TIMER: Disables support for the ACPI timer.
209 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
210 * first APIC and that the MADT should force that by ignoring the PC-AT
211 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
212 */
213 extern int acpi_quirks;
214 #define ACPI_Q_OK 0
215 #define ACPI_Q_BROKEN (1 << 0)
216 #define ACPI_Q_TIMER (1 << 1)
217 #define ACPI_Q_MADT_IRQ0 (1 << 2)
218
219 /*
220 * Note that the low ivar values are reserved to provide
221 * interface compatibility with ISA drivers which can also
222 * attach to ACPI.
223 */
224 #define ACPI_IVAR_HANDLE 0x100
225 #define ACPI_IVAR_UNUSED 0x101 /* Unused/reserved. */
226 #define ACPI_IVAR_PRIVATE 0x102
227 #define ACPI_IVAR_FLAGS 0x103
228
229 /*
230 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
231 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
232 */
233 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
234 \
235 static __inline type varp ## _get_ ## var(device_t dev) \
236 { \
237 uintptr_t v = 0; \
238 BUS_READ_IVAR(device_get_parent(dev), dev, \
239 ivarp ## _IVAR_ ## ivar, &v); \
240 return ((type) v); \
241 } \
242 \
243 static __inline void varp ## _set_ ## var(device_t dev, type t) \
244 { \
245 uintptr_t v = (uintptr_t) t; \
246 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
247 ivarp ## _IVAR_ ## ivar, v); \
248 }
249
250 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
251 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
252 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
253
254 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
255 static __inline device_t
256 acpi_get_device(ACPI_HANDLE handle)
257 {
258 void *dev = NULL;
259 AcpiGetData(handle, acpi_fake_objhandler, &dev);
260 return ((device_t)dev);
261 }
262
263 static __inline ACPI_OBJECT_TYPE
264 acpi_get_type(device_t dev)
265 {
266 ACPI_HANDLE h;
267 ACPI_OBJECT_TYPE t;
268
269 if ((h = acpi_get_handle(dev)) == NULL)
270 return (ACPI_TYPE_NOT_FOUND);
271 if (AcpiGetType(h, &t) != AE_OK)
272 return (ACPI_TYPE_NOT_FOUND);
273 return (t);
274 }
275
276 /* Find the difference between two PM tick counts. */
277 static __inline uint32_t
278 acpi_TimerDelta(uint32_t end, uint32_t start)
279 {
280
281 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
282 end |= 0x01000000;
283 return (end - start);
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 /* Callback function type for walking subtables within a table. */
318 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *);
319
320 BOOLEAN acpi_DeviceIsPresent(device_t dev);
321 BOOLEAN acpi_BatteryIsPresent(device_t dev);
322 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
323 ACPI_HANDLE *result);
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_OverrideInterruptLevel(UINT32 InterruptNumber);
338 ACPI_STATUS acpi_SetIntrModel(int model);
339 int acpi_ReqSleepState(struct acpi_softc *sc, int state);
340 int acpi_AckSleepState(struct apm_clone_data *clone, int error);
341 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
342 void acpi_resync_clock(struct acpi_softc *sc);
343 int acpi_wake_set_enable(device_t dev, int enable);
344 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
345 ACPI_STATUS acpi_Startup(void);
346 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
347 uint8_t notify);
348 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
349 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
350 u_int flags);
351 void acpi_walk_subtables(void *first, void *end,
352 acpi_subtable_handler *handler, void *arg);
353 BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid);
354
355 struct acpi_parse_resource_set {
356 void (*set_init)(device_t dev, void *arg, void **context);
357 void (*set_done)(device_t dev, void *context);
358 void (*set_ioport)(device_t dev, void *context, uint64_t base,
359 uint64_t length);
360 void (*set_iorange)(device_t dev, void *context, uint64_t low,
361 uint64_t high, uint64_t length, uint64_t align);
362 void (*set_memory)(device_t dev, void *context, uint64_t base,
363 uint64_t length);
364 void (*set_memoryrange)(device_t dev, void *context, uint64_t low,
365 uint64_t high, uint64_t length, uint64_t align);
366 void (*set_irq)(device_t dev, void *context, uint8_t *irq,
367 int count, int trig, int pol);
368 void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
369 int count, int trig, int pol);
370 void (*set_drq)(device_t dev, void *context, uint8_t *drq,
371 int count);
372 void (*set_start_dependent)(device_t dev, void *context,
373 int preference);
374 void (*set_end_dependent)(device_t dev, void *context);
375 };
376
377 extern struct acpi_parse_resource_set acpi_res_parse_set;
378
379 int acpi_identify(void);
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 struct resource *acpi_alloc_sysres(device_t child, int type, int *rid,
386 u_long start, u_long end, u_long count, u_int flags);
387
388 /* ACPI event handling */
389 UINT32 acpi_event_power_button_sleep(void *context);
390 UINT32 acpi_event_power_button_wake(void *context);
391 UINT32 acpi_event_sleep_button_sleep(void *context);
392 UINT32 acpi_event_sleep_button_wake(void *context);
393
394 #define ACPI_EVENT_PRI_FIRST 0
395 #define ACPI_EVENT_PRI_DEFAULT 10000
396 #define ACPI_EVENT_PRI_LAST 20000
397
398 typedef void (*acpi_event_handler_t)(void *, int);
399
400 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
401 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
402
403 /* Device power control. */
404 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
405 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
406 int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
407 int *dstate);
408
409 /* APM emulation */
410 void acpi_apm_init(struct acpi_softc *);
411
412 /* Misc. */
413 static __inline struct acpi_softc *
414 acpi_device_get_parent_softc(device_t child)
415 {
416 device_t parent;
417
418 parent = device_get_parent(child);
419 if (parent == NULL)
420 return (NULL);
421 return (device_get_softc(parent));
422 }
423
424 static __inline int
425 acpi_get_verbose(struct acpi_softc *sc)
426 {
427 if (sc)
428 return (sc->acpi_verbose);
429 return (0);
430 }
431
432 char *acpi_name(ACPI_HANDLE handle);
433 int acpi_avoid(ACPI_HANDLE handle);
434 int acpi_disabled(char *subsys);
435 int acpi_machdep_init(device_t dev);
436 void acpi_install_wakeup_handler(struct acpi_softc *sc);
437 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
438 int acpi_table_quirks(int *quirks);
439 int acpi_machdep_quirks(int *quirks);
440
441 /* Battery Abstraction. */
442 struct acpi_battinfo;
443
444 int acpi_battery_register(device_t dev);
445 int acpi_battery_remove(device_t dev);
446 int acpi_battery_get_units(void);
447 int acpi_battery_get_info_expire(void);
448 int acpi_battery_bst_valid(struct acpi_bst *bst);
449 int acpi_battery_bif_valid(struct acpi_bif *bif);
450 int acpi_battery_get_battinfo(device_t dev,
451 struct acpi_battinfo *info);
452
453 /* Embedded controller. */
454 void acpi_ec_ecdt_probe(device_t);
455
456 /* AC adapter interface. */
457 int acpi_acad_get_acline(int *);
458
459 /* Package manipulation convenience functions. */
460 #define ACPI_PKG_VALID(pkg, size) \
461 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
462 (pkg)->Package.Count >= (size))
463 int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
464 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
465 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
466 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
467 int *rid, struct resource **dst, u_int flags);
468 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
469
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 maximum number of tasks to enqueue. */
479 #ifndef ACPI_MAX_TASKS
480 #define ACPI_MAX_TASKS 32
481 #endif
482
483 /* Default number of task queue threads to start. */
484 #ifndef ACPI_MAX_THREADS
485 #define ACPI_MAX_THREADS 3
486 #endif
487
488 /* Use the device logging level for ktr(4). */
489 #define KTR_ACPI KTR_DEV
490
491 #endif /* _KERNEL */
492 #endif /* !_ACPIVAR_H_ */
Cache object: 77a24c1503e2c6c5dd62489b913b786a
|