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