2 * Copyright (c) 2012 Alexander Motin <mav@FreeBSD.org>
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
35 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/sysctl.h>
41 #include <contrib/dev/acpica/include/acpi.h>
42 #include <contrib/dev/acpica/include/accommon.h>
43 #include <dev/acpica/acpivar.h>
44 #include "acpi_wmi_if.h"
46 #define _COMPONENT ACPI_OEM
47 ACPI_MODULE_NAME("ASUS-WMI")
49 #define ACPI_ASUS_WMI_MGMT_GUID "97845ED0-4E6D-11DE-8A39-0800200C9A66"
50 #define ACPI_ASUS_WMI_EVENT_GUID "0B3CBB35-E3C2-45ED-91C2-4C5A6D195D1C"
51 #define ACPI_EEEPC_WMI_EVENT_GUID "ABBC0F72-8EA1-11D1-00A0-C90629100000"
54 #define ASUS_WMI_METHODID_SPEC 0x43455053
55 #define ASUS_WMI_METHODID_SFUN 0x4E554653
56 #define ASUS_WMI_METHODID_DSTS 0x53544344
57 #define ASUS_WMI_METHODID_DSTS2 0x53545344
58 #define ASUS_WMI_METHODID_DEVS 0x53564544
59 #define ASUS_WMI_METHODID_INIT 0x54494E49
60 #define ASUS_WMI_METHODID_HKEY 0x59454B48
62 #define ASUS_WMI_UNSUPPORTED_METHOD 0xFFFFFFFE
65 #define ASUS_WMI_DEVID_HW_SWITCH 0x00010001
66 #define ASUS_WMI_DEVID_WIRELESS_LED 0x00010002
67 #define ASUS_WMI_DEVID_CWAP 0x00010003
68 #define ASUS_WMI_DEVID_WLAN 0x00010011
69 #define ASUS_WMI_DEVID_BLUETOOTH 0x00010013
70 #define ASUS_WMI_DEVID_GPS 0x00010015
71 #define ASUS_WMI_DEVID_WIMAX 0x00010017
72 #define ASUS_WMI_DEVID_WWAN3G 0x00010019
73 #define ASUS_WMI_DEVID_UWB 0x00010021
76 #define ASUS_WMI_DEVID_LED1 0x00020011
77 #define ASUS_WMI_DEVID_LED2 0x00020012
78 #define ASUS_WMI_DEVID_LED3 0x00020013
79 #define ASUS_WMI_DEVID_LED4 0x00020014
80 #define ASUS_WMI_DEVID_LED5 0x00020015
81 #define ASUS_WMI_DEVID_LED6 0x00020016
83 /* Backlight and Brightness */
84 #define ASUS_WMI_DEVID_BACKLIGHT 0x00050011
85 #define ASUS_WMI_DEVID_BRIGHTNESS 0x00050012
86 #define ASUS_WMI_DEVID_KBD_BACKLIGHT 0x00050021
87 #define ASUS_WMI_DEVID_LIGHT_SENSOR 0x00050022
90 #define ASUS_WMI_DEVID_CAMERA 0x00060013
91 #define ASUS_WMI_DEVID_CARDREADER 0x00080013
92 #define ASUS_WMI_DEVID_TOUCHPAD 0x00100011
93 #define ASUS_WMI_DEVID_TOUCHPAD_LED 0x00100012
94 #define ASUS_WMI_DEVID_THERMAL_CTRL 0x00110011
95 #define ASUS_WMI_DEVID_FAN_CTRL 0x00110012
96 #define ASUS_WMI_DEVID_PROCESSOR_STATE 0x00120012
99 #define ASUS_WMI_DSTS_STATUS_BIT 0x00000001
100 #define ASUS_WMI_DSTS_UNKNOWN_BIT 0x00000002
101 #define ASUS_WMI_DSTS_PRESENCE_BIT 0x00010000
102 #define ASUS_WMI_DSTS_USER_BIT 0x00020000
103 #define ASUS_WMI_DSTS_BIOS_BIT 0x00040000
104 #define ASUS_WMI_DSTS_BRIGHTNESS_MASK 0x000000FF
105 #define ASUS_WMI_DSTS_MAX_BRIGTH_MASK 0x0000FF00
107 struct acpi_asus_wmi_softc {
110 const char *notify_guid;
111 struct sysctl_ctx_list *sysctl_ctx;
112 struct sysctl_oid *sysctl_tree;
122 } acpi_asus_wmi_sysctls[] = {
125 .dev_id = ASUS_WMI_DEVID_HW_SWITCH,
126 .description = "hw_switch",
129 .name = "wireless_led",
130 .dev_id = ASUS_WMI_DEVID_WIRELESS_LED,
131 .description = "Wireless LED control",
135 .dev_id = ASUS_WMI_DEVID_CWAP,
136 .description = "Alt+F2 function",
140 .dev_id = ASUS_WMI_DEVID_WLAN,
141 .description = "WLAN power control",
145 .dev_id = ASUS_WMI_DEVID_BLUETOOTH,
146 .description = "Bluetooth power control",
150 .dev_id = ASUS_WMI_DEVID_GPS,
151 .description = "GPS power control",
155 .dev_id = ASUS_WMI_DEVID_WIMAX,
156 .description = "WiMAX power control",
160 .dev_id = ASUS_WMI_DEVID_WWAN3G,
161 .description = "WWAN-3G power control",
165 .dev_id = ASUS_WMI_DEVID_UWB,
166 .description = "UWB power control",
170 .dev_id = ASUS_WMI_DEVID_LED1,
171 .description = "LED1 control",
175 .dev_id = ASUS_WMI_DEVID_LED2,
176 .description = "LED2 control",
180 .dev_id = ASUS_WMI_DEVID_LED3,
181 .description = "LED3 control",
185 .dev_id = ASUS_WMI_DEVID_LED4,
186 .description = "LED4 control",
190 .dev_id = ASUS_WMI_DEVID_LED5,
191 .description = "LED5 control",
195 .dev_id = ASUS_WMI_DEVID_LED6,
196 .description = "LED6 control",
200 .dev_id = ASUS_WMI_DEVID_BACKLIGHT,
201 .description = "LCD backlight on/off control",
204 .name = "brightness",
205 .dev_id = ASUS_WMI_DEVID_BRIGHTNESS,
206 .description = "LCD backlight brightness control",
209 .name = "kbd_backlight",
210 .dev_id = ASUS_WMI_DEVID_KBD_BACKLIGHT,
211 .description = "Keyboard backlight brightness control",
214 .name = "light_sensor",
215 .dev_id = ASUS_WMI_DEVID_LIGHT_SENSOR,
216 .description = "Ambient light sensor",
220 .dev_id = ASUS_WMI_DEVID_CAMERA,
221 .description = "Camera power control",
224 .name = "cardreader",
225 .dev_id = ASUS_WMI_DEVID_CARDREADER,
226 .description = "Cardreader power control",
230 .dev_id = ASUS_WMI_DEVID_TOUCHPAD,
231 .description = "Touchpad control",
234 .name = "touchpad_led",
235 .dev_id = ASUS_WMI_DEVID_TOUCHPAD_LED,
236 .description = "Touchpad LED control",
239 .name = "themperature",
240 .dev_id = ASUS_WMI_DEVID_THERMAL_CTRL,
241 .description = "Temperature (C)",
246 .dev_id = ASUS_WMI_DEVID_FAN_CTRL,
247 .description = "Fan speed (0-3)",
251 .name = "processor_state",
252 .dev_id = ASUS_WMI_DEVID_PROCESSOR_STATE,
258 ACPI_SERIAL_DECL(asus_wmi, "ASUS WMI device");
260 static void acpi_asus_wmi_identify(driver_t *driver, device_t parent);
261 static int acpi_asus_wmi_probe(device_t dev);
262 static int acpi_asus_wmi_attach(device_t dev);
263 static int acpi_asus_wmi_detach(device_t dev);
265 static int acpi_asus_wmi_sysctl(SYSCTL_HANDLER_ARGS);
266 static int acpi_asus_wmi_sysctl_set(struct acpi_asus_wmi_softc *sc, int dev_id,
267 int arg, int oldarg);
268 static int acpi_asus_wmi_sysctl_get(struct acpi_asus_wmi_softc *sc, int dev_id);
269 static int acpi_asus_wmi_evaluate_method(device_t wmi_dev, int method,
270 UINT32 arg0, UINT32 arg1, UINT32 *retval);
271 static int acpi_wpi_asus_get_devstate(struct acpi_asus_wmi_softc *sc,
272 UINT32 dev_id, UINT32 *retval);
273 static int acpi_wpi_asus_set_devstate(struct acpi_asus_wmi_softc *sc,
274 UINT32 dev_id, UINT32 ctrl_param, UINT32 *retval);
275 static void acpi_asus_wmi_notify(ACPI_HANDLE h, UINT32 notify, void *context);
277 static device_method_t acpi_asus_wmi_methods[] = {
278 DEVMETHOD(device_identify, acpi_asus_wmi_identify),
279 DEVMETHOD(device_probe, acpi_asus_wmi_probe),
280 DEVMETHOD(device_attach, acpi_asus_wmi_attach),
281 DEVMETHOD(device_detach, acpi_asus_wmi_detach),
286 static driver_t acpi_asus_wmi_driver = {
288 acpi_asus_wmi_methods,
289 sizeof(struct acpi_asus_wmi_softc),
292 static devclass_t acpi_asus_wmi_devclass;
294 DRIVER_MODULE(acpi_asus_wmi, acpi_wmi, acpi_asus_wmi_driver,
295 acpi_asus_wmi_devclass, 0, 0);
296 MODULE_DEPEND(acpi_asus_wmi, acpi_wmi, 1, 1, 1);
297 MODULE_DEPEND(acpi_asus_wmi, acpi, 1, 1, 1);
300 acpi_asus_wmi_identify(driver_t *driver, device_t parent)
303 /* Don't do anything if driver is disabled. */
304 if (acpi_disabled("asus_wmi"))
307 /* Add only a single device instance. */
308 if (device_find_child(parent, "acpi_asus_wmi", -1) != NULL)
311 /* Check management GUID to see whether system is compatible. */
312 if (!ACPI_WMI_PROVIDES_GUID_STRING(parent,
313 ACPI_ASUS_WMI_MGMT_GUID))
316 if (BUS_ADD_CHILD(parent, 0, "acpi_asus_wmi", -1) == NULL)
317 device_printf(parent, "add acpi_asus_wmi child failed\n");
321 acpi_asus_wmi_probe(device_t dev)
324 if (!ACPI_WMI_PROVIDES_GUID_STRING(device_get_parent(dev),
325 ACPI_ASUS_WMI_MGMT_GUID))
327 device_set_desc(dev, "ASUS WMI device");
332 acpi_asus_wmi_attach(device_t dev)
334 struct acpi_asus_wmi_softc *sc;
338 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
340 sc = device_get_softc(dev);
342 sc->wmi_dev = device_get_parent(dev);
345 /* Check management GUID. */
346 if (!ACPI_WMI_PROVIDES_GUID_STRING(sc->wmi_dev,
347 ACPI_ASUS_WMI_MGMT_GUID)) {
349 "WMI device does not provide the ASUS management GUID\n");
353 /* Find proper DSTS method. */
354 sc->dsts_id = ASUS_WMI_METHODID_DSTS;
356 for (i = 0; acpi_asus_wmi_sysctls[i].name != NULL; ++i) {
357 dev_id = acpi_asus_wmi_sysctls[i].dev_id;
358 if (acpi_wpi_asus_get_devstate(sc, dev_id, &val))
362 if (acpi_asus_wmi_sysctls[i].name == NULL) {
363 if (sc->dsts_id == ASUS_WMI_METHODID_DSTS) {
364 sc->dsts_id = ASUS_WMI_METHODID_DSTS2;
367 device_printf(dev, "Can not detect DSTS method ID\n");
372 /* Find proper and attach to notufy GUID. */
373 if (ACPI_WMI_PROVIDES_GUID_STRING(sc->wmi_dev,
374 ACPI_ASUS_WMI_EVENT_GUID))
375 sc->notify_guid = ACPI_ASUS_WMI_EVENT_GUID;
376 else if (ACPI_WMI_PROVIDES_GUID_STRING(sc->wmi_dev,
377 ACPI_EEEPC_WMI_EVENT_GUID))
378 sc->notify_guid = ACPI_EEEPC_WMI_EVENT_GUID;
380 sc->notify_guid = NULL;
381 if (sc->notify_guid != NULL) {
382 if (ACPI_WMI_INSTALL_EVENT_HANDLER(sc->wmi_dev,
383 sc->notify_guid, acpi_asus_wmi_notify, dev))
384 sc->notify_guid = NULL;
386 if (sc->notify_guid == NULL)
387 device_printf(dev, "Could not install event handler!\n");
390 if (!acpi_asus_wmi_evaluate_method(sc->wmi_dev,
391 ASUS_WMI_METHODID_INIT, 0, 0, &val) && bootverbose)
392 device_printf(dev, "Initialization: %#x\n", val);
393 if (!acpi_asus_wmi_evaluate_method(sc->wmi_dev,
394 ASUS_WMI_METHODID_SPEC, 0, 0x9, &val) && bootverbose)
395 device_printf(dev, "WMI BIOS version: %d.%d\n",
396 val >> 16, val & 0xFF);
397 if (!acpi_asus_wmi_evaluate_method(sc->wmi_dev,
398 ASUS_WMI_METHODID_SFUN, 0, 0, &val) && bootverbose)
399 device_printf(dev, "SFUN value: %#x\n", val);
401 ACPI_SERIAL_BEGIN(asus_wmi);
403 sc->sysctl_ctx = device_get_sysctl_ctx(dev);
404 sc->sysctl_tree = device_get_sysctl_tree(dev);
405 SYSCTL_ADD_INT(sc->sysctl_ctx,
406 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
407 "handle_keys", CTLFLAG_RW, &sc->handle_keys,
408 0, "Handle some hardware keys inside the driver");
409 for (i = 0; acpi_asus_wmi_sysctls[i].name != NULL; ++i) {
410 dev_id = acpi_asus_wmi_sysctls[i].dev_id;
411 if (acpi_wpi_asus_get_devstate(sc, dev_id, &val))
414 case ASUS_WMI_DEVID_THERMAL_CTRL:
415 case ASUS_WMI_DEVID_PROCESSOR_STATE:
416 case ASUS_WMI_DEVID_FAN_CTRL:
417 case ASUS_WMI_DEVID_BRIGHTNESS:
422 if ((val & ASUS_WMI_DSTS_PRESENCE_BIT) == 0)
427 if (acpi_asus_wmi_sysctls[i].flag_rdonly != 0) {
428 SYSCTL_ADD_PROC(sc->sysctl_ctx,
429 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
430 acpi_asus_wmi_sysctls[i].name,
431 CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
432 sc, i, acpi_asus_wmi_sysctl, "I",
433 acpi_asus_wmi_sysctls[i].description);
435 SYSCTL_ADD_PROC(sc->sysctl_ctx,
436 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
437 acpi_asus_wmi_sysctls[i].name,
438 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
439 sc, i, acpi_asus_wmi_sysctl, "I",
440 acpi_asus_wmi_sysctls[i].description);
443 ACPI_SERIAL_END(asus_wmi);
449 acpi_asus_wmi_detach(device_t dev)
451 struct acpi_asus_wmi_softc *sc = device_get_softc(dev);
453 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__);
456 ACPI_WMI_REMOVE_EVENT_HANDLER(dev, sc->notify_guid);
462 acpi_asus_wmi_sysctl(SYSCTL_HANDLER_ARGS)
464 struct acpi_asus_wmi_softc *sc;
471 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
473 sc = (struct acpi_asus_wmi_softc *)oidp->oid_arg1;
474 function = oidp->oid_arg2;
475 dev_id = acpi_asus_wmi_sysctls[function].dev_id;
477 ACPI_SERIAL_BEGIN(asus_wmi);
478 arg = acpi_asus_wmi_sysctl_get(sc, dev_id);
480 error = sysctl_handle_int(oidp, &arg, 0, req);
481 if (!error && req->newptr != NULL)
482 error = acpi_asus_wmi_sysctl_set(sc, dev_id, arg, oldarg);
483 ACPI_SERIAL_END(asus_wmi);
489 acpi_asus_wmi_sysctl_get(struct acpi_asus_wmi_softc *sc, int dev_id)
493 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
494 ACPI_SERIAL_ASSERT(asus_wmi);
496 acpi_wpi_asus_get_devstate(sc, dev_id, &val);
499 case ASUS_WMI_DEVID_THERMAL_CTRL:
500 val = (val - 2731 + 5) / 10;
502 case ASUS_WMI_DEVID_PROCESSOR_STATE:
503 case ASUS_WMI_DEVID_FAN_CTRL:
505 case ASUS_WMI_DEVID_BRIGHTNESS:
506 val &= ASUS_WMI_DSTS_BRIGHTNESS_MASK;
508 case ASUS_WMI_DEVID_KBD_BACKLIGHT:
512 if (val & ASUS_WMI_DSTS_UNKNOWN_BIT)
515 val = !!(val & ASUS_WMI_DSTS_STATUS_BIT);
523 acpi_asus_wmi_sysctl_set(struct acpi_asus_wmi_softc *sc, int dev_id, int arg, int oldarg)
525 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
526 ACPI_SERIAL_ASSERT(asus_wmi);
529 case ASUS_WMI_DEVID_KBD_BACKLIGHT:
536 acpi_wpi_asus_set_devstate(sc, dev_id, arg, NULL);
542 acpi_asus_wmi_free_buffer(ACPI_BUFFER* buf) {
543 if (buf && buf->Pointer) {
544 AcpiOsFree(buf->Pointer);
549 acpi_asus_wmi_notify(ACPI_HANDLE h, UINT32 notify, void *context)
551 device_t dev = context;
552 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
556 struct acpi_asus_wmi_softc *sc = device_get_softc(dev);
557 ACPI_BUFFER response = { ACPI_ALLOCATE_BUFFER, NULL };
559 ACPI_WMI_GET_EVENT_DATA(sc->wmi_dev, notify, &response);
560 obj = (ACPI_OBJECT*) response.Pointer;
561 if (obj && obj->Type == ACPI_TYPE_INTEGER) {
562 code = obj->Integer.Value;
563 acpi_UserNotify("ASUS", ACPI_ROOT_OBJECT,
566 if (code && sc->handle_keys) {
567 /* Keyboard backlight control. */
568 if (code == 0xc4 || code == 0xc5) {
569 acpi_wpi_asus_get_devstate(sc,
570 ASUS_WMI_DEVID_KBD_BACKLIGHT, &val);
579 acpi_wpi_asus_set_devstate(sc,
580 ASUS_WMI_DEVID_KBD_BACKLIGHT, val, NULL);
582 /* Touchpad control. */
584 acpi_wpi_asus_get_devstate(sc,
585 ASUS_WMI_DEVID_TOUCHPAD, &val);
587 acpi_wpi_asus_set_devstate(sc,
588 ASUS_WMI_DEVID_TOUCHPAD, val, NULL);
591 acpi_asus_wmi_free_buffer(&response);
595 acpi_asus_wmi_evaluate_method(device_t wmi_dev, int method,
596 UINT32 arg0, UINT32 arg1, UINT32 *retval)
598 UINT32 params[2] = { arg0, arg1 };
601 ACPI_BUFFER in = { sizeof(params), ¶ms };
602 ACPI_BUFFER out = { ACPI_ALLOCATE_BUFFER, NULL };
604 if (ACPI_FAILURE(ACPI_WMI_EVALUATE_CALL(wmi_dev,
605 ACPI_ASUS_WMI_MGMT_GUID, 1, method, &in, &out))) {
606 acpi_asus_wmi_free_buffer(&out);
610 if (obj && obj->Type == ACPI_TYPE_INTEGER)
611 result = (UINT32) obj->Integer.Value;
614 acpi_asus_wmi_free_buffer(&out);
617 return (result == ASUS_WMI_UNSUPPORTED_METHOD ? -ENODEV : 0);
621 acpi_wpi_asus_get_devstate(struct acpi_asus_wmi_softc *sc,
622 UINT32 dev_id, UINT32 *retval)
625 return (acpi_asus_wmi_evaluate_method(sc->wmi_dev,
626 sc->dsts_id, dev_id, 0, retval));
630 acpi_wpi_asus_set_devstate(struct acpi_asus_wmi_softc *sc,
631 UINT32 dev_id, UINT32 ctrl_param, UINT32 *retval)
634 return (acpi_asus_wmi_evaluate_method(sc->wmi_dev,
635 ASUS_WMI_METHODID_DEVS, dev_id, ctrl_param, retval));