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
60 struct sysctl_ctx_list acpi_sysctl_ctx;
61 struct sysctl_oid *acpi_sysctl_tree;
62 enum power_stype acpi_power_button_stype;
63 enum power_stype acpi_sleep_button_stype;
64 enum power_stype acpi_lid_switch_stype;
65
66 int acpi_standby_sx;
67 bool acpi_s4bios;
68 bool acpi_s4bios_supported;
69
70 int acpi_sleep_delay;
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 enum power_stype acpi_next_stype; /* Next suspend sleep type. */
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 #define ACPI_SPMC 0x08000000
196
197 /*
198 * Constants for different interrupt models used with acpi_SetIntrModel().
199 */
200 #define ACPI_INTR_PIC 0
201 #define ACPI_INTR_APIC 1
202 #define ACPI_INTR_SAPIC 2
203
204 /*
205 * Various features and capabilities for the acpi_get_features() method.
206 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
207 * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
208 * number 302223-007.
209 */
210 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
211 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
212 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
213 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
214 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
215 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
216 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
217 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
218 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
219 #define ACPI_CAP_SMP_C3_NATIVE (1 << 9) /* MP C2 and C3 support */
220 #define ACPI_CAP_PX_HW_COORD (1 << 11) /* Intel P-state HW coordination */
221 #define ACPI_CAP_INTR_CPPC (1 << 12) /* Native Interrupt Handling for
222 Collaborative Processor Performance Control notifications */
223 #define ACPI_CAP_HW_DUTY_C (1 << 13) /* Hardware Duty Cycling */
224
225 /*
226 * Quirk flags.
227 *
228 * ACPI_Q_BROKEN: Disables all ACPI support.
229 * ACPI_Q_TIMER: Disables support for the ACPI timer.
230 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
231 * first APIC and that the MADT should force that by ignoring the PC-AT
232 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
233 * ACPI_Q_AEI_NOPULL: Specifies that _AEI objects incorrectly designate pins
234 * as "PullUp" and they should be treated as "NoPull" instead.
235 * ACPI_Q_CLEAR_PME_ON_DETACH: Specifies that PCIM_PSTAT_(PME & ~PMEENABLE)
236 * should be written to the power status register as part of ACPI Eject.
237 * ACPI_Q_DELAY_BEFORE_EJECT_RESCAN: Specifies that we need a short (10ms)
238 * delay after _EJ0 returns before rescanning the PCI bus.
239 */
240 extern int acpi_quirks;
241 #define ACPI_Q_OK 0
242 #define ACPI_Q_BROKEN (1 << 0)
243 #define ACPI_Q_TIMER (1 << 1)
244 #define ACPI_Q_MADT_IRQ0 (1 << 2)
245 #define ACPI_Q_AEI_NOPULL (1 << 3)
246 #define ACPI_Q_CLEAR_PME_ON_DETACH (1 << 4)
247 #define ACPI_Q_DELAY_BEFORE_EJECT_RESCAN (1 << 5)
248
249 #if defined(__amd64__) || defined(__i386__)
250 /*
251 * Certain Intel BIOSes have buggy AML that specify an IRQ that is
252 * edge-sensitive and active-lo. Normally, edge-sensitive IRQs should
253 * be active-hi. If this value is non-zero, edge-sensitive ISA IRQs
254 * are forced to be active-hi instead. At least some AMD systems use
255 * active-lo edge-sensitive ISA IRQs, so this setting is only enabled
256 * by default on systems with Intel CPUs.
257 */
258 extern int acpi_override_isa_irq_polarity;
259 #endif
260
261 /*
262 * Plug and play information for device matching. Matching table format
263 * is compatible with ids parameter of ACPI_ID_PROBE bus method.
264 *
265 * XXX: While ACPI_ID_PROBE matches against _HID and all _CIDs, current
266 * acpi_pnpinfo() exports only _HID and first _CID. That means second
267 * and further _CIDs should be added to both acpi_pnpinfo() and
268 * ACPICOMPAT_PNP_INFO if device matching against them is required.
269 */
270 #define ACPICOMPAT_PNP_INFO(t, busname) \
271 MODULE_PNP_INFO("Z:_HID", busname, t##hid, t, nitems(t)-1); \
272 MODULE_PNP_INFO("Z:_CID", busname, t##cid, t, nitems(t)-1);
273 #define ACPI_PNP_INFO(t) ACPICOMPAT_PNP_INFO(t, acpi)
274
275 /*
276 * Note that the low ivar values are reserved to provide
277 * interface compatibility with ISA drivers which can also
278 * attach to ACPI.
279 */
280 enum {
281 ACPI_IVAR_PRIVATE = 20,
282 ACPI_IVAR_DOMAIN,
283 ACPI_IVAR_HANDLE = BUS_IVARS_ACPI,
284 ACPI_IVAR_FLAGS
285 };
286
287 /*
288 * ad_domain NUMA domain special value.
289 */
290 #define ACPI_DEV_DOMAIN_UNKNOWN (-1)
291
292 __BUS_ACCESSOR_DEFAULT(acpi, handle, ACPI, HANDLE, ACPI_HANDLE, NULL)
293 __BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
294 __BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
295 __BUS_ACCESSOR(acpi, domain, ACPI, DOMAIN, int)
296
297 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
298 static __inline device_t
acpi_get_device(ACPI_HANDLE handle)299 acpi_get_device(ACPI_HANDLE handle)
300 {
301 void *dev = NULL;
302 AcpiGetData(handle, acpi_fake_objhandler, &dev);
303 return ((device_t)dev);
304 }
305
306 static __inline ACPI_OBJECT_TYPE
acpi_get_type(device_t dev)307 acpi_get_type(device_t dev)
308 {
309 ACPI_HANDLE h;
310 ACPI_OBJECT_TYPE t;
311
312 if ((h = acpi_get_handle(dev)) == NULL)
313 return (ACPI_TYPE_NOT_FOUND);
314 if (ACPI_FAILURE(AcpiGetType(h, &t)))
315 return (ACPI_TYPE_NOT_FOUND);
316 return (t);
317 }
318
319 /* Find the difference between two PM tick counts. */
320 static __inline uint32_t
acpi_TimerDelta(uint32_t end,uint32_t start)321 acpi_TimerDelta(uint32_t end, uint32_t start)
322 {
323
324 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
325 end |= 0x01000000;
326 return (end - start);
327 }
328
329 #ifdef ACPI_DEBUGGER
330 void acpi_EnterDebugger(void);
331 #endif
332
333 #ifdef ACPI_DEBUG
334 #include <sys/cons.h>
335 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
336 #else
337 #define STEP(x)
338 #endif
339
340 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
341 if (acpi_get_verbose(acpi_sc)) \
342 device_printf(dev, x); \
343 } while (0)
344
345 /* Values for the first status word returned by _OSC. */
346 #define ACPI_OSC_FAILURE (1 << 1)
347 #define ACPI_OSC_BAD_UUID (1 << 2)
348 #define ACPI_OSC_BAD_REVISION (1 << 3)
349 #define ACPI_OSC_CAPS_MASKED (1 << 4)
350
351 #define ACPI_DEVINFO_PRESENT(x, flags) \
352 (((x) & (flags)) == (flags))
353 #define ACPI_DEVICE_PRESENT(x) \
354 ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT | \
355 ACPI_STA_DEVICE_FUNCTIONING)
356 #define ACPI_BATTERY_PRESENT(x) \
357 ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT | \
358 ACPI_STA_DEVICE_FUNCTIONING | ACPI_STA_BATTERY_PRESENT)
359
360 /* Callback function type for walking subtables within a table. */
361 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *);
362
363 BOOLEAN acpi_DeviceIsPresent(device_t dev);
364 BOOLEAN acpi_BatteryIsPresent(device_t dev);
365 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
366 ACPI_HANDLE *result);
367 ACPI_STATUS acpi_GetProperty(device_t dev, ACPI_STRING propname,
368 const ACPI_OBJECT **value);
369 ACPI_BUFFER *acpi_AllocBuffer(int size);
370 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
371 UINT32 *number);
372 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
373 UINT32 *number);
374 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
375 UINT32 number);
376 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
377 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
378 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
379 ACPI_RESOURCE **resp);
380 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
381 ACPI_RESOURCE *res);
382 UINT64 acpi_DSMQuery(ACPI_HANDLE h, const uint8_t *uuid,
383 int revision);
384 ACPI_STATUS acpi_EvaluateDSM(ACPI_HANDLE handle, const uint8_t *uuid,
385 int revision, UINT64 function, ACPI_OBJECT *package,
386 ACPI_BUFFER *out_buf);
387 ACPI_STATUS acpi_EvaluateDSMTyped(ACPI_HANDLE handle,
388 const uint8_t *uuid, int revision, UINT64 function,
389 ACPI_OBJECT *package, ACPI_BUFFER *out_buf,
390 ACPI_OBJECT_TYPE type);
391 ACPI_STATUS acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid,
392 int revision, int count, uint32_t *caps_in,
393 uint32_t *caps_out, bool query);
394 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
395 ACPI_STATUS acpi_SetIntrModel(int model);
396 int acpi_ReqSleepState(struct acpi_softc *sc, enum power_stype stype);
397 int acpi_AckSleepState(struct apm_clone_data *clone, int error);
398 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
399 int acpi_wake_set_enable(device_t dev, int enable);
400 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
401 ACPI_STATUS acpi_Startup(void);
402 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
403 uint8_t notify);
404 int acpi_bus_alloc_gas(device_t dev, int *type, int rid,
405 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
406 u_int flags);
407 void acpi_walk_subtables(void *first, void *end,
408 acpi_subtable_handler *handler, void *arg);
409 BOOLEAN acpi_has_hid(ACPI_HANDLE handle);
410 int acpi_MatchHid(ACPI_HANDLE h, const char *hid);
411 #define ACPI_MATCHHID_NOMATCH 0
412 #define ACPI_MATCHHID_HID 1
413 #define ACPI_MATCHHID_CID 2
414
415 static __inline bool
acpi_HasProperty(device_t dev,ACPI_STRING propname)416 acpi_HasProperty(device_t dev, ACPI_STRING propname)
417 {
418
419 return ACPI_SUCCESS(acpi_GetProperty(dev, propname, NULL));
420 }
421
422 struct acpi_parse_resource_set {
423 void (*set_init)(device_t dev, void *arg, void **context);
424 void (*set_done)(device_t dev, void *context);
425 void (*set_ioport)(device_t dev, void *context, uint64_t base,
426 uint64_t length);
427 void (*set_iorange)(device_t dev, void *context, uint64_t low,
428 uint64_t high, uint64_t length, uint64_t align);
429 void (*set_memory)(device_t dev, void *context, uint64_t base,
430 uint64_t length);
431 void (*set_memoryrange)(device_t dev, void *context, uint64_t low,
432 uint64_t high, uint64_t length, uint64_t align);
433 void (*set_irq)(device_t dev, void *context, uint8_t *irq,
434 int count, int trig, int pol);
435 void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
436 int count, int trig, int pol);
437 void (*set_drq)(device_t dev, void *context, uint8_t *drq,
438 int count);
439 void (*set_start_dependent)(device_t dev, void *context,
440 int preference);
441 void (*set_end_dependent)(device_t dev, void *context);
442 };
443
444 extern struct acpi_parse_resource_set acpi_res_parse_set;
445
446 int acpi_identify(void);
447 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
448 #ifdef INTRNG
449 int acpi_map_intr(device_t dev, u_int irq, ACPI_HANDLE handle);
450 #endif
451 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
452 struct resource *res, ACPI_RESOURCE *acpi_res);
453 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
454 struct acpi_parse_resource_set *set, void *arg);
455
456 /* ACPI event handling */
457 UINT32 acpi_event_power_button_sleep(void *context);
458 UINT32 acpi_event_power_button_wake(void *context);
459 UINT32 acpi_event_sleep_button_sleep(void *context);
460 UINT32 acpi_event_sleep_button_wake(void *context);
461
462 #define ACPI_EVENT_PRI_FIRST 0
463 #define ACPI_EVENT_PRI_DEFAULT 10000
464 #define ACPI_EVENT_PRI_LAST 20000
465
466 typedef void (*acpi_event_handler_t)(void *, enum power_stype);
467
468 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
469 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
470 EVENTHANDLER_DECLARE(acpi_acad_event, acpi_event_handler_t);
471 EVENTHANDLER_DECLARE(acpi_video_event, acpi_event_handler_t);
472 EVENTHANDLER_DECLARE(acpi_post_dev_suspend, acpi_event_handler_t);
473 EVENTHANDLER_DECLARE(acpi_pre_dev_resume, acpi_event_handler_t);
474
475 /* Device power control. */
476 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
477 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
478 acpi_pwr_for_sleep_t acpi_device_pwr_for_sleep;
479 int acpi_set_powerstate(device_t child, int state);
480
481 /* APM emulation */
482 void acpi_apm_init(struct acpi_softc *);
483
484 /* Misc. */
485 static __inline struct acpi_softc *
acpi_device_get_parent_softc(device_t child)486 acpi_device_get_parent_softc(device_t child)
487 {
488 device_t parent;
489
490 parent = device_get_parent(child);
491 if (parent == NULL)
492 return (NULL);
493 return (device_get_softc(parent));
494 }
495
496 static __inline int
acpi_get_verbose(struct acpi_softc * sc)497 acpi_get_verbose(struct acpi_softc *sc)
498 {
499 if (sc)
500 return (sc->acpi_verbose);
501 return (0);
502 }
503
504 static __inline const char *
acpi_d_state_to_str(int state)505 acpi_d_state_to_str(int state)
506 {
507 const char *strs[ACPI_D_STATE_COUNT] = {"D0", "D1", "D2", "D3hot",
508 "D3cold"};
509
510 MPASS(state >= ACPI_STATE_D0 && state <= ACPI_D_STATES_MAX);
511 return (strs[state]);
512 }
513
514 static __inline bool
acpi_should_do_s4bios(struct acpi_softc * sc)515 acpi_should_do_s4bios(struct acpi_softc *sc)
516 {
517 MPASS(!sc->acpi_s4bios || sc->acpi_s4bios_supported);
518 return (sc->acpi_s4bios);
519 }
520
521 char *acpi_name(ACPI_HANDLE handle);
522 int acpi_avoid(ACPI_HANDLE handle);
523 int acpi_disabled(char *subsys);
524 int acpi_get_acpi_device_path(device_t bus, device_t child,
525 const char *locator, struct sbuf *sb);
526 int acpi_machdep_init(device_t dev);
527 void acpi_install_wakeup_handler(struct acpi_softc *sc);
528 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
529 int acpi_wakeup_machdep(struct acpi_softc *sc, int state,
530 int sleep_result, int intr_enabled);
531 int acpi_table_quirks(int *quirks);
532 int acpi_machdep_quirks(int *quirks);
533 int acpi_pnpinfo(ACPI_HANDLE handle, struct sbuf *sb);
534
535 uint32_t hpet_get_uid(device_t dev);
536
537 /* Battery Abstraction. */
538 struct acpi_battinfo;
539
540 int acpi_battery_register(device_t dev);
541 int acpi_battery_remove(device_t dev);
542 int acpi_battery_get_units(void);
543 int acpi_battery_get_info_expire(void);
544 int acpi_battery_bst_valid(struct acpi_bst *bst);
545 int acpi_battery_bix_valid(struct acpi_bix *bix);
546 int acpi_battery_get_battinfo(device_t dev,
547 struct acpi_battinfo *info);
548
549 /* Embedded controller. */
550 void acpi_ec_ecdt_probe(device_t);
551
552 /* AC adapter interface. */
553 int acpi_acad_get_acline(int *);
554
555 /* Package manipulation convenience functions. */
556 #define ACPI_PKG_VALID(pkg, size) \
557 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
558 (pkg)->Package.Count >= (size))
559 #define ACPI_PKG_VALID_EQ(pkg, size) \
560 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
561 (pkg)->Package.Count == (size))
562 int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
563 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
564 int acpi_PkgInt16(ACPI_OBJECT *res, int idx, uint16_t *dst);
565 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
566 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
567 int rid, struct resource **dst, u_int flags);
568 int acpi_PkgFFH_IntelCpu(ACPI_OBJECT *res, int idx, int *vendor,
569 int *class, uint64_t *address, int *accsize);
570 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
571
572 /*
573 * Base level for BUS_ADD_CHILD. Special devices are added at orders less
574 * than this, and normal devices at or above this level. This keeps the
575 * probe order sorted so that things like sysresource are available before
576 * their children need them.
577 */
578 #define ACPI_DEV_BASE_ORDER 100
579
580 /* Default maximum number of tasks to enqueue. */
581 #ifndef ACPI_MAX_TASKS
582 #define ACPI_MAX_TASKS MAX(32, MAXCPU * 4)
583 #endif
584
585 /* Default number of task queue threads to start. */
586 #ifndef ACPI_MAX_THREADS
587 #define ACPI_MAX_THREADS 3
588 #endif
589
590 /* Use the device logging level for ktr(4). */
591 #define KTR_ACPI KTR_DEV
592
593 SYSCTL_DECL(_debug_acpi);
594
595 /*
596 * Parse and use proximity information in SRAT and SLIT.
597 */
598 int acpi_pxm_init(int ncpus, vm_paddr_t maxphys);
599 void acpi_pxm_parse_tables(void);
600 void acpi_pxm_set_mem_locality(void);
601 void acpi_pxm_set_cpu_locality(void);
602 int acpi_pxm_get_cpu_locality(int apic_id);
603 int acpi_pxm_parse(device_t dev);
604
605 /*
606 * Map a PXM to a VM domain.
607 *
608 * Returns the VM domain ID if found, or -1 if not found / invalid.
609 */
610 int acpi_map_pxm_to_vm_domainid(int pxm);
611 bus_get_cpus_t acpi_get_cpus;
612
613 /*
614 * Hook for ACPI sleep routine.
615 */
616 extern int (*acpi_prepare_sleep)(uint8_t state, uint32_t a, uint32_t b,
617 bool ext);
618
619 static inline void
acpi_set_prepare_sleep(int (* hook)(uint8_t state,uint32_t a,uint32_t b,bool ext))620 acpi_set_prepare_sleep(
621 int (*hook)(uint8_t state, uint32_t a, uint32_t b, bool ext))
622 {
623 acpi_prepare_sleep = hook;
624 }
625
626 #ifdef __aarch64__
627 /*
628 * ARM specific ACPI interfaces, relating to IORT table.
629 */
630 int acpi_iort_map_pci_msi(u_int seg, u_int rid, u_int *xref, u_int *devid);
631 int acpi_iort_map_pci_smmuv3(u_int seg, u_int rid, uint64_t *xref,
632 u_int *devid);
633 int acpi_iort_its_lookup(u_int its_id, u_int *xref, int *pxm);
634 int acpi_iort_map_named_msi(const char *devname, u_int rid, u_int *xref,
635 u_int *devid);
636 int acpi_iort_map_named_smmuv3(const char *devname, u_int rid,
637 uint64_t *xref, u_int *devid);
638 #endif
639 #endif /* _KERNEL */
640 #endif /* !_ACPIVAR_H_ */
641