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 * $FreeBSD$ 29 */ 30 31 #ifndef _ACPIVAR_H_ 32 #define _ACPIVAR_H_ 33 34 #ifdef _KERNEL 35 36 #include "acpi_if.h" 37 #include "bus_if.h" 38 #include <sys/eventhandler.h> 39 #include <sys/ktr.h> 40 #include <sys/lock.h> 41 #include <sys/mutex.h> 42 #include <sys/selinfo.h> 43 #include <sys/sx.h> 44 #include <sys/sysctl.h> 45 46 #include <machine/bus.h> 47 #include <machine/resource.h> 48 49 struct apm_clone_data; 50 struct acpi_softc { 51 device_t acpi_dev; 52 struct cdev *acpi_dev_t; 53 54 int acpi_enabled; 55 int acpi_sstate; 56 int acpi_sleep_disabled; 57 int acpi_resources_reserved; 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 83 struct acpi_device { 84 /* ACPI ivars */ 85 ACPI_HANDLE ad_handle; 86 void *ad_private; 87 int ad_flags; 88 89 /* Resources */ 90 struct resource_list ad_rl; 91 }; 92 93 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */ 94 struct apm_clone_data { 95 STAILQ_ENTRY(apm_clone_data) entries; 96 struct cdev *cdev; 97 int flags; 98 #define ACPI_EVF_NONE 0 /* /dev/apm semantics */ 99 #define ACPI_EVF_DEVD 1 /* /dev/acpi is handled via devd(8) */ 100 #define ACPI_EVF_WRITE 2 /* Device instance is opened writable. */ 101 int notify_status; 102 #define APM_EV_NONE 0 /* Device not yet aware of pending sleep. */ 103 #define APM_EV_NOTIFIED 1 /* Device saw next sleep state. */ 104 #define APM_EV_ACKED 2 /* Device agreed sleep can occur. */ 105 struct acpi_softc *acpi_sc; 106 struct selinfo sel_read; 107 }; 108 109 #define ACPI_PRW_MAX_POWERRES 8 110 111 struct acpi_prw_data { 112 ACPI_HANDLE gpe_handle; 113 int gpe_bit; 114 int lowest_wake; 115 ACPI_OBJECT power_res[ACPI_PRW_MAX_POWERRES]; 116 int power_res_count; 117 }; 118 119 /* Flags for each device defined in the AML namespace. */ 120 #define ACPI_FLAG_WAKE_ENABLED 0x1 121 122 /* Macros for extracting parts of a PCI address from an _ADR value. */ 123 #define ACPI_ADR_PCI_SLOT(adr) (((adr) & 0xffff0000) >> 16) 124 #define ACPI_ADR_PCI_FUNC(adr) ((adr) & 0xffff) 125 126 /* 127 * Entry points to ACPI from above are global functions defined in this 128 * file, sysctls, and I/O on the control device. Entry points from below 129 * are interrupts (the SCI), notifies, task queue threads, and the thermal 130 * zone polling thread. 131 * 132 * ACPI tables and global shared data are protected by a global lock 133 * (acpi_mutex). 134 * 135 * Each ACPI device can have its own driver-specific mutex for protecting 136 * shared access to local data. The ACPI_LOCK macros handle mutexes. 137 * 138 * Drivers that need to serialize access to functions (e.g., to route 139 * interrupts, get/set control paths, etc.) should use the sx lock macros 140 * (ACPI_SERIAL). 141 * 142 * ACPI-CA handles its own locking and should not be called with locks held. 143 * 144 * The most complicated path is: 145 * GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE 146 */ 147 extern struct mtx acpi_mutex; 148 #define ACPI_LOCK(sys) mtx_lock(&sys##_mutex) 149 #define ACPI_UNLOCK(sys) mtx_unlock(&sys##_mutex) 150 #define ACPI_LOCK_ASSERT(sys) mtx_assert(&sys##_mutex, MA_OWNED); 151 #define ACPI_LOCK_DECL(sys, name) \ 152 static struct mtx sys##_mutex; \ 153 MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF) 154 #define ACPI_SERIAL_BEGIN(sys) sx_xlock(&sys##_sxlock) 155 #define ACPI_SERIAL_END(sys) sx_xunlock(&sys##_sxlock) 156 #define ACPI_SERIAL_ASSERT(sys) sx_assert(&sys##_sxlock, SX_XLOCKED); 157 #define ACPI_SERIAL_DECL(sys, name) \ 158 static struct sx sys##_sxlock; \ 159 SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name) 160 161 /* 162 * ACPI CA does not define layers for non-ACPI CA drivers. 163 * We define some here within the range provided. 164 */ 165 #define ACPI_AC_ADAPTER 0x00010000 166 #define ACPI_BATTERY 0x00020000 167 #define ACPI_BUS 0x00040000 168 #define ACPI_BUTTON 0x00080000 169 #define ACPI_EC 0x00100000 170 #define ACPI_FAN 0x00200000 171 #define ACPI_POWERRES 0x00400000 172 #define ACPI_PROCESSOR 0x00800000 173 #define ACPI_THERMAL 0x01000000 174 #define ACPI_TIMER 0x02000000 175 #define ACPI_OEM 0x04000000 176 177 /* 178 * Constants for different interrupt models used with acpi_SetIntrModel(). 179 */ 180 #define ACPI_INTR_PIC 0 181 #define ACPI_INTR_APIC 1 182 #define ACPI_INTR_SAPIC 2 183 184 /* 185 * Various features and capabilities for the acpi_get_features() method. 186 * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods. 187 * See the Intel document titled "Intel Processor Vendor-Specific ACPI", 188 * number 302223-005. 189 */ 190 #define ACPI_CAP_PERF_MSRS (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */ 191 #define ACPI_CAP_C1_IO_HALT (1 << 1) /* Intel C1 "IO then halt" sequence */ 192 #define ACPI_CAP_THR_MSRS (1 << 2) /* Intel OnDemand throttling MSRs */ 193 #define ACPI_CAP_SMP_SAME (1 << 3) /* MP C1, Px, and Tx (all the same) */ 194 #define ACPI_CAP_SMP_SAME_C3 (1 << 4) /* MP C2 and C3 (all the same) */ 195 #define ACPI_CAP_SMP_DIFF_PX (1 << 5) /* MP Px (different, using _PSD) */ 196 #define ACPI_CAP_SMP_DIFF_CX (1 << 6) /* MP Cx (different, using _CSD) */ 197 #define ACPI_CAP_SMP_DIFF_TX (1 << 7) /* MP Tx (different, using _TSD) */ 198 #define ACPI_CAP_SMP_C1_NATIVE (1 << 8) /* MP C1 support other than halt */ 199 #define ACPI_CAP_SMP_C3_NATIVE (1 << 9) /* MP C2 and C3 support */ 200 #define ACPI_CAP_PX_HW_COORD (1 << 11) /* Intel P-state HW coordination */ 201 202 /* 203 * Quirk flags. 204 * 205 * ACPI_Q_BROKEN: Disables all ACPI support. 206 * ACPI_Q_TIMER: Disables support for the ACPI timer. 207 * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the 208 * first APIC and that the MADT should force that by ignoring the PC-AT 209 * compatible flag and ignoring overrides that redirect IRQ 0 to pin 2. 210 */ 211 extern int acpi_quirks; 212 #define ACPI_Q_OK 0 213 #define ACPI_Q_BROKEN (1 << 0) 214 #define ACPI_Q_TIMER (1 << 1) 215 #define ACPI_Q_MADT_IRQ0 (1 << 2) 216 217 /* 218 * Note that the low ivar values are reserved to provide 219 * interface compatibility with ISA drivers which can also 220 * attach to ACPI. 221 */ 222 #define ACPI_IVAR_HANDLE 0x100 223 #define ACPI_IVAR_UNUSED 0x101 /* Unused/reserved. */ 224 #define ACPI_IVAR_PRIVATE 0x102 225 #define ACPI_IVAR_FLAGS 0x103 226 227 /* 228 * Accessor functions for our ivars. Default value for BUS_READ_IVAR is 229 * (type) 0. The <sys/bus.h> accessor functions don't check return values. 230 */ 231 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type) \ 232 \ 233 static __inline type varp ## _get_ ## var(device_t dev) \ 234 { \ 235 uintptr_t v = 0; \ 236 BUS_READ_IVAR(device_get_parent(dev), dev, \ 237 ivarp ## _IVAR_ ## ivar, &v); \ 238 return ((type) v); \ 239 } \ 240 \ 241 static __inline void varp ## _set_ ## var(device_t dev, type t) \ 242 { \ 243 uintptr_t v = (uintptr_t) t; \ 244 BUS_WRITE_IVAR(device_get_parent(dev), dev, \ 245 ivarp ## _IVAR_ ## ivar, v); \ 246 } 247 248 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE) 249 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *) 250 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int) 251 252 void acpi_fake_objhandler(ACPI_HANDLE h, void *data); 253 static __inline device_t 254 acpi_get_device(ACPI_HANDLE handle) 255 { 256 void *dev = NULL; 257 AcpiGetData(handle, acpi_fake_objhandler, &dev); 258 return ((device_t)dev); 259 } 260 261 static __inline ACPI_OBJECT_TYPE 262 acpi_get_type(device_t dev) 263 { 264 ACPI_HANDLE h; 265 ACPI_OBJECT_TYPE t; 266 267 if ((h = acpi_get_handle(dev)) == NULL) 268 return (ACPI_TYPE_NOT_FOUND); 269 if (ACPI_FAILURE(AcpiGetType(h, &t))) 270 return (ACPI_TYPE_NOT_FOUND); 271 return (t); 272 } 273 274 /* Find the difference between two PM tick counts. */ 275 static __inline uint32_t 276 acpi_TimerDelta(uint32_t end, uint32_t start) 277 { 278 279 if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0) 280 end |= 0x01000000; 281 return (end - start); 282 } 283 284 #ifdef ACPI_DEBUGGER 285 void acpi_EnterDebugger(void); 286 #endif 287 288 #ifdef ACPI_DEBUG 289 #include <sys/cons.h> 290 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0) 291 #else 292 #define STEP(x) 293 #endif 294 295 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \ 296 if (acpi_get_verbose(acpi_sc)) \ 297 device_printf(dev, x); \ 298 } while (0) 299 300 /* Values for the device _STA (status) method. */ 301 #define ACPI_STA_PRESENT (1 << 0) 302 #define ACPI_STA_ENABLED (1 << 1) 303 #define ACPI_STA_SHOW_IN_UI (1 << 2) 304 #define ACPI_STA_FUNCTIONAL (1 << 3) 305 #define ACPI_STA_BATT_PRESENT (1 << 4) 306 307 #define ACPI_DEVINFO_PRESENT(x, flags) \ 308 (((x) & (flags)) == (flags)) 309 #define ACPI_DEVICE_PRESENT(x) \ 310 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL) 311 #define ACPI_BATTERY_PRESENT(x) \ 312 ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \ 313 ACPI_STA_BATT_PRESENT) 314 315 /* Callback function type for walking subtables within a table. */ 316 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *); 317 318 BOOLEAN acpi_DeviceIsPresent(device_t dev); 319 BOOLEAN acpi_BatteryIsPresent(device_t dev); 320 ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, 321 ACPI_HANDLE *result); 322 ACPI_BUFFER *acpi_AllocBuffer(int size); 323 ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, 324 UINT32 *number); 325 ACPI_STATUS acpi_GetInteger(ACPI_HANDLE handle, char *path, 326 UINT32 *number); 327 ACPI_STATUS acpi_SetInteger(ACPI_HANDLE handle, char *path, 328 UINT32 number); 329 ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj, 330 void (*func)(ACPI_OBJECT *comp, void *arg), void *arg); 331 ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, 332 ACPI_RESOURCE **resp); 333 ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf, 334 ACPI_RESOURCE *res); 335 ACPI_STATUS acpi_OverrideInterruptLevel(UINT32 InterruptNumber); 336 ACPI_STATUS acpi_SetIntrModel(int model); 337 int acpi_ReqSleepState(struct acpi_softc *sc, int state); 338 int acpi_AckSleepState(struct apm_clone_data *clone, int error); 339 ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state); 340 int acpi_wake_set_enable(device_t dev, int enable); 341 int acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw); 342 ACPI_STATUS acpi_Startup(void); 343 void acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, 344 uint8_t notify); 345 int acpi_bus_alloc_gas(device_t dev, int *type, int *rid, 346 ACPI_GENERIC_ADDRESS *gas, struct resource **res, 347 u_int flags); 348 void acpi_walk_subtables(void *first, void *end, 349 acpi_subtable_handler *handler, void *arg); 350 BOOLEAN acpi_MatchHid(ACPI_HANDLE h, const char *hid); 351 352 struct acpi_parse_resource_set { 353 void (*set_init)(device_t dev, void *arg, void **context); 354 void (*set_done)(device_t dev, void *context); 355 void (*set_ioport)(device_t dev, void *context, uint64_t base, 356 uint64_t length); 357 void (*set_iorange)(device_t dev, void *context, uint64_t low, 358 uint64_t high, uint64_t length, uint64_t align); 359 void (*set_memory)(device_t dev, void *context, uint64_t base, 360 uint64_t length); 361 void (*set_memoryrange)(device_t dev, void *context, uint64_t low, 362 uint64_t high, uint64_t length, uint64_t align); 363 void (*set_irq)(device_t dev, void *context, uint8_t *irq, 364 int count, int trig, int pol); 365 void (*set_ext_irq)(device_t dev, void *context, uint32_t *irq, 366 int count, int trig, int pol); 367 void (*set_drq)(device_t dev, void *context, uint8_t *drq, 368 int count); 369 void (*set_start_dependent)(device_t dev, void *context, 370 int preference); 371 void (*set_end_dependent)(device_t dev, void *context); 372 }; 373 374 extern struct acpi_parse_resource_set acpi_res_parse_set; 375 376 int acpi_identify(void); 377 void acpi_config_intr(device_t dev, ACPI_RESOURCE *res); 378 ACPI_STATUS acpi_lookup_irq_resource(device_t dev, int rid, 379 struct resource *res, ACPI_RESOURCE *acpi_res); 380 ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle, 381 struct acpi_parse_resource_set *set, void *arg); 382 struct resource *acpi_alloc_sysres(device_t child, int type, int *rid, 383 u_long start, u_long end, u_long count, u_int flags); 384 385 /* ACPI event handling */ 386 UINT32 acpi_event_power_button_sleep(void *context); 387 UINT32 acpi_event_power_button_wake(void *context); 388 UINT32 acpi_event_sleep_button_sleep(void *context); 389 UINT32 acpi_event_sleep_button_wake(void *context); 390 391 #define ACPI_EVENT_PRI_FIRST 0 392 #define ACPI_EVENT_PRI_DEFAULT 10000 393 #define ACPI_EVENT_PRI_LAST 20000 394 395 typedef void (*acpi_event_handler_t)(void *, int); 396 397 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t); 398 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t); 399 400 /* Device power control. */ 401 ACPI_STATUS acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable); 402 ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state); 403 int acpi_device_pwr_for_sleep(device_t bus, device_t dev, 404 int *dstate); 405 406 /* APM emulation */ 407 void acpi_apm_init(struct acpi_softc *); 408 409 /* Misc. */ 410 static __inline struct acpi_softc * 411 acpi_device_get_parent_softc(device_t child) 412 { 413 device_t parent; 414 415 parent = device_get_parent(child); 416 if (parent == NULL) 417 return (NULL); 418 return (device_get_softc(parent)); 419 } 420 421 static __inline int 422 acpi_get_verbose(struct acpi_softc *sc) 423 { 424 if (sc) 425 return (sc->acpi_verbose); 426 return (0); 427 } 428 429 char *acpi_name(ACPI_HANDLE handle); 430 int acpi_avoid(ACPI_HANDLE handle); 431 int acpi_disabled(char *subsys); 432 int acpi_machdep_init(device_t dev); 433 void acpi_install_wakeup_handler(struct acpi_softc *sc); 434 int acpi_sleep_machdep(struct acpi_softc *sc, int state); 435 int acpi_wakeup_machdep(struct acpi_softc *sc, int state, 436 int sleep_result, int intr_enabled); 437 int acpi_table_quirks(int *quirks); 438 int acpi_machdep_quirks(int *quirks); 439 440 /* Battery Abstraction. */ 441 struct acpi_battinfo; 442 443 int acpi_battery_register(device_t dev); 444 int acpi_battery_remove(device_t dev); 445 int acpi_battery_get_units(void); 446 int acpi_battery_get_info_expire(void); 447 int acpi_battery_bst_valid(struct acpi_bst *bst); 448 int acpi_battery_bif_valid(struct acpi_bif *bif); 449 int acpi_battery_get_battinfo(device_t dev, 450 struct acpi_battinfo *info); 451 452 /* Embedded controller. */ 453 void acpi_ec_ecdt_probe(device_t); 454 455 /* AC adapter interface. */ 456 int acpi_acad_get_acline(int *); 457 458 /* Package manipulation convenience functions. */ 459 #define ACPI_PKG_VALID(pkg, size) \ 460 ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE && \ 461 (pkg)->Package.Count >= (size)) 462 int acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst); 463 int acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst); 464 int acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size); 465 int acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type, 466 int *rid, struct resource **dst, u_int flags); 467 ACPI_HANDLE acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj); 468 469 /* 470 * Base level for BUS_ADD_CHILD. Special devices are added at orders less 471 * than this, and normal devices at or above this level. This keeps the 472 * probe order sorted so that things like sysresource are available before 473 * their children need them. 474 */ 475 #define ACPI_DEV_BASE_ORDER 100 476 477 /* Default maximum number of tasks to enqueue. */ 478 #ifndef ACPI_MAX_TASKS 479 #define ACPI_MAX_TASKS MAX(32, MAXCPU * 4) 480 #endif 481 482 /* Default number of task queue threads to start. */ 483 #ifndef ACPI_MAX_THREADS 484 #define ACPI_MAX_THREADS 3 485 #endif 486 487 /* Use the device logging level for ktr(4). */ 488 #define KTR_ACPI KTR_DEV 489 490 SYSCTL_DECL(_debug_acpi); 491 492 #endif /* _KERNEL */ 493 #endif /* !_ACPIVAR_H_ */ 494