2 * Copyright (c) 2000 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
3 * Copyright (c) 2000 Michael Smith <msmith@freebsd.org>
4 * Copyright (c) 2000 BSDi
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
38 #include <sys/eventhandler.h>
41 #include <sys/mutex.h>
42 #include <sys/selinfo.h>
44 #include <sys/sysctl.h>
46 #include <machine/bus.h>
47 #include <machine/resource.h>
49 struct apm_clone_data;
52 struct cdev *acpi_dev_t;
56 int acpi_sleep_disabled;
57 int acpi_resources_reserved;
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;
72 int acpi_handle_reboot;
74 vm_offset_t acpi_wakeaddr;
75 vm_paddr_t acpi_wakephys;
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. */
85 ACPI_HANDLE ad_handle;
91 struct resource_list ad_rl;
94 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
95 struct apm_clone_data {
96 STAILQ_ENTRY(apm_clone_data) entries;
99 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */
100 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */
101 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */
103 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */
104 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */
105 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */
106 struct acpi_softc *acpi_sc;
107 struct selinfo sel_read;
110 #define ACPI_PRW_MAX_POWERRES 8
112 struct acpi_prw_data {
113 ACPI_HANDLE gpe_handle;
116 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES];
120 /* Flags for each device defined in the AML namespace. */
121 #define ACPI_FLAG_WAKE_ENABLED 0x1
123 /* Macros for extracting parts of a PCI address from an _ADR value. */
124 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16)
125 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff)
128 * Entry points to ACPI from above are global functions defined in this
129 * file, sysctls, and I/O on the control device. Entry points from below
130 * are interrupts (the SCI), notifies, task queue threads, and the thermal
131 * zone polling thread.
133 * ACPI tables and global shared data are protected by a global lock
136 * Each ACPI device can have its own driver-specific mutex for protecting
137 * shared access to local data. The ACPI_LOCK macros handle mutexes.
139 * Drivers that need to serialize access to functions (e.g., to route
140 * interrupts, get/set control paths, etc.) should use the sx lock macros
143 * ACPI-CA handles its own locking and should not be called with locks held.
145 * The most complicated path is:
146 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
148 extern struct mtx acpi_mutex;
149 #define ACPI_LOCK(sys) mtx_lock(&sys##_mutex)
150 #define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex)
151 #define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED);
152 #define ACPI_LOCK_DECL(sys, name) \
153 static struct mtx sys##_mutex; \
154 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
155 #define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock)
156 #define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock)
157 #define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED);
158 #define ACPI_SERIAL_DECL(sys, name) \
159 static struct sx sys##_sxlock; \
160 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
163 * ACPI CA does not define layers for non-ACPI CA drivers.
164 * We define some here within the range provided.
166 #define ACPI_AC_ADAPTER 0x00010000
167 #define ACPI_BATTERY 0x00020000
168 #define ACPI_BUS 0x00040000
169 #define ACPI_BUTTON 0x00080000
170 #define ACPI_EC 0x00100000
171 #define ACPI_FAN 0x00200000
172 #define ACPI_POWERRES 0x00400000
173 #define ACPI_PROCESSOR 0x00800000
174 #define ACPI_THERMAL 0x01000000
175 #define ACPI_TIMER 0x02000000
176 #define ACPI_OEM 0x04000000
179 * Constants for different interrupt models used with acpi_SetIntrModel().
181 #define ACPI_INTR_PIC 0
182 #define ACPI_INTR_APIC 1
183 #define ACPI_INTR_SAPIC 2
186 * Various features and capabilities for the acpi_get_features() method.
187 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
188 * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
191 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
192 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */
193 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */
194 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */
195 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */
196 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */
197 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */
198 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */
199 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */
200 #define ACPI_CAP_SMP_C3_NATIVE (1 << 9) /* MP C2 and C3 support */
201 #define ACPI_CAP_PX_HW_COORD (1 << 11) /* Intel P-state HW coordination */
202 #define ACPI_CAP_INTR_CPPC (1 << 12) /* Native Interrupt Handling for
203 Collaborative Processor Performance Control notifications */
204 #define ACPI_CAP_HW_DUTY_C (1 << 13) /* Hardware Duty Cycling */
209 * ACPI_Q_BROKEN: Disables all ACPI support.
210 * ACPI_Q_TIMER: Disables support for the ACPI timer.
211 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
212 * first APIC and that the MADT should force that by ignoring the PC-AT
213 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
215 extern int acpi_quirks;
217 #define ACPI_Q_BROKEN (1 << 0)
218 #define ACPI_Q_TIMER (1 << 1)
219 #define ACPI_Q_MADT_IRQ0 (1 << 2)
222 * Note that the low ivar values are reserved to provide
223 * interface compatibility with ISA drivers which can also
226 #define ACPI_IVAR_HANDLE 0x100
227 #define ACPI_IVAR_UNUSED 0x101 /* Unused/reserved. */
228 #define ACPI_IVAR_PRIVATE 0x102
229 #define ACPI_IVAR_FLAGS 0x103
232 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is
233 * (type) 0. The <sys/bus.h> accessor functions don't check return values.
235 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \
237 static __inline type varp ## _get_ ## var(device_t dev) \
240 BUS_READ_IVAR(device_get_parent(dev), dev, \
241 ivarp ## _IVAR_ ## ivar, &v); \
245 static __inline void varp ## _set_ ## var(device_t dev, type t) \
247 uintptr_t v = (uintptr_t) t; \
248 BUS_WRITE_IVAR(device_get_parent(dev), dev, \
249 ivarp ## _IVAR_ ## ivar, v); \
252 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
253 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
254 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
256 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
257 static __inline device_t
258 acpi_get_device(ACPI_HANDLE handle)
261 AcpiGetData(handle, acpi_fake_objhandler, &dev);
262 return ((device_t)dev);
265 static __inline ACPI_OBJECT_TYPE
266 acpi_get_type(device_t dev)
271 if ((h = acpi_get_handle(dev)) == NULL)
272 return (ACPI_TYPE_NOT_FOUND);
273 if (ACPI_FAILURE(AcpiGetType(h, &t)))
274 return (ACPI_TYPE_NOT_FOUND);
278 /* Find the difference between two PM tick counts. */
279 static __inline uint32_t
280 acpi_TimerDelta(uint32_t end, uint32_t start)
283 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
285 return (end - start);
289 void acpi_EnterDebugger(void);
293 #include <sys/cons.h>
294 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0)
299 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \
300 if (acpi_get_verbose(acpi_sc)) \
301 device_printf(dev, x); \
304 /* Values for the first status word returned by _OSC. */
305 #define ACPI_OSC_FAILURE (1 << 1)
306 #define ACPI_OSC_BAD_UUID (1 << 2)
307 #define ACPI_OSC_BAD_REVISION (1 << 3)
308 #define ACPI_OSC_CAPS_MASKED (1 << 4)
310 /* Values for the device _STA (status) method. */
311 #define ACPI_STA_PRESENT (1 << 0)
312 #define ACPI_STA_ENABLED (1 << 1)
313 #define ACPI_STA_SHOW_IN_UI (1 << 2)
314 #define ACPI_STA_FUNCTIONAL (1 << 3)
315 #define ACPI_STA_BATT_PRESENT (1 << 4)
317 #define ACPI_DEVINFO_PRESENT(x, flags) \
318 (((x) & (flags)) == (flags))
319 #define ACPI_DEVICE_PRESENT(x) \
320 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
321 #define ACPI_BATTERY_PRESENT(x) \
322 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
323 ACPI_STA_BATT_PRESENT)
325 /* Callback function type for walking subtables within a table. */
326 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *);
328 BOOLEAN acpi_DeviceIsPresent(device_t dev);
329 BOOLEAN acpi_BatteryIsPresent(device_t dev);
330 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
331 ACPI_HANDLE *result);
332 ACPI_BUFFER *acpi_AllocBuffer(int size);
333 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
335 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path,
337 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path,
339 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj,
340 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
341 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
342 ACPI_RESOURCE **resp);
343 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf,
345 ACPI_STATUS acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid,
346 int revision, int count, uint32_t *caps_in,
347 uint32_t *caps_out, bool query);
348 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
349 ACPI_STATUS acpi_SetIntrModel(int model);
350 int acpi_ReqSleepState(struct acpi_softc *sc, int state);
351 int acpi_AckSleepState(struct apm_clone_data *clone, int error);
352 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state);
353 int acpi_wake_set_enable(device_t dev, int enable);
354 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
355 ACPI_STATUS acpi_Startup(void);
356 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
358 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
359 ACPI_GENERIC_ADDRESS *gas, struct resource **res,
361 void acpi_walk_subtables(void *first, void *end,
362 acpi_subtable_handler *handler, void *arg);
363 BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid);
365 struct acpi_parse_resource_set {
366 void (*set_init)(device_t dev, void *arg, void **context);
367 void (*set_done)(device_t dev, void *context);
368 void (*set_ioport)(device_t dev, void *context, uint64_t base,
370 void (*set_iorange)(device_t dev, void *context, uint64_t low,
371 uint64_t high, uint64_t length, uint64_t align);
372 void (*set_memory)(device_t dev, void *context, uint64_t base,
374 void (*set_memoryrange)(device_t dev, void *context, uint64_t low,
375 uint64_t high, uint64_t length, uint64_t align);
376 void (*set_irq)(device_t dev, void *context, uint8_t *irq,
377 int count, int trig, int pol);
378 void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
379 int count, int trig, int pol);
380 void (*set_drq)(device_t dev, void *context, uint8_t *drq,
382 void (*set_start_dependent)(device_t dev, void *context,
384 void (*set_end_dependent)(device_t dev, void *context);
387 extern struct acpi_parse_resource_set acpi_res_parse_set;
389 int acpi_identify(void);
390 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
391 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid,
392 struct resource *res, ACPI_RESOURCE *acpi_res);
393 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
394 struct acpi_parse_resource_set *set, void *arg);
395 struct resource *acpi_alloc_sysres(device_t child, int type, int *rid,
396 rman_res_t start, rman_res_t end, rman_res_t count,
399 /* ACPI event handling */
400 UINT32 acpi_event_power_button_sleep(void *context);
401 UINT32 acpi_event_power_button_wake(void *context);
402 UINT32 acpi_event_sleep_button_sleep(void *context);
403 UINT32 acpi_event_sleep_button_wake(void *context);
405 #define ACPI_EVENT_PRI_FIRST 0
406 #define ACPI_EVENT_PRI_DEFAULT 10000
407 #define ACPI_EVENT_PRI_LAST 20000
409 typedef void (*acpi_event_handler_t)(void *, int);
411 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
412 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
414 /* Device power control. */
415 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
416 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
417 int acpi_device_pwr_for_sleep(device_t bus, device_t dev,
421 void acpi_apm_init(struct acpi_softc *);
424 static __inline struct acpi_softc *
425 acpi_device_get_parent_softc(device_t child)
429 parent = device_get_parent(child);
432 return (device_get_softc(parent));
436 acpi_get_verbose(struct acpi_softc *sc)
439 return (sc->acpi_verbose);
443 char *acpi_name(ACPI_HANDLE handle);
444 int acpi_avoid(ACPI_HANDLE handle);
445 int acpi_disabled(char *subsys);
446 int acpi_machdep_init(device_t dev);
447 void acpi_install_wakeup_handler(struct acpi_softc *sc);
448 int acpi_sleep_machdep(struct acpi_softc *sc, int state);
449 int acpi_wakeup_machdep(struct acpi_softc *sc, int state,
450 int sleep_result, int intr_enabled);
451 int acpi_table_quirks(int *quirks);
452 int acpi_machdep_quirks(int *quirks);
454 uint32_t hpet_get_uid(device_t dev);
456 /* Battery Abstraction. */
457 struct acpi_battinfo;
459 int acpi_battery_register(device_t dev);
460 int acpi_battery_remove(device_t dev);
461 int acpi_battery_get_units(void);
462 int acpi_battery_get_info_expire(void);
463 int acpi_battery_bst_valid(struct acpi_bst *bst);
464 int acpi_battery_bif_valid(struct acpi_bif *bif);
465 int acpi_battery_get_battinfo(device_t dev,
466 struct acpi_battinfo *info);
468 /* Embedded controller. */
469 void acpi_ec_ecdt_probe(device_t);
471 /* AC adapter interface. */
472 int acpi_acad_get_acline(int *);
474 /* Package manipulation convenience functions. */
475 #define ACPI_PKG_VALID(pkg, size) \
476 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \
477 (pkg)->Package.Count >= (size))
478 int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
479 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
480 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
481 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
482 int *rid, struct resource **dst, u_int flags);
483 int acpi_PkgFFH_IntelCpu(ACPI_OBJECT *res, int idx, int *vendor,
484 int *class, uint64_t *address, int *accsize);
485 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
488 * Base level for BUS_ADD_CHILD. Special devices are added at orders less
489 * than this, and normal devices at or above this level. This keeps the
490 * probe order sorted so that things like sysresource are available before
491 * their children need them.
493 #define ACPI_DEV_BASE_ORDER 100
495 /* Default maximum number of tasks to enqueue. */
496 #ifndef ACPI_MAX_TASKS
497 #define ACPI_MAX_TASKS MAX(32, MAXCPU * 4)
500 /* Default number of task queue threads to start. */
501 #ifndef ACPI_MAX_THREADS
502 #define ACPI_MAX_THREADS 3
505 /* Use the device logging level for ktr(4). */
506 #define KTR_ACPI KTR_DEV
508 SYSCTL_DECL(_debug_acpi);
511 * Map a PXM to a VM domain.
513 * Returns the VM domain ID if found, or -1 if not found / invalid.
515 int acpi_map_pxm_to_vm_domainid(int pxm);
516 int acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op,
517 size_t setsize, cpuset_t *cpuset);
518 int acpi_get_domain(device_t dev, device_t child, int *domain);
521 #endif /* !_ACPIVAR_H_ */