acpi_bus_alloc_gas: Constify gas parameter
[dragonfly.git] / sys / dev / acpica5 / acpivar.h
CommitLineData
5ed44076
MD
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 *
c8b4f0e6 28 * $FreeBSD: src/sys/dev/acpica/acpivar.h,v 1.71 2004/06/13 22:52:30 njl Exp $
7d58d14b 29 * $DragonFly: src/sys/dev/acpica5/acpivar.h,v 1.16 2008/09/29 06:59:45 hasso Exp $
5ed44076
MD
30 */
31
676159d4 32#include "acpi_if.h"
5ed44076
MD
33#include "bus_if.h"
34#include <sys/eventhandler.h>
35#include <sys/sysctl.h>
36#if __FreeBSD_version >= 500000
37#include <sys/lock.h>
38#include <sys/mutex.h>
39#endif
1f7ab7c9 40#include <sys/bus.h>
5ed44076
MD
41
42struct acpi_softc {
43 device_t acpi_dev;
b13267a5 44 cdev_t acpi_dev_t;
5ed44076 45
edf6eb70 46 struct callout acpi_sleep_timer;
5ed44076
MD
47 struct resource *acpi_irq;
48 int acpi_irq_rid;
49 void *acpi_irq_handle;
50
51 int acpi_enabled;
52 int acpi_sstate;
53 int acpi_sleep_disabled;
54
55 struct sysctl_ctx_list acpi_sysctl_ctx;
56 struct sysctl_oid *acpi_sysctl_tree;
5ed44076
MD
57 int acpi_power_button_sx;
58 int acpi_sleep_button_sx;
59 int acpi_lid_switch_sx;
60
61 int acpi_standby_sx;
62 int acpi_suspend_sx;
63
64 int acpi_sleep_delay;
65 int acpi_s4bios;
66 int acpi_disable_on_poweroff;
5ed44076
MD
67 int acpi_verbose;
68
69 bus_dma_tag_t acpi_waketag;
70 bus_dmamap_t acpi_wakemap;
71 vm_offset_t acpi_wakeaddr;
72 vm_paddr_t acpi_wakephys;
73
74 struct sysctl_ctx_list acpi_battery_sysctl_ctx;
75 struct sysctl_oid *acpi_battery_sysctl_tree;
76};
77
78struct acpi_device {
79 /* ACPI ivars */
80 ACPI_HANDLE ad_handle;
81 int ad_magic;
82 void *ad_private;
83
f9d8cd12 84 /* Resources */
5ed44076 85 struct resource_list ad_rl;
49e48b8a 86};
5ed44076 87
49e48b8a
MD
88struct acpi_prw_data {
89 ACPI_HANDLE gpe_handle;
90 int gpe_bit;
91 int lowest_wake;
92 void *power_res;
5ed44076
MD
93};
94
49e48b8a
MD
95/* Flags for each device defined in the AML namespace. */
96#define ACPI_FLAG_WAKE_CAPABLE 0x1
97#define ACPI_FLAG_WAKE_ENABLED 0x2
98
5ed44076
MD
99#if defined(__DragonFly__)
100/*
1a5f156c 101 * In DragonFly, ACPI is protected by critical sections.
5ed44076 102 */
1a5f156c
SS
103# define ACPI_LOCK crit_enter()
104# define ACPI_UNLOCK crit_exit()
5ed44076
MD
105# define ACPI_ASSERTLOCK
106# define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
1a5f156c 107# define ACPI_LOCK_DECL
5ed44076
MD
108# define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
109#elif __FreeBSD_version < 500000
110/*
111 * In 4.x, ACPI is protected by splhigh().
112 */
113# define ACPI_LOCK s = splhigh()
114# define ACPI_UNLOCK splx(s)
115# define ACPI_ASSERTLOCK
116# define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e)
117# define ACPI_LOCK_DECL int s
118# define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f)
119# define tc_init(a) init_timecounter(a)
120#else
121# define ACPI_LOCK
122# define ACPI_UNLOCK
123# define ACPI_ASSERTLOCK
124# define ACPI_LOCK_DECL
125#endif
126
127/*
128 * ACPI CA does not define layers for non-ACPI CA drivers.
129 * We define some here within the range provided.
130 */
f9d8cd12
MD
131#define ACPI_AC_ADAPTER 0x00010000
132#define ACPI_BATTERY 0x00020000
133#define ACPI_BUS 0x00040000
134#define ACPI_BUTTON 0x00080000
135#define ACPI_EC 0x00100000
136#define ACPI_FAN 0x00200000
137#define ACPI_POWERRES 0x00400000
5ed44076
MD
138#define ACPI_PROCESSOR 0x00800000
139#define ACPI_THERMAL 0x01000000
f9d8cd12 140#define ACPI_TIMER 0x02000000
1abcfdcd 141#define ACPI_OEM 0x04000000
5ed44076
MD
142
143/*
144 * Constants for different interrupt models used with acpi_SetIntrModel().
145 */
146#define ACPI_INTR_PIC 0
147#define ACPI_INTR_APIC 1
148#define ACPI_INTR_SAPIC 2
149
150/*
5ebadb2c
HT
151 * Various features and capabilities for the acpi_get_features() method.
152 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
153 */
154#define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
155#define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
156#define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
157#define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
158#define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
159#define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
160#define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
161#define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
162#define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
163
164/*
5ed44076
MD
165 * Note that the low ivar values are reserved to provide
166 * interface compatibility with ISA drivers which can also
167 * attach to ACPI.
168 */
169#define ACPI_IVAR_HANDLE 0x100
170#define ACPI_IVAR_MAGIC 0x101
171#define ACPI_IVAR_PRIVATE 0x102
172
49e48b8a
MD
173/*
174 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
175 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
176 */
177#define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
178 \
179static __inline type varp ## _get_ ## var(device_t dev) \
180{ \
181 uintptr_t v = 0; \
182 BUS_READ_IVAR(device_get_parent(dev), dev, \
183 ivarp ## _IVAR_ ## ivar, &v); \
184 return ((type) v); \
185} \
186 \
187static __inline void varp ## _set_ ## var(device_t dev, type t) \
188{ \
189 uintptr_t v = (uintptr_t) t; \
190 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
191 ivarp ## _IVAR_ ## ivar, v); \
f9d8cd12
MD
192}
193
49e48b8a
MD
194__ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
195__ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
196__ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
f9d8cd12 197
c8b4f0e6
YT
198void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
199static __inline device_t
200acpi_get_device(ACPI_HANDLE handle)
201{
202 void *dev = NULL;
203 AcpiGetData(handle, acpi_fake_objhandler, &dev);
204 return ((device_t)dev);
205}
206
f9d8cd12
MD
207static __inline ACPI_OBJECT_TYPE
208acpi_get_type(device_t dev)
209{
210 ACPI_HANDLE h;
211 ACPI_OBJECT_TYPE t;
212
213 if ((h = acpi_get_handle(dev)) == NULL)
214 return (ACPI_TYPE_NOT_FOUND);
215 if (AcpiGetType(h, &t) != AE_OK)
216 return (ACPI_TYPE_NOT_FOUND);
217 return (t);
218}
5ed44076
MD
219
220#ifdef ACPI_DEBUGGER
49e48b8a 221void acpi_EnterDebugger(void);
5ed44076
MD
222#endif
223
224#ifdef ACPI_DEBUG
225#include <sys/cons.h>
e3869ec7 226#define STEP(x) do {kprintf x, kprintf("\n"); cngetc();} while (0)
5ed44076
MD
227#else
228#define STEP(x)
229#endif
230
231#define ACPI_VPRINT(dev, acpi_sc, x...) do { \
232 if (acpi_get_verbose(acpi_sc)) \
233 device_printf(dev, x); \
234} while (0)
235
236#define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9)
49e48b8a
MD
237BOOLEAN acpi_DeviceIsPresent(device_t dev);
238BOOLEAN acpi_BatteryIsPresent(device_t dev);
c8b4f0e6 239BOOLEAN acpi_MatchHid(ACPI_HANDLE h, char *hid);
49e48b8a
MD
240ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
241 ACPI_HANDLE *result);
242uint32_t acpi_TimerDelta(uint32_t end, uint32_t start);
243ACPI_BUFFER *acpi_AllocBuffer(int size);
244ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
245 UINT32 *number);
246ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
247 UINT32 *number);
248ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
249 UINT32 number);
250ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
251 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
252ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
253 ACPI_RESOURCE **resp);
254ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
255 ACPI_RESOURCE *res);
256ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
257ACPI_STATUS acpi_SetIntrModel(int model);
258ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
259int acpi_wake_init(device_t dev, int type);
260int acpi_wake_set_enable(device_t dev, int enable);
261int acpi_wake_sleep_prep(device_t dev, int sstate);
262int acpi_wake_run_prep(device_t dev);
263ACPI_STATUS acpi_Startup(void);
264ACPI_STATUS acpi_Enable(struct acpi_softc *sc);
265ACPI_STATUS acpi_Disable(struct acpi_softc *sc);
266void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
267 uint8_t notify);
268struct resource *acpi_bus_alloc_gas(device_t dev, int *rid,
1ce36465 269 const ACPI_GENERIC_ADDRESS *gas, u_int flags);
5ed44076
MD
270
271struct acpi_parse_resource_set {
f9d8cd12 272 void (*set_init)(device_t dev, void *arg, void **context);
5ed44076 273 void (*set_done)(device_t dev, void *context);
49e48b8a
MD
274 void (*set_ioport)(device_t dev, void *context, uint32_t base,
275 uint32_t length);
276 void (*set_iorange)(device_t dev, void *context, uint32_t low,
277 uint32_t high, uint32_t length, uint32_t align);
278 void (*set_memory)(device_t dev, void *context, uint32_t base,
279 uint32_t length);
280 void (*set_memoryrange)(device_t dev, void *context, uint32_t low,
281 uint32_t high, uint32_t length, uint32_t align);
e1eeedd0 282 void (*set_irq)(device_t dev, void *context, u_int8_t *irq,
49e48b8a 283 int count, int trig, int pol);
e1eeedd0
YT
284 void (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
285 int count, int trig, int pol);
286 void (*set_drq)(device_t dev, void *context, u_int8_t *drq,
49e48b8a 287 int count);
5ed44076 288 void (*set_start_dependant)(device_t dev, void *context,
49e48b8a 289 int preference);
5ed44076
MD
290 void (*set_end_dependant)(device_t dev, void *context);
291};
292
49e48b8a
MD
293extern struct acpi_parse_resource_set acpi_res_parse_set;
294ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
295 struct acpi_parse_resource_set *set, void *arg);
c8b4f0e6
YT
296extern struct rman acpi_rman_io, acpi_rman_mem;
297struct resource_list_entry *acpi_sysres_find(int type, u_long addr);
5ed44076
MD
298
299/* ACPI event handling */
49e48b8a
MD
300UINT32 acpi_event_power_button_sleep(void *context);
301UINT32 acpi_event_power_button_wake(void *context);
302UINT32 acpi_event_sleep_button_sleep(void *context);
303UINT32 acpi_event_sleep_button_wake(void *context);
5ed44076
MD
304
305#define ACPI_EVENT_PRI_FIRST 0
306#define ACPI_EVENT_PRI_DEFAULT 10000
307#define ACPI_EVENT_PRI_LAST 20000
308
309typedef void (*acpi_event_handler_t)(void *, int);
310
311EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
312EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
313
314/* Device power control. */
49e48b8a 315ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
5ed44076
MD
316
317/* Misc. */
318static __inline struct acpi_softc *
319acpi_device_get_parent_softc(device_t child)
320{
321 device_t parent;
322
323 parent = device_get_parent(child);
324 if (parent == NULL)
325 return (NULL);
326 return (device_get_softc(parent));
327}
328
329static __inline int
330acpi_get_verbose(struct acpi_softc *sc)
331{
332 if (sc)
333 return (sc->acpi_verbose);
334 return (0);
335}
336
49e48b8a
MD
337char *acpi_name(ACPI_HANDLE handle);
338int acpi_avoid(ACPI_HANDLE handle);
339int acpi_disabled(char *subsys);
2df6e324 340int acpi_enabled(char *subsys);
49e48b8a
MD
341int acpi_machdep_init(device_t dev);
342void acpi_install_wakeup_handler(struct acpi_softc *sc);
343int acpi_sleep_machdep(struct acpi_softc *sc, int state);
5ed44076
MD
344
345/* Battery Abstraction. */
346struct acpi_battinfo;
5ed44076 347
7d58d14b
HT
348int acpi_battery_register(device_t dev);
349int acpi_battery_remove(device_t dev);
49e48b8a
MD
350int acpi_battery_get_units(void);
351int acpi_battery_get_info_expire(void);
7d58d14b
HT
352int acpi_battery_bst_valid(struct acpi_bst *bst);
353int acpi_battery_bif_valid(struct acpi_bif *bif);
354int acpi_battery_get_battinfo(device_t dev,
355 struct acpi_battinfo *info);
5ed44076
MD
356
357/* Embedded controller. */
49e48b8a 358void acpi_ec_ecdt_probe(device_t);
5ed44076
MD
359
360/* AC adapter interface. */
49e48b8a 361int acpi_acad_get_acline(int *);
5ed44076
MD
362
363/* Package manipulation convenience functions. */
c3a2c0df
SZ
364#define _ACPI_PKG_VALID(pkg) \
365 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE)
366#define ACPI_PKG_VALID(pkg, size) \
367 (_ACPI_PKG_VALID((pkg)) && (pkg)->Package.Count >= (size))
368#define ACPI_PKG_VALID_EQ(pkg, size) \
369 (_ACPI_PKG_VALID((pkg)) && (pkg)->Package.Count == (size))
5ed44076
MD
370int acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
371int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
372int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
373int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *rid,
5ebadb2c 374 struct resource **dst, u_int flags);
78e2ad38
SZ
375int acpi_PkgRawGas(ACPI_OBJECT *res, int idx,
376 ACPI_GENERIC_ADDRESS *gas);
f9d8cd12 377ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
5ed44076 378
5ed44076 379/* ACPI task kernel thread initialization. */
49e48b8a 380int acpi_task_thread_init(void);