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 "bus_if.h" 32 #include <sys/eventhandler.h> 33 #include <sys/sysctl.h> 34 35 #include <machine/bus.h> 36 #include <machine/resource.h> 37 38 extern devclass_t acpi_devclass; 39 40 struct acpi_softc { 41 device_t acpi_dev; 42 dev_t acpi_dev_t; 43 44 struct resource *acpi_irq; 45 int acpi_irq_rid; 46 void *acpi_irq_handle; 47 48 int acpi_enabled; 49 int acpi_sstate; 50 int acpi_sleep_disabled; 51 52 struct sysctl_ctx_list acpi_sysctl_ctx; 53 struct sysctl_oid *acpi_sysctl_tree; 54 #define ACPI_POWER_BUTTON_DEFAULT_SX ACPI_STATE_S5; 55 #define ACPI_SLEEP_BUTTON_DEFAULT_SX ACPI_STATE_S1; 56 #define ACPI_LID_SWITCH_DEFAULT_SX ACPI_STATE_S1; 57 int acpi_power_button_sx; 58 int acpi_sleep_button_sx; 59 int acpi_lid_switch_sx; 60 61 int acpi_standby_sx; 62 int acpi_suspend_sx; 63 64 int acpi_s4bios; 65 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_offset_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 83 /* resources */ 84 struct resource_list ad_rl; 85 86 }; 87 88 /* 89 * The ACPI subsystem lives under a single mutex. You *must* 90 * acquire this mutex before calling any of the acpi_ or Acpi* functions. 91 * 92 * XXX the ACPI_MSLEEP macro should go away once locking is resolved 93 */ 94 extern struct mtx acpi_mutex; 95 #if 0 96 # define ACPI_LOCK mtx_lock(&acpi_mutex) 97 # define ACPI_UNLOCK mtx_unlock(&acpi_mutex) 98 # define ACPI_ASSERTLOCK mtx_assert(&acpi_mutex, MA_OWNED) 99 # define ACPI_MSLEEP(a, b, c, d, e) msleep(a, b, c, d, e) 100 #else 101 # define ACPI_LOCK 102 # define ACPI_UNLOCK 103 # define ACPI_ASSERTLOCK 104 # define ACPI_MSLEEP(a, b, c, d, e) tsleep(a, c, d, e) 105 #endif 106 107 /* 108 * This is a cheap and nasty way to get around the horrid counted list 109 * argument format that AcpiEvalateObject uses. 110 */ 111 #define ACPI_OBJECTLIST_MAX 16 112 struct acpi_object_list { 113 UINT32 count; 114 ACPI_OBJECT *pointer[ACPI_OBJECTLIST_MAX]; 115 ACPI_OBJECT object[ACPI_OBJECTLIST_MAX]; 116 }; 117 118 static __inline struct acpi_object_list * 119 acpi_AllocObjectList(int nobj) 120 { 121 struct acpi_object_list *l; 122 int i; 123 124 if (nobj > ACPI_OBJECTLIST_MAX) 125 return(NULL); 126 if ((l = AcpiOsAllocate(sizeof(*l))) == NULL) 127 return(NULL); 128 bzero(l, sizeof(*l)); 129 for (i = 0; i < ACPI_OBJECTLIST_MAX; i++) 130 l->pointer[i] = &l->object[i]; 131 l->count = nobj; 132 return(l); 133 } 134 135 /* 136 * Note that the low ivar values are reserved to provide 137 * interface compatibility with ISA drivers which can also 138 * attach to ACPI. 139 */ 140 #define ACPI_IVAR_HANDLE 0x100 141 #define ACPI_IVAR_MAGIC 0x101 142 #define ACPI_IVAR_PRIVATE 0x102 143 144 static __inline ACPI_HANDLE 145 acpi_get_handle(device_t dev) 146 { 147 uintptr_t up; 148 ACPI_HANDLE h; 149 150 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, &up)) 151 return(NULL); 152 h = (ACPI_HANDLE)up; 153 return(h); 154 } 155 156 static __inline int 157 acpi_set_handle(device_t dev, ACPI_HANDLE h) 158 { 159 uintptr_t up; 160 161 up = (uintptr_t)h; 162 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_HANDLE, up)); 163 } 164 165 static __inline int 166 acpi_get_magic(device_t dev) 167 { 168 uintptr_t up; 169 int m; 170 171 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, &up)) 172 return(0); 173 m = (int)up; 174 return(m); 175 } 176 177 static __inline int 178 acpi_set_magic(device_t dev, int m) 179 { 180 uintptr_t up; 181 182 up = (uintptr_t)m; 183 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_MAGIC, up)); 184 } 185 186 static __inline void * 187 acpi_get_private(device_t dev) 188 { 189 uintptr_t up; 190 void *p; 191 192 if (BUS_READ_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, &up)) 193 return(NULL); 194 p = (void *)up; 195 return(p); 196 } 197 198 static __inline int 199 acpi_set_private(device_t dev, void *p) 200 { 201 uintptr_t up; 202 203 up = (uintptr_t)p; 204 return(BUS_WRITE_IVAR(device_get_parent(dev), dev, ACPI_IVAR_PRIVATE, up)); 205 } 206 207 static __inline ACPI_OBJECT_TYPE 208 acpi_get_type(device_t dev) 209 { 210 ACPI_HANDLE h; 211 ACPI_OBJECT_TYPE t; 212 213 if ((h = acpi_get_handle(dev)) == NULL) 214 return(ACPI_TYPE_NOT_FOUND); 215 if (AcpiGetType(h, &t) != AE_OK) 216 return(ACPI_TYPE_NOT_FOUND); 217 return(t); 218 } 219 220 #ifdef ENABLE_DEBUGGER 221 extern void acpi_EnterDebugger(void); 222 #endif 223 224 #ifdef ACPI_DEBUG 225 #include <sys/cons.h> 226 #define STEP(x) do {printf x, printf("\n"); cngetc();} while (0) 227 #else 228 #define STEP(x) 229 #endif 230 231 #define ACPI_VPRINT(dev, acpi_sc, x...) do { \ 232 if (acpi_get_verbose(acpi_sc)) \ 233 device_printf(dev, x); \ 234 } while (0) 235 236 extern BOOLEAN acpi_DeviceIsPresent(device_t dev); 237 extern BOOLEAN acpi_MatchHid(device_t dev, char *hid); 238 extern ACPI_STATUS acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result); 239 extern ACPI_BUFFER *acpi_AllocBuffer(int size); 240 extern ACPI_STATUS acpi_GetIntoBuffer(ACPI_HANDLE handle, 241 ACPI_STATUS (*func)(ACPI_HANDLE, ACPI_BUFFER *), 242 ACPI_BUFFER *buf); 243 extern ACPI_STATUS acpi_GetTableIntoBuffer(ACPI_TABLE_TYPE table, UINT32 instance, ACPI_BUFFER *buf); 244 extern ACPI_STATUS acpi_EvaluateIntoBuffer(ACPI_HANDLE object, ACPI_STRING pathname, 245 ACPI_OBJECT_LIST *params, ACPI_BUFFER *buf); 246 extern ACPI_STATUS acpi_EvaluateInteger(ACPI_HANDLE handle, char *path, int *number); 247 extern ACPI_STATUS acpi_ForeachPackageObject(ACPI_OBJECT *obj, 248 void (* func)(ACPI_OBJECT *comp, void *arg), 249 void *arg); 250 extern ACPI_STATUS acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp); 251 extern ACPI_STATUS acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res); 252 253 extern ACPI_STATUS acpi_SetSleepState(struct acpi_softc *sc, int state); 254 extern ACPI_STATUS acpi_Enable(struct acpi_softc *sc); 255 extern ACPI_STATUS acpi_Disable(struct acpi_softc *sc); 256 257 struct acpi_parse_resource_set { 258 void (* set_init)(device_t dev, void **context); 259 void (* set_done)(device_t dev, void *context); 260 void (* set_ioport)(device_t dev, void *context, u_int32_t base, u_int32_t length); 261 void (* set_iorange)(device_t dev, void *context, u_int32_t low, u_int32_t high, 262 u_int32_t length, u_int32_t align); 263 void (* set_memory)(device_t dev, void *context, u_int32_t base, u_int32_t length); 264 void (* set_memoryrange)(device_t dev, void *context, u_int32_t low, u_int32_t high, 265 u_int32_t length, u_int32_t align); 266 void (* set_irq)(device_t dev, void *context, u_int32_t irq); 267 void (* set_drq)(device_t dev, void *context, u_int32_t drq); 268 void (* set_start_dependant)(device_t dev, void *context, int preference); 269 void (* set_end_dependant)(device_t dev, void *context); 270 }; 271 272 extern struct acpi_parse_resource_set acpi_res_parse_set; 273 extern ACPI_STATUS acpi_parse_resources(device_t dev, ACPI_HANDLE handle, 274 struct acpi_parse_resource_set *set); 275 /* XXX until Intel fix this in their headers, based on NEXT_RESOURCE */ 276 #define ACPI_RESOURCE_NEXT(Res) (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length) 277 278 /* 279 * ACPI event handling 280 */ 281 extern UINT32 acpi_eventhandler_power_button_for_sleep(void *context); 282 extern UINT32 acpi_eventhandler_power_button_for_wakeup(void *context); 283 extern UINT32 acpi_eventhandler_sleep_button_for_sleep(void *context); 284 extern UINT32 acpi_eventhandler_sleep_button_for_wakeup(void *context); 285 286 #define ACPI_EVENT_PRI_FIRST 0 287 #define ACPI_EVENT_PRI_DEFAULT 10000 288 #define ACPI_EVENT_PRI_LAST 20000 289 290 typedef void (*acpi_event_handler_t) __P((void *, int)); 291 292 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t); 293 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t); 294 295 /* 296 * Device power control. 297 */ 298 extern ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state); 299 300 /* 301 * Misc. 302 */ 303 static __inline struct acpi_softc * 304 acpi_device_get_parent_softc(device_t child) 305 { 306 device_t parent; 307 308 parent = device_get_parent(child); 309 if (parent == NULL) { 310 return(NULL); 311 } 312 return(device_get_softc(parent)); 313 } 314 315 static __inline int 316 acpi_get_verbose(struct acpi_softc *sc) 317 { 318 if (sc) 319 return(sc->acpi_verbose); 320 return(0); 321 } 322 323 extern char *acpi_name(ACPI_HANDLE handle); 324 extern int acpi_avoid(ACPI_HANDLE handle); 325 extern int acpi_disabled(char *subsys); 326 327 extern int acpi_machdep_init(device_t dev); 328 extern void acpi_install_wakeup_handler(struct acpi_softc *sc); 329 extern int acpi_sleep_machdep(struct acpi_softc *sc, int state); 330 331 /* 332 * Battery Abstruction. 333 */ 334 struct acpi_battinfo; 335 struct acpi_battdesc; 336 337 extern int acpi_battery_register(int, int); 338 extern int acpi_battery_get_battinfo(int, struct acpi_battinfo *); 339 extern int acpi_battery_get_units(void); 340 extern int acpi_battery_get_info_expire(void); 341 extern int acpi_battery_get_battdesc(int, struct acpi_battdesc *); 342 343 extern int acpi_cmbat_get_battinfo(int, struct acpi_battinfo *); 344 345 /* 346 * AC adapter interface. 347 */ 348 349 extern int acpi_acad_get_acline(int *); 350 351 /* 352 * System power API. 353 * 354 * XXX should this be further generalised? 355 * 356 */ 357 #define POWERPROFILE_PERFORMANCE 0 358 #define POWERPROFILE_ECONOMY 1 359 360 extern int powerprofile_get_state(void); 361 extern void powerprofile_set_state(int state); 362 363 typedef void (*powerprofile_change_hook)(void *); 364 EVENTHANDLER_DECLARE(powerprofile_change, powerprofile_change_hook); 365