Loading...
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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or (at
16 * your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 *
27 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28 */
29
30#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
32#include <linux/kernel.h>
33#include <linux/init.h>
34#include <linux/types.h>
35#include <linux/device.h>
36#include <linux/list.h>
37#include <linux/acpi.h>
38#include <linux/slab.h>
39#include <linux/module.h>
40
41ACPI_MODULE_NAME("wmi");
42MODULE_AUTHOR("Carlos Corbacho");
43MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
44MODULE_LICENSE("GPL");
45
46#define ACPI_WMI_CLASS "wmi"
47
48static LIST_HEAD(wmi_block_list);
49
50struct guid_block {
51 char guid[16];
52 union {
53 char object_id[2];
54 struct {
55 unsigned char notify_id;
56 unsigned char reserved;
57 };
58 };
59 u8 instance_count;
60 u8 flags;
61};
62
63struct wmi_block {
64 struct list_head list;
65 struct guid_block gblock;
66 acpi_handle handle;
67 wmi_notify_handler handler;
68 void *handler_data;
69 struct device dev;
70};
71
72
73/*
74 * If the GUID data block is marked as expensive, we must enable and
75 * explicitily disable data collection.
76 */
77#define ACPI_WMI_EXPENSIVE 0x1
78#define ACPI_WMI_METHOD 0x2 /* GUID is a method */
79#define ACPI_WMI_STRING 0x4 /* GUID takes & returns a string */
80#define ACPI_WMI_EVENT 0x8 /* GUID is an event */
81
82static bool debug_event;
83module_param(debug_event, bool, 0444);
84MODULE_PARM_DESC(debug_event,
85 "Log WMI Events [0/1]");
86
87static bool debug_dump_wdg;
88module_param(debug_dump_wdg, bool, 0444);
89MODULE_PARM_DESC(debug_dump_wdg,
90 "Dump available WMI interfaces [0/1]");
91
92static int acpi_wmi_remove(struct acpi_device *device);
93static int acpi_wmi_add(struct acpi_device *device);
94static void acpi_wmi_notify(struct acpi_device *device, u32 event);
95
96static const struct acpi_device_id wmi_device_ids[] = {
97 {"PNP0C14", 0},
98 {"pnp0c14", 0},
99 {"", 0},
100};
101MODULE_DEVICE_TABLE(acpi, wmi_device_ids);
102
103static struct acpi_driver acpi_wmi_driver = {
104 .name = "wmi",
105 .class = ACPI_WMI_CLASS,
106 .ids = wmi_device_ids,
107 .ops = {
108 .add = acpi_wmi_add,
109 .remove = acpi_wmi_remove,
110 .notify = acpi_wmi_notify,
111 },
112};
113
114/*
115 * GUID parsing functions
116 */
117
118/**
119 * wmi_parse_hexbyte - Convert a ASCII hex number to a byte
120 * @src: Pointer to at least 2 characters to convert.
121 *
122 * Convert a two character ASCII hex string to a number.
123 *
124 * Return: 0-255 Success, the byte was parsed correctly
125 * -1 Error, an invalid character was supplied
126 */
127static int wmi_parse_hexbyte(const u8 *src)
128{
129 int h;
130 int value;
131
132 /* high part */
133 h = value = hex_to_bin(src[0]);
134 if (value < 0)
135 return -1;
136
137 /* low part */
138 value = hex_to_bin(src[1]);
139 if (value >= 0)
140 return (h << 4) | value;
141 return -1;
142}
143
144/**
145 * wmi_swap_bytes - Rearrange GUID bytes to match GUID binary
146 * @src: Memory block holding binary GUID (16 bytes)
147 * @dest: Memory block to hold byte swapped binary GUID (16 bytes)
148 *
149 * Byte swap a binary GUID to match it's real GUID value
150 */
151static void wmi_swap_bytes(u8 *src, u8 *dest)
152{
153 int i;
154
155 for (i = 0; i <= 3; i++)
156 memcpy(dest + i, src + (3 - i), 1);
157
158 for (i = 0; i <= 1; i++)
159 memcpy(dest + 4 + i, src + (5 - i), 1);
160
161 for (i = 0; i <= 1; i++)
162 memcpy(dest + 6 + i, src + (7 - i), 1);
163
164 memcpy(dest + 8, src + 8, 8);
165}
166
167/**
168 * wmi_parse_guid - Convert GUID from ASCII to binary
169 * @src: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
170 * @dest: Memory block to hold binary GUID (16 bytes)
171 *
172 * N.B. The GUID need not be NULL terminated.
173 *
174 * Return: 'true' @dest contains binary GUID
175 * 'false' @dest contents are undefined
176 */
177static bool wmi_parse_guid(const u8 *src, u8 *dest)
178{
179 static const int size[] = { 4, 2, 2, 2, 6 };
180 int i, j, v;
181
182 if (src[8] != '-' || src[13] != '-' ||
183 src[18] != '-' || src[23] != '-')
184 return false;
185
186 for (j = 0; j < 5; j++, src++) {
187 for (i = 0; i < size[j]; i++, src += 2, *dest++ = v) {
188 v = wmi_parse_hexbyte(src);
189 if (v < 0)
190 return false;
191 }
192 }
193
194 return true;
195}
196
197static bool find_guid(const char *guid_string, struct wmi_block **out)
198{
199 char tmp[16], guid_input[16];
200 struct wmi_block *wblock;
201 struct guid_block *block;
202 struct list_head *p;
203
204 wmi_parse_guid(guid_string, tmp);
205 wmi_swap_bytes(tmp, guid_input);
206
207 list_for_each(p, &wmi_block_list) {
208 wblock = list_entry(p, struct wmi_block, list);
209 block = &wblock->gblock;
210
211 if (memcmp(block->guid, guid_input, 16) == 0) {
212 if (out)
213 *out = wblock;
214 return true;
215 }
216 }
217 return false;
218}
219
220static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
221{
222 struct guid_block *block = NULL;
223 char method[5];
224 acpi_status status;
225 acpi_handle handle;
226
227 block = &wblock->gblock;
228 handle = wblock->handle;
229
230 snprintf(method, 5, "WE%02X", block->notify_id);
231 status = acpi_execute_simple_method(handle, method, enable);
232
233 if (status != AE_OK && status != AE_NOT_FOUND)
234 return status;
235 else
236 return AE_OK;
237}
238
239/*
240 * Exported WMI functions
241 */
242/**
243 * wmi_evaluate_method - Evaluate a WMI method
244 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
245 * @instance: Instance index
246 * @method_id: Method ID to call
247 * &in: Buffer containing input for the method call
248 * &out: Empty buffer to return the method results
249 *
250 * Call an ACPI-WMI method
251 */
252acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
253u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
254{
255 struct guid_block *block = NULL;
256 struct wmi_block *wblock = NULL;
257 acpi_handle handle;
258 acpi_status status;
259 struct acpi_object_list input;
260 union acpi_object params[3];
261 char method[5] = "WM";
262
263 if (!find_guid(guid_string, &wblock))
264 return AE_ERROR;
265
266 block = &wblock->gblock;
267 handle = wblock->handle;
268
269 if (!(block->flags & ACPI_WMI_METHOD))
270 return AE_BAD_DATA;
271
272 if (block->instance_count < instance)
273 return AE_BAD_PARAMETER;
274
275 input.count = 2;
276 input.pointer = params;
277 params[0].type = ACPI_TYPE_INTEGER;
278 params[0].integer.value = instance;
279 params[1].type = ACPI_TYPE_INTEGER;
280 params[1].integer.value = method_id;
281
282 if (in) {
283 input.count = 3;
284
285 if (block->flags & ACPI_WMI_STRING) {
286 params[2].type = ACPI_TYPE_STRING;
287 } else {
288 params[2].type = ACPI_TYPE_BUFFER;
289 }
290 params[2].buffer.length = in->length;
291 params[2].buffer.pointer = in->pointer;
292 }
293
294 strncat(method, block->object_id, 2);
295
296 status = acpi_evaluate_object(handle, method, &input, out);
297
298 return status;
299}
300EXPORT_SYMBOL_GPL(wmi_evaluate_method);
301
302/**
303 * wmi_query_block - Return contents of a WMI block
304 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
305 * @instance: Instance index
306 * &out: Empty buffer to return the contents of the data block to
307 *
308 * Return the contents of an ACPI-WMI data block to a buffer
309 */
310acpi_status wmi_query_block(const char *guid_string, u8 instance,
311struct acpi_buffer *out)
312{
313 struct guid_block *block = NULL;
314 struct wmi_block *wblock = NULL;
315 acpi_handle handle;
316 acpi_status status, wc_status = AE_ERROR;
317 struct acpi_object_list input;
318 union acpi_object wq_params[1];
319 char method[5];
320 char wc_method[5] = "WC";
321
322 if (!guid_string || !out)
323 return AE_BAD_PARAMETER;
324
325 if (!find_guid(guid_string, &wblock))
326 return AE_ERROR;
327
328 block = &wblock->gblock;
329 handle = wblock->handle;
330
331 if (block->instance_count < instance)
332 return AE_BAD_PARAMETER;
333
334 /* Check GUID is a data block */
335 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
336 return AE_ERROR;
337
338 input.count = 1;
339 input.pointer = wq_params;
340 wq_params[0].type = ACPI_TYPE_INTEGER;
341 wq_params[0].integer.value = instance;
342
343 /*
344 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
345 * enable collection.
346 */
347 if (block->flags & ACPI_WMI_EXPENSIVE) {
348 strncat(wc_method, block->object_id, 2);
349
350 /*
351 * Some GUIDs break the specification by declaring themselves
352 * expensive, but have no corresponding WCxx method. So we
353 * should not fail if this happens.
354 */
355 if (acpi_has_method(handle, wc_method))
356 wc_status = acpi_execute_simple_method(handle,
357 wc_method, 1);
358 }
359
360 strcpy(method, "WQ");
361 strncat(method, block->object_id, 2);
362
363 status = acpi_evaluate_object(handle, method, &input, out);
364
365 /*
366 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
367 * the WQxx method failed - we should disable collection anyway.
368 */
369 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
370 status = acpi_execute_simple_method(handle, wc_method, 0);
371 }
372
373 return status;
374}
375EXPORT_SYMBOL_GPL(wmi_query_block);
376
377/**
378 * wmi_set_block - Write to a WMI block
379 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
380 * @instance: Instance index
381 * &in: Buffer containing new values for the data block
382 *
383 * Write the contents of the input buffer to an ACPI-WMI data block
384 */
385acpi_status wmi_set_block(const char *guid_string, u8 instance,
386const struct acpi_buffer *in)
387{
388 struct guid_block *block = NULL;
389 struct wmi_block *wblock = NULL;
390 acpi_handle handle;
391 struct acpi_object_list input;
392 union acpi_object params[2];
393 char method[5] = "WS";
394
395 if (!guid_string || !in)
396 return AE_BAD_DATA;
397
398 if (!find_guid(guid_string, &wblock))
399 return AE_ERROR;
400
401 block = &wblock->gblock;
402 handle = wblock->handle;
403
404 if (block->instance_count < instance)
405 return AE_BAD_PARAMETER;
406
407 /* Check GUID is a data block */
408 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
409 return AE_ERROR;
410
411 input.count = 2;
412 input.pointer = params;
413 params[0].type = ACPI_TYPE_INTEGER;
414 params[0].integer.value = instance;
415
416 if (block->flags & ACPI_WMI_STRING) {
417 params[1].type = ACPI_TYPE_STRING;
418 } else {
419 params[1].type = ACPI_TYPE_BUFFER;
420 }
421 params[1].buffer.length = in->length;
422 params[1].buffer.pointer = in->pointer;
423
424 strncat(method, block->object_id, 2);
425
426 return acpi_evaluate_object(handle, method, &input, NULL);
427}
428EXPORT_SYMBOL_GPL(wmi_set_block);
429
430static void wmi_dump_wdg(const struct guid_block *g)
431{
432 pr_info("%pUL:\n", g->guid);
433 pr_info("\tobject_id: %c%c\n", g->object_id[0], g->object_id[1]);
434 pr_info("\tnotify_id: %02X\n", g->notify_id);
435 pr_info("\treserved: %02X\n", g->reserved);
436 pr_info("\tinstance_count: %d\n", g->instance_count);
437 pr_info("\tflags: %#x", g->flags);
438 if (g->flags) {
439 if (g->flags & ACPI_WMI_EXPENSIVE)
440 pr_cont(" ACPI_WMI_EXPENSIVE");
441 if (g->flags & ACPI_WMI_METHOD)
442 pr_cont(" ACPI_WMI_METHOD");
443 if (g->flags & ACPI_WMI_STRING)
444 pr_cont(" ACPI_WMI_STRING");
445 if (g->flags & ACPI_WMI_EVENT)
446 pr_cont(" ACPI_WMI_EVENT");
447 }
448 pr_cont("\n");
449
450}
451
452static void wmi_notify_debug(u32 value, void *context)
453{
454 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
455 union acpi_object *obj;
456 acpi_status status;
457
458 status = wmi_get_event_data(value, &response);
459 if (status != AE_OK) {
460 pr_info("bad event status 0x%x\n", status);
461 return;
462 }
463
464 obj = (union acpi_object *)response.pointer;
465
466 if (!obj)
467 return;
468
469 pr_info("DEBUG Event ");
470 switch(obj->type) {
471 case ACPI_TYPE_BUFFER:
472 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
473 break;
474 case ACPI_TYPE_STRING:
475 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
476 break;
477 case ACPI_TYPE_INTEGER:
478 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
479 break;
480 case ACPI_TYPE_PACKAGE:
481 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
482 break;
483 default:
484 pr_cont("object type 0x%X\n", obj->type);
485 }
486 kfree(obj);
487}
488
489/**
490 * wmi_install_notify_handler - Register handler for WMI events
491 * @handler: Function to handle notifications
492 * @data: Data to be returned to handler when event is fired
493 *
494 * Register a handler for events sent to the ACPI-WMI mapper device.
495 */
496acpi_status wmi_install_notify_handler(const char *guid,
497wmi_notify_handler handler, void *data)
498{
499 struct wmi_block *block;
500 acpi_status status = AE_NOT_EXIST;
501 char tmp[16], guid_input[16];
502 struct list_head *p;
503
504 if (!guid || !handler)
505 return AE_BAD_PARAMETER;
506
507 wmi_parse_guid(guid, tmp);
508 wmi_swap_bytes(tmp, guid_input);
509
510 list_for_each(p, &wmi_block_list) {
511 acpi_status wmi_status;
512 block = list_entry(p, struct wmi_block, list);
513
514 if (memcmp(block->gblock.guid, guid_input, 16) == 0) {
515 if (block->handler &&
516 block->handler != wmi_notify_debug)
517 return AE_ALREADY_ACQUIRED;
518
519 block->handler = handler;
520 block->handler_data = data;
521
522 wmi_status = wmi_method_enable(block, 1);
523 if ((wmi_status != AE_OK) ||
524 ((wmi_status == AE_OK) && (status == AE_NOT_EXIST)))
525 status = wmi_status;
526 }
527 }
528
529 return status;
530}
531EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
532
533/**
534 * wmi_uninstall_notify_handler - Unregister handler for WMI events
535 *
536 * Unregister handler for events sent to the ACPI-WMI mapper device.
537 */
538acpi_status wmi_remove_notify_handler(const char *guid)
539{
540 struct wmi_block *block;
541 acpi_status status = AE_NOT_EXIST;
542 char tmp[16], guid_input[16];
543 struct list_head *p;
544
545 if (!guid)
546 return AE_BAD_PARAMETER;
547
548 wmi_parse_guid(guid, tmp);
549 wmi_swap_bytes(tmp, guid_input);
550
551 list_for_each(p, &wmi_block_list) {
552 acpi_status wmi_status;
553 block = list_entry(p, struct wmi_block, list);
554
555 if (memcmp(block->gblock.guid, guid_input, 16) == 0) {
556 if (!block->handler ||
557 block->handler == wmi_notify_debug)
558 return AE_NULL_ENTRY;
559
560 if (debug_event) {
561 block->handler = wmi_notify_debug;
562 status = AE_OK;
563 } else {
564 wmi_status = wmi_method_enable(block, 0);
565 block->handler = NULL;
566 block->handler_data = NULL;
567 if ((wmi_status != AE_OK) ||
568 ((wmi_status == AE_OK) &&
569 (status == AE_NOT_EXIST)))
570 status = wmi_status;
571 }
572 }
573 }
574
575 return status;
576}
577EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
578
579/**
580 * wmi_get_event_data - Get WMI data associated with an event
581 *
582 * @event: Event to find
583 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
584 *
585 * Returns extra data associated with an event in WMI.
586 */
587acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
588{
589 struct acpi_object_list input;
590 union acpi_object params[1];
591 struct guid_block *gblock;
592 struct wmi_block *wblock;
593 struct list_head *p;
594
595 input.count = 1;
596 input.pointer = params;
597 params[0].type = ACPI_TYPE_INTEGER;
598 params[0].integer.value = event;
599
600 list_for_each(p, &wmi_block_list) {
601 wblock = list_entry(p, struct wmi_block, list);
602 gblock = &wblock->gblock;
603
604 if ((gblock->flags & ACPI_WMI_EVENT) &&
605 (gblock->notify_id == event))
606 return acpi_evaluate_object(wblock->handle, "_WED",
607 &input, out);
608 }
609
610 return AE_NOT_FOUND;
611}
612EXPORT_SYMBOL_GPL(wmi_get_event_data);
613
614/**
615 * wmi_has_guid - Check if a GUID is available
616 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
617 *
618 * Check if a given GUID is defined by _WDG
619 */
620bool wmi_has_guid(const char *guid_string)
621{
622 return find_guid(guid_string, NULL);
623}
624EXPORT_SYMBOL_GPL(wmi_has_guid);
625
626/*
627 * sysfs interface
628 */
629static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
630 char *buf)
631{
632 struct wmi_block *wblock;
633
634 wblock = dev_get_drvdata(dev);
635 if (!wblock) {
636 strcat(buf, "\n");
637 return strlen(buf);
638 }
639
640 return sprintf(buf, "wmi:%pUL\n", wblock->gblock.guid);
641}
642static DEVICE_ATTR_RO(modalias);
643
644static struct attribute *wmi_attrs[] = {
645 &dev_attr_modalias.attr,
646 NULL,
647};
648ATTRIBUTE_GROUPS(wmi);
649
650static int wmi_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
651{
652 char guid_string[37];
653
654 struct wmi_block *wblock;
655
656 if (add_uevent_var(env, "MODALIAS="))
657 return -ENOMEM;
658
659 wblock = dev_get_drvdata(dev);
660 if (!wblock)
661 return -ENOMEM;
662
663 sprintf(guid_string, "%pUL", wblock->gblock.guid);
664
665 strcpy(&env->buf[env->buflen - 1], "wmi:");
666 memcpy(&env->buf[env->buflen - 1 + 4], guid_string, 36);
667 env->buflen += 40;
668
669 return 0;
670}
671
672static void wmi_dev_free(struct device *dev)
673{
674 struct wmi_block *wmi_block = container_of(dev, struct wmi_block, dev);
675
676 kfree(wmi_block);
677}
678
679static struct class wmi_class = {
680 .name = "wmi",
681 .dev_release = wmi_dev_free,
682 .dev_uevent = wmi_dev_uevent,
683 .dev_groups = wmi_groups,
684};
685
686static int wmi_create_device(const struct guid_block *gblock,
687 struct wmi_block *wblock, acpi_handle handle)
688{
689 wblock->dev.class = &wmi_class;
690
691 dev_set_name(&wblock->dev, "%pUL", gblock->guid);
692
693 dev_set_drvdata(&wblock->dev, wblock);
694
695 return device_register(&wblock->dev);
696}
697
698static void wmi_free_devices(void)
699{
700 struct wmi_block *wblock, *next;
701
702 /* Delete devices for all the GUIDs */
703 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
704 list_del(&wblock->list);
705 if (wblock->dev.class)
706 device_unregister(&wblock->dev);
707 else
708 kfree(wblock);
709 }
710}
711
712static bool guid_already_parsed(const char *guid_string)
713{
714 struct wmi_block *wblock;
715
716 list_for_each_entry(wblock, &wmi_block_list, list)
717 if (memcmp(wblock->gblock.guid, guid_string, 16) == 0)
718 return true;
719
720 return false;
721}
722
723/*
724 * Parse the _WDG method for the GUID data blocks
725 */
726static int parse_wdg(acpi_handle handle)
727{
728 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
729 union acpi_object *obj;
730 const struct guid_block *gblock;
731 struct wmi_block *wblock;
732 acpi_status status;
733 int retval;
734 u32 i, total;
735
736 status = acpi_evaluate_object(handle, "_WDG", NULL, &out);
737 if (ACPI_FAILURE(status))
738 return -ENXIO;
739
740 obj = (union acpi_object *) out.pointer;
741 if (!obj)
742 return -ENXIO;
743
744 if (obj->type != ACPI_TYPE_BUFFER) {
745 retval = -ENXIO;
746 goto out_free_pointer;
747 }
748
749 gblock = (const struct guid_block *)obj->buffer.pointer;
750 total = obj->buffer.length / sizeof(struct guid_block);
751
752 for (i = 0; i < total; i++) {
753 if (debug_dump_wdg)
754 wmi_dump_wdg(&gblock[i]);
755
756 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
757 if (!wblock)
758 return -ENOMEM;
759
760 wblock->handle = handle;
761 wblock->gblock = gblock[i];
762
763 /*
764 Some WMI devices, like those for nVidia hooks, have a
765 duplicate GUID. It's not clear what we should do in this
766 case yet, so for now, we'll just ignore the duplicate
767 for device creation.
768 */
769 if (!guid_already_parsed(gblock[i].guid)) {
770 retval = wmi_create_device(&gblock[i], wblock, handle);
771 if (retval) {
772 wmi_free_devices();
773 goto out_free_pointer;
774 }
775 }
776
777 list_add_tail(&wblock->list, &wmi_block_list);
778
779 if (debug_event) {
780 wblock->handler = wmi_notify_debug;
781 wmi_method_enable(wblock, 1);
782 }
783 }
784
785 retval = 0;
786
787out_free_pointer:
788 kfree(out.pointer);
789
790 return retval;
791}
792
793/*
794 * WMI can have EmbeddedControl access regions. In which case, we just want to
795 * hand these off to the EC driver.
796 */
797static acpi_status
798acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
799 u32 bits, u64 *value,
800 void *handler_context, void *region_context)
801{
802 int result = 0, i = 0;
803 u8 temp = 0;
804
805 if ((address > 0xFF) || !value)
806 return AE_BAD_PARAMETER;
807
808 if (function != ACPI_READ && function != ACPI_WRITE)
809 return AE_BAD_PARAMETER;
810
811 if (bits != 8)
812 return AE_BAD_PARAMETER;
813
814 if (function == ACPI_READ) {
815 result = ec_read(address, &temp);
816 (*value) |= ((u64)temp) << i;
817 } else {
818 temp = 0xff & ((*value) >> i);
819 result = ec_write(address, temp);
820 }
821
822 switch (result) {
823 case -EINVAL:
824 return AE_BAD_PARAMETER;
825 break;
826 case -ENODEV:
827 return AE_NOT_FOUND;
828 break;
829 case -ETIME:
830 return AE_TIME;
831 break;
832 default:
833 return AE_OK;
834 }
835}
836
837static void acpi_wmi_notify(struct acpi_device *device, u32 event)
838{
839 struct guid_block *block;
840 struct wmi_block *wblock;
841 struct list_head *p;
842
843 list_for_each(p, &wmi_block_list) {
844 wblock = list_entry(p, struct wmi_block, list);
845 block = &wblock->gblock;
846
847 if ((block->flags & ACPI_WMI_EVENT) &&
848 (block->notify_id == event)) {
849 if (wblock->handler)
850 wblock->handler(event, wblock->handler_data);
851 if (debug_event) {
852 pr_info("DEBUG Event GUID: %pUL\n",
853 wblock->gblock.guid);
854 }
855
856 acpi_bus_generate_netlink_event(
857 device->pnp.device_class, dev_name(&device->dev),
858 event, 0);
859 break;
860 }
861 }
862}
863
864static int acpi_wmi_remove(struct acpi_device *device)
865{
866 acpi_remove_address_space_handler(device->handle,
867 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
868 wmi_free_devices();
869
870 return 0;
871}
872
873static int acpi_wmi_add(struct acpi_device *device)
874{
875 acpi_status status;
876 int error;
877
878 status = acpi_install_address_space_handler(device->handle,
879 ACPI_ADR_SPACE_EC,
880 &acpi_wmi_ec_space_handler,
881 NULL, NULL);
882 if (ACPI_FAILURE(status)) {
883 pr_err("Error installing EC region handler\n");
884 return -ENODEV;
885 }
886
887 error = parse_wdg(device->handle);
888 if (error) {
889 acpi_remove_address_space_handler(device->handle,
890 ACPI_ADR_SPACE_EC,
891 &acpi_wmi_ec_space_handler);
892 pr_err("Failed to parse WDG method\n");
893 return error;
894 }
895
896 return 0;
897}
898
899static int __init acpi_wmi_init(void)
900{
901 int error;
902
903 if (acpi_disabled)
904 return -ENODEV;
905
906 error = class_register(&wmi_class);
907 if (error)
908 return error;
909
910 error = acpi_bus_register_driver(&acpi_wmi_driver);
911 if (error) {
912 pr_err("Error loading mapper\n");
913 class_unregister(&wmi_class);
914 return error;
915 }
916
917 pr_info("Mapper loaded\n");
918 return 0;
919}
920
921static void __exit acpi_wmi_exit(void)
922{
923 acpi_bus_unregister_driver(&acpi_wmi_driver);
924 class_unregister(&wmi_class);
925
926 pr_info("Mapper unloaded\n");
927}
928
929subsys_initcall(acpi_wmi_init);
930module_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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or (at
16 * your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 *
27 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28 */
29
30#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
32#include <linux/kernel.h>
33#include <linux/init.h>
34#include <linux/types.h>
35#include <linux/device.h>
36#include <linux/list.h>
37#include <linux/acpi.h>
38#include <linux/slab.h>
39#include <linux/module.h>
40
41ACPI_MODULE_NAME("wmi");
42MODULE_AUTHOR("Carlos Corbacho");
43MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
44MODULE_LICENSE("GPL");
45
46#define ACPI_WMI_CLASS "wmi"
47
48static DEFINE_MUTEX(wmi_data_lock);
49static LIST_HEAD(wmi_block_list);
50
51struct guid_block {
52 char guid[16];
53 union {
54 char object_id[2];
55 struct {
56 unsigned char notify_id;
57 unsigned char reserved;
58 };
59 };
60 u8 instance_count;
61 u8 flags;
62};
63
64struct wmi_block {
65 struct list_head list;
66 struct guid_block gblock;
67 acpi_handle handle;
68 wmi_notify_handler handler;
69 void *handler_data;
70 struct device dev;
71};
72
73
74/*
75 * If the GUID data block is marked as expensive, we must enable and
76 * explicitily disable data collection.
77 */
78#define ACPI_WMI_EXPENSIVE 0x1
79#define ACPI_WMI_METHOD 0x2 /* GUID is a method */
80#define ACPI_WMI_STRING 0x4 /* GUID takes & returns a string */
81#define ACPI_WMI_EVENT 0x8 /* GUID is an event */
82
83static bool debug_event;
84module_param(debug_event, bool, 0444);
85MODULE_PARM_DESC(debug_event,
86 "Log WMI Events [0/1]");
87
88static bool debug_dump_wdg;
89module_param(debug_dump_wdg, bool, 0444);
90MODULE_PARM_DESC(debug_dump_wdg,
91 "Dump available WMI interfaces [0/1]");
92
93static int acpi_wmi_remove(struct acpi_device *device);
94static int acpi_wmi_add(struct acpi_device *device);
95static void acpi_wmi_notify(struct acpi_device *device, u32 event);
96
97static const struct acpi_device_id wmi_device_ids[] = {
98 {"PNP0C14", 0},
99 {"pnp0c14", 0},
100 {"", 0},
101};
102MODULE_DEVICE_TABLE(acpi, wmi_device_ids);
103
104static struct acpi_driver acpi_wmi_driver = {
105 .name = "wmi",
106 .class = ACPI_WMI_CLASS,
107 .ids = wmi_device_ids,
108 .ops = {
109 .add = acpi_wmi_add,
110 .remove = acpi_wmi_remove,
111 .notify = acpi_wmi_notify,
112 },
113};
114
115/*
116 * GUID parsing functions
117 */
118
119/**
120 * wmi_parse_hexbyte - Convert a ASCII hex number to a byte
121 * @src: Pointer to at least 2 characters to convert.
122 *
123 * Convert a two character ASCII hex string to a number.
124 *
125 * Return: 0-255 Success, the byte was parsed correctly
126 * -1 Error, an invalid character was supplied
127 */
128static int wmi_parse_hexbyte(const u8 *src)
129{
130 int h;
131 int value;
132
133 /* high part */
134 h = value = hex_to_bin(src[0]);
135 if (value < 0)
136 return -1;
137
138 /* low part */
139 value = hex_to_bin(src[1]);
140 if (value >= 0)
141 return (h << 4) | value;
142 return -1;
143}
144
145/**
146 * wmi_swap_bytes - Rearrange GUID bytes to match GUID binary
147 * @src: Memory block holding binary GUID (16 bytes)
148 * @dest: Memory block to hold byte swapped binary GUID (16 bytes)
149 *
150 * Byte swap a binary GUID to match it's real GUID value
151 */
152static void wmi_swap_bytes(u8 *src, u8 *dest)
153{
154 int i;
155
156 for (i = 0; i <= 3; i++)
157 memcpy(dest + i, src + (3 - i), 1);
158
159 for (i = 0; i <= 1; i++)
160 memcpy(dest + 4 + i, src + (5 - i), 1);
161
162 for (i = 0; i <= 1; i++)
163 memcpy(dest + 6 + i, src + (7 - i), 1);
164
165 memcpy(dest + 8, src + 8, 8);
166}
167
168/**
169 * wmi_parse_guid - Convert GUID from ASCII to binary
170 * @src: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
171 * @dest: Memory block to hold binary GUID (16 bytes)
172 *
173 * N.B. The GUID need not be NULL terminated.
174 *
175 * Return: 'true' @dest contains binary GUID
176 * 'false' @dest contents are undefined
177 */
178static bool wmi_parse_guid(const u8 *src, u8 *dest)
179{
180 static const int size[] = { 4, 2, 2, 2, 6 };
181 int i, j, v;
182
183 if (src[8] != '-' || src[13] != '-' ||
184 src[18] != '-' || src[23] != '-')
185 return false;
186
187 for (j = 0; j < 5; j++, src++) {
188 for (i = 0; i < size[j]; i++, src += 2, *dest++ = v) {
189 v = wmi_parse_hexbyte(src);
190 if (v < 0)
191 return false;
192 }
193 }
194
195 return true;
196}
197
198/*
199 * Convert a raw GUID to the ACII string representation
200 */
201static int wmi_gtoa(const char *in, char *out)
202{
203 int i;
204
205 for (i = 3; i >= 0; i--)
206 out += sprintf(out, "%02X", in[i] & 0xFF);
207
208 out += sprintf(out, "-");
209 out += sprintf(out, "%02X", in[5] & 0xFF);
210 out += sprintf(out, "%02X", in[4] & 0xFF);
211 out += sprintf(out, "-");
212 out += sprintf(out, "%02X", in[7] & 0xFF);
213 out += sprintf(out, "%02X", in[6] & 0xFF);
214 out += sprintf(out, "-");
215 out += sprintf(out, "%02X", in[8] & 0xFF);
216 out += sprintf(out, "%02X", in[9] & 0xFF);
217 out += sprintf(out, "-");
218
219 for (i = 10; i <= 15; i++)
220 out += sprintf(out, "%02X", in[i] & 0xFF);
221
222 *out = '\0';
223 return 0;
224}
225
226static bool find_guid(const char *guid_string, struct wmi_block **out)
227{
228 char tmp[16], guid_input[16];
229 struct wmi_block *wblock;
230 struct guid_block *block;
231 struct list_head *p;
232
233 wmi_parse_guid(guid_string, tmp);
234 wmi_swap_bytes(tmp, guid_input);
235
236 list_for_each(p, &wmi_block_list) {
237 wblock = list_entry(p, struct wmi_block, list);
238 block = &wblock->gblock;
239
240 if (memcmp(block->guid, guid_input, 16) == 0) {
241 if (out)
242 *out = wblock;
243 return 1;
244 }
245 }
246 return 0;
247}
248
249static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
250{
251 struct guid_block *block = NULL;
252 char method[5];
253 acpi_status status;
254 acpi_handle handle;
255
256 block = &wblock->gblock;
257 handle = wblock->handle;
258
259 if (!block)
260 return AE_NOT_EXIST;
261
262
263 snprintf(method, 5, "WE%02X", block->notify_id);
264 status = acpi_execute_simple_method(handle, method, enable);
265
266 if (status != AE_OK && status != AE_NOT_FOUND)
267 return status;
268 else
269 return AE_OK;
270}
271
272/*
273 * Exported WMI functions
274 */
275/**
276 * wmi_evaluate_method - Evaluate a WMI method
277 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
278 * @instance: Instance index
279 * @method_id: Method ID to call
280 * &in: Buffer containing input for the method call
281 * &out: Empty buffer to return the method results
282 *
283 * Call an ACPI-WMI method
284 */
285acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
286u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
287{
288 struct guid_block *block = NULL;
289 struct wmi_block *wblock = NULL;
290 acpi_handle handle;
291 acpi_status status;
292 struct acpi_object_list input;
293 union acpi_object params[3];
294 char method[5] = "WM";
295
296 if (!find_guid(guid_string, &wblock))
297 return AE_ERROR;
298
299 block = &wblock->gblock;
300 handle = wblock->handle;
301
302 if (!(block->flags & ACPI_WMI_METHOD))
303 return AE_BAD_DATA;
304
305 if (block->instance_count < instance)
306 return AE_BAD_PARAMETER;
307
308 input.count = 2;
309 input.pointer = params;
310 params[0].type = ACPI_TYPE_INTEGER;
311 params[0].integer.value = instance;
312 params[1].type = ACPI_TYPE_INTEGER;
313 params[1].integer.value = method_id;
314
315 if (in) {
316 input.count = 3;
317
318 if (block->flags & ACPI_WMI_STRING) {
319 params[2].type = ACPI_TYPE_STRING;
320 } else {
321 params[2].type = ACPI_TYPE_BUFFER;
322 }
323 params[2].buffer.length = in->length;
324 params[2].buffer.pointer = in->pointer;
325 }
326
327 strncat(method, block->object_id, 2);
328
329 status = acpi_evaluate_object(handle, method, &input, out);
330
331 return status;
332}
333EXPORT_SYMBOL_GPL(wmi_evaluate_method);
334
335/**
336 * wmi_query_block - Return contents of a WMI block
337 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
338 * @instance: Instance index
339 * &out: Empty buffer to return the contents of the data block to
340 *
341 * Return the contents of an ACPI-WMI data block to a buffer
342 */
343acpi_status wmi_query_block(const char *guid_string, u8 instance,
344struct acpi_buffer *out)
345{
346 struct guid_block *block = NULL;
347 struct wmi_block *wblock = NULL;
348 acpi_handle handle;
349 acpi_status status, wc_status = AE_ERROR;
350 struct acpi_object_list input;
351 union acpi_object wq_params[1];
352 char method[5];
353 char wc_method[5] = "WC";
354
355 if (!guid_string || !out)
356 return AE_BAD_PARAMETER;
357
358 if (!find_guid(guid_string, &wblock))
359 return AE_ERROR;
360
361 block = &wblock->gblock;
362 handle = wblock->handle;
363
364 if (block->instance_count < instance)
365 return AE_BAD_PARAMETER;
366
367 /* Check GUID is a data block */
368 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
369 return AE_ERROR;
370
371 input.count = 1;
372 input.pointer = wq_params;
373 wq_params[0].type = ACPI_TYPE_INTEGER;
374 wq_params[0].integer.value = instance;
375
376 /*
377 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
378 * enable collection.
379 */
380 if (block->flags & ACPI_WMI_EXPENSIVE) {
381 strncat(wc_method, block->object_id, 2);
382
383 /*
384 * Some GUIDs break the specification by declaring themselves
385 * expensive, but have no corresponding WCxx method. So we
386 * should not fail if this happens.
387 */
388 if (acpi_has_method(handle, wc_method))
389 wc_status = acpi_execute_simple_method(handle,
390 wc_method, 1);
391 }
392
393 strcpy(method, "WQ");
394 strncat(method, block->object_id, 2);
395
396 status = acpi_evaluate_object(handle, method, &input, out);
397
398 /*
399 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
400 * the WQxx method failed - we should disable collection anyway.
401 */
402 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
403 status = acpi_execute_simple_method(handle, wc_method, 0);
404 }
405
406 return status;
407}
408EXPORT_SYMBOL_GPL(wmi_query_block);
409
410/**
411 * wmi_set_block - Write to a WMI block
412 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
413 * @instance: Instance index
414 * &in: Buffer containing new values for the data block
415 *
416 * Write the contents of the input buffer to an ACPI-WMI data block
417 */
418acpi_status wmi_set_block(const char *guid_string, u8 instance,
419const struct acpi_buffer *in)
420{
421 struct guid_block *block = NULL;
422 struct wmi_block *wblock = NULL;
423 acpi_handle handle;
424 struct acpi_object_list input;
425 union acpi_object params[2];
426 char method[5] = "WS";
427
428 if (!guid_string || !in)
429 return AE_BAD_DATA;
430
431 if (!find_guid(guid_string, &wblock))
432 return AE_ERROR;
433
434 block = &wblock->gblock;
435 handle = wblock->handle;
436
437 if (block->instance_count < instance)
438 return AE_BAD_PARAMETER;
439
440 /* Check GUID is a data block */
441 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
442 return AE_ERROR;
443
444 input.count = 2;
445 input.pointer = params;
446 params[0].type = ACPI_TYPE_INTEGER;
447 params[0].integer.value = instance;
448
449 if (block->flags & ACPI_WMI_STRING) {
450 params[1].type = ACPI_TYPE_STRING;
451 } else {
452 params[1].type = ACPI_TYPE_BUFFER;
453 }
454 params[1].buffer.length = in->length;
455 params[1].buffer.pointer = in->pointer;
456
457 strncat(method, block->object_id, 2);
458
459 return acpi_evaluate_object(handle, method, &input, NULL);
460}
461EXPORT_SYMBOL_GPL(wmi_set_block);
462
463static void wmi_dump_wdg(const struct guid_block *g)
464{
465 char guid_string[37];
466
467 wmi_gtoa(g->guid, guid_string);
468
469 pr_info("%s:\n", guid_string);
470 pr_info("\tobject_id: %c%c\n", g->object_id[0], g->object_id[1]);
471 pr_info("\tnotify_id: %02X\n", g->notify_id);
472 pr_info("\treserved: %02X\n", g->reserved);
473 pr_info("\tinstance_count: %d\n", g->instance_count);
474 pr_info("\tflags: %#x", g->flags);
475 if (g->flags) {
476 if (g->flags & ACPI_WMI_EXPENSIVE)
477 pr_cont(" ACPI_WMI_EXPENSIVE");
478 if (g->flags & ACPI_WMI_METHOD)
479 pr_cont(" ACPI_WMI_METHOD");
480 if (g->flags & ACPI_WMI_STRING)
481 pr_cont(" ACPI_WMI_STRING");
482 if (g->flags & ACPI_WMI_EVENT)
483 pr_cont(" ACPI_WMI_EVENT");
484 }
485 pr_cont("\n");
486
487}
488
489static void wmi_notify_debug(u32 value, void *context)
490{
491 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
492 union acpi_object *obj;
493 acpi_status status;
494
495 status = wmi_get_event_data(value, &response);
496 if (status != AE_OK) {
497 pr_info("bad event status 0x%x\n", status);
498 return;
499 }
500
501 obj = (union acpi_object *)response.pointer;
502
503 if (!obj)
504 return;
505
506 pr_info("DEBUG Event ");
507 switch(obj->type) {
508 case ACPI_TYPE_BUFFER:
509 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
510 break;
511 case ACPI_TYPE_STRING:
512 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
513 break;
514 case ACPI_TYPE_INTEGER:
515 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
516 break;
517 case ACPI_TYPE_PACKAGE:
518 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
519 break;
520 default:
521 pr_cont("object type 0x%X\n", obj->type);
522 }
523 kfree(obj);
524}
525
526/**
527 * wmi_install_notify_handler - Register handler for WMI events
528 * @handler: Function to handle notifications
529 * @data: Data to be returned to handler when event is fired
530 *
531 * Register a handler for events sent to the ACPI-WMI mapper device.
532 */
533acpi_status wmi_install_notify_handler(const char *guid,
534wmi_notify_handler handler, void *data)
535{
536 struct wmi_block *block;
537 acpi_status status = AE_NOT_EXIST;
538 char tmp[16], guid_input[16];
539 struct list_head *p;
540
541 if (!guid || !handler)
542 return AE_BAD_PARAMETER;
543
544 wmi_parse_guid(guid, tmp);
545 wmi_swap_bytes(tmp, guid_input);
546
547 list_for_each(p, &wmi_block_list) {
548 acpi_status wmi_status;
549 block = list_entry(p, struct wmi_block, list);
550
551 if (memcmp(block->gblock.guid, guid_input, 16) == 0) {
552 if (block->handler &&
553 block->handler != wmi_notify_debug)
554 return AE_ALREADY_ACQUIRED;
555
556 block->handler = handler;
557 block->handler_data = data;
558
559 wmi_status = wmi_method_enable(block, 1);
560 if ((wmi_status != AE_OK) ||
561 ((wmi_status == AE_OK) && (status == AE_NOT_EXIST)))
562 status = wmi_status;
563 }
564 }
565
566 return status;
567}
568EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
569
570/**
571 * wmi_uninstall_notify_handler - Unregister handler for WMI events
572 *
573 * Unregister handler for events sent to the ACPI-WMI mapper device.
574 */
575acpi_status wmi_remove_notify_handler(const char *guid)
576{
577 struct wmi_block *block;
578 acpi_status status = AE_NOT_EXIST;
579 char tmp[16], guid_input[16];
580 struct list_head *p;
581
582 if (!guid)
583 return AE_BAD_PARAMETER;
584
585 wmi_parse_guid(guid, tmp);
586 wmi_swap_bytes(tmp, guid_input);
587
588 list_for_each(p, &wmi_block_list) {
589 acpi_status wmi_status;
590 block = list_entry(p, struct wmi_block, list);
591
592 if (memcmp(block->gblock.guid, guid_input, 16) == 0) {
593 if (!block->handler ||
594 block->handler == wmi_notify_debug)
595 return AE_NULL_ENTRY;
596
597 if (debug_event) {
598 block->handler = wmi_notify_debug;
599 status = AE_OK;
600 } else {
601 wmi_status = wmi_method_enable(block, 0);
602 block->handler = NULL;
603 block->handler_data = NULL;
604 if ((wmi_status != AE_OK) ||
605 ((wmi_status == AE_OK) &&
606 (status == AE_NOT_EXIST)))
607 status = wmi_status;
608 }
609 }
610 }
611
612 return status;
613}
614EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
615
616/**
617 * wmi_get_event_data - Get WMI data associated with an event
618 *
619 * @event: Event to find
620 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
621 *
622 * Returns extra data associated with an event in WMI.
623 */
624acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
625{
626 struct acpi_object_list input;
627 union acpi_object params[1];
628 struct guid_block *gblock;
629 struct wmi_block *wblock;
630 struct list_head *p;
631
632 input.count = 1;
633 input.pointer = params;
634 params[0].type = ACPI_TYPE_INTEGER;
635 params[0].integer.value = event;
636
637 list_for_each(p, &wmi_block_list) {
638 wblock = list_entry(p, struct wmi_block, list);
639 gblock = &wblock->gblock;
640
641 if ((gblock->flags & ACPI_WMI_EVENT) &&
642 (gblock->notify_id == event))
643 return acpi_evaluate_object(wblock->handle, "_WED",
644 &input, out);
645 }
646
647 return AE_NOT_FOUND;
648}
649EXPORT_SYMBOL_GPL(wmi_get_event_data);
650
651/**
652 * wmi_has_guid - Check if a GUID is available
653 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
654 *
655 * Check if a given GUID is defined by _WDG
656 */
657bool wmi_has_guid(const char *guid_string)
658{
659 return find_guid(guid_string, NULL);
660}
661EXPORT_SYMBOL_GPL(wmi_has_guid);
662
663/*
664 * sysfs interface
665 */
666static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
667 char *buf)
668{
669 char guid_string[37];
670 struct wmi_block *wblock;
671
672 wblock = dev_get_drvdata(dev);
673 if (!wblock) {
674 strcat(buf, "\n");
675 return strlen(buf);
676 }
677
678 wmi_gtoa(wblock->gblock.guid, guid_string);
679
680 return sprintf(buf, "wmi:%s\n", guid_string);
681}
682static DEVICE_ATTR_RO(modalias);
683
684static struct attribute *wmi_attrs[] = {
685 &dev_attr_modalias.attr,
686 NULL,
687};
688ATTRIBUTE_GROUPS(wmi);
689
690static int wmi_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
691{
692 char guid_string[37];
693
694 struct wmi_block *wblock;
695
696 if (add_uevent_var(env, "MODALIAS="))
697 return -ENOMEM;
698
699 wblock = dev_get_drvdata(dev);
700 if (!wblock)
701 return -ENOMEM;
702
703 wmi_gtoa(wblock->gblock.guid, guid_string);
704
705 strcpy(&env->buf[env->buflen - 1], "wmi:");
706 memcpy(&env->buf[env->buflen - 1 + 4], guid_string, 36);
707 env->buflen += 40;
708
709 return 0;
710}
711
712static void wmi_dev_free(struct device *dev)
713{
714 struct wmi_block *wmi_block = container_of(dev, struct wmi_block, dev);
715
716 kfree(wmi_block);
717}
718
719static struct class wmi_class = {
720 .name = "wmi",
721 .dev_release = wmi_dev_free,
722 .dev_uevent = wmi_dev_uevent,
723 .dev_groups = wmi_groups,
724};
725
726static int wmi_create_device(const struct guid_block *gblock,
727 struct wmi_block *wblock, acpi_handle handle)
728{
729 char guid_string[37];
730
731 wblock->dev.class = &wmi_class;
732
733 wmi_gtoa(gblock->guid, guid_string);
734 dev_set_name(&wblock->dev, "%s", guid_string);
735
736 dev_set_drvdata(&wblock->dev, wblock);
737
738 return device_register(&wblock->dev);
739}
740
741static void wmi_free_devices(void)
742{
743 struct wmi_block *wblock, *next;
744
745 /* Delete devices for all the GUIDs */
746 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
747 list_del(&wblock->list);
748 if (wblock->dev.class)
749 device_unregister(&wblock->dev);
750 else
751 kfree(wblock);
752 }
753}
754
755static bool guid_already_parsed(const char *guid_string)
756{
757 struct wmi_block *wblock;
758
759 list_for_each_entry(wblock, &wmi_block_list, list)
760 if (memcmp(wblock->gblock.guid, guid_string, 16) == 0)
761 return true;
762
763 return false;
764}
765
766/*
767 * Parse the _WDG method for the GUID data blocks
768 */
769static int parse_wdg(acpi_handle handle)
770{
771 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
772 union acpi_object *obj;
773 const struct guid_block *gblock;
774 struct wmi_block *wblock;
775 acpi_status status;
776 int retval;
777 u32 i, total;
778
779 status = acpi_evaluate_object(handle, "_WDG", NULL, &out);
780 if (ACPI_FAILURE(status))
781 return -ENXIO;
782
783 obj = (union acpi_object *) out.pointer;
784 if (!obj)
785 return -ENXIO;
786
787 if (obj->type != ACPI_TYPE_BUFFER) {
788 retval = -ENXIO;
789 goto out_free_pointer;
790 }
791
792 gblock = (const struct guid_block *)obj->buffer.pointer;
793 total = obj->buffer.length / sizeof(struct guid_block);
794
795 for (i = 0; i < total; i++) {
796 if (debug_dump_wdg)
797 wmi_dump_wdg(&gblock[i]);
798
799 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
800 if (!wblock)
801 return -ENOMEM;
802
803 wblock->handle = handle;
804 wblock->gblock = gblock[i];
805
806 /*
807 Some WMI devices, like those for nVidia hooks, have a
808 duplicate GUID. It's not clear what we should do in this
809 case yet, so for now, we'll just ignore the duplicate
810 for device creation.
811 */
812 if (!guid_already_parsed(gblock[i].guid)) {
813 retval = wmi_create_device(&gblock[i], wblock, handle);
814 if (retval) {
815 wmi_free_devices();
816 goto out_free_pointer;
817 }
818 }
819
820 list_add_tail(&wblock->list, &wmi_block_list);
821
822 if (debug_event) {
823 wblock->handler = wmi_notify_debug;
824 wmi_method_enable(wblock, 1);
825 }
826 }
827
828 retval = 0;
829
830out_free_pointer:
831 kfree(out.pointer);
832
833 return retval;
834}
835
836/*
837 * WMI can have EmbeddedControl access regions. In which case, we just want to
838 * hand these off to the EC driver.
839 */
840static acpi_status
841acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
842 u32 bits, u64 *value,
843 void *handler_context, void *region_context)
844{
845 int result = 0, i = 0;
846 u8 temp = 0;
847
848 if ((address > 0xFF) || !value)
849 return AE_BAD_PARAMETER;
850
851 if (function != ACPI_READ && function != ACPI_WRITE)
852 return AE_BAD_PARAMETER;
853
854 if (bits != 8)
855 return AE_BAD_PARAMETER;
856
857 if (function == ACPI_READ) {
858 result = ec_read(address, &temp);
859 (*value) |= ((u64)temp) << i;
860 } else {
861 temp = 0xff & ((*value) >> i);
862 result = ec_write(address, temp);
863 }
864
865 switch (result) {
866 case -EINVAL:
867 return AE_BAD_PARAMETER;
868 break;
869 case -ENODEV:
870 return AE_NOT_FOUND;
871 break;
872 case -ETIME:
873 return AE_TIME;
874 break;
875 default:
876 return AE_OK;
877 }
878}
879
880static void acpi_wmi_notify(struct acpi_device *device, u32 event)
881{
882 struct guid_block *block;
883 struct wmi_block *wblock;
884 struct list_head *p;
885 char guid_string[37];
886
887 list_for_each(p, &wmi_block_list) {
888 wblock = list_entry(p, struct wmi_block, list);
889 block = &wblock->gblock;
890
891 if ((block->flags & ACPI_WMI_EVENT) &&
892 (block->notify_id == event)) {
893 if (wblock->handler)
894 wblock->handler(event, wblock->handler_data);
895 if (debug_event) {
896 wmi_gtoa(wblock->gblock.guid, guid_string);
897 pr_info("DEBUG Event GUID: %s\n", guid_string);
898 }
899
900 acpi_bus_generate_netlink_event(
901 device->pnp.device_class, dev_name(&device->dev),
902 event, 0);
903 break;
904 }
905 }
906}
907
908static int acpi_wmi_remove(struct acpi_device *device)
909{
910 acpi_remove_address_space_handler(device->handle,
911 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
912 wmi_free_devices();
913
914 return 0;
915}
916
917static int acpi_wmi_add(struct acpi_device *device)
918{
919 acpi_status status;
920 int error;
921
922 status = acpi_install_address_space_handler(device->handle,
923 ACPI_ADR_SPACE_EC,
924 &acpi_wmi_ec_space_handler,
925 NULL, NULL);
926 if (ACPI_FAILURE(status)) {
927 pr_err("Error installing EC region handler\n");
928 return -ENODEV;
929 }
930
931 error = parse_wdg(device->handle);
932 if (error) {
933 acpi_remove_address_space_handler(device->handle,
934 ACPI_ADR_SPACE_EC,
935 &acpi_wmi_ec_space_handler);
936 pr_err("Failed to parse WDG method\n");
937 return error;
938 }
939
940 return 0;
941}
942
943static int __init acpi_wmi_init(void)
944{
945 int error;
946
947 if (acpi_disabled)
948 return -ENODEV;
949
950 error = class_register(&wmi_class);
951 if (error)
952 return error;
953
954 error = acpi_bus_register_driver(&acpi_wmi_driver);
955 if (error) {
956 pr_err("Error loading mapper\n");
957 class_unregister(&wmi_class);
958 return error;
959 }
960
961 pr_info("Mapper loaded\n");
962 return 0;
963}
964
965static void __exit acpi_wmi_exit(void)
966{
967 acpi_bus_unregister_driver(&acpi_wmi_driver);
968 class_unregister(&wmi_class);
969
970 pr_info("Mapper unloaded\n");
971}
972
973subsys_initcall(acpi_wmi_init);
974module_exit(acpi_wmi_exit);