Home | History | Annotate | Line # | Download | only in wmi
wmi_acpi.c revision 1.4
      1  1.4  jruoho /*	$NetBSD: wmi_acpi.c,v 1.4 2010/04/15 07:02:24 jruoho Exp $	*/
      2  1.1  jruoho 
      3  1.1  jruoho /*-
      4  1.1  jruoho  * Copyright (c) 2009, 2010 Jukka Ruohonen <jruohonen (at) iki.fi>
      5  1.1  jruoho  * All rights reserved.
      6  1.1  jruoho  *
      7  1.1  jruoho  * Redistribution and use in source and binary forms, with or without
      8  1.1  jruoho  * modification, are permitted provided that the following conditions
      9  1.1  jruoho  * are met:
     10  1.1  jruoho  *
     11  1.1  jruoho  * 1. Redistributions of source code must retain the above copyright
     12  1.1  jruoho  *    notice, this list of conditions and the following disclaimer.
     13  1.1  jruoho  * 2. Redistributions in binary form must reproduce the above copyright
     14  1.1  jruoho  *    notice, this list of conditions and the following disclaimer in the
     15  1.1  jruoho  *    documentation and/or other materials provided with the distribution.
     16  1.1  jruoho  *
     17  1.1  jruoho  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     18  1.1  jruoho  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     19  1.1  jruoho  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     20  1.1  jruoho  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     21  1.1  jruoho  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     22  1.1  jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     23  1.1  jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     24  1.1  jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     25  1.1  jruoho  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     26  1.1  jruoho  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     27  1.1  jruoho  * SUCH DAMAGE.
     28  1.1  jruoho  */
     29  1.1  jruoho #include <sys/cdefs.h>
     30  1.4  jruoho __KERNEL_RCSID(0, "$NetBSD: wmi_acpi.c,v 1.4 2010/04/15 07:02:24 jruoho Exp $");
     31  1.1  jruoho 
     32  1.1  jruoho #include <sys/param.h>
     33  1.1  jruoho #include <sys/device.h>
     34  1.1  jruoho #include <sys/endian.h>
     35  1.1  jruoho #include <sys/kmem.h>
     36  1.1  jruoho #include <sys/systm.h>
     37  1.1  jruoho 
     38  1.1  jruoho #include <dev/acpi/acpireg.h>
     39  1.1  jruoho #include <dev/acpi/acpivar.h>
     40  1.1  jruoho #include <dev/acpi/wmi/wmi_acpivar.h>
     41  1.1  jruoho 
     42  1.1  jruoho #define _COMPONENT          ACPI_RESOURCE_COMPONENT
     43  1.1  jruoho ACPI_MODULE_NAME            ("wmi_acpi")
     44  1.1  jruoho 
     45  1.1  jruoho /*
     46  1.1  jruoho  * This implements something called "Microsoft Windows Management
     47  1.1  jruoho  * Instrumentation" (WMI). This subset of ACPI is desribed in:
     48  1.1  jruoho  *
     49  1.1  jruoho  * http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx
     50  1.1  jruoho  *
     51  1.1  jruoho  * (Obtained on Thu Feb 12 18:21:44 EET 2009.)
     52  1.1  jruoho  */
     53  1.1  jruoho struct guid_t {
     54  1.1  jruoho 
     55  1.1  jruoho 	/*
     56  1.1  jruoho 	 * The GUID itself. The used format is the usual 32-16-16-64-bit
     57  1.1  jruoho 	 * representation. All except the fourth field are in native byte
     58  1.1  jruoho 	 * order. A 32-16-16-16-48-bit hexadecimal notation with hyphens
     59  1.1  jruoho 	 * is used for human-readable GUIDs.
     60  1.1  jruoho 	 */
     61  1.1  jruoho 	struct {
     62  1.1  jruoho 		uint32_t data1;
     63  1.1  jruoho 		uint16_t data2;
     64  1.1  jruoho 		uint16_t data3;
     65  1.1  jruoho 		uint8_t  data4[8];
     66  1.1  jruoho 	} __packed;
     67  1.1  jruoho 
     68  1.1  jruoho 	union {
     69  1.1  jruoho 		char oid[2];            /* ACPI object ID. */
     70  1.1  jruoho 
     71  1.1  jruoho 		struct {
     72  1.1  jruoho 			uint8_t nid;    /* Notification value. */
     73  1.1  jruoho 			uint8_t res;    /* Reserved. */
     74  1.1  jruoho 		} __packed;
     75  1.1  jruoho 	} __packed;
     76  1.1  jruoho 
     77  1.1  jruoho 	uint8_t count;	                /* Number of instances. */
     78  1.1  jruoho 	uint8_t flags;		        /* Additional flags. */
     79  1.1  jruoho 
     80  1.1  jruoho } __packed;
     81  1.1  jruoho 
     82  1.1  jruoho struct wmi_t {
     83  1.1  jruoho 	struct guid_t         guid;
     84  1.1  jruoho 	bool                  eevent;
     85  1.1  jruoho 
     86  1.1  jruoho 	SIMPLEQ_ENTRY(wmi_t)  wmi_link;
     87  1.1  jruoho };
     88  1.1  jruoho 
     89  1.1  jruoho struct acpi_wmi_softc {
     90  1.1  jruoho 	device_t	      sc_dev;
     91  1.1  jruoho 	device_t              sc_child;
     92  1.1  jruoho         ACPI_NOTIFY_HANDLER   sc_handler;
     93  1.1  jruoho 	struct acpi_devnode  *sc_node;
     94  1.1  jruoho 
     95  1.1  jruoho 	SIMPLEQ_HEAD(, wmi_t) wmi_head;
     96  1.1  jruoho };
     97  1.1  jruoho 
     98  1.1  jruoho #define ACPI_WMI_FLAG_EXPENSIVE 0x01
     99  1.1  jruoho #define ACPI_WMI_FLAG_METHOD    0x02
    100  1.1  jruoho #define ACPI_WMI_FLAG_STRING    0x04
    101  1.1  jruoho #define ACPI_WMI_FLAG_EVENT     0x08
    102  1.1  jruoho #define ACPI_WMI_FLAG_DATA      (ACPI_WMI_FLAG_EXPENSIVE |		\
    103  1.1  jruoho 	                         ACPI_WMI_FLAG_STRING)
    104  1.1  jruoho 
    105  1.1  jruoho #define UGET16(x)   (*(uint16_t *)(x))
    106  1.1  jruoho #define UGET64(x)   (*(uint64_t *)(x))
    107  1.1  jruoho 
    108  1.1  jruoho #define HEXCHAR(x)  (((x) >= '0' && (x) <= '9') ||			\
    109  1.1  jruoho 	             ((x) >= 'a' && (x) <= 'f') ||			\
    110  1.1  jruoho 		     ((x) >= 'A' && (x) <= 'F'))
    111  1.1  jruoho 
    112  1.1  jruoho #define GUIDCMP(a, b)							\
    113  1.1  jruoho 	((a)->data1 == (b)->data1 &&					\
    114  1.1  jruoho 	 (a)->data2 == (b)->data2 &&					\
    115  1.1  jruoho 	 (a)->data3 == (b)->data3 &&					\
    116  1.1  jruoho 	 UGET64((a)->data4) == UGET64((b)->data4))
    117  1.1  jruoho 
    118  1.1  jruoho static int         acpi_wmi_match(device_t, cfdata_t, void *);
    119  1.1  jruoho static void        acpi_wmi_attach(device_t, device_t, void *);
    120  1.1  jruoho static int         acpi_wmi_detach(device_t, int);
    121  1.1  jruoho static int         acpi_wmi_print(void *, const char *);
    122  1.1  jruoho static bool        acpi_wmi_init(struct acpi_wmi_softc *);
    123  1.1  jruoho static bool        acpi_wmi_add(struct acpi_wmi_softc *, ACPI_OBJECT *);
    124  1.1  jruoho static void        acpi_wmi_del(struct acpi_wmi_softc *);
    125  1.1  jruoho 
    126  1.1  jruoho #ifdef ACPIVERBOSE
    127  1.1  jruoho static void        acpi_wmi_dump(struct acpi_wmi_softc *);
    128  1.1  jruoho #endif
    129  1.1  jruoho 
    130  1.1  jruoho static ACPI_STATUS acpi_wmi_guid_get(struct acpi_wmi_softc *,
    131  1.1  jruoho                                      const char *, struct wmi_t **);
    132  1.4  jruoho static void	   acpi_wmi_event_add(struct acpi_wmi_softc *);
    133  1.4  jruoho static void	   acpi_wmi_event_del(struct acpi_wmi_softc *);
    134  1.1  jruoho static void        acpi_wmi_event_handler(ACPI_HANDLE, uint32_t, void *);
    135  1.1  jruoho static bool        acpi_wmi_suspend(device_t, const pmf_qual_t *);
    136  1.1  jruoho static bool        acpi_wmi_resume(device_t, const pmf_qual_t *);
    137  1.1  jruoho static ACPI_STATUS acpi_wmi_enable(ACPI_HANDLE, const char *, bool, bool);
    138  1.1  jruoho static bool        acpi_wmi_input(struct wmi_t *, uint8_t, uint8_t);
    139  1.1  jruoho 
    140  1.1  jruoho const char * const acpi_wmi_ids[] = {
    141  1.1  jruoho 	"PNP0C14",
    142  1.1  jruoho 	NULL
    143  1.1  jruoho };
    144  1.1  jruoho 
    145  1.1  jruoho CFATTACH_DECL_NEW(acpiwmi, sizeof(struct acpi_wmi_softc),
    146  1.1  jruoho     acpi_wmi_match, acpi_wmi_attach, acpi_wmi_detach, NULL);
    147  1.1  jruoho 
    148  1.1  jruoho static int
    149  1.1  jruoho acpi_wmi_match(device_t parent, cfdata_t match, void *aux)
    150  1.1  jruoho {
    151  1.1  jruoho 	struct acpi_attach_args *aa = aux;
    152  1.1  jruoho 
    153  1.1  jruoho 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
    154  1.1  jruoho 		return 0;
    155  1.1  jruoho 
    156  1.1  jruoho 	return acpi_match_hid(aa->aa_node->ad_devinfo, acpi_wmi_ids);
    157  1.1  jruoho }
    158  1.1  jruoho 
    159  1.1  jruoho static void
    160  1.1  jruoho acpi_wmi_attach(device_t parent, device_t self, void *aux)
    161  1.1  jruoho {
    162  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    163  1.1  jruoho 	struct acpi_attach_args *aa = aux;
    164  1.1  jruoho 
    165  1.1  jruoho 	sc->sc_dev = self;
    166  1.1  jruoho 	sc->sc_node = aa->aa_node;
    167  1.1  jruoho 
    168  1.1  jruoho 	sc->sc_child = NULL;
    169  1.1  jruoho 	sc->sc_handler = NULL;
    170  1.1  jruoho 
    171  1.1  jruoho 	aprint_naive("\n");
    172  1.1  jruoho 	aprint_normal(": ACPI WMI Interface\n");
    173  1.1  jruoho 
    174  1.1  jruoho 	if (acpi_wmi_init(sc) != true)
    175  1.1  jruoho 		return;
    176  1.1  jruoho 
    177  1.1  jruoho #ifdef ACPIVERBOSE
    178  1.1  jruoho 	acpi_wmi_dump(sc);
    179  1.1  jruoho #endif
    180  1.1  jruoho 
    181  1.4  jruoho 	acpi_wmi_event_add(sc);
    182  1.1  jruoho 
    183  1.1  jruoho 	sc->sc_child = config_found_ia(self, "acpiwmibus",
    184  1.1  jruoho 	    NULL, acpi_wmi_print);
    185  1.4  jruoho 
    186  1.4  jruoho 	(void)pmf_device_register(self, acpi_wmi_suspend, acpi_wmi_resume);
    187  1.1  jruoho }
    188  1.1  jruoho 
    189  1.1  jruoho static int
    190  1.1  jruoho acpi_wmi_detach(device_t self, int flags)
    191  1.1  jruoho {
    192  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    193  1.1  jruoho 
    194  1.4  jruoho 	acpi_wmi_event_del(sc);
    195  1.1  jruoho 
    196  1.1  jruoho 	if (sc->sc_child != NULL)
    197  1.1  jruoho 		(void)config_detach(sc->sc_child, flags);
    198  1.1  jruoho 
    199  1.1  jruoho 	acpi_wmi_del(sc);
    200  1.1  jruoho 	pmf_device_deregister(self);
    201  1.1  jruoho 
    202  1.1  jruoho 	return 0;
    203  1.1  jruoho }
    204  1.1  jruoho 
    205  1.1  jruoho static int
    206  1.1  jruoho acpi_wmi_print(void *aux, const char *pnp)
    207  1.1  jruoho {
    208  1.1  jruoho 
    209  1.1  jruoho 	if (pnp != NULL)
    210  1.1  jruoho 		aprint_normal("acpiwmibus at %s", pnp);
    211  1.1  jruoho 
    212  1.1  jruoho 	return UNCONF;
    213  1.1  jruoho }
    214  1.1  jruoho 
    215  1.1  jruoho static bool
    216  1.1  jruoho acpi_wmi_init(struct acpi_wmi_softc *sc)
    217  1.1  jruoho {
    218  1.1  jruoho 	ACPI_OBJECT *obj;
    219  1.1  jruoho 	ACPI_BUFFER buf;
    220  1.1  jruoho 	ACPI_STATUS rv;
    221  1.1  jruoho 	uint32_t len;
    222  1.1  jruoho 
    223  1.1  jruoho 	rv = acpi_eval_struct(sc->sc_node->ad_handle, "_WDG", &buf);
    224  1.1  jruoho 
    225  1.1  jruoho 	if (ACPI_FAILURE(rv))
    226  1.1  jruoho 		goto fail;
    227  1.1  jruoho 
    228  1.1  jruoho 	obj = buf.Pointer;
    229  1.1  jruoho 
    230  1.1  jruoho 	if (obj->Type != ACPI_TYPE_BUFFER) {
    231  1.1  jruoho 		rv = AE_TYPE;
    232  1.1  jruoho 		goto fail;
    233  1.1  jruoho 	}
    234  1.1  jruoho 
    235  1.1  jruoho 	len = obj->Buffer.Length;
    236  1.1  jruoho 
    237  1.1  jruoho 	if (len != obj->Package.Count) {
    238  1.1  jruoho 		rv = AE_BAD_VALUE;
    239  1.1  jruoho 		goto fail;
    240  1.1  jruoho 	}
    241  1.1  jruoho 
    242  1.1  jruoho 	CTASSERT(sizeof(struct guid_t) == 20);
    243  1.1  jruoho 
    244  1.1  jruoho 	if (len < sizeof(struct guid_t) ||
    245  1.1  jruoho 	    len % sizeof(struct guid_t) != 0) {
    246  1.1  jruoho 		rv = AE_BAD_DATA;
    247  1.1  jruoho 		goto fail;
    248  1.1  jruoho 	}
    249  1.1  jruoho 
    250  1.1  jruoho 	return acpi_wmi_add(sc, obj);
    251  1.1  jruoho 
    252  1.1  jruoho fail:
    253  1.1  jruoho 	aprint_error_dev(sc->sc_dev, "failed to evaluate _WDG: %s\n",
    254  1.1  jruoho 	    AcpiFormatException(rv));
    255  1.1  jruoho 
    256  1.1  jruoho 	if (buf.Pointer != NULL)
    257  1.1  jruoho 		ACPI_FREE(buf.Pointer);
    258  1.1  jruoho 
    259  1.1  jruoho 	return false;
    260  1.1  jruoho }
    261  1.1  jruoho 
    262  1.1  jruoho static bool
    263  1.1  jruoho acpi_wmi_add(struct acpi_wmi_softc *sc, ACPI_OBJECT *obj)
    264  1.1  jruoho {
    265  1.1  jruoho 	struct wmi_t *wmi;
    266  1.1  jruoho 	size_t i, n, offset, siz;
    267  1.1  jruoho 
    268  1.1  jruoho 	siz = sizeof(struct guid_t);
    269  1.1  jruoho 	n = obj->Buffer.Length / siz;
    270  1.1  jruoho 
    271  1.1  jruoho 	SIMPLEQ_INIT(&sc->wmi_head);
    272  1.1  jruoho 
    273  1.1  jruoho 	for (i = offset = 0; i < n; ++i) {
    274  1.1  jruoho 
    275  1.1  jruoho 		if ((wmi = kmem_zalloc(sizeof(*wmi), KM_NOSLEEP)) == NULL)
    276  1.1  jruoho 			goto fail;
    277  1.1  jruoho 
    278  1.1  jruoho 		(void)memcpy(&wmi->guid, obj->Buffer.Pointer + offset, siz);
    279  1.1  jruoho 
    280  1.1  jruoho 		wmi->eevent = false;
    281  1.1  jruoho 		offset = offset + siz;
    282  1.1  jruoho 
    283  1.1  jruoho 		SIMPLEQ_INSERT_TAIL(&sc->wmi_head, wmi, wmi_link);
    284  1.1  jruoho 	}
    285  1.1  jruoho 
    286  1.1  jruoho 	ACPI_FREE(obj);
    287  1.1  jruoho 
    288  1.1  jruoho 	return true;
    289  1.1  jruoho 
    290  1.1  jruoho fail:
    291  1.1  jruoho 	ACPI_FREE(obj);
    292  1.1  jruoho 	acpi_wmi_del(sc);
    293  1.1  jruoho 
    294  1.1  jruoho 	return false;
    295  1.1  jruoho }
    296  1.1  jruoho 
    297  1.1  jruoho static void
    298  1.1  jruoho acpi_wmi_del(struct acpi_wmi_softc *sc)
    299  1.1  jruoho {
    300  1.1  jruoho 	struct wmi_t *wmi;
    301  1.1  jruoho 
    302  1.2  jruoho 	if (SIMPLEQ_EMPTY(&sc->wmi_head) != 0)
    303  1.1  jruoho 		return;
    304  1.1  jruoho 
    305  1.1  jruoho 	while (SIMPLEQ_FIRST(&sc->wmi_head) != NULL) {
    306  1.1  jruoho 
    307  1.1  jruoho 		wmi = SIMPLEQ_FIRST(&sc->wmi_head);
    308  1.1  jruoho 		SIMPLEQ_REMOVE_HEAD(&sc->wmi_head, wmi_link);
    309  1.1  jruoho 
    310  1.1  jruoho 		KASSERT(wmi != NULL);
    311  1.1  jruoho 
    312  1.1  jruoho 		kmem_free(wmi, sizeof(*wmi));
    313  1.1  jruoho 	}
    314  1.1  jruoho }
    315  1.1  jruoho 
    316  1.1  jruoho #ifdef ACPIVERBOSE
    317  1.1  jruoho static void
    318  1.1  jruoho acpi_wmi_dump(struct acpi_wmi_softc *sc)
    319  1.1  jruoho {
    320  1.1  jruoho 	struct wmi_t *wmi;
    321  1.1  jruoho 
    322  1.1  jruoho 	KASSERT(SIMPLEQ_EMPTY(&sc->wmi_head) == 0);
    323  1.1  jruoho 
    324  1.1  jruoho 	SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
    325  1.1  jruoho 
    326  1.1  jruoho 		aprint_normal_dev(sc->sc_dev, "{%08X-%04X-%04X-",
    327  1.1  jruoho 		    wmi->guid.data1, wmi->guid.data2, wmi->guid.data3);
    328  1.1  jruoho 
    329  1.1  jruoho 		aprint_normal("%02X%02X-%02X%02X%02X%02X%02X%02X} ",
    330  1.1  jruoho 		    wmi->guid.data4[0], wmi->guid.data4[1],
    331  1.1  jruoho 		    wmi->guid.data4[2], wmi->guid.data4[3],
    332  1.1  jruoho 		    wmi->guid.data4[4], wmi->guid.data4[5],
    333  1.1  jruoho 		    wmi->guid.data4[6], wmi->guid.data4[7]);
    334  1.1  jruoho 
    335  1.1  jruoho 		aprint_normal("oid %04X count %02X flags %02X\n",
    336  1.1  jruoho 		    UGET16(wmi->guid.oid), wmi->guid.count, wmi->guid.flags);
    337  1.1  jruoho 	}
    338  1.1  jruoho }
    339  1.1  jruoho #endif
    340  1.1  jruoho 
    341  1.1  jruoho static ACPI_STATUS
    342  1.1  jruoho acpi_wmi_guid_get(struct acpi_wmi_softc *sc,
    343  1.1  jruoho     const char *src, struct wmi_t **out)
    344  1.1  jruoho {
    345  1.1  jruoho 	struct wmi_t *wmi;
    346  1.1  jruoho 	struct guid_t *guid;
    347  1.1  jruoho 	char bin[16];
    348  1.1  jruoho 	char hex[2];
    349  1.1  jruoho 	const char *ptr;
    350  1.1  jruoho 	uint8_t i;
    351  1.1  jruoho 
    352  1.1  jruoho 	if (sc == NULL || src == NULL || strlen(src) != 36)
    353  1.1  jruoho 		return AE_BAD_PARAMETER;
    354  1.1  jruoho 
    355  1.1  jruoho 	for (ptr = src, i = 0; i < 16; i++) {
    356  1.1  jruoho 
    357  1.1  jruoho 		if (*ptr == '-')
    358  1.1  jruoho 			ptr++;
    359  1.1  jruoho 
    360  1.1  jruoho 		(void)memcpy(hex, ptr, 2);
    361  1.1  jruoho 
    362  1.2  jruoho 		if (HEXCHAR(hex[0]) == 0 || HEXCHAR(hex[1]) == 0)
    363  1.1  jruoho 			return AE_BAD_HEX_CONSTANT;
    364  1.1  jruoho 
    365  1.1  jruoho 		bin[i] = strtoul(hex, NULL, 16) & 0xFF;
    366  1.1  jruoho 
    367  1.1  jruoho 		ptr++;
    368  1.1  jruoho 		ptr++;
    369  1.1  jruoho 	}
    370  1.1  jruoho 
    371  1.1  jruoho 	guid = (struct guid_t *)bin;
    372  1.1  jruoho 	guid->data1 = be32toh(guid->data1);
    373  1.1  jruoho 	guid->data2 = be16toh(guid->data2);
    374  1.1  jruoho 	guid->data3 = be16toh(guid->data3);
    375  1.1  jruoho 
    376  1.1  jruoho 	SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
    377  1.1  jruoho 
    378  1.1  jruoho 		if (GUIDCMP(guid, &wmi->guid) != 0) {
    379  1.1  jruoho 
    380  1.1  jruoho 			if (out != NULL)
    381  1.1  jruoho 				*out = wmi;
    382  1.1  jruoho 
    383  1.1  jruoho 			return AE_OK;
    384  1.1  jruoho 		}
    385  1.1  jruoho 	}
    386  1.1  jruoho 
    387  1.1  jruoho 	return AE_NOT_FOUND;
    388  1.1  jruoho }
    389  1.1  jruoho 
    390  1.1  jruoho /*
    391  1.1  jruoho  * Checks if a GUID is present. Child devices
    392  1.1  jruoho  * can use this in their autoconf(9) routines.
    393  1.1  jruoho  */
    394  1.1  jruoho int
    395  1.1  jruoho acpi_wmi_guid_match(device_t self, const char *guid)
    396  1.1  jruoho {
    397  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    398  1.1  jruoho 	ACPI_STATUS rv;
    399  1.1  jruoho 
    400  1.1  jruoho 	rv = acpi_wmi_guid_get(sc, guid, NULL);
    401  1.1  jruoho 
    402  1.1  jruoho 	if (ACPI_SUCCESS(rv))
    403  1.1  jruoho 		return 1;
    404  1.1  jruoho 
    405  1.1  jruoho 	return 0;
    406  1.1  jruoho }
    407  1.1  jruoho 
    408  1.1  jruoho /*
    409  1.1  jruoho  * Adds internal event handler.
    410  1.1  jruoho  */
    411  1.4  jruoho static void
    412  1.1  jruoho acpi_wmi_event_add(struct acpi_wmi_softc *sc)
    413  1.1  jruoho {
    414  1.1  jruoho 	struct wmi_t *wmi;
    415  1.1  jruoho 	ACPI_STATUS rv;
    416  1.1  jruoho 
    417  1.4  jruoho 	if (acpi_register_notify(sc->sc_node, acpi_wmi_event_handler) != true)
    418  1.4  jruoho 		return;
    419  1.1  jruoho 
    420  1.1  jruoho 	/* Enable possible expensive events. */
    421  1.1  jruoho 	SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
    422  1.1  jruoho 
    423  1.1  jruoho 		if ((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) != 0 &&
    424  1.1  jruoho 		    (wmi->guid.flags & ACPI_WMI_FLAG_EXPENSIVE) != 0) {
    425  1.1  jruoho 
    426  1.1  jruoho 			rv = acpi_wmi_enable(sc->sc_node->ad_handle,
    427  1.1  jruoho 			    wmi->guid.oid, false, true);
    428  1.1  jruoho 
    429  1.1  jruoho 			if (ACPI_SUCCESS(rv)) {
    430  1.1  jruoho 				wmi->eevent = true;
    431  1.1  jruoho 				continue;
    432  1.1  jruoho 			}
    433  1.1  jruoho 
    434  1.1  jruoho 			aprint_error_dev(sc->sc_dev, "failed to enable "
    435  1.1  jruoho 			    "expensive WExx: %s\n", AcpiFormatException(rv));
    436  1.1  jruoho 		}
    437  1.1  jruoho 	}
    438  1.1  jruoho }
    439  1.1  jruoho 
    440  1.1  jruoho /*
    441  1.1  jruoho  * Removes the internal event handler.
    442  1.1  jruoho  */
    443  1.4  jruoho static void
    444  1.1  jruoho acpi_wmi_event_del(struct acpi_wmi_softc *sc)
    445  1.1  jruoho {
    446  1.1  jruoho 	struct wmi_t *wmi;
    447  1.1  jruoho 	ACPI_STATUS rv;
    448  1.1  jruoho 
    449  1.4  jruoho 	acpi_deregister_notify(sc->sc_node);
    450  1.1  jruoho 
    451  1.1  jruoho 	SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
    452  1.1  jruoho 
    453  1.1  jruoho 		if (wmi->eevent != true)
    454  1.1  jruoho 			continue;
    455  1.1  jruoho 
    456  1.1  jruoho 		KASSERT((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) != 0);
    457  1.1  jruoho 		KASSERT((wmi->guid.flags & ACPI_WMI_FLAG_EXPENSIVE) != 0);
    458  1.1  jruoho 
    459  1.1  jruoho 		rv = acpi_wmi_enable(sc->sc_node->ad_handle,
    460  1.1  jruoho 		    wmi->guid.oid, false, false);
    461  1.1  jruoho 
    462  1.1  jruoho 		if (ACPI_SUCCESS(rv)) {
    463  1.1  jruoho 			wmi->eevent = false;
    464  1.1  jruoho 			continue;
    465  1.1  jruoho 		}
    466  1.1  jruoho 
    467  1.1  jruoho 		aprint_error_dev(sc->sc_dev, "failed to disable "
    468  1.1  jruoho 		    "expensive WExx: %s\n", AcpiFormatException(rv));
    469  1.1  jruoho 	}
    470  1.1  jruoho }
    471  1.1  jruoho 
    472  1.1  jruoho /*
    473  1.1  jruoho  * Returns extra information possibly associated with an event.
    474  1.1  jruoho  */
    475  1.1  jruoho ACPI_STATUS
    476  1.1  jruoho acpi_wmi_event_get(device_t self, uint32_t event, ACPI_BUFFER *obuf)
    477  1.1  jruoho {
    478  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    479  1.1  jruoho 	struct wmi_t *wmi;
    480  1.1  jruoho 	ACPI_OBJECT_LIST arg;
    481  1.1  jruoho 	ACPI_OBJECT obj;
    482  1.2  jruoho 	ACPI_HANDLE hdl;
    483  1.2  jruoho 
    484  1.1  jruoho 	if (sc == NULL || obuf == NULL)
    485  1.1  jruoho 		return AE_BAD_PARAMETER;
    486  1.1  jruoho 
    487  1.1  jruoho 	if (sc->sc_handler == NULL)
    488  1.1  jruoho 		return AE_ABORT_METHOD;
    489  1.1  jruoho 
    490  1.3  jruoho 	hdl = sc->sc_node->ad_handle;
    491  1.3  jruoho 
    492  1.1  jruoho 	obj.Type = ACPI_TYPE_INTEGER;
    493  1.1  jruoho 	obj.Integer.Value = event;
    494  1.1  jruoho 
    495  1.1  jruoho 	arg.Count = 0x01;
    496  1.1  jruoho 	arg.Pointer = &obj;
    497  1.1  jruoho 
    498  1.1  jruoho 	obuf->Pointer = NULL;
    499  1.1  jruoho 	obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
    500  1.1  jruoho 
    501  1.1  jruoho 	SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
    502  1.1  jruoho 
    503  1.1  jruoho 		if ((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) == 0)
    504  1.1  jruoho 			continue;
    505  1.1  jruoho 
    506  1.1  jruoho 		if (wmi->guid.nid != event)
    507  1.1  jruoho 			continue;
    508  1.1  jruoho 
    509  1.2  jruoho 		return AcpiEvaluateObject(hdl, "_WED", &arg, obuf);
    510  1.1  jruoho 	}
    511  1.1  jruoho 
    512  1.1  jruoho 	return AE_NOT_FOUND;
    513  1.1  jruoho }
    514  1.1  jruoho 
    515  1.1  jruoho /*
    516  1.1  jruoho  * Forwards events to the external handler through the internal one.
    517  1.1  jruoho  */
    518  1.1  jruoho static void
    519  1.1  jruoho acpi_wmi_event_handler(ACPI_HANDLE hdl, uint32_t evt, void *aux)
    520  1.1  jruoho {
    521  1.4  jruoho 	struct acpi_wmi_softc *sc;
    522  1.4  jruoho 	device_t self = aux;
    523  1.4  jruoho 
    524  1.4  jruoho 	sc = device_private(self);
    525  1.1  jruoho 
    526  1.1  jruoho 	if (sc->sc_child == NULL)
    527  1.1  jruoho 		return;
    528  1.1  jruoho 
    529  1.1  jruoho 	if (sc->sc_handler == NULL)
    530  1.1  jruoho 		return;
    531  1.1  jruoho 
    532  1.1  jruoho 	(*sc->sc_handler)(NULL, evt, sc->sc_child);
    533  1.1  jruoho }
    534  1.1  jruoho 
    535  1.1  jruoho ACPI_STATUS
    536  1.1  jruoho acpi_wmi_event_register(device_t self, ACPI_NOTIFY_HANDLER handler)
    537  1.1  jruoho {
    538  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    539  1.1  jruoho 
    540  1.1  jruoho 	if (sc == NULL)
    541  1.1  jruoho 		return AE_BAD_PARAMETER;
    542  1.1  jruoho 
    543  1.1  jruoho 	if (handler != NULL && sc->sc_handler != NULL)
    544  1.1  jruoho 		return AE_ALREADY_EXISTS;
    545  1.1  jruoho 
    546  1.1  jruoho 	sc->sc_handler = handler;
    547  1.1  jruoho 
    548  1.1  jruoho 	return AE_OK;
    549  1.1  jruoho }
    550  1.1  jruoho 
    551  1.1  jruoho ACPI_STATUS
    552  1.1  jruoho acpi_wmi_event_deregister(device_t self)
    553  1.1  jruoho {
    554  1.1  jruoho 	return acpi_wmi_event_register(self, NULL);
    555  1.1  jruoho }
    556  1.1  jruoho 
    557  1.1  jruoho /*
    558  1.1  jruoho  * As there is no prior knowledge about the expensive
    559  1.1  jruoho  * events that cause "significant overhead", try to
    560  1.1  jruoho  * disable (enable) these before suspending (resuming).
    561  1.1  jruoho  */
    562  1.1  jruoho static bool
    563  1.1  jruoho acpi_wmi_suspend(device_t self, const pmf_qual_t *qual)
    564  1.1  jruoho {
    565  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    566  1.1  jruoho 
    567  1.1  jruoho 	acpi_wmi_event_del(sc);
    568  1.1  jruoho 
    569  1.1  jruoho 	return true;
    570  1.1  jruoho }
    571  1.1  jruoho 
    572  1.1  jruoho static bool
    573  1.1  jruoho acpi_wmi_resume(device_t self, const pmf_qual_t *qual)
    574  1.1  jruoho {
    575  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    576  1.1  jruoho 
    577  1.1  jruoho 	acpi_wmi_event_add(sc);
    578  1.1  jruoho 
    579  1.1  jruoho 	return true;
    580  1.1  jruoho }
    581  1.1  jruoho 
    582  1.1  jruoho /*
    583  1.1  jruoho  * Enables or disables data collection (WCxx) or an event (WExx).
    584  1.1  jruoho  */
    585  1.1  jruoho static ACPI_STATUS
    586  1.1  jruoho acpi_wmi_enable(ACPI_HANDLE hdl, const char *oid, bool data, bool flag)
    587  1.1  jruoho {
    588  1.1  jruoho 	char path[5];
    589  1.1  jruoho 	const char *str;
    590  1.1  jruoho 
    591  1.1  jruoho 	str = (data != false) ? "WC" : "WE";
    592  1.1  jruoho 
    593  1.1  jruoho 	(void)strlcpy(path, str, sizeof(path));
    594  1.1  jruoho 	(void)strlcat(path, oid, sizeof(path));
    595  1.1  jruoho 
    596  1.1  jruoho 	return acpi_eval_set_integer(hdl, path, (flag != false) ? 0x01 : 0x00);
    597  1.1  jruoho }
    598  1.1  jruoho 
    599  1.1  jruoho static bool
    600  1.1  jruoho acpi_wmi_input(struct wmi_t *wmi, uint8_t flag, uint8_t idx)
    601  1.1  jruoho {
    602  1.1  jruoho 
    603  1.2  jruoho 	if ((wmi->guid.flags & flag) == 0)
    604  1.1  jruoho 		return false;
    605  1.1  jruoho 
    606  1.1  jruoho 	if (wmi->guid.count == 0x00)
    607  1.1  jruoho 		return false;
    608  1.1  jruoho 
    609  1.1  jruoho 	if (wmi->guid.count < idx)
    610  1.1  jruoho 		return false;
    611  1.1  jruoho 
    612  1.1  jruoho 	return true;
    613  1.1  jruoho }
    614  1.1  jruoho 
    615  1.1  jruoho /*
    616  1.1  jruoho  * Makes a WMI data block query (WQxx). The corresponding control
    617  1.1  jruoho  * method for data collection will be invoked if it is available.
    618  1.1  jruoho  */
    619  1.1  jruoho ACPI_STATUS
    620  1.1  jruoho acpi_wmi_data_query(device_t self, const char *guid,
    621  1.1  jruoho     uint8_t idx, ACPI_BUFFER *obuf)
    622  1.1  jruoho {
    623  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    624  1.1  jruoho 	struct wmi_t *wmi;
    625  1.1  jruoho 	char path[5] = "WQ";
    626  1.1  jruoho 	ACPI_OBJECT_LIST arg;
    627  1.1  jruoho 	ACPI_STATUS rv, rvxx;
    628  1.1  jruoho 	ACPI_OBJECT obj;
    629  1.1  jruoho 
    630  1.1  jruoho 	rvxx = AE_SUPPORT;
    631  1.1  jruoho 
    632  1.1  jruoho 	if (obuf == NULL)
    633  1.1  jruoho 		return AE_BAD_PARAMETER;
    634  1.1  jruoho 
    635  1.1  jruoho 	rv = acpi_wmi_guid_get(sc, guid, &wmi);
    636  1.1  jruoho 
    637  1.1  jruoho 	if (ACPI_FAILURE(rv))
    638  1.1  jruoho 		return rv;
    639  1.1  jruoho 
    640  1.1  jruoho 	if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_DATA, idx) != true)
    641  1.1  jruoho 		return AE_BAD_DATA;
    642  1.1  jruoho 
    643  1.1  jruoho 	(void)strlcat(path, wmi->guid.oid, sizeof(path));
    644  1.1  jruoho 
    645  1.1  jruoho 	obj.Type = ACPI_TYPE_INTEGER;
    646  1.1  jruoho 	obj.Integer.Value = idx;
    647  1.1  jruoho 
    648  1.1  jruoho 	arg.Count = 0x01;
    649  1.1  jruoho 	arg.Pointer = &obj;
    650  1.1  jruoho 
    651  1.1  jruoho 	obuf->Pointer = NULL;
    652  1.1  jruoho 	obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
    653  1.1  jruoho 
    654  1.1  jruoho 	/*
    655  1.1  jruoho 	 * If the expensive flag is set, we should enable
    656  1.1  jruoho 	 * data collection before evaluating the WQxx buffer.
    657  1.1  jruoho 	 */
    658  1.1  jruoho 	if ((wmi->guid.flags & ACPI_WMI_FLAG_EXPENSIVE) != 0) {
    659  1.1  jruoho 
    660  1.1  jruoho 		rvxx = acpi_wmi_enable(sc->sc_node->ad_handle,
    661  1.1  jruoho 		    wmi->guid.oid, true, true);
    662  1.1  jruoho 	}
    663  1.1  jruoho 
    664  1.1  jruoho 	rv = AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, obuf);
    665  1.1  jruoho 
    666  1.1  jruoho 	/* No longer needed. */
    667  1.1  jruoho 	if (ACPI_SUCCESS(rvxx)) {
    668  1.1  jruoho 
    669  1.1  jruoho 		(void)acpi_wmi_enable(sc->sc_node->ad_handle,
    670  1.1  jruoho 		    wmi->guid.oid, true, false);
    671  1.1  jruoho 	}
    672  1.1  jruoho 
    673  1.1  jruoho #ifdef DIAGNOSTIC
    674  1.1  jruoho 	/*
    675  1.1  jruoho 	 * XXX: It appears that quite a few laptops have WQxx
    676  1.1  jruoho 	 * methods that are declared as expensive, but lack the
    677  1.1  jruoho 	 * corresponding WCxx control method.
    678  1.1  jruoho 	 *
    679  1.1  jruoho 	 * -- Acer Aspire One is one example <jruohonen (at) iki.fi>.
    680  1.1  jruoho 	 */
    681  1.1  jruoho 	if (ACPI_FAILURE(rvxx) && rvxx != AE_SUPPORT)
    682  1.1  jruoho 		aprint_error_dev(sc->sc_dev, "failed to evaluate WCxx "
    683  1.1  jruoho 		    "for %s: %s\n", path, AcpiFormatException(rvxx));
    684  1.1  jruoho #endif
    685  1.1  jruoho 	return rv;
    686  1.1  jruoho }
    687  1.1  jruoho 
    688  1.1  jruoho /*
    689  1.1  jruoho  * Writes to a data block (WSxx).
    690  1.1  jruoho  */
    691  1.1  jruoho ACPI_STATUS
    692  1.1  jruoho acpi_wmi_data_write(device_t self, const char *guid,
    693  1.1  jruoho     uint8_t idx, ACPI_BUFFER *ibuf)
    694  1.1  jruoho {
    695  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    696  1.1  jruoho 	struct wmi_t *wmi;
    697  1.1  jruoho 	ACPI_OBJECT_LIST arg;
    698  1.1  jruoho 	ACPI_OBJECT obj[2];
    699  1.1  jruoho 	char path[5] = "WS";
    700  1.1  jruoho 	ACPI_STATUS rv;
    701  1.1  jruoho 
    702  1.1  jruoho 	if (ibuf == NULL)
    703  1.1  jruoho 		return AE_BAD_PARAMETER;
    704  1.1  jruoho 
    705  1.1  jruoho 	rv = acpi_wmi_guid_get(sc, guid, &wmi);
    706  1.1  jruoho 
    707  1.1  jruoho 	if (ACPI_FAILURE(rv))
    708  1.1  jruoho 		return rv;
    709  1.1  jruoho 
    710  1.1  jruoho 	if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_DATA, idx) != true)
    711  1.1  jruoho 		return AE_BAD_DATA;
    712  1.1  jruoho 
    713  1.1  jruoho 	(void)strlcat(path, wmi->guid.oid, sizeof(path));
    714  1.1  jruoho 
    715  1.1  jruoho 	obj[0].Integer.Value = idx;
    716  1.1  jruoho 	obj[0].Type = ACPI_TYPE_INTEGER;
    717  1.1  jruoho 
    718  1.1  jruoho 	obj[1].Buffer.Length = ibuf->Length;
    719  1.1  jruoho 	obj[1].Buffer.Pointer = ibuf->Pointer;
    720  1.1  jruoho 
    721  1.1  jruoho 	obj[1].Type = ((wmi->guid.flags & ACPI_WMI_FLAG_STRING) != 0) ?
    722  1.1  jruoho 	    ACPI_TYPE_STRING : ACPI_TYPE_BUFFER;
    723  1.1  jruoho 
    724  1.1  jruoho 	arg.Count = 0x02;
    725  1.1  jruoho 	arg.Pointer = obj;
    726  1.1  jruoho 
    727  1.1  jruoho 	return AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, NULL);
    728  1.1  jruoho }
    729  1.1  jruoho 
    730  1.1  jruoho /*
    731  1.1  jruoho  * Executes a method (WMxx).
    732  1.1  jruoho  */
    733  1.1  jruoho ACPI_STATUS
    734  1.1  jruoho acpi_wmi_method(device_t self, const char *guid, uint8_t idx,
    735  1.1  jruoho     uint32_t mid, ACPI_BUFFER *ibuf, ACPI_BUFFER *obuf)
    736  1.1  jruoho {
    737  1.1  jruoho 	struct acpi_wmi_softc *sc = device_private(self);
    738  1.1  jruoho 	struct wmi_t *wmi;
    739  1.1  jruoho 	ACPI_OBJECT_LIST arg;
    740  1.1  jruoho 	ACPI_OBJECT obj[3];
    741  1.1  jruoho 	char path[5] = "WM";
    742  1.1  jruoho 	ACPI_STATUS rv;
    743  1.1  jruoho 
    744  1.1  jruoho 	if (ibuf == NULL || obuf == NULL)
    745  1.1  jruoho 		return AE_BAD_PARAMETER;
    746  1.1  jruoho 
    747  1.1  jruoho 	rv = acpi_wmi_guid_get(sc, guid, &wmi);
    748  1.1  jruoho 
    749  1.1  jruoho 	if (ACPI_FAILURE(rv))
    750  1.1  jruoho 		return rv;
    751  1.1  jruoho 
    752  1.1  jruoho 	if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_METHOD, idx) != true)
    753  1.1  jruoho 		return AE_BAD_DATA;
    754  1.1  jruoho 
    755  1.1  jruoho 	(void)strlcat(path, wmi->guid.oid, sizeof(path));
    756  1.1  jruoho 
    757  1.1  jruoho 	obj[0].Integer.Value = idx;
    758  1.1  jruoho 	obj[1].Integer.Value = mid;
    759  1.1  jruoho 	obj[0].Type = obj[1].Type = ACPI_TYPE_INTEGER;
    760  1.1  jruoho 
    761  1.1  jruoho 	obj[2].Buffer.Length = ibuf->Length;
    762  1.1  jruoho 	obj[2].Buffer.Pointer = ibuf->Pointer;
    763  1.1  jruoho 
    764  1.1  jruoho 	obj[2].Type = ((wmi->guid.flags & ACPI_WMI_FLAG_STRING) != 0) ?
    765  1.1  jruoho 	    ACPI_TYPE_STRING : ACPI_TYPE_BUFFER;
    766  1.1  jruoho 
    767  1.1  jruoho 	arg.Count = 0x03;
    768  1.1  jruoho 	arg.Pointer = obj;
    769  1.1  jruoho 
    770  1.1  jruoho 	obuf->Pointer = NULL;
    771  1.1  jruoho 	obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
    772  1.1  jruoho 
    773  1.1  jruoho 	return AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, obuf);
    774  1.1  jruoho }
    775