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