4 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
6 * Portions based on wistron_btns.c:
7 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
8 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
9 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/types.h>
31 #include <linux/input.h>
32 #include <linux/platform_device.h>
33 #include <linux/acpi.h>
34 #include <linux/rfkill.h>
35 #include <linux/string.h>
37 MODULE_AUTHOR("Matthew Garrett <mjg59@srcf.ucam.org>");
38 MODULE_DESCRIPTION("HP laptop WMI hotkeys driver");
39 MODULE_LICENSE("GPL");
41 MODULE_ALIAS("wmi:95F24279-4D7B-4334-9387-ACCDC67EF61C");
42 MODULE_ALIAS("wmi:5FB7F034-2C63-45e9-BE91-3D44E2C707E4");
44 #define HPWMI_EVENT_GUID "95F24279-4D7B-4334-9387-ACCDC67EF61C"
45 #define HPWMI_BIOS_GUID "5FB7F034-2C63-45e9-BE91-3D44E2C707E4"
47 #define HPWMI_DISPLAY_QUERY 0x1
48 #define HPWMI_HDDTEMP_QUERY 0x2
49 #define HPWMI_ALS_QUERY 0x3
50 #define HPWMI_HARDWARE_QUERY 0x4
51 #define HPWMI_WIRELESS_QUERY 0x5
52 #define HPWMI_HOTKEY_QUERY 0xc
54 #define PREFIX "HP WMI: "
55 #define UNIMP "Unimplemented "
63 enum hp_wmi_event_ids {
66 HPWMI_SMART_ADAPTER = 3,
67 HPWMI_BEZEL_BUTTON = 4,
69 HPWMI_CPU_BATTERY_THROTTLE = 6,
70 HPWMI_LOCK_SWITCH = 7,
73 static int __devinit hp_wmi_bios_setup(struct platform_device *device);
74 static int __exit hp_wmi_bios_remove(struct platform_device *device);
75 static int hp_wmi_resume_handler(struct device *device);
92 char type; /* See KE_* below */
97 enum { KE_KEY, KE_END };
99 static struct key_entry hp_wmi_keymap[] = {
100 {KE_KEY, 0x02, KEY_BRIGHTNESSUP},
101 {KE_KEY, 0x03, KEY_BRIGHTNESSDOWN},
102 {KE_KEY, 0x20e6, KEY_PROG1},
103 {KE_KEY, 0x20e8, KEY_MEDIA},
104 {KE_KEY, 0x2142, KEY_MEDIA},
105 {KE_KEY, 0x213b, KEY_INFO},
106 {KE_KEY, 0x2169, KEY_DIRECTION},
107 {KE_KEY, 0x231b, KEY_HELP},
111 static struct input_dev *hp_wmi_input_dev;
112 static struct platform_device *hp_wmi_platform_dev;
114 static struct rfkill *wifi_rfkill;
115 static struct rfkill *bluetooth_rfkill;
116 static struct rfkill *wwan_rfkill;
118 static const struct dev_pm_ops hp_wmi_pm_ops = {
119 .resume = hp_wmi_resume_handler,
120 .restore = hp_wmi_resume_handler,
123 static struct platform_driver hp_wmi_driver = {
126 .owner = THIS_MODULE,
127 .pm = &hp_wmi_pm_ops,
129 .probe = hp_wmi_bios_setup,
130 .remove = hp_wmi_bios_remove,
134 * hp_wmi_perform_query
136 * query: The commandtype -> What should be queried
137 * write: The command -> 0 read, 1 write, 3 ODM specific
138 * buffer: Buffer used as input and/or output
139 * buffersize: Size of buffer
141 * returns zero on success
142 * an HP WMI query specific error code (which is positive)
143 * -EINVAL if the query was not successful at all
144 * -EINVAL if the output buffer size exceeds buffersize
146 * Note: The buffersize must at least be the maximum of the input and output
147 * size. E.g. Battery info query (0x7) is defined to have 1 byte input
148 * and 128 byte output. The caller would do:
149 * buffer = kzalloc(128, GFP_KERNEL);
150 * ret = hp_wmi_perform_query(0x7, 0, buffer, 128)
152 static int hp_wmi_perform_query(int query, int write, u32 *buffer,
155 struct bios_return bios_return;
157 union acpi_object *obj;
158 struct bios_args args = {
159 .signature = 0x55434553,
160 .command = write ? 0x2 : 0x1,
161 .commandtype = query,
162 .datasize = buffersize,
165 struct acpi_buffer input = { sizeof(struct bios_args), &args };
166 struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
168 status = wmi_evaluate_method(HPWMI_BIOS_GUID, 0, 0x3, &input, &output);
170 obj = output.pointer;
174 else if (obj->type != ACPI_TYPE_BUFFER) {
179 bios_return = *((struct bios_return *)obj->buffer.pointer);
181 memcpy(buffer, &bios_return.value, sizeof(bios_return.value));
185 static int hp_wmi_display_state(void)
188 int ret = hp_wmi_perform_query(HPWMI_DISPLAY_QUERY, 0, &state,
195 static int hp_wmi_hddtemp_state(void)
198 int ret = hp_wmi_perform_query(HPWMI_HDDTEMP_QUERY, 0, &state,
205 static int hp_wmi_als_state(void)
208 int ret = hp_wmi_perform_query(HPWMI_ALS_QUERY, 0, &state,
215 static int hp_wmi_dock_state(void)
218 int ret = hp_wmi_perform_query(HPWMI_HARDWARE_QUERY, 0, &state,
227 static int hp_wmi_tablet_state(void)
230 int ret = hp_wmi_perform_query(HPWMI_HARDWARE_QUERY, 0, &state,
235 return (state & 0x4) ? 1 : 0;
238 static int hp_wmi_set_block(void *data, bool blocked)
240 enum hp_wmi_radio r = (enum hp_wmi_radio) data;
241 int query = BIT(r + 8) | ((!blocked) << r);
244 ret = hp_wmi_perform_query(HPWMI_WIRELESS_QUERY, 1,
245 &query, sizeof(query));
251 static const struct rfkill_ops hp_wmi_rfkill_ops = {
252 .set_block = hp_wmi_set_block,
255 static bool hp_wmi_get_sw_state(enum hp_wmi_radio r)
259 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY, 0,
260 &wireless, sizeof(wireless));
261 /* TBD: Pass error */
263 mask = 0x200 << (r * 8);
271 static bool hp_wmi_get_hw_state(enum hp_wmi_radio r)
275 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY, 0,
276 &wireless, sizeof(wireless));
277 /* TBD: Pass error */
279 mask = 0x800 << (r * 8);
287 static ssize_t show_display(struct device *dev, struct device_attribute *attr,
290 int value = hp_wmi_display_state();
293 return sprintf(buf, "%d\n", value);
296 static ssize_t show_hddtemp(struct device *dev, struct device_attribute *attr,
299 int value = hp_wmi_hddtemp_state();
302 return sprintf(buf, "%d\n", value);
305 static ssize_t show_als(struct device *dev, struct device_attribute *attr,
308 int value = hp_wmi_als_state();
311 return sprintf(buf, "%d\n", value);
314 static ssize_t show_dock(struct device *dev, struct device_attribute *attr,
317 int value = hp_wmi_dock_state();
320 return sprintf(buf, "%d\n", value);
323 static ssize_t show_tablet(struct device *dev, struct device_attribute *attr,
326 int value = hp_wmi_tablet_state();
329 return sprintf(buf, "%d\n", value);
332 static ssize_t set_als(struct device *dev, struct device_attribute *attr,
333 const char *buf, size_t count)
335 u32 tmp = simple_strtoul(buf, NULL, 10);
336 int ret = hp_wmi_perform_query(HPWMI_ALS_QUERY, 1, &tmp,
344 static DEVICE_ATTR(display, S_IRUGO, show_display, NULL);
345 static DEVICE_ATTR(hddtemp, S_IRUGO, show_hddtemp, NULL);
346 static DEVICE_ATTR(als, S_IRUGO | S_IWUSR, show_als, set_als);
347 static DEVICE_ATTR(dock, S_IRUGO, show_dock, NULL);
348 static DEVICE_ATTR(tablet, S_IRUGO, show_tablet, NULL);
350 static struct key_entry *hp_wmi_get_entry_by_scancode(unsigned int code)
352 struct key_entry *key;
354 for (key = hp_wmi_keymap; key->type != KE_END; key++)
355 if (code == key->code)
361 static struct key_entry *hp_wmi_get_entry_by_keycode(unsigned int keycode)
363 struct key_entry *key;
365 for (key = hp_wmi_keymap; key->type != KE_END; key++)
366 if (key->type == KE_KEY && keycode == key->keycode)
372 static int hp_wmi_getkeycode(struct input_dev *dev,
373 unsigned int scancode, unsigned int *keycode)
375 struct key_entry *key = hp_wmi_get_entry_by_scancode(scancode);
377 if (key && key->type == KE_KEY) {
378 *keycode = key->keycode;
385 static int hp_wmi_setkeycode(struct input_dev *dev,
386 unsigned int scancode, unsigned int keycode)
388 struct key_entry *key;
389 unsigned int old_keycode;
391 key = hp_wmi_get_entry_by_scancode(scancode);
392 if (key && key->type == KE_KEY) {
393 old_keycode = key->keycode;
394 key->keycode = keycode;
395 set_bit(keycode, dev->keybit);
396 if (!hp_wmi_get_entry_by_keycode(old_keycode))
397 clear_bit(old_keycode, dev->keybit);
404 static void hp_wmi_notify(u32 value, void *context)
406 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
407 static struct key_entry *key;
408 union acpi_object *obj;
409 u32 event_id, event_data;
410 int key_code = 0, ret;
414 status = wmi_get_event_data(value, &response);
415 if (status != AE_OK) {
416 printk(KERN_INFO PREFIX "bad event status 0x%x\n", status);
420 obj = (union acpi_object *)response.pointer;
424 if (obj->type != ACPI_TYPE_BUFFER) {
425 printk(KERN_INFO "hp-wmi: Unknown response received %d\n",
432 * Depending on ACPI version the concatenation of id and event data
433 * inside _WED function will result in a 8 or 16 byte buffer.
435 location = (u32 *)obj->buffer.pointer;
436 if (obj->buffer.length == 8) {
437 event_id = *location;
438 event_data = *(location + 1);
439 } else if (obj->buffer.length == 16) {
440 event_id = *location;
441 event_data = *(location + 2);
443 printk(KERN_INFO "hp-wmi: Unknown buffer length %d\n",
451 case HPWMI_DOCK_EVENT:
452 input_report_switch(hp_wmi_input_dev, SW_DOCK,
453 hp_wmi_dock_state());
454 input_report_switch(hp_wmi_input_dev, SW_TABLET_MODE,
455 hp_wmi_tablet_state());
456 input_sync(hp_wmi_input_dev);
460 case HPWMI_SMART_ADAPTER:
462 case HPWMI_BEZEL_BUTTON:
463 ret = hp_wmi_perform_query(HPWMI_HOTKEY_QUERY, 0,
468 key = hp_wmi_get_entry_by_scancode(key_code);
472 input_report_key(hp_wmi_input_dev,
474 input_sync(hp_wmi_input_dev);
475 input_report_key(hp_wmi_input_dev,
477 input_sync(hp_wmi_input_dev);
481 printk(KERN_INFO PREFIX "Unknown key code - 0x%x\n",
486 rfkill_set_states(wifi_rfkill,
487 hp_wmi_get_sw_state(HPWMI_WIFI),
488 hp_wmi_get_hw_state(HPWMI_WIFI));
489 if (bluetooth_rfkill)
490 rfkill_set_states(bluetooth_rfkill,
491 hp_wmi_get_sw_state(HPWMI_BLUETOOTH),
492 hp_wmi_get_hw_state(HPWMI_BLUETOOTH));
494 rfkill_set_states(wwan_rfkill,
495 hp_wmi_get_sw_state(HPWMI_WWAN),
496 hp_wmi_get_hw_state(HPWMI_WWAN));
498 case HPWMI_CPU_BATTERY_THROTTLE:
499 printk(KERN_INFO PREFIX UNIMP "CPU throttle because of 3 Cell"
500 " battery event detected\n");
502 case HPWMI_LOCK_SWITCH:
505 printk(KERN_INFO PREFIX "Unknown event_id - %d - 0x%x\n",
506 event_id, event_data);
511 static int __init hp_wmi_input_setup(void)
513 struct key_entry *key;
516 hp_wmi_input_dev = input_allocate_device();
517 if (!hp_wmi_input_dev)
520 hp_wmi_input_dev->name = "HP WMI hotkeys";
521 hp_wmi_input_dev->phys = "wmi/input0";
522 hp_wmi_input_dev->id.bustype = BUS_HOST;
523 hp_wmi_input_dev->getkeycode = hp_wmi_getkeycode;
524 hp_wmi_input_dev->setkeycode = hp_wmi_setkeycode;
526 for (key = hp_wmi_keymap; key->type != KE_END; key++) {
529 set_bit(EV_KEY, hp_wmi_input_dev->evbit);
530 set_bit(key->keycode, hp_wmi_input_dev->keybit);
535 set_bit(EV_SW, hp_wmi_input_dev->evbit);
536 set_bit(SW_DOCK, hp_wmi_input_dev->swbit);
537 set_bit(SW_TABLET_MODE, hp_wmi_input_dev->swbit);
539 /* Set initial hardware state */
540 input_report_switch(hp_wmi_input_dev, SW_DOCK, hp_wmi_dock_state());
541 input_report_switch(hp_wmi_input_dev, SW_TABLET_MODE,
542 hp_wmi_tablet_state());
543 input_sync(hp_wmi_input_dev);
545 err = input_register_device(hp_wmi_input_dev);
548 input_free_device(hp_wmi_input_dev);
555 static void cleanup_sysfs(struct platform_device *device)
557 device_remove_file(&device->dev, &dev_attr_display);
558 device_remove_file(&device->dev, &dev_attr_hddtemp);
559 device_remove_file(&device->dev, &dev_attr_als);
560 device_remove_file(&device->dev, &dev_attr_dock);
561 device_remove_file(&device->dev, &dev_attr_tablet);
564 static int __devinit hp_wmi_bios_setup(struct platform_device *device)
569 err = hp_wmi_perform_query(HPWMI_WIRELESS_QUERY, 0, &wireless,
574 err = device_create_file(&device->dev, &dev_attr_display);
576 goto add_sysfs_error;
577 err = device_create_file(&device->dev, &dev_attr_hddtemp);
579 goto add_sysfs_error;
580 err = device_create_file(&device->dev, &dev_attr_als);
582 goto add_sysfs_error;
583 err = device_create_file(&device->dev, &dev_attr_dock);
585 goto add_sysfs_error;
586 err = device_create_file(&device->dev, &dev_attr_tablet);
588 goto add_sysfs_error;
590 if (wireless & 0x1) {
591 wifi_rfkill = rfkill_alloc("hp-wifi", &device->dev,
594 (void *) HPWMI_WIFI);
595 rfkill_init_sw_state(wifi_rfkill,
596 hp_wmi_get_sw_state(HPWMI_WIFI));
597 rfkill_set_hw_state(wifi_rfkill,
598 hp_wmi_get_hw_state(HPWMI_WIFI));
599 err = rfkill_register(wifi_rfkill);
601 goto register_wifi_error;
604 if (wireless & 0x2) {
605 bluetooth_rfkill = rfkill_alloc("hp-bluetooth", &device->dev,
606 RFKILL_TYPE_BLUETOOTH,
608 (void *) HPWMI_BLUETOOTH);
609 rfkill_init_sw_state(bluetooth_rfkill,
610 hp_wmi_get_sw_state(HPWMI_BLUETOOTH));
611 rfkill_set_hw_state(bluetooth_rfkill,
612 hp_wmi_get_hw_state(HPWMI_BLUETOOTH));
613 err = rfkill_register(bluetooth_rfkill);
615 goto register_bluetooth_error;
618 if (wireless & 0x4) {
619 wwan_rfkill = rfkill_alloc("hp-wwan", &device->dev,
622 (void *) HPWMI_WWAN);
623 rfkill_init_sw_state(wwan_rfkill,
624 hp_wmi_get_sw_state(HPWMI_WWAN));
625 rfkill_set_hw_state(wwan_rfkill,
626 hp_wmi_get_hw_state(HPWMI_WWAN));
627 err = rfkill_register(wwan_rfkill);
629 goto register_wwan_err;
634 rfkill_destroy(wwan_rfkill);
635 if (bluetooth_rfkill)
636 rfkill_unregister(bluetooth_rfkill);
637 register_bluetooth_error:
638 rfkill_destroy(bluetooth_rfkill);
640 rfkill_unregister(wifi_rfkill);
642 rfkill_destroy(wifi_rfkill);
644 cleanup_sysfs(device);
648 static int __exit hp_wmi_bios_remove(struct platform_device *device)
650 cleanup_sysfs(device);
653 rfkill_unregister(wifi_rfkill);
654 rfkill_destroy(wifi_rfkill);
656 if (bluetooth_rfkill) {
657 rfkill_unregister(bluetooth_rfkill);
658 rfkill_destroy(bluetooth_rfkill);
661 rfkill_unregister(wwan_rfkill);
662 rfkill_destroy(wwan_rfkill);
668 static int hp_wmi_resume_handler(struct device *device)
671 * Hardware state may have changed while suspended, so trigger
672 * input events for the current state. As this is a switch,
673 * the input layer will only actually pass it on if the state
676 if (hp_wmi_input_dev) {
677 input_report_switch(hp_wmi_input_dev, SW_DOCK,
678 hp_wmi_dock_state());
679 input_report_switch(hp_wmi_input_dev, SW_TABLET_MODE,
680 hp_wmi_tablet_state());
681 input_sync(hp_wmi_input_dev);
685 rfkill_set_states(wifi_rfkill,
686 hp_wmi_get_sw_state(HPWMI_WIFI),
687 hp_wmi_get_hw_state(HPWMI_WIFI));
688 if (bluetooth_rfkill)
689 rfkill_set_states(bluetooth_rfkill,
690 hp_wmi_get_sw_state(HPWMI_BLUETOOTH),
691 hp_wmi_get_hw_state(HPWMI_BLUETOOTH));
693 rfkill_set_states(wwan_rfkill,
694 hp_wmi_get_sw_state(HPWMI_WWAN),
695 hp_wmi_get_hw_state(HPWMI_WWAN));
700 static int __init hp_wmi_init(void)
703 int event_capable = wmi_has_guid(HPWMI_EVENT_GUID);
704 int bios_capable = wmi_has_guid(HPWMI_BIOS_GUID);
707 err = wmi_install_notify_handler(HPWMI_EVENT_GUID,
708 hp_wmi_notify, NULL);
709 if (ACPI_FAILURE(err))
711 err = hp_wmi_input_setup();
713 wmi_remove_notify_handler(HPWMI_EVENT_GUID);
719 err = platform_driver_register(&hp_wmi_driver);
722 hp_wmi_platform_dev = platform_device_alloc("hp-wmi", -1);
723 if (!hp_wmi_platform_dev) {
725 goto err_device_alloc;
727 err = platform_device_add(hp_wmi_platform_dev);
732 if (!bios_capable && !event_capable)
738 platform_device_put(hp_wmi_platform_dev);
740 platform_driver_unregister(&hp_wmi_driver);
742 if (wmi_has_guid(HPWMI_EVENT_GUID)) {
743 input_unregister_device(hp_wmi_input_dev);
744 wmi_remove_notify_handler(HPWMI_EVENT_GUID);
750 static void __exit hp_wmi_exit(void)
752 if (wmi_has_guid(HPWMI_EVENT_GUID)) {
753 wmi_remove_notify_handler(HPWMI_EVENT_GUID);
754 input_unregister_device(hp_wmi_input_dev);
756 if (hp_wmi_platform_dev) {
757 platform_device_unregister(hp_wmi_platform_dev);
758 platform_driver_unregister(&hp_wmi_driver);
762 module_init(hp_wmi_init);
763 module_exit(hp_wmi_exit);