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