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
)) {
292 status
= acpi_execute_simple_method(handle
, wc_method
, 0);
297 EXPORT_SYMBOL_GPL(wmi_query_block
);
300 * wmi_set_block - Write to a WMI block
301 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
302 * @instance: Instance index
303 * &in: Buffer containing new values for the data block
305 * Write the contents of the input buffer to an ACPI-WMI data block
307 acpi_status
wmi_set_block(const char *guid_string
, u8 instance
,
308 const struct acpi_buffer
*in
)
310 struct guid_block
*block
= NULL
;
311 struct wmi_block
*wblock
= NULL
;
313 struct acpi_object_list input
;
314 union acpi_object params
[2];
315 char method
[5] = "WS";
317 if (!guid_string
|| !in
)
320 if (!find_guid(guid_string
, &wblock
))
323 block
= &wblock
->gblock
;
324 handle
= wblock
->handle
;
326 if (block
->instance_count
< instance
)
327 return AE_BAD_PARAMETER
;
329 /* Check GUID is a data block */
330 if (block
->flags
& (ACPI_WMI_EVENT
| ACPI_WMI_METHOD
))
334 input
.pointer
= params
;
335 params
[0].type
= ACPI_TYPE_INTEGER
;
336 params
[0].integer
.value
= instance
;
338 if (block
->flags
& ACPI_WMI_STRING
) {
339 params
[1].type
= ACPI_TYPE_STRING
;
341 params
[1].type
= ACPI_TYPE_BUFFER
;
343 params
[1].buffer
.length
= in
->length
;
344 params
[1].buffer
.pointer
= in
->pointer
;
346 strncat(method
, block
->object_id
, 2);
348 return acpi_evaluate_object(handle
, method
, &input
, NULL
);
350 EXPORT_SYMBOL_GPL(wmi_set_block
);
352 static void wmi_dump_wdg(const struct guid_block
*g
)
354 pr_info("%pUL:\n", g
->guid
);
355 pr_info("\tobject_id: %c%c\n", g
->object_id
[0], g
->object_id
[1]);
356 pr_info("\tnotify_id: %02X\n", g
->notify_id
);
357 pr_info("\treserved: %02X\n", g
->reserved
);
358 pr_info("\tinstance_count: %d\n", g
->instance_count
);
359 pr_info("\tflags: %#x", g
->flags
);
361 if (g
->flags
& ACPI_WMI_EXPENSIVE
)
362 pr_cont(" ACPI_WMI_EXPENSIVE");
363 if (g
->flags
& ACPI_WMI_METHOD
)
364 pr_cont(" ACPI_WMI_METHOD");
365 if (g
->flags
& ACPI_WMI_STRING
)
366 pr_cont(" ACPI_WMI_STRING");
367 if (g
->flags
& ACPI_WMI_EVENT
)
368 pr_cont(" ACPI_WMI_EVENT");
374 static void wmi_notify_debug(u32 value
, void *context
)
376 struct acpi_buffer response
= { ACPI_ALLOCATE_BUFFER
, NULL
};
377 union acpi_object
*obj
;
380 status
= wmi_get_event_data(value
, &response
);
381 if (status
!= AE_OK
) {
382 pr_info("bad event status 0x%x\n", status
);
386 obj
= (union acpi_object
*)response
.pointer
;
391 pr_info("DEBUG Event ");
393 case ACPI_TYPE_BUFFER
:
394 pr_cont("BUFFER_TYPE - length %d\n", obj
->buffer
.length
);
396 case ACPI_TYPE_STRING
:
397 pr_cont("STRING_TYPE - %s\n", obj
->string
.pointer
);
399 case ACPI_TYPE_INTEGER
:
400 pr_cont("INTEGER_TYPE - %llu\n", obj
->integer
.value
);
402 case ACPI_TYPE_PACKAGE
:
403 pr_cont("PACKAGE_TYPE - %d elements\n", obj
->package
.count
);
406 pr_cont("object type 0x%X\n", obj
->type
);
412 * wmi_install_notify_handler - Register handler for WMI events
413 * @handler: Function to handle notifications
414 * @data: Data to be returned to handler when event is fired
416 * Register a handler for events sent to the ACPI-WMI mapper device.
418 acpi_status
wmi_install_notify_handler(const char *guid
,
419 wmi_notify_handler handler
, void *data
)
421 struct wmi_block
*block
;
422 acpi_status status
= AE_NOT_EXIST
;
426 if (!guid
|| !handler
)
427 return AE_BAD_PARAMETER
;
429 if (uuid_le_to_bin(guid
, &guid_input
))
430 return AE_BAD_PARAMETER
;
432 list_for_each(p
, &wmi_block_list
) {
433 acpi_status wmi_status
;
434 block
= list_entry(p
, struct wmi_block
, list
);
436 if (memcmp(block
->gblock
.guid
, &guid_input
, 16) == 0) {
437 if (block
->handler
&&
438 block
->handler
!= wmi_notify_debug
)
439 return AE_ALREADY_ACQUIRED
;
441 block
->handler
= handler
;
442 block
->handler_data
= data
;
444 wmi_status
= wmi_method_enable(block
, 1);
445 if ((wmi_status
!= AE_OK
) ||
446 ((wmi_status
== AE_OK
) && (status
== AE_NOT_EXIST
)))
453 EXPORT_SYMBOL_GPL(wmi_install_notify_handler
);
456 * wmi_uninstall_notify_handler - Unregister handler for WMI events
458 * Unregister handler for events sent to the ACPI-WMI mapper device.
460 acpi_status
wmi_remove_notify_handler(const char *guid
)
462 struct wmi_block
*block
;
463 acpi_status status
= AE_NOT_EXIST
;
468 return AE_BAD_PARAMETER
;
470 if (uuid_le_to_bin(guid
, &guid_input
))
471 return AE_BAD_PARAMETER
;
473 list_for_each(p
, &wmi_block_list
) {
474 acpi_status wmi_status
;
475 block
= list_entry(p
, struct wmi_block
, list
);
477 if (memcmp(block
->gblock
.guid
, &guid_input
, 16) == 0) {
478 if (!block
->handler
||
479 block
->handler
== wmi_notify_debug
)
480 return AE_NULL_ENTRY
;
483 block
->handler
= wmi_notify_debug
;
486 wmi_status
= wmi_method_enable(block
, 0);
487 block
->handler
= NULL
;
488 block
->handler_data
= NULL
;
489 if ((wmi_status
!= AE_OK
) ||
490 ((wmi_status
== AE_OK
) &&
491 (status
== AE_NOT_EXIST
)))
499 EXPORT_SYMBOL_GPL(wmi_remove_notify_handler
);
502 * wmi_get_event_data - Get WMI data associated with an event
504 * @event: Event to find
505 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
507 * Returns extra data associated with an event in WMI.
509 acpi_status
wmi_get_event_data(u32 event
, struct acpi_buffer
*out
)
511 struct acpi_object_list input
;
512 union acpi_object params
[1];
513 struct guid_block
*gblock
;
514 struct wmi_block
*wblock
;
518 input
.pointer
= params
;
519 params
[0].type
= ACPI_TYPE_INTEGER
;
520 params
[0].integer
.value
= event
;
522 list_for_each(p
, &wmi_block_list
) {
523 wblock
= list_entry(p
, struct wmi_block
, list
);
524 gblock
= &wblock
->gblock
;
526 if ((gblock
->flags
& ACPI_WMI_EVENT
) &&
527 (gblock
->notify_id
== event
))
528 return acpi_evaluate_object(wblock
->handle
, "_WED",
534 EXPORT_SYMBOL_GPL(wmi_get_event_data
);
537 * wmi_has_guid - Check if a GUID is available
538 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
540 * Check if a given GUID is defined by _WDG
542 bool wmi_has_guid(const char *guid_string
)
544 return find_guid(guid_string
, NULL
);
546 EXPORT_SYMBOL_GPL(wmi_has_guid
);
551 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*attr
,
554 struct wmi_block
*wblock
;
556 wblock
= dev_get_drvdata(dev
);
562 return sprintf(buf
, "wmi:%pUL\n", wblock
->gblock
.guid
);
564 static DEVICE_ATTR_RO(modalias
);
566 static struct attribute
*wmi_attrs
[] = {
567 &dev_attr_modalias
.attr
,
570 ATTRIBUTE_GROUPS(wmi
);
572 static int wmi_dev_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
574 char guid_string
[37];
576 struct wmi_block
*wblock
;
578 if (add_uevent_var(env
, "MODALIAS="))
581 wblock
= dev_get_drvdata(dev
);
585 sprintf(guid_string
, "%pUL", wblock
->gblock
.guid
);
587 strcpy(&env
->buf
[env
->buflen
- 1], "wmi:");
588 memcpy(&env
->buf
[env
->buflen
- 1 + 4], guid_string
, 36);
594 static void wmi_dev_free(struct device
*dev
)
596 struct wmi_block
*wmi_block
= container_of(dev
, struct wmi_block
, dev
);
601 static struct class wmi_class
= {
603 .dev_release
= wmi_dev_free
,
604 .dev_uevent
= wmi_dev_uevent
,
605 .dev_groups
= wmi_groups
,
608 static int wmi_create_device(const struct guid_block
*gblock
,
609 struct wmi_block
*wblock
, acpi_handle handle
)
611 wblock
->dev
.class = &wmi_class
;
613 dev_set_name(&wblock
->dev
, "%pUL", gblock
->guid
);
615 dev_set_drvdata(&wblock
->dev
, wblock
);
617 return device_register(&wblock
->dev
);
620 static void wmi_free_devices(void)
622 struct wmi_block
*wblock
, *next
;
624 /* Delete devices for all the GUIDs */
625 list_for_each_entry_safe(wblock
, next
, &wmi_block_list
, list
) {
626 list_del(&wblock
->list
);
627 if (wblock
->dev
.class)
628 device_unregister(&wblock
->dev
);
634 static bool guid_already_parsed(const char *guid_string
)
636 struct wmi_block
*wblock
;
638 list_for_each_entry(wblock
, &wmi_block_list
, list
)
639 if (memcmp(wblock
->gblock
.guid
, guid_string
, 16) == 0)
646 * Parse the _WDG method for the GUID data blocks
648 static int parse_wdg(acpi_handle handle
)
650 struct acpi_buffer out
= {ACPI_ALLOCATE_BUFFER
, NULL
};
651 union acpi_object
*obj
;
652 const struct guid_block
*gblock
;
653 struct wmi_block
*wblock
;
658 status
= acpi_evaluate_object(handle
, "_WDG", NULL
, &out
);
659 if (ACPI_FAILURE(status
))
662 obj
= (union acpi_object
*) out
.pointer
;
666 if (obj
->type
!= ACPI_TYPE_BUFFER
) {
668 goto out_free_pointer
;
671 gblock
= (const struct guid_block
*)obj
->buffer
.pointer
;
672 total
= obj
->buffer
.length
/ sizeof(struct guid_block
);
674 for (i
= 0; i
< total
; i
++) {
676 wmi_dump_wdg(&gblock
[i
]);
678 wblock
= kzalloc(sizeof(struct wmi_block
), GFP_KERNEL
);
682 wblock
->handle
= handle
;
683 wblock
->gblock
= gblock
[i
];
686 Some WMI devices, like those for nVidia hooks, have a
687 duplicate GUID. It's not clear what we should do in this
688 case yet, so for now, we'll just ignore the duplicate
691 if (!guid_already_parsed(gblock
[i
].guid
)) {
692 retval
= wmi_create_device(&gblock
[i
], wblock
, handle
);
695 goto out_free_pointer
;
699 list_add_tail(&wblock
->list
, &wmi_block_list
);
702 wblock
->handler
= wmi_notify_debug
;
703 wmi_method_enable(wblock
, 1);
716 * WMI can have EmbeddedControl access regions. In which case, we just want to
717 * hand these off to the EC driver.
720 acpi_wmi_ec_space_handler(u32 function
, acpi_physical_address address
,
721 u32 bits
, u64
*value
,
722 void *handler_context
, void *region_context
)
724 int result
= 0, i
= 0;
727 if ((address
> 0xFF) || !value
)
728 return AE_BAD_PARAMETER
;
730 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
731 return AE_BAD_PARAMETER
;
734 return AE_BAD_PARAMETER
;
736 if (function
== ACPI_READ
) {
737 result
= ec_read(address
, &temp
);
738 (*value
) |= ((u64
)temp
) << i
;
740 temp
= 0xff & ((*value
) >> i
);
741 result
= ec_write(address
, temp
);
746 return AE_BAD_PARAMETER
;
759 static void acpi_wmi_notify(struct acpi_device
*device
, u32 event
)
761 struct guid_block
*block
;
762 struct wmi_block
*wblock
;
765 list_for_each(p
, &wmi_block_list
) {
766 wblock
= list_entry(p
, struct wmi_block
, list
);
767 block
= &wblock
->gblock
;
769 if ((block
->flags
& ACPI_WMI_EVENT
) &&
770 (block
->notify_id
== event
)) {
772 wblock
->handler(event
, wblock
->handler_data
);
774 pr_info("DEBUG Event GUID: %pUL\n",
775 wblock
->gblock
.guid
);
778 acpi_bus_generate_netlink_event(
779 device
->pnp
.device_class
, dev_name(&device
->dev
),
786 static int acpi_wmi_remove(struct acpi_device
*device
)
788 acpi_remove_address_space_handler(device
->handle
,
789 ACPI_ADR_SPACE_EC
, &acpi_wmi_ec_space_handler
);
795 static int acpi_wmi_add(struct acpi_device
*device
)
800 status
= acpi_install_address_space_handler(device
->handle
,
802 &acpi_wmi_ec_space_handler
,
804 if (ACPI_FAILURE(status
)) {
805 pr_err("Error installing EC region handler\n");
809 error
= parse_wdg(device
->handle
);
811 acpi_remove_address_space_handler(device
->handle
,
813 &acpi_wmi_ec_space_handler
);
814 pr_err("Failed to parse WDG method\n");
821 static int __init
acpi_wmi_init(void)
828 error
= class_register(&wmi_class
);
832 error
= acpi_bus_register_driver(&acpi_wmi_driver
);
834 pr_err("Error loading mapper\n");
835 class_unregister(&wmi_class
);
839 pr_info("Mapper loaded\n");
843 static void __exit
acpi_wmi_exit(void)
845 acpi_bus_unregister_driver(&acpi_wmi_driver
);
846 class_unregister(&wmi_class
);
848 pr_info("Mapper unloaded\n");
851 subsys_initcall(acpi_wmi_init
);
852 module_exit(acpi_wmi_exit
);