blob: ceeb8c188ef33566e67a6603dfd8f75d5e440de9 [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>
Andy Shevchenko538d7eb2016-05-20 17:01:30 -070040#include <linux/uuid.h>
Carlos Corbachobff431e2008-02-05 02:17:04 +000041
42ACPI_MODULE_NAME("wmi");
43MODULE_AUTHOR("Carlos Corbacho");
44MODULE_DESCRIPTION("ACPI-WMI Mapping Driver");
45MODULE_LICENSE("GPL");
46
47#define ACPI_WMI_CLASS "wmi"
48
Dmitry Torokhov762e1a22010-08-26 00:15:14 -070049static LIST_HEAD(wmi_block_list);
Carlos Corbachobff431e2008-02-05 02:17:04 +000050
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;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -070070 struct device dev;
Carlos Corbachobff431e2008-02-05 02:17:04 +000071};
72
Carlos Corbachobff431e2008-02-05 02:17:04 +000073
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
Rusty Russell90ab5ee2012-01-13 09:32:20 +103083static bool debug_event;
Thomas Renningerfc3155b2010-05-03 15:30:15 +020084module_param(debug_event, bool, 0444);
85MODULE_PARM_DESC(debug_event,
86 "Log WMI Events [0/1]");
87
Rusty Russell90ab5ee2012-01-13 09:32:20 +103088static bool debug_dump_wdg;
Thomas Renningera929aae2010-05-03 15:30:17 +020089module_param(debug_dump_wdg, bool, 0444);
90MODULE_PARM_DESC(debug_dump_wdg,
91 "Dump available WMI interfaces [0/1]");
92
Rafael J. Wysocki51fac832013-01-24 00:24:48 +010093static int acpi_wmi_remove(struct acpi_device *device);
Carlos Corbachobff431e2008-02-05 02:17:04 +000094static int acpi_wmi_add(struct acpi_device *device);
Bjorn Helgaasf61bb932009-04-07 15:37:37 +000095static void acpi_wmi_notify(struct acpi_device *device, u32 event);
Carlos Corbachobff431e2008-02-05 02:17:04 +000096
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,
Bjorn Helgaasf61bb932009-04-07 15:37:37 +0000111 .notify = acpi_wmi_notify,
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700112 },
Carlos Corbachobff431e2008-02-05 02:17:04 +0000113};
114
115/*
116 * GUID parsing functions
117 */
118
Carlos Corbachobff431e2008-02-05 02:17:04 +0000119static bool find_guid(const char *guid_string, struct wmi_block **out)
120{
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700121 uuid_le guid_input;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000122 struct wmi_block *wblock;
123 struct guid_block *block;
124 struct list_head *p;
125
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700126 if (uuid_le_to_bin(guid_string, &guid_input))
127 return false;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000128
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700129 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000130 wblock = list_entry(p, struct wmi_block, list);
131 block = &wblock->gblock;
132
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700133 if (memcmp(block->guid, &guid_input, 16) == 0) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000134 if (out)
135 *out = wblock;
Joe Perches097c27f2015-03-30 10:43:20 -0700136 return true;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000137 }
138 }
Joe Perches097c27f2015-03-30 10:43:20 -0700139 return false;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000140}
141
Matthew Garretta66bfa72008-10-08 21:40:32 +0100142static acpi_status wmi_method_enable(struct wmi_block *wblock, int enable)
143{
144 struct guid_block *block = NULL;
145 char method[5];
Matthew Garretta66bfa72008-10-08 21:40:32 +0100146 acpi_status status;
147 acpi_handle handle;
148
149 block = &wblock->gblock;
150 handle = wblock->handle;
151
Matthew Garretta66bfa72008-10-08 21:40:32 +0100152 snprintf(method, 5, "WE%02X", block->notify_id);
Zhang Rui8122ab62013-09-03 08:31:57 +0800153 status = acpi_execute_simple_method(handle, method, enable);
Matthew Garretta66bfa72008-10-08 21:40:32 +0100154
155 if (status != AE_OK && status != AE_NOT_FOUND)
156 return status;
157 else
158 return AE_OK;
159}
160
Carlos Corbachobff431e2008-02-05 02:17:04 +0000161/*
162 * Exported WMI functions
163 */
164/**
165 * wmi_evaluate_method - Evaluate a WMI method
166 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
167 * @instance: Instance index
168 * @method_id: Method ID to call
169 * &in: Buffer containing input for the method call
170 * &out: Empty buffer to return the method results
171 *
172 * Call an ACPI-WMI method
173 */
174acpi_status wmi_evaluate_method(const char *guid_string, u8 instance,
175u32 method_id, const struct acpi_buffer *in, struct acpi_buffer *out)
176{
177 struct guid_block *block = NULL;
178 struct wmi_block *wblock = NULL;
179 acpi_handle handle;
180 acpi_status status;
181 struct acpi_object_list input;
182 union acpi_object params[3];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700183 char method[5] = "WM";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000184
185 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800186 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000187
188 block = &wblock->gblock;
189 handle = wblock->handle;
190
Al Viroe6bafba2008-02-13 04:03:25 +0000191 if (!(block->flags & ACPI_WMI_METHOD))
Carlos Corbachobff431e2008-02-05 02:17:04 +0000192 return AE_BAD_DATA;
193
194 if (block->instance_count < instance)
195 return AE_BAD_PARAMETER;
196
197 input.count = 2;
198 input.pointer = params;
199 params[0].type = ACPI_TYPE_INTEGER;
200 params[0].integer.value = instance;
201 params[1].type = ACPI_TYPE_INTEGER;
202 params[1].integer.value = method_id;
203
204 if (in) {
205 input.count = 3;
206
207 if (block->flags & ACPI_WMI_STRING) {
208 params[2].type = ACPI_TYPE_STRING;
209 } else {
210 params[2].type = ACPI_TYPE_BUFFER;
211 }
212 params[2].buffer.length = in->length;
213 params[2].buffer.pointer = in->pointer;
214 }
215
216 strncat(method, block->object_id, 2);
217
218 status = acpi_evaluate_object(handle, method, &input, out);
219
220 return status;
221}
222EXPORT_SYMBOL_GPL(wmi_evaluate_method);
223
224/**
225 * wmi_query_block - Return contents of a WMI block
226 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
227 * @instance: Instance index
228 * &out: Empty buffer to return the contents of the data block to
229 *
230 * Return the contents of an ACPI-WMI data block to a buffer
231 */
232acpi_status wmi_query_block(const char *guid_string, u8 instance,
233struct acpi_buffer *out)
234{
235 struct guid_block *block = NULL;
236 struct wmi_block *wblock = NULL;
Zhang Rui54f14c22013-09-03 08:32:07 +0800237 acpi_handle handle;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000238 acpi_status status, wc_status = AE_ERROR;
Zhang Rui8122ab62013-09-03 08:31:57 +0800239 struct acpi_object_list input;
240 union acpi_object wq_params[1];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700241 char method[5];
242 char wc_method[5] = "WC";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000243
244 if (!guid_string || !out)
245 return AE_BAD_PARAMETER;
246
247 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800248 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000249
250 block = &wblock->gblock;
251 handle = wblock->handle;
252
253 if (block->instance_count < instance)
254 return AE_BAD_PARAMETER;
255
256 /* Check GUID is a data block */
257 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
Lin Ming08237972008-08-08 11:57:11 +0800258 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000259
260 input.count = 1;
261 input.pointer = wq_params;
262 wq_params[0].type = ACPI_TYPE_INTEGER;
263 wq_params[0].integer.value = instance;
264
265 /*
266 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method first to
267 * enable collection.
268 */
269 if (block->flags & ACPI_WMI_EXPENSIVE) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000270 strncat(wc_method, block->object_id, 2);
271
272 /*
273 * Some GUIDs break the specification by declaring themselves
274 * expensive, but have no corresponding WCxx method. So we
275 * should not fail if this happens.
276 */
Zhang Rui54f14c22013-09-03 08:32:07 +0800277 if (acpi_has_method(handle, wc_method))
Zhang Rui8122ab62013-09-03 08:31:57 +0800278 wc_status = acpi_execute_simple_method(handle,
279 wc_method, 1);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000280 }
281
282 strcpy(method, "WQ");
283 strncat(method, block->object_id, 2);
284
Carlos Corbachodab36ad2008-08-02 17:28:45 +0100285 status = acpi_evaluate_object(handle, method, &input, out);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000286
287 /*
288 * If ACPI_WMI_EXPENSIVE, call the relevant WCxx method, even if
289 * the WQxx method failed - we should disable collection anyway.
290 */
Carlos Corbachoa527f2d2008-02-24 13:34:34 +0000291 if ((block->flags & ACPI_WMI_EXPENSIVE) && ACPI_SUCCESS(wc_status)) {
Zhang Rui8122ab62013-09-03 08:31:57 +0800292 status = acpi_execute_simple_method(handle, wc_method, 0);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000293 }
294
295 return status;
296}
297EXPORT_SYMBOL_GPL(wmi_query_block);
298
299/**
300 * wmi_set_block - Write to a WMI block
301 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
302 * @instance: Instance index
303 * &in: Buffer containing new values for the data block
304 *
305 * Write the contents of the input buffer to an ACPI-WMI data block
306 */
307acpi_status wmi_set_block(const char *guid_string, u8 instance,
308const struct acpi_buffer *in)
309{
310 struct guid_block *block = NULL;
311 struct wmi_block *wblock = NULL;
312 acpi_handle handle;
313 struct acpi_object_list input;
314 union acpi_object params[2];
Costantino Leandrof3d83e22009-08-26 14:29:28 -0700315 char method[5] = "WS";
Carlos Corbachobff431e2008-02-05 02:17:04 +0000316
317 if (!guid_string || !in)
318 return AE_BAD_DATA;
319
320 if (!find_guid(guid_string, &wblock))
Lin Ming08237972008-08-08 11:57:11 +0800321 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000322
323 block = &wblock->gblock;
324 handle = wblock->handle;
325
326 if (block->instance_count < instance)
327 return AE_BAD_PARAMETER;
328
329 /* Check GUID is a data block */
330 if (block->flags & (ACPI_WMI_EVENT | ACPI_WMI_METHOD))
Lin Ming08237972008-08-08 11:57:11 +0800331 return AE_ERROR;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000332
333 input.count = 2;
334 input.pointer = params;
335 params[0].type = ACPI_TYPE_INTEGER;
336 params[0].integer.value = instance;
337
338 if (block->flags & ACPI_WMI_STRING) {
339 params[1].type = ACPI_TYPE_STRING;
340 } else {
341 params[1].type = ACPI_TYPE_BUFFER;
342 }
343 params[1].buffer.length = in->length;
344 params[1].buffer.pointer = in->pointer;
345
346 strncat(method, block->object_id, 2);
347
348 return acpi_evaluate_object(handle, method, &input, NULL);
349}
350EXPORT_SYMBOL_GPL(wmi_set_block);
351
Dmitry Torokhov37830662010-08-26 00:15:09 -0700352static void wmi_dump_wdg(const struct guid_block *g)
Thomas Renningera929aae2010-05-03 15:30:17 +0200353{
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200354 pr_info("%pUL:\n", g->guid);
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700355 pr_info("\tobject_id: %c%c\n", g->object_id[0], g->object_id[1]);
356 pr_info("\tnotify_id: %02X\n", g->notify_id);
357 pr_info("\treserved: %02X\n", g->reserved);
358 pr_info("\tinstance_count: %d\n", g->instance_count);
Joe Perchesdd8e9082011-03-29 15:21:53 -0700359 pr_info("\tflags: %#x", g->flags);
Thomas Renningera929aae2010-05-03 15:30:17 +0200360 if (g->flags) {
Thomas Renningera929aae2010-05-03 15:30:17 +0200361 if (g->flags & ACPI_WMI_EXPENSIVE)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700362 pr_cont(" ACPI_WMI_EXPENSIVE");
Thomas Renningera929aae2010-05-03 15:30:17 +0200363 if (g->flags & ACPI_WMI_METHOD)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700364 pr_cont(" ACPI_WMI_METHOD");
Thomas Renningera929aae2010-05-03 15:30:17 +0200365 if (g->flags & ACPI_WMI_STRING)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700366 pr_cont(" ACPI_WMI_STRING");
Thomas Renningera929aae2010-05-03 15:30:17 +0200367 if (g->flags & ACPI_WMI_EVENT)
Joe Perchesdd8e9082011-03-29 15:21:53 -0700368 pr_cont(" ACPI_WMI_EVENT");
Thomas Renningera929aae2010-05-03 15:30:17 +0200369 }
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700370 pr_cont("\n");
Thomas Renningera929aae2010-05-03 15:30:17 +0200371
372}
373
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200374static void wmi_notify_debug(u32 value, void *context)
375{
376 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
377 union acpi_object *obj;
Axel Lin1492616a2010-06-28 09:30:45 +0800378 acpi_status status;
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200379
Axel Lin1492616a2010-06-28 09:30:45 +0800380 status = wmi_get_event_data(value, &response);
381 if (status != AE_OK) {
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700382 pr_info("bad event status 0x%x\n", status);
Axel Lin1492616a2010-06-28 09:30:45 +0800383 return;
384 }
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200385
386 obj = (union acpi_object *)response.pointer;
387
388 if (!obj)
389 return;
390
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700391 pr_info("DEBUG Event ");
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200392 switch(obj->type) {
393 case ACPI_TYPE_BUFFER:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700394 pr_cont("BUFFER_TYPE - length %d\n", obj->buffer.length);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200395 break;
396 case ACPI_TYPE_STRING:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700397 pr_cont("STRING_TYPE - %s\n", obj->string.pointer);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200398 break;
399 case ACPI_TYPE_INTEGER:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700400 pr_cont("INTEGER_TYPE - %llu\n", obj->integer.value);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200401 break;
402 case ACPI_TYPE_PACKAGE:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700403 pr_cont("PACKAGE_TYPE - %d elements\n", obj->package.count);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200404 break;
405 default:
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700406 pr_cont("object type 0x%X\n", obj->type);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200407 }
Axel Lin1492616a2010-06-28 09:30:45 +0800408 kfree(obj);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200409}
410
Carlos Corbachobff431e2008-02-05 02:17:04 +0000411/**
412 * wmi_install_notify_handler - Register handler for WMI events
413 * @handler: Function to handle notifications
414 * @data: Data to be returned to handler when event is fired
415 *
416 * Register a handler for events sent to the ACPI-WMI mapper device.
417 */
418acpi_status wmi_install_notify_handler(const char *guid,
419wmi_notify_handler handler, void *data)
420{
421 struct wmi_block *block;
Colin King58f64252010-11-19 15:40:02 +0000422 acpi_status status = AE_NOT_EXIST;
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700423 uuid_le guid_input;
Colin King58f64252010-11-19 15:40:02 +0000424 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000425
426 if (!guid || !handler)
427 return AE_BAD_PARAMETER;
428
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700429 if (uuid_le_to_bin(guid, &guid_input))
430 return AE_BAD_PARAMETER;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000431
Colin King58f64252010-11-19 15:40:02 +0000432 list_for_each(p, &wmi_block_list) {
433 acpi_status wmi_status;
434 block = list_entry(p, struct wmi_block, list);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000435
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700436 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
Colin King58f64252010-11-19 15:40:02 +0000437 if (block->handler &&
438 block->handler != wmi_notify_debug)
439 return AE_ALREADY_ACQUIRED;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000440
Colin King58f64252010-11-19 15:40:02 +0000441 block->handler = handler;
442 block->handler_data = data;
443
444 wmi_status = wmi_method_enable(block, 1);
445 if ((wmi_status != AE_OK) ||
446 ((wmi_status == AE_OK) && (status == AE_NOT_EXIST)))
447 status = wmi_status;
448 }
449 }
Matthew Garretta66bfa72008-10-08 21:40:32 +0100450
451 return status;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000452}
453EXPORT_SYMBOL_GPL(wmi_install_notify_handler);
454
455/**
456 * wmi_uninstall_notify_handler - Unregister handler for WMI events
457 *
458 * Unregister handler for events sent to the ACPI-WMI mapper device.
459 */
460acpi_status wmi_remove_notify_handler(const char *guid)
461{
462 struct wmi_block *block;
Colin King58f64252010-11-19 15:40:02 +0000463 acpi_status status = AE_NOT_EXIST;
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700464 uuid_le guid_input;
Colin King58f64252010-11-19 15:40:02 +0000465 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000466
467 if (!guid)
468 return AE_BAD_PARAMETER;
469
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700470 if (uuid_le_to_bin(guid, &guid_input))
471 return AE_BAD_PARAMETER;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000472
Colin King58f64252010-11-19 15:40:02 +0000473 list_for_each(p, &wmi_block_list) {
474 acpi_status wmi_status;
475 block = list_entry(p, struct wmi_block, list);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000476
Andy Shevchenko538d7eb2016-05-20 17:01:30 -0700477 if (memcmp(block->gblock.guid, &guid_input, 16) == 0) {
Colin King58f64252010-11-19 15:40:02 +0000478 if (!block->handler ||
479 block->handler == wmi_notify_debug)
480 return AE_NULL_ENTRY;
481
482 if (debug_event) {
483 block->handler = wmi_notify_debug;
484 status = AE_OK;
485 } else {
486 wmi_status = wmi_method_enable(block, 0);
487 block->handler = NULL;
488 block->handler_data = NULL;
489 if ((wmi_status != AE_OK) ||
490 ((wmi_status == AE_OK) &&
491 (status == AE_NOT_EXIST)))
492 status = wmi_status;
493 }
494 }
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200495 }
Colin King58f64252010-11-19 15:40:02 +0000496
Matthew Garretta66bfa72008-10-08 21:40:32 +0100497 return status;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000498}
499EXPORT_SYMBOL_GPL(wmi_remove_notify_handler);
500
501/**
502 * wmi_get_event_data - Get WMI data associated with an event
503 *
Anisse Astier3e9b9882009-12-04 10:10:09 +0100504 * @event: Event to find
505 * @out: Buffer to hold event data. out->pointer should be freed with kfree()
Carlos Corbachobff431e2008-02-05 02:17:04 +0000506 *
507 * Returns extra data associated with an event in WMI.
508 */
509acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out)
510{
511 struct acpi_object_list input;
512 union acpi_object params[1];
513 struct guid_block *gblock;
514 struct wmi_block *wblock;
515 struct list_head *p;
516
517 input.count = 1;
518 input.pointer = params;
519 params[0].type = ACPI_TYPE_INTEGER;
520 params[0].integer.value = event;
521
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700522 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000523 wblock = list_entry(p, struct wmi_block, list);
524 gblock = &wblock->gblock;
525
526 if ((gblock->flags & ACPI_WMI_EVENT) &&
527 (gblock->notify_id == event))
528 return acpi_evaluate_object(wblock->handle, "_WED",
529 &input, out);
530 }
531
532 return AE_NOT_FOUND;
533}
534EXPORT_SYMBOL_GPL(wmi_get_event_data);
535
536/**
537 * wmi_has_guid - Check if a GUID is available
538 * @guid_string: 36 char string of the form fa50ff2b-f2e8-45de-83fa-65417f2f49ba
539 *
540 * Check if a given GUID is defined by _WDG
541 */
542bool wmi_has_guid(const char *guid_string)
543{
544 return find_guid(guid_string, NULL);
545}
546EXPORT_SYMBOL_GPL(wmi_has_guid);
547
548/*
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500549 * sysfs interface
550 */
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700551static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500552 char *buf)
553{
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500554 struct wmi_block *wblock;
555
556 wblock = dev_get_drvdata(dev);
Prarit Bhargavaa80e1052013-10-03 19:23:36 -0400557 if (!wblock) {
558 strcat(buf, "\n");
559 return strlen(buf);
560 }
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500561
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200562 return sprintf(buf, "wmi:%pUL\n", wblock->gblock.guid);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500563}
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700564static DEVICE_ATTR_RO(modalias);
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700565
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700566static struct attribute *wmi_attrs[] = {
567 &dev_attr_modalias.attr,
568 NULL,
Dmitry Torokhov614ef432010-08-26 00:15:25 -0700569};
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700570ATTRIBUTE_GROUPS(wmi);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500571
572static int wmi_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
573{
574 char guid_string[37];
575
576 struct wmi_block *wblock;
577
578 if (add_uevent_var(env, "MODALIAS="))
579 return -ENOMEM;
580
581 wblock = dev_get_drvdata(dev);
582 if (!wblock)
583 return -ENOMEM;
584
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200585 sprintf(guid_string, "%pUL", wblock->gblock.guid);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500586
587 strcpy(&env->buf[env->buflen - 1], "wmi:");
588 memcpy(&env->buf[env->buflen - 1 + 4], guid_string, 36);
589 env->buflen += 40;
590
591 return 0;
592}
593
594static void wmi_dev_free(struct device *dev)
595{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700596 struct wmi_block *wmi_block = container_of(dev, struct wmi_block, dev);
597
598 kfree(wmi_block);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500599}
600
601static struct class wmi_class = {
602 .name = "wmi",
603 .dev_release = wmi_dev_free,
604 .dev_uevent = wmi_dev_uevent,
Greg Kroah-Hartmane80b89a2013-07-24 15:05:18 -0700605 .dev_groups = wmi_groups,
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500606};
607
Colin King58f64252010-11-19 15:40:02 +0000608static int wmi_create_device(const struct guid_block *gblock,
609 struct wmi_block *wblock, acpi_handle handle)
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500610{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700611 wblock->dev.class = &wmi_class;
612
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200613 dev_set_name(&wblock->dev, "%pUL", gblock->guid);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700614
615 dev_set_drvdata(&wblock->dev, wblock);
616
Colin King58f64252010-11-19 15:40:02 +0000617 return device_register(&wblock->dev);
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500618}
619
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700620static void wmi_free_devices(void)
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500621{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700622 struct wmi_block *wblock, *next;
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500623
624 /* Delete devices for all the GUIDs */
Dmitry Torokhov023b9562011-09-07 15:00:02 -0700625 list_for_each_entry_safe(wblock, next, &wmi_block_list, list) {
626 list_del(&wblock->list);
Colin King58f64252010-11-19 15:40:02 +0000627 if (wblock->dev.class)
628 device_unregister(&wblock->dev);
Dmitry Torokhov023b9562011-09-07 15:00:02 -0700629 else
630 kfree(wblock);
631 }
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500632}
633
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000634static bool guid_already_parsed(const char *guid_string)
635{
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000636 struct wmi_block *wblock;
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000637
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700638 list_for_each_entry(wblock, &wmi_block_list, list)
Thadeu Lima de Souza Cascardo8b14d7b2010-11-28 19:46:50 -0200639 if (memcmp(wblock->gblock.guid, guid_string, 16) == 0)
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000640 return true;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700641
Carlos Corbachod1f9e492009-12-26 19:14:59 +0000642 return false;
643}
644
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500645/*
Carlos Corbachobff431e2008-02-05 02:17:04 +0000646 * Parse the _WDG method for the GUID data blocks
647 */
Dan Carpenter0a018a62013-08-14 12:02:30 +0300648static int parse_wdg(acpi_handle handle)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000649{
650 struct acpi_buffer out = {ACPI_ALLOCATE_BUFFER, NULL};
651 union acpi_object *obj;
Dmitry Torokhov37830662010-08-26 00:15:09 -0700652 const struct guid_block *gblock;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000653 struct wmi_block *wblock;
654 acpi_status status;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700655 int retval;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000656 u32 i, total;
657
658 status = acpi_evaluate_object(handle, "_WDG", NULL, &out);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000659 if (ACPI_FAILURE(status))
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700660 return -ENXIO;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000661
662 obj = (union acpi_object *) out.pointer;
Dmitry Torokhov3d2c63e2010-08-26 00:15:03 -0700663 if (!obj)
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700664 return -ENXIO;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000665
Dmitry Torokhov64ed0ab2010-08-26 00:14:58 -0700666 if (obj->type != ACPI_TYPE_BUFFER) {
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700667 retval = -ENXIO;
Dmitry Torokhov64ed0ab2010-08-26 00:14:58 -0700668 goto out_free_pointer;
669 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000670
Dmitry Torokhov37830662010-08-26 00:15:09 -0700671 gblock = (const struct guid_block *)obj->buffer.pointer;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000672 total = obj->buffer.length / sizeof(struct guid_block);
673
Carlos Corbachobff431e2008-02-05 02:17:04 +0000674 for (i = 0; i < total; i++) {
Thomas Renningera929aae2010-05-03 15:30:17 +0200675 if (debug_dump_wdg)
676 wmi_dump_wdg(&gblock[i]);
677
Colin King58f64252010-11-19 15:40:02 +0000678 wblock = kzalloc(sizeof(struct wmi_block), GFP_KERNEL);
679 if (!wblock)
Dan Carpenter0a018a62013-08-14 12:02:30 +0300680 return -ENOMEM;
Colin King58f64252010-11-19 15:40:02 +0000681
682 wblock->handle = handle;
683 wblock->gblock = gblock[i];
684
685 /*
686 Some WMI devices, like those for nVidia hooks, have a
687 duplicate GUID. It's not clear what we should do in this
688 case yet, so for now, we'll just ignore the duplicate
689 for device creation.
690 */
691 if (!guid_already_parsed(gblock[i].guid)) {
692 retval = wmi_create_device(&gblock[i], wblock, handle);
693 if (retval) {
694 wmi_free_devices();
Dan Carpentere1e0dac2010-12-06 16:44:23 -0500695 goto out_free_pointer;
Colin King58f64252010-11-19 15:40:02 +0000696 }
Axel Lina5167c52010-06-03 11:45:45 +0800697 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000698
Colin King58f64252010-11-19 15:40:02 +0000699 list_add_tail(&wblock->list, &wmi_block_list);
700
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200701 if (debug_event) {
702 wblock->handler = wmi_notify_debug;
Dmitry Torokhov2d5ab552010-08-26 00:14:48 -0700703 wmi_method_enable(wblock, 1);
Thomas Renningerfc3155b2010-05-03 15:30:15 +0200704 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000705 }
706
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700707 retval = 0;
708
Axel Lina5167c52010-06-03 11:45:45 +0800709out_free_pointer:
710 kfree(out.pointer);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000711
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700712 return retval;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000713}
714
715/*
716 * WMI can have EmbeddedControl access regions. In which case, we just want to
717 * hand these off to the EC driver.
718 */
719static acpi_status
720acpi_wmi_ec_space_handler(u32 function, acpi_physical_address address,
Lin Ming439913f2010-01-28 10:53:19 +0800721 u32 bits, u64 *value,
Carlos Corbachobff431e2008-02-05 02:17:04 +0000722 void *handler_context, void *region_context)
723{
724 int result = 0, i = 0;
725 u8 temp = 0;
726
727 if ((address > 0xFF) || !value)
728 return AE_BAD_PARAMETER;
729
730 if (function != ACPI_READ && function != ACPI_WRITE)
731 return AE_BAD_PARAMETER;
732
733 if (bits != 8)
734 return AE_BAD_PARAMETER;
735
736 if (function == ACPI_READ) {
737 result = ec_read(address, &temp);
Lin Ming439913f2010-01-28 10:53:19 +0800738 (*value) |= ((u64)temp) << i;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000739 } else {
740 temp = 0xff & ((*value) >> i);
741 result = ec_write(address, temp);
742 }
743
744 switch (result) {
745 case -EINVAL:
746 return AE_BAD_PARAMETER;
747 break;
748 case -ENODEV:
749 return AE_NOT_FOUND;
750 break;
751 case -ETIME:
752 return AE_TIME;
753 break;
754 default:
755 return AE_OK;
756 }
757}
758
Bjorn Helgaasf61bb932009-04-07 15:37:37 +0000759static void acpi_wmi_notify(struct acpi_device *device, u32 event)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000760{
761 struct guid_block *block;
762 struct wmi_block *wblock;
763 struct list_head *p;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000764
Dmitry Torokhov762e1a22010-08-26 00:15:14 -0700765 list_for_each(p, &wmi_block_list) {
Carlos Corbachobff431e2008-02-05 02:17:04 +0000766 wblock = list_entry(p, struct wmi_block, list);
767 block = &wblock->gblock;
768
769 if ((block->flags & ACPI_WMI_EVENT) &&
770 (block->notify_id == event)) {
771 if (wblock->handler)
772 wblock->handler(event, wblock->handler_data);
Thomas Renninger7715348c2010-05-03 15:30:16 +0200773 if (debug_event) {
Rasmus Villemoes85b4e4e2015-09-10 00:08:45 +0200774 pr_info("DEBUG Event GUID: %pUL\n",
775 wblock->gblock.guid);
Thomas Renninger7715348c2010-05-03 15:30:16 +0200776 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000777
778 acpi_bus_generate_netlink_event(
Kay Sievers07944692008-10-30 01:18:59 +0100779 device->pnp.device_class, dev_name(&device->dev),
Carlos Corbachobff431e2008-02-05 02:17:04 +0000780 event, 0);
781 break;
782 }
783 }
784}
785
Rafael J. Wysocki51fac832013-01-24 00:24:48 +0100786static int acpi_wmi_remove(struct acpi_device *device)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000787{
Carlos Corbachobff431e2008-02-05 02:17:04 +0000788 acpi_remove_address_space_handler(device->handle,
789 ACPI_ADR_SPACE_EC, &acpi_wmi_ec_space_handler);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700790 wmi_free_devices();
Carlos Corbachobff431e2008-02-05 02:17:04 +0000791
792 return 0;
793}
794
Thomas Renninger925b1082010-07-16 13:11:36 +0200795static int acpi_wmi_add(struct acpi_device *device)
Carlos Corbachobff431e2008-02-05 02:17:04 +0000796{
797 acpi_status status;
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700798 int error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000799
Carlos Corbachobff431e2008-02-05 02:17:04 +0000800 status = acpi_install_address_space_handler(device->handle,
801 ACPI_ADR_SPACE_EC,
802 &acpi_wmi_ec_space_handler,
803 NULL, NULL);
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700804 if (ACPI_FAILURE(status)) {
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700805 pr_err("Error installing EC region handler\n");
Carlos Corbachobff431e2008-02-05 02:17:04 +0000806 return -ENODEV;
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700807 }
Carlos Corbachobff431e2008-02-05 02:17:04 +0000808
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700809 error = parse_wdg(device->handle);
810 if (error) {
Dmitry Torokhov5212cd62010-08-26 00:14:42 -0700811 acpi_remove_address_space_handler(device->handle,
812 ACPI_ADR_SPACE_EC,
813 &acpi_wmi_ec_space_handler);
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700814 pr_err("Failed to parse WDG method\n");
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700815 return error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000816 }
817
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700818 return 0;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000819}
820
821static int __init acpi_wmi_init(void)
822{
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700823 int error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000824
825 if (acpi_disabled)
826 return -ENODEV;
827
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700828 error = class_register(&wmi_class);
829 if (error)
830 return error;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000831
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700832 error = acpi_bus_register_driver(&acpi_wmi_driver);
833 if (error) {
834 pr_err("Error loading mapper\n");
835 class_unregister(&wmi_class);
836 return error;
Matthew Garrett1caab3c2009-11-04 14:17:53 -0500837 }
838
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700839 pr_info("Mapper loaded\n");
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700840 return 0;
Carlos Corbachobff431e2008-02-05 02:17:04 +0000841}
842
843static void __exit acpi_wmi_exit(void)
844{
Carlos Corbachobff431e2008-02-05 02:17:04 +0000845 acpi_bus_unregister_driver(&acpi_wmi_driver);
Dmitry Torokhovc64eefd2010-08-26 00:15:30 -0700846 class_unregister(&wmi_class);
Carlos Corbachobff431e2008-02-05 02:17:04 +0000847
Dmitry Torokhov8e075142010-08-26 00:15:19 -0700848 pr_info("Mapper unloaded\n");
Carlos Corbachobff431e2008-02-05 02:17:04 +0000849}
850
851subsys_initcall(acpi_wmi_init);
852module_exit(acpi_wmi_exit);