drivers/platform/x86/wmi.c

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