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