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 <acpi/acpi_drivers.h>
33 #include <linux/platform_device.h>
34 #include <linux/acpi.h>
35 #include <linux/rfkill.h>
36 #include <linux/string.h>
38 MODULE_AUTHOR("Matthew Garrett <mjg59@srcf.ucam.org>");
39 MODULE_DESCRIPTION("HP laptop WMI hotkeys driver");
40 MODULE_LICENSE("GPL");
42 MODULE_ALIAS("wmi:95F24279-4D7B-4334-9387-ACCDC67EF61C");
43 MODULE_ALIAS("wmi:5FB7F034-2C63-45e9-BE91-3D44E2C707E4");
45 #define HPWMI_EVENT_GUID "95F24279-4D7B-4334-9387-ACCDC67EF61C"
46 #define HPWMI_BIOS_GUID "5FB7F034-2C63-45e9-BE91-3D44E2C707E4"
48 #define HPWMI_DISPLAY_QUERY 0x1
49 #define HPWMI_HDDTEMP_QUERY 0x2
50 #define HPWMI_ALS_QUERY 0x3
51 #define HPWMI_HARDWARE_QUERY 0x4
52 #define HPWMI_WIRELESS_QUERY 0x5
53 #define HPWMI_HOTKEY_QUERY 0xc
55 #define PREFIX "HP WMI: "
56 #define UNIMP "Unimplemented "
64 enum hp_wmi_event_ids
{
67 HPWMI_SMART_ADAPTER
= 3,
68 HPWMI_BEZEL_BUTTON
= 4,
70 HPWMI_CPU_BATTERY_THROTTLE
= 6,
71 HPWMI_LOCK_SWITCH
= 7,
74 static int __devinit
hp_wmi_bios_setup(struct platform_device
*device
);
75 static int __exit
hp_wmi_bios_remove(struct platform_device
*device
);
76 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
, char *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 if (bios_return
.return_code
) {
182 printk(KERN_WARNING PREFIX
"Query %d returned %d\n", query
,
183 bios_return
.return_code
);
185 return bios_return
.return_code
;
187 if (obj
->buffer
.length
- sizeof(bios_return
) > buffersize
) {
192 memset(buffer
, 0, buffersize
);
194 ((char *)obj
->buffer
.pointer
) + sizeof(struct bios_return
),
195 obj
->buffer
.length
- sizeof(bios_return
));
200 static int hp_wmi_display_state(void)
203 int ret
= hp_wmi_perform_query(HPWMI_DISPLAY_QUERY
, 0, (char *)&state
,
210 static int hp_wmi_hddtemp_state(void)
213 int ret
= hp_wmi_perform_query(HPWMI_HDDTEMP_QUERY
, 0, (char *)&state
,
220 static int hp_wmi_als_state(void)
223 int ret
= hp_wmi_perform_query(HPWMI_ALS_QUERY
, 0, (char *)&state
,
230 static int hp_wmi_dock_state(void)
233 int ret
= hp_wmi_perform_query(HPWMI_HARDWARE_QUERY
, 0, (char *)&state
,
242 static int hp_wmi_tablet_state(void)
245 int ret
= hp_wmi_perform_query(HPWMI_HARDWARE_QUERY
, 0, (char *)&state
,
250 return (state
& 0x4) ? 1 : 0;
253 static int hp_wmi_set_block(void *data
, bool blocked
)
255 enum hp_wmi_radio r
= (enum hp_wmi_radio
) data
;
256 int query
= BIT(r
+ 8) | ((!blocked
) << r
);
259 ret
= hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 1,
260 (char *)&query
, sizeof(query
));
266 static const struct rfkill_ops hp_wmi_rfkill_ops
= {
267 .set_block
= hp_wmi_set_block
,
270 static bool hp_wmi_get_sw_state(enum hp_wmi_radio r
)
274 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0,
275 (char *)&wireless
, sizeof(wireless
));
276 /* TBD: Pass error */
278 mask
= 0x200 << (r
* 8);
286 static bool hp_wmi_get_hw_state(enum hp_wmi_radio r
)
290 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0,
291 (char *)&wireless
, sizeof(wireless
));
292 /* TBD: Pass error */
294 mask
= 0x800 << (r
* 8);
302 static ssize_t
show_display(struct device
*dev
, struct device_attribute
*attr
,
305 int value
= hp_wmi_display_state();
308 return sprintf(buf
, "%d\n", value
);
311 static ssize_t
show_hddtemp(struct device
*dev
, struct device_attribute
*attr
,
314 int value
= hp_wmi_hddtemp_state();
317 return sprintf(buf
, "%d\n", value
);
320 static ssize_t
show_als(struct device
*dev
, struct device_attribute
*attr
,
323 int value
= hp_wmi_als_state();
326 return sprintf(buf
, "%d\n", value
);
329 static ssize_t
show_dock(struct device
*dev
, struct device_attribute
*attr
,
332 int value
= hp_wmi_dock_state();
335 return sprintf(buf
, "%d\n", value
);
338 static ssize_t
show_tablet(struct device
*dev
, struct device_attribute
*attr
,
341 int value
= hp_wmi_tablet_state();
344 return sprintf(buf
, "%d\n", value
);
347 static ssize_t
set_als(struct device
*dev
, struct device_attribute
*attr
,
348 const char *buf
, size_t count
)
350 u32 tmp
= simple_strtoul(buf
, NULL
, 10);
351 int ret
= hp_wmi_perform_query(HPWMI_ALS_QUERY
, 1, (char *)&tmp
,
359 static DEVICE_ATTR(display
, S_IRUGO
, show_display
, NULL
);
360 static DEVICE_ATTR(hddtemp
, S_IRUGO
, show_hddtemp
, NULL
);
361 static DEVICE_ATTR(als
, S_IRUGO
| S_IWUSR
, show_als
, set_als
);
362 static DEVICE_ATTR(dock
, S_IRUGO
, show_dock
, NULL
);
363 static DEVICE_ATTR(tablet
, S_IRUGO
, show_tablet
, NULL
);
365 static struct key_entry
*hp_wmi_get_entry_by_scancode(unsigned int code
)
367 struct key_entry
*key
;
369 for (key
= hp_wmi_keymap
; key
->type
!= KE_END
; key
++)
370 if (code
== key
->code
)
376 static struct key_entry
*hp_wmi_get_entry_by_keycode(unsigned int keycode
)
378 struct key_entry
*key
;
380 for (key
= hp_wmi_keymap
; key
->type
!= KE_END
; key
++)
381 if (key
->type
== KE_KEY
&& keycode
== key
->keycode
)
387 static int hp_wmi_getkeycode(struct input_dev
*dev
,
388 unsigned int scancode
, unsigned int *keycode
)
390 struct key_entry
*key
= hp_wmi_get_entry_by_scancode(scancode
);
392 if (key
&& key
->type
== KE_KEY
) {
393 *keycode
= key
->keycode
;
400 static int hp_wmi_setkeycode(struct input_dev
*dev
,
401 unsigned int scancode
, unsigned int keycode
)
403 struct key_entry
*key
;
404 unsigned int old_keycode
;
406 key
= hp_wmi_get_entry_by_scancode(scancode
);
407 if (key
&& key
->type
== KE_KEY
) {
408 old_keycode
= key
->keycode
;
409 key
->keycode
= keycode
;
410 set_bit(keycode
, dev
->keybit
);
411 if (!hp_wmi_get_entry_by_keycode(old_keycode
))
412 clear_bit(old_keycode
, dev
->keybit
);
419 static void hp_wmi_notify(u32 value
, void *context
)
421 struct acpi_buffer response
= { ACPI_ALLOCATE_BUFFER
, NULL
};
422 static struct key_entry
*key
;
423 union acpi_object
*obj
;
424 u32 event_id
, event_data
;
429 status
= wmi_get_event_data(value
, &response
);
430 if (status
!= AE_OK
) {
431 printk(KERN_INFO PREFIX
"bad event status 0x%x\n", status
);
435 obj
= (union acpi_object
*)response
.pointer
;
437 if (obj
|| obj
->type
!= ACPI_TYPE_BUFFER
) {
438 printk(KERN_INFO
"hp-wmi: Unknown response received %d\n",
445 * Depending on ACPI version the concatenation of id and event data
446 * inside _WED function will result in a 8 or 16 byte buffer.
448 location
= (u32
*)obj
->buffer
.pointer
;
449 if (obj
->buffer
.length
== 8) {
450 event_id
= *location
;
451 event_data
= *(location
+ 1);
452 } else if (obj
->buffer
.length
== 16) {
453 event_id
= *location
;
454 event_data
= *(location
+ 2);
456 printk(KERN_INFO
"hp-wmi: Unknown buffer length %d\n",
464 case HPWMI_DOCK_EVENT
:
465 input_report_switch(hp_wmi_input_dev
, SW_DOCK
,
466 hp_wmi_dock_state());
467 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
468 hp_wmi_tablet_state());
469 input_sync(hp_wmi_input_dev
);
473 case HPWMI_SMART_ADAPTER
:
475 case HPWMI_BEZEL_BUTTON
:
476 ret
= hp_wmi_perform_query(HPWMI_HOTKEY_QUERY
, 0,
481 key
= hp_wmi_get_entry_by_scancode(key_code
);
485 input_report_key(hp_wmi_input_dev
,
487 input_sync(hp_wmi_input_dev
);
488 input_report_key(hp_wmi_input_dev
,
490 input_sync(hp_wmi_input_dev
);
494 printk(KERN_INFO PREFIX
"Unknown key code - 0x%x\n",
499 rfkill_set_states(wifi_rfkill
,
500 hp_wmi_get_sw_state(HPWMI_WIFI
),
501 hp_wmi_get_hw_state(HPWMI_WIFI
));
502 if (bluetooth_rfkill
)
503 rfkill_set_states(bluetooth_rfkill
,
504 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
),
505 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
507 rfkill_set_states(wwan_rfkill
,
508 hp_wmi_get_sw_state(HPWMI_WWAN
),
509 hp_wmi_get_hw_state(HPWMI_WWAN
));
511 case HPWMI_CPU_BATTERY_THROTTLE
:
512 printk(KERN_INFO PREFIX UNIMP
"CPU throttle because of 3 Cell"
513 " battery event detected\n");
515 case HPWMI_LOCK_SWITCH
:
518 printk(KERN_INFO PREFIX
"Unknown event_id - %d - 0x%x\n",
519 event_id
, event_data
);
524 static int __init
hp_wmi_input_setup(void)
526 struct key_entry
*key
;
529 hp_wmi_input_dev
= input_allocate_device();
531 hp_wmi_input_dev
->name
= "HP WMI hotkeys";
532 hp_wmi_input_dev
->phys
= "wmi/input0";
533 hp_wmi_input_dev
->id
.bustype
= BUS_HOST
;
534 hp_wmi_input_dev
->getkeycode
= hp_wmi_getkeycode
;
535 hp_wmi_input_dev
->setkeycode
= hp_wmi_setkeycode
;
537 for (key
= hp_wmi_keymap
; key
->type
!= KE_END
; key
++) {
540 set_bit(EV_KEY
, hp_wmi_input_dev
->evbit
);
541 set_bit(key
->keycode
, hp_wmi_input_dev
->keybit
);
546 set_bit(EV_SW
, hp_wmi_input_dev
->evbit
);
547 set_bit(SW_DOCK
, hp_wmi_input_dev
->swbit
);
548 set_bit(SW_TABLET_MODE
, hp_wmi_input_dev
->swbit
);
550 /* Set initial hardware state */
551 input_report_switch(hp_wmi_input_dev
, SW_DOCK
, hp_wmi_dock_state());
552 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
553 hp_wmi_tablet_state());
554 input_sync(hp_wmi_input_dev
);
556 err
= input_register_device(hp_wmi_input_dev
);
559 input_free_device(hp_wmi_input_dev
);
566 static void cleanup_sysfs(struct platform_device
*device
)
568 device_remove_file(&device
->dev
, &dev_attr_display
);
569 device_remove_file(&device
->dev
, &dev_attr_hddtemp
);
570 device_remove_file(&device
->dev
, &dev_attr_als
);
571 device_remove_file(&device
->dev
, &dev_attr_dock
);
572 device_remove_file(&device
->dev
, &dev_attr_tablet
);
575 static int __devinit
hp_wmi_bios_setup(struct platform_device
*device
)
580 err
= hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0, (char *)&wireless
,
585 err
= device_create_file(&device
->dev
, &dev_attr_display
);
587 goto add_sysfs_error
;
588 err
= device_create_file(&device
->dev
, &dev_attr_hddtemp
);
590 goto add_sysfs_error
;
591 err
= device_create_file(&device
->dev
, &dev_attr_als
);
593 goto add_sysfs_error
;
594 err
= device_create_file(&device
->dev
, &dev_attr_dock
);
596 goto add_sysfs_error
;
597 err
= device_create_file(&device
->dev
, &dev_attr_tablet
);
599 goto add_sysfs_error
;
601 if (wireless
& 0x1) {
602 wifi_rfkill
= rfkill_alloc("hp-wifi", &device
->dev
,
605 (void *) HPWMI_WIFI
);
606 rfkill_init_sw_state(wifi_rfkill
,
607 hp_wmi_get_sw_state(HPWMI_WIFI
));
608 rfkill_set_hw_state(wifi_rfkill
,
609 hp_wmi_get_hw_state(HPWMI_WIFI
));
610 err
= rfkill_register(wifi_rfkill
);
612 goto register_wifi_error
;
615 if (wireless
& 0x2) {
616 bluetooth_rfkill
= rfkill_alloc("hp-bluetooth", &device
->dev
,
617 RFKILL_TYPE_BLUETOOTH
,
619 (void *) HPWMI_BLUETOOTH
);
620 rfkill_init_sw_state(bluetooth_rfkill
,
621 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
));
622 rfkill_set_hw_state(bluetooth_rfkill
,
623 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
624 err
= rfkill_register(bluetooth_rfkill
);
626 goto register_bluetooth_error
;
629 if (wireless
& 0x4) {
630 wwan_rfkill
= rfkill_alloc("hp-wwan", &device
->dev
,
633 (void *) HPWMI_WWAN
);
634 rfkill_init_sw_state(wwan_rfkill
,
635 hp_wmi_get_sw_state(HPWMI_WWAN
));
636 rfkill_set_hw_state(wwan_rfkill
,
637 hp_wmi_get_hw_state(HPWMI_WWAN
));
638 err
= rfkill_register(wwan_rfkill
);
640 goto register_wwan_err
;
645 rfkill_destroy(wwan_rfkill
);
646 if (bluetooth_rfkill
)
647 rfkill_unregister(bluetooth_rfkill
);
648 register_bluetooth_error
:
649 rfkill_destroy(bluetooth_rfkill
);
651 rfkill_unregister(wifi_rfkill
);
653 rfkill_destroy(wifi_rfkill
);
655 cleanup_sysfs(device
);
659 static int __exit
hp_wmi_bios_remove(struct platform_device
*device
)
661 cleanup_sysfs(device
);
664 rfkill_unregister(wifi_rfkill
);
665 rfkill_destroy(wifi_rfkill
);
667 if (bluetooth_rfkill
) {
668 rfkill_unregister(bluetooth_rfkill
);
669 rfkill_destroy(bluetooth_rfkill
);
672 rfkill_unregister(wwan_rfkill
);
673 rfkill_destroy(wwan_rfkill
);
679 static int hp_wmi_resume_handler(struct device
*device
)
682 * Hardware state may have changed while suspended, so trigger
683 * input events for the current state. As this is a switch,
684 * the input layer will only actually pass it on if the state
687 if (hp_wmi_input_dev
) {
688 input_report_switch(hp_wmi_input_dev
, SW_DOCK
,
689 hp_wmi_dock_state());
690 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
691 hp_wmi_tablet_state());
692 input_sync(hp_wmi_input_dev
);
696 rfkill_set_states(wifi_rfkill
,
697 hp_wmi_get_sw_state(HPWMI_WIFI
),
698 hp_wmi_get_hw_state(HPWMI_WIFI
));
699 if (bluetooth_rfkill
)
700 rfkill_set_states(bluetooth_rfkill
,
701 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
),
702 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
704 rfkill_set_states(wwan_rfkill
,
705 hp_wmi_get_sw_state(HPWMI_WWAN
),
706 hp_wmi_get_hw_state(HPWMI_WWAN
));
711 static int __init
hp_wmi_init(void)
715 if (wmi_has_guid(HPWMI_EVENT_GUID
)) {
716 err
= wmi_install_notify_handler(HPWMI_EVENT_GUID
,
717 hp_wmi_notify
, NULL
);
718 if (ACPI_FAILURE(err
))
720 err
= hp_wmi_input_setup();
722 wmi_remove_notify_handler(HPWMI_EVENT_GUID
);
727 if (wmi_has_guid(HPWMI_BIOS_GUID
)) {
728 err
= platform_driver_register(&hp_wmi_driver
);
731 hp_wmi_platform_dev
= platform_device_alloc("hp-wmi", -1);
732 if (!hp_wmi_platform_dev
) {
734 goto err_device_alloc
;
736 err
= platform_device_add(hp_wmi_platform_dev
);
744 platform_device_put(hp_wmi_platform_dev
);
746 platform_driver_unregister(&hp_wmi_driver
);
748 if (wmi_has_guid(HPWMI_EVENT_GUID
)) {
749 input_unregister_device(hp_wmi_input_dev
);
750 wmi_remove_notify_handler(HPWMI_EVENT_GUID
);
756 static void __exit
hp_wmi_exit(void)
758 if (wmi_has_guid(HPWMI_EVENT_GUID
)) {
759 wmi_remove_notify_handler(HPWMI_EVENT_GUID
);
760 input_unregister_device(hp_wmi_input_dev
);
762 if (hp_wmi_platform_dev
) {
763 platform_device_unregister(hp_wmi_platform_dev
);
764 platform_driver_unregister(&hp_wmi_driver
);
768 module_init(hp_wmi_init
);
769 module_exit(hp_wmi_exit
);