sys/dev/acpica/acpivar.h

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