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 #ifdef INTRNG
  40 #include <sys/intr.h>
  41 #endif
  42 #include <sys/ktr.h>
  43 #include <sys/lock.h>
  44 #include <sys/mutex.h>
  45 #include <sys/selinfo.h>
  46 #include <sys/sx.h>
  47 #include <sys/sysctl.h>
  48
  49 #include <machine/bus.h>
  50 #include <machine/resource.h>
  51
  52 struct apm_clone_data;
  53 struct acpi_softc {
  54     device_t            acpi_dev;
  55     struct cdev         *acpi_dev_t;
  56
  57     int                 acpi_enabled;
  58     int                 acpi_sstate;
  59     int                 acpi_sleep_disabled;
  60     int                 acpi_resources_reserved;
  61
  62     struct sysctl_ctx_list acpi_sysctl_ctx;
  63     struct sysctl_oid   *acpi_sysctl_tree;
  64     int                 acpi_power_button_sx;
  65     int                 acpi_sleep_button_sx;
  66     int                 acpi_lid_switch_sx;
  67
  68     int                 acpi_standby_sx;
  69     int                 acpi_suspend_sx;
  70
  71     int                 acpi_sleep_delay;
  72     int                 acpi_s4bios;
  73     int                 acpi_do_disable;
  74     int                 acpi_verbose;
  75     int                 acpi_handle_reboot;
  76
  77     vm_offset_t         acpi_wakeaddr;
  78     vm_paddr_t          acpi_wakephys;
  79
  80     int                 acpi_next_sstate;       /* Next suspend Sx state. */
  81     struct apm_clone_data *acpi_clone;          /* Pseudo-dev for devd(8). */
  82     STAILQ_HEAD(,apm_clone_data) apm_cdevs;     /* All apm/apmctl/acpi cdevs. */
  83     struct callout      susp_force_to;          /* Force suspend if no acks. */
  84 };
  85
  86 struct acpi_device {
  87     /* ACPI ivars */
  88     ACPI_HANDLE                 ad_handle;
  89     void                        *ad_private;
  90     int                         ad_flags;
  91     int                         ad_cls_class;
  92
  93     ACPI_BUFFER                 dsd;    /* Device Specific Data */
  94     const ACPI_OBJECT   *dsd_pkg;
  95
  96     /* Resources */
  97     struct resource_list        ad_rl;
  98 };
  99
 100 #ifdef INTRNG
 101 struct intr_map_data_acpi {
 102         struct intr_map_data    hdr;
 103         u_int                   irq;
 104         u_int                   pol;
 105         u_int                   trig;
 106 };
 107
 108 #endif
 109
 110 /* Track device (/dev/{apm,apmctl} and /dev/acpi) notification status. */
 111 struct apm_clone_data {
 112     STAILQ_ENTRY(apm_clone_data) entries;
 113     struct cdev         *cdev;
 114     int                 flags;
 115 #define ACPI_EVF_NONE   0       /* /dev/apm semantics */
 116 #define ACPI_EVF_DEVD   1       /* /dev/acpi is handled via devd(8) */
 117 #define ACPI_EVF_WRITE  2       /* Device instance is opened writable. */
 118     int                 notify_status;
 119 #define APM_EV_NONE     0       /* Device not yet aware of pending sleep. */
 120 #define APM_EV_NOTIFIED 1       /* Device saw next sleep state. */
 121 #define APM_EV_ACKED    2       /* Device agreed sleep can occur. */
 122     struct acpi_softc   *acpi_sc;
 123     struct selinfo      sel_read;
 124 };
 125
 126 #define ACPI_PRW_MAX_POWERRES   8
 127
 128 struct acpi_prw_data {
 129     ACPI_HANDLE         gpe_handle;
 130     int                 gpe_bit;
 131     int                 lowest_wake;
 132     ACPI_OBJECT         power_res[ACPI_PRW_MAX_POWERRES];
 133     int                 power_res_count;
 134 };
 135
 136 /* Flags for each device defined in the AML namespace. */
 137 #define ACPI_FLAG_WAKE_ENABLED  0x1
 138
 139 /* Macros for extracting parts of a PCI address from an _ADR value. */
 140 #define ACPI_ADR_PCI_SLOT(adr)  (((adr) & 0xffff0000) >> 16)
 141 #define ACPI_ADR_PCI_FUNC(adr)  ((adr) & 0xffff)
 142
 143 /*
 144  * Entry points to ACPI from above are global functions defined in this
 145  * file, sysctls, and I/O on the control device.  Entry points from below
 146  * are interrupts (the SCI), notifies, task queue threads, and the thermal
 147  * zone polling thread.
 148  *
 149  * ACPI tables and global shared data are protected by a global lock
 150  * (acpi_mutex).
 151  *
 152  * Each ACPI device can have its own driver-specific mutex for protecting
 153  * shared access to local data.  The ACPI_LOCK macros handle mutexes.
 154  *
 155  * Drivers that need to serialize access to functions (e.g., to route
 156  * interrupts, get/set control paths, etc.) should use the sx lock macros
 157  * (ACPI_SERIAL).
 158  *
 159  * ACPI-CA handles its own locking and should not be called with locks held.
 160  *
 161  * The most complicated path is:
 162  *     GPE -> EC runs _Qxx -> _Qxx reads EC space -> GPE
 163  */
 164 extern struct mtx                       acpi_mutex;
 165 #define ACPI_LOCK(sys)                  mtx_lock(&sys##_mutex)
 166 #define ACPI_UNLOCK(sys)                mtx_unlock(&sys##_mutex)
 167 #define ACPI_LOCK_ASSERT(sys)           mtx_assert(&sys##_mutex, MA_OWNED);
 168 #define ACPI_LOCK_DECL(sys, name)                               \
 169         static struct mtx sys##_mutex;                          \
 170         MTX_SYSINIT(sys##_mutex, &sys##_mutex, name, MTX_DEF)
 171 #define ACPI_SERIAL_BEGIN(sys)          sx_xlock(&sys##_sxlock)
 172 #define ACPI_SERIAL_END(sys)            sx_xunlock(&sys##_sxlock)
 173 #define ACPI_SERIAL_ASSERT(sys)         sx_assert(&sys##_sxlock, SX_XLOCKED);
 174 #define ACPI_SERIAL_DECL(sys, name)                             \
 175         static struct sx sys##_sxlock;                          \
 176         SX_SYSINIT(sys##_sxlock, &sys##_sxlock, name)
 177
 178 /*
 179  * ACPI CA does not define layers for non-ACPI CA drivers.
 180  * We define some here within the range provided.
 181  */
 182 #define ACPI_AC_ADAPTER         0x00010000
 183 #define ACPI_BATTERY            0x00020000
 184 #define ACPI_BUS                0x00040000
 185 #define ACPI_BUTTON             0x00080000
 186 #define ACPI_EC                 0x00100000
 187 #define ACPI_FAN                0x00200000
 188 #define ACPI_POWERRES           0x00400000
 189 #define ACPI_PROCESSOR          0x00800000
 190 #define ACPI_THERMAL            0x01000000
 191 #define ACPI_TIMER              0x02000000
 192 #define ACPI_OEM                0x04000000
 193
 194 /*
 195  * Constants for different interrupt models used with acpi_SetIntrModel().
 196  */
 197 #define ACPI_INTR_PIC           0
 198 #define ACPI_INTR_APIC          1
 199 #define ACPI_INTR_SAPIC         2
 200
 201 /*
 202  * Various features and capabilities for the acpi_get_features() method.
 203  * In particular, these are used for the ACPI 3.0 _PDC and _OSC methods.
 204  * See the Intel document titled "Intel Processor Vendor-Specific ACPI",
 205  * number 302223-007.
 206  */
 207 #define ACPI_CAP_PERF_MSRS      (1 << 0)  /* Intel SpeedStep PERF_CTL MSRs */
 208 #define ACPI_CAP_C1_IO_HALT     (1 << 1)  /* Intel C1 "IO then halt" sequence */
 209 #define ACPI_CAP_THR_MSRS       (1 << 2)  /* Intel OnDemand throttling MSRs */
 210 #define ACPI_CAP_SMP_SAME       (1 << 3)  /* MP C1, Px, and Tx (all the same) */
 211 #define ACPI_CAP_SMP_SAME_C3    (1 << 4)  /* MP C2 and C3 (all the same) */
 212 #define ACPI_CAP_SMP_DIFF_PX    (1 << 5)  /* MP Px (different, using _PSD) */
 213 #define ACPI_CAP_SMP_DIFF_CX    (1 << 6)  /* MP Cx (different, using _CSD) */
 214 #define ACPI_CAP_SMP_DIFF_TX    (1 << 7)  /* MP Tx (different, using _TSD) */
 215 #define ACPI_CAP_SMP_C1_NATIVE  (1 << 8)  /* MP C1 support other than halt */
 216 #define ACPI_CAP_SMP_C3_NATIVE  (1 << 9)  /* MP C2 and C3 support */
 217 #define ACPI_CAP_PX_HW_COORD    (1 << 11) /* Intel P-state HW coordination */
 218 #define ACPI_CAP_INTR_CPPC      (1 << 12) /* Native Interrupt Handling for
 219              Collaborative Processor Performance Control notifications */
 220 #define ACPI_CAP_HW_DUTY_C      (1 << 13) /* Hardware Duty Cycling */
 221
 222 /*
 223  * Quirk flags.
 224  *
 225  * ACPI_Q_BROKEN: Disables all ACPI support.
 226  * ACPI_Q_TIMER: Disables support for the ACPI timer.
 227  * ACPI_Q_MADT_IRQ0: Specifies that ISA IRQ 0 is wired up to pin 0 of the
 228  *      first APIC and that the MADT should force that by ignoring the PC-AT
 229  *      compatible flag and ignoring overrides that redirect IRQ 0 to pin 2.
 230  */
 231 extern int      acpi_quirks;
 232 #define ACPI_Q_OK               0
 233 #define ACPI_Q_BROKEN           (1 << 0)
 234 #define ACPI_Q_TIMER            (1 << 1)
 235 #define ACPI_Q_MADT_IRQ0        (1 << 2)
 236
 237 /*
 238  * Plug and play information for device matching.  Matching table format
 239  * is compatible with ids parameter of ACPI_ID_PROBE bus method.
 240  *
 241  * XXX: While ACPI_ID_PROBE matches against _HID and all _CIDs, current
 242  *      acpi_pnpinfo() exports only _HID and first _CID.  That means second
 243  *      and further _CIDs should be added to both acpi_pnpinfo() and
 244  *      ACPICOMPAT_PNP_INFO if device matching against them is required.
 245  */
 246 #define ACPICOMPAT_PNP_INFO(t, busname)                                 \
 247         MODULE_PNP_INFO("Z:_HID", busname, t##hid, t, nitems(t)-1);     \
 248         MODULE_PNP_INFO("Z:_CID", busname, t##cid, t, nitems(t)-1);
 249 #define ACPI_PNP_INFO(t)        ACPICOMPAT_PNP_INFO(t, acpi)
 250
 251 /*
 252  * Note that the low ivar values are reserved to provide
 253  * interface compatibility with ISA drivers which can also
 254  * attach to ACPI.
 255  */
 256 #define ACPI_IVAR_HANDLE        0x100
 257 #define ACPI_IVAR_UNUSED        0x101   /* Unused/reserved. */
 258 #define ACPI_IVAR_PRIVATE       0x102
 259 #define ACPI_IVAR_FLAGS         0x103
 260
 261 /*
 262  * Accessor functions for our ivars.  Default value for BUS_READ_IVAR is
 263  * (type) 0.  The <sys/bus.h> accessor functions don't check return values.
 264  */
 265 #define __ACPI_BUS_ACCESSOR(varp, var, ivarp, ivar, type)       \
 266                                                                 \
 267 static __inline type varp ## _get_ ## var(device_t dev)         \
 268 {                                                               \
 269     uintptr_t v = 0;                                            \
 270     BUS_READ_IVAR(device_get_parent(dev), dev,                  \
 271         ivarp ## _IVAR_ ## ivar, &v);                           \
 272     return ((type) v);                                          \
 273 }                                                               \
 274                                                                 \
 275 static __inline void varp ## _set_ ## var(device_t dev, type t) \
 276 {                                                               \
 277     uintptr_t v = (uintptr_t) t;                                \
 278     BUS_WRITE_IVAR(device_get_parent(dev), dev,                 \
 279         ivarp ## _IVAR_ ## ivar, v);                            \
 280 }
 281
 282 __ACPI_BUS_ACCESSOR(acpi, handle, ACPI, HANDLE, ACPI_HANDLE)
 283 __ACPI_BUS_ACCESSOR(acpi, private, ACPI, PRIVATE, void *)
 284 __ACPI_BUS_ACCESSOR(acpi, flags, ACPI, FLAGS, int)
 285
 286 void acpi_fake_objhandler(ACPI_HANDLE h, void *data);
 287 static __inline device_t
 288 acpi_get_device(ACPI_HANDLE handle)
 289 {
 290     void *dev = NULL;
 291     AcpiGetData(handle, acpi_fake_objhandler, &dev);
 292     return ((device_t)dev);
 293 }
 294
 295 static __inline ACPI_OBJECT_TYPE
 296 acpi_get_type(device_t dev)
 297 {
 298     ACPI_HANDLE         h;
 299     ACPI_OBJECT_TYPE    t;
 300
 301     if ((h = acpi_get_handle(dev)) == NULL)
 302         return (ACPI_TYPE_NOT_FOUND);
 303     if (ACPI_FAILURE(AcpiGetType(h, &t)))
 304         return (ACPI_TYPE_NOT_FOUND);
 305     return (t);
 306 }
 307
 308 /* Find the difference between two PM tick counts. */
 309 static __inline uint32_t
 310 acpi_TimerDelta(uint32_t end, uint32_t start)
 311 {
 312
 313         if (end < start && (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
 314                 end |= 0x01000000;
 315         return (end - start);
 316 }
 317
 318 #ifdef ACPI_DEBUGGER
 319 void            acpi_EnterDebugger(void);
 320 #endif
 321
 322 #ifdef ACPI_DEBUG
 323 #include <sys/cons.h>
 324 #define STEP(x)         do {printf x, printf("\n"); cngetc();} while (0)
 325 #else
 326 #define STEP(x)
 327 #endif
 328
 329 #define ACPI_VPRINT(dev, acpi_sc, x...) do {                    \
 330     if (acpi_get_verbose(acpi_sc))                              \
 331         device_printf(dev, x);                                  \
 332 } while (0)
 333
 334 /* Values for the first status word returned by _OSC. */
 335 #define ACPI_OSC_FAILURE        (1 << 1)
 336 #define ACPI_OSC_BAD_UUID       (1 << 2)
 337 #define ACPI_OSC_BAD_REVISION   (1 << 3)
 338 #define ACPI_OSC_CAPS_MASKED    (1 << 4)
 339
 340 #define ACPI_DEVINFO_PRESENT(x, flags)                                  \
 341         (((x) & (flags)) == (flags))
 342 #define ACPI_DEVICE_PRESENT(x)                                          \
 343         ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT |               \
 344             ACPI_STA_DEVICE_FUNCTIONING)
 345 #define ACPI_BATTERY_PRESENT(x)                                         \
 346         ACPI_DEVINFO_PRESENT(x, ACPI_STA_DEVICE_PRESENT |               \
 347             ACPI_STA_DEVICE_FUNCTIONING | ACPI_STA_BATTERY_PRESENT)
 348
 349 /* Callback function type for walking subtables within a table. */
 350 typedef void acpi_subtable_handler(ACPI_SUBTABLE_HEADER *, void *);
 351
 352 BOOLEAN         acpi_DeviceIsPresent(device_t dev);
 353 BOOLEAN         acpi_BatteryIsPresent(device_t dev);
 354 ACPI_STATUS     acpi_GetHandleInScope(ACPI_HANDLE parent, char *path,
 355                     ACPI_HANDLE *result);
 356 ACPI_STATUS     acpi_GetProperty(device_t dev, ACPI_STRING propname,
 357                     const ACPI_OBJECT **value);
 358 ACPI_BUFFER     *acpi_AllocBuffer(int size);
 359 ACPI_STATUS     acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp,
 360                     UINT32 *number);
 361 ACPI_STATUS     acpi_GetInteger(ACPI_HANDLE handle, char *path,
 362                     UINT32 *number);
 363 ACPI_STATUS     acpi_SetInteger(ACPI_HANDLE handle, char *path,
 364                     UINT32 number);
 365 ACPI_STATUS     acpi_ForeachPackageObject(ACPI_OBJECT *obj,
 366                     void (*func)(ACPI_OBJECT *comp, void *arg), void *arg);
 367 ACPI_STATUS     acpi_FindIndexedResource(ACPI_BUFFER *buf, int index,
 368                     ACPI_RESOURCE **resp);
 369 ACPI_STATUS     acpi_AppendBufferResource(ACPI_BUFFER *buf,
 370                     ACPI_RESOURCE *res);
 371 UINT64          acpi_DSMQuery(ACPI_HANDLE h, const uint8_t *uuid,
 372                     int revision);
 373 ACPI_STATUS     acpi_EvaluateDSM(ACPI_HANDLE handle, const uint8_t *uuid,
 374                     int revision, UINT64 function, ACPI_OBJECT *package,
 375                     ACPI_BUFFER *out_buf);
 376 ACPI_STATUS     acpi_EvaluateDSMTyped(ACPI_HANDLE handle,
 377                     const uint8_t *uuid, int revision, UINT64 function,
 378                     ACPI_OBJECT *package, ACPI_BUFFER *out_buf,
 379                     ACPI_OBJECT_TYPE type);
 380 ACPI_STATUS     acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid,
 381                     int revision, int count, uint32_t *caps_in,
 382                     uint32_t *caps_out, bool query);
 383 ACPI_STATUS     acpi_OverrideInterruptLevel(UINT32 InterruptNumber);
 384 ACPI_STATUS     acpi_SetIntrModel(int model);
 385 int             acpi_ReqSleepState(struct acpi_softc *sc, int state);
 386 int             acpi_AckSleepState(struct apm_clone_data *clone, int error);
 387 ACPI_STATUS     acpi_SetSleepState(struct acpi_softc *sc, int state);
 388 int             acpi_wake_set_enable(device_t dev, int enable);
 389 int             acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw);
 390 ACPI_STATUS     acpi_Startup(void);
 391 void            acpi_UserNotify(const char *subsystem, ACPI_HANDLE h,
 392                     uint8_t notify);
 393 int             acpi_bus_alloc_gas(device_t dev, int *type, int *rid,
 394                     ACPI_GENERIC_ADDRESS *gas, struct resource **res,
 395                     u_int flags);
 396 void            acpi_walk_subtables(void *first, void *end,
 397                     acpi_subtable_handler *handler, void *arg);
 398 BOOLEAN         acpi_has_hid(ACPI_HANDLE handle);
 399 int             acpi_MatchHid(ACPI_HANDLE h, const char *hid);
 400 #define ACPI_MATCHHID_NOMATCH 0
 401 #define ACPI_MATCHHID_HID 1
 402 #define ACPI_MATCHHID_CID 2
 403
 404 static __inline bool
 405 acpi_HasProperty(device_t dev, ACPI_STRING propname)
 406 {
 407
 408         return ACPI_SUCCESS(acpi_GetProperty(dev, propname, NULL));
 409 }
 410
 411 struct acpi_parse_resource_set {
 412     void        (*set_init)(device_t dev, void *arg, void **context);
 413     void        (*set_done)(device_t dev, void *context);
 414     void        (*set_ioport)(device_t dev, void *context, uint64_t base,
 415                     uint64_t length);
 416     void        (*set_iorange)(device_t dev, void *context, uint64_t low,
 417                     uint64_t high, uint64_t length, uint64_t align);
 418     void        (*set_memory)(device_t dev, void *context, uint64_t base,
 419                     uint64_t length);
 420     void        (*set_memoryrange)(device_t dev, void *context, uint64_t low,
 421                     uint64_t high, uint64_t length, uint64_t align);
 422     void        (*set_irq)(device_t dev, void *context, uint8_t *irq,
 423                     int count, int trig, int pol);
 424     void        (*set_ext_irq)(device_t dev, void *context, uint32_t *irq,
 425                     int count, int trig, int pol);
 426     void        (*set_drq)(device_t dev, void *context, uint8_t *drq,
 427                     int count);
 428     void        (*set_start_dependent)(device_t dev, void *context,
 429                     int preference);
 430     void        (*set_end_dependent)(device_t dev, void *context);
 431 };
 432
 433 extern struct   acpi_parse_resource_set acpi_res_parse_set;
 434
 435 int             acpi_identify(void);
 436 void            acpi_config_intr(device_t dev, ACPI_RESOURCE *res);
 437 #ifdef INTRNG
 438 int             acpi_map_intr(device_t dev, u_int irq, ACPI_HANDLE handle);
 439 #endif
 440 ACPI_STATUS     acpi_lookup_irq_resource(device_t dev, int rid,
 441                     struct resource *res, ACPI_RESOURCE *acpi_res);
 442 ACPI_STATUS     acpi_parse_resources(device_t dev, ACPI_HANDLE handle,
 443                     struct acpi_parse_resource_set *set, void *arg);
 444 struct resource *acpi_alloc_sysres(device_t child, int type, int *rid,
 445                     rman_res_t start, rman_res_t end, rman_res_t count,
 446                     u_int flags);
 447
 448 /* ACPI event handling */
 449 UINT32          acpi_event_power_button_sleep(void *context);
 450 UINT32          acpi_event_power_button_wake(void *context);
 451 UINT32          acpi_event_sleep_button_sleep(void *context);
 452 UINT32          acpi_event_sleep_button_wake(void *context);
 453
 454 #define ACPI_EVENT_PRI_FIRST      0
 455 #define ACPI_EVENT_PRI_DEFAULT    10000
 456 #define ACPI_EVENT_PRI_LAST       20000
 457
 458 typedef void (*acpi_event_handler_t)(void *, int);
 459
 460 EVENTHANDLER_DECLARE(acpi_sleep_event, acpi_event_handler_t);
 461 EVENTHANDLER_DECLARE(acpi_wakeup_event, acpi_event_handler_t);
 462 EVENTHANDLER_DECLARE(acpi_acad_event, acpi_event_handler_t);
 463 EVENTHANDLER_DECLARE(acpi_video_event, acpi_event_handler_t);
 464
 465 /* Device power control. */
 466 ACPI_STATUS     acpi_pwr_wake_enable(ACPI_HANDLE consumer, int enable);
 467 ACPI_STATUS     acpi_pwr_switch_consumer(ACPI_HANDLE consumer, int state);
 468 int             acpi_device_pwr_for_sleep(device_t bus, device_t dev,
 469                     int *dstate);
 470 int             acpi_set_powerstate(device_t child, int state);
 471
 472 /* APM emulation */
 473 void            acpi_apm_init(struct acpi_softc *);
 474
 475 /* Misc. */
 476 static __inline struct acpi_softc *
 477 acpi_device_get_parent_softc(device_t child)
 478 {
 479     device_t    parent;
 480
 481     parent = device_get_parent(child);
 482     if (parent == NULL)
 483         return (NULL);
 484     return (device_get_softc(parent));
 485 }
 486
 487 static __inline int
 488 acpi_get_verbose(struct acpi_softc *sc)
 489 {
 490     if (sc)
 491         return (sc->acpi_verbose);
 492     return (0);
 493 }
 494
 495 char            *acpi_name(ACPI_HANDLE handle);
 496 int             acpi_avoid(ACPI_HANDLE handle);
 497 int             acpi_disabled(char *subsys);
 498 int             acpi_machdep_init(device_t dev);
 499 void            acpi_install_wakeup_handler(struct acpi_softc *sc);
 500 int             acpi_sleep_machdep(struct acpi_softc *sc, int state);
 501 int             acpi_wakeup_machdep(struct acpi_softc *sc, int state,
 502                     int sleep_result, int intr_enabled);
 503 int             acpi_table_quirks(int *quirks);
 504 int             acpi_machdep_quirks(int *quirks);
 505 int             acpi_pnpinfo(ACPI_HANDLE handle, struct sbuf *sb);
 506
 507 uint32_t        hpet_get_uid(device_t dev);
 508
 509 /* Battery Abstraction. */
 510 struct acpi_battinfo;
 511
 512 int             acpi_battery_register(device_t dev);
 513 int             acpi_battery_remove(device_t dev);
 514 int             acpi_battery_get_units(void);
 515 int             acpi_battery_get_info_expire(void);
 516 int             acpi_battery_bst_valid(struct acpi_bst *bst);
 517 int             acpi_battery_bix_valid(struct acpi_bix *bix);
 518 int             acpi_battery_get_battinfo(device_t dev,
 519                     struct acpi_battinfo *info);
 520
 521 /* Embedded controller. */
 522 void            acpi_ec_ecdt_probe(device_t);
 523
 524 /* AC adapter interface. */
 525 int             acpi_acad_get_acline(int *);
 526
 527 /* Package manipulation convenience functions. */
 528 #define ACPI_PKG_VALID(pkg, size)                               \
 529     ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE &&       \
 530      (pkg)->Package.Count >= (size))
 531 #define ACPI_PKG_VALID_EQ(pkg, size)                            \
 532     ((pkg) != NULL && (pkg)->Type == ACPI_TYPE_PACKAGE &&       \
 533      (pkg)->Package.Count == (size))
 534 int             acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst);
 535 int             acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst);
 536 int             acpi_PkgInt16(ACPI_OBJECT *res, int idx, uint16_t *dst);
 537 int             acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size);
 538 int             acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type,
 539                     int *rid, struct resource **dst, u_int flags);
 540 int             acpi_PkgFFH_IntelCpu(ACPI_OBJECT *res, int idx, int *vendor,
 541                     int *class, uint64_t *address, int *accsize);
 542 ACPI_HANDLE     acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj);
 543
 544 /*
 545  * Base level for BUS_ADD_CHILD.  Special devices are added at orders less
 546  * than this, and normal devices at or above this level.  This keeps the
 547  * probe order sorted so that things like sysresource are available before
 548  * their children need them.
 549  */
 550 #define ACPI_DEV_BASE_ORDER     100
 551
 552 /* Default maximum number of tasks to enqueue. */
 553 #ifndef ACPI_MAX_TASKS
 554 #define ACPI_MAX_TASKS          MAX(32, MAXCPU * 4)
 555 #endif
 556
 557 /* Default number of task queue threads to start. */
 558 #ifndef ACPI_MAX_THREADS
 559 #define ACPI_MAX_THREADS        3
 560 #endif
 561
 562 /* Use the device logging level for ktr(4). */
 563 #define KTR_ACPI                KTR_DEV
 564
 565 SYSCTL_DECL(_debug_acpi);
 566
 567 /*
 568  * Parse and use proximity information in SRAT and SLIT.
 569  */
 570 int             acpi_pxm_init(int ncpus, vm_paddr_t maxphys);
 571 void            acpi_pxm_parse_tables(void);
 572 void            acpi_pxm_set_mem_locality(void);
 573 void            acpi_pxm_set_cpu_locality(void);
 574 int             acpi_pxm_get_cpu_locality(int apic_id);
 575
 576 /*
 577  * Map a PXM to a VM domain.
 578  *
 579  * Returns the VM domain ID if found, or -1 if not found / invalid.
 580  */
 581 int             acpi_map_pxm_to_vm_domainid(int pxm);
 582 int             acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op,
 583                     size_t setsize, cpuset_t *cpuset);
 584 int             acpi_get_domain(device_t dev, device_t child, int *domain);
 585
 586 #ifdef __aarch64__
 587 /*
 588  * ARM specific ACPI interfaces, relating to IORT table.
 589  */
 590 int     acpi_iort_map_pci_msi(u_int seg, u_int rid, u_int *xref, u_int *devid);
 591 int     acpi_iort_map_pci_smmuv3(u_int seg, u_int rid, u_int *xref, u_int *devid);
 592 int     acpi_iort_its_lookup(u_int its_id, u_int *xref, int *pxm);
 593 int     acpi_iort_map_named_msi(const char *devname, u_int rid, u_int *xref,
 594             u_int *devid);
 595 int     acpi_iort_map_named_smmuv3(const char *devname, u_int rid, u_int *xref,
 596             u_int *devid);
 597 #endif
 598 #endif /* _KERNEL */
 599 #endif /* !_ACPIVAR_H_ */