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