2 * toshiba_acpi.c - Toshiba Laptop ACPI Extras
5 * Copyright (C) 2002-2004 John Belmonte
6 * Copyright (C) 2008 Philip Langdale
7 * Copyright (C) 2010 Pierre Ducroquet
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * The devolpment page for this driver is located at
25 * http://memebeam.org/toys/ToshibaAcpiDriver.
28 * Jonathan A. Buzzard - Toshiba HCI info, and critical tips on reverse
29 * engineering the Windows drivers
30 * Yasushi Nagato - changes for linux kernel 2.4 -> 2.5
31 * Rob Miller - TV out and hotkeys help
38 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
40 #define TOSHIBA_ACPI_VERSION "0.19"
41 #define PROC_INTERFACE_VERSION 1
43 #include <linux/kernel.h>
44 #include <linux/module.h>
45 #include <linux/init.h>
46 #include <linux/types.h>
47 #include <linux/proc_fs.h>
48 #include <linux/seq_file.h>
49 #include <linux/backlight.h>
50 #include <linux/rfkill.h>
51 #include <linux/input.h>
52 #include <linux/input/sparse-keymap.h>
53 #include <linux/leds.h>
54 #include <linux/slab.h>
55 #include <linux/workqueue.h>
56 #include <linux/i8042.h>
57 #include <linux/acpi.h>
58 #include <asm/uaccess.h>
60 MODULE_AUTHOR("John Belmonte");
61 MODULE_DESCRIPTION("Toshiba Laptop ACPI Extras Driver");
62 MODULE_LICENSE("GPL");
64 #define TOSHIBA_WMI_EVENT_GUID "59142400-C6A3-40FA-BADB-8A2652834100"
66 /* Scan code for Fn key on TOS1900 models */
67 #define TOS1900_FN_SCAN 0x6e
69 /* Toshiba ACPI method paths */
70 #define METHOD_VIDEO_OUT "\\_SB_.VALX.DSSX"
72 /* Toshiba HCI interface definitions
74 * HCI is Toshiba's "Hardware Control Interface" which is supposed to
75 * be uniform across all their models. Ideally we would just call
76 * dedicated ACPI methods instead of using this primitive interface.
77 * However the ACPI methods seem to be incomplete in some areas (for
78 * example they allow setting, but not reading, the LCD brightness value),
79 * so this is still useful.
85 #define HCI_SET 0xff00
86 #define HCI_GET 0xfe00
89 #define HCI_SUCCESS 0x0000
90 #define HCI_FAILURE 0x1000
91 #define HCI_NOT_SUPPORTED 0x8000
92 #define HCI_EMPTY 0x8c00
95 #define HCI_FAN 0x0004
96 #define HCI_TR_BACKLIGHT 0x0005
97 #define HCI_SYSTEM_EVENT 0x0016
98 #define HCI_VIDEO_OUT 0x001c
99 #define HCI_HOTKEY_EVENT 0x001e
100 #define HCI_LCD_BRIGHTNESS 0x002a
101 #define HCI_WIRELESS 0x0056
103 /* field definitions */
104 #define HCI_HOTKEY_DISABLE 0x0b
105 #define HCI_HOTKEY_ENABLE 0x09
106 #define HCI_LCD_BRIGHTNESS_BITS 3
107 #define HCI_LCD_BRIGHTNESS_SHIFT (16-HCI_LCD_BRIGHTNESS_BITS)
108 #define HCI_LCD_BRIGHTNESS_LEVELS (1 << HCI_LCD_BRIGHTNESS_BITS)
109 #define HCI_VIDEO_OUT_LCD 0x1
110 #define HCI_VIDEO_OUT_CRT 0x2
111 #define HCI_VIDEO_OUT_TV 0x4
112 #define HCI_WIRELESS_KILL_SWITCH 0x01
113 #define HCI_WIRELESS_BT_PRESENT 0x0f
114 #define HCI_WIRELESS_BT_ATTACH 0x40
115 #define HCI_WIRELESS_BT_POWER 0x80
117 struct toshiba_acpi_dev {
118 struct acpi_device *acpi_dev;
119 const char *method_hci;
120 struct rfkill *bt_rfk;
121 struct input_dev *hotkey_dev;
122 struct work_struct hotkey_work;
123 struct backlight_device *backlight_dev;
124 struct led_classdev led_dev;
130 unsigned int illumination_supported:1;
131 unsigned int video_supported:1;
132 unsigned int fan_supported:1;
133 unsigned int system_event_supported:1;
134 unsigned int ntfy_supported:1;
135 unsigned int info_supported:1;
136 unsigned int tr_backlight_supported:1;
141 static struct toshiba_acpi_dev *toshiba_acpi;
143 static const struct acpi_device_id toshiba_device_ids[] = {
149 MODULE_DEVICE_TABLE(acpi, toshiba_device_ids);
151 static const struct key_entry toshiba_acpi_keymap[] = {
152 { KE_KEY, 0x101, { KEY_MUTE } },
153 { KE_KEY, 0x102, { KEY_ZOOMOUT } },
154 { KE_KEY, 0x103, { KEY_ZOOMIN } },
155 { KE_KEY, 0x12c, { KEY_KBDILLUMTOGGLE } },
156 { KE_KEY, 0x139, { KEY_ZOOMRESET } },
157 { KE_KEY, 0x13b, { KEY_COFFEE } },
158 { KE_KEY, 0x13c, { KEY_BATTERY } },
159 { KE_KEY, 0x13d, { KEY_SLEEP } },
160 { KE_KEY, 0x13e, { KEY_SUSPEND } },
161 { KE_KEY, 0x13f, { KEY_SWITCHVIDEOMODE } },
162 { KE_KEY, 0x140, { KEY_BRIGHTNESSDOWN } },
163 { KE_KEY, 0x141, { KEY_BRIGHTNESSUP } },
164 { KE_KEY, 0x142, { KEY_WLAN } },
165 { KE_KEY, 0x143, { KEY_TOUCHPAD_TOGGLE } },
166 { KE_KEY, 0x17f, { KEY_FN } },
167 { KE_KEY, 0xb05, { KEY_PROG2 } },
168 { KE_KEY, 0xb06, { KEY_WWW } },
169 { KE_KEY, 0xb07, { KEY_MAIL } },
170 { KE_KEY, 0xb30, { KEY_STOP } },
171 { KE_KEY, 0xb31, { KEY_PREVIOUSSONG } },
172 { KE_KEY, 0xb32, { KEY_NEXTSONG } },
173 { KE_KEY, 0xb33, { KEY_PLAYPAUSE } },
174 { KE_KEY, 0xb5a, { KEY_MEDIA } },
175 { KE_IGNORE, 0x1430, { KEY_RESERVED } },
182 static __inline__ void _set_bit(u32 * word, u32 mask, int value)
184 *word = (*word & ~mask) | (mask * value);
187 /* acpi interface wrappers
190 static int write_acpi_int(const char *methodName, int val)
194 status = acpi_execute_simple_method(NULL, (char *)methodName, val);
195 return (status == AE_OK) ? 0 : -EIO;
198 /* Perform a raw HCI call. Here we don't care about input or output buffer
201 static acpi_status hci_raw(struct toshiba_acpi_dev *dev,
202 const u32 in[HCI_WORDS], u32 out[HCI_WORDS])
204 struct acpi_object_list params;
205 union acpi_object in_objs[HCI_WORDS];
206 struct acpi_buffer results;
207 union acpi_object out_objs[HCI_WORDS + 1];
211 params.count = HCI_WORDS;
212 params.pointer = in_objs;
213 for (i = 0; i < HCI_WORDS; ++i) {
214 in_objs[i].type = ACPI_TYPE_INTEGER;
215 in_objs[i].integer.value = in[i];
218 results.length = sizeof(out_objs);
219 results.pointer = out_objs;
221 status = acpi_evaluate_object(dev->acpi_dev->handle,
222 (char *)dev->method_hci, ¶ms,
224 if ((status == AE_OK) && (out_objs->package.count <= HCI_WORDS)) {
225 for (i = 0; i < out_objs->package.count; ++i) {
226 out[i] = out_objs->package.elements[i].integer.value;
233 /* common hci tasks (get or set one or two value)
235 * In addition to the ACPI status, the HCI system returns a result which
236 * may be useful (such as "not supported").
239 static acpi_status hci_write1(struct toshiba_acpi_dev *dev, u32 reg,
240 u32 in1, u32 *result)
242 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, 0, 0, 0 };
244 acpi_status status = hci_raw(dev, in, out);
245 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
249 static acpi_status hci_read1(struct toshiba_acpi_dev *dev, u32 reg,
250 u32 *out1, u32 *result)
252 u32 in[HCI_WORDS] = { HCI_GET, reg, 0, 0, 0, 0 };
254 acpi_status status = hci_raw(dev, in, out);
256 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
260 static acpi_status hci_write2(struct toshiba_acpi_dev *dev, u32 reg,
261 u32 in1, u32 in2, u32 *result)
263 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, in2, 0, 0 };
265 acpi_status status = hci_raw(dev, in, out);
266 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
270 static acpi_status hci_read2(struct toshiba_acpi_dev *dev, u32 reg,
271 u32 *out1, u32 *out2, u32 *result)
273 u32 in[HCI_WORDS] = { HCI_GET, reg, *out1, *out2, 0, 0 };
275 acpi_status status = hci_raw(dev, in, out);
278 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
282 /* Illumination support */
283 static int toshiba_illumination_available(struct toshiba_acpi_dev *dev)
285 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
290 status = hci_raw(dev, in, out);
291 if (ACPI_FAILURE(status)) {
292 pr_info("Illumination device not available\n");
296 status = hci_raw(dev, in, out);
300 static void toshiba_illumination_set(struct led_classdev *cdev,
301 enum led_brightness brightness)
303 struct toshiba_acpi_dev *dev = container_of(cdev,
304 struct toshiba_acpi_dev, led_dev);
305 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
309 /* First request : initialize communication. */
311 status = hci_raw(dev, in, out);
312 if (ACPI_FAILURE(status)) {
313 pr_info("Illumination device not available\n");
318 /* Switch the illumination on */
322 status = hci_raw(dev, in, out);
323 if (ACPI_FAILURE(status)) {
324 pr_info("ACPI call for illumination failed\n");
328 /* Switch the illumination off */
332 status = hci_raw(dev, in, out);
333 if (ACPI_FAILURE(status)) {
334 pr_info("ACPI call for illumination failed.\n");
339 /* Last request : close communication. */
343 hci_raw(dev, in, out);
346 static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev)
348 struct toshiba_acpi_dev *dev = container_of(cdev,
349 struct toshiba_acpi_dev, led_dev);
350 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
353 enum led_brightness result;
355 /*Â First request : initialize communication. */
357 status = hci_raw(dev, in, out);
358 if (ACPI_FAILURE(status)) {
359 pr_info("Illumination device not available\n");
363 /* Check the illumination */
366 status = hci_raw(dev, in, out);
367 if (ACPI_FAILURE(status)) {
368 pr_info("ACPI call for illumination failed.\n");
372 result = out[2] ? LED_FULL : LED_OFF;
374 /* Last request : close communication. */
378 hci_raw(dev, in, out);
383 /* Bluetooth rfkill handlers */
385 static u32 hci_get_bt_present(struct toshiba_acpi_dev *dev, bool *present)
392 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
393 if (hci_result == HCI_SUCCESS)
394 *present = (value & HCI_WIRELESS_BT_PRESENT) ? true : false;
399 static u32 hci_get_radio_state(struct toshiba_acpi_dev *dev, bool *radio_state)
406 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
408 *radio_state = value & HCI_WIRELESS_KILL_SWITCH;
412 static int bt_rfkill_set_block(void *data, bool blocked)
414 struct toshiba_acpi_dev *dev = data;
415 u32 result1, result2;
420 value = (blocked == false);
422 mutex_lock(&dev->mutex);
423 if (hci_get_radio_state(dev, &radio_state) != HCI_SUCCESS) {
433 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_POWER, &result1);
434 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_ATTACH, &result2);
436 if (result1 != HCI_SUCCESS || result2 != HCI_SUCCESS)
441 mutex_unlock(&dev->mutex);
445 static void bt_rfkill_poll(struct rfkill *rfkill, void *data)
450 struct toshiba_acpi_dev *dev = data;
452 mutex_lock(&dev->mutex);
454 hci_result = hci_get_radio_state(dev, &value);
455 if (hci_result != HCI_SUCCESS) {
456 /* Can't do anything useful */
457 mutex_unlock(&dev->mutex);
461 new_rfk_state = value;
463 mutex_unlock(&dev->mutex);
465 if (rfkill_set_hw_state(rfkill, !new_rfk_state))
466 bt_rfkill_set_block(data, true);
469 static const struct rfkill_ops toshiba_rfk_ops = {
470 .set_block = bt_rfkill_set_block,
471 .poll = bt_rfkill_poll,
474 static int get_tr_backlight_status(struct toshiba_acpi_dev *dev, bool *enabled)
479 hci_read1(dev, HCI_TR_BACKLIGHT, &status, &hci_result);
481 return hci_result == HCI_SUCCESS ? 0 : -EIO;
484 static int set_tr_backlight_status(struct toshiba_acpi_dev *dev, bool enable)
489 hci_write1(dev, HCI_TR_BACKLIGHT, value, &hci_result);
490 return hci_result == HCI_SUCCESS ? 0 : -EIO;
493 static struct proc_dir_entry *toshiba_proc_dir /*= 0*/ ;
495 static int __get_lcd_brightness(struct toshiba_acpi_dev *dev)
501 if (dev->tr_backlight_supported) {
503 int ret = get_tr_backlight_status(dev, &enabled);
511 hci_read1(dev, HCI_LCD_BRIGHTNESS, &value, &hci_result);
512 if (hci_result == HCI_SUCCESS)
513 return brightness + (value >> HCI_LCD_BRIGHTNESS_SHIFT);
518 static int get_lcd_brightness(struct backlight_device *bd)
520 struct toshiba_acpi_dev *dev = bl_get_data(bd);
521 return __get_lcd_brightness(dev);
524 static int lcd_proc_show(struct seq_file *m, void *v)
526 struct toshiba_acpi_dev *dev = m->private;
530 if (!dev->backlight_dev)
533 levels = dev->backlight_dev->props.max_brightness + 1;
534 value = get_lcd_brightness(dev->backlight_dev);
536 seq_printf(m, "brightness: %d\n", value);
537 seq_printf(m, "brightness_levels: %d\n", levels);
541 pr_err("Error reading LCD brightness\n");
545 static int lcd_proc_open(struct inode *inode, struct file *file)
547 return single_open(file, lcd_proc_show, PDE_DATA(inode));
550 static int set_lcd_brightness(struct toshiba_acpi_dev *dev, int value)
554 if (dev->tr_backlight_supported) {
555 bool enable = !value;
556 int ret = set_tr_backlight_status(dev, enable);
563 value = value << HCI_LCD_BRIGHTNESS_SHIFT;
564 hci_write1(dev, HCI_LCD_BRIGHTNESS, value, &hci_result);
565 return hci_result == HCI_SUCCESS ? 0 : -EIO;
568 static int set_lcd_status(struct backlight_device *bd)
570 struct toshiba_acpi_dev *dev = bl_get_data(bd);
571 return set_lcd_brightness(dev, bd->props.brightness);
574 static ssize_t lcd_proc_write(struct file *file, const char __user *buf,
575 size_t count, loff_t *pos)
577 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
582 int levels = dev->backlight_dev->props.max_brightness + 1;
584 len = min(count, sizeof(cmd) - 1);
585 if (copy_from_user(cmd, buf, len))
589 if (sscanf(cmd, " brightness : %i", &value) == 1 &&
590 value >= 0 && value < levels) {
591 ret = set_lcd_brightness(dev, value);
600 static const struct file_operations lcd_proc_fops = {
601 .owner = THIS_MODULE,
602 .open = lcd_proc_open,
605 .release = single_release,
606 .write = lcd_proc_write,
609 static int get_video_status(struct toshiba_acpi_dev *dev, u32 *status)
613 hci_read1(dev, HCI_VIDEO_OUT, status, &hci_result);
614 return hci_result == HCI_SUCCESS ? 0 : -EIO;
617 static int video_proc_show(struct seq_file *m, void *v)
619 struct toshiba_acpi_dev *dev = m->private;
623 ret = get_video_status(dev, &value);
625 int is_lcd = (value & HCI_VIDEO_OUT_LCD) ? 1 : 0;
626 int is_crt = (value & HCI_VIDEO_OUT_CRT) ? 1 : 0;
627 int is_tv = (value & HCI_VIDEO_OUT_TV) ? 1 : 0;
628 seq_printf(m, "lcd_out: %d\n", is_lcd);
629 seq_printf(m, "crt_out: %d\n", is_crt);
630 seq_printf(m, "tv_out: %d\n", is_tv);
636 static int video_proc_open(struct inode *inode, struct file *file)
638 return single_open(file, video_proc_show, PDE_DATA(inode));
641 static ssize_t video_proc_write(struct file *file, const char __user *buf,
642 size_t count, loff_t *pos)
644 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
654 cmd = kmalloc(count + 1, GFP_KERNEL);
657 if (copy_from_user(cmd, buf, count)) {
665 /* scan expression. Multiple expressions may be delimited with ;
667 * NOTE: to keep scanning simple, invalid fields are ignored
670 if (sscanf(buffer, " lcd_out : %i", &value) == 1)
672 else if (sscanf(buffer, " crt_out : %i", &value) == 1)
674 else if (sscanf(buffer, " tv_out : %i", &value) == 1)
676 /* advance to one character past the next ; */
681 while (remain && *(buffer - 1) != ';');
686 ret = get_video_status(dev, &video_out);
688 unsigned int new_video_out = video_out;
690 _set_bit(&new_video_out, HCI_VIDEO_OUT_LCD, lcd_out);
692 _set_bit(&new_video_out, HCI_VIDEO_OUT_CRT, crt_out);
694 _set_bit(&new_video_out, HCI_VIDEO_OUT_TV, tv_out);
695 /* To avoid unnecessary video disruption, only write the new
696 * video setting if something changed. */
697 if (new_video_out != video_out)
698 ret = write_acpi_int(METHOD_VIDEO_OUT, new_video_out);
701 return ret ? ret : count;
704 static const struct file_operations video_proc_fops = {
705 .owner = THIS_MODULE,
706 .open = video_proc_open,
709 .release = single_release,
710 .write = video_proc_write,
713 static int get_fan_status(struct toshiba_acpi_dev *dev, u32 *status)
717 hci_read1(dev, HCI_FAN, status, &hci_result);
718 return hci_result == HCI_SUCCESS ? 0 : -EIO;
721 static int fan_proc_show(struct seq_file *m, void *v)
723 struct toshiba_acpi_dev *dev = m->private;
727 ret = get_fan_status(dev, &value);
729 seq_printf(m, "running: %d\n", (value > 0));
730 seq_printf(m, "force_on: %d\n", dev->force_fan);
736 static int fan_proc_open(struct inode *inode, struct file *file)
738 return single_open(file, fan_proc_show, PDE_DATA(inode));
741 static ssize_t fan_proc_write(struct file *file, const char __user *buf,
742 size_t count, loff_t *pos)
744 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
750 len = min(count, sizeof(cmd) - 1);
751 if (copy_from_user(cmd, buf, len))
755 if (sscanf(cmd, " force_on : %i", &value) == 1 &&
756 value >= 0 && value <= 1) {
757 hci_write1(dev, HCI_FAN, value, &hci_result);
758 if (hci_result != HCI_SUCCESS)
761 dev->force_fan = value;
769 static const struct file_operations fan_proc_fops = {
770 .owner = THIS_MODULE,
771 .open = fan_proc_open,
774 .release = single_release,
775 .write = fan_proc_write,
778 static int keys_proc_show(struct seq_file *m, void *v)
780 struct toshiba_acpi_dev *dev = m->private;
784 if (!dev->key_event_valid && dev->system_event_supported) {
785 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
786 if (hci_result == HCI_SUCCESS) {
787 dev->key_event_valid = 1;
788 dev->last_key_event = value;
789 } else if (hci_result == HCI_EMPTY) {
790 /* better luck next time */
791 } else if (hci_result == HCI_NOT_SUPPORTED) {
792 /* This is a workaround for an unresolved issue on
793 * some machines where system events sporadically
794 * become disabled. */
795 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
796 pr_notice("Re-enabled hotkeys\n");
798 pr_err("Error reading hotkey status\n");
803 seq_printf(m, "hotkey_ready: %d\n", dev->key_event_valid);
804 seq_printf(m, "hotkey: 0x%04x\n", dev->last_key_event);
808 static int keys_proc_open(struct inode *inode, struct file *file)
810 return single_open(file, keys_proc_show, PDE_DATA(inode));
813 static ssize_t keys_proc_write(struct file *file, const char __user *buf,
814 size_t count, loff_t *pos)
816 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
821 len = min(count, sizeof(cmd) - 1);
822 if (copy_from_user(cmd, buf, len))
826 if (sscanf(cmd, " hotkey_ready : %i", &value) == 1 && value == 0) {
827 dev->key_event_valid = 0;
835 static const struct file_operations keys_proc_fops = {
836 .owner = THIS_MODULE,
837 .open = keys_proc_open,
840 .release = single_release,
841 .write = keys_proc_write,
844 static int version_proc_show(struct seq_file *m, void *v)
846 seq_printf(m, "driver: %s\n", TOSHIBA_ACPI_VERSION);
847 seq_printf(m, "proc_interface: %d\n", PROC_INTERFACE_VERSION);
851 static int version_proc_open(struct inode *inode, struct file *file)
853 return single_open(file, version_proc_show, PDE_DATA(inode));
856 static const struct file_operations version_proc_fops = {
857 .owner = THIS_MODULE,
858 .open = version_proc_open,
861 .release = single_release,
864 /* proc and module init
867 #define PROC_TOSHIBA "toshiba"
869 static void create_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
871 if (dev->backlight_dev)
872 proc_create_data("lcd", S_IRUGO | S_IWUSR, toshiba_proc_dir,
873 &lcd_proc_fops, dev);
874 if (dev->video_supported)
875 proc_create_data("video", S_IRUGO | S_IWUSR, toshiba_proc_dir,
876 &video_proc_fops, dev);
877 if (dev->fan_supported)
878 proc_create_data("fan", S_IRUGO | S_IWUSR, toshiba_proc_dir,
879 &fan_proc_fops, dev);
881 proc_create_data("keys", S_IRUGO | S_IWUSR, toshiba_proc_dir,
882 &keys_proc_fops, dev);
883 proc_create_data("version", S_IRUGO, toshiba_proc_dir,
884 &version_proc_fops, dev);
887 static void remove_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
889 if (dev->backlight_dev)
890 remove_proc_entry("lcd", toshiba_proc_dir);
891 if (dev->video_supported)
892 remove_proc_entry("video", toshiba_proc_dir);
893 if (dev->fan_supported)
894 remove_proc_entry("fan", toshiba_proc_dir);
896 remove_proc_entry("keys", toshiba_proc_dir);
897 remove_proc_entry("version", toshiba_proc_dir);
900 static const struct backlight_ops toshiba_backlight_data = {
901 .options = BL_CORE_SUSPENDRESUME,
902 .get_brightness = get_lcd_brightness,
903 .update_status = set_lcd_status,
906 static bool toshiba_acpi_i8042_filter(unsigned char data, unsigned char str,
912 if (unlikely(data == 0xe0))
915 if ((data & 0x7f) == TOS1900_FN_SCAN) {
916 schedule_work(&toshiba_acpi->hotkey_work);
923 static void toshiba_acpi_hotkey_work(struct work_struct *work)
925 acpi_handle ec_handle = ec_get_handle();
931 status = acpi_evaluate_object(ec_handle, "NTFY", NULL, NULL);
932 if (ACPI_FAILURE(status))
933 pr_err("ACPI NTFY method execution failed\n");
937 * Returns hotkey scancode, or < 0 on failure.
939 static int toshiba_acpi_query_hotkey(struct toshiba_acpi_dev *dev)
941 unsigned long long value;
944 status = acpi_evaluate_integer(dev->acpi_dev->handle, "INFO",
946 if (ACPI_FAILURE(status)) {
947 pr_err("ACPI INFO method execution failed\n");
954 static void toshiba_acpi_report_hotkey(struct toshiba_acpi_dev *dev,
957 if (scancode == 0x100)
960 /* act on key press; ignore key release */
964 if (!sparse_keymap_report_event(dev->hotkey_dev, scancode, 1, true))
965 pr_info("Unknown key %x\n", scancode);
968 static int toshiba_acpi_setup_keyboard(struct toshiba_acpi_dev *dev)
971 acpi_handle ec_handle;
975 dev->hotkey_dev = input_allocate_device();
976 if (!dev->hotkey_dev)
979 dev->hotkey_dev->name = "Toshiba input device";
980 dev->hotkey_dev->phys = "toshiba_acpi/input0";
981 dev->hotkey_dev->id.bustype = BUS_HOST;
983 error = sparse_keymap_setup(dev->hotkey_dev, toshiba_acpi_keymap, NULL);
988 * For some machines the SCI responsible for providing hotkey
989 * notification doesn't fire. We can trigger the notification
990 * whenever the Fn key is pressed using the NTFY method, if
991 * supported, so if it's present set up an i8042 key filter
995 ec_handle = ec_get_handle();
996 if (ec_handle && acpi_has_method(ec_handle, "NTFY")) {
997 INIT_WORK(&dev->hotkey_work, toshiba_acpi_hotkey_work);
999 error = i8042_install_filter(toshiba_acpi_i8042_filter);
1001 pr_err("Error installing key filter\n");
1002 goto err_free_keymap;
1005 dev->ntfy_supported = 1;
1009 * Determine hotkey query interface. Prefer using the INFO
1010 * method when it is available.
1012 if (acpi_has_method(dev->acpi_dev->handle, "INFO"))
1013 dev->info_supported = 1;
1015 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
1016 if (hci_result == HCI_SUCCESS)
1017 dev->system_event_supported = 1;
1020 if (!dev->info_supported && !dev->system_event_supported) {
1021 pr_warn("No hotkey query interface found\n");
1022 goto err_remove_filter;
1025 status = acpi_evaluate_object(dev->acpi_dev->handle, "ENAB", NULL, NULL);
1026 if (ACPI_FAILURE(status)) {
1027 pr_info("Unable to enable hotkeys\n");
1029 goto err_remove_filter;
1032 error = input_register_device(dev->hotkey_dev);
1034 pr_info("Unable to register input device\n");
1035 goto err_remove_filter;
1038 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &hci_result);
1042 if (dev->ntfy_supported)
1043 i8042_remove_filter(toshiba_acpi_i8042_filter);
1045 sparse_keymap_free(dev->hotkey_dev);
1047 input_free_device(dev->hotkey_dev);
1048 dev->hotkey_dev = NULL;
1052 static int toshiba_acpi_setup_backlight(struct toshiba_acpi_dev *dev)
1054 struct backlight_properties props;
1060 * Some machines don't support the backlight methods at all, and
1061 * others support it read-only. Either of these is pretty useless,
1062 * so only register the backlight device if the backlight method
1063 * supports both reads and writes.
1065 brightness = __get_lcd_brightness(dev);
1068 ret = set_lcd_brightness(dev, brightness);
1070 pr_debug("Backlight method is read-only, disabling backlight support\n");
1074 /* Determine whether or not BIOS supports transflective backlight */
1075 ret = get_tr_backlight_status(dev, &enabled);
1076 dev->tr_backlight_supported = !ret;
1078 memset(&props, 0, sizeof(props));
1079 props.type = BACKLIGHT_PLATFORM;
1080 props.max_brightness = HCI_LCD_BRIGHTNESS_LEVELS - 1;
1082 /* adding an extra level and having 0 change to transflective mode */
1083 if (dev->tr_backlight_supported)
1084 props.max_brightness++;
1086 dev->backlight_dev = backlight_device_register("toshiba",
1087 &dev->acpi_dev->dev,
1089 &toshiba_backlight_data,
1091 if (IS_ERR(dev->backlight_dev)) {
1092 ret = PTR_ERR(dev->backlight_dev);
1093 pr_err("Could not register toshiba backlight device\n");
1094 dev->backlight_dev = NULL;
1098 dev->backlight_dev->props.brightness = brightness;
1102 static int toshiba_acpi_remove(struct acpi_device *acpi_dev)
1104 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1106 remove_toshiba_proc_entries(dev);
1108 if (dev->ntfy_supported) {
1109 i8042_remove_filter(toshiba_acpi_i8042_filter);
1110 cancel_work_sync(&dev->hotkey_work);
1113 if (dev->hotkey_dev) {
1114 input_unregister_device(dev->hotkey_dev);
1115 sparse_keymap_free(dev->hotkey_dev);
1119 rfkill_unregister(dev->bt_rfk);
1120 rfkill_destroy(dev->bt_rfk);
1123 if (dev->backlight_dev)
1124 backlight_device_unregister(dev->backlight_dev);
1126 if (dev->illumination_supported)
1127 led_classdev_unregister(&dev->led_dev);
1130 toshiba_acpi = NULL;
1137 static const char *find_hci_method(acpi_handle handle)
1139 if (acpi_has_method(handle, "GHCI"))
1142 if (acpi_has_method(handle, "SPFC"))
1148 static int toshiba_acpi_add(struct acpi_device *acpi_dev)
1150 struct toshiba_acpi_dev *dev;
1151 const char *hci_method;
1159 pr_info("Toshiba Laptop ACPI Extras version %s\n",
1160 TOSHIBA_ACPI_VERSION);
1162 hci_method = find_hci_method(acpi_dev->handle);
1164 pr_err("HCI interface not found\n");
1168 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1171 dev->acpi_dev = acpi_dev;
1172 dev->method_hci = hci_method;
1173 acpi_dev->driver_data = dev;
1175 if (toshiba_acpi_setup_keyboard(dev))
1176 pr_info("Unable to activate hotkeys\n");
1178 mutex_init(&dev->mutex);
1180 ret = toshiba_acpi_setup_backlight(dev);
1184 /* Register rfkill switch for Bluetooth */
1185 if (hci_get_bt_present(dev, &bt_present) == HCI_SUCCESS && bt_present) {
1186 dev->bt_rfk = rfkill_alloc("Toshiba Bluetooth",
1188 RFKILL_TYPE_BLUETOOTH,
1192 pr_err("unable to allocate rfkill device\n");
1197 ret = rfkill_register(dev->bt_rfk);
1199 pr_err("unable to register rfkill device\n");
1200 rfkill_destroy(dev->bt_rfk);
1205 if (toshiba_illumination_available(dev)) {
1206 dev->led_dev.name = "toshiba::illumination";
1207 dev->led_dev.max_brightness = 1;
1208 dev->led_dev.brightness_set = toshiba_illumination_set;
1209 dev->led_dev.brightness_get = toshiba_illumination_get;
1210 if (!led_classdev_register(&acpi_dev->dev, &dev->led_dev))
1211 dev->illumination_supported = 1;
1214 /* Determine whether or not BIOS supports fan and video interfaces */
1216 ret = get_video_status(dev, &dummy);
1217 dev->video_supported = !ret;
1219 ret = get_fan_status(dev, &dummy);
1220 dev->fan_supported = !ret;
1222 create_toshiba_proc_entries(dev);
1229 toshiba_acpi_remove(acpi_dev);
1233 static void toshiba_acpi_notify(struct acpi_device *acpi_dev, u32 event)
1235 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1236 u32 hci_result, value;
1243 if (dev->info_supported) {
1244 scancode = toshiba_acpi_query_hotkey(dev);
1246 pr_err("Failed to query hotkey event\n");
1247 else if (scancode != 0)
1248 toshiba_acpi_report_hotkey(dev, scancode);
1249 } else if (dev->system_event_supported) {
1251 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
1252 switch (hci_result) {
1254 toshiba_acpi_report_hotkey(dev, (int)value);
1256 case HCI_NOT_SUPPORTED:
1258 * This is a workaround for an unresolved
1259 * issue on some machines where system events
1260 * sporadically become disabled.
1262 hci_write1(dev, HCI_SYSTEM_EVENT, 1,
1264 pr_notice("Re-enabled hotkeys\n");
1270 } while (retries && hci_result != HCI_EMPTY);
1274 #ifdef CONFIG_PM_SLEEP
1275 static int toshiba_acpi_suspend(struct device *device)
1277 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1280 if (dev->hotkey_dev)
1281 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_DISABLE, &result);
1286 static int toshiba_acpi_resume(struct device *device)
1288 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1291 if (dev->hotkey_dev)
1292 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &result);
1298 static SIMPLE_DEV_PM_OPS(toshiba_acpi_pm,
1299 toshiba_acpi_suspend, toshiba_acpi_resume);
1301 static struct acpi_driver toshiba_acpi_driver = {
1302 .name = "Toshiba ACPI driver",
1303 .owner = THIS_MODULE,
1304 .ids = toshiba_device_ids,
1305 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1307 .add = toshiba_acpi_add,
1308 .remove = toshiba_acpi_remove,
1309 .notify = toshiba_acpi_notify,
1311 .drv.pm = &toshiba_acpi_pm,
1314 static int __init toshiba_acpi_init(void)
1319 * Machines with this WMI guid aren't supported due to bugs in
1320 * their AML. This check relies on wmi initializing before
1321 * toshiba_acpi to guarantee guids have been identified.
1323 if (wmi_has_guid(TOSHIBA_WMI_EVENT_GUID))
1326 toshiba_proc_dir = proc_mkdir(PROC_TOSHIBA, acpi_root_dir);
1327 if (!toshiba_proc_dir) {
1328 pr_err("Unable to create proc dir " PROC_TOSHIBA "\n");
1332 ret = acpi_bus_register_driver(&toshiba_acpi_driver);
1334 pr_err("Failed to register ACPI driver: %d\n", ret);
1335 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1341 static void __exit toshiba_acpi_exit(void)
1343 acpi_bus_unregister_driver(&toshiba_acpi_driver);
1344 if (toshiba_proc_dir)
1345 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1348 module_init(toshiba_acpi_init);
1349 module_exit(toshiba_acpi_exit);