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.79.2.9 2005/07/21 08:50:26 bruno Exp $
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/sysctl.h>
40 #include <sys/lock.h>
41 #include <sys/mutex.h>
42 #include <sys/sx.h>
43
44 #include <machine/bus.h>
45 #include <machine/resource.h>
46
47 struct acpi_softc {
48 device_t acpi_dev;
49 struct cdev *acpi_dev_t;
50
51 struct resource *acpi_irq;
52 int acpi_irq_rid;
53 void *acpi_irq_handle;
54
55 int acpi_enabled;
56 int acpi_sstate;
57 int acpi_sleep_disabled;
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_disable_on_poweroff;
71 int acpi_verbose;
72
73 bus_dma_tag_t acpi_waketag;
74 bus_dmamap_t acpi_wakemap;
75 vm_offset_t acpi_wakeaddr;
76 vm_paddr_t acpi_wakephys;
77
78 struct sysctl_ctx_list acpi_battery_sysctl_ctx;
79 struct sysctl_oid *acpi_battery_sysctl_tree;
80 };
81
82 struct acpi_device {
83 /* ACPI ivars */
84 ACPI_HANDLE ad_handle;
85 int ad_magic;
86 void *ad_private;
87 int ad_flags;
88
89 /* Resources */
90 struct resource_list ad_rl;
91 };
92
93 #define ACPI_PRW_MAX_POWERRES 8
94
95 struct acpi_prw_data {
96 ACPI_HANDLE gpe_handle;
97 int gpe_bit;
98 int lowest_wake;
99 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
100 int power_res_count;
101 };
102
103 /* Flags for each device defined in the AML namespace. */
104 #define ACPI_FLAG_WAKE_ENABLED 0x1
105
106 /* Macros for extracting parts of a PCI address from an _ADR value. */
107 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
108 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
109
110 /*
111 * Entry points to ACPI from above are global functions defined in this
112 * file, sysctls, and I/O on the control device. Entry points from below
113 * are interrupts (the SCI), notifies, task queue threads, and the thermal
114 * zone polling thread.
115 *
116 * ACPI tables and global shared data are protected by a global lock
117 * (acpi_mutex).
118 *
119 * Each ACPI device can have its own driver-specific mutex for protecting
120 * shared access to local data. The ACPI_LOCK macros handle mutexes.
121 *
122 * Drivers that need to serialize access to functions (e.g., to route
123 * interrupts, get/set control paths, etc.) should use the sx lock macros
124 * (ACPI_SERIAL).
125 *
126 * ACPI-CA handles its own locking and should not be called with locks held.
127 *
128 * The most complicated path is:
129 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
130 */
131 extern struct mtx acpi_mutex;
132 #define ACPI_LOCK(sys) mtx_lock(&sys##_mutex)
133 #define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex)
134 #define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED);
135 #define ACPI_LOCK_DECL(sys, name) \
136 static struct mtx sys##_mutex; \
137 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
138 #define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock)
139 #define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock)
140 #define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED);
141 #define ACPI_SERIAL_DECL(sys, name) \
142 static struct sx sys##_sxlock; \
143 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
144
145 /*
146 * ACPI CA does not define layers for non-ACPI CA drivers.
147 * We define some here within the range provided.
148 */
149 #define ACPI_AC_ADAPTER 0x00010000
150 #define ACPI_BATTERY 0x00020000
151 #define ACPI_BUS 0x00040000
152 #define ACPI_BUTTON 0x00080000
153 #define ACPI_EC 0x00100000
154 #define ACPI_FAN 0x00200000
155 #define ACPI_POWERRES 0x00400000
156 #define ACPI_PROCESSOR 0x00800000
157 #define ACPI_THERMAL 0x01000000
158 #define ACPI_TIMER 0x02000000
159 #define ACPI_OEM 0x04000000
160
161 /*
162 * Constants for different interrupt models used with acpi_SetIntrModel().
163 */
164 #define ACPI_INTR_PIC 0
165 #define ACPI_INTR_APIC 1
166 #define ACPI_INTR_SAPIC 2
167
168 /*
169 * Various features and capabilities for the acpi_get_features() method.
170 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
171 * See the Intel document titled "Processor Driver Capabilities Bit
172 * Definitions", number 302223-002.
173 */
174 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
175 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
176 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
177 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
178 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
179 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
180 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
181 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
182 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
183
184 /*
185 * Quirk flags.
186 *
187 * ACPI_Q_BROKEN: Disables all ACPI support.
188 * ACPI_Q_TIMER: Disables support for the ACPI timer.
189 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
190 * first APIC and that the MADT should force that by ignoring the PC-AT
191 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
192 */
193 extern int acpi_quirks;
194 #define ACPI_Q_OK 0
195 #define ACPI_Q_BROKEN (1 << 0)
196 #define ACPI_Q_TIMER (1 << 1)
197 #define ACPI_Q_MADT_IRQ0 (1 << 2)
198
199 /*
200 * Note that the low ivar values are reserved to provide
201 * interface compatibility with ISA drivers which can also
202 * attach to ACPI.
203 */
204 #define ACPI_IVAR_HANDLE 0x100
205 #define ACPI_IVAR_MAGIC 0x101
206 #define ACPI_IVAR_PRIVATE 0x102
207 #define ACPI_IVAR_FLAGS 0x103
208
209 /*
210 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
211 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
212 */
213 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
214 \
215 static __inline type varp ## _get_ ## var(device_t dev) \
216 { \
217 uintptr_t v = 0; \
218 BUS_READ_IVAR(device_get_parent(dev), dev, \
219 ivarp ## _IVAR_ ## ivar, &v); \
220 return ((type) v); \
221 } \
222 \
223 static __inline void varp ## _set_ ## var(device_t dev, type t) \
224 { \
225 uintptr_t v = (uintptr_t) t; \
226 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
227 ivarp ## _IVAR_ ## ivar, v); \
228 }
229
230 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
231 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
232 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
233 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
234
235 void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
236 static __inline device_t
237 acpi_get_device(ACPI_HANDLE handle)
238 {
239 void *dev = NULL;
240 AcpiGetData(handle, acpi_fake_objhandler, &dev);
241 return ((device_t)dev);
242 }
243
244 static __inline ACPI_OBJECT_TYPE
245 acpi_get_type(device_t dev)
246 {
247 ACPI_HANDLE h;
248 ACPI_OBJECT_TYPE t;
249
250 if ((h = acpi_get_handle(dev)) == NULL)
251 return (ACPI_TYPE_NOT_FOUND);
252 if (AcpiGetType(h, &t) != AE_OK)
253 return (ACPI_TYPE_NOT_FOUND);
254 return (t);
255 }
256
257 #ifdef ACPI_DEBUGGER
258 void acpi_EnterDebugger(void);
259 #endif
260
261 #ifdef ACPI_DEBUG
262 #include <sys/cons.h>
263 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
264 #else
265 #define STEP(x)
266 #endif
267
268 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
269 if (acpi_get_verbose(acpi_sc)) \
270 device_printf(dev, x); \
271 } while (0)
272
273 /* Values for the device _STA (status) method. */
274 #define ACPI_STA_PRESENT (1 << 0)
275 #define ACPI_STA_ENABLED (1 << 1)
276 #define ACPI_STA_SHOW_IN_UI (1 << 2)
277 #define ACPI_STA_FUNCTIONAL (1 << 3)
278 #define ACPI_STA_BATT_PRESENT (1 << 4)
279
280 #define ACPI_DEVINFO_PRESENT(x, flags) \
281 (((x) & (flags)) == (flags))
282 #define ACPI_DEVICE_PRESENT(x) \
283 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
284 #define ACPI_BATTERY_PRESENT(x) \
285 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
286 ACPI_STA_BATT_PRESENT)
287
288 BOOLEAN acpi_DeviceIsPresent(device_t dev);
289 BOOLEAN acpi_BatteryIsPresent(device_t dev);
290 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
291 ACPI_HANDLE *result);
292 uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
293 ACPI_BUFFER *acpi_AllocBuffer(int size);
294 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
295 UINT32 *number);
296 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
297 UINT32 *number);
298 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
299 UINT32 number);
300 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
301 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
302 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
303 ACPI_RESOURCE **resp);
304 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
305 ACPI_RESOURCE *res);
306 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
307 ACPI_STATUS acpi_SetIntrModel(int model);
308 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
309 int acpi_wake_init(device_t dev, int type);
310 int acpi_wake_set_enable(device_t dev, int enable);
311 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
312 ACPI_STATUS acpi_Startup(void);
313 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
314 uint8_t notify);
315 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
316 ACPI_GENERIC_ADDRESS *gas, struct resource **res);
317
318 struct acpi_parse_resource_set {
319 void (*set_init)(device_t dev, void *arg, void **context);
320 void (*set_done)(device_t dev, void *context);
321 void (*set_ioport)(device_t dev, void *context, uint32_t base,
322 uint32_t length);
323 void (*set_iorange)(device_t dev, void *context, uint32_t low,
324 uint32_t high, uint32_t length, uint32_t align);
325 void (*set_memory)(device_t dev, void *context, uint32_t base,
326 uint32_t length);
327 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
328 uint32_t high, uint32_t length, uint32_t align);
329 void (*set_irq)(device_t dev, void *context, u_int32_t *irq,
330 int count, int trig, int pol);
331 void (*set_drq)(device_t dev, void *context, u_int32_t *drq,
332 int count);
333 void (*set_start_dependant)(device_t dev, void *context,
334 int preference);
335 void (*set_end_dependant)(device_t dev, void *context);
336 };
337
338 extern struct acpi_parse_resource_set acpi_res_parse_set;
339
340 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
341 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
342 struct resource *res, ACPI_RESOURCE *acpi_res);
343 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
344 struct acpi_parse_resource_set *set, void *arg);
345
346 /* ACPI event handling */
347 UINT32 acpi_event_power_button_sleep(void *context);
348 UINT32 acpi_event_power_button_wake(void *context);
349 UINT32 acpi_event_sleep_button_sleep(void *context);
350 UINT32 acpi_event_sleep_button_wake(void *context);
351
352 #define ACPI_EVENT_PRI_FIRST 0
353 #define ACPI_EVENT_PRI_DEFAULT 10000
354 #define ACPI_EVENT_PRI_LAST 20000
355
356 typedef void (*acpi_event_handler_t)(void *, int);
357
358 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
359 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
360
361 /* Device power control. */
362 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
363 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
364
365 /* Misc. */
366 static __inline struct acpi_softc *
367 acpi_device_get_parent_softc(device_t child)
368 {
369 device_t parent;
370
371 parent = device_get_parent(child);
372 if (parent == NULL)
373 return (NULL);
374 return (device_get_softc(parent));
375 }
376
377 static __inline int
378 acpi_get_verbose(struct acpi_softc *sc)
379 {
380 if (sc)
381 return (sc->acpi_verbose);
382 return (0);
383 }
384
385 char *acpi_name(ACPI_HANDLE handle);
386 int acpi_avoid(ACPI_HANDLE handle);
387 int acpi_disabled(char *subsys);
388 int acpi_machdep_init(device_t dev);
389 void acpi_install_wakeup_handler(struct acpi_softc *sc);
390 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
391 int acpi_table_quirks(int *quirks);
392 int acpi_machdep_quirks(int *quirks);
393
394 /* Battery Abstraction. */
395 struct acpi_battinfo;
396 struct acpi_battdesc;
397
398 int acpi_battery_register(int, int);
399 int acpi_battery_remove(int, int);
400 int acpi_battery_get_battinfo(int, struct acpi_battinfo *);
401 int acpi_battery_get_units(void);
402 int acpi_battery_get_info_expire(void);
403 int acpi_battery_get_battdesc(int, struct acpi_battdesc *);
404
405 int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *);
406
407 /* Embedded controller. */
408 void acpi_ec_ecdt_probe(device_t);
409
410 /* AC adapter interface. */
411 int acpi_acad_get_acline(int *);
412
413 /* Package manipulation convenience functions. */
414 #define ACPI_PKG_VALID(pkg, size) \
415 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
416 (pkg)->Package.Count >= (size))
417 int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
418 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
419 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
420 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
421 int *rid, struct resource **dst);
422 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
423
424 /* Default number of task queue threads to start. */
425 #define ACPI_MAX_THREADS 3
426
427 /* ACPI task kernel thread initialization. */
428 int acpi_task_thread_init(void);
429
430 #endif /* _KERNEL */
431 #endif /* !_ACPIVAR_H_ */
Cache object: 7dff6ef1447d18ae6078203aaf90488a
|