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