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