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 #ifndef _ACPIVAR_H_
  32 #define _ACPIVAR_H_
  33
  34 #ifdef _KERNEL
  35
  36 #include "acpi_if.h"
  37 #include "bus_if.h"
  38 #include <sys/eventhandler.h>
  39 #include <sys/sysctl.h>
  40 #include <sys/lock.h>
  41 #include <sys/mutex.h>
  42 #include <sys/sx.h>
  43
  44 #include <machine/bus.h>
  45 #include <machine/resource.h>
  46
  47 struct acpi_softc {
  48     device_t            acpi_dev;
  49     struct cdev *acpi_dev_t;
  50
  51     struct resource     *acpi_irq;
  52     int                 acpi_irq_rid;
  53     void                *acpi_irq_handle;
  54
  55     int                 acpi_enabled;
  56     int                 acpi_sstate;
  57     int                 acpi_sleep_disabled;
  58
  59     struct sysctl_ctx_list acpi_sysctl_ctx;
  60     struct sysctl_oid   *acpi_sysctl_tree;
  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     int                 acpi_verbose;
  72
  73     bus_dma_tag_t       acpi_waketag;
  74     bus_dmamap_t        acpi_wakemap;
  75     vm_offset_t         acpi_wakeaddr;
  76     vm_paddr_t          acpi_wakephys;
  77 };
  78
  79 struct acpi_device {
  80     /* ACPI ivars */
  81     ACPI_HANDLE                 ad_handle;
  82     int                         ad_magic;
  83     void                        *ad_private;
  84     int                         ad_flags;
  85
  86     /* Resources */
  87     struct resource_list        ad_rl;
  88 };
  89
  90 #define ACPI_PRW_MAX_POWERRES   8
  91
  92 struct acpi_prw_data {
  93     ACPI_HANDLE         gpe_handle;
  94     int                 gpe_bit;
  95     int                 lowest_wake;
  96     ACPI_OBJECT         power_res[ACPI_PRW_MAX_POWERRES];
  97     int                 power_res_count;
  98 };
  99
 100 /* Flags for each device defined in the AML namespace. */
 101 #define ACPI_FLAG_WAKE_ENABLED  0x1
 102
 103 /* Macros for extracting parts of a PCI address from an _ADR value. */
 104 #define ACPI_ADR_PCI_SLOT(adr)  (((adr) & 0xffff0000) >> 16)
 105 #define ACPI_ADR_PCI_FUNC(adr)  ((adr) & 0xffff)
 106
 107 /*
 108  * Entry points to ACPI from above are global functions defined in this
 109  * file, sysctls, and I/O on the control device.  Entry points from below
 110  * are interrupts (the SCI), notifies, task queue threads, and the thermal
 111  * zone polling thread.
 112  *
 113  * ACPI tables and global shared data are protected by a global lock
 114  * (acpi_mutex).
 115  *
 116  * Each ACPI device can have its own driver-specific mutex for protecting
 117  * shared access to local data.  The ACPI_LOCK macros handle mutexes.
 118  *
 119  * Drivers that need to serialize access to functions (e.g., to route
 120  * interrupts, get/set control paths, etc.) should use the sx lock macros
 121  * (ACPI_SERIAL).
 122  *
 123  * ACPI-CA handles its own locking and should not be called with locks held.
 124  *
 125  * The most complicated path is:
 126  *     GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
 127  */
 128 extern struct mtx                       acpi_mutex;
 129 #define ACPI_LOCK(sys)                  mtx_lock(&sys##_mutex)
 130 #define ACPI_UNLOCK(sys)                mtx_unlock(&sys##_mutex)
 131 #define ACPI_LOCK_ASSERT(sys)           mtx_assert(&sys##_mutex, MA_OWNED);
 132 #define ACPI_LOCK_DECL(sys, name)                               \
 133         static struct mtx sys##_mutex;                          \
 134         MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
 135 #define ACPI_SERIAL_BEGIN(sys)          sx_xlock(&sys##_sxlock)
 136 #define ACPI_SERIAL_END(sys)            sx_xunlock(&sys##_sxlock)
 137 #define ACPI_SERIAL_ASSERT(sys)         sx_assert(&sys##_sxlock, SX_XLOCKED);
 138 #define ACPI_SERIAL_DECL(sys, name)                             \
 139         static struct sx sys##_sxlock;                          \
 140         SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
 141
 142 /*
 143  * ACPI CA does not define layers for non-ACPI CA drivers.
 144  * We define some here within the range provided.
 145  */
 146 #define ACPI_AC_ADAPTER         0x00010000
 147 #define ACPI_BATTERY            0x00020000
 148 #define ACPI_BUS                0x00040000
 149 #define ACPI_BUTTON             0x00080000
 150 #define ACPI_EC                 0x00100000
 151 #define ACPI_FAN                0x00200000
 152 #define ACPI_POWERRES           0x00400000
 153 #define ACPI_PROCESSOR          0x00800000
 154 #define ACPI_THERMAL            0x01000000
 155 #define ACPI_TIMER              0x02000000
 156 #define ACPI_OEM                0x04000000
 157
 158 /*
 159  * Constants for different interrupt models used with acpi_SetIntrModel().
 160  */
 161 #define ACPI_INTR_PIC           0
 162 #define ACPI_INTR_APIC          1
 163 #define ACPI_INTR_SAPIC         2
 164
 165 /*
 166  * Various features and capabilities for the acpi_get_features() method.
 167  * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
 168  * See the Intel document titled "Processor Driver Capabilities Bit
 169  * Definitions", number 302223-002.
 170  */
 171 #define ACPI_CAP_PERF_MSRS      (1 << 0) /* Intel SpeedStep PERF_CTL MSRs */
 172 #define ACPI_CAP_C1_IO_HALT     (1 << 1) /* Intel C1 "IO then halt" sequence */
 173 #define ACPI_CAP_THR_MSRS       (1 << 2) /* Intel OnDemand throttling MSRs */
 174 #define ACPI_CAP_SMP_SAME       (1 << 3) /* MP C1, Px, and Tx (all the same) */
 175 #define ACPI_CAP_SMP_SAME_C3    (1 << 4) /* MP C2 and C3 (all the same) */
 176 #define ACPI_CAP_SMP_DIFF_PX    (1 << 5) /* MP Px (different, using _PSD) */
 177 #define ACPI_CAP_SMP_DIFF_CX    (1 << 6) /* MP Cx (different, using _CSD) */
 178 #define ACPI_CAP_SMP_DIFF_TX    (1 << 7) /* MP Tx (different, using _TSD) */
 179 #define ACPI_CAP_SMP_C1_NATIVE  (1 << 8) /* MP C1 support other than halt */
 180
 181 /*
 182  * Quirk flags.
 183  *
 184  * ACPI_Q_BROKEN: Disables all ACPI support.
 185  * ACPI_Q_TIMER: Disables support for the ACPI timer.
 186  * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
 187  *      first APIC and that the MADT should force that by ignoring the PC-AT
 188  *      compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
 189  */
 190 extern int      acpi_quirks;
 191 #define ACPI_Q_OK               0
 192 #define ACPI_Q_BROKEN           (1 << 0)
 193 #define ACPI_Q_TIMER            (1 << 1)
 194 #define ACPI_Q_MADT_IRQ0        (1 << 2)
 195
 196 /*
 197  * Note that the low ivar values are reserved to provide
 198  * interface compatibility with ISA drivers which can also
 199  * attach to ACPI.
 200  */
 201 #define ACPI_IVAR_HANDLE        0x100
 202 #define ACPI_IVAR_MAGIC         0x101
 203 #define ACPI_IVAR_PRIVATE       0x102
 204 #define ACPI_IVAR_FLAGS         0x103
 205
 206 /*
 207  * Accessor functions for our ivars.  Default value for BUS_READ_IVAR is
 208  * (type) 0.  The <sys/bus.h> accessor functions don't check return values.
 209  */
 210 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type)       \
 211                                                                 \
 212 static __inline type varp ## _get_ ## var(device_t dev)         \
 213 {                                                               \
 214     uintptr_t v = 0;                                            \
 215     BUS_READ_IVAR(device_get_parent(dev), dev,                  \
 216         ivarp ## _IVAR_ ## ivar, &v);                           \
 217     return ((type) v);                                          \
 218 }                                                               \
 219                                                                 \
 220 static __inline void varp ## _set_ ## var(device_t dev, type t) \
 221 {                                                               \
 222     uintptr_t v = (uintptr_t) t;                                \
 223     BUS_WRITE_IVAR(device_get_parent(dev), dev,                 \
 224         ivarp ## _IVAR_ ## ivar, v);                            \
 225 }
 226
 227 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
 228 __ACPI_BUS_ACCESSOR(acpi, magic, ACPI, MAGIC, int)
 229 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
 230 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
 231
 232 void acpi_fake_objhandler(ACPI_HANDLE h, UINT32 fn, void *data);
 233 static __inline device_t
 234 acpi_get_device(ACPI_HANDLE handle)
 235 {
 236     void *dev = NULL;
 237     AcpiGetData(handle, acpi_fake_objhandler, &dev);
 238     return ((device_t)dev);
 239 }
 240
 241 static __inline ACPI_OBJECT_TYPE
 242 acpi_get_type(device_t dev)
 243 {
 244     ACPI_HANDLE         h;
 245     ACPI_OBJECT_TYPE    t;
 246
 247     if ((h = acpi_get_handle(dev)) == NULL)
 248         return (ACPI_TYPE_NOT_FOUND);
 249     if (AcpiGetType(h, &t) != AE_OK)
 250         return (ACPI_TYPE_NOT_FOUND);
 251     return (t);
 252 }
 253
 254 #ifdef ACPI_DEBUGGER
 255 void            acpi_EnterDebugger(void);
 256 #endif
 257
 258 #ifdef ACPI_DEBUG
 259 #include <sys/cons.h>
 260 #define STEP(x)         do {printf x, printf("\n"); cngetc();} while (0)
 261 #else
 262 #define STEP(x)
 263 #endif
 264
 265 #define ACPI_VPRINT(dev, acpi_sc, x...) do {                    \
 266     if (acpi_get_verbose(acpi_sc))                              \
 267         device_printf(dev, x);                                  \
 268 } while (0)
 269
 270 /* Values for the device _STA (status) method. */
 271 #define ACPI_STA_PRESENT        (1 << 0)
 272 #define ACPI_STA_ENABLED        (1 << 1)
 273 #define ACPI_STA_SHOW_IN_UI     (1 << 2)
 274 #define ACPI_STA_FUNCTIONAL     (1 << 3)
 275 #define ACPI_STA_BATT_PRESENT   (1 << 4)
 276
 277 #define ACPI_DEVINFO_PRESENT(x, flags)                                  \
 278         (((x) & (flags)) == (flags))
 279 #define ACPI_DEVICE_PRESENT(x)                                          \
 280         ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL)
 281 #define ACPI_BATTERY_PRESENT(x)                                         \
 282         ACPI_DEVINFO_PRESENT(x, ACPI_STA_PRESENT | ACPI_STA_FUNCTIONAL | \
 283             ACPI_STA_BATT_PRESENT)
 284
 285 BOOLEAN         acpi_DeviceIsPresent(device_t dev);
 286 BOOLEAN         acpi_BatteryIsPresent(device_t dev);
 287 ACPI_STATUS     acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
 288                     ACPI_HANDLE *result);
 289 uint32_t        acpi_TimerDelta(uint32_t end, uint32_t start);
 290 ACPI_BUFFER     *acpi_AllocBuffer(int size);
 291 ACPI_STATUS     acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
 292                     UINT32 *number);
 293 ACPI_STATUS     acpi_GetInteger(ACPI_HANDLE handle, char *path,
 294                     UINT32 *number);
 295 ACPI_STATUS     acpi_SetInteger(ACPI_HANDLE handle, char *path,
 296                     UINT32 number);
 297 ACPI_STATUS     acpi_ForeachPackageObject(ACPI_OBJECT *obj,
 298                     void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
 299 ACPI_STATUS     acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
 300                     ACPI_RESOURCE **resp);
 301 ACPI_STATUS     acpi_AppendBufferResource(ACPI_BUFFER *buf,
 302                     ACPI_RESOURCE *res);
 303 ACPI_STATUS     acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
 304 ACPI_STATUS     acpi_SetIntrModel(int model);
 305 ACPI_STATUS     acpi_SetSleepState(struct acpi_softc *sc, int state);
 306 int             acpi_wake_init(device_t dev, int type);
 307 int             acpi_wake_set_enable(device_t dev, int enable);
 308 int             acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
 309 ACPI_STATUS     acpi_Startup(void);
 310 void            acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
 311                     uint8_t notify);
 312 int             acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
 313                     ACPI_GENERIC_ADDRESS *gas, struct resource **res);
 314
 315 struct acpi_parse_resource_set {
 316     void        (*set_init)(device_t dev, void *arg, void **context);
 317     void        (*set_done)(device_t dev, void *context);
 318     void        (*set_ioport)(device_t dev, void *context, uint32_t base,
 319                     uint32_t length);
 320     void        (*set_iorange)(device_t dev, void *context, uint32_t low,
 321                     uint32_t high, uint32_t length, uint32_t align);
 322     void        (*set_memory)(device_t dev, void *context, uint32_t base,
 323                     uint32_t length);
 324     void        (*set_memoryrange)(device_t dev, void *context, uint32_t low,
 325                     uint32_t high, uint32_t length, uint32_t align);
 326     void        (*set_irq)(device_t dev, void *context, u_int8_t *irq,
 327                     int count, int trig, int pol);
 328     void        (*set_ext_irq)(device_t dev, void *context, u_int32_t *irq,
 329                     int count, int trig, int pol);
 330     void        (*set_drq)(device_t dev, void *context, u_int8_t *drq,
 331                     int count);
 332     void        (*set_start_dependent)(device_t dev, void *context,
 333                     int preference);
 334     void        (*set_end_dependent)(device_t dev, void *context);
 335 };
 336
 337 extern struct   acpi_parse_resource_set acpi_res_parse_set;
 338
 339 void            acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
 340 ACPI_STATUS     acpi_lookup_irq_resource(device_t dev, int rid,
 341                     struct resource *res, ACPI_RESOURCE *acpi_res);
 342 ACPI_STATUS     acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
 343                     struct acpi_parse_resource_set *set, void *arg);
 344
 345 /* ACPI event handling */
 346 UINT32          acpi_event_power_button_sleep(void *context);
 347 UINT32          acpi_event_power_button_wake(void *context);
 348 UINT32          acpi_event_sleep_button_sleep(void *context);
 349 UINT32          acpi_event_sleep_button_wake(void *context);
 350
 351 #define ACPI_EVENT_PRI_FIRST      0
 352 #define ACPI_EVENT_PRI_DEFAULT    10000
 353 #define ACPI_EVENT_PRI_LAST       20000
 354
 355 typedef void (*acpi_event_handler_t)(void *, int);
 356
 357 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
 358 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
 359
 360 /* Device power control. */
 361 ACPI_STATUS     acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
 362 ACPI_STATUS     acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
 363
 364 /* Misc. */
 365 static __inline struct acpi_softc *
 366 acpi_device_get_parent_softc(device_t child)
 367 {
 368     device_t    parent;
 369
 370     parent = device_get_parent(child);
 371     if (parent == NULL)
 372         return (NULL);
 373     return (device_get_softc(parent));
 374 }
 375
 376 static __inline int
 377 acpi_get_verbose(struct acpi_softc *sc)
 378 {
 379     if (sc)
 380         return (sc->acpi_verbose);
 381     return (0);
 382 }
 383
 384 char            *acpi_name(ACPI_HANDLE handle);
 385 int             acpi_avoid(ACPI_HANDLE handle);
 386 int             acpi_disabled(char *subsys);
 387 int             acpi_machdep_init(device_t dev);
 388 void            acpi_install_wakeup_handler(struct acpi_softc *sc);
 389 int             acpi_sleep_machdep(struct acpi_softc *sc, int state);
 390 int             acpi_table_quirks(int *quirks);
 391 int             acpi_machdep_quirks(int *quirks);
 392
 393 /* Battery Abstraction. */
 394 struct acpi_battinfo;
 395
 396 int             acpi_battery_register(device_t dev);
 397 int             acpi_battery_remove(device_t dev);
 398 int             acpi_battery_get_units(void);
 399 int             acpi_battery_get_info_expire(void);
 400 int             acpi_battery_bst_valid(struct acpi_bst *bst);
 401 int             acpi_battery_bif_valid(struct acpi_bif *bif);
 402 int             acpi_battery_get_battinfo(device_t dev,
 403                     struct acpi_battinfo *info);
 404
 405 /* Embedded controller. */
 406 void            acpi_ec_ecdt_probe(device_t);
 407
 408 /* AC adapter interface. */
 409 int             acpi_acad_get_acline(int *);
 410
 411 /* Package manipulation convenience functions. */
 412 #define ACPI_PKG_VALID(pkg, size)                               \
 413     ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE &&       \
 414      (pkg)->Package.Count >= (size))
 415 int             acpi_PkgInt(ACPI_OBJECT *res, int idx, ACPI_INTEGER *dst);
 416 int             acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
 417 int             acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
 418 int             acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
 419                     int *rid, struct resource **dst);
 420 ACPI_HANDLE     acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
 421
 422 /* Default number of task queue threads to start. */
 423 #define ACPI_MAX_THREADS        3
 424
 425 #endif /* _KERNEL */
 426 #endif /* !_ACPIVAR_H_ */