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