Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * ACPI-WMI mapping driver
4 *
5 * Copyright (C) 2007-2008 Carlos Corbacho <carlos@strangeworlds.co.uk>
6 *
7 * GUID parsing code from ldm.c is:
8 * Copyright (C) 2001,2002 Richard Russon <ldm@flatcap.org>
9 * Copyright (c) 2001-2007 Anton Altaparmakov
10 * Copyright (C) 2001,2002 Jakob Kemi <jakob.kemi@telia.com>
11 *
12 * WMI bus infrastructure by Andrew Lutomirski and Darren Hart:
13 * Copyright (C) 2015 Andrew Lutomirski
14 * Copyright (C) 2017 VMware, Inc. All Rights Reserved.
15 */
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
19#include <linux/acpi.h>
20#include <linux/bits.h>
21#include <linux/build_bug.h>
22#include <linux/device.h>
23#include <linux/init.h>
24#include <linux/kernel.h>
25#include <linux/list.h>
26#include <linux/module.h>
27#include <linux/platform_device.h>
28#include <linux/rwsem.h>
29#include <linux/slab.h>
30#include <linux/sysfs.h>
31#include <linux/types.h>
32#include <linux/uuid.h>
33#include <linux/wmi.h>
34#include <linux/fs.h>
35
36MODULE_AUTHOR("Carlos Corbacho");
37MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
38MODULE_LICENSE("GPL");
39
40static LIST_HEAD(wmi_block_list);
41
42struct guid_block {
43 guid_t guid;
44 union {
45 char object_id[2];
46 struct {
47 unsigned char notify_id;
48 unsigned char reserved;
49 };
50 };
51 u8 instance_count;
52 u8 flags;
53} __packed;
54static_assert(sizeof(typeof_member(struct guid_block, guid)) == 16);
55static_assert(sizeof(struct guid_block) == 20);
56static_assert(__alignof__(struct guid_block) == 1);
57
58enum { /* wmi_block flags */
59 WMI_READ_TAKES_NO_ARGS,
60};
61
62struct wmi_block {
63 struct wmi_device dev;
64 struct list_head list;
65 struct guid_block gblock;
66 struct acpi_device *acpi_device;
67 struct rw_semaphore notify_lock; /* Protects notify callback add/remove */
68 wmi_notify_handler handler;
69 void *handler_data;
70 bool driver_ready;
71 unsigned long flags;
72};
73
74
75/*
76 * If the GUID data block is marked as expensive, we must enable and
77 * explicitily disable data collection.
78 */
79#define ACPI_WMI_EXPENSIVE BIT(0)
80#define ACPI_WMI_METHOD BIT(1) /* GUID is a method */
81#define ACPI_WMI_STRING BIT(2) /* GUID takes & returns a string */
82#define ACPI_WMI_EVENT BIT(3) /* GUID is an event */
83
84static const struct acpi_device_id wmi_device_ids[] = {
85 {"PNP0C14", 0},
86 {"pnp0c14", 0},
87 { }
88};
89MODULE_DEVICE_TABLE(acpi, wmi_device_ids);
90
91/* allow duplicate GUIDs as these device drivers use struct wmi_driver */
92static const char * const allow_duplicates[] = {
93 "05901221-D566-11D1-B2F0-00A0C9062910", /* wmi-bmof */
94 "8A42EA14-4F2A-FD45-6422-0087F7A7E608", /* dell-wmi-ddv */
95 "44FADEB1-B204-40F2-8581-394BBDC1B651", /* intel-wmi-sbl-fw-update */
96 "86CCFD48-205E-4A77-9C48-2021CBEDE341", /* intel-wmi-thunderbolt */
97 "F1DDEE52-063C-4784-A11E-8A06684B9B01", /* dell-smm-hwmon */
98 NULL
99};
100
101#define dev_to_wblock(__dev) container_of_const(__dev, struct wmi_block, dev.dev)
102#define dev_to_wdev(__dev) container_of_const(__dev, struct wmi_device, dev)
103
104/*
105 * GUID parsing functions
106 */
107
108static bool guid_parse_and_compare(const char *string, const guid_t *guid)
109{
110 guid_t guid_input;
111
112 if (guid_parse(string, &guid_input))
113 return false;
114
115 return guid_equal(&guid_input, guid);
116}
117
118static const void *find_guid_context(struct wmi_block *wblock,
119 struct wmi_driver *wdriver)
120{
121 const struct wmi_device_id *id;
122
123 id = wdriver->id_table;
124 if (!id)
125 return NULL;
126
127 while (*id->guid_string) {
128 if (guid_parse_and_compare(id->guid_string, &wblock->gblock.guid))
129 return id->context;
130 id++;
131 }
132 return NULL;
133}
134
135static int get_subobj_info(acpi_handle handle, const char *pathname,
136 struct acpi_device_info **info)
137{
138 acpi_handle subobj_handle;
139 acpi_status status;
140
141 status = acpi_get_handle(handle, pathname, &subobj_handle);
142 if (status == AE_NOT_FOUND)
143 return -ENOENT;
144
145 if (ACPI_FAILURE(status))
146 return -EIO;
147
148 status = acpi_get_object_info(subobj_handle, info);
149 if (ACPI_FAILURE(status))
150 return -EIO;
151
152 return 0;
153}
154
155static acpi_status wmi_method_enable(struct wmi_block *wblock, bool enable)
156{
157 struct guid_block *block;
158 char method[5];
159 acpi_status status;
160 acpi_handle handle;
161
162 block = &wblock->gblock;
163 handle = wblock->acpi_device->handle;
164
165 snprintf(method, 5, "WE%02X", block->notify_id);
166 status = acpi_execute_simple_method(handle, method, enable);
167 if (status == AE_NOT_FOUND)
168 return AE_OK;
169
170 return status;
171}
172
173#define WMI_ACPI_METHOD_NAME_SIZE 5
174
175static inline void get_acpi_method_name(const struct wmi_block *wblock,
176 const char method,
177 char buffer[static WMI_ACPI_METHOD_NAME_SIZE])
178{
179 static_assert(ARRAY_SIZE(wblock->gblock.object_id) == 2);
180 static_assert(WMI_ACPI_METHOD_NAME_SIZE >= 5);
181
182 buffer[0] = 'W';
183 buffer[1] = method;
184 buffer[2] = wblock->gblock.object_id[0];
185 buffer[3] = wblock->gblock.object_id[1];
186 buffer[4] = '\0';
187}
188
189static inline acpi_object_type get_param_acpi_type(const struct wmi_block *wblock)
190{
191 if (wblock->gblock.flags & ACPI_WMI_STRING)
192 return ACPI_TYPE_STRING;
193 else
194 return ACPI_TYPE_BUFFER;
195}
196
197static acpi_status get_event_data(const struct wmi_block *wblock, struct acpi_buffer *out)
198{
199 union acpi_object param = {
200 .integer = {
201 .type = ACPI_TYPE_INTEGER,
202 .value = wblock->gblock.notify_id,
203 }
204 };
205 struct acpi_object_list input = {
206 .count = 1,
207 .pointer = ¶m,
208 };
209
210 return acpi_evaluate_object(wblock->acpi_device->handle, "_WED", &input, out);
211}
212
213static int wmidev_match_guid(struct device *dev, const void *data)
214{
215 struct wmi_block *wblock = dev_to_wblock(dev);
216 const guid_t *guid = data;
217
218 if (guid_equal(guid, &wblock->gblock.guid))
219 return 1;
220
221 return 0;
222}
223
224static int wmidev_match_notify_id(struct device *dev, const void *data)
225{
226 struct wmi_block *wblock = dev_to_wblock(dev);
227 const u32 *notify_id = data;
228
229 if (wblock->gblock.flags & ACPI_WMI_EVENT && wblock->gblock.notify_id == *notify_id)
230 return 1;
231
232 return 0;
233}
234
235static struct bus_type wmi_bus_type;
236
237static struct wmi_device *wmi_find_device_by_guid(const char *guid_string)
238{
239 struct device *dev;
240 guid_t guid;
241 int ret;
242
243 ret = guid_parse(guid_string, &guid);
244 if (ret < 0)
245 return ERR_PTR(ret);
246
247 dev = bus_find_device(&wmi_bus_type, NULL, &guid, wmidev_match_guid);
248 if (!dev)
249 return ERR_PTR(-ENODEV);
250
251 return dev_to_wdev(dev);
252}
253
254static struct wmi_device *wmi_find_event_by_notify_id(const u32 notify_id)
255{
256 struct device *dev;
257
258 dev = bus_find_device(&wmi_bus_type, NULL, ¬ify_id, wmidev_match_notify_id);
259 if (!dev)
260 return ERR_PTR(-ENODEV);
261
262 return to_wmi_device(dev);
263}
264
265static void wmi_device_put(struct wmi_device *wdev)
266{
267 put_device(&wdev->dev);
268}
269
270/*
271 * Exported WMI functions
272 */
273
274/**
275 * wmi_instance_count - Get number of WMI object instances
276 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
277 *
278 * Get the number of WMI object instances.
279 *
280 * Returns: Number of WMI object instances or negative error code.
281 */
282int wmi_instance_count(const char *guid_string)
283{
284 struct wmi_device *wdev;
285 int ret;
286
287 wdev = wmi_find_device_by_guid(guid_string);
288 if (IS_ERR(wdev))
289 return PTR_ERR(wdev);
290
291 ret = wmidev_instance_count(wdev);
292 wmi_device_put(wdev);
293
294 return ret;
295}
296EXPORT_SYMBOL_GPL(wmi_instance_count);
297
298/**
299 * wmidev_instance_count - Get number of WMI object instances
300 * @wdev: A wmi bus device from a driver
301 *
302 * Get the number of WMI object instances.
303 *
304 * Returns: Number of WMI object instances.
305 */
306u8 wmidev_instance_count(struct wmi_device *wdev)
307{
308 struct wmi_block *wblock = container_of(wdev, struct wmi_block, dev);
309
310 return wblock->gblock.instance_count;
311}
312EXPORT_SYMBOL_GPL(wmidev_instance_count);
313
314/**
315 * wmi_evaluate_method - Evaluate a WMI method (deprecated)
316 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
317 * @instance: Instance index
318 * @method_id: Method ID to call
319 * @in: Buffer containing input for the method call
320 * @out: Empty buffer to return the method results
321 *
322 * Call an ACPI-WMI method, the caller must free @out.
323 *
324 * Return: acpi_status signaling success or error.
325 */
326acpi_status wmi_evaluate_method(const char *guid_string, u8 instance, u32 method_id,
327 const struct acpi_buffer *in, struct acpi_buffer *out)
328{
329 struct wmi_device *wdev;
330 acpi_status status;
331
332 wdev = wmi_find_device_by_guid(guid_string);
333 if (IS_ERR(wdev))
334 return AE_ERROR;
335
336 status = wmidev_evaluate_method(wdev, instance, method_id, in, out);
337
338 wmi_device_put(wdev);
339
340 return status;
341}
342EXPORT_SYMBOL_GPL(wmi_evaluate_method);
343
344/**
345 * wmidev_evaluate_method - Evaluate a WMI method
346 * @wdev: A wmi bus device from a driver
347 * @instance: Instance index
348 * @method_id: Method ID to call
349 * @in: Buffer containing input for the method call
350 * @out: Empty buffer to return the method results
351 *
352 * Call an ACPI-WMI method, the caller must free @out.
353 *
354 * Return: acpi_status signaling success or error.
355 */
356acpi_status wmidev_evaluate_method(struct wmi_device *wdev, u8 instance, u32 method_id,
357 const struct acpi_buffer *in, struct acpi_buffer *out)
358{
359 struct guid_block *block;
360 struct wmi_block *wblock;
361 acpi_handle handle;
362 struct acpi_object_list input;
363 union acpi_object params[3];
364 char method[WMI_ACPI_METHOD_NAME_SIZE];
365
366 wblock = container_of(wdev, struct wmi_block, dev);
367 block = &wblock->gblock;
368 handle = wblock->acpi_device->handle;
369
370 if (!(block->flags & ACPI_WMI_METHOD))
371 return AE_BAD_DATA;
372
373 if (block->instance_count <= instance)
374 return AE_BAD_PARAMETER;
375
376 input.count = 2;
377 input.pointer = params;
378 params[0].type = ACPI_TYPE_INTEGER;
379 params[0].integer.value = instance;
380 params[1].type = ACPI_TYPE_INTEGER;
381 params[1].integer.value = method_id;
382
383 if (in) {
384 input.count = 3;
385
386 params[2].type = get_param_acpi_type(wblock);
387 params[2].buffer.length = in->length;
388 params[2].buffer.pointer = in->pointer;
389 }
390
391 get_acpi_method_name(wblock, 'M', method);
392
393 return acpi_evaluate_object(handle, method, &input, out);
394}
395EXPORT_SYMBOL_GPL(wmidev_evaluate_method);
396
397static acpi_status __query_block(struct wmi_block *wblock, u8 instance,
398 struct acpi_buffer *out)
399{
400 struct guid_block *block;
401 acpi_handle handle;
402 acpi_status status, wc_status = AE_ERROR;
403 struct acpi_object_list input;
404 union acpi_object wq_params[1];
405 char wc_method[WMI_ACPI_METHOD_NAME_SIZE];
406 char method[WMI_ACPI_METHOD_NAME_SIZE];
407
408 if (!out)
409 return AE_BAD_PARAMETER;
410
411 block = &wblock->gblock;
412 handle = wblock->acpi_device->handle;
413
414 if (block->instance_count <= instance)
415 return AE_BAD_PARAMETER;
416
417 /* Check GUID is a data block */
418 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
419 return AE_ERROR;
420
421 input.count = 1;
422 input.pointer = wq_params;
423 wq_params[0].type = ACPI_TYPE_INTEGER;
424 wq_params[0].integer.value = instance;
425
426 if (instance == 0 && test_bit(WMI_READ_TAKES_NO_ARGS, &wblock->flags))
427 input.count = 0;
428
429 /*
430 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
431 * enable collection.
432 */
433 if (block->flags & ACPI_WMI_EXPENSIVE) {
434 get_acpi_method_name(wblock, 'C', wc_method);
435
436 /*
437 * Some GUIDs break the specification by declaring themselves
438 * expensive, but have no corresponding WCxx method. So we
439 * should not fail if this happens.
440 */
441 wc_status = acpi_execute_simple_method(handle, wc_method, 1);
442 }
443
444 get_acpi_method_name(wblock, 'Q', method);
445 status = acpi_evaluate_object(handle, method, &input, out);
446
447 /*
448 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
449 * the WQxx method failed - we should disable collection anyway.
450 */
451 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
452 /*
453 * Ignore whether this WCxx call succeeds or not since
454 * the previously executed WQxx method call might have
455 * succeeded, and returning the failing status code
456 * of this call would throw away the result of the WQxx
457 * call, potentially leaking memory.
458 */
459 acpi_execute_simple_method(handle, wc_method, 0);
460 }
461
462 return status;
463}
464
465/**
466 * wmi_query_block - Return contents of a WMI block (deprecated)
467 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
468 * @instance: Instance index
469 * @out: Empty buffer to return the contents of the data block to
470 *
471 * Query a ACPI-WMI block, the caller must free @out.
472 *
473 * Return: ACPI object containing the content of the WMI block.
474 */
475acpi_status wmi_query_block(const char *guid_string, u8 instance,
476 struct acpi_buffer *out)
477{
478 struct wmi_block *wblock;
479 struct wmi_device *wdev;
480 acpi_status status;
481
482 wdev = wmi_find_device_by_guid(guid_string);
483 if (IS_ERR(wdev))
484 return AE_ERROR;
485
486 wblock = container_of(wdev, struct wmi_block, dev);
487 status = __query_block(wblock, instance, out);
488
489 wmi_device_put(wdev);
490
491 return status;
492}
493EXPORT_SYMBOL_GPL(wmi_query_block);
494
495/**
496 * wmidev_block_query - Return contents of a WMI block
497 * @wdev: A wmi bus device from a driver
498 * @instance: Instance index
499 *
500 * Query an ACPI-WMI block, the caller must free the result.
501 *
502 * Return: ACPI object containing the content of the WMI block.
503 */
504union acpi_object *wmidev_block_query(struct wmi_device *wdev, u8 instance)
505{
506 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
507 struct wmi_block *wblock = container_of(wdev, struct wmi_block, dev);
508
509 if (ACPI_FAILURE(__query_block(wblock, instance, &out)))
510 return NULL;
511
512 return out.pointer;
513}
514EXPORT_SYMBOL_GPL(wmidev_block_query);
515
516/**
517 * wmi_set_block - Write to a WMI block (deprecated)
518 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
519 * @instance: Instance index
520 * @in: Buffer containing new values for the data block
521 *
522 * Write the contents of the input buffer to an ACPI-WMI data block.
523 *
524 * Return: acpi_status signaling success or error.
525 */
526acpi_status wmi_set_block(const char *guid_string, u8 instance, const struct acpi_buffer *in)
527{
528 struct wmi_device *wdev;
529 acpi_status status;
530
531 wdev = wmi_find_device_by_guid(guid_string);
532 if (IS_ERR(wdev))
533 return AE_ERROR;
534
535 status = wmidev_block_set(wdev, instance, in);
536 wmi_device_put(wdev);
537
538 return status;
539}
540EXPORT_SYMBOL_GPL(wmi_set_block);
541
542/**
543 * wmidev_block_set - Write to a WMI block
544 * @wdev: A wmi bus device from a driver
545 * @instance: Instance index
546 * @in: Buffer containing new values for the data block
547 *
548 * Write contents of the input buffer to an ACPI-WMI data block.
549 *
550 * Return: acpi_status signaling success or error.
551 */
552acpi_status wmidev_block_set(struct wmi_device *wdev, u8 instance, const struct acpi_buffer *in)
553{
554 struct wmi_block *wblock = container_of(wdev, struct wmi_block, dev);
555 acpi_handle handle = wblock->acpi_device->handle;
556 struct guid_block *block = &wblock->gblock;
557 char method[WMI_ACPI_METHOD_NAME_SIZE];
558 struct acpi_object_list input;
559 union acpi_object params[2];
560
561 if (!in)
562 return AE_BAD_DATA;
563
564 if (block->instance_count <= instance)
565 return AE_BAD_PARAMETER;
566
567 /* Check GUID is a data block */
568 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
569 return AE_ERROR;
570
571 input.count = 2;
572 input.pointer = params;
573 params[0].type = ACPI_TYPE_INTEGER;
574 params[0].integer.value = instance;
575 params[1].type = get_param_acpi_type(wblock);
576 params[1].buffer.length = in->length;
577 params[1].buffer.pointer = in->pointer;
578
579 get_acpi_method_name(wblock, 'S', method);
580
581 return acpi_evaluate_object(handle, method, &input, NULL);
582}
583EXPORT_SYMBOL_GPL(wmidev_block_set);
584
585/**
586 * wmi_install_notify_handler - Register handler for WMI events (deprecated)
587 * @guid: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
588 * @handler: Function to handle notifications
589 * @data: Data to be returned to handler when event is fired
590 *
591 * Register a handler for events sent to the ACPI-WMI mapper device.
592 *
593 * Return: acpi_status signaling success or error.
594 */
595acpi_status wmi_install_notify_handler(const char *guid,
596 wmi_notify_handler handler,
597 void *data)
598{
599 struct wmi_block *wblock;
600 struct wmi_device *wdev;
601 acpi_status status;
602
603 wdev = wmi_find_device_by_guid(guid);
604 if (IS_ERR(wdev))
605 return AE_ERROR;
606
607 wblock = container_of(wdev, struct wmi_block, dev);
608
609 down_write(&wblock->notify_lock);
610 if (wblock->handler) {
611 status = AE_ALREADY_ACQUIRED;
612 } else {
613 wblock->handler = handler;
614 wblock->handler_data = data;
615
616 if (ACPI_FAILURE(wmi_method_enable(wblock, true)))
617 dev_warn(&wblock->dev.dev, "Failed to enable device\n");
618
619 status = AE_OK;
620 }
621 up_write(&wblock->notify_lock);
622
623 wmi_device_put(wdev);
624
625 return status;
626}
627EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
628
629/**
630 * wmi_remove_notify_handler - Unregister handler for WMI events (deprecated)
631 * @guid: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
632 *
633 * Unregister handler for events sent to the ACPI-WMI mapper device.
634 *
635 * Return: acpi_status signaling success or error.
636 */
637acpi_status wmi_remove_notify_handler(const char *guid)
638{
639 struct wmi_block *wblock;
640 struct wmi_device *wdev;
641 acpi_status status;
642
643 wdev = wmi_find_device_by_guid(guid);
644 if (IS_ERR(wdev))
645 return AE_ERROR;
646
647 wblock = container_of(wdev, struct wmi_block, dev);
648
649 down_write(&wblock->notify_lock);
650 if (!wblock->handler) {
651 status = AE_NULL_ENTRY;
652 } else {
653 if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
654 dev_warn(&wblock->dev.dev, "Failed to disable device\n");
655
656 wblock->handler = NULL;
657 wblock->handler_data = NULL;
658
659 status = AE_OK;
660 }
661 up_write(&wblock->notify_lock);
662
663 wmi_device_put(wdev);
664
665 return status;
666}
667EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
668
669/**
670 * wmi_get_event_data - Get WMI data associated with an event (deprecated)
671 *
672 * @event: Event to find
673 * @out: Buffer to hold event data
674 *
675 * Get extra data associated with an WMI event, the caller needs to free @out.
676 *
677 * Return: acpi_status signaling success or error.
678 */
679acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
680{
681 struct wmi_block *wblock;
682 struct wmi_device *wdev;
683 acpi_status status;
684
685 wdev = wmi_find_event_by_notify_id(event);
686 if (IS_ERR(wdev))
687 return AE_NOT_FOUND;
688
689 wblock = container_of(wdev, struct wmi_block, dev);
690 status = get_event_data(wblock, out);
691
692 wmi_device_put(wdev);
693
694 return status;
695}
696EXPORT_SYMBOL_GPL(wmi_get_event_data);
697
698/**
699 * wmi_has_guid - Check if a GUID is available
700 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
701 *
702 * Check if a given GUID is defined by _WDG.
703 *
704 * Return: True if GUID is available, false otherwise.
705 */
706bool wmi_has_guid(const char *guid_string)
707{
708 struct wmi_device *wdev;
709
710 wdev = wmi_find_device_by_guid(guid_string);
711 if (IS_ERR(wdev))
712 return false;
713
714 wmi_device_put(wdev);
715
716 return true;
717}
718EXPORT_SYMBOL_GPL(wmi_has_guid);
719
720/**
721 * wmi_get_acpi_device_uid() - Get _UID name of ACPI device that defines GUID (deprecated)
722 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
723 *
724 * Find the _UID of ACPI device associated with this WMI GUID.
725 *
726 * Return: The ACPI _UID field value or NULL if the WMI GUID was not found.
727 */
728char *wmi_get_acpi_device_uid(const char *guid_string)
729{
730 struct wmi_block *wblock;
731 struct wmi_device *wdev;
732 char *uid;
733
734 wdev = wmi_find_device_by_guid(guid_string);
735 if (IS_ERR(wdev))
736 return NULL;
737
738 wblock = container_of(wdev, struct wmi_block, dev);
739 uid = acpi_device_uid(wblock->acpi_device);
740
741 wmi_device_put(wdev);
742
743 return uid;
744}
745EXPORT_SYMBOL_GPL(wmi_get_acpi_device_uid);
746
747static inline struct wmi_driver *drv_to_wdrv(struct device_driver *drv)
748{
749 return container_of(drv, struct wmi_driver, driver);
750}
751
752/*
753 * sysfs interface
754 */
755static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
756 char *buf)
757{
758 struct wmi_block *wblock = dev_to_wblock(dev);
759
760 return sysfs_emit(buf, "wmi:%pUL\n", &wblock->gblock.guid);
761}
762static DEVICE_ATTR_RO(modalias);
763
764static ssize_t guid_show(struct device *dev, struct device_attribute *attr,
765 char *buf)
766{
767 struct wmi_block *wblock = dev_to_wblock(dev);
768
769 return sysfs_emit(buf, "%pUL\n", &wblock->gblock.guid);
770}
771static DEVICE_ATTR_RO(guid);
772
773static ssize_t instance_count_show(struct device *dev,
774 struct device_attribute *attr, char *buf)
775{
776 struct wmi_block *wblock = dev_to_wblock(dev);
777
778 return sysfs_emit(buf, "%d\n", (int)wblock->gblock.instance_count);
779}
780static DEVICE_ATTR_RO(instance_count);
781
782static ssize_t expensive_show(struct device *dev,
783 struct device_attribute *attr, char *buf)
784{
785 struct wmi_block *wblock = dev_to_wblock(dev);
786
787 return sysfs_emit(buf, "%d\n",
788 (wblock->gblock.flags & ACPI_WMI_EXPENSIVE) != 0);
789}
790static DEVICE_ATTR_RO(expensive);
791
792static struct attribute *wmi_attrs[] = {
793 &dev_attr_modalias.attr,
794 &dev_attr_guid.attr,
795 &dev_attr_instance_count.attr,
796 &dev_attr_expensive.attr,
797 NULL
798};
799ATTRIBUTE_GROUPS(wmi);
800
801static ssize_t notify_id_show(struct device *dev, struct device_attribute *attr,
802 char *buf)
803{
804 struct wmi_block *wblock = dev_to_wblock(dev);
805
806 return sysfs_emit(buf, "%02X\n", (unsigned int)wblock->gblock.notify_id);
807}
808static DEVICE_ATTR_RO(notify_id);
809
810static struct attribute *wmi_event_attrs[] = {
811 &dev_attr_notify_id.attr,
812 NULL
813};
814ATTRIBUTE_GROUPS(wmi_event);
815
816static ssize_t object_id_show(struct device *dev, struct device_attribute *attr,
817 char *buf)
818{
819 struct wmi_block *wblock = dev_to_wblock(dev);
820
821 return sysfs_emit(buf, "%c%c\n", wblock->gblock.object_id[0],
822 wblock->gblock.object_id[1]);
823}
824static DEVICE_ATTR_RO(object_id);
825
826static ssize_t setable_show(struct device *dev, struct device_attribute *attr,
827 char *buf)
828{
829 struct wmi_device *wdev = dev_to_wdev(dev);
830
831 return sysfs_emit(buf, "%d\n", (int)wdev->setable);
832}
833static DEVICE_ATTR_RO(setable);
834
835static struct attribute *wmi_data_attrs[] = {
836 &dev_attr_object_id.attr,
837 &dev_attr_setable.attr,
838 NULL
839};
840ATTRIBUTE_GROUPS(wmi_data);
841
842static struct attribute *wmi_method_attrs[] = {
843 &dev_attr_object_id.attr,
844 NULL
845};
846ATTRIBUTE_GROUPS(wmi_method);
847
848static int wmi_dev_uevent(const struct device *dev, struct kobj_uevent_env *env)
849{
850 const struct wmi_block *wblock = dev_to_wblock(dev);
851
852 if (add_uevent_var(env, "MODALIAS=wmi:%pUL", &wblock->gblock.guid))
853 return -ENOMEM;
854
855 if (add_uevent_var(env, "WMI_GUID=%pUL", &wblock->gblock.guid))
856 return -ENOMEM;
857
858 return 0;
859}
860
861static void wmi_dev_release(struct device *dev)
862{
863 struct wmi_block *wblock = dev_to_wblock(dev);
864
865 kfree(wblock);
866}
867
868static int wmi_dev_match(struct device *dev, struct device_driver *driver)
869{
870 struct wmi_driver *wmi_driver = drv_to_wdrv(driver);
871 struct wmi_block *wblock = dev_to_wblock(dev);
872 const struct wmi_device_id *id = wmi_driver->id_table;
873
874 if (id == NULL)
875 return 0;
876
877 while (*id->guid_string) {
878 if (guid_parse_and_compare(id->guid_string, &wblock->gblock.guid))
879 return 1;
880
881 id++;
882 }
883
884 return 0;
885}
886
887static int wmi_dev_probe(struct device *dev)
888{
889 struct wmi_block *wblock = dev_to_wblock(dev);
890 struct wmi_driver *wdriver = drv_to_wdrv(dev->driver);
891 int ret = 0;
892
893 if (ACPI_FAILURE(wmi_method_enable(wblock, true)))
894 dev_warn(dev, "failed to enable device -- probing anyway\n");
895
896 if (wdriver->probe) {
897 ret = wdriver->probe(dev_to_wdev(dev),
898 find_guid_context(wblock, wdriver));
899 if (ret) {
900 if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
901 dev_warn(dev, "Failed to disable device\n");
902
903 return ret;
904 }
905 }
906
907 down_write(&wblock->notify_lock);
908 wblock->driver_ready = true;
909 up_write(&wblock->notify_lock);
910
911 return 0;
912}
913
914static void wmi_dev_remove(struct device *dev)
915{
916 struct wmi_block *wblock = dev_to_wblock(dev);
917 struct wmi_driver *wdriver = drv_to_wdrv(dev->driver);
918
919 down_write(&wblock->notify_lock);
920 wblock->driver_ready = false;
921 up_write(&wblock->notify_lock);
922
923 if (wdriver->remove)
924 wdriver->remove(dev_to_wdev(dev));
925
926 if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
927 dev_warn(dev, "failed to disable device\n");
928}
929
930static struct class wmi_bus_class = {
931 .name = "wmi_bus",
932};
933
934static struct bus_type wmi_bus_type = {
935 .name = "wmi",
936 .dev_groups = wmi_groups,
937 .match = wmi_dev_match,
938 .uevent = wmi_dev_uevent,
939 .probe = wmi_dev_probe,
940 .remove = wmi_dev_remove,
941};
942
943static const struct device_type wmi_type_event = {
944 .name = "event",
945 .groups = wmi_event_groups,
946 .release = wmi_dev_release,
947};
948
949static const struct device_type wmi_type_method = {
950 .name = "method",
951 .groups = wmi_method_groups,
952 .release = wmi_dev_release,
953};
954
955static const struct device_type wmi_type_data = {
956 .name = "data",
957 .groups = wmi_data_groups,
958 .release = wmi_dev_release,
959};
960
961/*
962 * _WDG is a static list that is only parsed at startup,
963 * so it's safe to count entries without extra protection.
964 */
965static int guid_count(const guid_t *guid)
966{
967 struct wmi_block *wblock;
968 int count = 0;
969
970 list_for_each_entry(wblock, &wmi_block_list, list) {
971 if (guid_equal(&wblock->gblock.guid, guid))
972 count++;
973 }
974
975 return count;
976}
977
978static int wmi_create_device(struct device *wmi_bus_dev,
979 struct wmi_block *wblock,
980 struct acpi_device *device)
981{
982 struct acpi_device_info *info;
983 char method[WMI_ACPI_METHOD_NAME_SIZE];
984 int result;
985 uint count;
986
987 if (wblock->gblock.flags & ACPI_WMI_EVENT) {
988 wblock->dev.dev.type = &wmi_type_event;
989 goto out_init;
990 }
991
992 if (wblock->gblock.flags & ACPI_WMI_METHOD) {
993 wblock->dev.dev.type = &wmi_type_method;
994 goto out_init;
995 }
996
997 /*
998 * Data Block Query Control Method (WQxx by convention) is
999 * required per the WMI documentation. If it is not present,
1000 * we ignore this data block.
1001 */
1002 get_acpi_method_name(wblock, 'Q', method);
1003 result = get_subobj_info(device->handle, method, &info);
1004
1005 if (result) {
1006 dev_warn(wmi_bus_dev,
1007 "%s data block query control method not found\n",
1008 method);
1009 return result;
1010 }
1011
1012 wblock->dev.dev.type = &wmi_type_data;
1013
1014 /*
1015 * The Microsoft documentation specifically states:
1016 *
1017 * Data blocks registered with only a single instance
1018 * can ignore the parameter.
1019 *
1020 * ACPICA will get mad at us if we call the method with the wrong number
1021 * of arguments, so check what our method expects. (On some Dell
1022 * laptops, WQxx may not be a method at all.)
1023 */
1024 if (info->type != ACPI_TYPE_METHOD || info->param_count == 0)
1025 set_bit(WMI_READ_TAKES_NO_ARGS, &wblock->flags);
1026
1027 kfree(info);
1028
1029 get_acpi_method_name(wblock, 'S', method);
1030 if (acpi_has_method(device->handle, method))
1031 wblock->dev.setable = true;
1032
1033 out_init:
1034 init_rwsem(&wblock->notify_lock);
1035 wblock->driver_ready = false;
1036 wblock->dev.dev.bus = &wmi_bus_type;
1037 wblock->dev.dev.parent = wmi_bus_dev;
1038
1039 count = guid_count(&wblock->gblock.guid);
1040 if (count)
1041 dev_set_name(&wblock->dev.dev, "%pUL-%d", &wblock->gblock.guid, count);
1042 else
1043 dev_set_name(&wblock->dev.dev, "%pUL", &wblock->gblock.guid);
1044
1045 device_initialize(&wblock->dev.dev);
1046
1047 return 0;
1048}
1049
1050static int wmi_add_device(struct platform_device *pdev, struct wmi_device *wdev)
1051{
1052 struct device_link *link;
1053
1054 /*
1055 * Many aggregate WMI drivers do not use -EPROBE_DEFER when they
1056 * are unable to find a WMI device during probe, instead they require
1057 * all WMI devices associated with an platform device to become available
1058 * at once. This device link thus prevents WMI drivers from probing until
1059 * the associated platform device has finished probing (and has registered
1060 * all discovered WMI devices).
1061 */
1062
1063 link = device_link_add(&wdev->dev, &pdev->dev, DL_FLAG_AUTOREMOVE_SUPPLIER);
1064 if (!link)
1065 return -EINVAL;
1066
1067 return device_add(&wdev->dev);
1068}
1069
1070static bool guid_already_parsed_for_legacy(struct acpi_device *device, const guid_t *guid)
1071{
1072 struct wmi_block *wblock;
1073
1074 list_for_each_entry(wblock, &wmi_block_list, list) {
1075 /* skip warning and register if we know the driver will use struct wmi_driver */
1076 for (int i = 0; allow_duplicates[i] != NULL; i++) {
1077 if (guid_parse_and_compare(allow_duplicates[i], guid))
1078 return false;
1079 }
1080 if (guid_equal(&wblock->gblock.guid, guid)) {
1081 /*
1082 * Because we historically didn't track the relationship
1083 * between GUIDs and ACPI nodes, we don't know whether
1084 * we need to suppress GUIDs that are unique on a
1085 * given node but duplicated across nodes.
1086 */
1087 dev_warn(&device->dev, "duplicate WMI GUID %pUL (first instance was on %s)\n",
1088 guid, dev_name(&wblock->acpi_device->dev));
1089 return true;
1090 }
1091 }
1092
1093 return false;
1094}
1095
1096/*
1097 * Parse the _WDG method for the GUID data blocks
1098 */
1099static int parse_wdg(struct device *wmi_bus_dev, struct platform_device *pdev)
1100{
1101 struct acpi_device *device = ACPI_COMPANION(&pdev->dev);
1102 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
1103 const struct guid_block *gblock;
1104 struct wmi_block *wblock;
1105 union acpi_object *obj;
1106 acpi_status status;
1107 u32 i, total;
1108 int retval;
1109
1110 status = acpi_evaluate_object(device->handle, "_WDG", NULL, &out);
1111 if (ACPI_FAILURE(status))
1112 return -ENXIO;
1113
1114 obj = out.pointer;
1115 if (!obj)
1116 return -ENXIO;
1117
1118 if (obj->type != ACPI_TYPE_BUFFER) {
1119 kfree(obj);
1120 return -ENXIO;
1121 }
1122
1123 gblock = (const struct guid_block *)obj->buffer.pointer;
1124 total = obj->buffer.length / sizeof(struct guid_block);
1125
1126 for (i = 0; i < total; i++) {
1127 if (!gblock[i].instance_count) {
1128 dev_info(wmi_bus_dev, FW_INFO "%pUL has zero instances\n", &gblock[i].guid);
1129 continue;
1130 }
1131
1132 if (guid_already_parsed_for_legacy(device, &gblock[i].guid))
1133 continue;
1134
1135 wblock = kzalloc(sizeof(*wblock), GFP_KERNEL);
1136 if (!wblock) {
1137 dev_err(wmi_bus_dev, "Failed to allocate %pUL\n", &gblock[i].guid);
1138 continue;
1139 }
1140
1141 wblock->acpi_device = device;
1142 wblock->gblock = gblock[i];
1143
1144 retval = wmi_create_device(wmi_bus_dev, wblock, device);
1145 if (retval) {
1146 kfree(wblock);
1147 continue;
1148 }
1149
1150 list_add_tail(&wblock->list, &wmi_block_list);
1151
1152 retval = wmi_add_device(pdev, &wblock->dev);
1153 if (retval) {
1154 dev_err(wmi_bus_dev, "failed to register %pUL\n",
1155 &wblock->gblock.guid);
1156
1157 list_del(&wblock->list);
1158 put_device(&wblock->dev.dev);
1159 }
1160 }
1161
1162 kfree(obj);
1163
1164 return 0;
1165}
1166
1167/*
1168 * WMI can have EmbeddedControl access regions. In which case, we just want to
1169 * hand these off to the EC driver.
1170 */
1171static acpi_status
1172acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
1173 u32 bits, u64 *value,
1174 void *handler_context, void *region_context)
1175{
1176 int result = 0;
1177 u8 temp = 0;
1178
1179 if ((address > 0xFF) || !value)
1180 return AE_BAD_PARAMETER;
1181
1182 if (function != ACPI_READ && function != ACPI_WRITE)
1183 return AE_BAD_PARAMETER;
1184
1185 if (bits != 8)
1186 return AE_BAD_PARAMETER;
1187
1188 if (function == ACPI_READ) {
1189 result = ec_read(address, &temp);
1190 *value = temp;
1191 } else {
1192 temp = 0xff & *value;
1193 result = ec_write(address, temp);
1194 }
1195
1196 switch (result) {
1197 case -EINVAL:
1198 return AE_BAD_PARAMETER;
1199 case -ENODEV:
1200 return AE_NOT_FOUND;
1201 case -ETIME:
1202 return AE_TIME;
1203 default:
1204 return AE_OK;
1205 }
1206}
1207
1208static void wmi_notify_driver(struct wmi_block *wblock)
1209{
1210 struct wmi_driver *driver = drv_to_wdrv(wblock->dev.dev.driver);
1211 struct acpi_buffer data = { ACPI_ALLOCATE_BUFFER, NULL };
1212 acpi_status status;
1213
1214 if (!driver->no_notify_data) {
1215 status = get_event_data(wblock, &data);
1216 if (ACPI_FAILURE(status)) {
1217 dev_warn(&wblock->dev.dev, "Failed to get event data\n");
1218 return;
1219 }
1220 }
1221
1222 if (driver->notify)
1223 driver->notify(&wblock->dev, data.pointer);
1224
1225 kfree(data.pointer);
1226}
1227
1228static int wmi_notify_device(struct device *dev, void *data)
1229{
1230 struct wmi_block *wblock = dev_to_wblock(dev);
1231 u32 *event = data;
1232
1233 if (!(wblock->gblock.flags & ACPI_WMI_EVENT && wblock->gblock.notify_id == *event))
1234 return 0;
1235
1236 down_read(&wblock->notify_lock);
1237 /* The WMI driver notify handler conflicts with the legacy WMI handler.
1238 * Because of this the WMI driver notify handler takes precedence.
1239 */
1240 if (wblock->dev.dev.driver && wblock->driver_ready) {
1241 wmi_notify_driver(wblock);
1242 } else {
1243 if (wblock->handler)
1244 wblock->handler(*event, wblock->handler_data);
1245 }
1246 up_read(&wblock->notify_lock);
1247
1248 acpi_bus_generate_netlink_event(wblock->acpi_device->pnp.device_class,
1249 dev_name(&wblock->dev.dev), *event, 0);
1250
1251 return -EBUSY;
1252}
1253
1254static void acpi_wmi_notify_handler(acpi_handle handle, u32 event, void *context)
1255{
1256 struct device *wmi_bus_dev = context;
1257
1258 device_for_each_child(wmi_bus_dev, &event, wmi_notify_device);
1259}
1260
1261static int wmi_remove_device(struct device *dev, void *data)
1262{
1263 struct wmi_block *wblock = dev_to_wblock(dev);
1264
1265 list_del(&wblock->list);
1266 device_unregister(dev);
1267
1268 return 0;
1269}
1270
1271static void acpi_wmi_remove(struct platform_device *device)
1272{
1273 struct device *wmi_bus_device = dev_get_drvdata(&device->dev);
1274
1275 device_for_each_child_reverse(wmi_bus_device, NULL, wmi_remove_device);
1276}
1277
1278static void acpi_wmi_remove_notify_handler(void *data)
1279{
1280 struct acpi_device *acpi_device = data;
1281
1282 acpi_remove_notify_handler(acpi_device->handle, ACPI_ALL_NOTIFY, acpi_wmi_notify_handler);
1283}
1284
1285static void acpi_wmi_remove_address_space_handler(void *data)
1286{
1287 struct acpi_device *acpi_device = data;
1288
1289 acpi_remove_address_space_handler(acpi_device->handle, ACPI_ADR_SPACE_EC,
1290 &acpi_wmi_ec_space_handler);
1291}
1292
1293static void acpi_wmi_remove_bus_device(void *data)
1294{
1295 struct device *wmi_bus_dev = data;
1296
1297 device_unregister(wmi_bus_dev);
1298}
1299
1300static int acpi_wmi_probe(struct platform_device *device)
1301{
1302 struct acpi_device *acpi_device;
1303 struct device *wmi_bus_dev;
1304 acpi_status status;
1305 int error;
1306
1307 acpi_device = ACPI_COMPANION(&device->dev);
1308 if (!acpi_device) {
1309 dev_err(&device->dev, "ACPI companion is missing\n");
1310 return -ENODEV;
1311 }
1312
1313 wmi_bus_dev = device_create(&wmi_bus_class, &device->dev, MKDEV(0, 0), NULL, "wmi_bus-%s",
1314 dev_name(&device->dev));
1315 if (IS_ERR(wmi_bus_dev))
1316 return PTR_ERR(wmi_bus_dev);
1317
1318 error = devm_add_action_or_reset(&device->dev, acpi_wmi_remove_bus_device, wmi_bus_dev);
1319 if (error < 0)
1320 return error;
1321
1322 dev_set_drvdata(&device->dev, wmi_bus_dev);
1323
1324 status = acpi_install_address_space_handler(acpi_device->handle,
1325 ACPI_ADR_SPACE_EC,
1326 &acpi_wmi_ec_space_handler,
1327 NULL, NULL);
1328 if (ACPI_FAILURE(status)) {
1329 dev_err(&device->dev, "Error installing EC region handler\n");
1330 return -ENODEV;
1331 }
1332 error = devm_add_action_or_reset(&device->dev, acpi_wmi_remove_address_space_handler,
1333 acpi_device);
1334 if (error < 0)
1335 return error;
1336
1337 status = acpi_install_notify_handler(acpi_device->handle, ACPI_ALL_NOTIFY,
1338 acpi_wmi_notify_handler, wmi_bus_dev);
1339 if (ACPI_FAILURE(status)) {
1340 dev_err(&device->dev, "Error installing notify handler\n");
1341 return -ENODEV;
1342 }
1343 error = devm_add_action_or_reset(&device->dev, acpi_wmi_remove_notify_handler,
1344 acpi_device);
1345 if (error < 0)
1346 return error;
1347
1348 error = parse_wdg(wmi_bus_dev, device);
1349 if (error) {
1350 pr_err("Failed to parse WDG method\n");
1351 return error;
1352 }
1353
1354 return 0;
1355}
1356
1357int __must_check __wmi_driver_register(struct wmi_driver *driver,
1358 struct module *owner)
1359{
1360 driver->driver.owner = owner;
1361 driver->driver.bus = &wmi_bus_type;
1362
1363 return driver_register(&driver->driver);
1364}
1365EXPORT_SYMBOL(__wmi_driver_register);
1366
1367/**
1368 * wmi_driver_unregister() - Unregister a WMI driver
1369 * @driver: WMI driver to unregister
1370 *
1371 * Unregisters a WMI driver from the WMI bus.
1372 */
1373void wmi_driver_unregister(struct wmi_driver *driver)
1374{
1375 driver_unregister(&driver->driver);
1376}
1377EXPORT_SYMBOL(wmi_driver_unregister);
1378
1379static struct platform_driver acpi_wmi_driver = {
1380 .driver = {
1381 .name = "acpi-wmi",
1382 .acpi_match_table = wmi_device_ids,
1383 },
1384 .probe = acpi_wmi_probe,
1385 .remove_new = acpi_wmi_remove,
1386};
1387
1388static int __init acpi_wmi_init(void)
1389{
1390 int error;
1391
1392 if (acpi_disabled)
1393 return -ENODEV;
1394
1395 error = class_register(&wmi_bus_class);
1396 if (error)
1397 return error;
1398
1399 error = bus_register(&wmi_bus_type);
1400 if (error)
1401 goto err_unreg_class;
1402
1403 error = platform_driver_register(&acpi_wmi_driver);
1404 if (error) {
1405 pr_err("Error loading mapper\n");
1406 goto err_unreg_bus;
1407 }
1408
1409 return 0;
1410
1411err_unreg_bus:
1412 bus_unregister(&wmi_bus_type);
1413
1414err_unreg_class:
1415 class_unregister(&wmi_bus_class);
1416
1417 return error;
1418}
1419
1420static void __exit acpi_wmi_exit(void)
1421{
1422 platform_driver_unregister(&acpi_wmi_driver);
1423 bus_unregister(&wmi_bus_type);
1424 class_unregister(&wmi_bus_class);
1425}
1426
1427subsys_initcall_sync(acpi_wmi_init);
1428module_exit(acpi_wmi_exit);
1/*
2 * ACPI-WMI mapping driver
3 *
4 * Copyright (C) 2007-2008 Carlos Corbacho <carlos@strangeworlds.co.uk>
5 *
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>
10 *
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.
14 *
15 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 *
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.
21 *
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.
26 *
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.
30 *
31 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 */
33
34#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
35
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>
50
51ACPI_MODULE_NAME("wmi");
52MODULE_AUTHOR("Carlos Corbacho");
53MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
54MODULE_LICENSE("GPL");
55
56static LIST_HEAD(wmi_block_list);
57
58struct guid_block {
59 char guid[16];
60 union {
61 char object_id[2];
62 struct {
63 unsigned char notify_id;
64 unsigned char reserved;
65 };
66 };
67 u8 instance_count;
68 u8 flags;
69};
70
71struct wmi_block {
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;
79 void *handler_data;
80 u64 req_buf_size;
81
82 bool read_takes_no_args;
83};
84
85
86/*
87 * If the GUID data block is marked as expensive, we must enable and
88 * explicitily disable data collection.
89 */
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 */
94
95static bool debug_event;
96module_param(debug_event, bool, 0444);
97MODULE_PARM_DESC(debug_event,
98 "Log WMI Events [0/1]");
99
100static bool debug_dump_wdg;
101module_param(debug_dump_wdg, bool, 0444);
102MODULE_PARM_DESC(debug_dump_wdg,
103 "Dump available WMI interfaces [0/1]");
104
105static int acpi_wmi_remove(struct platform_device *device);
106static int acpi_wmi_probe(struct platform_device *device);
107
108static const struct acpi_device_id wmi_device_ids[] = {
109 {"PNP0C14", 0},
110 {"pnp0c14", 0},
111 {"", 0},
112};
113MODULE_DEVICE_TABLE(acpi, wmi_device_ids);
114
115static struct platform_driver acpi_wmi_driver = {
116 .driver = {
117 .name = "acpi-wmi",
118 .acpi_match_table = wmi_device_ids,
119 },
120 .probe = acpi_wmi_probe,
121 .remove = acpi_wmi_remove,
122};
123
124/*
125 * GUID parsing functions
126 */
127
128static bool find_guid(const char *guid_string, struct wmi_block **out)
129{
130 uuid_le guid_input;
131 struct wmi_block *wblock;
132 struct guid_block *block;
133
134 if (uuid_le_to_bin(guid_string, &guid_input))
135 return false;
136
137 list_for_each_entry(wblock, &wmi_block_list, list) {
138 block = &wblock->gblock;
139
140 if (memcmp(block->guid, &guid_input, 16) == 0) {
141 if (out)
142 *out = wblock;
143 return true;
144 }
145 }
146 return false;
147}
148
149static int get_subobj_info(acpi_handle handle, const char *pathname,
150 struct acpi_device_info **info)
151{
152 struct acpi_device_info *dummy_info, **info_ptr;
153 acpi_handle subobj_handle;
154 acpi_status status;
155
156 status = acpi_get_handle(handle, (char *)pathname, &subobj_handle);
157 if (status == AE_NOT_FOUND)
158 return -ENOENT;
159 else if (ACPI_FAILURE(status))
160 return -EIO;
161
162 info_ptr = info ? info : &dummy_info;
163 status = acpi_get_object_info(subobj_handle, info_ptr);
164 if (ACPI_FAILURE(status))
165 return -EIO;
166
167 if (!info)
168 kfree(dummy_info);
169
170 return 0;
171}
172
173static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
174{
175 struct guid_block *block = NULL;
176 char method[5];
177 acpi_status status;
178 acpi_handle handle;
179
180 block = &wblock->gblock;
181 handle = wblock->acpi_device->handle;
182
183 snprintf(method, 5, "WE%02X", block->notify_id);
184 status = acpi_execute_simple_method(handle, method, enable);
185
186 if (status != AE_OK && status != AE_NOT_FOUND)
187 return status;
188 else
189 return AE_OK;
190}
191
192/*
193 * Exported WMI functions
194 */
195
196/**
197 * set_required_buffer_size - Sets the buffer size needed for performing IOCTL
198 * @wdev: A wmi bus device from a driver
199 * @instance: Instance index
200 *
201 * Allocates memory needed for buffer, stores the buffer size in that memory
202 */
203int set_required_buffer_size(struct wmi_device *wdev, u64 length)
204{
205 struct wmi_block *wblock;
206
207 wblock = container_of(wdev, struct wmi_block, dev);
208 wblock->req_buf_size = length;
209
210 return 0;
211}
212EXPORT_SYMBOL_GPL(set_required_buffer_size);
213
214/**
215 * wmi_evaluate_method - Evaluate a WMI method
216 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
217 * @instance: Instance index
218 * @method_id: Method ID to call
219 * &in: Buffer containing input for the method call
220 * &out: Empty buffer to return the method results
221 *
222 * Call an ACPI-WMI method
223 */
224acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
225u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
226{
227 struct wmi_block *wblock = NULL;
228
229 if (!find_guid(guid_string, &wblock))
230 return AE_ERROR;
231 return wmidev_evaluate_method(&wblock->dev, instance, method_id,
232 in, out);
233}
234EXPORT_SYMBOL_GPL(wmi_evaluate_method);
235
236/**
237 * wmidev_evaluate_method - Evaluate a WMI method
238 * @wdev: A wmi bus device from a driver
239 * @instance: Instance index
240 * @method_id: Method ID to call
241 * &in: Buffer containing input for the method call
242 * &out: Empty buffer to return the method results
243 *
244 * Call an ACPI-WMI method
245 */
246acpi_status wmidev_evaluate_method(struct wmi_device *wdev, u8 instance,
247 u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
248{
249 struct guid_block *block = NULL;
250 struct wmi_block *wblock = NULL;
251 acpi_handle handle;
252 acpi_status status;
253 struct acpi_object_list input;
254 union acpi_object params[3];
255 char method[5] = "WM";
256
257 wblock = container_of(wdev, struct wmi_block, dev);
258 block = &wblock->gblock;
259 handle = wblock->acpi_device->handle;
260
261 if (!(block->flags & ACPI_WMI_METHOD))
262 return AE_BAD_DATA;
263
264 if (block->instance_count <= instance)
265 return AE_BAD_PARAMETER;
266
267 input.count = 2;
268 input.pointer = params;
269 params[0].type = ACPI_TYPE_INTEGER;
270 params[0].integer.value = instance;
271 params[1].type = ACPI_TYPE_INTEGER;
272 params[1].integer.value = method_id;
273
274 if (in) {
275 input.count = 3;
276
277 if (block->flags & ACPI_WMI_STRING) {
278 params[2].type = ACPI_TYPE_STRING;
279 } else {
280 params[2].type = ACPI_TYPE_BUFFER;
281 }
282 params[2].buffer.length = in->length;
283 params[2].buffer.pointer = in->pointer;
284 }
285
286 strncat(method, block->object_id, 2);
287
288 status = acpi_evaluate_object(handle, method, &input, out);
289
290 return status;
291}
292EXPORT_SYMBOL_GPL(wmidev_evaluate_method);
293
294static acpi_status __query_block(struct wmi_block *wblock, u8 instance,
295 struct acpi_buffer *out)
296{
297 struct guid_block *block = NULL;
298 acpi_handle handle;
299 acpi_status status, wc_status = AE_ERROR;
300 struct acpi_object_list input;
301 union acpi_object wq_params[1];
302 char method[5];
303 char wc_method[5] = "WC";
304
305 if (!out)
306 return AE_BAD_PARAMETER;
307
308 block = &wblock->gblock;
309 handle = wblock->acpi_device->handle;
310
311 if (block->instance_count <= instance)
312 return AE_BAD_PARAMETER;
313
314 /* Check GUID is a data block */
315 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
316 return AE_ERROR;
317
318 input.count = 1;
319 input.pointer = wq_params;
320 wq_params[0].type = ACPI_TYPE_INTEGER;
321 wq_params[0].integer.value = instance;
322
323 if (instance == 0 && wblock->read_takes_no_args)
324 input.count = 0;
325
326 /*
327 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
328 * enable collection.
329 */
330 if (block->flags & ACPI_WMI_EXPENSIVE) {
331 strncat(wc_method, block->object_id, 2);
332
333 /*
334 * Some GUIDs break the specification by declaring themselves
335 * expensive, but have no corresponding WCxx method. So we
336 * should not fail if this happens.
337 */
338 if (acpi_has_method(handle, wc_method))
339 wc_status = acpi_execute_simple_method(handle,
340 wc_method, 1);
341 }
342
343 strcpy(method, "WQ");
344 strncat(method, block->object_id, 2);
345
346 status = acpi_evaluate_object(handle, method, &input, out);
347
348 /*
349 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
350 * the WQxx method failed - we should disable collection anyway.
351 */
352 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
353 status = acpi_execute_simple_method(handle, wc_method, 0);
354 }
355
356 return status;
357}
358
359/**
360 * wmi_query_block - Return contents of a WMI block (deprecated)
361 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
362 * @instance: Instance index
363 * &out: Empty buffer to return the contents of the data block to
364 *
365 * Return the contents of an ACPI-WMI data block to a buffer
366 */
367acpi_status wmi_query_block(const char *guid_string, u8 instance,
368 struct acpi_buffer *out)
369{
370 struct wmi_block *wblock;
371
372 if (!guid_string)
373 return AE_BAD_PARAMETER;
374
375 if (!find_guid(guid_string, &wblock))
376 return AE_ERROR;
377
378 return __query_block(wblock, instance, out);
379}
380EXPORT_SYMBOL_GPL(wmi_query_block);
381
382union acpi_object *wmidev_block_query(struct wmi_device *wdev, u8 instance)
383{
384 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
385 struct wmi_block *wblock = container_of(wdev, struct wmi_block, dev);
386
387 if (ACPI_FAILURE(__query_block(wblock, instance, &out)))
388 return NULL;
389
390 return (union acpi_object *)out.pointer;
391}
392EXPORT_SYMBOL_GPL(wmidev_block_query);
393
394/**
395 * wmi_set_block - Write to a WMI block
396 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
397 * @instance: Instance index
398 * &in: Buffer containing new values for the data block
399 *
400 * Write the contents of the input buffer to an ACPI-WMI data block
401 */
402acpi_status wmi_set_block(const char *guid_string, u8 instance,
403 const struct acpi_buffer *in)
404{
405 struct guid_block *block = NULL;
406 struct wmi_block *wblock = NULL;
407 acpi_handle handle;
408 struct acpi_object_list input;
409 union acpi_object params[2];
410 char method[5] = "WS";
411
412 if (!guid_string || !in)
413 return AE_BAD_DATA;
414
415 if (!find_guid(guid_string, &wblock))
416 return AE_ERROR;
417
418 block = &wblock->gblock;
419 handle = wblock->acpi_device->handle;
420
421 if (block->instance_count <= instance)
422 return AE_BAD_PARAMETER;
423
424 /* Check GUID is a data block */
425 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
426 return AE_ERROR;
427
428 input.count = 2;
429 input.pointer = params;
430 params[0].type = ACPI_TYPE_INTEGER;
431 params[0].integer.value = instance;
432
433 if (block->flags & ACPI_WMI_STRING) {
434 params[1].type = ACPI_TYPE_STRING;
435 } else {
436 params[1].type = ACPI_TYPE_BUFFER;
437 }
438 params[1].buffer.length = in->length;
439 params[1].buffer.pointer = in->pointer;
440
441 strncat(method, block->object_id, 2);
442
443 return acpi_evaluate_object(handle, method, &input, NULL);
444}
445EXPORT_SYMBOL_GPL(wmi_set_block);
446
447static void wmi_dump_wdg(const struct guid_block *g)
448{
449 pr_info("%pUL:\n", g->guid);
450 if (g->flags & ACPI_WMI_EVENT)
451 pr_info("\tnotify_id: 0x%02X\n", g->notify_id);
452 else
453 pr_info("\tobject_id: %2pE\n", g->object_id);
454 pr_info("\tinstance_count: %d\n", g->instance_count);
455 pr_info("\tflags: %#x", g->flags);
456 if (g->flags) {
457 if (g->flags & ACPI_WMI_EXPENSIVE)
458 pr_cont(" ACPI_WMI_EXPENSIVE");
459 if (g->flags & ACPI_WMI_METHOD)
460 pr_cont(" ACPI_WMI_METHOD");
461 if (g->flags & ACPI_WMI_STRING)
462 pr_cont(" ACPI_WMI_STRING");
463 if (g->flags & ACPI_WMI_EVENT)
464 pr_cont(" ACPI_WMI_EVENT");
465 }
466 pr_cont("\n");
467
468}
469
470static void wmi_notify_debug(u32 value, void *context)
471{
472 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
473 union acpi_object *obj;
474 acpi_status status;
475
476 status = wmi_get_event_data(value, &response);
477 if (status != AE_OK) {
478 pr_info("bad event status 0x%x\n", status);
479 return;
480 }
481
482 obj = (union acpi_object *)response.pointer;
483
484 if (!obj)
485 return;
486
487 pr_info("DEBUG Event ");
488 switch(obj->type) {
489 case ACPI_TYPE_BUFFER:
490 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
491 break;
492 case ACPI_TYPE_STRING:
493 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
494 break;
495 case ACPI_TYPE_INTEGER:
496 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
497 break;
498 case ACPI_TYPE_PACKAGE:
499 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
500 break;
501 default:
502 pr_cont("object type 0x%X\n", obj->type);
503 }
504 kfree(obj);
505}
506
507/**
508 * wmi_install_notify_handler - Register handler for WMI events
509 * @handler: Function to handle notifications
510 * @data: Data to be returned to handler when event is fired
511 *
512 * Register a handler for events sent to the ACPI-WMI mapper device.
513 */
514acpi_status wmi_install_notify_handler(const char *guid,
515wmi_notify_handler handler, void *data)
516{
517 struct wmi_block *block;
518 acpi_status status = AE_NOT_EXIST;
519 uuid_le guid_input;
520
521 if (!guid || !handler)
522 return AE_BAD_PARAMETER;
523
524 if (uuid_le_to_bin(guid, &guid_input))
525 return AE_BAD_PARAMETER;
526
527 list_for_each_entry(block, &wmi_block_list, list) {
528 acpi_status wmi_status;
529
530 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
531 if (block->handler &&
532 block->handler != wmi_notify_debug)
533 return AE_ALREADY_ACQUIRED;
534
535 block->handler = handler;
536 block->handler_data = data;
537
538 wmi_status = wmi_method_enable(block, 1);
539 if ((wmi_status != AE_OK) ||
540 ((wmi_status == AE_OK) && (status == AE_NOT_EXIST)))
541 status = wmi_status;
542 }
543 }
544
545 return status;
546}
547EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
548
549/**
550 * wmi_uninstall_notify_handler - Unregister handler for WMI events
551 *
552 * Unregister handler for events sent to the ACPI-WMI mapper device.
553 */
554acpi_status wmi_remove_notify_handler(const char *guid)
555{
556 struct wmi_block *block;
557 acpi_status status = AE_NOT_EXIST;
558 uuid_le guid_input;
559
560 if (!guid)
561 return AE_BAD_PARAMETER;
562
563 if (uuid_le_to_bin(guid, &guid_input))
564 return AE_BAD_PARAMETER;
565
566 list_for_each_entry(block, &wmi_block_list, list) {
567 acpi_status wmi_status;
568
569 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
570 if (!block->handler ||
571 block->handler == wmi_notify_debug)
572 return AE_NULL_ENTRY;
573
574 if (debug_event) {
575 block->handler = wmi_notify_debug;
576 status = AE_OK;
577 } else {
578 wmi_status = wmi_method_enable(block, 0);
579 block->handler = NULL;
580 block->handler_data = NULL;
581 if ((wmi_status != AE_OK) ||
582 ((wmi_status == AE_OK) &&
583 (status == AE_NOT_EXIST)))
584 status = wmi_status;
585 }
586 }
587 }
588
589 return status;
590}
591EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
592
593/**
594 * wmi_get_event_data - Get WMI data associated with an event
595 *
596 * @event: Event to find
597 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
598 *
599 * Returns extra data associated with an event in WMI.
600 */
601acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
602{
603 struct acpi_object_list input;
604 union acpi_object params[1];
605 struct guid_block *gblock;
606 struct wmi_block *wblock;
607
608 input.count = 1;
609 input.pointer = params;
610 params[0].type = ACPI_TYPE_INTEGER;
611 params[0].integer.value = event;
612
613 list_for_each_entry(wblock, &wmi_block_list, list) {
614 gblock = &wblock->gblock;
615
616 if ((gblock->flags & ACPI_WMI_EVENT) &&
617 (gblock->notify_id == event))
618 return acpi_evaluate_object(wblock->acpi_device->handle,
619 "_WED", &input, out);
620 }
621
622 return AE_NOT_FOUND;
623}
624EXPORT_SYMBOL_GPL(wmi_get_event_data);
625
626/**
627 * wmi_has_guid - Check if a GUID is available
628 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
629 *
630 * Check if a given GUID is defined by _WDG
631 */
632bool wmi_has_guid(const char *guid_string)
633{
634 return find_guid(guid_string, NULL);
635}
636EXPORT_SYMBOL_GPL(wmi_has_guid);
637
638static struct wmi_block *dev_to_wblock(struct device *dev)
639{
640 return container_of(dev, struct wmi_block, dev.dev);
641}
642
643static struct wmi_device *dev_to_wdev(struct device *dev)
644{
645 return container_of(dev, struct wmi_device, dev);
646}
647
648/*
649 * sysfs interface
650 */
651static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
652 char *buf)
653{
654 struct wmi_block *wblock = dev_to_wblock(dev);
655
656 return sprintf(buf, "wmi:%pUL\n", wblock->gblock.guid);
657}
658static DEVICE_ATTR_RO(modalias);
659
660static ssize_t guid_show(struct device *dev, struct device_attribute *attr,
661 char *buf)
662{
663 struct wmi_block *wblock = dev_to_wblock(dev);
664
665 return sprintf(buf, "%pUL\n", wblock->gblock.guid);
666}
667static DEVICE_ATTR_RO(guid);
668
669static ssize_t instance_count_show(struct device *dev,
670 struct device_attribute *attr, char *buf)
671{
672 struct wmi_block *wblock = dev_to_wblock(dev);
673
674 return sprintf(buf, "%d\n", (int)wblock->gblock.instance_count);
675}
676static DEVICE_ATTR_RO(instance_count);
677
678static ssize_t expensive_show(struct device *dev,
679 struct device_attribute *attr, char *buf)
680{
681 struct wmi_block *wblock = dev_to_wblock(dev);
682
683 return sprintf(buf, "%d\n",
684 (wblock->gblock.flags & ACPI_WMI_EXPENSIVE) != 0);
685}
686static DEVICE_ATTR_RO(expensive);
687
688static struct attribute *wmi_attrs[] = {
689 &dev_attr_modalias.attr,
690 &dev_attr_guid.attr,
691 &dev_attr_instance_count.attr,
692 &dev_attr_expensive.attr,
693 NULL,
694};
695ATTRIBUTE_GROUPS(wmi);
696
697static ssize_t notify_id_show(struct device *dev, struct device_attribute *attr,
698 char *buf)
699{
700 struct wmi_block *wblock = dev_to_wblock(dev);
701
702 return sprintf(buf, "%02X\n", (unsigned int)wblock->gblock.notify_id);
703}
704static DEVICE_ATTR_RO(notify_id);
705
706static struct attribute *wmi_event_attrs[] = {
707 &dev_attr_notify_id.attr,
708 NULL,
709};
710ATTRIBUTE_GROUPS(wmi_event);
711
712static ssize_t object_id_show(struct device *dev, struct device_attribute *attr,
713 char *buf)
714{
715 struct wmi_block *wblock = dev_to_wblock(dev);
716
717 return sprintf(buf, "%c%c\n", wblock->gblock.object_id[0],
718 wblock->gblock.object_id[1]);
719}
720static DEVICE_ATTR_RO(object_id);
721
722static ssize_t setable_show(struct device *dev, struct device_attribute *attr,
723 char *buf)
724{
725 struct wmi_device *wdev = dev_to_wdev(dev);
726
727 return sprintf(buf, "%d\n", (int)wdev->setable);
728}
729static DEVICE_ATTR_RO(setable);
730
731static struct attribute *wmi_data_attrs[] = {
732 &dev_attr_object_id.attr,
733 &dev_attr_setable.attr,
734 NULL,
735};
736ATTRIBUTE_GROUPS(wmi_data);
737
738static struct attribute *wmi_method_attrs[] = {
739 &dev_attr_object_id.attr,
740 NULL,
741};
742ATTRIBUTE_GROUPS(wmi_method);
743
744static int wmi_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
745{
746 struct wmi_block *wblock = dev_to_wblock(dev);
747
748 if (add_uevent_var(env, "MODALIAS=wmi:%pUL", wblock->gblock.guid))
749 return -ENOMEM;
750
751 if (add_uevent_var(env, "WMI_GUID=%pUL", wblock->gblock.guid))
752 return -ENOMEM;
753
754 return 0;
755}
756
757static void wmi_dev_release(struct device *dev)
758{
759 struct wmi_block *wblock = dev_to_wblock(dev);
760
761 kfree(wblock);
762}
763
764static int wmi_dev_match(struct device *dev, struct device_driver *driver)
765{
766 struct wmi_driver *wmi_driver =
767 container_of(driver, struct wmi_driver, driver);
768 struct wmi_block *wblock = dev_to_wblock(dev);
769 const struct wmi_device_id *id = wmi_driver->id_table;
770
771 while (id->guid_string) {
772 uuid_le driver_guid;
773
774 if (WARN_ON(uuid_le_to_bin(id->guid_string, &driver_guid)))
775 continue;
776 if (!memcmp(&driver_guid, wblock->gblock.guid, 16))
777 return 1;
778
779 id++;
780 }
781
782 return 0;
783}
784static int wmi_char_open(struct inode *inode, struct file *filp)
785{
786 const char *driver_name = filp->f_path.dentry->d_iname;
787 struct wmi_block *wblock = NULL;
788 struct wmi_block *next = NULL;
789
790 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
791 if (!wblock->dev.dev.driver)
792 continue;
793 if (strcmp(driver_name, wblock->dev.dev.driver->name) == 0) {
794 filp->private_data = wblock;
795 break;
796 }
797 }
798
799 if (!filp->private_data)
800 return -ENODEV;
801
802 return nonseekable_open(inode, filp);
803}
804
805static ssize_t wmi_char_read(struct file *filp, char __user *buffer,
806 size_t length, loff_t *offset)
807{
808 struct wmi_block *wblock = filp->private_data;
809
810 return simple_read_from_buffer(buffer, length, offset,
811 &wblock->req_buf_size,
812 sizeof(wblock->req_buf_size));
813}
814
815static long wmi_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
816{
817 struct wmi_ioctl_buffer __user *input =
818 (struct wmi_ioctl_buffer __user *) arg;
819 struct wmi_block *wblock = filp->private_data;
820 struct wmi_ioctl_buffer *buf = NULL;
821 struct wmi_driver *wdriver = NULL;
822 int ret;
823
824 if (_IOC_TYPE(cmd) != WMI_IOC)
825 return -ENOTTY;
826
827 /* make sure we're not calling a higher instance than exists*/
828 if (_IOC_NR(cmd) >= wblock->gblock.instance_count)
829 return -EINVAL;
830
831 mutex_lock(&wblock->char_mutex);
832 buf = wblock->handler_data;
833 if (get_user(buf->length, &input->length)) {
834 dev_dbg(&wblock->dev.dev, "Read length from user failed\n");
835 ret = -EFAULT;
836 goto out_ioctl;
837 }
838 /* if it's too small, abort */
839 if (buf->length < wblock->req_buf_size) {
840 dev_err(&wblock->dev.dev,
841 "Buffer %lld too small, need at least %lld\n",
842 buf->length, wblock->req_buf_size);
843 ret = -EINVAL;
844 goto out_ioctl;
845 }
846 /* if it's too big, warn, driver will only use what is needed */
847 if (buf->length > wblock->req_buf_size)
848 dev_warn(&wblock->dev.dev,
849 "Buffer %lld is bigger than required %lld\n",
850 buf->length, wblock->req_buf_size);
851
852 /* copy the structure from userspace */
853 if (copy_from_user(buf, input, wblock->req_buf_size)) {
854 dev_dbg(&wblock->dev.dev, "Copy %llu from user failed\n",
855 wblock->req_buf_size);
856 ret = -EFAULT;
857 goto out_ioctl;
858 }
859
860 /* let the driver do any filtering and do the call */
861 wdriver = container_of(wblock->dev.dev.driver,
862 struct wmi_driver, driver);
863 if (!try_module_get(wdriver->driver.owner)) {
864 ret = -EBUSY;
865 goto out_ioctl;
866 }
867 ret = wdriver->filter_callback(&wblock->dev, cmd, buf);
868 module_put(wdriver->driver.owner);
869 if (ret)
870 goto out_ioctl;
871
872 /* return the result (only up to our internal buffer size) */
873 if (copy_to_user(input, buf, wblock->req_buf_size)) {
874 dev_dbg(&wblock->dev.dev, "Copy %llu to user failed\n",
875 wblock->req_buf_size);
876 ret = -EFAULT;
877 }
878
879out_ioctl:
880 mutex_unlock(&wblock->char_mutex);
881 return ret;
882}
883
884static const struct file_operations wmi_fops = {
885 .owner = THIS_MODULE,
886 .read = wmi_char_read,
887 .open = wmi_char_open,
888 .unlocked_ioctl = wmi_ioctl,
889 .compat_ioctl = wmi_ioctl,
890};
891
892static int wmi_dev_probe(struct device *dev)
893{
894 struct wmi_block *wblock = dev_to_wblock(dev);
895 struct wmi_driver *wdriver =
896 container_of(dev->driver, struct wmi_driver, driver);
897 int ret = 0;
898 int count;
899 char *buf;
900
901 if (ACPI_FAILURE(wmi_method_enable(wblock, 1)))
902 dev_warn(dev, "failed to enable device -- probing anyway\n");
903
904 if (wdriver->probe) {
905 ret = wdriver->probe(dev_to_wdev(dev));
906 if (ret != 0)
907 goto probe_failure;
908 }
909
910 /* driver wants a character device made */
911 if (wdriver->filter_callback) {
912 /* check that required buffer size declared by driver or MOF */
913 if (!wblock->req_buf_size) {
914 dev_err(&wblock->dev.dev,
915 "Required buffer size not set\n");
916 ret = -EINVAL;
917 goto probe_failure;
918 }
919
920 count = get_order(wblock->req_buf_size);
921 wblock->handler_data = (void *)__get_free_pages(GFP_KERNEL,
922 count);
923 if (!wblock->handler_data) {
924 ret = -ENOMEM;
925 goto probe_failure;
926 }
927
928 buf = kasprintf(GFP_KERNEL, "wmi/%s", wdriver->driver.name);
929 if (!buf) {
930 ret = -ENOMEM;
931 goto probe_string_failure;
932 }
933 wblock->char_dev.minor = MISC_DYNAMIC_MINOR;
934 wblock->char_dev.name = buf;
935 wblock->char_dev.fops = &wmi_fops;
936 wblock->char_dev.mode = 0444;
937 ret = misc_register(&wblock->char_dev);
938 if (ret) {
939 dev_warn(dev, "failed to register char dev: %d\n", ret);
940 ret = -ENOMEM;
941 goto probe_misc_failure;
942 }
943 }
944
945 return 0;
946
947probe_misc_failure:
948 kfree(buf);
949probe_string_failure:
950 kfree(wblock->handler_data);
951probe_failure:
952 if (ACPI_FAILURE(wmi_method_enable(wblock, 0)))
953 dev_warn(dev, "failed to disable device\n");
954 return ret;
955}
956
957static int wmi_dev_remove(struct device *dev)
958{
959 struct wmi_block *wblock = dev_to_wblock(dev);
960 struct wmi_driver *wdriver =
961 container_of(dev->driver, struct wmi_driver, driver);
962 int ret = 0;
963
964 if (wdriver->filter_callback) {
965 misc_deregister(&wblock->char_dev);
966 kfree(wblock->char_dev.name);
967 free_pages((unsigned long)wblock->handler_data,
968 get_order(wblock->req_buf_size));
969 }
970
971 if (wdriver->remove)
972 ret = wdriver->remove(dev_to_wdev(dev));
973
974 if (ACPI_FAILURE(wmi_method_enable(wblock, 0)))
975 dev_warn(dev, "failed to disable device\n");
976
977 return ret;
978}
979
980static struct class wmi_bus_class = {
981 .name = "wmi_bus",
982};
983
984static struct bus_type wmi_bus_type = {
985 .name = "wmi",
986 .dev_groups = wmi_groups,
987 .match = wmi_dev_match,
988 .uevent = wmi_dev_uevent,
989 .probe = wmi_dev_probe,
990 .remove = wmi_dev_remove,
991};
992
993static struct device_type wmi_type_event = {
994 .name = "event",
995 .groups = wmi_event_groups,
996 .release = wmi_dev_release,
997};
998
999static struct device_type wmi_type_method = {
1000 .name = "method",
1001 .groups = wmi_method_groups,
1002 .release = wmi_dev_release,
1003};
1004
1005static struct device_type wmi_type_data = {
1006 .name = "data",
1007 .groups = wmi_data_groups,
1008 .release = wmi_dev_release,
1009};
1010
1011static int wmi_create_device(struct device *wmi_bus_dev,
1012 const struct guid_block *gblock,
1013 struct wmi_block *wblock,
1014 struct acpi_device *device)
1015{
1016 struct acpi_device_info *info;
1017 char method[5];
1018 int result;
1019
1020 if (gblock->flags & ACPI_WMI_EVENT) {
1021 wblock->dev.dev.type = &wmi_type_event;
1022 goto out_init;
1023 }
1024
1025 if (gblock->flags & ACPI_WMI_METHOD) {
1026 wblock->dev.dev.type = &wmi_type_method;
1027 mutex_init(&wblock->char_mutex);
1028 goto out_init;
1029 }
1030
1031 /*
1032 * Data Block Query Control Method (WQxx by convention) is
1033 * required per the WMI documentation. If it is not present,
1034 * we ignore this data block.
1035 */
1036 strcpy(method, "WQ");
1037 strncat(method, wblock->gblock.object_id, 2);
1038 result = get_subobj_info(device->handle, method, &info);
1039
1040 if (result) {
1041 dev_warn(wmi_bus_dev,
1042 "%s data block query control method not found\n",
1043 method);
1044 return result;
1045 }
1046
1047 wblock->dev.dev.type = &wmi_type_data;
1048
1049 /*
1050 * The Microsoft documentation specifically states:
1051 *
1052 * Data blocks registered with only a single instance
1053 * can ignore the parameter.
1054 *
1055 * ACPICA will get mad at us if we call the method with the wrong number
1056 * of arguments, so check what our method expects. (On some Dell
1057 * laptops, WQxx may not be a method at all.)
1058 */
1059 if (info->type != ACPI_TYPE_METHOD || info->param_count == 0)
1060 wblock->read_takes_no_args = true;
1061
1062 kfree(info);
1063
1064 strcpy(method, "WS");
1065 strncat(method, wblock->gblock.object_id, 2);
1066 result = get_subobj_info(device->handle, method, NULL);
1067
1068 if (result == 0)
1069 wblock->dev.setable = true;
1070
1071 out_init:
1072 wblock->dev.dev.bus = &wmi_bus_type;
1073 wblock->dev.dev.parent = wmi_bus_dev;
1074
1075 dev_set_name(&wblock->dev.dev, "%pUL", gblock->guid);
1076
1077 device_initialize(&wblock->dev.dev);
1078
1079 return 0;
1080}
1081
1082static void wmi_free_devices(struct acpi_device *device)
1083{
1084 struct wmi_block *wblock, *next;
1085
1086 /* Delete devices for all the GUIDs */
1087 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
1088 if (wblock->acpi_device == device) {
1089 list_del(&wblock->list);
1090 device_unregister(&wblock->dev.dev);
1091 }
1092 }
1093}
1094
1095static bool guid_already_parsed(struct acpi_device *device,
1096 const u8 *guid)
1097{
1098 struct wmi_block *wblock;
1099
1100 list_for_each_entry(wblock, &wmi_block_list, list) {
1101 if (memcmp(wblock->gblock.guid, guid, 16) == 0) {
1102 /*
1103 * Because we historically didn't track the relationship
1104 * between GUIDs and ACPI nodes, we don't know whether
1105 * we need to suppress GUIDs that are unique on a
1106 * given node but duplicated across nodes.
1107 */
1108 dev_warn(&device->dev, "duplicate WMI GUID %pUL (first instance was on %s)\n",
1109 guid, dev_name(&wblock->acpi_device->dev));
1110 return true;
1111 }
1112 }
1113
1114 return false;
1115}
1116
1117/*
1118 * Parse the _WDG method for the GUID data blocks
1119 */
1120static int parse_wdg(struct device *wmi_bus_dev, struct acpi_device *device)
1121{
1122 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
1123 const struct guid_block *gblock;
1124 struct wmi_block *wblock, *next;
1125 union acpi_object *obj;
1126 acpi_status status;
1127 int retval = 0;
1128 u32 i, total;
1129
1130 status = acpi_evaluate_object(device->handle, "_WDG", NULL, &out);
1131 if (ACPI_FAILURE(status))
1132 return -ENXIO;
1133
1134 obj = (union acpi_object *) out.pointer;
1135 if (!obj)
1136 return -ENXIO;
1137
1138 if (obj->type != ACPI_TYPE_BUFFER) {
1139 retval = -ENXIO;
1140 goto out_free_pointer;
1141 }
1142
1143 gblock = (const struct guid_block *)obj->buffer.pointer;
1144 total = obj->buffer.length / sizeof(struct guid_block);
1145
1146 for (i = 0; i < total; i++) {
1147 if (debug_dump_wdg)
1148 wmi_dump_wdg(&gblock[i]);
1149
1150 /*
1151 * Some WMI devices, like those for nVidia hooks, have a
1152 * duplicate GUID. It's not clear what we should do in this
1153 * case yet, so for now, we'll just ignore the duplicate
1154 * for device creation.
1155 */
1156 if (guid_already_parsed(device, gblock[i].guid))
1157 continue;
1158
1159 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
1160 if (!wblock) {
1161 retval = -ENOMEM;
1162 break;
1163 }
1164
1165 wblock->acpi_device = device;
1166 wblock->gblock = gblock[i];
1167
1168 retval = wmi_create_device(wmi_bus_dev, &gblock[i], wblock, device);
1169 if (retval) {
1170 kfree(wblock);
1171 continue;
1172 }
1173
1174 list_add_tail(&wblock->list, &wmi_block_list);
1175
1176 if (debug_event) {
1177 wblock->handler = wmi_notify_debug;
1178 wmi_method_enable(wblock, 1);
1179 }
1180 }
1181
1182 /*
1183 * Now that all of the devices are created, add them to the
1184 * device tree and probe subdrivers.
1185 */
1186 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
1187 if (wblock->acpi_device != device)
1188 continue;
1189
1190 retval = device_add(&wblock->dev.dev);
1191 if (retval) {
1192 dev_err(wmi_bus_dev, "failed to register %pUL\n",
1193 wblock->gblock.guid);
1194 if (debug_event)
1195 wmi_method_enable(wblock, 0);
1196 list_del(&wblock->list);
1197 put_device(&wblock->dev.dev);
1198 }
1199 }
1200
1201out_free_pointer:
1202 kfree(out.pointer);
1203 return retval;
1204}
1205
1206/*
1207 * WMI can have EmbeddedControl access regions. In which case, we just want to
1208 * hand these off to the EC driver.
1209 */
1210static acpi_status
1211acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
1212 u32 bits, u64 *value,
1213 void *handler_context, void *region_context)
1214{
1215 int result = 0, i = 0;
1216 u8 temp = 0;
1217
1218 if ((address > 0xFF) || !value)
1219 return AE_BAD_PARAMETER;
1220
1221 if (function != ACPI_READ && function != ACPI_WRITE)
1222 return AE_BAD_PARAMETER;
1223
1224 if (bits != 8)
1225 return AE_BAD_PARAMETER;
1226
1227 if (function == ACPI_READ) {
1228 result = ec_read(address, &temp);
1229 (*value) |= ((u64)temp) << i;
1230 } else {
1231 temp = 0xff & ((*value) >> i);
1232 result = ec_write(address, temp);
1233 }
1234
1235 switch (result) {
1236 case -EINVAL:
1237 return AE_BAD_PARAMETER;
1238 break;
1239 case -ENODEV:
1240 return AE_NOT_FOUND;
1241 break;
1242 case -ETIME:
1243 return AE_TIME;
1244 break;
1245 default:
1246 return AE_OK;
1247 }
1248}
1249
1250static void acpi_wmi_notify_handler(acpi_handle handle, u32 event,
1251 void *context)
1252{
1253 struct guid_block *block;
1254 struct wmi_block *wblock;
1255 bool found_it = false;
1256
1257 list_for_each_entry(wblock, &wmi_block_list, list) {
1258 block = &wblock->gblock;
1259
1260 if (wblock->acpi_device->handle == handle &&
1261 (block->flags & ACPI_WMI_EVENT) &&
1262 (block->notify_id == event))
1263 {
1264 found_it = true;
1265 break;
1266 }
1267 }
1268
1269 if (!found_it)
1270 return;
1271
1272 /* If a driver is bound, then notify the driver. */
1273 if (wblock->dev.dev.driver) {
1274 struct wmi_driver *driver;
1275 struct acpi_object_list input;
1276 union acpi_object params[1];
1277 struct acpi_buffer evdata = { ACPI_ALLOCATE_BUFFER, NULL };
1278 acpi_status status;
1279
1280 driver = container_of(wblock->dev.dev.driver,
1281 struct wmi_driver, driver);
1282
1283 input.count = 1;
1284 input.pointer = params;
1285 params[0].type = ACPI_TYPE_INTEGER;
1286 params[0].integer.value = event;
1287
1288 status = acpi_evaluate_object(wblock->acpi_device->handle,
1289 "_WED", &input, &evdata);
1290 if (ACPI_FAILURE(status)) {
1291 dev_warn(&wblock->dev.dev,
1292 "failed to get event data\n");
1293 return;
1294 }
1295
1296 if (driver->notify)
1297 driver->notify(&wblock->dev,
1298 (union acpi_object *)evdata.pointer);
1299
1300 kfree(evdata.pointer);
1301 } else if (wblock->handler) {
1302 /* Legacy handler */
1303 wblock->handler(event, wblock->handler_data);
1304 }
1305
1306 if (debug_event) {
1307 pr_info("DEBUG Event GUID: %pUL\n",
1308 wblock->gblock.guid);
1309 }
1310
1311 acpi_bus_generate_netlink_event(
1312 wblock->acpi_device->pnp.device_class,
1313 dev_name(&wblock->dev.dev),
1314 event, 0);
1315
1316}
1317
1318static int acpi_wmi_remove(struct platform_device *device)
1319{
1320 struct acpi_device *acpi_device = ACPI_COMPANION(&device->dev);
1321
1322 acpi_remove_notify_handler(acpi_device->handle, ACPI_DEVICE_NOTIFY,
1323 acpi_wmi_notify_handler);
1324 acpi_remove_address_space_handler(acpi_device->handle,
1325 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
1326 wmi_free_devices(acpi_device);
1327 device_destroy(&wmi_bus_class, MKDEV(0, 0));
1328
1329 return 0;
1330}
1331
1332static int acpi_wmi_probe(struct platform_device *device)
1333{
1334 struct acpi_device *acpi_device;
1335 struct device *wmi_bus_dev;
1336 acpi_status status;
1337 int error;
1338
1339 acpi_device = ACPI_COMPANION(&device->dev);
1340 if (!acpi_device) {
1341 dev_err(&device->dev, "ACPI companion is missing\n");
1342 return -ENODEV;
1343 }
1344
1345 status = acpi_install_address_space_handler(acpi_device->handle,
1346 ACPI_ADR_SPACE_EC,
1347 &acpi_wmi_ec_space_handler,
1348 NULL, NULL);
1349 if (ACPI_FAILURE(status)) {
1350 dev_err(&device->dev, "Error installing EC region handler\n");
1351 return -ENODEV;
1352 }
1353
1354 status = acpi_install_notify_handler(acpi_device->handle,
1355 ACPI_DEVICE_NOTIFY,
1356 acpi_wmi_notify_handler,
1357 NULL);
1358 if (ACPI_FAILURE(status)) {
1359 dev_err(&device->dev, "Error installing notify handler\n");
1360 error = -ENODEV;
1361 goto err_remove_ec_handler;
1362 }
1363
1364 wmi_bus_dev = device_create(&wmi_bus_class, &device->dev, MKDEV(0, 0),
1365 NULL, "wmi_bus-%s", dev_name(&device->dev));
1366 if (IS_ERR(wmi_bus_dev)) {
1367 error = PTR_ERR(wmi_bus_dev);
1368 goto err_remove_notify_handler;
1369 }
1370 dev_set_drvdata(&device->dev, wmi_bus_dev);
1371
1372 error = parse_wdg(wmi_bus_dev, acpi_device);
1373 if (error) {
1374 pr_err("Failed to parse WDG method\n");
1375 goto err_remove_busdev;
1376 }
1377
1378 return 0;
1379
1380err_remove_busdev:
1381 device_destroy(&wmi_bus_class, MKDEV(0, 0));
1382
1383err_remove_notify_handler:
1384 acpi_remove_notify_handler(acpi_device->handle, ACPI_DEVICE_NOTIFY,
1385 acpi_wmi_notify_handler);
1386
1387err_remove_ec_handler:
1388 acpi_remove_address_space_handler(acpi_device->handle,
1389 ACPI_ADR_SPACE_EC,
1390 &acpi_wmi_ec_space_handler);
1391
1392 return error;
1393}
1394
1395int __must_check __wmi_driver_register(struct wmi_driver *driver,
1396 struct module *owner)
1397{
1398 driver->driver.owner = owner;
1399 driver->driver.bus = &wmi_bus_type;
1400
1401 return driver_register(&driver->driver);
1402}
1403EXPORT_SYMBOL(__wmi_driver_register);
1404
1405void wmi_driver_unregister(struct wmi_driver *driver)
1406{
1407 driver_unregister(&driver->driver);
1408}
1409EXPORT_SYMBOL(wmi_driver_unregister);
1410
1411static int __init acpi_wmi_init(void)
1412{
1413 int error;
1414
1415 if (acpi_disabled)
1416 return -ENODEV;
1417
1418 error = class_register(&wmi_bus_class);
1419 if (error)
1420 return error;
1421
1422 error = bus_register(&wmi_bus_type);
1423 if (error)
1424 goto err_unreg_class;
1425
1426 error = platform_driver_register(&acpi_wmi_driver);
1427 if (error) {
1428 pr_err("Error loading mapper\n");
1429 goto err_unreg_bus;
1430 }
1431
1432 return 0;
1433
1434err_unreg_bus:
1435 bus_unregister(&wmi_bus_type);
1436
1437err_unreg_class:
1438 class_unregister(&wmi_bus_class);
1439
1440 return error;
1441}
1442
1443static void __exit acpi_wmi_exit(void)
1444{
1445 platform_driver_unregister(&acpi_wmi_driver);
1446 bus_unregister(&wmi_bus_type);
1447 class_unregister(&wmi_bus_class);
1448}
1449
1450subsys_initcall_sync(acpi_wmi_init);
1451module_exit(acpi_wmi_exit);