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/input/sparse-keymap.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 enum hp_return_value
{
93 HPWMI_RET_WRONG_SIGNATURE
= 0x02,
94 HPWMI_RET_UNKNOWN_COMMAND
= 0x03,
95 HPWMI_RET_UNKNOWN_CMDTYPE
= 0x04,
96 HPWMI_RET_INVALID_PARAMETERS
= 0x05,
99 static const 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 if (bios_return
.return_code
) {
182 if (bios_return
.return_code
!= HPWMI_RET_UNKNOWN_CMDTYPE
)
183 printk(KERN_WARNING PREFIX
"query 0x%x returned "
185 query
, bios_return
.return_code
);
187 return bios_return
.return_code
;
190 memcpy(buffer
, &bios_return
.value
, sizeof(bios_return
.value
));
196 static int hp_wmi_display_state(void)
199 int ret
= hp_wmi_perform_query(HPWMI_DISPLAY_QUERY
, 0, &state
,
206 static int hp_wmi_hddtemp_state(void)
209 int ret
= hp_wmi_perform_query(HPWMI_HDDTEMP_QUERY
, 0, &state
,
216 static int hp_wmi_als_state(void)
219 int ret
= hp_wmi_perform_query(HPWMI_ALS_QUERY
, 0, &state
,
226 static int hp_wmi_dock_state(void)
229 int ret
= hp_wmi_perform_query(HPWMI_HARDWARE_QUERY
, 0, &state
,
238 static int hp_wmi_tablet_state(void)
241 int ret
= hp_wmi_perform_query(HPWMI_HARDWARE_QUERY
, 0, &state
,
246 return (state
& 0x4) ? 1 : 0;
249 static int hp_wmi_set_block(void *data
, bool blocked
)
251 enum hp_wmi_radio r
= (enum hp_wmi_radio
) data
;
252 int query
= BIT(r
+ 8) | ((!blocked
) << r
);
255 ret
= hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 1,
256 &query
, sizeof(query
));
262 static const struct rfkill_ops hp_wmi_rfkill_ops
= {
263 .set_block
= hp_wmi_set_block
,
266 static bool hp_wmi_get_sw_state(enum hp_wmi_radio r
)
270 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0,
271 &wireless
, sizeof(wireless
));
272 /* TBD: Pass error */
274 mask
= 0x200 << (r
* 8);
282 static bool hp_wmi_get_hw_state(enum hp_wmi_radio r
)
286 hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0,
287 &wireless
, sizeof(wireless
));
288 /* TBD: Pass error */
290 mask
= 0x800 << (r
* 8);
298 static ssize_t
show_display(struct device
*dev
, struct device_attribute
*attr
,
301 int value
= hp_wmi_display_state();
304 return sprintf(buf
, "%d\n", value
);
307 static ssize_t
show_hddtemp(struct device
*dev
, struct device_attribute
*attr
,
310 int value
= hp_wmi_hddtemp_state();
313 return sprintf(buf
, "%d\n", value
);
316 static ssize_t
show_als(struct device
*dev
, struct device_attribute
*attr
,
319 int value
= hp_wmi_als_state();
322 return sprintf(buf
, "%d\n", value
);
325 static ssize_t
show_dock(struct device
*dev
, struct device_attribute
*attr
,
328 int value
= hp_wmi_dock_state();
331 return sprintf(buf
, "%d\n", value
);
334 static ssize_t
show_tablet(struct device
*dev
, struct device_attribute
*attr
,
337 int value
= hp_wmi_tablet_state();
340 return sprintf(buf
, "%d\n", value
);
343 static ssize_t
set_als(struct device
*dev
, struct device_attribute
*attr
,
344 const char *buf
, size_t count
)
346 u32 tmp
= simple_strtoul(buf
, NULL
, 10);
347 int ret
= hp_wmi_perform_query(HPWMI_ALS_QUERY
, 1, &tmp
,
355 static DEVICE_ATTR(display
, S_IRUGO
, show_display
, NULL
);
356 static DEVICE_ATTR(hddtemp
, S_IRUGO
, show_hddtemp
, NULL
);
357 static DEVICE_ATTR(als
, S_IRUGO
| S_IWUSR
, show_als
, set_als
);
358 static DEVICE_ATTR(dock
, S_IRUGO
, show_dock
, NULL
);
359 static DEVICE_ATTR(tablet
, S_IRUGO
, show_tablet
, NULL
);
361 static void hp_wmi_notify(u32 value
, void *context
)
363 struct acpi_buffer response
= { ACPI_ALLOCATE_BUFFER
, NULL
};
364 union acpi_object
*obj
;
365 u32 event_id
, event_data
;
366 int key_code
= 0, ret
;
370 status
= wmi_get_event_data(value
, &response
);
371 if (status
!= AE_OK
) {
372 printk(KERN_INFO PREFIX
"bad event status 0x%x\n", status
);
376 obj
= (union acpi_object
*)response
.pointer
;
380 if (obj
->type
!= ACPI_TYPE_BUFFER
) {
381 printk(KERN_INFO
"hp-wmi: Unknown response received %d\n",
388 * Depending on ACPI version the concatenation of id and event data
389 * inside _WED function will result in a 8 or 16 byte buffer.
391 location
= (u32
*)obj
->buffer
.pointer
;
392 if (obj
->buffer
.length
== 8) {
393 event_id
= *location
;
394 event_data
= *(location
+ 1);
395 } else if (obj
->buffer
.length
== 16) {
396 event_id
= *location
;
397 event_data
= *(location
+ 2);
399 printk(KERN_INFO
"hp-wmi: Unknown buffer length %d\n",
407 case HPWMI_DOCK_EVENT
:
408 input_report_switch(hp_wmi_input_dev
, SW_DOCK
,
409 hp_wmi_dock_state());
410 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
411 hp_wmi_tablet_state());
412 input_sync(hp_wmi_input_dev
);
416 case HPWMI_SMART_ADAPTER
:
418 case HPWMI_BEZEL_BUTTON
:
419 ret
= hp_wmi_perform_query(HPWMI_HOTKEY_QUERY
, 0,
425 if (!sparse_keymap_report_event(hp_wmi_input_dev
,
427 printk(KERN_INFO PREFIX
"Unknown key code - 0x%x\n",
432 rfkill_set_states(wifi_rfkill
,
433 hp_wmi_get_sw_state(HPWMI_WIFI
),
434 hp_wmi_get_hw_state(HPWMI_WIFI
));
435 if (bluetooth_rfkill
)
436 rfkill_set_states(bluetooth_rfkill
,
437 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
),
438 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
440 rfkill_set_states(wwan_rfkill
,
441 hp_wmi_get_sw_state(HPWMI_WWAN
),
442 hp_wmi_get_hw_state(HPWMI_WWAN
));
444 case HPWMI_CPU_BATTERY_THROTTLE
:
445 printk(KERN_INFO PREFIX UNIMP
"CPU throttle because of 3 Cell"
446 " battery event detected\n");
448 case HPWMI_LOCK_SWITCH
:
451 printk(KERN_INFO PREFIX
"Unknown event_id - %d - 0x%x\n",
452 event_id
, event_data
);
457 static int __init
hp_wmi_input_setup(void)
462 hp_wmi_input_dev
= input_allocate_device();
463 if (!hp_wmi_input_dev
)
466 hp_wmi_input_dev
->name
= "HP WMI hotkeys";
467 hp_wmi_input_dev
->phys
= "wmi/input0";
468 hp_wmi_input_dev
->id
.bustype
= BUS_HOST
;
470 __set_bit(EV_SW
, hp_wmi_input_dev
->evbit
);
471 __set_bit(SW_DOCK
, hp_wmi_input_dev
->swbit
);
472 __set_bit(SW_TABLET_MODE
, hp_wmi_input_dev
->swbit
);
474 err
= sparse_keymap_setup(hp_wmi_input_dev
, hp_wmi_keymap
, NULL
);
478 /* Set initial hardware state */
479 input_report_switch(hp_wmi_input_dev
, SW_DOCK
, hp_wmi_dock_state());
480 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
481 hp_wmi_tablet_state());
482 input_sync(hp_wmi_input_dev
);
484 status
= wmi_install_notify_handler(HPWMI_EVENT_GUID
, hp_wmi_notify
, NULL
);
485 if (ACPI_FAILURE(status
)) {
487 goto err_free_keymap
;
490 err
= input_register_device(hp_wmi_input_dev
);
492 goto err_uninstall_notifier
;
496 err_uninstall_notifier
:
497 wmi_remove_notify_handler(HPWMI_EVENT_GUID
);
499 sparse_keymap_free(hp_wmi_input_dev
);
501 input_free_device(hp_wmi_input_dev
);
505 static void hp_wmi_input_destroy(void)
507 wmi_remove_notify_handler(HPWMI_EVENT_GUID
);
508 sparse_keymap_free(hp_wmi_input_dev
);
509 input_unregister_device(hp_wmi_input_dev
);
512 static void cleanup_sysfs(struct platform_device
*device
)
514 device_remove_file(&device
->dev
, &dev_attr_display
);
515 device_remove_file(&device
->dev
, &dev_attr_hddtemp
);
516 device_remove_file(&device
->dev
, &dev_attr_als
);
517 device_remove_file(&device
->dev
, &dev_attr_dock
);
518 device_remove_file(&device
->dev
, &dev_attr_tablet
);
521 static int __devinit
hp_wmi_bios_setup(struct platform_device
*device
)
526 err
= hp_wmi_perform_query(HPWMI_WIRELESS_QUERY
, 0, &wireless
,
531 err
= device_create_file(&device
->dev
, &dev_attr_display
);
533 goto add_sysfs_error
;
534 err
= device_create_file(&device
->dev
, &dev_attr_hddtemp
);
536 goto add_sysfs_error
;
537 err
= device_create_file(&device
->dev
, &dev_attr_als
);
539 goto add_sysfs_error
;
540 err
= device_create_file(&device
->dev
, &dev_attr_dock
);
542 goto add_sysfs_error
;
543 err
= device_create_file(&device
->dev
, &dev_attr_tablet
);
545 goto add_sysfs_error
;
547 if (wireless
& 0x1) {
548 wifi_rfkill
= rfkill_alloc("hp-wifi", &device
->dev
,
551 (void *) HPWMI_WIFI
);
552 rfkill_init_sw_state(wifi_rfkill
,
553 hp_wmi_get_sw_state(HPWMI_WIFI
));
554 rfkill_set_hw_state(wifi_rfkill
,
555 hp_wmi_get_hw_state(HPWMI_WIFI
));
556 err
= rfkill_register(wifi_rfkill
);
558 goto register_wifi_error
;
561 if (wireless
& 0x2) {
562 bluetooth_rfkill
= rfkill_alloc("hp-bluetooth", &device
->dev
,
563 RFKILL_TYPE_BLUETOOTH
,
565 (void *) HPWMI_BLUETOOTH
);
566 rfkill_init_sw_state(bluetooth_rfkill
,
567 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
));
568 rfkill_set_hw_state(bluetooth_rfkill
,
569 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
570 err
= rfkill_register(bluetooth_rfkill
);
572 goto register_bluetooth_error
;
575 if (wireless
& 0x4) {
576 wwan_rfkill
= rfkill_alloc("hp-wwan", &device
->dev
,
579 (void *) HPWMI_WWAN
);
580 rfkill_init_sw_state(wwan_rfkill
,
581 hp_wmi_get_sw_state(HPWMI_WWAN
));
582 rfkill_set_hw_state(wwan_rfkill
,
583 hp_wmi_get_hw_state(HPWMI_WWAN
));
584 err
= rfkill_register(wwan_rfkill
);
586 goto register_wwan_err
;
591 rfkill_destroy(wwan_rfkill
);
592 if (bluetooth_rfkill
)
593 rfkill_unregister(bluetooth_rfkill
);
594 register_bluetooth_error
:
595 rfkill_destroy(bluetooth_rfkill
);
597 rfkill_unregister(wifi_rfkill
);
599 rfkill_destroy(wifi_rfkill
);
601 cleanup_sysfs(device
);
605 static int __exit
hp_wmi_bios_remove(struct platform_device
*device
)
607 cleanup_sysfs(device
);
610 rfkill_unregister(wifi_rfkill
);
611 rfkill_destroy(wifi_rfkill
);
613 if (bluetooth_rfkill
) {
614 rfkill_unregister(bluetooth_rfkill
);
615 rfkill_destroy(bluetooth_rfkill
);
618 rfkill_unregister(wwan_rfkill
);
619 rfkill_destroy(wwan_rfkill
);
625 static int hp_wmi_resume_handler(struct device
*device
)
628 * Hardware state may have changed while suspended, so trigger
629 * input events for the current state. As this is a switch,
630 * the input layer will only actually pass it on if the state
633 if (hp_wmi_input_dev
) {
634 input_report_switch(hp_wmi_input_dev
, SW_DOCK
,
635 hp_wmi_dock_state());
636 input_report_switch(hp_wmi_input_dev
, SW_TABLET_MODE
,
637 hp_wmi_tablet_state());
638 input_sync(hp_wmi_input_dev
);
642 rfkill_set_states(wifi_rfkill
,
643 hp_wmi_get_sw_state(HPWMI_WIFI
),
644 hp_wmi_get_hw_state(HPWMI_WIFI
));
645 if (bluetooth_rfkill
)
646 rfkill_set_states(bluetooth_rfkill
,
647 hp_wmi_get_sw_state(HPWMI_BLUETOOTH
),
648 hp_wmi_get_hw_state(HPWMI_BLUETOOTH
));
650 rfkill_set_states(wwan_rfkill
,
651 hp_wmi_get_sw_state(HPWMI_WWAN
),
652 hp_wmi_get_hw_state(HPWMI_WWAN
));
657 static int __init
hp_wmi_init(void)
660 int event_capable
= wmi_has_guid(HPWMI_EVENT_GUID
);
661 int bios_capable
= wmi_has_guid(HPWMI_BIOS_GUID
);
664 err
= hp_wmi_input_setup();
670 err
= platform_driver_register(&hp_wmi_driver
);
673 hp_wmi_platform_dev
= platform_device_alloc("hp-wmi", -1);
674 if (!hp_wmi_platform_dev
) {
676 goto err_device_alloc
;
678 err
= platform_device_add(hp_wmi_platform_dev
);
683 if (!bios_capable
&& !event_capable
)
689 platform_device_put(hp_wmi_platform_dev
);
691 platform_driver_unregister(&hp_wmi_driver
);
694 hp_wmi_input_destroy();
699 static void __exit
hp_wmi_exit(void)
701 if (wmi_has_guid(HPWMI_EVENT_GUID
))
702 hp_wmi_input_destroy();
704 if (hp_wmi_platform_dev
) {
705 platform_device_unregister(hp_wmi_platform_dev
);
706 platform_driver_unregister(&hp_wmi_driver
);
710 module_init(hp_wmi_init
);
711 module_exit(hp_wmi_exit
);