2 * ACPI-WMI mapping driver
4 * Copyright (C) 2007-2008 Carlos Corbacho <carlos@strangeworlds.co.uk>
6 * GUID parsing code from ldm.c is:
7 * Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
8 * Copyright (c) 2001-2007 Anton Altaparmakov
9 * Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
11 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or (at
16 * your option) any later version.
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
27 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/kernel.h>
33 #include <linux/init.h>
34 #include <linux/types.h>
35 #include <linux/device.h>
36 #include <linux/list.h>
37 #include <linux/acpi.h>
38 #include <linux/slab.h>
39 #include <linux/module.h>
40 #include <linux/uuid.h>
42 ACPI_MODULE_NAME("wmi");
43 MODULE_AUTHOR("Carlos Corbacho");
44 MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
45 MODULE_LICENSE("GPL");
47 #define ACPI_WMI_CLASS "wmi"
49 static LIST_HEAD(wmi_block_list);
56 unsigned char notify_id;
57 unsigned char reserved;
65 struct list_head list;
66 struct guid_block gblock;
68 wmi_notify_handler handler;
75 * If the GUID data block is marked as expensive, we must enable and
76 * explicitily disable data collection.
78 #define ACPI_WMI_EXPENSIVE 0x1
79 #define ACPI_WMI_METHOD 0x2 /* GUID is a method */
80 #define ACPI_WMI_STRING 0x4 /* GUID takes & returns a string */
81 #define ACPI_WMI_EVENT 0x8 /* GUID is an event */
83 static bool debug_event;
84 module_param(debug_event, bool, 0444);
85 MODULE_PARM_DESC(debug_event,
86 "Log WMI Events [0/1]");
88 static bool debug_dump_wdg;
89 module_param(debug_dump_wdg, bool, 0444);
90 MODULE_PARM_DESC(debug_dump_wdg,
91 "Dump available WMI interfaces [0/1]");
93 static int acpi_wmi_remove(struct acpi_device *device);
94 static int acpi_wmi_add(struct acpi_device *device);
95 static void acpi_wmi_notify(struct acpi_device *device, u32 event);
97 static const struct acpi_device_id wmi_device_ids[] = {
102 MODULE_DEVICE_TABLE(acpi, wmi_device_ids);
104 static struct acpi_driver acpi_wmi_driver = {
106 .class = ACPI_WMI_CLASS,
107 .ids = wmi_device_ids,
110 .remove = acpi_wmi_remove,
111 .notify = acpi_wmi_notify,
116 * GUID parsing functions
119 static bool find_guid(const char *guid_string, struct wmi_block **out)
122 struct wmi_block *wblock;
123 struct guid_block *block;
126 if (uuid_le_to_bin(guid_string, &guid_input))
129 list_for_each(p, &wmi_block_list) {
130 wblock = list_entry(p, struct wmi_block, list);
131 block = &wblock->gblock;
133 if (memcmp(block->guid, &guid_input, 16) == 0) {
142 static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
144 struct guid_block *block = NULL;
149 block = &wblock->gblock;
150 handle = wblock->handle;
152 snprintf(method, 5, "WE%02X", block->notify_id);
153 status = acpi_execute_simple_method(handle, method, enable);
155 if (status != AE_OK && status != AE_NOT_FOUND)
162 * Exported WMI functions
165 * wmi_evaluate_method - Evaluate a WMI method
166 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
167 * @instance: Instance index
168 * @method_id: Method ID to call
169 * &in: Buffer containing input for the method call
170 * &out: Empty buffer to return the method results
172 * Call an ACPI-WMI method
174 acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
175 u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
177 struct guid_block *block = NULL;
178 struct wmi_block *wblock = NULL;
181 struct acpi_object_list input;
182 union acpi_object params[3];
183 char method[5] = "WM";
185 if (!find_guid(guid_string, &wblock))
188 block = &wblock->gblock;
189 handle = wblock->handle;
191 if (!(block->flags & ACPI_WMI_METHOD))
194 if (block->instance_count < instance)
195 return AE_BAD_PARAMETER;
198 input.pointer = params;
199 params[0].type = ACPI_TYPE_INTEGER;
200 params[0].integer.value = instance;
201 params[1].type = ACPI_TYPE_INTEGER;
202 params[1].integer.value = method_id;
207 if (block->flags & ACPI_WMI_STRING) {
208 params[2].type = ACPI_TYPE_STRING;
210 params[2].type = ACPI_TYPE_BUFFER;
212 params[2].buffer.length = in->length;
213 params[2].buffer.pointer = in->pointer;
216 strncat(method, block->object_id, 2);
218 status = acpi_evaluate_object(handle, method, &input, out);
222 EXPORT_SYMBOL_GPL(wmi_evaluate_method);
225 * wmi_query_block - Return contents of a WMI block
226 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
227 * @instance: Instance index
228 * &out: Empty buffer to return the contents of the data block to
230 * Return the contents of an ACPI-WMI data block to a buffer
232 acpi_status wmi_query_block(const char *guid_string, u8 instance,
233 struct acpi_buffer *out)
235 struct guid_block *block = NULL;
236 struct wmi_block *wblock = NULL;
238 acpi_status status, wc_status = AE_ERROR;
239 struct acpi_object_list input;
240 union acpi_object wq_params[1];
242 char wc_method[5] = "WC";
244 if (!guid_string || !out)
245 return AE_BAD_PARAMETER;
247 if (!find_guid(guid_string, &wblock))
250 block = &wblock->gblock;
251 handle = wblock->handle;
253 if (block->instance_count < instance)
254 return AE_BAD_PARAMETER;
256 /* Check GUID is a data block */
257 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
261 input.pointer = wq_params;
262 wq_params[0].type = ACPI_TYPE_INTEGER;
263 wq_params[0].integer.value = instance;
266 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
269 if (block->flags & ACPI_WMI_EXPENSIVE) {
270 strncat(wc_method, block->object_id, 2);
273 * Some GUIDs break the specification by declaring themselves
274 * expensive, but have no corresponding WCxx method. So we
275 * should not fail if this happens.
277 if (acpi_has_method(handle, wc_method))
278 wc_status = acpi_execute_simple_method(handle,
282 strcpy(method, "WQ");
283 strncat(method, block->object_id, 2);
285 status = acpi_evaluate_object(handle, method, &input, out);
288 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
289 * the WQxx method failed - we should disable collection anyway.
291 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
293 * Ignore whether this WCxx call succeeds or not since
294 * the previously executed WQxx method call might have
295 * succeeded, and returning the failing status code
296 * of this call would throw away the result of the WQxx
297 * call, potentially leaking memory.
299 acpi_execute_simple_method(handle, wc_method, 0);
304 EXPORT_SYMBOL_GPL(wmi_query_block);
307 * wmi_set_block - Write to a WMI block
308 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
309 * @instance: Instance index
310 * &in: Buffer containing new values for the data block
312 * Write the contents of the input buffer to an ACPI-WMI data block
314 acpi_status wmi_set_block(const char *guid_string, u8 instance,
315 const struct acpi_buffer *in)
317 struct guid_block *block = NULL;
318 struct wmi_block *wblock = NULL;
320 struct acpi_object_list input;
321 union acpi_object params[2];
322 char method[5] = "WS";
324 if (!guid_string || !in)
327 if (!find_guid(guid_string, &wblock))
330 block = &wblock->gblock;
331 handle = wblock->handle;
333 if (block->instance_count < instance)
334 return AE_BAD_PARAMETER;
336 /* Check GUID is a data block */
337 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
341 input.pointer = params;
342 params[0].type = ACPI_TYPE_INTEGER;
343 params[0].integer.value = instance;
345 if (block->flags & ACPI_WMI_STRING) {
346 params[1].type = ACPI_TYPE_STRING;
348 params[1].type = ACPI_TYPE_BUFFER;
350 params[1].buffer.length = in->length;
351 params[1].buffer.pointer = in->pointer;
353 strncat(method, block->object_id, 2);
355 return acpi_evaluate_object(handle, method, &input, NULL);
357 EXPORT_SYMBOL_GPL(wmi_set_block);
359 static void wmi_dump_wdg(const struct guid_block *g)
361 pr_info("%pUL:\n", g->guid);
362 pr_info("\tobject_id: %c%c\n", g->object_id[0], g->object_id[1]);
363 pr_info("\tnotify_id: %02X\n", g->notify_id);
364 pr_info("\treserved: %02X\n", g->reserved);
365 pr_info("\tinstance_count: %d\n", g->instance_count);
366 pr_info("\tflags: %#x", g->flags);
368 if (g->flags & ACPI_WMI_EXPENSIVE)
369 pr_cont(" ACPI_WMI_EXPENSIVE");
370 if (g->flags & ACPI_WMI_METHOD)
371 pr_cont(" ACPI_WMI_METHOD");
372 if (g->flags & ACPI_WMI_STRING)
373 pr_cont(" ACPI_WMI_STRING");
374 if (g->flags & ACPI_WMI_EVENT)
375 pr_cont(" ACPI_WMI_EVENT");
381 static void wmi_notify_debug(u32 value, void *context)
383 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
384 union acpi_object *obj;
387 status = wmi_get_event_data(value, &response);
388 if (status != AE_OK) {
389 pr_info("bad event status 0x%x\n", status);
393 obj = (union acpi_object *)response.pointer;
398 pr_info("DEBUG Event ");
400 case ACPI_TYPE_BUFFER:
401 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
403 case ACPI_TYPE_STRING:
404 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
406 case ACPI_TYPE_INTEGER:
407 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
409 case ACPI_TYPE_PACKAGE:
410 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
413 pr_cont("object type 0x%X\n", obj->type);
419 * wmi_install_notify_handler - Register handler for WMI events
420 * @handler: Function to handle notifications
421 * @data: Data to be returned to handler when event is fired
423 * Register a handler for events sent to the ACPI-WMI mapper device.
425 acpi_status wmi_install_notify_handler(const char *guid,
426 wmi_notify_handler handler, void *data)
428 struct wmi_block *block;
429 acpi_status status = AE_NOT_EXIST;
433 if (!guid || !handler)
434 return AE_BAD_PARAMETER;
436 if (uuid_le_to_bin(guid, &guid_input))
437 return AE_BAD_PARAMETER;
439 list_for_each(p, &wmi_block_list) {
440 acpi_status wmi_status;
441 block = list_entry(p, struct wmi_block, list);
443 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
444 if (block->handler &&
445 block->handler != wmi_notify_debug)
446 return AE_ALREADY_ACQUIRED;
448 block->handler = handler;
449 block->handler_data = data;
451 wmi_status = wmi_method_enable(block, 1);
452 if ((wmi_status != AE_OK) ||
453 ((wmi_status == AE_OK) && (status == AE_NOT_EXIST)))
460 EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
463 * wmi_uninstall_notify_handler - Unregister handler for WMI events
465 * Unregister handler for events sent to the ACPI-WMI mapper device.
467 acpi_status wmi_remove_notify_handler(const char *guid)
469 struct wmi_block *block;
470 acpi_status status = AE_NOT_EXIST;
475 return AE_BAD_PARAMETER;
477 if (uuid_le_to_bin(guid, &guid_input))
478 return AE_BAD_PARAMETER;
480 list_for_each(p, &wmi_block_list) {
481 acpi_status wmi_status;
482 block = list_entry(p, struct wmi_block, list);
484 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
485 if (!block->handler ||
486 block->handler == wmi_notify_debug)
487 return AE_NULL_ENTRY;
490 block->handler = wmi_notify_debug;
493 wmi_status = wmi_method_enable(block, 0);
494 block->handler = NULL;
495 block->handler_data = NULL;
496 if ((wmi_status != AE_OK) ||
497 ((wmi_status == AE_OK) &&
498 (status == AE_NOT_EXIST)))
506 EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
509 * wmi_get_event_data - Get WMI data associated with an event
511 * @event: Event to find
512 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
514 * Returns extra data associated with an event in WMI.
516 acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
518 struct acpi_object_list input;
519 union acpi_object params[1];
520 struct guid_block *gblock;
521 struct wmi_block *wblock;
525 input.pointer = params;
526 params[0].type = ACPI_TYPE_INTEGER;
527 params[0].integer.value = event;
529 list_for_each(p, &wmi_block_list) {
530 wblock = list_entry(p, struct wmi_block, list);
531 gblock = &wblock->gblock;
533 if ((gblock->flags & ACPI_WMI_EVENT) &&
534 (gblock->notify_id == event))
535 return acpi_evaluate_object(wblock->handle, "_WED",
541 EXPORT_SYMBOL_GPL(wmi_get_event_data);
544 * wmi_has_guid - Check if a GUID is available
545 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
547 * Check if a given GUID is defined by _WDG
549 bool wmi_has_guid(const char *guid_string)
551 return find_guid(guid_string, NULL);
553 EXPORT_SYMBOL_GPL(wmi_has_guid);
558 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
561 struct wmi_block *wblock;
563 wblock = dev_get_drvdata(dev);
569 return sprintf(buf, "wmi:%pUL\n", wblock->gblock.guid);
571 static DEVICE_ATTR_RO(modalias);
573 static struct attribute *wmi_attrs[] = {
574 &dev_attr_modalias.attr,
577 ATTRIBUTE_GROUPS(wmi);
579 static int wmi_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
581 char guid_string[37];
583 struct wmi_block *wblock;
585 if (add_uevent_var(env, "MODALIAS="))
588 wblock = dev_get_drvdata(dev);
592 sprintf(guid_string, "%pUL", wblock->gblock.guid);
594 strcpy(&env->buf[env->buflen - 1], "wmi:");
595 memcpy(&env->buf[env->buflen - 1 + 4], guid_string, 36);
601 static void wmi_dev_free(struct device *dev)
603 struct wmi_block *wmi_block = container_of(dev, struct wmi_block, dev);
608 static struct class wmi_class = {
610 .dev_release = wmi_dev_free,
611 .dev_uevent = wmi_dev_uevent,
612 .dev_groups = wmi_groups,
615 static int wmi_create_device(const struct guid_block *gblock,
616 struct wmi_block *wblock, acpi_handle handle)
618 wblock->dev.class = &wmi_class;
620 dev_set_name(&wblock->dev, "%pUL", gblock->guid);
622 dev_set_drvdata(&wblock->dev, wblock);
624 return device_register(&wblock->dev);
627 static void wmi_free_devices(void)
629 struct wmi_block *wblock, *next;
631 /* Delete devices for all the GUIDs */
632 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
633 list_del(&wblock->list);
634 if (wblock->dev.class)
635 device_unregister(&wblock->dev);
641 static bool guid_already_parsed(const char *guid_string)
643 struct wmi_block *wblock;
645 list_for_each_entry(wblock, &wmi_block_list, list)
646 if (memcmp(wblock->gblock.guid, guid_string, 16) == 0)
653 * Parse the _WDG method for the GUID data blocks
655 static int parse_wdg(acpi_handle handle)
657 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
658 union acpi_object *obj;
659 const struct guid_block *gblock;
660 struct wmi_block *wblock;
665 status = acpi_evaluate_object(handle, "_WDG", NULL, &out);
666 if (ACPI_FAILURE(status))
669 obj = (union acpi_object *) out.pointer;
673 if (obj->type != ACPI_TYPE_BUFFER) {
675 goto out_free_pointer;
678 gblock = (const struct guid_block *)obj->buffer.pointer;
679 total = obj->buffer.length / sizeof(struct guid_block);
681 for (i = 0; i < total; i++) {
683 wmi_dump_wdg(&gblock[i]);
685 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
689 wblock->handle = handle;
690 wblock->gblock = gblock[i];
693 Some WMI devices, like those for nVidia hooks, have a
694 duplicate GUID. It's not clear what we should do in this
695 case yet, so for now, we'll just ignore the duplicate
698 if (!guid_already_parsed(gblock[i].guid)) {
699 retval = wmi_create_device(&gblock[i], wblock, handle);
702 goto out_free_pointer;
706 list_add_tail(&wblock->list, &wmi_block_list);
709 wblock->handler = wmi_notify_debug;
710 wmi_method_enable(wblock, 1);
723 * WMI can have EmbeddedControl access regions. In which case, we just want to
724 * hand these off to the EC driver.
727 acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
728 u32 bits, u64 *value,
729 void *handler_context, void *region_context)
731 int result = 0, i = 0;
734 if ((address > 0xFF) || !value)
735 return AE_BAD_PARAMETER;
737 if (function != ACPI_READ && function != ACPI_WRITE)
738 return AE_BAD_PARAMETER;
741 return AE_BAD_PARAMETER;
743 if (function == ACPI_READ) {
744 result = ec_read(address, &temp);
745 (*value) |= ((u64)temp) << i;
747 temp = 0xff & ((*value) >> i);
748 result = ec_write(address, temp);
753 return AE_BAD_PARAMETER;
766 static void acpi_wmi_notify(struct acpi_device *device, u32 event)
768 struct guid_block *block;
769 struct wmi_block *wblock;
772 list_for_each(p, &wmi_block_list) {
773 wblock = list_entry(p, struct wmi_block, list);
774 block = &wblock->gblock;
776 if ((block->flags & ACPI_WMI_EVENT) &&
777 (block->notify_id == event)) {
779 wblock->handler(event, wblock->handler_data);
781 pr_info("DEBUG Event GUID: %pUL\n",
782 wblock->gblock.guid);
785 acpi_bus_generate_netlink_event(
786 device->pnp.device_class, dev_name(&device->dev),
793 static int acpi_wmi_remove(struct acpi_device *device)
795 acpi_remove_address_space_handler(device->handle,
796 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
802 static int acpi_wmi_add(struct acpi_device *device)
807 status = acpi_install_address_space_handler(device->handle,
809 &acpi_wmi_ec_space_handler,
811 if (ACPI_FAILURE(status)) {
812 pr_err("Error installing EC region handler\n");
816 error = parse_wdg(device->handle);
818 acpi_remove_address_space_handler(device->handle,
820 &acpi_wmi_ec_space_handler);
821 pr_err("Failed to parse WDG method\n");
828 static int __init acpi_wmi_init(void)
835 error = class_register(&wmi_class);
839 error = acpi_bus_register_driver(&acpi_wmi_driver);
841 pr_err("Error loading mapper\n");
842 class_unregister(&wmi_class);
846 pr_info("Mapper loaded\n");
850 static void __exit acpi_wmi_exit(void)
852 acpi_bus_unregister_driver(&acpi_wmi_driver);
853 class_unregister(&wmi_class);
855 pr_info("Mapper unloaded\n");
858 subsys_initcall_sync(acpi_wmi_init);
859 module_exit(acpi_wmi_exit);