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