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