blob: eb391a2818330e9423f2030722a041eddedc9130 [file] [log] [blame]
Carlos Corbachobff431e2008-02-05 02:17:04 +00001/*
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
Dmitry Torokhov8e075142010-08-26 00:15:19 -070030#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
Carlos Corbachobff431e2008-02-05 02:17:04 +000032#include <linux/kernel.h>
33#include <linux/init.h>
34#include <linux/types.h>
Matthew Garrett1caab3c2009-11-04 14:17:53 -050035#include <linux/device.h>
Carlos Corbachobff431e2008-02-05 02:17:04 +000036#include <linux/list.h>
37#include <linux/acpi.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090038#include <linux/slab.h>
Paul Gortmaker7c52d552011-05-27 12:33:10 -040039#include <linux/module.h>
Carlos Corbachobff431e2008-02-05 02:17:04 +000040
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
Dmitry Torokhov762e1a22010-08-26 00:15:14 -070048static LIST_HEAD(wmi_block_list);
Carlos Corbachobff431e2008-02-05 02:17:04 +000049
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;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -070069 struct device dev;
Carlos Corbachobff431e2008-02-05 02:17:04 +000070};
71
Carlos Corbachobff431e2008-02-05 02:17:04 +000072
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
Rusty Russell90ab5ee2012-01-13 09:32:20 +103082static bool debug_event;
Thomas Renningerfc3155b2010-05-03 15:30:15 +020083module_param(debug_event, bool, 0444);
84MODULE_PARM_DESC(debug_event,
85 "Log WMI Events [0/1]");
86
Rusty Russell90ab5ee2012-01-13 09:32:20 +103087static bool debug_dump_wdg;
Thomas Renningera929aae2010-05-03 15:30:17 +020088module_param(debug_dump_wdg, bool, 0444);
89MODULE_PARM_DESC(debug_dump_wdg,
90 "Dump available WMI interfaces [0/1]");
91
Rafael J. Wysocki51fac832013-01-24 00:24:48 +010092static int acpi_wmi_remove(struct acpi_device *device);
Carlos Corbachobff431e2008-02-05 02:17:04 +000093static int acpi_wmi_add(struct acpi_device *device);
Bjorn Helgaasf61bb932009-04-07 15:37:37 +000094static void acpi_wmi_notify(struct acpi_device *device, u32 event);
Carlos Corbachobff431e2008-02-05 02:17:04 +000095
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,
Bjorn Helgaasf61bb932009-04-07 15:37:37 +0000110 .notify = acpi_wmi_notify,
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700111 },
Carlos Corbachobff431e2008-02-05 02:17:04 +0000112};
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{
Carlos Corbachobff431e2008-02-05 02:17:04 +0000129 int h;
Andy Shevchenko392bd8b2010-09-11 16:31:02 +0300130 int value;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000131
132 /* high part */
Andy Shevchenko392bd8b2010-09-11 16:31:02 +0300133 h = value = hex_to_bin(src[0]);
134 if (value < 0)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000135 return -1;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000136
137 /* low part */
Andy Shevchenko392bd8b2010-09-11 16:31:02 +0300138 value = hex_to_bin(src[1]);
139 if (value >= 0)
140 return (h << 4) | value;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000141 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
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700207 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000208 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;
Joe Perches097c27f2015-03-30 10:43:20 -0700214 return true;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000215 }
216 }
Joe Perches097c27f2015-03-30 10:43:20 -0700217 return false;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000218}
219
Matthew Garretta66bfa72008-10-08 21:40:32 +0100220static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
221{
222 struct guid_block *block = NULL;
223 char method[5];
Matthew Garretta66bfa72008-10-08 21:40:32 +0100224 acpi_status status;
225 acpi_handle handle;
226
227 block = &wblock->gblock;
228 handle = wblock->handle;
229
Matthew Garretta66bfa72008-10-08 21:40:32 +0100230 snprintf(method, 5, "WE%02X", block->notify_id);
Zhang Rui8122ab62013-09-03 08:31:57 +0800231 status = acpi_execute_simple_method(handle, method, enable);
Matthew Garretta66bfa72008-10-08 21:40:32 +0100232
233 if (status != AE_OK && status != AE_NOT_FOUND)
234 return status;
235 else
236 return AE_OK;
237}
238
Carlos Corbachobff431e2008-02-05 02:17:04 +0000239/*
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];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700261 char method[5] = "WM";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000262
263 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800264 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000265
266 block = &wblock->gblock;
267 handle = wblock->handle;
268
Al Viroe6bafba2008-02-13 04:03:25 +0000269 if (!(block->flags & ACPI_WMI_METHOD))
Carlos Corbachobff431e2008-02-05 02:17:04 +0000270 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;
Zhang Rui54f14c22013-09-03 08:32:07 +0800315 acpi_handle handle;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000316 acpi_status status, wc_status = AE_ERROR;
Zhang Rui8122ab62013-09-03 08:31:57 +0800317 struct acpi_object_list input;
318 union acpi_object wq_params[1];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700319 char method[5];
320 char wc_method[5] = "WC";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000321
322 if (!guid_string || !out)
323 return AE_BAD_PARAMETER;
324
325 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800326 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000327
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))
Lin Ming08237972008-08-08 11:57:11 +0800336 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000337
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) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000348 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 */
Zhang Rui54f14c22013-09-03 08:32:07 +0800355 if (acpi_has_method(handle, wc_method))
Zhang Rui8122ab62013-09-03 08:31:57 +0800356 wc_status = acpi_execute_simple_method(handle,
357 wc_method, 1);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000358 }
359
360 strcpy(method, "WQ");
361 strncat(method, block->object_id, 2);
362
Carlos Corbachodab36ad2008-08-02 17:28:45 +0100363 status = acpi_evaluate_object(handle, method, &input, out);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000364
365 /*
366 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
367 * the WQxx method failed - we should disable collection anyway.
368 */
Carlos Corbachoa527f2d2008-02-24 13:34:34 +0000369 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
Zhang Rui8122ab62013-09-03 08:31:57 +0800370 status = acpi_execute_simple_method(handle, wc_method, 0);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000371 }
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];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700393 char method[5] = "WS";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000394
395 if (!guid_string || !in)
396 return AE_BAD_DATA;
397
398 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800399 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000400
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))
Lin Ming08237972008-08-08 11:57:11 +0800409 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000410
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
Dmitry Torokhov37830662010-08-26 00:15:09 -0700430static void wmi_dump_wdg(const struct guid_block *g)
Thomas Renningera929aae2010-05-03 15:30:17 +0200431{
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200432 pr_info("%pUL:\n", g->guid);
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700433 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);
Joe Perchesdd8e9082011-03-29 15:21:53 -0700437 pr_info("\tflags: %#x", g->flags);
Thomas Renningera929aae2010-05-03 15:30:17 +0200438 if (g->flags) {
Thomas Renningera929aae2010-05-03 15:30:17 +0200439 if (g->flags & ACPI_WMI_EXPENSIVE)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700440 pr_cont(" ACPI_WMI_EXPENSIVE");
Thomas Renningera929aae2010-05-03 15:30:17 +0200441 if (g->flags & ACPI_WMI_METHOD)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700442 pr_cont(" ACPI_WMI_METHOD");
Thomas Renningera929aae2010-05-03 15:30:17 +0200443 if (g->flags & ACPI_WMI_STRING)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700444 pr_cont(" ACPI_WMI_STRING");
Thomas Renningera929aae2010-05-03 15:30:17 +0200445 if (g->flags & ACPI_WMI_EVENT)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700446 pr_cont(" ACPI_WMI_EVENT");
Thomas Renningera929aae2010-05-03 15:30:17 +0200447 }
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700448 pr_cont("\n");
Thomas Renningera929aae2010-05-03 15:30:17 +0200449
450}
451
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200452static void wmi_notify_debug(u32 value, void *context)
453{
454 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
455 union acpi_object *obj;
Axel Lin1492616a2010-06-28 09:30:45 +0800456 acpi_status status;
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200457
Axel Lin1492616a2010-06-28 09:30:45 +0800458 status = wmi_get_event_data(value, &response);
459 if (status != AE_OK) {
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700460 pr_info("bad event status 0x%x\n", status);
Axel Lin1492616a2010-06-28 09:30:45 +0800461 return;
462 }
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200463
464 obj = (union acpi_object *)response.pointer;
465
466 if (!obj)
467 return;
468
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700469 pr_info("DEBUG Event ");
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200470 switch(obj->type) {
471 case ACPI_TYPE_BUFFER:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700472 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200473 break;
474 case ACPI_TYPE_STRING:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700475 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200476 break;
477 case ACPI_TYPE_INTEGER:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700478 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200479 break;
480 case ACPI_TYPE_PACKAGE:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700481 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200482 break;
483 default:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700484 pr_cont("object type 0x%X\n", obj->type);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200485 }
Axel Lin1492616a2010-06-28 09:30:45 +0800486 kfree(obj);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200487}
488
Carlos Corbachobff431e2008-02-05 02:17:04 +0000489/**
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;
Colin King58f64252010-11-19 15:40:02 +0000500 acpi_status status = AE_NOT_EXIST;
501 char tmp[16], guid_input[16];
502 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000503
504 if (!guid || !handler)
505 return AE_BAD_PARAMETER;
506
Colin King58f64252010-11-19 15:40:02 +0000507 wmi_parse_guid(guid, tmp);
508 wmi_swap_bytes(tmp, guid_input);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000509
Colin King58f64252010-11-19 15:40:02 +0000510 list_for_each(p, &wmi_block_list) {
511 acpi_status wmi_status;
512 block = list_entry(p, struct wmi_block, list);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000513
Colin King58f64252010-11-19 15:40:02 +0000514 if (memcmp(block->gblock.guid, guid_input, 16) == 0) {
515 if (block->handler &&
516 block->handler != wmi_notify_debug)
517 return AE_ALREADY_ACQUIRED;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000518
Colin King58f64252010-11-19 15:40:02 +0000519 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 }
Matthew Garretta66bfa72008-10-08 21:40:32 +0100528
529 return status;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000530}
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;
Colin King58f64252010-11-19 15:40:02 +0000541 acpi_status status = AE_NOT_EXIST;
542 char tmp[16], guid_input[16];
543 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000544
545 if (!guid)
546 return AE_BAD_PARAMETER;
547
Colin King58f64252010-11-19 15:40:02 +0000548 wmi_parse_guid(guid, tmp);
549 wmi_swap_bytes(tmp, guid_input);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000550
Colin King58f64252010-11-19 15:40:02 +0000551 list_for_each(p, &wmi_block_list) {
552 acpi_status wmi_status;
553 block = list_entry(p, struct wmi_block, list);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000554
Colin King58f64252010-11-19 15:40:02 +0000555 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 }
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200573 }
Colin King58f64252010-11-19 15:40:02 +0000574
Matthew Garretta66bfa72008-10-08 21:40:32 +0100575 return status;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000576}
577EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
578
579/**
580 * wmi_get_event_data - Get WMI data associated with an event
581 *
Anisse Astier3e9b9882009-12-04 10:10:09 +0100582 * @event: Event to find
583 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
Carlos Corbachobff431e2008-02-05 02:17:04 +0000584 *
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
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700600 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000601 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/*
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500627 * sysfs interface
628 */
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700629static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500630 char *buf)
631{
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500632 struct wmi_block *wblock;
633
634 wblock = dev_get_drvdata(dev);
Prarit Bhargavaa80e1052013-10-03 19:23:36 -0400635 if (!wblock) {
636 strcat(buf, "\n");
637 return strlen(buf);
638 }
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500639
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200640 return sprintf(buf, "wmi:%pUL\n", wblock->gblock.guid);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500641}
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700642static DEVICE_ATTR_RO(modalias);
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700643
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700644static struct attribute *wmi_attrs[] = {
645 &dev_attr_modalias.attr,
646 NULL,
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700647};
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700648ATTRIBUTE_GROUPS(wmi);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500649
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
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200663 sprintf(guid_string, "%pUL", wblock->gblock.guid);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500664
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{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700674 struct wmi_block *wmi_block = container_of(dev, struct wmi_block, dev);
675
676 kfree(wmi_block);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500677}
678
679static struct class wmi_class = {
680 .name = "wmi",
681 .dev_release = wmi_dev_free,
682 .dev_uevent = wmi_dev_uevent,
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700683 .dev_groups = wmi_groups,
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500684};
685
Colin King58f64252010-11-19 15:40:02 +0000686static int wmi_create_device(const struct guid_block *gblock,
687 struct wmi_block *wblock, acpi_handle handle)
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500688{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700689 wblock->dev.class = &wmi_class;
690
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200691 dev_set_name(&wblock->dev, "%pUL", gblock->guid);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700692
693 dev_set_drvdata(&wblock->dev, wblock);
694
Colin King58f64252010-11-19 15:40:02 +0000695 return device_register(&wblock->dev);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500696}
697
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700698static void wmi_free_devices(void)
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500699{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700700 struct wmi_block *wblock, *next;
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500701
702 /* Delete devices for all the GUIDs */
Dmitry Torokhov023b9562011-09-07 15:00:02 -0700703 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
704 list_del(&wblock->list);
Colin King58f64252010-11-19 15:40:02 +0000705 if (wblock->dev.class)
706 device_unregister(&wblock->dev);
Dmitry Torokhov023b9562011-09-07 15:00:02 -0700707 else
708 kfree(wblock);
709 }
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500710}
711
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000712static bool guid_already_parsed(const char *guid_string)
713{
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000714 struct wmi_block *wblock;
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000715
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700716 list_for_each_entry(wblock, &wmi_block_list, list)
Thadeu Lima de Souza Cascardo8b14d7b2010-11-28 19:46:50 -0200717 if (memcmp(wblock->gblock.guid, guid_string, 16) == 0)
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000718 return true;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700719
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000720 return false;
721}
722
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500723/*
Carlos Corbachobff431e2008-02-05 02:17:04 +0000724 * Parse the _WDG method for the GUID data blocks
725 */
Dan Carpenter0a018a62013-08-14 12:02:30 +0300726static int parse_wdg(acpi_handle handle)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000727{
728 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
729 union acpi_object *obj;
Dmitry Torokhov37830662010-08-26 00:15:09 -0700730 const struct guid_block *gblock;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000731 struct wmi_block *wblock;
732 acpi_status status;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700733 int retval;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000734 u32 i, total;
735
736 status = acpi_evaluate_object(handle, "_WDG", NULL, &out);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000737 if (ACPI_FAILURE(status))
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700738 return -ENXIO;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000739
740 obj = (union acpi_object *) out.pointer;
Dmitry Torokhov3d2c63e2010-08-26 00:15:03 -0700741 if (!obj)
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700742 return -ENXIO;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000743
Dmitry Torokhov64ed0ab2010-08-26 00:14:58 -0700744 if (obj->type != ACPI_TYPE_BUFFER) {
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700745 retval = -ENXIO;
Dmitry Torokhov64ed0ab2010-08-26 00:14:58 -0700746 goto out_free_pointer;
747 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000748
Dmitry Torokhov37830662010-08-26 00:15:09 -0700749 gblock = (const struct guid_block *)obj->buffer.pointer;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000750 total = obj->buffer.length / sizeof(struct guid_block);
751
Carlos Corbachobff431e2008-02-05 02:17:04 +0000752 for (i = 0; i < total; i++) {
Thomas Renningera929aae2010-05-03 15:30:17 +0200753 if (debug_dump_wdg)
754 wmi_dump_wdg(&gblock[i]);
755
Colin King58f64252010-11-19 15:40:02 +0000756 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
757 if (!wblock)
Dan Carpenter0a018a62013-08-14 12:02:30 +0300758 return -ENOMEM;
Colin King58f64252010-11-19 15:40:02 +0000759
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();
Dan Carpentere1e0dac2010-12-06 16:44:23 -0500773 goto out_free_pointer;
Colin King58f64252010-11-19 15:40:02 +0000774 }
Axel Lina5167c52010-06-03 11:45:45 +0800775 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000776
Colin King58f64252010-11-19 15:40:02 +0000777 list_add_tail(&wblock->list, &wmi_block_list);
778
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200779 if (debug_event) {
780 wblock->handler = wmi_notify_debug;
Dmitry Torokhov2d5ab552010-08-26 00:14:48 -0700781 wmi_method_enable(wblock, 1);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200782 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000783 }
784
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700785 retval = 0;
786
Axel Lina5167c52010-06-03 11:45:45 +0800787out_free_pointer:
788 kfree(out.pointer);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000789
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700790 return retval;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000791}
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,
Lin Ming439913f2010-01-28 10:53:19 +0800799 u32 bits, u64 *value,
Carlos Corbachobff431e2008-02-05 02:17:04 +0000800 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);
Lin Ming439913f2010-01-28 10:53:19 +0800816 (*value) |= ((u64)temp) << i;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000817 } 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
Bjorn Helgaasf61bb932009-04-07 15:37:37 +0000837static void acpi_wmi_notify(struct acpi_device *device, u32 event)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000838{
839 struct guid_block *block;
840 struct wmi_block *wblock;
841 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000842
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700843 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000844 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);
Thomas Renninger7715348c2010-05-03 15:30:16 +0200851 if (debug_event) {
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200852 pr_info("DEBUG Event GUID: %pUL\n",
853 wblock->gblock.guid);
Thomas Renninger7715348c2010-05-03 15:30:16 +0200854 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000855
856 acpi_bus_generate_netlink_event(
Kay Sievers07944692008-10-30 01:18:59 +0100857 device->pnp.device_class, dev_name(&device->dev),
Carlos Corbachobff431e2008-02-05 02:17:04 +0000858 event, 0);
859 break;
860 }
861 }
862}
863
Rafael J. Wysocki51fac832013-01-24 00:24:48 +0100864static int acpi_wmi_remove(struct acpi_device *device)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000865{
Carlos Corbachobff431e2008-02-05 02:17:04 +0000866 acpi_remove_address_space_handler(device->handle,
867 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700868 wmi_free_devices();
Carlos Corbachobff431e2008-02-05 02:17:04 +0000869
870 return 0;
871}
872
Thomas Renninger925b1082010-07-16 13:11:36 +0200873static int acpi_wmi_add(struct acpi_device *device)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000874{
875 acpi_status status;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700876 int error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000877
Carlos Corbachobff431e2008-02-05 02:17:04 +0000878 status = acpi_install_address_space_handler(device->handle,
879 ACPI_ADR_SPACE_EC,
880 &acpi_wmi_ec_space_handler,
881 NULL, NULL);
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700882 if (ACPI_FAILURE(status)) {
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700883 pr_err("Error installing EC region handler\n");
Carlos Corbachobff431e2008-02-05 02:17:04 +0000884 return -ENODEV;
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700885 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000886
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700887 error = parse_wdg(device->handle);
888 if (error) {
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700889 acpi_remove_address_space_handler(device->handle,
890 ACPI_ADR_SPACE_EC,
891 &acpi_wmi_ec_space_handler);
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700892 pr_err("Failed to parse WDG method\n");
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700893 return error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000894 }
895
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700896 return 0;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000897}
898
899static int __init acpi_wmi_init(void)
900{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700901 int error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000902
903 if (acpi_disabled)
904 return -ENODEV;
905
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700906 error = class_register(&wmi_class);
907 if (error)
908 return error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000909
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700910 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;
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500915 }
916
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700917 pr_info("Mapper loaded\n");
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700918 return 0;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000919}
920
921static void __exit acpi_wmi_exit(void)
922{
Carlos Corbachobff431e2008-02-05 02:17:04 +0000923 acpi_bus_unregister_driver(&acpi_wmi_driver);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700924 class_unregister(&wmi_class);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000925
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700926 pr_info("Mapper unloaded\n");
Carlos Corbachobff431e2008-02-05 02:17:04 +0000927}
928
929subsys_initcall(acpi_wmi_init);
930module_exit(acpi_wmi_exit);