The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/acpica/acpivar.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: afe4b45e46522576452faca8da62e683


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.