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: src/sys/dev/acpica/acpivar.h,v 1.43.2.1 2003/08/22 20:49:20 jhb Exp $ 29 * $DragonFly: src/sys/dev/acpica/Attic/acpivar.h,v 1.3 2004/09/15 01:39:10 joerg Exp $ 30 */ 31 32 #include "bus_if.h" 33 #include <sys/eventhandler.h> 34 #include <sys/sysctl.h> 35 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000 36 #include <sys/lock.h> 37 #include <sys/mutex.h> 38 #endif 39 40 #include <machine/bus.h> 41 #include <machine/resource.h> 42 43 struct acpi_softc { 44 device_t acpi_dev; 45 dev_t acpi_dev_t; 46 47 struct callout acpi_sleep_timer; 48 struct resource *acpi_irq; 49 int acpi_irq_rid; 50 void *acpi_irq_handle; 51 52 int acpi_enabled; 53 int acpi_sstate; 54 int acpi_sleep_disabled; 55 56 struct sysctl_ctx_list acpi_sysctl_ctx; 57 struct sysctl_oid *acpi_sysctl_tree; 58 #define ACPI_POWER_BUTTON_DEFAULT_SX ACPI_STATE_S5; 59 #define ACPI_SLEEP_BUTTON_DEFAULT_SX ACPI_STATE_S1; 60 #define ACPI_LID_SWITCH_DEFAULT_SX ACPI_STATE_S1; 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_disable_on_poweroff; 71 72 int acpi_verbose; 73 74 bus_dma_tag_t acpi_waketag; 75 bus_dmamap_t acpi_wakemap; 76 vm_offset_t acpi_wakeaddr; 77 vm_paddr_t acpi_wakephys; 78 79 struct sysctl_ctx_list acpi_battery_sysctl_ctx; 80 struct sysctl_oid *acpi_battery_sysctl_tree; 81 }; 82 83 struct acpi_device { 84 /* ACPI ivars */ 85 ACPI_HANDLE ad_handle; 86 int ad_magic; 87 void *ad_private; 88 89 /* resources */ 90 struct resource_list ad_rl; 91 92 }; 93 94 #if defined(__DragonFly__) || __FreeBSD_version < 500000 95 /* 96 * In 4.x, ACPI is protected by splhigh(). 97 */ 98 # define ACPI_LOCK s = splhigh() 99 # define ACPI_UNLOCK splx(s) 100 # define ACPI_ASSERTLOCK 101 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e) 102 # define ACPI_LOCK_DECL int s 103 # define kthread_create(a, b, c, d, e, f) kthread_create(a, b, c, f) 104 # define tc_init(a) init_timecounter(a) 105 #elif 0 106 /* 107 * The ACPI subsystem lives under a single mutex. You *must* 108 * acquire this mutex before calling any of the acpi_ or Acpi* functions. 109 */ 110 extern struct mtx acpi_mutex; 111 # define ACPI_LOCK mtx_lock(&acpi_mutex) 112 # define ACPI_UNLOCK mtx_unlock(&acpi_mutex) 113 # define ACPI_ASSERTLOCK mtx_assert(&acpi_mutex, MA_OWNED) 114 # define ACPI_MSLEEP(a, b, c, d, e) msleep(a, b, c, d, e) 115 # define ACPI_LOCK_DECL 116 #else 117 # define ACPI_LOCK 118 # define ACPI_UNLOCK 119 # define ACPI_ASSERTLOCK 120 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e) 121 # define ACPI_LOCK_DECL 122 #endif 123 124 /* 125 * ACPI CA does not define layers for non-ACPI CA drivers. 126 * We define some here within the range provided. 127 */ 128 #define ACPI_BUS 0x00010000 129 #define ACPI_SYSTEM 0x00020000 130 #define ACPI_POWER 0x00040000 131 #define ACPI_EC 0x00080000 132 #define ACPI_AC_ADAPTER 0x00100000 133 #define ACPI_BATTERY 0x00110000 134 #define ACPI_BUTTON 0x00120000 135 #define ACPI_PROCESSOR 0x00140000 136 #define ACPI_THERMAL 0x00180000 137 #define ACPI_FAN 0x00200000 138 139 /* 140 * Constants for different interrupt models used with acpi_SetIntrModel(). 141 */ 142 #define ACPI_INTR_PIC 0 143 #define ACPI_INTR_APIC 1 144 #define ACPI_INTR_SAPIC 2 145 146 /* XXX this is no longer referenced anywhere, remove? */ 147 #if 0 148 /* 149 * This is a cheap and nasty way to get around the horrid counted list 150 * argument format that AcpiEvalateObject uses. 151 */ 152 #define ACPI_OBJECTLIST_MAX 16 153 struct acpi_object_list { 154 UINT32 count; 155 ACPI_OBJECT *pointer[ACPI_OBJECTLIST_MAX]; 156 ACPI_OBJECT object[ACPI_OBJECTLIST_MAX]; 157 }; 158 159 static __inline struct acpi_object_list * 160 acpi_AllocObjectList(int nobj) 161 { 162 struct acpi_object_list *l; 163 int i; 164 165 if (nobj > ACPI_OBJECTLIST_MAX) 166 return(NULL); 167 if ((l = AcpiOsAllocate(sizeof(*l))) == NULL) 168 return(NULL); 169 bzero(l, sizeof(*l)); 170 for (i = 0; i < ACPI_OBJECTLIST_MAX; i++) 171 l->pointer[i] = &l->object[i]; 172 l->count = nobj; 173 return(l); 174 } 175 #endif /* unused */ 176 177 /* 178 * Note that the low ivar values are reserved to provide 179 * interface compatibility with ISA drivers which can also 180 * attach to ACPI. 181 */ 182 #define ACPI_IVAR_HANDLE 0x100 183 #define ACPI_IVAR_MAGIC 0x101 184 #define ACPI_IVAR_PRIVATE 0x102 185 186 static __inline ACPI_HANDLE 187 acpi_get_handle(device_t dev) 188 { 189 uintptr_t up; 190 ACPI_HANDLE h; 191 192 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, &up)) 193 return(NULL); 194 h = (ACPI_HANDLE)up; 195 return(h); 196 } 197 198 static __inline int 199 acpi_set_handle(device_t dev, ACPI_HANDLE h) 200 { 201 uintptr_t up; 202 203 up = (uintptr_t)h; 204 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, up)); 205 } 206 207 static __inline int 208 acpi_get_magic(device_t dev) 209 { 210 uintptr_t up; 211 int m; 212 213 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, &up)) 214 return(0); 215 m = (int)up; 216 return(m); 217 } 218 219 static __inline int 220 acpi_set_magic(device_t dev, int m) 221 { 222 uintptr_t up; 223 224 up = (uintptr_t)m; 225 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, up)); 226 } 227 228 static __inline void * 229 acpi_get_private(device_t dev) 230 { 231 uintptr_t up; 232 void *p; 233 234 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, &up)) 235 return(NULL); 236 p = (void *)up; 237 return(p); 238 } 239 240 static __inline int 241 acpi_set_private(device_t dev, void *p) 242 { 243 uintptr_t up; 244 245 up = (uintptr_t)p; 246 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, up)); 247 } 248 249 static __inline ACPI_OBJECT_TYPE 250 acpi_get_type(device_t dev) 251 { 252 ACPI_HANDLE h; 253 ACPI_OBJECT_TYPE t; 254 255 if ((h = acpi_get_handle(dev)) == NULL) 256 return(ACPI_TYPE_NOT_FOUND); 257 if (AcpiGetType(h, &t) != AE_OK) 258 return(ACPI_TYPE_NOT_FOUND); 259 return(t); 260 } 261 262 #ifdef ACPI_DEBUGGER 263 extern void acpi_EnterDebugger(void); 264 #endif 265 266 #ifdef ACPI_DEBUG 267 #include <sys/cons.h> 268 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0) 269 #else 270 #define STEP(x) 271 #endif 272 273 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \ 274 if (acpi_get_verbose(acpi_sc)) \ 275 device_printf(dev, x); \ 276 } while (0) 277 278 #define ACPI_DEVINFO_PRESENT(x) (((x) & 0x9) == 9) 279 extern BOOLEAN acpi_DeviceIsPresent(device_t dev); 280 extern BOOLEAN acpi_BatteryIsPresent(device_t dev); 281 extern BOOLEAN acpi_MatchHid(device_t dev, char *hid); 282 extern ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result); 283 extern ACPI_BUFFER *acpi_AllocBuffer(int size); 284 extern ACPI_STATUS acpi_EvaluateInteger(ACPI_HANDLE handle, char *path, int *number); 285 extern ACPI_STATUS acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, int *number); 286 extern ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj, 287 void (* func)(ACPI_OBJECT *comp, void *arg), 288 void *arg); 289 extern ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp); 290 extern ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res); 291 extern ACPI_STATUS acpi_SetIntrModel(int model); 292 293 extern ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state); 294 extern ACPI_STATUS acpi_Enable(struct acpi_softc *sc); 295 extern ACPI_STATUS acpi_Disable(struct acpi_softc *sc); 296 297 struct acpi_parse_resource_set { 298 void (* set_init)(device_t dev, void **context); 299 void (* set_done)(device_t dev, void *context); 300 void (* set_ioport)(device_t dev, void *context, u_int32_t base, u_int32_t length); 301 void (* set_iorange)(device_t dev, void *context, u_int32_t low, u_int32_t high, 302 u_int32_t length, u_int32_t align); 303 void (* set_memory)(device_t dev, void *context, u_int32_t base, u_int32_t length); 304 void (* set_memoryrange)(device_t dev, void *context, u_int32_t low, u_int32_t high, 305 u_int32_t length, u_int32_t align); 306 void (* set_irq)(device_t dev, void *context, u_int32_t *irq, int cout); 307 void (* set_drq)(device_t dev, void *context, u_int32_t *drq, int count); 308 void (* set_start_dependant)(device_t dev, void *context, int preference); 309 void (* set_end_dependant)(device_t dev, void *context); 310 }; 311 312 extern struct acpi_parse_resource_set acpi_res_parse_set; 313 extern ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle, 314 struct acpi_parse_resource_set *set); 315 /* XXX until Intel fix this in their headers, based on NEXT_RESOURCE */ 316 #define ACPI_RESOURCE_NEXT(Res) (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length) 317 318 /* 319 * ACPI event handling 320 */ 321 extern UINT32 acpi_eventhandler_power_button_for_sleep(void *context); 322 extern UINT32 acpi_eventhandler_power_button_for_wakeup(void *context); 323 extern UINT32 acpi_eventhandler_sleep_button_for_sleep(void *context); 324 extern UINT32 acpi_eventhandler_sleep_button_for_wakeup(void *context); 325 326 #define ACPI_EVENT_PRI_FIRST 0 327 #define ACPI_EVENT_PRI_DEFAULT 10000 328 #define ACPI_EVENT_PRI_LAST 20000 329 330 typedef void (*acpi_event_handler_t)(void *, int); 331 332 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t); 333 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t); 334 335 /* 336 * Device power control. 337 */ 338 extern ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state); 339 340 /* 341 * Misc. 342 */ 343 static __inline struct acpi_softc * 344 acpi_device_get_parent_softc(device_t child) 345 { 346 device_t parent; 347 348 parent = device_get_parent(child); 349 if (parent == NULL) { 350 return(NULL); 351 } 352 return(device_get_softc(parent)); 353 } 354 355 static __inline int 356 acpi_get_verbose(struct acpi_softc *sc) 357 { 358 if (sc) 359 return(sc->acpi_verbose); 360 return(0); 361 } 362 363 extern char *acpi_name(ACPI_HANDLE handle); 364 extern int acpi_avoid(ACPI_HANDLE handle); 365 extern int acpi_disabled(char *subsys); 366 367 extern void acpi_device_enable_wake_capability(ACPI_HANDLE h, int enable); 368 extern void acpi_device_enable_wake_event(ACPI_HANDLE h); 369 370 extern int acpi_machdep_init(device_t dev); 371 extern void acpi_install_wakeup_handler(struct acpi_softc *sc); 372 extern int acpi_sleep_machdep(struct acpi_softc *sc, int state); 373 374 /* 375 * Battery Abstraction. 376 */ 377 struct acpi_battinfo; 378 struct acpi_battdesc; 379 380 extern int acpi_battery_register(int, int); 381 extern int acpi_battery_get_battinfo(int, struct acpi_battinfo *); 382 extern int acpi_battery_get_units(void); 383 extern int acpi_battery_get_info_expire(void); 384 extern int acpi_battery_get_battdesc(int, struct acpi_battdesc *); 385 386 extern int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *); 387 388 /* 389 * AC adapter interface. 390 */ 391 392 extern int acpi_acad_get_acline(int *); 393 394 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000 395 #ifndef ACPI_MAX_THREADS 396 #define ACPI_MAX_THREADS 3 397 #endif 398 #if ACPI_MAX_THREADS > 0 399 #define ACPI_USE_THREADS 400 #endif 401 #endif 402 403 #ifdef ACPI_USE_THREADS 404 /* 405 * ACPI task kernel thread initialization. 406 */ 407 extern int acpi_task_thread_init(void); 408 #endif 409 410