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