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 * WMI bus infrastructure by Andrew Lutomirski and Darren Hart:
12 * Copyright (C) 2015 Andrew Lutomirski
13 * Copyright (C) 2017 VMware, Inc. All Rights Reserved.
15 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will be useful, but
23 * WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 * General Public License for more details.
27 * You should have received a copy of the GNU General Public License along
28 * with this program; if not, write to the Free Software Foundation, Inc.,
29 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
31 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
36 #include <linux/acpi.h>
37 #include <linux/device.h>
38 #include <linux/init.h>
39 #include <linux/kernel.h>
40 #include <linux/list.h>
41 #include <linux/miscdevice.h>
42 #include <linux/module.h>
43 #include <linux/platform_device.h>
44 #include <linux/slab.h>
45 #include <linux/types.h>
46 #include <linux/uaccess.h>
47 #include <linux/uuid.h>
48 #include <linux/wmi.h>
49 #include <uapi/linux/wmi.h>
51 ACPI_MODULE_NAME("wmi");
52 MODULE_AUTHOR("Carlos Corbacho");
53 MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
54 MODULE_LICENSE("GPL");
56 static LIST_HEAD(wmi_block_list
);
63 unsigned char notify_id
;
64 unsigned char reserved
;
72 struct wmi_device dev
;
73 struct list_head list
;
74 struct guid_block gblock
;
75 struct miscdevice char_dev
;
76 struct mutex char_mutex
;
77 struct acpi_device
*acpi_device
;
78 wmi_notify_handler handler
;
82 bool read_takes_no_args
;
87 * If the GUID data block is marked as expensive, we must enable and
88 * explicitily disable data collection.
90 #define ACPI_WMI_EXPENSIVE 0x1
91 #define ACPI_WMI_METHOD 0x2 /* GUID is a method */
92 #define ACPI_WMI_STRING 0x4 /* GUID takes & returns a string */
93 #define ACPI_WMI_EVENT 0x8 /* GUID is an event */
95 static bool debug_event
;
96 module_param(debug_event
, bool, 0444);
97 MODULE_PARM_DESC(debug_event
,
98 "Log WMI Events [0/1]");
100 static bool debug_dump_wdg
;
101 module_param(debug_dump_wdg
, bool, 0444);
102 MODULE_PARM_DESC(debug_dump_wdg
,
103 "Dump available WMI interfaces [0/1]");
105 static int acpi_wmi_remove(struct platform_device
*device
);
106 static int acpi_wmi_probe(struct platform_device
*device
);
108 static const struct acpi_device_id wmi_device_ids
[] = {
113 MODULE_DEVICE_TABLE(acpi
, wmi_device_ids
);
115 static struct platform_driver acpi_wmi_driver
= {
118 .acpi_match_table
= wmi_device_ids
,
120 .probe
= acpi_wmi_probe
,
121 .remove
= acpi_wmi_remove
,
125 * GUID parsing functions
128 static bool find_guid(const char *guid_string
, struct wmi_block
**out
)
131 struct wmi_block
*wblock
;
132 struct guid_block
*block
;
135 if (uuid_le_to_bin(guid_string
, &guid_input
))
138 list_for_each(p
, &wmi_block_list
) {
139 wblock
= list_entry(p
, struct wmi_block
, list
);
140 block
= &wblock
->gblock
;
142 if (memcmp(block
->guid
, &guid_input
, 16) == 0) {
151 static int get_subobj_info(acpi_handle handle
, const char *pathname
,
152 struct acpi_device_info
**info
)
154 struct acpi_device_info
*dummy_info
, **info_ptr
;
155 acpi_handle subobj_handle
;
158 status
= acpi_get_handle(handle
, (char *)pathname
, &subobj_handle
);
159 if (status
== AE_NOT_FOUND
)
161 else if (ACPI_FAILURE(status
))
164 info_ptr
= info
? info
: &dummy_info
;
165 status
= acpi_get_object_info(subobj_handle
, info_ptr
);
166 if (ACPI_FAILURE(status
))
175 static acpi_status
wmi_method_enable(struct wmi_block
*wblock
, int enable
)
177 struct guid_block
*block
= NULL
;
182 block
= &wblock
->gblock
;
183 handle
= wblock
->acpi_device
->handle
;
185 snprintf(method
, 5, "WE%02X", block
->notify_id
);
186 status
= acpi_execute_simple_method(handle
, method
, enable
);
188 if (status
!= AE_OK
&& status
!= AE_NOT_FOUND
)
195 * Exported WMI functions
199 * set_required_buffer_size - Sets the buffer size needed for performing IOCTL
200 * @wdev: A wmi bus device from a driver
201 * @instance: Instance index
203 * Allocates memory needed for buffer, stores the buffer size in that memory
205 int set_required_buffer_size(struct wmi_device
*wdev
, u64 length
)
207 struct wmi_block
*wblock
;
209 wblock
= container_of(wdev
, struct wmi_block
, dev
);
210 wblock
->req_buf_size
= length
;
214 EXPORT_SYMBOL_GPL(set_required_buffer_size
);
217 * wmi_evaluate_method - Evaluate a WMI method
218 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
219 * @instance: Instance index
220 * @method_id: Method ID to call
221 * &in: Buffer containing input for the method call
222 * &out: Empty buffer to return the method results
224 * Call an ACPI-WMI method
226 acpi_status
wmi_evaluate_method(const char *guid_string
, u8 instance
,
227 u32 method_id
, const struct acpi_buffer
*in
, struct acpi_buffer
*out
)
229 struct wmi_block
*wblock
= NULL
;
231 if (!find_guid(guid_string
, &wblock
))
233 return wmidev_evaluate_method(&wblock
->dev
, instance
, method_id
,
236 EXPORT_SYMBOL_GPL(wmi_evaluate_method
);
239 * wmidev_evaluate_method - Evaluate a WMI method
240 * @wdev: A wmi bus device from a driver
241 * @instance: Instance index
242 * @method_id: Method ID to call
243 * &in: Buffer containing input for the method call
244 * &out: Empty buffer to return the method results
246 * Call an ACPI-WMI method
248 acpi_status
wmidev_evaluate_method(struct wmi_device
*wdev
, u8 instance
,
249 u32 method_id
, const struct acpi_buffer
*in
, struct acpi_buffer
*out
)
251 struct guid_block
*block
= NULL
;
252 struct wmi_block
*wblock
= NULL
;
255 struct acpi_object_list input
;
256 union acpi_object params
[3];
257 char method
[5] = "WM";
259 wblock
= container_of(wdev
, struct wmi_block
, dev
);
260 block
= &wblock
->gblock
;
261 handle
= wblock
->acpi_device
->handle
;
263 if (!(block
->flags
& ACPI_WMI_METHOD
))
266 if (block
->instance_count
<= instance
)
267 return AE_BAD_PARAMETER
;
270 input
.pointer
= params
;
271 params
[0].type
= ACPI_TYPE_INTEGER
;
272 params
[0].integer
.value
= instance
;
273 params
[1].type
= ACPI_TYPE_INTEGER
;
274 params
[1].integer
.value
= method_id
;
279 if (block
->flags
& ACPI_WMI_STRING
) {
280 params
[2].type
= ACPI_TYPE_STRING
;
282 params
[2].type
= ACPI_TYPE_BUFFER
;
284 params
[2].buffer
.length
= in
->length
;
285 params
[2].buffer
.pointer
= in
->pointer
;
288 strncat(method
, block
->object_id
, 2);
290 status
= acpi_evaluate_object(handle
, method
, &input
, out
);
294 EXPORT_SYMBOL_GPL(wmidev_evaluate_method
);
296 static acpi_status
__query_block(struct wmi_block
*wblock
, u8 instance
,
297 struct acpi_buffer
*out
)
299 struct guid_block
*block
= NULL
;
301 acpi_status status
, wc_status
= AE_ERROR
;
302 struct acpi_object_list input
;
303 union acpi_object wq_params
[1];
305 char wc_method
[5] = "WC";
308 return AE_BAD_PARAMETER
;
310 block
= &wblock
->gblock
;
311 handle
= wblock
->acpi_device
->handle
;
313 if (block
->instance_count
<= instance
)
314 return AE_BAD_PARAMETER
;
316 /* Check GUID is a data block */
317 if (block
->flags
& (ACPI_WMI_EVENT
| ACPI_WMI_METHOD
))
321 input
.pointer
= wq_params
;
322 wq_params
[0].type
= ACPI_TYPE_INTEGER
;
323 wq_params
[0].integer
.value
= instance
;
325 if (instance
== 0 && wblock
->read_takes_no_args
)
329 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
332 if (block
->flags
& ACPI_WMI_EXPENSIVE
) {
333 strncat(wc_method
, block
->object_id
, 2);
336 * Some GUIDs break the specification by declaring themselves
337 * expensive, but have no corresponding WCxx method. So we
338 * should not fail if this happens.
340 if (acpi_has_method(handle
, wc_method
))
341 wc_status
= acpi_execute_simple_method(handle
,
345 strcpy(method
, "WQ");
346 strncat(method
, block
->object_id
, 2);
348 status
= acpi_evaluate_object(handle
, method
, &input
, out
);
351 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
352 * the WQxx method failed - we should disable collection anyway.
354 if ((block
->flags
& ACPI_WMI_EXPENSIVE
) && ACPI_SUCCESS(wc_status
)) {
355 status
= acpi_execute_simple_method(handle
, wc_method
, 0);
362 * wmi_query_block - Return contents of a WMI block (deprecated)
363 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
364 * @instance: Instance index
365 * &out: Empty buffer to return the contents of the data block to
367 * Return the contents of an ACPI-WMI data block to a buffer
369 acpi_status
wmi_query_block(const char *guid_string
, u8 instance
,
370 struct acpi_buffer
*out
)
372 struct wmi_block
*wblock
;
375 return AE_BAD_PARAMETER
;
377 if (!find_guid(guid_string
, &wblock
))
380 return __query_block(wblock
, instance
, out
);
382 EXPORT_SYMBOL_GPL(wmi_query_block
);
384 union acpi_object
*wmidev_block_query(struct wmi_device
*wdev
, u8 instance
)
386 struct acpi_buffer out
= { ACPI_ALLOCATE_BUFFER
, NULL
};
387 struct wmi_block
*wblock
= container_of(wdev
, struct wmi_block
, dev
);
389 if (ACPI_FAILURE(__query_block(wblock
, instance
, &out
)))
392 return (union acpi_object
*)out
.pointer
;
394 EXPORT_SYMBOL_GPL(wmidev_block_query
);
397 * wmi_set_block - Write to a WMI block
398 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
399 * @instance: Instance index
400 * &in: Buffer containing new values for the data block
402 * Write the contents of the input buffer to an ACPI-WMI data block
404 acpi_status
wmi_set_block(const char *guid_string
, u8 instance
,
405 const struct acpi_buffer
*in
)
407 struct guid_block
*block
= NULL
;
408 struct wmi_block
*wblock
= NULL
;
410 struct acpi_object_list input
;
411 union acpi_object params
[2];
412 char method
[5] = "WS";
414 if (!guid_string
|| !in
)
417 if (!find_guid(guid_string
, &wblock
))
420 block
= &wblock
->gblock
;
421 handle
= wblock
->acpi_device
->handle
;
423 if (block
->instance_count
<= instance
)
424 return AE_BAD_PARAMETER
;
426 /* Check GUID is a data block */
427 if (block
->flags
& (ACPI_WMI_EVENT
| ACPI_WMI_METHOD
))
431 input
.pointer
= params
;
432 params
[0].type
= ACPI_TYPE_INTEGER
;
433 params
[0].integer
.value
= instance
;
435 if (block
->flags
& ACPI_WMI_STRING
) {
436 params
[1].type
= ACPI_TYPE_STRING
;
438 params
[1].type
= ACPI_TYPE_BUFFER
;
440 params
[1].buffer
.length
= in
->length
;
441 params
[1].buffer
.pointer
= in
->pointer
;
443 strncat(method
, block
->object_id
, 2);
445 return acpi_evaluate_object(handle
, method
, &input
, NULL
);
447 EXPORT_SYMBOL_GPL(wmi_set_block
);
449 static void wmi_dump_wdg(const struct guid_block
*g
)
451 pr_info("%pUL:\n", g
->guid
);
452 if (g
->flags
& ACPI_WMI_EVENT
)
453 pr_info("\tnotify_id: 0x%02X\n", g
->notify_id
);
455 pr_info("\tobject_id: %2pE\n", g
->object_id
);
456 pr_info("\tinstance_count: %d\n", g
->instance_count
);
457 pr_info("\tflags: %#x", g
->flags
);
459 if (g
->flags
& ACPI_WMI_EXPENSIVE
)
460 pr_cont(" ACPI_WMI_EXPENSIVE");
461 if (g
->flags
& ACPI_WMI_METHOD
)
462 pr_cont(" ACPI_WMI_METHOD");
463 if (g
->flags
& ACPI_WMI_STRING
)
464 pr_cont(" ACPI_WMI_STRING");
465 if (g
->flags
& ACPI_WMI_EVENT
)
466 pr_cont(" ACPI_WMI_EVENT");
472 static void wmi_notify_debug(u32 value
, void *context
)
474 struct acpi_buffer response
= { ACPI_ALLOCATE_BUFFER
, NULL
};
475 union acpi_object
*obj
;
478 status
= wmi_get_event_data(value
, &response
);
479 if (status
!= AE_OK
) {
480 pr_info("bad event status 0x%x\n", status
);
484 obj
= (union acpi_object
*)response
.pointer
;
489 pr_info("DEBUG Event ");
491 case ACPI_TYPE_BUFFER
:
492 pr_cont("BUFFER_TYPE - length %d\n", obj
->buffer
.length
);
494 case ACPI_TYPE_STRING
:
495 pr_cont("STRING_TYPE - %s\n", obj
->string
.pointer
);
497 case ACPI_TYPE_INTEGER
:
498 pr_cont("INTEGER_TYPE - %llu\n", obj
->integer
.value
);
500 case ACPI_TYPE_PACKAGE
:
501 pr_cont("PACKAGE_TYPE - %d elements\n", obj
->package
.count
);
504 pr_cont("object type 0x%X\n", obj
->type
);
510 * wmi_install_notify_handler - Register handler for WMI events
511 * @handler: Function to handle notifications
512 * @data: Data to be returned to handler when event is fired
514 * Register a handler for events sent to the ACPI-WMI mapper device.
516 acpi_status
wmi_install_notify_handler(const char *guid
,
517 wmi_notify_handler handler
, void *data
)
519 struct wmi_block
*block
;
520 acpi_status status
= AE_NOT_EXIST
;
524 if (!guid
|| !handler
)
525 return AE_BAD_PARAMETER
;
527 if (uuid_le_to_bin(guid
, &guid_input
))
528 return AE_BAD_PARAMETER
;
530 list_for_each(p
, &wmi_block_list
) {
531 acpi_status wmi_status
;
532 block
= list_entry(p
, struct wmi_block
, list
);
534 if (memcmp(block
->gblock
.guid
, &guid_input
, 16) == 0) {
535 if (block
->handler
&&
536 block
->handler
!= wmi_notify_debug
)
537 return AE_ALREADY_ACQUIRED
;
539 block
->handler
= handler
;
540 block
->handler_data
= data
;
542 wmi_status
= wmi_method_enable(block
, 1);
543 if ((wmi_status
!= AE_OK
) ||
544 ((wmi_status
== AE_OK
) && (status
== AE_NOT_EXIST
)))
551 EXPORT_SYMBOL_GPL(wmi_install_notify_handler
);
554 * wmi_uninstall_notify_handler - Unregister handler for WMI events
556 * Unregister handler for events sent to the ACPI-WMI mapper device.
558 acpi_status
wmi_remove_notify_handler(const char *guid
)
560 struct wmi_block
*block
;
561 acpi_status status
= AE_NOT_EXIST
;
566 return AE_BAD_PARAMETER
;
568 if (uuid_le_to_bin(guid
, &guid_input
))
569 return AE_BAD_PARAMETER
;
571 list_for_each(p
, &wmi_block_list
) {
572 acpi_status wmi_status
;
573 block
= list_entry(p
, struct wmi_block
, list
);
575 if (memcmp(block
->gblock
.guid
, &guid_input
, 16) == 0) {
576 if (!block
->handler
||
577 block
->handler
== wmi_notify_debug
)
578 return AE_NULL_ENTRY
;
581 block
->handler
= wmi_notify_debug
;
584 wmi_status
= wmi_method_enable(block
, 0);
585 block
->handler
= NULL
;
586 block
->handler_data
= NULL
;
587 if ((wmi_status
!= AE_OK
) ||
588 ((wmi_status
== AE_OK
) &&
589 (status
== AE_NOT_EXIST
)))
597 EXPORT_SYMBOL_GPL(wmi_remove_notify_handler
);
600 * wmi_get_event_data - Get WMI data associated with an event
602 * @event: Event to find
603 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
605 * Returns extra data associated with an event in WMI.
607 acpi_status
wmi_get_event_data(u32 event
, struct acpi_buffer
*out
)
609 struct acpi_object_list input
;
610 union acpi_object params
[1];
611 struct guid_block
*gblock
;
612 struct wmi_block
*wblock
;
616 input
.pointer
= params
;
617 params
[0].type
= ACPI_TYPE_INTEGER
;
618 params
[0].integer
.value
= event
;
620 list_for_each(p
, &wmi_block_list
) {
621 wblock
= list_entry(p
, struct wmi_block
, list
);
622 gblock
= &wblock
->gblock
;
624 if ((gblock
->flags
& ACPI_WMI_EVENT
) &&
625 (gblock
->notify_id
== event
))
626 return acpi_evaluate_object(wblock
->acpi_device
->handle
,
627 "_WED", &input
, out
);
632 EXPORT_SYMBOL_GPL(wmi_get_event_data
);
635 * wmi_has_guid - Check if a GUID is available
636 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
638 * Check if a given GUID is defined by _WDG
640 bool wmi_has_guid(const char *guid_string
)
642 return find_guid(guid_string
, NULL
);
644 EXPORT_SYMBOL_GPL(wmi_has_guid
);
646 static struct wmi_block
*dev_to_wblock(struct device
*dev
)
648 return container_of(dev
, struct wmi_block
, dev
.dev
);
651 static struct wmi_device
*dev_to_wdev(struct device
*dev
)
653 return container_of(dev
, struct wmi_device
, dev
);
659 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*attr
,
662 struct wmi_block
*wblock
= dev_to_wblock(dev
);
664 return sprintf(buf
, "wmi:%pUL\n", wblock
->gblock
.guid
);
666 static DEVICE_ATTR_RO(modalias
);
668 static ssize_t
guid_show(struct device
*dev
, struct device_attribute
*attr
,
671 struct wmi_block
*wblock
= dev_to_wblock(dev
);
673 return sprintf(buf
, "%pUL\n", wblock
->gblock
.guid
);
675 static DEVICE_ATTR_RO(guid
);
677 static ssize_t
instance_count_show(struct device
*dev
,
678 struct device_attribute
*attr
, char *buf
)
680 struct wmi_block
*wblock
= dev_to_wblock(dev
);
682 return sprintf(buf
, "%d\n", (int)wblock
->gblock
.instance_count
);
684 static DEVICE_ATTR_RO(instance_count
);
686 static ssize_t
expensive_show(struct device
*dev
,
687 struct device_attribute
*attr
, char *buf
)
689 struct wmi_block
*wblock
= dev_to_wblock(dev
);
691 return sprintf(buf
, "%d\n",
692 (wblock
->gblock
.flags
& ACPI_WMI_EXPENSIVE
) != 0);
694 static DEVICE_ATTR_RO(expensive
);
696 static struct attribute
*wmi_attrs
[] = {
697 &dev_attr_modalias
.attr
,
699 &dev_attr_instance_count
.attr
,
700 &dev_attr_expensive
.attr
,
703 ATTRIBUTE_GROUPS(wmi
);
705 static ssize_t
notify_id_show(struct device
*dev
, struct device_attribute
*attr
,
708 struct wmi_block
*wblock
= dev_to_wblock(dev
);
710 return sprintf(buf
, "%02X\n", (unsigned int)wblock
->gblock
.notify_id
);
712 static DEVICE_ATTR_RO(notify_id
);
714 static struct attribute
*wmi_event_attrs
[] = {
715 &dev_attr_notify_id
.attr
,
718 ATTRIBUTE_GROUPS(wmi_event
);
720 static ssize_t
object_id_show(struct device
*dev
, struct device_attribute
*attr
,
723 struct wmi_block
*wblock
= dev_to_wblock(dev
);
725 return sprintf(buf
, "%c%c\n", wblock
->gblock
.object_id
[0],
726 wblock
->gblock
.object_id
[1]);
728 static DEVICE_ATTR_RO(object_id
);
730 static ssize_t
setable_show(struct device
*dev
, struct device_attribute
*attr
,
733 struct wmi_device
*wdev
= dev_to_wdev(dev
);
735 return sprintf(buf
, "%d\n", (int)wdev
->setable
);
737 static DEVICE_ATTR_RO(setable
);
739 static struct attribute
*wmi_data_attrs
[] = {
740 &dev_attr_object_id
.attr
,
741 &dev_attr_setable
.attr
,
744 ATTRIBUTE_GROUPS(wmi_data
);
746 static struct attribute
*wmi_method_attrs
[] = {
747 &dev_attr_object_id
.attr
,
750 ATTRIBUTE_GROUPS(wmi_method
);
752 static int wmi_dev_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
754 struct wmi_block
*wblock
= dev_to_wblock(dev
);
756 if (add_uevent_var(env
, "MODALIAS=wmi:%pUL", wblock
->gblock
.guid
))
759 if (add_uevent_var(env
, "WMI_GUID=%pUL", wblock
->gblock
.guid
))
765 static void wmi_dev_release(struct device
*dev
)
767 struct wmi_block
*wblock
= dev_to_wblock(dev
);
772 static int wmi_dev_match(struct device
*dev
, struct device_driver
*driver
)
774 struct wmi_driver
*wmi_driver
=
775 container_of(driver
, struct wmi_driver
, driver
);
776 struct wmi_block
*wblock
= dev_to_wblock(dev
);
777 const struct wmi_device_id
*id
= wmi_driver
->id_table
;
779 while (id
->guid_string
) {
782 if (WARN_ON(uuid_le_to_bin(id
->guid_string
, &driver_guid
)))
784 if (!memcmp(&driver_guid
, wblock
->gblock
.guid
, 16))
792 static int wmi_char_open(struct inode
*inode
, struct file
*filp
)
794 const char *driver_name
= filp
->f_path
.dentry
->d_iname
;
795 struct wmi_block
*wblock
= NULL
;
796 struct wmi_block
*next
= NULL
;
798 list_for_each_entry_safe(wblock
, next
, &wmi_block_list
, list
) {
799 if (!wblock
->dev
.dev
.driver
)
801 if (strcmp(driver_name
, wblock
->dev
.dev
.driver
->name
) == 0) {
802 filp
->private_data
= wblock
;
807 if (!filp
->private_data
)
810 return nonseekable_open(inode
, filp
);
813 static ssize_t
wmi_char_read(struct file
*filp
, char __user
*buffer
,
814 size_t length
, loff_t
*offset
)
816 struct wmi_block
*wblock
= filp
->private_data
;
818 return simple_read_from_buffer(buffer
, length
, offset
,
819 &wblock
->req_buf_size
,
820 sizeof(wblock
->req_buf_size
));
823 static long wmi_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
825 struct wmi_ioctl_buffer __user
*input
=
826 (struct wmi_ioctl_buffer __user
*) arg
;
827 struct wmi_block
*wblock
= filp
->private_data
;
828 struct wmi_ioctl_buffer
*buf
= NULL
;
829 struct wmi_driver
*wdriver
= NULL
;
832 if (_IOC_TYPE(cmd
) != WMI_IOC
)
835 /* make sure we're not calling a higher instance than exists*/
836 if (_IOC_NR(cmd
) >= wblock
->gblock
.instance_count
)
839 mutex_lock(&wblock
->char_mutex
);
840 buf
= wblock
->handler_data
;
841 if (get_user(buf
->length
, &input
->length
)) {
842 dev_dbg(&wblock
->dev
.dev
, "Read length from user failed\n");
846 /* if it's too small, abort */
847 if (buf
->length
< wblock
->req_buf_size
) {
848 dev_err(&wblock
->dev
.dev
,
849 "Buffer %lld too small, need at least %lld\n",
850 buf
->length
, wblock
->req_buf_size
);
854 /* if it's too big, warn, driver will only use what is needed */
855 if (buf
->length
> wblock
->req_buf_size
)
856 dev_warn(&wblock
->dev
.dev
,
857 "Buffer %lld is bigger than required %lld\n",
858 buf
->length
, wblock
->req_buf_size
);
860 /* copy the structure from userspace */
861 if (copy_from_user(buf
, input
, wblock
->req_buf_size
)) {
862 dev_dbg(&wblock
->dev
.dev
, "Copy %llu from user failed\n",
863 wblock
->req_buf_size
);
868 /* let the driver do any filtering and do the call */
869 wdriver
= container_of(wblock
->dev
.dev
.driver
,
870 struct wmi_driver
, driver
);
871 if (!try_module_get(wdriver
->driver
.owner
)) {
875 ret
= wdriver
->filter_callback(&wblock
->dev
, cmd
, buf
);
876 module_put(wdriver
->driver
.owner
);
880 /* return the result (only up to our internal buffer size) */
881 if (copy_to_user(input
, buf
, wblock
->req_buf_size
)) {
882 dev_dbg(&wblock
->dev
.dev
, "Copy %llu to user failed\n",
883 wblock
->req_buf_size
);
888 mutex_unlock(&wblock
->char_mutex
);
892 static const struct file_operations wmi_fops
= {
893 .owner
= THIS_MODULE
,
894 .read
= wmi_char_read
,
895 .open
= wmi_char_open
,
896 .unlocked_ioctl
= wmi_ioctl
,
897 .compat_ioctl
= wmi_ioctl
,
900 static int wmi_dev_probe(struct device
*dev
)
902 struct wmi_block
*wblock
= dev_to_wblock(dev
);
903 struct wmi_driver
*wdriver
=
904 container_of(dev
->driver
, struct wmi_driver
, driver
);
909 if (ACPI_FAILURE(wmi_method_enable(wblock
, 1)))
910 dev_warn(dev
, "failed to enable device -- probing anyway\n");
912 if (wdriver
->probe
) {
913 ret
= wdriver
->probe(dev_to_wdev(dev
));
918 /* driver wants a character device made */
919 if (wdriver
->filter_callback
) {
920 /* check that required buffer size declared by driver or MOF */
921 if (!wblock
->req_buf_size
) {
922 dev_err(&wblock
->dev
.dev
,
923 "Required buffer size not set\n");
928 count
= get_order(wblock
->req_buf_size
);
929 wblock
->handler_data
= (void *)__get_free_pages(GFP_KERNEL
,
931 if (!wblock
->handler_data
) {
936 buf
= kmalloc(strlen(wdriver
->driver
.name
) + 5, GFP_KERNEL
);
939 goto probe_string_failure
;
941 sprintf(buf
, "wmi/%s", wdriver
->driver
.name
);
942 wblock
->char_dev
.minor
= MISC_DYNAMIC_MINOR
;
943 wblock
->char_dev
.name
= buf
;
944 wblock
->char_dev
.fops
= &wmi_fops
;
945 wblock
->char_dev
.mode
= 0444;
946 ret
= misc_register(&wblock
->char_dev
);
948 dev_warn(dev
, "failed to register char dev: %d\n", ret
);
950 goto probe_misc_failure
;
958 probe_string_failure
:
959 kfree(wblock
->handler_data
);
961 if (ACPI_FAILURE(wmi_method_enable(wblock
, 0)))
962 dev_warn(dev
, "failed to disable device\n");
966 static int wmi_dev_remove(struct device
*dev
)
968 struct wmi_block
*wblock
= dev_to_wblock(dev
);
969 struct wmi_driver
*wdriver
=
970 container_of(dev
->driver
, struct wmi_driver
, driver
);
973 if (wdriver
->filter_callback
) {
974 misc_deregister(&wblock
->char_dev
);
975 kfree(wblock
->char_dev
.name
);
976 free_pages((unsigned long)wblock
->handler_data
,
977 get_order(wblock
->req_buf_size
));
981 ret
= wdriver
->remove(dev_to_wdev(dev
));
983 if (ACPI_FAILURE(wmi_method_enable(wblock
, 0)))
984 dev_warn(dev
, "failed to disable device\n");
989 static struct class wmi_bus_class
= {
993 static struct bus_type wmi_bus_type
= {
995 .dev_groups
= wmi_groups
,
996 .match
= wmi_dev_match
,
997 .uevent
= wmi_dev_uevent
,
998 .probe
= wmi_dev_probe
,
999 .remove
= wmi_dev_remove
,
1002 static struct device_type wmi_type_event
= {
1004 .groups
= wmi_event_groups
,
1005 .release
= wmi_dev_release
,
1008 static struct device_type wmi_type_method
= {
1010 .groups
= wmi_method_groups
,
1011 .release
= wmi_dev_release
,
1014 static struct device_type wmi_type_data
= {
1016 .groups
= wmi_data_groups
,
1017 .release
= wmi_dev_release
,
1020 static int wmi_create_device(struct device
*wmi_bus_dev
,
1021 const struct guid_block
*gblock
,
1022 struct wmi_block
*wblock
,
1023 struct acpi_device
*device
)
1025 struct acpi_device_info
*info
;
1029 if (gblock
->flags
& ACPI_WMI_EVENT
) {
1030 wblock
->dev
.dev
.type
= &wmi_type_event
;
1034 if (gblock
->flags
& ACPI_WMI_METHOD
) {
1035 wblock
->dev
.dev
.type
= &wmi_type_method
;
1036 mutex_init(&wblock
->char_mutex
);
1041 * Data Block Query Control Method (WQxx by convention) is
1042 * required per the WMI documentation. If it is not present,
1043 * we ignore this data block.
1045 strcpy(method
, "WQ");
1046 strncat(method
, wblock
->gblock
.object_id
, 2);
1047 result
= get_subobj_info(device
->handle
, method
, &info
);
1050 dev_warn(wmi_bus_dev
,
1051 "%s data block query control method not found\n",
1056 wblock
->dev
.dev
.type
= &wmi_type_data
;
1059 * The Microsoft documentation specifically states:
1061 * Data blocks registered with only a single instance
1062 * can ignore the parameter.
1064 * ACPICA will get mad at us if we call the method with the wrong number
1065 * of arguments, so check what our method expects. (On some Dell
1066 * laptops, WQxx may not be a method at all.)
1068 if (info
->type
!= ACPI_TYPE_METHOD
|| info
->param_count
== 0)
1069 wblock
->read_takes_no_args
= true;
1073 strcpy(method
, "WS");
1074 strncat(method
, wblock
->gblock
.object_id
, 2);
1075 result
= get_subobj_info(device
->handle
, method
, NULL
);
1078 wblock
->dev
.setable
= true;
1081 wblock
->dev
.dev
.bus
= &wmi_bus_type
;
1082 wblock
->dev
.dev
.parent
= wmi_bus_dev
;
1084 dev_set_name(&wblock
->dev
.dev
, "%pUL", gblock
->guid
);
1086 device_initialize(&wblock
->dev
.dev
);
1091 static void wmi_free_devices(struct acpi_device
*device
)
1093 struct wmi_block
*wblock
, *next
;
1095 /* Delete devices for all the GUIDs */
1096 list_for_each_entry_safe(wblock
, next
, &wmi_block_list
, list
) {
1097 if (wblock
->acpi_device
== device
) {
1098 list_del(&wblock
->list
);
1099 device_unregister(&wblock
->dev
.dev
);
1104 static bool guid_already_parsed(struct acpi_device
*device
,
1107 struct wmi_block
*wblock
;
1109 list_for_each_entry(wblock
, &wmi_block_list
, list
) {
1110 if (memcmp(wblock
->gblock
.guid
, guid
, 16) == 0) {
1112 * Because we historically didn't track the relationship
1113 * between GUIDs and ACPI nodes, we don't know whether
1114 * we need to suppress GUIDs that are unique on a
1115 * given node but duplicated across nodes.
1117 dev_warn(&device
->dev
, "duplicate WMI GUID %pUL (first instance was on %s)\n",
1118 guid
, dev_name(&wblock
->acpi_device
->dev
));
1127 * Parse the _WDG method for the GUID data blocks
1129 static int parse_wdg(struct device
*wmi_bus_dev
, struct acpi_device
*device
)
1131 struct acpi_buffer out
= {ACPI_ALLOCATE_BUFFER
, NULL
};
1132 const struct guid_block
*gblock
;
1133 struct wmi_block
*wblock
, *next
;
1134 union acpi_object
*obj
;
1139 status
= acpi_evaluate_object(device
->handle
, "_WDG", NULL
, &out
);
1140 if (ACPI_FAILURE(status
))
1143 obj
= (union acpi_object
*) out
.pointer
;
1147 if (obj
->type
!= ACPI_TYPE_BUFFER
) {
1149 goto out_free_pointer
;
1152 gblock
= (const struct guid_block
*)obj
->buffer
.pointer
;
1153 total
= obj
->buffer
.length
/ sizeof(struct guid_block
);
1155 for (i
= 0; i
< total
; i
++) {
1157 wmi_dump_wdg(&gblock
[i
]);
1160 * Some WMI devices, like those for nVidia hooks, have a
1161 * duplicate GUID. It's not clear what we should do in this
1162 * case yet, so for now, we'll just ignore the duplicate
1163 * for device creation.
1165 if (guid_already_parsed(device
, gblock
[i
].guid
))
1168 wblock
= kzalloc(sizeof(struct wmi_block
), GFP_KERNEL
);
1174 wblock
->acpi_device
= device
;
1175 wblock
->gblock
= gblock
[i
];
1177 retval
= wmi_create_device(wmi_bus_dev
, &gblock
[i
], wblock
, device
);
1183 list_add_tail(&wblock
->list
, &wmi_block_list
);
1186 wblock
->handler
= wmi_notify_debug
;
1187 wmi_method_enable(wblock
, 1);
1192 * Now that all of the devices are created, add them to the
1193 * device tree and probe subdrivers.
1195 list_for_each_entry_safe(wblock
, next
, &wmi_block_list
, list
) {
1196 if (wblock
->acpi_device
!= device
)
1199 retval
= device_add(&wblock
->dev
.dev
);
1201 dev_err(wmi_bus_dev
, "failed to register %pUL\n",
1202 wblock
->gblock
.guid
);
1204 wmi_method_enable(wblock
, 0);
1205 list_del(&wblock
->list
);
1206 put_device(&wblock
->dev
.dev
);
1216 * WMI can have EmbeddedControl access regions. In which case, we just want to
1217 * hand these off to the EC driver.
1220 acpi_wmi_ec_space_handler(u32 function
, acpi_physical_address address
,
1221 u32 bits
, u64
*value
,
1222 void *handler_context
, void *region_context
)
1224 int result
= 0, i
= 0;
1227 if ((address
> 0xFF) || !value
)
1228 return AE_BAD_PARAMETER
;
1230 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
1231 return AE_BAD_PARAMETER
;
1234 return AE_BAD_PARAMETER
;
1236 if (function
== ACPI_READ
) {
1237 result
= ec_read(address
, &temp
);
1238 (*value
) |= ((u64
)temp
) << i
;
1240 temp
= 0xff & ((*value
) >> i
);
1241 result
= ec_write(address
, temp
);
1246 return AE_BAD_PARAMETER
;
1249 return AE_NOT_FOUND
;
1259 static void acpi_wmi_notify_handler(acpi_handle handle
, u32 event
,
1262 struct guid_block
*block
;
1263 struct wmi_block
*wblock
;
1264 struct list_head
*p
;
1265 bool found_it
= false;
1267 list_for_each(p
, &wmi_block_list
) {
1268 wblock
= list_entry(p
, struct wmi_block
, list
);
1269 block
= &wblock
->gblock
;
1271 if (wblock
->acpi_device
->handle
== handle
&&
1272 (block
->flags
& ACPI_WMI_EVENT
) &&
1273 (block
->notify_id
== event
))
1283 /* If a driver is bound, then notify the driver. */
1284 if (wblock
->dev
.dev
.driver
) {
1285 struct wmi_driver
*driver
;
1286 struct acpi_object_list input
;
1287 union acpi_object params
[1];
1288 struct acpi_buffer evdata
= { ACPI_ALLOCATE_BUFFER
, NULL
};
1291 driver
= container_of(wblock
->dev
.dev
.driver
,
1292 struct wmi_driver
, driver
);
1295 input
.pointer
= params
;
1296 params
[0].type
= ACPI_TYPE_INTEGER
;
1297 params
[0].integer
.value
= event
;
1299 status
= acpi_evaluate_object(wblock
->acpi_device
->handle
,
1300 "_WED", &input
, &evdata
);
1301 if (ACPI_FAILURE(status
)) {
1302 dev_warn(&wblock
->dev
.dev
,
1303 "failed to get event data\n");
1308 driver
->notify(&wblock
->dev
,
1309 (union acpi_object
*)evdata
.pointer
);
1311 kfree(evdata
.pointer
);
1312 } else if (wblock
->handler
) {
1313 /* Legacy handler */
1314 wblock
->handler(event
, wblock
->handler_data
);
1318 pr_info("DEBUG Event GUID: %pUL\n",
1319 wblock
->gblock
.guid
);
1322 acpi_bus_generate_netlink_event(
1323 wblock
->acpi_device
->pnp
.device_class
,
1324 dev_name(&wblock
->dev
.dev
),
1329 static int acpi_wmi_remove(struct platform_device
*device
)
1331 struct acpi_device
*acpi_device
= ACPI_COMPANION(&device
->dev
);
1333 acpi_remove_notify_handler(acpi_device
->handle
, ACPI_DEVICE_NOTIFY
,
1334 acpi_wmi_notify_handler
);
1335 acpi_remove_address_space_handler(acpi_device
->handle
,
1336 ACPI_ADR_SPACE_EC
, &acpi_wmi_ec_space_handler
);
1337 wmi_free_devices(acpi_device
);
1338 device_destroy(&wmi_bus_class
, MKDEV(0, 0));
1343 static int acpi_wmi_probe(struct platform_device
*device
)
1345 struct acpi_device
*acpi_device
;
1346 struct device
*wmi_bus_dev
;
1350 acpi_device
= ACPI_COMPANION(&device
->dev
);
1352 dev_err(&device
->dev
, "ACPI companion is missing\n");
1356 status
= acpi_install_address_space_handler(acpi_device
->handle
,
1358 &acpi_wmi_ec_space_handler
,
1360 if (ACPI_FAILURE(status
)) {
1361 dev_err(&device
->dev
, "Error installing EC region handler\n");
1365 status
= acpi_install_notify_handler(acpi_device
->handle
,
1367 acpi_wmi_notify_handler
,
1369 if (ACPI_FAILURE(status
)) {
1370 dev_err(&device
->dev
, "Error installing notify handler\n");
1372 goto err_remove_ec_handler
;
1375 wmi_bus_dev
= device_create(&wmi_bus_class
, &device
->dev
, MKDEV(0, 0),
1376 NULL
, "wmi_bus-%s", dev_name(&device
->dev
));
1377 if (IS_ERR(wmi_bus_dev
)) {
1378 error
= PTR_ERR(wmi_bus_dev
);
1379 goto err_remove_notify_handler
;
1381 dev_set_drvdata(&device
->dev
, wmi_bus_dev
);
1383 error
= parse_wdg(wmi_bus_dev
, acpi_device
);
1385 pr_err("Failed to parse WDG method\n");
1386 goto err_remove_busdev
;
1392 device_destroy(&wmi_bus_class
, MKDEV(0, 0));
1394 err_remove_notify_handler
:
1395 acpi_remove_notify_handler(acpi_device
->handle
, ACPI_DEVICE_NOTIFY
,
1396 acpi_wmi_notify_handler
);
1398 err_remove_ec_handler
:
1399 acpi_remove_address_space_handler(acpi_device
->handle
,
1401 &acpi_wmi_ec_space_handler
);
1406 int __must_check
__wmi_driver_register(struct wmi_driver
*driver
,
1407 struct module
*owner
)
1409 driver
->driver
.owner
= owner
;
1410 driver
->driver
.bus
= &wmi_bus_type
;
1412 return driver_register(&driver
->driver
);
1414 EXPORT_SYMBOL(__wmi_driver_register
);
1416 void wmi_driver_unregister(struct wmi_driver
*driver
)
1418 driver_unregister(&driver
->driver
);
1420 EXPORT_SYMBOL(wmi_driver_unregister
);
1422 static int __init
acpi_wmi_init(void)
1429 error
= class_register(&wmi_bus_class
);
1433 error
= bus_register(&wmi_bus_type
);
1435 goto err_unreg_class
;
1437 error
= platform_driver_register(&acpi_wmi_driver
);
1439 pr_err("Error loading mapper\n");
1446 bus_unregister(&wmi_bus_type
);
1449 class_unregister(&wmi_bus_class
);
1454 static void __exit
acpi_wmi_exit(void)
1456 platform_driver_unregister(&acpi_wmi_driver
);
1457 bus_unregister(&wmi_bus_type
);
1458 class_unregister(&wmi_bus_class
);
1461 subsys_initcall_sync(acpi_wmi_init
);
1462 module_exit(acpi_wmi_exit
);