2 * Copyright (c) 2009 Michael Gmelin <freebsd@grem.de>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/acpi_support/acpi_wmi.c,v 1.9 2011/11/22 21:28:20 marius Exp $
30 * Driver for acpi-wmi mapping, provides an interface for vendor specific
31 * implementations (e.g. HP and Acer laptops).
32 * Inspired by the ACPI-WMI mapping driver (c) 2008-2008 Carlos Corbacho which
33 * implements this functionality for Linux.
35 * WMI and ACPI: http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx
36 * acpi-wmi for Linux: http://www.kernel.org
40 #include <sys/param.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
47 #include <sys/module.h>
49 #include <sys/device.h>
53 #include <dev/acpica/acpivar.h>
54 #include "acpi_wmi_if.h"
56 static MALLOC_DEFINE(M_ACPIWMI, "acpiwmi", "ACPI-WMI mapping");
58 #define _COMPONENT ACPI_OEM
59 ACPI_MODULE_NAME("ACPI_WMI");
61 #define ACPI_WMI_REGFLAG_EXPENSIVE 0x1 /* GUID flag: Expensive operation */
62 #define ACPI_WMI_REGFLAG_METHOD 0x2 /* GUID flag: Method call */
63 #define ACPI_WMI_REGFLAG_STRING 0x4 /* GUID flag: String */
64 #define ACPI_WMI_REGFLAG_EVENT 0x8 /* GUID flag: Event */
67 * acpi_wmi driver private structure
69 struct acpi_wmi_softc {
70 device_t wmi_dev; /* wmi device id */
71 ACPI_HANDLE wmi_handle; /* handle of the PNP0C14 node */
72 device_t ec_dev; /* acpi_ec0 */
73 struct cdev *wmistat_dev_t; /* wmistat device handle */
74 struct sbuf wmistat_sbuf; /* sbuf for /dev/wmistat output */
75 pid_t wmistat_open_pid; /* pid operating on /dev/wmistat */
76 int wmistat_bufptr; /* /dev/wmistat ptr to buffer position */
80 * Struct that holds information about
81 * about a single GUID entry in _WDG
84 char guid[16]; /* 16 byte non human readable GUID */
85 char oid[2]; /* object id or event notify id (first byte) */
86 UINT8 max_instance; /* highest instance known for this GUID */
87 UINT8 flags; /* ACPI_WMI_REGFLAG_%s */
90 /* WExx event generation state (on/off) */
91 enum event_generation_state {
92 EVENT_GENERATION_ON = 1,
93 EVENT_GENERATION_OFF = 0
98 * Information about one entry in _WDG.
99 * List of those is used to lookup information by GUID.
102 TAILQ_ENTRY(wmi_info) wmi_list;
103 struct guid_info ginfo; /* information on guid */
104 ACPI_NOTIFY_HANDLER event_handler;/* client provided event handler */
105 void *event_handler_user_data; /* ev handler cookie */
108 TAILQ_HEAD(wmi_info_list_head, wmi_info)
109 wmi_info_list = TAILQ_HEAD_INITIALIZER(wmi_info_list);
111 ACPI_SERIAL_DECL(acpi_wmi, "ACPI-WMI Mapping");
113 /* public interface - declaration */
114 /* standard device interface*/
115 static int acpi_wmi_probe(device_t dev);
116 static int acpi_wmi_attach(device_t dev);
117 static int acpi_wmi_detach(device_t dev);
118 /* see acpi_wmi_if.m */
119 static int acpi_wmi_provides_guid_string_method(device_t dev,
120 const char *guid_string);
121 static ACPI_STATUS acpi_wmi_evaluate_call_method(device_t dev,
122 const char *guid_string, UINT8 instance,
123 UINT32 method_id, const ACPI_BUFFER *in,
125 static ACPI_STATUS acpi_wmi_install_event_handler_method(device_t dev,
126 const char *guid_string, ACPI_NOTIFY_HANDLER handler,
128 static ACPI_STATUS acpi_wmi_remove_event_handler_method(device_t dev,
129 const char *guid_string);
130 static ACPI_STATUS acpi_wmi_get_event_data_method(device_t dev,
131 UINT32 event_id, ACPI_BUFFER *out);
132 static ACPI_STATUS acpi_wmi_get_block_method(device_t dev,
133 const char *guid_string,
134 UINT8 instance, ACPI_BUFFER *out);
135 static ACPI_STATUS acpi_wmi_set_block_method(device_t dev,
136 const char *guid_string,
137 UINT8 instance, const ACPI_BUFFER *in);
138 /* private interface - declaration */
140 static void acpi_wmi_notify_handler(ACPI_HANDLE h, UINT32 notify,
142 static ACPI_STATUS acpi_wmi_ec_handler(UINT32 function,
143 ACPI_PHYSICAL_ADDRESS address, UINT32 width,
144 UINT64 *value, void *context,
145 void *region_context);
147 static ACPI_STATUS acpi_wmi_read_wdg_blocks(ACPI_HANDLE h);
148 static ACPI_STATUS acpi_wmi_toggle_we_event_generation(device_t dev,
149 struct wmi_info *winfo,
150 enum event_generation_state state);
151 static int acpi_wmi_guid_string_to_guid(const UINT8 *guid_string,
153 static struct wmi_info* acpi_wmi_lookup_wmi_info_by_guid_string(
154 const char *guid_string);
156 static d_open_t acpi_wmi_wmistat_open;
157 static d_close_t acpi_wmi_wmistat_close;
158 static d_read_t acpi_wmi_wmistat_read;
160 /* handler /dev/wmistat device */
161 static struct dev_ops wmistat_ops = {
162 { .name = "wmistat" },
163 .d_open = acpi_wmi_wmistat_open,
164 .d_close = acpi_wmi_wmistat_close,
165 .d_read = acpi_wmi_wmistat_read,
169 static device_method_t acpi_wmi_methods[] = {
170 /* Device interface */
171 DEVMETHOD(device_probe, acpi_wmi_probe),
172 DEVMETHOD(device_attach, acpi_wmi_attach),
173 DEVMETHOD(device_detach, acpi_wmi_detach),
176 DEVMETHOD(bus_add_child, bus_generic_add_child),
178 /* acpi_wmi interface */
179 DEVMETHOD(acpi_wmi_provides_guid_string,
180 acpi_wmi_provides_guid_string_method),
181 DEVMETHOD(acpi_wmi_evaluate_call, acpi_wmi_evaluate_call_method),
182 DEVMETHOD(acpi_wmi_install_event_handler,
183 acpi_wmi_install_event_handler_method),
184 DEVMETHOD(acpi_wmi_remove_event_handler,
185 acpi_wmi_remove_event_handler_method),
186 DEVMETHOD(acpi_wmi_get_event_data, acpi_wmi_get_event_data_method),
187 DEVMETHOD(acpi_wmi_get_block, acpi_wmi_get_block_method),
188 DEVMETHOD(acpi_wmi_set_block, acpi_wmi_set_block_method),
193 static driver_t acpi_wmi_driver = {
196 sizeof(struct acpi_wmi_softc),
199 static devclass_t acpi_wmi_devclass;
200 DRIVER_MODULE(acpi_wmi, acpi, acpi_wmi_driver, acpi_wmi_devclass, NULL, NULL);
201 MODULE_VERSION(acpi_wmi, 1);
202 MODULE_DEPEND(acpi_wmi, acpi, 1, 1, 1);
203 static char *wmi_ids[] = {"PNP0C14", NULL};
206 * Probe for the PNP0C14 ACPI node
209 acpi_wmi_probe(device_t dev)
211 if (acpi_disabled("wmi") ||
212 ACPI_ID_PROBE(device_get_parent(dev), dev, wmi_ids) == NULL)
214 device_set_desc(dev, "ACPI-WMI mapping");
220 * Attach the device by:
221 * - Looking for the first ACPI EC device
222 * - Install the notify handler
223 * - Install the EC address space handler
224 * - Look for the _WDG node and read GUID information blocks
227 acpi_wmi_attach(device_t dev)
229 struct acpi_wmi_softc *sc;
233 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
234 sc = device_get_softc(dev);
237 ACPI_SERIAL_BEGIN(acpi_wmi);
239 sc->wmi_handle = acpi_get_handle(dev);
240 TAILQ_INIT(&wmi_info_list);
241 /* XXX Only works with one EC, but nearly all systems only have one. */
242 if ((sc->ec_dev = devclass_get_device(devclass_find("acpi_ec"), 0))
244 device_printf(dev, "cannot find EC device\n");
245 else if (ACPI_FAILURE((status = AcpiInstallNotifyHandler(sc->wmi_handle,
246 ACPI_DEVICE_NOTIFY, acpi_wmi_notify_handler, sc))))
247 device_printf(sc->wmi_dev, "couldn't install notify handler - %s\n",
248 AcpiFormatException(status));
249 else if (ACPI_FAILURE((status = AcpiInstallAddressSpaceHandler(
250 sc->wmi_handle, ACPI_ADR_SPACE_EC, acpi_wmi_ec_handler,
252 device_printf(sc->wmi_dev, "couldn't install EC handler - %s\n",
253 AcpiFormatException(status));
254 AcpiRemoveNotifyHandler(sc->wmi_handle, ACPI_DEVICE_NOTIFY,
255 acpi_wmi_notify_handler);
256 } else if (ACPI_FAILURE((status = acpi_wmi_read_wdg_blocks(
258 device_printf(sc->wmi_dev, "couldn't parse _WDG - %s\n",
259 AcpiFormatException(status));
260 AcpiRemoveNotifyHandler(sc->wmi_handle, ACPI_DEVICE_NOTIFY,
261 acpi_wmi_notify_handler);
262 AcpiRemoveAddressSpaceHandler(sc->wmi_handle, ACPI_ADR_SPACE_EC,
263 acpi_wmi_ec_handler);
265 sc->wmistat_dev_t = make_dev(&wmistat_ops, 0, UID_ROOT,
266 GID_WHEEL, 0644, "wmistat%d", device_get_unit(dev));
267 sc->wmistat_dev_t->si_drv1 = sc;
268 sc->wmistat_open_pid = 0;
269 sc->wmistat_bufptr = -1;
272 ACPI_SERIAL_END(acpi_wmi);
275 bus_generic_probe(dev);
276 ret = bus_generic_attach(dev);
283 * Detach the driver by:
284 * - Removing notification handler
285 * - Removing address space handler
286 * - Turning off event generation for all WExx event activated by
290 acpi_wmi_detach(device_t dev)
292 struct wmi_info *winfo, *tmp;
293 struct acpi_wmi_softc *sc;
296 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
297 sc = device_get_softc(dev);
298 ACPI_SERIAL_BEGIN(acpi_wmi);
300 if (sc->wmistat_open_pid != 0) {
303 AcpiRemoveNotifyHandler(sc->wmi_handle, ACPI_DEVICE_NOTIFY,
304 acpi_wmi_notify_handler);
305 AcpiRemoveAddressSpaceHandler(sc->wmi_handle,
306 ACPI_ADR_SPACE_EC, acpi_wmi_ec_handler);
307 TAILQ_FOREACH_MUTABLE(winfo, &wmi_info_list, wmi_list, tmp) {
308 if (winfo->event_handler)
309 acpi_wmi_toggle_we_event_generation(dev,
310 winfo, EVENT_GENERATION_OFF);
311 TAILQ_REMOVE(&wmi_info_list, winfo, wmi_list);
312 kfree(winfo, M_ACPIWMI);
314 if (sc->wmistat_bufptr != -1) {
315 sbuf_delete(&sc->wmistat_sbuf);
316 sc->wmistat_bufptr = -1;
318 sc->wmistat_open_pid = 0;
319 destroy_dev(sc->wmistat_dev_t);
322 ACPI_SERIAL_END(acpi_wmi);
329 * Check if the given GUID string (human readable format
330 * AABBCCDD-EEFF-GGHH-IIJJ-KKLLMMNNOOPP)
334 acpi_wmi_provides_guid_string_method(device_t dev, const char *guid_string)
336 struct wmi_info *winfo;
339 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
340 ACPI_SERIAL_BEGIN(acpi_wmi);
341 winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string);
342 ret = (winfo == NULL)?0:winfo->ginfo.max_instance+1;
343 ACPI_SERIAL_END(acpi_wmi);
349 * Call a method "method_id" on the given GUID block
350 * write result into user provided output buffer
353 acpi_wmi_evaluate_call_method(device_t dev, const char *guid_string,
354 UINT8 instance, UINT32 method_id, const ACPI_BUFFER *in, ACPI_BUFFER *out)
356 ACPI_OBJECT params[3];
357 ACPI_OBJECT_LIST input;
358 char method[5] = "WMxx";
359 struct wmi_info *winfo;
360 struct acpi_wmi_softc *sc;
363 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
365 sc = device_get_softc(dev);
366 ACPI_SERIAL_BEGIN(acpi_wmi);
367 if ((winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string))
369 status = AE_NOT_FOUND;
370 else if (!(winfo->ginfo.flags & ACPI_WMI_REGFLAG_METHOD))
371 status = AE_BAD_DATA;
372 else if (instance > winfo->ginfo.max_instance)
373 status = AE_BAD_PARAMETER;
375 params[0].Type = ACPI_TYPE_INTEGER;
376 params[0].Integer.Value = instance;
377 params[1].Type = ACPI_TYPE_INTEGER;
378 params[1].Integer.Value = method_id;
379 input.Pointer = params;
383 (winfo->ginfo.flags & ACPI_WMI_REGFLAG_STRING)
384 ?ACPI_TYPE_STRING:ACPI_TYPE_BUFFER;
385 params[2].Buffer.Length = in->Length;
386 params[2].Buffer.Pointer = in->Pointer;
389 method[2] = winfo->ginfo.oid[0];
390 method[3] = winfo->ginfo.oid[1];
391 status = AcpiEvaluateObject(sc->wmi_handle, method,
394 ACPI_SERIAL_END(acpi_wmi);
400 * Install a user provided event_handler on the given GUID
401 * provided *data will be passed on callback
402 * If there is already an existing event handler registered it will be silently
406 acpi_wmi_install_event_handler_method(device_t dev, const char *guid_string,
407 ACPI_NOTIFY_HANDLER event_handler, void *data)
409 struct wmi_info *winfo;
412 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
415 ACPI_SERIAL_BEGIN(acpi_wmi);
416 if (guid_string == NULL || event_handler == NULL)
417 status = AE_BAD_PARAMETER;
418 else if ((winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string))
420 status = AE_NOT_EXIST;
421 else if (winfo->event_handler != NULL ||
422 (status = acpi_wmi_toggle_we_event_generation(dev, winfo,
423 EVENT_GENERATION_ON)) == AE_OK) {
424 winfo->event_handler = event_handler;
425 winfo->event_handler_user_data = data;
427 ACPI_SERIAL_END(acpi_wmi);
433 * Remove a previously installed event handler from the given GUID
434 * If there was none installed, this call is silently discarded and
438 acpi_wmi_remove_event_handler_method(device_t dev, const char *guid_string)
440 struct wmi_info *winfo;
443 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
446 ACPI_SERIAL_BEGIN(acpi_wmi);
448 (winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string))
449 != NULL && winfo->event_handler) {
450 status = acpi_wmi_toggle_we_event_generation(dev, winfo,
451 EVENT_GENERATION_OFF);
452 winfo->event_handler = NULL;
453 winfo->event_handler_user_data = NULL;
455 ACPI_SERIAL_END(acpi_wmi);
461 * Get details on an event received through a callback registered
462 * through ACPI_WMI_REMOVE_EVENT_HANDLER into a user provided output buffer.
463 * (event_id equals "notify" passed in the callback)
466 acpi_wmi_get_event_data_method(device_t dev, UINT32 event_id, ACPI_BUFFER *out)
468 ACPI_OBJECT_LIST input;
469 ACPI_OBJECT params[1];
470 struct acpi_wmi_softc *sc;
471 struct wmi_info *winfo;
474 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
476 sc = device_get_softc(dev);
477 status = AE_NOT_FOUND;
478 ACPI_SERIAL_BEGIN(acpi_wmi);
479 params[0].Type = ACPI_TYPE_INTEGER;
480 params[0].Integer.Value = event_id;
481 input.Pointer = params;
483 TAILQ_FOREACH(winfo, &wmi_info_list, wmi_list) {
484 if ((winfo->ginfo.flags & ACPI_WMI_REGFLAG_EVENT) &&
485 ((UINT8) winfo->ginfo.oid[0] == event_id)) {
486 status = AcpiEvaluateObject(sc->wmi_handle, "_WED",
491 ACPI_SERIAL_END(acpi_wmi);
497 * Read a block of data from the given GUID (using WQxx (query))
498 * Will be returned in a user provided buffer (out).
499 * If the method is marked as expensive (ACPI_WMI_REGFLAG_EXPENSIVE)
500 * we will first call the WCxx control method to lock the node to
501 * lock the node for data collection and release it afterwards.
502 * (Failed WCxx calls are ignored to "support" broken implementations)
505 acpi_wmi_get_block_method(device_t dev, const char *guid_string, UINT8 instance,
508 char wc_method[5] = "WCxx";
509 char wq_method[5] = "WQxx";
510 ACPI_OBJECT_LIST wc_input;
511 ACPI_OBJECT_LIST wq_input;
512 ACPI_OBJECT wc_params[1];
513 ACPI_OBJECT wq_params[1];
514 ACPI_HANDLE wc_handle;
515 struct acpi_wmi_softc *sc;
516 struct wmi_info *winfo;
518 ACPI_STATUS wc_status;
520 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
522 sc = device_get_softc(dev);
523 wc_status = AE_ERROR;
524 ACPI_SERIAL_BEGIN(acpi_wmi);
525 if (guid_string == NULL || out == NULL)
526 status = AE_BAD_PARAMETER;
527 else if ((winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string))
530 else if (instance > winfo->ginfo.max_instance)
531 status = AE_BAD_PARAMETER;
532 else if ((winfo->ginfo.flags & ACPI_WMI_REGFLAG_EVENT) ||
533 (winfo->ginfo.flags & ACPI_WMI_REGFLAG_METHOD))
536 wq_params[0].Type = ACPI_TYPE_INTEGER;
537 wq_params[0].Integer.Value = instance;
538 wq_input.Pointer = wq_params;
540 if (winfo->ginfo.flags & ACPI_WMI_REGFLAG_EXPENSIVE) {
541 wc_params[0].Type = ACPI_TYPE_INTEGER;
542 wc_params[0].Integer.Value = 1;
543 wc_input.Pointer = wc_params;
545 wc_method[2] = winfo->ginfo.oid[0];
546 wc_method[3] = winfo->ginfo.oid[1];
547 wc_status = AcpiGetHandle(sc->wmi_handle, wc_method,
549 if (ACPI_SUCCESS(wc_status))
550 wc_status = AcpiEvaluateObject(wc_handle,
551 wc_method, &wc_input, NULL);
553 wq_method[2] = winfo->ginfo.oid[0];
554 wq_method[3] = winfo->ginfo.oid[1];
555 status = AcpiEvaluateObject(sc->wmi_handle, wq_method,
557 if ((winfo->ginfo.flags & ACPI_WMI_REGFLAG_EXPENSIVE)
558 && ACPI_SUCCESS(wc_status)) {
559 wc_params[0].Integer.Value = 0;
560 status = AcpiEvaluateObject(wc_handle, wc_method,
561 &wc_input, NULL); /* XXX this might be
566 ACPI_SERIAL_END(acpi_wmi);
572 * Write a block of data to the given GUID (using WSxx)
575 acpi_wmi_set_block_method(device_t dev, const char *guid_string, UINT8 instance,
576 const ACPI_BUFFER *in)
578 char method[5] = "WSxx";
579 ACPI_OBJECT_LIST input;
580 ACPI_OBJECT params[2];
581 struct wmi_info *winfo;
582 struct acpi_wmi_softc *sc;
585 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
587 sc = device_get_softc(dev);
588 ACPI_SERIAL_BEGIN(acpi_wmi);
589 if (guid_string == NULL || in == NULL)
590 status = AE_BAD_DATA;
591 else if ((winfo = acpi_wmi_lookup_wmi_info_by_guid_string(guid_string))
594 else if (instance > winfo->ginfo.max_instance)
595 status = AE_BAD_PARAMETER;
596 else if ((winfo->ginfo.flags & ACPI_WMI_REGFLAG_EVENT) ||
597 (winfo->ginfo.flags & ACPI_WMI_REGFLAG_METHOD))
600 params[0].Type = ACPI_TYPE_INTEGER;
601 params[0].Integer.Value = instance;
602 input.Pointer = params;
604 params[1].Type = (winfo->ginfo.flags & ACPI_WMI_REGFLAG_STRING)
605 ?ACPI_TYPE_STRING:ACPI_TYPE_BUFFER;
606 params[1].Buffer.Length = in->Length;
607 params[1].Buffer.Pointer = in->Pointer;
608 method[2] = winfo->ginfo.oid[0];
609 method[3] = winfo->ginfo.oid[1];
610 status = AcpiEvaluateObject(sc->wmi_handle, method,
613 ACPI_SERIAL_END(acpi_wmi);
619 * Handle events received and dispatch them to
620 * stakeholders that registered through ACPI_WMI_INSTALL_EVENT_HANDLER
623 acpi_wmi_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
625 ACPI_NOTIFY_HANDLER handler;
627 struct wmi_info *winfo;
629 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
633 ACPI_SERIAL_BEGIN(acpi_wmi);
634 TAILQ_FOREACH(winfo, &wmi_info_list, wmi_list) {
635 if ((winfo->ginfo.flags & ACPI_WMI_REGFLAG_EVENT) &&
636 ((UINT8) winfo->ginfo.oid[0] == notify)) {
637 if (winfo->event_handler) {
638 handler = winfo->event_handler;
639 handler_data = winfo->event_handler_user_data;
644 ACPI_SERIAL_END(acpi_wmi);
646 handler(h, notify, handler_data);
651 * Handle EC address space notifications reveived on the WDG node
652 * (this mimics EcAddressSpaceHandler in acpi_ec.c)
655 acpi_wmi_ec_handler(UINT32 function, ACPI_PHYSICAL_ADDRESS address,
656 UINT32 width, UINT64 *value, void *context,
657 void *region_context)
659 struct acpi_wmi_softc *sc;
665 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)address);
667 sc = (struct acpi_wmi_softc *)context;
668 if (width % 8 != 0 || value == NULL || context == NULL)
669 return (AE_BAD_PARAMETER);
670 if (address + (width / 8) - 1 > 0xFF)
671 return (AE_BAD_ADDRESS);
672 if (function == ACPI_READ)
677 for (i = 0; i < width; i += 8, ++ec_addr) {
680 status = ACPI_EC_READ(sc->ec_dev, ec_addr, &ec_data, 1);
681 if (ACPI_SUCCESS(status))
682 *value |= ec_data << i;
685 ec_data = (UINT8)((*value) >> i);
686 status = ACPI_EC_WRITE(sc->ec_dev, ec_addr, ec_data, 1);
689 device_printf(sc->wmi_dev,
690 "invalid acpi_wmi_ec_handler function %d\n",
692 status = AE_BAD_PARAMETER;
695 if (ACPI_FAILURE(status))
703 * Read GUID blocks from the _WDG node
704 * into wmi_info_list.
707 acpi_wmi_read_wdg_blocks(ACPI_HANDLE h)
709 ACPI_BUFFER out = {ACPI_ALLOCATE_BUFFER, NULL};
710 struct guid_info *ginfo;
712 struct wmi_info *winfo;
714 UINT32 wdg_block_count;
717 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
719 ACPI_SERIAL_ASSERT(acpi_wmi);
720 if (ACPI_FAILURE(status = AcpiEvaluateObject(h, "_WDG", NULL, &out)))
722 obj = (ACPI_OBJECT*) out.Pointer;
723 wdg_block_count = obj->Buffer.Length / sizeof(struct guid_info);
724 if ((ginfo = kmalloc(obj->Buffer.Length, M_ACPIWMI, M_NOWAIT))
726 AcpiOsFree(out.Pointer);
727 return (AE_NO_MEMORY);
729 memcpy(ginfo, obj->Buffer.Pointer, obj->Buffer.Length);
730 for (i = 0; i < wdg_block_count; ++i) {
731 if ((winfo = kmalloc(sizeof(struct wmi_info), M_ACPIWMI,
732 M_NOWAIT | M_ZERO)) == NULL) {
733 AcpiOsFree(out.Pointer);
734 kfree(ginfo, M_ACPIWMI);
735 return (AE_NO_MEMORY);
737 winfo->ginfo = ginfo[i];
738 TAILQ_INSERT_TAIL(&wmi_info_list, winfo, wmi_list);
740 AcpiOsFree(out.Pointer);
741 kfree(ginfo, M_ACPIWMI);
747 * Toggle event generation in for the given GUID (passed by winfo)
748 * Turn on to get notified (through acpi_wmi_notify_handler) if events happen
752 acpi_wmi_toggle_we_event_generation(device_t dev, struct wmi_info *winfo,
753 enum event_generation_state state)
755 char method[5] = "WExx";
756 ACPI_OBJECT_LIST input;
757 ACPI_OBJECT params[1];
758 struct acpi_wmi_softc *sc;
761 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
763 sc = device_get_softc(dev);
764 ACPI_SERIAL_ASSERT(acpi_wmi);
765 params[0].Type = ACPI_TYPE_INTEGER;
766 params[0].Integer.Value = state==EVENT_GENERATION_ON?1:0;
767 input.Pointer = params;
770 UINT8 hi = ((UINT8) winfo->ginfo.oid[0]) >> 4;
771 UINT8 lo = ((UINT8) winfo->ginfo.oid[0]) & 0xf;
772 method[2] = (hi > 9 ? hi + 55: hi + 48);
773 method[3] = (lo > 9 ? lo + 55: lo + 48);
774 status = AcpiEvaluateObject(sc->wmi_handle, method, &input, NULL);
775 if (status == AE_NOT_FOUND) status = AE_OK;
781 * Convert given two digit hex string (hexin) to an UINT8 referenced
783 * Return != 0 if the was a problem (invalid input)
785 static __inline int acpi_wmi_hex_to_int(const UINT8 *hexin, UINT8 *byteout)
792 if ('0' <= hi && hi <= '9')
794 else if ('A' <= hi && hi <= 'F')
796 else if ('a' <= hi && hi <= 'f')
800 if ('0' <= lo && lo <= '9')
802 else if ('A' <= lo && lo <= 'F')
804 else if ('a' <= lo && lo <= 'f')
808 *byteout = (hi << 4) + lo;
814 * Convert a human readable 36 character GUID into a 16byte
815 * machine readable one.
816 * The basic algorithm looks as follows:
817 * Input: AABBCCDD-EEFF-GGHH-IIJJ-KKLLMMNNOOPP
818 * Output: DCBAFEHGIJKLMNOP
819 * (AA BB CC etc. represent two digit hex numbers == bytes)
820 * Return != 0 if passed guid string is invalid
823 acpi_wmi_guid_string_to_guid(const UINT8 *guid_string, UINT8 *guid)
825 static const int mapping[20] = {3, 2, 1, 0, -1, 5, 4, -1, 7, 6, -1,
826 8, 9, -1, 10, 11, 12, 13, 14, 15};
829 for (i = 0; i < 20; ++i, ++guid_string) {
830 if (mapping[i] >= 0) {
831 if (acpi_wmi_hex_to_int(guid_string,
835 } else if (*guid_string != '-')
843 * Lookup a wmi_info structure in wmi_list based on a
844 * human readable GUID
845 * Return NULL if the GUID is unknown in the _WDG
847 static struct wmi_info*
848 acpi_wmi_lookup_wmi_info_by_guid_string(const char *guid_string)
851 struct wmi_info *winfo;
853 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
855 ACPI_SERIAL_ASSERT(acpi_wmi);
857 if (!acpi_wmi_guid_string_to_guid(guid_string, guid)) {
858 TAILQ_FOREACH(winfo, &wmi_info_list, wmi_list) {
859 if (!memcmp(winfo->ginfo.guid, guid, 16)) {
869 * open wmistat device
872 acpi_wmi_wmistat_open(struct dev_open_args *ap)
874 struct cdev *dev = ap->a_head.a_dev;
875 struct thread *td = curthread;
876 struct acpi_wmi_softc *sc;
879 if (dev == NULL || dev->si_drv1 == NULL)
883 ACPI_SERIAL_BEGIN(acpi_wmi);
884 if (sc->wmistat_open_pid != 0) {
888 if (sbuf_new(&sc->wmistat_sbuf, NULL, 4096, SBUF_AUTOEXTEND)
892 sc->wmistat_open_pid = td->td_proc->p_pid;
893 sc->wmistat_bufptr = 0;
897 ACPI_SERIAL_END(acpi_wmi);
903 * close wmistat device
906 acpi_wmi_wmistat_close(struct dev_close_args *ap)
908 struct cdev *dev = ap->a_head.a_dev;
909 struct acpi_wmi_softc *sc;
912 if (dev == NULL || dev->si_drv1 == NULL)
916 ACPI_SERIAL_BEGIN(acpi_wmi);
917 if (sc->wmistat_open_pid == 0) {
921 if (sc->wmistat_bufptr != -1) {
922 sbuf_delete(&sc->wmistat_sbuf);
923 sc->wmistat_bufptr = -1;
925 sc->wmistat_open_pid = 0;
928 ACPI_SERIAL_END(acpi_wmi);
934 * Read from wmistat guid information
937 acpi_wmi_wmistat_read(struct dev_read_args *ap)
939 struct cdev *dev = ap->a_head.a_dev;
940 struct uio *buf = ap->a_uio;
941 struct acpi_wmi_softc *sc;
942 struct wmi_info *winfo;
947 if (dev == NULL || dev->si_drv1 == NULL)
951 ACPI_SERIAL_BEGIN(acpi_wmi);
952 if (sc->wmistat_open_pid != buf->uio_td->td_proc->p_pid ||
953 sc->wmistat_bufptr == -1) {
957 if (!sbuf_done(&sc->wmistat_sbuf)) {
958 sbuf_printf(&sc->wmistat_sbuf, "GUID "
959 " INST EXPE METH STR "
961 TAILQ_FOREACH(winfo, &wmi_info_list, wmi_list) {
962 guid = (UINT8*)winfo->ginfo.guid;
963 sbuf_printf(&sc->wmistat_sbuf,
964 "{%02X%02X%02X%02X-%02X%02X-"
965 "%02X%02X-%02X%02X-%02X%02X"
966 "%02X%02X%02X%02X} %3d %-5s",
967 guid[3], guid[2], guid[1], guid[0],
971 guid[10], guid[11], guid[12],
972 guid[13], guid[14], guid[15],
973 winfo->ginfo.max_instance,
975 ACPI_WMI_REGFLAG_EXPENSIVE)?
978 if (winfo->ginfo.flags&ACPI_WMI_REGFLAG_METHOD)
979 sbuf_printf(&sc->wmistat_sbuf,
982 winfo->ginfo.oid[1]);
984 sbuf_printf(&sc->wmistat_sbuf, "NO ");
985 sbuf_printf(&sc->wmistat_sbuf, "%-4s",
987 ACPI_WMI_REGFLAG_STRING)?"YES":"NO"
989 if (winfo->ginfo.flags&ACPI_WMI_REGFLAG_EVENT)
990 sbuf_printf(&sc->wmistat_sbuf,
992 (UINT8)winfo->ginfo.oid[0],
993 winfo->event_handler==NULL?
996 sbuf_printf(&sc->wmistat_sbuf,
999 winfo->ginfo.oid[1]);
1001 sbuf_finish(&sc->wmistat_sbuf);
1003 if (sbuf_len(&sc->wmistat_sbuf) <= 0) {
1004 sbuf_delete(&sc->wmistat_sbuf);
1005 sc->wmistat_bufptr = -1;
1006 sc->wmistat_open_pid = 0;
1009 l = min(buf->uio_resid, sbuf_len(&sc->wmistat_sbuf) -
1010 sc->wmistat_bufptr);
1011 ret = (l > 0)?uiomove(sbuf_data(&sc->wmistat_sbuf) +
1012 sc->wmistat_bufptr, l, buf) : 0;
1013 sc->wmistat_bufptr += l;
1016 ACPI_SERIAL_END(acpi_wmi);