xref: /freebsd/sys/dev/acpica/acpivar.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
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 
29 #ifndef _ACPIVAR_H_
30 #define _ACPIVAR_H_
31 
32 #ifdef _KERNEL
33 
34 #include "acpi_if.h"
35 #include "bus_if.h"
36 #include <sys/_eventhandler.h>
37 #ifdef INTRNG
38 #include <sys/intr.h>
39 #endif
40 #include <sys/ktr.h>
41 #include <sys/lock.h>
42 #include <sys/mutex.h>
43 #include <sys/selinfo.h>
44 #include <sys/sx.h>
45 #include <sys/sysctl.h>
46 
47 #include <machine/bus.h>
48 #include <machine/resource.h>
49 
50 struct apm_clone_data;
51 struct acpi_softc {
52     device_t		acpi_dev;
53     struct cdev		*acpi_dev_t;
54 
55     int			acpi_enabled;
56     int			acpi_sstate;
57     int			acpi_sleep_disabled;
58     int			acpi_resources_reserved;
59 
60     struct sysctl_ctx_list acpi_sysctl_ctx;
61     struct sysctl_oid	*acpi_sysctl_tree;
62     int			acpi_power_button_sx;
63     int			acpi_sleep_button_sx;
64     int			acpi_lid_switch_sx;
65 
66     int			acpi_standby_sx;
67     int			acpi_suspend_sx;
68 
69     int			acpi_sleep_delay;
70     int			acpi_s4bios;
71     int			acpi_do_disable;
72     int			acpi_verbose;
73     int			acpi_handle_reboot;
74 
75     vm_offset_t		acpi_wakeaddr;
76     vm_paddr_t		acpi_wakephys;
77 
78     int			acpi_next_sstate;	/* Next suspend Sx state. */
79     struct apm_clone_data *acpi_clone;		/* Pseudo-dev for devd(8). */
80     STAILQ_HEAD(,apm_clone_data) apm_cdevs;	/* All apm/apmctl/acpi cdevs. */
81     struct callout	susp_force_to;		/* Force suspend if no acks. */
82 };
83 
84 struct acpi_device {
85     /* ACPI ivars */
86     ACPI_HANDLE			ad_handle;
87     void			*ad_private;
88     int				ad_flags;
89     int				ad_cls_class;
90 
91     ACPI_BUFFER			dsd;	/* Device Specific Data */
92     const ACPI_OBJECT	*dsd_pkg;
93 
94     /* Resources */
95     struct resource_list	ad_rl;
96 };
97 
98 #ifdef INTRNG
99 struct intr_map_data_acpi {
100 	struct intr_map_data	hdr;
101 	u_int			irq;
102 	u_int			pol;
103 	u_int			trig;
104 };
105 
106 #endif
107 
108 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
109 struct apm_clone_data {
110     STAILQ_ENTRY(apm_clone_data) entries;
111     struct cdev 	*cdev;
112     int			flags;
113 #define	ACPI_EVF_NONE	0	/* /dev/apm semantics */
114 #define	ACPI_EVF_DEVD	1	/* /dev/acpi is handled via devd(8) */
115 #define	ACPI_EVF_WRITE	2	/* Device instance is opened writable. */
116     int			notify_status;
117 #define	APM_EV_NONE	0	/* Device not yet aware of pending sleep. */
118 #define	APM_EV_NOTIFIED	1	/* Device saw next sleep state. */
119 #define	APM_EV_ACKED	2	/* Device agreed sleep can occur. */
120     struct acpi_softc	*acpi_sc;
121     struct selinfo	sel_read;
122 };
123 
124 #define ACPI_PRW_MAX_POWERRES	8
125 
126 struct acpi_prw_data {
127     ACPI_HANDLE		gpe_handle;
128     int			gpe_bit;
129     int			lowest_wake;
130     ACPI_OBJECT		power_res[ACPI_PRW_MAX_POWERRES];
131     int			power_res_count;
132 };
133 
134 /* Flags for each device defined in the AML namespace. */
135 #define ACPI_FLAG_WAKE_ENABLED	0x1
136 
137 /* Macros for extracting parts of a PCI address from an _ADR value. */
138 #define	ACPI_ADR_PCI_SLOT(adr)	(((adr) & 0xffff0000) >> 16)
139 #define	ACPI_ADR_PCI_FUNC(adr)	((adr) & 0xffff)
140 
141 /*
142  * Entry points to ACPI from above are global functions defined in this
143  * file, sysctls, and I/O on the control device.  Entry points from below
144  * are interrupts (the SCI), notifies, task queue threads, and the thermal
145  * zone polling thread.
146  *
147  * ACPI tables and global shared data are protected by a global lock
148  * (acpi_mutex).
149  *
150  * Each ACPI device can have its own driver-specific mutex for protecting
151  * shared access to local data.  The ACPI_LOCK macros handle mutexes.
152  *
153  * Drivers that need to serialize access to functions (e.g., to route
154  * interrupts, get/set control paths, etc.) should use the sx lock macros
155  * (ACPI_SERIAL).
156  *
157  * ACPI-CA handles its own locking and should not be called with locks held.
158  *
159  * The most complicated path is:
160  *     GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
161  */
162 extern struct mtx			acpi_mutex;
163 #define ACPI_LOCK(sys)			mtx_lock(&sys##_mutex)
164 #define ACPI_UNLOCK(sys)		mtx_unlock(&sys##_mutex)
165 #define ACPI_LOCK_ASSERT(sys)		mtx_assert(&sys##_mutex, MA_OWNED);
166 #define ACPI_LOCK_DECL(sys, name)				\
167 	static struct mtx sys##_mutex;				\
168 	MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
169 #define ACPI_SERIAL_BEGIN(sys)		sx_xlock(&sys##_sxlock)
170 #define ACPI_SERIAL_END(sys)		sx_xunlock(&sys##_sxlock)
171 #define ACPI_SERIAL_ASSERT(sys)		sx_assert(&sys##_sxlock, SX_XLOCKED);
172 #define ACPI_SERIAL_DECL(sys, name)				\
173 	static struct sx sys##_sxlock;				\
174 	SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
175 
176 /*
177  * ACPI CA does not define layers for non-ACPI CA drivers.
178  * We define some here within the range provided.
179  */
180 #define	ACPI_AC_ADAPTER		0x00010000
181 #define	ACPI_BATTERY		0x00020000
182 #define	ACPI_BUS		0x00040000
183 #define	ACPI_BUTTON		0x00080000
184 #define	ACPI_EC			0x00100000
185 #define	ACPI_FAN		0x00200000
186 #define	ACPI_POWERRES		0x00400000
187 #define	ACPI_PROCESSOR		0x00800000
188 #define	ACPI_THERMAL		0x01000000
189 #define	ACPI_TIMER		0x02000000
190 #define	ACPI_OEM		0x04000000
191 
192 /*
193  * Constants for different interrupt models used with acpi_SetIntrModel().
194  */
195 #define	ACPI_INTR_PIC		0
196 #define	ACPI_INTR_APIC		1
197 #define	ACPI_INTR_SAPIC		2
198 
199 /*
200  * Various features and capabilities for the acpi_get_features() method.
201  * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
202  * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
203  * number 302223-007.
204  */
205 #define	ACPI_CAP_PERF_MSRS	(1 << 0)  /* Intel SpeedStep PERF_CTL MSRs */
206 #define	ACPI_CAP_C1_IO_HALT	(1 << 1)  /* Intel C1 "IO then halt" sequence */
207 #define	ACPI_CAP_THR_MSRS	(1 << 2)  /* Intel OnDemand throttling MSRs */
208 #define	ACPI_CAP_SMP_SAME	(1 << 3)  /* MP C1, Px, and Tx (all the same) */
209 #define	ACPI_CAP_SMP_SAME_C3	(1 << 4)  /* MP C2 and C3 (all the same) */
210 #define	ACPI_CAP_SMP_DIFF_PX	(1 << 5)  /* MP Px (different, using _PSD) */
211 #define	ACPI_CAP_SMP_DIFF_CX	(1 << 6)  /* MP Cx (different, using _CSD) */
212 #define	ACPI_CAP_SMP_DIFF_TX	(1 << 7)  /* MP Tx (different, using _TSD) */
213 #define	ACPI_CAP_SMP_C1_NATIVE	(1 << 8)  /* MP C1 support other than halt */
214 #define	ACPI_CAP_SMP_C3_NATIVE	(1 << 9)  /* MP C2 and C3 support */
215 #define	ACPI_CAP_PX_HW_COORD	(1 << 11) /* Intel P-state HW coordination */
216 #define	ACPI_CAP_INTR_CPPC	(1 << 12) /* Native Interrupt Handling for
217 	     Collaborative Processor Performance Control notifications */
218 #define	ACPI_CAP_HW_DUTY_C	(1 << 13) /* Hardware Duty Cycling */
219 
220 /*
221  * Quirk flags.
222  *
223  * ACPI_Q_BROKEN: Disables all ACPI support.
224  * ACPI_Q_TIMER: Disables support for the ACPI timer.
225  * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
226  *	first APIC and that the MADT should force that by ignoring the PC-AT
227  *	compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
228  */
229 extern int	acpi_quirks;
230 #define ACPI_Q_OK		0
231 #define ACPI_Q_BROKEN		(1 << 0)
232 #define ACPI_Q_TIMER		(1 << 1)
233 #define ACPI_Q_MADT_IRQ0	(1 << 2)
234 
235 /*
236  * Plug and play information for device matching.  Matching table format
237  * is compatible with ids parameter of ACPI_ID_PROBE bus method.
238  *
239  * XXX: While ACPI_ID_PROBE matches against _HID and all _CIDs, current
240  *      acpi_pnpinfo() exports only _HID and first _CID.  That means second
241  *      and further _CIDs should be added to both acpi_pnpinfo() and
242  *      ACPICOMPAT_PNP_INFO if device matching against them is required.
243  */
244 #define	ACPICOMPAT_PNP_INFO(t, busname)					\
245 	MODULE_PNP_INFO("Z:_HID", busname, t##hid, t, nitems(t)-1);	\
246 	MODULE_PNP_INFO("Z:_CID", busname, t##cid, t, nitems(t)-1);
247 #define	ACPI_PNP_INFO(t)	ACPICOMPAT_PNP_INFO(t, acpi)
248 
249 /*
250  * Note that the low ivar values are reserved to provide
251  * interface compatibility with ISA drivers which can also
252  * attach to ACPI.
253  */
254 #define ACPI_IVAR_HANDLE	0x100
255 #define ACPI_IVAR_UNUSED	0x101	/* Unused/reserved. */
256 #define ACPI_IVAR_PRIVATE	0x102
257 #define ACPI_IVAR_FLAGS		0x103
258 
259 /*
260  * Accessor functions for our ivars.  Default value for BUS_READ_IVAR is
261  * (type) 0.  The <sys/bus.h> accessor functions don't check return values.
262  */
263 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type)	\
264 								\
265 static __inline type varp ## _get_ ## var(device_t dev)		\
266 {								\
267     uintptr_t v = 0;						\
268     BUS_READ_IVAR(device_get_parent(dev), dev,			\
269 	ivarp ## _IVAR_ ## ivar, &v);				\
270     return ((type) v);						\
271 }								\
272 								\
273 static __inline void varp ## _set_ ## var(device_t dev, type t)	\
274 {								\
275     uintptr_t v = (uintptr_t) t;				\
276     BUS_WRITE_IVAR(device_get_parent(dev), dev,			\
277 	ivarp ## _IVAR_ ## ivar, v);				\
278 }
279 
280 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
281 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
282 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
283 
284 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
285 static __inline device_t
286 acpi_get_device(ACPI_HANDLE handle)
287 {
288     void *dev = NULL;
289     AcpiGetData(handle, acpi_fake_objhandler, &dev);
290     return ((device_t)dev);
291 }
292 
293 static __inline ACPI_OBJECT_TYPE
294 acpi_get_type(device_t dev)
295 {
296     ACPI_HANDLE		h;
297     ACPI_OBJECT_TYPE	t;
298 
299     if ((h = acpi_get_handle(dev)) == NULL)
300 	return (ACPI_TYPE_NOT_FOUND);
301     if (ACPI_FAILURE(AcpiGetType(h, &t)))
302 	return (ACPI_TYPE_NOT_FOUND);
303     return (t);
304 }
305 
306 /* Find the difference between two PM tick counts. */
307 static __inline uint32_t
308 acpi_TimerDelta(uint32_t end, uint32_t start)
309 {
310 
311 	if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
312 		end |= 0x01000000;
313 	return (end - start);
314 }
315 
316 #ifdef ACPI_DEBUGGER
317 void		acpi_EnterDebugger(void);
318 #endif
319 
320 #ifdef ACPI_DEBUG
321 #include <sys/cons.h>
322 #define STEP(x)		do {printf x, printf("\n"); cngetc();} while (0)
323 #else
324 #define STEP(x)
325 #endif
326 
327 #define ACPI_VPRINT(dev, acpi_sc, x...) do {			\
328     if (acpi_get_verbose(acpi_sc))				\
329 	device_printf(dev, x);					\
330 } while (0)
331 
332 /* Values for the first status word returned by _OSC. */
333 #define	ACPI_OSC_FAILURE	(1 << 1)
334 #define	ACPI_OSC_BAD_UUID	(1 << 2)
335 #define	ACPI_OSC_BAD_REVISION	(1 << 3)
336 #define	ACPI_OSC_CAPS_MASKED	(1 << 4)
337 
338 #define ACPI_DEVINFO_PRESENT(x, flags)					\
339 	(((x) & (flags)) == (flags))
340 #define ACPI_DEVICE_PRESENT(x)						\
341 	ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT |		\
342 	    ACPI_STA_DEVICE_FUNCTIONING)
343 #define ACPI_BATTERY_PRESENT(x)						\
344 	ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT |		\
345 	    ACPI_STA_DEVICE_FUNCTIONING | ACPI_STA_BATTERY_PRESENT)
346 
347 /* Callback function type for walking subtables within a table. */
348 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *);
349 
350 BOOLEAN		acpi_DeviceIsPresent(device_t dev);
351 BOOLEAN		acpi_BatteryIsPresent(device_t dev);
352 ACPI_STATUS	acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
353 		    ACPI_HANDLE *result);
354 ACPI_STATUS	acpi_GetProperty(device_t dev, ACPI_STRING propname,
355 		    const ACPI_OBJECT **value);
356 ACPI_BUFFER	*acpi_AllocBuffer(int size);
357 ACPI_STATUS	acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
358 		    UINT32 *number);
359 ACPI_STATUS	acpi_GetInteger(ACPI_HANDLE handle, char *path,
360 		    UINT32 *number);
361 ACPI_STATUS	acpi_SetInteger(ACPI_HANDLE handle, char *path,
362 		    UINT32 number);
363 ACPI_STATUS	acpi_ForeachPackageObject(ACPI_OBJECT *obj,
364 		    void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
365 ACPI_STATUS	acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
366 		    ACPI_RESOURCE **resp);
367 ACPI_STATUS	acpi_AppendBufferResource(ACPI_BUFFER *buf,
368 		    ACPI_RESOURCE *res);
369 UINT64		acpi_DSMQuery(ACPI_HANDLE h, const uint8_t *uuid,
370 		    int revision);
371 ACPI_STATUS	acpi_EvaluateDSM(ACPI_HANDLE handle, const uint8_t *uuid,
372 		    int revision, UINT64 function, ACPI_OBJECT *package,
373 		    ACPI_BUFFER *out_buf);
374 ACPI_STATUS	acpi_EvaluateDSMTyped(ACPI_HANDLE handle,
375 		    const uint8_t *uuid, int revision, UINT64 function,
376 		    ACPI_OBJECT *package, ACPI_BUFFER *out_buf,
377 		    ACPI_OBJECT_TYPE type);
378 ACPI_STATUS	acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid,
379 		    int revision, int count, uint32_t *caps_in,
380 		    uint32_t *caps_out, bool query);
381 ACPI_STATUS	acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
382 ACPI_STATUS	acpi_SetIntrModel(int model);
383 int		acpi_ReqSleepState(struct acpi_softc *sc, int state);
384 int		acpi_AckSleepState(struct apm_clone_data *clone, int error);
385 ACPI_STATUS	acpi_SetSleepState(struct acpi_softc *sc, int state);
386 int		acpi_wake_set_enable(device_t dev, int enable);
387 int		acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
388 ACPI_STATUS	acpi_Startup(void);
389 void		acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
390 		    uint8_t notify);
391 int		acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
392 		    ACPI_GENERIC_ADDRESS *gas, struct resource **res,
393 		    u_int flags);
394 void		acpi_walk_subtables(void *first, void *end,
395 		    acpi_subtable_handler *handler, void *arg);
396 BOOLEAN		acpi_has_hid(ACPI_HANDLE handle);
397 int		acpi_MatchHid(ACPI_HANDLE h, const char *hid);
398 #define ACPI_MATCHHID_NOMATCH 0
399 #define ACPI_MATCHHID_HID 1
400 #define ACPI_MATCHHID_CID 2
401 
402 static __inline bool
403 acpi_HasProperty(device_t dev, ACPI_STRING propname)
404 {
405 
406 	return ACPI_SUCCESS(acpi_GetProperty(dev, propname, NULL));
407 }
408 
409 struct acpi_parse_resource_set {
410     void	(*set_init)(device_t dev, void *arg, void **context);
411     void	(*set_done)(device_t dev, void *context);
412     void	(*set_ioport)(device_t dev, void *context, uint64_t base,
413 		    uint64_t length);
414     void	(*set_iorange)(device_t dev, void *context, uint64_t low,
415 		    uint64_t high, uint64_t length, uint64_t align);
416     void	(*set_memory)(device_t dev, void *context, uint64_t base,
417 		    uint64_t length);
418     void	(*set_memoryrange)(device_t dev, void *context, uint64_t low,
419 		    uint64_t high, uint64_t length, uint64_t align);
420     void	(*set_irq)(device_t dev, void *context, uint8_t *irq,
421 		    int count, int trig, int pol);
422     void	(*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
423 		    int count, int trig, int pol);
424     void	(*set_drq)(device_t dev, void *context, uint8_t *drq,
425 		    int count);
426     void	(*set_start_dependent)(device_t dev, void *context,
427 		    int preference);
428     void	(*set_end_dependent)(device_t dev, void *context);
429 };
430 
431 extern struct	acpi_parse_resource_set acpi_res_parse_set;
432 
433 int		acpi_identify(void);
434 void		acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
435 #ifdef INTRNG
436 int		acpi_map_intr(device_t dev, u_int irq, ACPI_HANDLE handle);
437 #endif
438 ACPI_STATUS	acpi_lookup_irq_resource(device_t dev, int rid,
439 		    struct resource *res, ACPI_RESOURCE *acpi_res);
440 ACPI_STATUS	acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
441 		    struct acpi_parse_resource_set *set, void *arg);
442 struct resource *acpi_alloc_sysres(device_t child, int type, int *rid,
443 		    rman_res_t start, rman_res_t end, rman_res_t count,
444 		    u_int flags);
445 
446 /* ACPI event handling */
447 UINT32		acpi_event_power_button_sleep(void *context);
448 UINT32		acpi_event_power_button_wake(void *context);
449 UINT32		acpi_event_sleep_button_sleep(void *context);
450 UINT32		acpi_event_sleep_button_wake(void *context);
451 
452 #define ACPI_EVENT_PRI_FIRST      0
453 #define ACPI_EVENT_PRI_DEFAULT    10000
454 #define ACPI_EVENT_PRI_LAST       20000
455 
456 typedef void (*acpi_event_handler_t)(void *, int);
457 
458 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
459 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
460 EVENTHANDLER_DECLARE(acpi_acad_event, acpi_event_handler_t);
461 EVENTHANDLER_DECLARE(acpi_video_event, acpi_event_handler_t);
462 
463 /* Device power control. */
464 ACPI_STATUS	acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
465 ACPI_STATUS	acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
466 int		acpi_device_pwr_for_sleep(device_t bus, device_t dev,
467 		    int *dstate);
468 int		acpi_set_powerstate(device_t child, int state);
469 
470 /* APM emulation */
471 void		acpi_apm_init(struct acpi_softc *);
472 
473 /* Misc. */
474 static __inline struct acpi_softc *
475 acpi_device_get_parent_softc(device_t child)
476 {
477     device_t	parent;
478 
479     parent = device_get_parent(child);
480     if (parent == NULL)
481 	return (NULL);
482     return (device_get_softc(parent));
483 }
484 
485 static __inline int
486 acpi_get_verbose(struct acpi_softc *sc)
487 {
488     if (sc)
489 	return (sc->acpi_verbose);
490     return (0);
491 }
492 
493 char		*acpi_name(ACPI_HANDLE handle);
494 int		acpi_avoid(ACPI_HANDLE handle);
495 int		acpi_disabled(char *subsys);
496 int		acpi_get_acpi_device_path(device_t bus, device_t child,
497 		    const char *locator, struct sbuf *sb);
498 int		acpi_machdep_init(device_t dev);
499 void		acpi_install_wakeup_handler(struct acpi_softc *sc);
500 int		acpi_sleep_machdep(struct acpi_softc *sc, int state);
501 int		acpi_wakeup_machdep(struct acpi_softc *sc, int state,
502 		    int sleep_result, int intr_enabled);
503 int		acpi_table_quirks(int *quirks);
504 int		acpi_machdep_quirks(int *quirks);
505 int		acpi_pnpinfo(ACPI_HANDLE handle, struct sbuf *sb);
506 
507 uint32_t	hpet_get_uid(device_t dev);
508 
509 /* Battery Abstraction. */
510 struct acpi_battinfo;
511 
512 int		acpi_battery_register(device_t dev);
513 int		acpi_battery_remove(device_t dev);
514 int		acpi_battery_get_units(void);
515 int		acpi_battery_get_info_expire(void);
516 int		acpi_battery_bst_valid(struct acpi_bst *bst);
517 int		acpi_battery_bix_valid(struct acpi_bix *bix);
518 int		acpi_battery_get_battinfo(device_t dev,
519 		    struct acpi_battinfo *info);
520 
521 /* Embedded controller. */
522 void		acpi_ec_ecdt_probe(device_t);
523 
524 /* AC adapter interface. */
525 int		acpi_acad_get_acline(int *);
526 
527 /* Package manipulation convenience functions. */
528 #define ACPI_PKG_VALID(pkg, size)				\
529     ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE &&	\
530      (pkg)->Package.Count >= (size))
531 #define	ACPI_PKG_VALID_EQ(pkg, size)				\
532     ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE &&	\
533      (pkg)->Package.Count == (size))
534 int		acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
535 int		acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
536 int		acpi_PkgInt16(ACPI_OBJECT *res, int idx, uint16_t *dst);
537 int		acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
538 int		acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
539 		    int *rid, struct resource **dst, u_int flags);
540 int		acpi_PkgFFH_IntelCpu(ACPI_OBJECT *res, int idx, int *vendor,
541 		    int *class, uint64_t *address, int *accsize);
542 ACPI_HANDLE	acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
543 
544 /*
545  * Base level for BUS_ADD_CHILD.  Special devices are added at orders less
546  * than this, and normal devices at or above this level.  This keeps the
547  * probe order sorted so that things like sysresource are available before
548  * their children need them.
549  */
550 #define	ACPI_DEV_BASE_ORDER	100
551 
552 /* Default maximum number of tasks to enqueue. */
553 #ifndef ACPI_MAX_TASKS
554 #define	ACPI_MAX_TASKS		MAX(32, MAXCPU * 4)
555 #endif
556 
557 /* Default number of task queue threads to start. */
558 #ifndef ACPI_MAX_THREADS
559 #define ACPI_MAX_THREADS	3
560 #endif
561 
562 /* Use the device logging level for ktr(4). */
563 #define	KTR_ACPI		KTR_DEV
564 
565 SYSCTL_DECL(_debug_acpi);
566 
567 /*
568  * Parse and use proximity information in SRAT and SLIT.
569  */
570 int		acpi_pxm_init(int ncpus, vm_paddr_t maxphys);
571 void		acpi_pxm_parse_tables(void);
572 void		acpi_pxm_set_mem_locality(void);
573 void		acpi_pxm_set_cpu_locality(void);
574 int		acpi_pxm_get_cpu_locality(int apic_id);
575 
576 /*
577  * Map a PXM to a VM domain.
578  *
579  * Returns the VM domain ID if found, or -1 if not found / invalid.
580  */
581 int		acpi_map_pxm_to_vm_domainid(int pxm);
582 int		acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op,
583 		    size_t setsize, cpuset_t *cpuset);
584 int		acpi_get_domain(device_t dev, device_t child, int *domain);
585 
586 #ifdef __aarch64__
587 /*
588  * ARM specific ACPI interfaces, relating to IORT table.
589  */
590 int	acpi_iort_map_pci_msi(u_int seg, u_int rid, u_int *xref, u_int *devid);
591 int	acpi_iort_map_pci_smmuv3(u_int seg, u_int rid, u_int *xref, u_int *devid);
592 int	acpi_iort_its_lookup(u_int its_id, u_int *xref, int *pxm);
593 int	acpi_iort_map_named_msi(const char *devname, u_int rid, u_int *xref,
594 	    u_int *devid);
595 int	acpi_iort_map_named_smmuv3(const char *devname, u_int rid, u_int *xref,
596 	    u_int *devid);
597 #endif
598 #endif /* _KERNEL */
599 #endif /* !_ACPIVAR_H_ */
600