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>
58 #include <asm/uaccess.h>
60 #include <acpi/acpi_drivers.h>
62 MODULE_AUTHOR("John Belmonte");
63 MODULE_DESCRIPTION("Toshiba Laptop ACPI Extras Driver");
64 MODULE_LICENSE("GPL");
66 #define TOSHIBA_WMI_EVENT_GUID "59142400-C6A3-40FA-BADB-8A2652834100"
68 /* Scan code for Fn key on TOS1900 models */
69 #define TOS1900_FN_SCAN 0x6e
71 /* Toshiba ACPI method paths */
72 #define METHOD_VIDEO_OUT "\\_SB_.VALX.DSSX"
74 /* Toshiba HCI interface definitions
76 * HCI is Toshiba's "Hardware Control Interface" which is supposed to
77 * be uniform across all their models. Ideally we would just call
78 * dedicated ACPI methods instead of using this primitive interface.
79 * However the ACPI methods seem to be incomplete in some areas (for
80 * example they allow setting, but not reading, the LCD brightness value),
81 * so this is still useful.
87 #define HCI_SET 0xff00
88 #define HCI_GET 0xfe00
91 #define HCI_SUCCESS 0x0000
92 #define HCI_FAILURE 0x1000
93 #define HCI_NOT_SUPPORTED 0x8000
94 #define HCI_EMPTY 0x8c00
97 #define HCI_FAN 0x0004
98 #define HCI_TR_BACKLIGHT 0x0005
99 #define HCI_SYSTEM_EVENT 0x0016
100 #define HCI_VIDEO_OUT 0x001c
101 #define HCI_HOTKEY_EVENT 0x001e
102 #define HCI_LCD_BRIGHTNESS 0x002a
103 #define HCI_WIRELESS 0x0056
105 /* field definitions */
106 #define HCI_HOTKEY_DISABLE 0x0b
107 #define HCI_HOTKEY_ENABLE 0x09
108 #define HCI_LCD_BRIGHTNESS_BITS 3
109 #define HCI_LCD_BRIGHTNESS_SHIFT (16-HCI_LCD_BRIGHTNESS_BITS)
110 #define HCI_LCD_BRIGHTNESS_LEVELS (1 << HCI_LCD_BRIGHTNESS_BITS)
111 #define HCI_VIDEO_OUT_LCD 0x1
112 #define HCI_VIDEO_OUT_CRT 0x2
113 #define HCI_VIDEO_OUT_TV 0x4
114 #define HCI_WIRELESS_KILL_SWITCH 0x01
115 #define HCI_WIRELESS_BT_PRESENT 0x0f
116 #define HCI_WIRELESS_BT_ATTACH 0x40
117 #define HCI_WIRELESS_BT_POWER 0x80
119 struct toshiba_acpi_dev {
120 struct acpi_device *acpi_dev;
121 const char *method_hci;
122 struct rfkill *bt_rfk;
123 struct input_dev *hotkey_dev;
124 struct work_struct hotkey_work;
125 struct backlight_device *backlight_dev;
126 struct led_classdev led_dev;
132 unsigned int illumination_supported:1;
133 unsigned int video_supported:1;
134 unsigned int fan_supported:1;
135 unsigned int system_event_supported:1;
136 unsigned int ntfy_supported:1;
137 unsigned int info_supported:1;
138 unsigned int tr_backlight_supported:1;
143 static struct toshiba_acpi_dev *toshiba_acpi;
145 static const struct acpi_device_id toshiba_device_ids[] = {
151 MODULE_DEVICE_TABLE(acpi, toshiba_device_ids);
153 static const struct key_entry toshiba_acpi_keymap[] = {
154 { KE_KEY, 0x101, { KEY_MUTE } },
155 { KE_KEY, 0x102, { KEY_ZOOMOUT } },
156 { KE_KEY, 0x103, { KEY_ZOOMIN } },
157 { KE_KEY, 0x12c, { KEY_KBDILLUMTOGGLE } },
158 { KE_KEY, 0x139, { KEY_ZOOMRESET } },
159 { KE_KEY, 0x13b, { KEY_COFFEE } },
160 { KE_KEY, 0x13c, { KEY_BATTERY } },
161 { KE_KEY, 0x13d, { KEY_SLEEP } },
162 { KE_KEY, 0x13e, { KEY_SUSPEND } },
163 { KE_KEY, 0x13f, { KEY_SWITCHVIDEOMODE } },
164 { KE_KEY, 0x140, { KEY_BRIGHTNESSDOWN } },
165 { KE_KEY, 0x141, { KEY_BRIGHTNESSUP } },
166 { KE_KEY, 0x142, { KEY_WLAN } },
167 { KE_KEY, 0x143, { KEY_TOUCHPAD_TOGGLE } },
168 { KE_KEY, 0x17f, { KEY_FN } },
169 { KE_KEY, 0xb05, { KEY_PROG2 } },
170 { KE_KEY, 0xb06, { KEY_WWW } },
171 { KE_KEY, 0xb07, { KEY_MAIL } },
172 { KE_KEY, 0xb30, { KEY_STOP } },
173 { KE_KEY, 0xb31, { KEY_PREVIOUSSONG } },
174 { KE_KEY, 0xb32, { KEY_NEXTSONG } },
175 { KE_KEY, 0xb33, { KEY_PLAYPAUSE } },
176 { KE_KEY, 0xb5a, { KEY_MEDIA } },
177 { KE_IGNORE, 0x1430, { KEY_RESERVED } },
184 static __inline__ void _set_bit(u32 * word, u32 mask, int value)
186 *word = (*word & ~mask) | (mask * value);
189 /* acpi interface wrappers
192 static int write_acpi_int(const char *methodName, int val)
196 status = acpi_execute_simple_method(NULL, (char *)methodName, val);
197 return (status == AE_OK) ? 0 : -EIO;
200 /* Perform a raw HCI call. Here we don't care about input or output buffer
203 static acpi_status hci_raw(struct toshiba_acpi_dev *dev,
204 const u32 in[HCI_WORDS], u32 out[HCI_WORDS])
206 struct acpi_object_list params;
207 union acpi_object in_objs[HCI_WORDS];
208 struct acpi_buffer results;
209 union acpi_object out_objs[HCI_WORDS + 1];
213 params.count = HCI_WORDS;
214 params.pointer = in_objs;
215 for (i = 0; i < HCI_WORDS; ++i) {
216 in_objs[i].type = ACPI_TYPE_INTEGER;
217 in_objs[i].integer.value = in[i];
220 results.length = sizeof(out_objs);
221 results.pointer = out_objs;
223 status = acpi_evaluate_object(dev->acpi_dev->handle,
224 (char *)dev->method_hci, ¶ms,
226 if ((status == AE_OK) && (out_objs->package.count <= HCI_WORDS)) {
227 for (i = 0; i < out_objs->package.count; ++i) {
228 out[i] = out_objs->package.elements[i].integer.value;
235 /* common hci tasks (get or set one or two value)
237 * In addition to the ACPI status, the HCI system returns a result which
238 * may be useful (such as "not supported").
241 static acpi_status hci_write1(struct toshiba_acpi_dev *dev, u32 reg,
242 u32 in1, u32 *result)
244 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, 0, 0, 0 };
246 acpi_status status = hci_raw(dev, in, out);
247 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
251 static acpi_status hci_read1(struct toshiba_acpi_dev *dev, u32 reg,
252 u32 *out1, u32 *result)
254 u32 in[HCI_WORDS] = { HCI_GET, reg, 0, 0, 0, 0 };
256 acpi_status status = hci_raw(dev, in, out);
258 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
262 static acpi_status hci_write2(struct toshiba_acpi_dev *dev, u32 reg,
263 u32 in1, u32 in2, u32 *result)
265 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, in2, 0, 0 };
267 acpi_status status = hci_raw(dev, in, out);
268 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
272 static acpi_status hci_read2(struct toshiba_acpi_dev *dev, u32 reg,
273 u32 *out1, u32 *out2, u32 *result)
275 u32 in[HCI_WORDS] = { HCI_GET, reg, *out1, *out2, 0, 0 };
277 acpi_status status = hci_raw(dev, in, out);
280 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
284 /* Illumination support */
285 static int toshiba_illumination_available(struct toshiba_acpi_dev *dev)
287 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
292 status = hci_raw(dev, in, out);
293 if (ACPI_FAILURE(status)) {
294 pr_info("Illumination device not available\n");
298 status = hci_raw(dev, in, out);
302 static void toshiba_illumination_set(struct led_classdev *cdev,
303 enum led_brightness brightness)
305 struct toshiba_acpi_dev *dev = container_of(cdev,
306 struct toshiba_acpi_dev, led_dev);
307 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
311 /* First request : initialize communication. */
313 status = hci_raw(dev, in, out);
314 if (ACPI_FAILURE(status)) {
315 pr_info("Illumination device not available\n");
320 /* Switch the illumination on */
324 status = hci_raw(dev, in, out);
325 if (ACPI_FAILURE(status)) {
326 pr_info("ACPI call for illumination failed\n");
330 /* Switch the illumination off */
334 status = hci_raw(dev, in, out);
335 if (ACPI_FAILURE(status)) {
336 pr_info("ACPI call for illumination failed.\n");
341 /* Last request : close communication. */
345 hci_raw(dev, in, out);
348 static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev)
350 struct toshiba_acpi_dev *dev = container_of(cdev,
351 struct toshiba_acpi_dev, led_dev);
352 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
355 enum led_brightness result;
357 /*Â First request : initialize communication. */
359 status = hci_raw(dev, in, out);
360 if (ACPI_FAILURE(status)) {
361 pr_info("Illumination device not available\n");
365 /* Check the illumination */
368 status = hci_raw(dev, in, out);
369 if (ACPI_FAILURE(status)) {
370 pr_info("ACPI call for illumination failed.\n");
374 result = out[2] ? LED_FULL : LED_OFF;
376 /* Last request : close communication. */
380 hci_raw(dev, in, out);
385 /* Bluetooth rfkill handlers */
387 static u32 hci_get_bt_present(struct toshiba_acpi_dev *dev, bool *present)
394 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
395 if (hci_result == HCI_SUCCESS)
396 *present = (value & HCI_WIRELESS_BT_PRESENT) ? true : false;
401 static u32 hci_get_radio_state(struct toshiba_acpi_dev *dev, bool *radio_state)
408 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
410 *radio_state = value & HCI_WIRELESS_KILL_SWITCH;
414 static int bt_rfkill_set_block(void *data, bool blocked)
416 struct toshiba_acpi_dev *dev = data;
417 u32 result1, result2;
422 value = (blocked == false);
424 mutex_lock(&dev->mutex);
425 if (hci_get_radio_state(dev, &radio_state) != HCI_SUCCESS) {
435 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_POWER, &result1);
436 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_ATTACH, &result2);
438 if (result1 != HCI_SUCCESS || result2 != HCI_SUCCESS)
443 mutex_unlock(&dev->mutex);
447 static void bt_rfkill_poll(struct rfkill *rfkill, void *data)
452 struct toshiba_acpi_dev *dev = data;
454 mutex_lock(&dev->mutex);
456 hci_result = hci_get_radio_state(dev, &value);
457 if (hci_result != HCI_SUCCESS) {
458 /* Can't do anything useful */
459 mutex_unlock(&dev->mutex);
463 new_rfk_state = value;
465 mutex_unlock(&dev->mutex);
467 if (rfkill_set_hw_state(rfkill, !new_rfk_state))
468 bt_rfkill_set_block(data, true);
471 static const struct rfkill_ops toshiba_rfk_ops = {
472 .set_block = bt_rfkill_set_block,
473 .poll = bt_rfkill_poll,
476 static int get_tr_backlight_status(struct toshiba_acpi_dev *dev, bool *enabled)
481 hci_read1(dev, HCI_TR_BACKLIGHT, &status, &hci_result);
483 return hci_result == HCI_SUCCESS ? 0 : -EIO;
486 static int set_tr_backlight_status(struct toshiba_acpi_dev *dev, bool enable)
491 hci_write1(dev, HCI_TR_BACKLIGHT, value, &hci_result);
492 return hci_result == HCI_SUCCESS ? 0 : -EIO;
495 static struct proc_dir_entry *toshiba_proc_dir /*= 0*/ ;
497 static int __get_lcd_brightness(struct toshiba_acpi_dev *dev)
503 if (dev->tr_backlight_supported) {
505 int ret = get_tr_backlight_status(dev, &enabled);
513 hci_read1(dev, HCI_LCD_BRIGHTNESS, &value, &hci_result);
514 if (hci_result == HCI_SUCCESS)
515 return brightness + (value >> HCI_LCD_BRIGHTNESS_SHIFT);
520 static int get_lcd_brightness(struct backlight_device *bd)
522 struct toshiba_acpi_dev *dev = bl_get_data(bd);
523 return __get_lcd_brightness(dev);
526 static int lcd_proc_show(struct seq_file *m, void *v)
528 struct toshiba_acpi_dev *dev = m->private;
532 if (!dev->backlight_dev)
535 levels = dev->backlight_dev->props.max_brightness + 1;
536 value = get_lcd_brightness(dev->backlight_dev);
538 seq_printf(m, "brightness: %d\n", value);
539 seq_printf(m, "brightness_levels: %d\n", levels);
543 pr_err("Error reading LCD brightness\n");
547 static int lcd_proc_open(struct inode *inode, struct file *file)
549 return single_open(file, lcd_proc_show, PDE_DATA(inode));
552 static int set_lcd_brightness(struct toshiba_acpi_dev *dev, int value)
556 if (dev->tr_backlight_supported) {
557 bool enable = !value;
558 int ret = set_tr_backlight_status(dev, enable);
565 value = value << HCI_LCD_BRIGHTNESS_SHIFT;
566 hci_write1(dev, HCI_LCD_BRIGHTNESS, value, &hci_result);
567 return hci_result == HCI_SUCCESS ? 0 : -EIO;
570 static int set_lcd_status(struct backlight_device *bd)
572 struct toshiba_acpi_dev *dev = bl_get_data(bd);
573 return set_lcd_brightness(dev, bd->props.brightness);
576 static ssize_t lcd_proc_write(struct file *file, const char __user *buf,
577 size_t count, loff_t *pos)
579 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
584 int levels = dev->backlight_dev->props.max_brightness + 1;
586 len = min(count, sizeof(cmd) - 1);
587 if (copy_from_user(cmd, buf, len))
591 if (sscanf(cmd, " brightness : %i", &value) == 1 &&
592 value >= 0 && value < levels) {
593 ret = set_lcd_brightness(dev, value);
602 static const struct file_operations lcd_proc_fops = {
603 .owner = THIS_MODULE,
604 .open = lcd_proc_open,
607 .release = single_release,
608 .write = lcd_proc_write,
611 static int get_video_status(struct toshiba_acpi_dev *dev, u32 *status)
615 hci_read1(dev, HCI_VIDEO_OUT, status, &hci_result);
616 return hci_result == HCI_SUCCESS ? 0 : -EIO;
619 static int video_proc_show(struct seq_file *m, void *v)
621 struct toshiba_acpi_dev *dev = m->private;
625 ret = get_video_status(dev, &value);
627 int is_lcd = (value & HCI_VIDEO_OUT_LCD) ? 1 : 0;
628 int is_crt = (value & HCI_VIDEO_OUT_CRT) ? 1 : 0;
629 int is_tv = (value & HCI_VIDEO_OUT_TV) ? 1 : 0;
630 seq_printf(m, "lcd_out: %d\n", is_lcd);
631 seq_printf(m, "crt_out: %d\n", is_crt);
632 seq_printf(m, "tv_out: %d\n", is_tv);
638 static int video_proc_open(struct inode *inode, struct file *file)
640 return single_open(file, video_proc_show, PDE_DATA(inode));
643 static ssize_t video_proc_write(struct file *file, const char __user *buf,
644 size_t count, loff_t *pos)
646 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
656 cmd = kmalloc(count + 1, GFP_KERNEL);
659 if (copy_from_user(cmd, buf, count)) {
667 /* scan expression. Multiple expressions may be delimited with ;
669 * NOTE: to keep scanning simple, invalid fields are ignored
672 if (sscanf(buffer, " lcd_out : %i", &value) == 1)
674 else if (sscanf(buffer, " crt_out : %i", &value) == 1)
676 else if (sscanf(buffer, " tv_out : %i", &value) == 1)
678 /* advance to one character past the next ; */
683 while (remain && *(buffer - 1) != ';');
688 ret = get_video_status(dev, &video_out);
690 unsigned int new_video_out = video_out;
692 _set_bit(&new_video_out, HCI_VIDEO_OUT_LCD, lcd_out);
694 _set_bit(&new_video_out, HCI_VIDEO_OUT_CRT, crt_out);
696 _set_bit(&new_video_out, HCI_VIDEO_OUT_TV, tv_out);
697 /* To avoid unnecessary video disruption, only write the new
698 * video setting if something changed. */
699 if (new_video_out != video_out)
700 ret = write_acpi_int(METHOD_VIDEO_OUT, new_video_out);
703 return ret ? ret : count;
706 static const struct file_operations video_proc_fops = {
707 .owner = THIS_MODULE,
708 .open = video_proc_open,
711 .release = single_release,
712 .write = video_proc_write,
715 static int get_fan_status(struct toshiba_acpi_dev *dev, u32 *status)
719 hci_read1(dev, HCI_FAN, status, &hci_result);
720 return hci_result == HCI_SUCCESS ? 0 : -EIO;
723 static int fan_proc_show(struct seq_file *m, void *v)
725 struct toshiba_acpi_dev *dev = m->private;
729 ret = get_fan_status(dev, &value);
731 seq_printf(m, "running: %d\n", (value > 0));
732 seq_printf(m, "force_on: %d\n", dev->force_fan);
738 static int fan_proc_open(struct inode *inode, struct file *file)
740 return single_open(file, fan_proc_show, PDE_DATA(inode));
743 static ssize_t fan_proc_write(struct file *file, const char __user *buf,
744 size_t count, loff_t *pos)
746 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
752 len = min(count, sizeof(cmd) - 1);
753 if (copy_from_user(cmd, buf, len))
757 if (sscanf(cmd, " force_on : %i", &value) == 1 &&
758 value >= 0 && value <= 1) {
759 hci_write1(dev, HCI_FAN, value, &hci_result);
760 if (hci_result != HCI_SUCCESS)
763 dev->force_fan = value;
771 static const struct file_operations fan_proc_fops = {
772 .owner = THIS_MODULE,
773 .open = fan_proc_open,
776 .release = single_release,
777 .write = fan_proc_write,
780 static int keys_proc_show(struct seq_file *m, void *v)
782 struct toshiba_acpi_dev *dev = m->private;
786 if (!dev->key_event_valid && dev->system_event_supported) {
787 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
788 if (hci_result == HCI_SUCCESS) {
789 dev->key_event_valid = 1;
790 dev->last_key_event = value;
791 } else if (hci_result == HCI_EMPTY) {
792 /* better luck next time */
793 } else if (hci_result == HCI_NOT_SUPPORTED) {
794 /* This is a workaround for an unresolved issue on
795 * some machines where system events sporadically
796 * become disabled. */
797 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
798 pr_notice("Re-enabled hotkeys\n");
800 pr_err("Error reading hotkey status\n");
805 seq_printf(m, "hotkey_ready: %d\n", dev->key_event_valid);
806 seq_printf(m, "hotkey: 0x%04x\n", dev->last_key_event);
810 static int keys_proc_open(struct inode *inode, struct file *file)
812 return single_open(file, keys_proc_show, PDE_DATA(inode));
815 static ssize_t keys_proc_write(struct file *file, const char __user *buf,
816 size_t count, loff_t *pos)
818 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
823 len = min(count, sizeof(cmd) - 1);
824 if (copy_from_user(cmd, buf, len))
828 if (sscanf(cmd, " hotkey_ready : %i", &value) == 1 && value == 0) {
829 dev->key_event_valid = 0;
837 static const struct file_operations keys_proc_fops = {
838 .owner = THIS_MODULE,
839 .open = keys_proc_open,
842 .release = single_release,
843 .write = keys_proc_write,
846 static int version_proc_show(struct seq_file *m, void *v)
848 seq_printf(m, "driver: %s\n", TOSHIBA_ACPI_VERSION);
849 seq_printf(m, "proc_interface: %d\n", PROC_INTERFACE_VERSION);
853 static int version_proc_open(struct inode *inode, struct file *file)
855 return single_open(file, version_proc_show, PDE_DATA(inode));
858 static const struct file_operations version_proc_fops = {
859 .owner = THIS_MODULE,
860 .open = version_proc_open,
863 .release = single_release,
866 /* proc and module init
869 #define PROC_TOSHIBA "toshiba"
871 static void create_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
873 if (dev->backlight_dev)
874 proc_create_data("lcd", S_IRUGO | S_IWUSR, toshiba_proc_dir,
875 &lcd_proc_fops, dev);
876 if (dev->video_supported)
877 proc_create_data("video", S_IRUGO | S_IWUSR, toshiba_proc_dir,
878 &video_proc_fops, dev);
879 if (dev->fan_supported)
880 proc_create_data("fan", S_IRUGO | S_IWUSR, toshiba_proc_dir,
881 &fan_proc_fops, dev);
883 proc_create_data("keys", S_IRUGO | S_IWUSR, toshiba_proc_dir,
884 &keys_proc_fops, dev);
885 proc_create_data("version", S_IRUGO, toshiba_proc_dir,
886 &version_proc_fops, dev);
889 static void remove_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
891 if (dev->backlight_dev)
892 remove_proc_entry("lcd", toshiba_proc_dir);
893 if (dev->video_supported)
894 remove_proc_entry("video", toshiba_proc_dir);
895 if (dev->fan_supported)
896 remove_proc_entry("fan", toshiba_proc_dir);
898 remove_proc_entry("keys", toshiba_proc_dir);
899 remove_proc_entry("version", toshiba_proc_dir);
902 static const struct backlight_ops toshiba_backlight_data = {
903 .options = BL_CORE_SUSPENDRESUME,
904 .get_brightness = get_lcd_brightness,
905 .update_status = set_lcd_status,
908 static bool toshiba_acpi_i8042_filter(unsigned char data, unsigned char str,
914 if (unlikely(data == 0xe0))
917 if ((data & 0x7f) == TOS1900_FN_SCAN) {
918 schedule_work(&toshiba_acpi->hotkey_work);
925 static void toshiba_acpi_hotkey_work(struct work_struct *work)
927 acpi_handle ec_handle = ec_get_handle();
933 status = acpi_evaluate_object(ec_handle, "NTFY", NULL, NULL);
934 if (ACPI_FAILURE(status))
935 pr_err("ACPI NTFY method execution failed\n");
939 * Returns hotkey scancode, or < 0 on failure.
941 static int toshiba_acpi_query_hotkey(struct toshiba_acpi_dev *dev)
943 unsigned long long value;
946 status = acpi_evaluate_integer(dev->acpi_dev->handle, "INFO",
948 if (ACPI_FAILURE(status)) {
949 pr_err("ACPI INFO method execution failed\n");
956 static void toshiba_acpi_report_hotkey(struct toshiba_acpi_dev *dev,
959 if (scancode == 0x100)
962 /* act on key press; ignore key release */
966 if (!sparse_keymap_report_event(dev->hotkey_dev, scancode, 1, true))
967 pr_info("Unknown key %x\n", scancode);
970 static int toshiba_acpi_setup_keyboard(struct toshiba_acpi_dev *dev)
973 acpi_handle ec_handle;
977 dev->hotkey_dev = input_allocate_device();
978 if (!dev->hotkey_dev)
981 dev->hotkey_dev->name = "Toshiba input device";
982 dev->hotkey_dev->phys = "toshiba_acpi/input0";
983 dev->hotkey_dev->id.bustype = BUS_HOST;
985 error = sparse_keymap_setup(dev->hotkey_dev, toshiba_acpi_keymap, NULL);
990 * For some machines the SCI responsible for providing hotkey
991 * notification doesn't fire. We can trigger the notification
992 * whenever the Fn key is pressed using the NTFY method, if
993 * supported, so if it's present set up an i8042 key filter
997 ec_handle = ec_get_handle();
998 if (ec_handle && acpi_has_method(ec_handle, "NTFY")) {
999 INIT_WORK(&dev->hotkey_work, toshiba_acpi_hotkey_work);
1001 error = i8042_install_filter(toshiba_acpi_i8042_filter);
1003 pr_err("Error installing key filter\n");
1004 goto err_free_keymap;
1007 dev->ntfy_supported = 1;
1011 * Determine hotkey query interface. Prefer using the INFO
1012 * method when it is available.
1014 if (acpi_has_method(dev->acpi_dev->handle, "INFO"))
1015 dev->info_supported = 1;
1017 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
1018 if (hci_result == HCI_SUCCESS)
1019 dev->system_event_supported = 1;
1022 if (!dev->info_supported && !dev->system_event_supported) {
1023 pr_warn("No hotkey query interface found\n");
1024 goto err_remove_filter;
1027 status = acpi_evaluate_object(dev->acpi_dev->handle, "ENAB", NULL, NULL);
1028 if (ACPI_FAILURE(status)) {
1029 pr_info("Unable to enable hotkeys\n");
1031 goto err_remove_filter;
1034 error = input_register_device(dev->hotkey_dev);
1036 pr_info("Unable to register input device\n");
1037 goto err_remove_filter;
1040 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &hci_result);
1044 if (dev->ntfy_supported)
1045 i8042_remove_filter(toshiba_acpi_i8042_filter);
1047 sparse_keymap_free(dev->hotkey_dev);
1049 input_free_device(dev->hotkey_dev);
1050 dev->hotkey_dev = NULL;
1054 static int toshiba_acpi_setup_backlight(struct toshiba_acpi_dev *dev)
1056 struct backlight_properties props;
1062 * Some machines don't support the backlight methods at all, and
1063 * others support it read-only. Either of these is pretty useless,
1064 * so only register the backlight device if the backlight method
1065 * supports both reads and writes.
1067 brightness = __get_lcd_brightness(dev);
1070 ret = set_lcd_brightness(dev, brightness);
1072 pr_debug("Backlight method is read-only, disabling backlight support\n");
1076 /* Determine whether or not BIOS supports transflective backlight */
1077 ret = get_tr_backlight_status(dev, &enabled);
1078 dev->tr_backlight_supported = !ret;
1080 memset(&props, 0, sizeof(props));
1081 props.type = BACKLIGHT_PLATFORM;
1082 props.max_brightness = HCI_LCD_BRIGHTNESS_LEVELS - 1;
1084 /* adding an extra level and having 0 change to transflective mode */
1085 if (dev->tr_backlight_supported)
1086 props.max_brightness++;
1088 dev->backlight_dev = backlight_device_register("toshiba",
1089 &dev->acpi_dev->dev,
1091 &toshiba_backlight_data,
1093 if (IS_ERR(dev->backlight_dev)) {
1094 ret = PTR_ERR(dev->backlight_dev);
1095 pr_err("Could not register toshiba backlight device\n");
1096 dev->backlight_dev = NULL;
1100 dev->backlight_dev->props.brightness = brightness;
1104 static int toshiba_acpi_remove(struct acpi_device *acpi_dev)
1106 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1108 remove_toshiba_proc_entries(dev);
1110 if (dev->ntfy_supported) {
1111 i8042_remove_filter(toshiba_acpi_i8042_filter);
1112 cancel_work_sync(&dev->hotkey_work);
1115 if (dev->hotkey_dev) {
1116 input_unregister_device(dev->hotkey_dev);
1117 sparse_keymap_free(dev->hotkey_dev);
1121 rfkill_unregister(dev->bt_rfk);
1122 rfkill_destroy(dev->bt_rfk);
1125 if (dev->backlight_dev)
1126 backlight_device_unregister(dev->backlight_dev);
1128 if (dev->illumination_supported)
1129 led_classdev_unregister(&dev->led_dev);
1132 toshiba_acpi = NULL;
1139 static const char *find_hci_method(acpi_handle handle)
1141 if (acpi_has_method(handle, "GHCI"))
1144 if (acpi_has_method(handle, "SPFC"))
1150 static int toshiba_acpi_add(struct acpi_device *acpi_dev)
1152 struct toshiba_acpi_dev *dev;
1153 const char *hci_method;
1161 pr_info("Toshiba Laptop ACPI Extras version %s\n",
1162 TOSHIBA_ACPI_VERSION);
1164 hci_method = find_hci_method(acpi_dev->handle);
1166 pr_err("HCI interface not found\n");
1170 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1173 dev->acpi_dev = acpi_dev;
1174 dev->method_hci = hci_method;
1175 acpi_dev->driver_data = dev;
1177 if (toshiba_acpi_setup_keyboard(dev))
1178 pr_info("Unable to activate hotkeys\n");
1180 mutex_init(&dev->mutex);
1182 ret = toshiba_acpi_setup_backlight(dev);
1186 /* Register rfkill switch for Bluetooth */
1187 if (hci_get_bt_present(dev, &bt_present) == HCI_SUCCESS && bt_present) {
1188 dev->bt_rfk = rfkill_alloc("Toshiba Bluetooth",
1190 RFKILL_TYPE_BLUETOOTH,
1194 pr_err("unable to allocate rfkill device\n");
1199 ret = rfkill_register(dev->bt_rfk);
1201 pr_err("unable to register rfkill device\n");
1202 rfkill_destroy(dev->bt_rfk);
1207 if (toshiba_illumination_available(dev)) {
1208 dev->led_dev.name = "toshiba::illumination";
1209 dev->led_dev.max_brightness = 1;
1210 dev->led_dev.brightness_set = toshiba_illumination_set;
1211 dev->led_dev.brightness_get = toshiba_illumination_get;
1212 if (!led_classdev_register(&acpi_dev->dev, &dev->led_dev))
1213 dev->illumination_supported = 1;
1216 /* Determine whether or not BIOS supports fan and video interfaces */
1218 ret = get_video_status(dev, &dummy);
1219 dev->video_supported = !ret;
1221 ret = get_fan_status(dev, &dummy);
1222 dev->fan_supported = !ret;
1224 create_toshiba_proc_entries(dev);
1231 toshiba_acpi_remove(acpi_dev);
1235 static void toshiba_acpi_notify(struct acpi_device *acpi_dev, u32 event)
1237 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1238 u32 hci_result, value;
1245 if (dev->info_supported) {
1246 scancode = toshiba_acpi_query_hotkey(dev);
1248 pr_err("Failed to query hotkey event\n");
1249 else if (scancode != 0)
1250 toshiba_acpi_report_hotkey(dev, scancode);
1251 } else if (dev->system_event_supported) {
1253 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
1254 switch (hci_result) {
1256 toshiba_acpi_report_hotkey(dev, (int)value);
1258 case HCI_NOT_SUPPORTED:
1260 * This is a workaround for an unresolved
1261 * issue on some machines where system events
1262 * sporadically become disabled.
1264 hci_write1(dev, HCI_SYSTEM_EVENT, 1,
1266 pr_notice("Re-enabled hotkeys\n");
1272 } while (retries && hci_result != HCI_EMPTY);
1276 #ifdef CONFIG_PM_SLEEP
1277 static int toshiba_acpi_suspend(struct device *device)
1279 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1282 if (dev->hotkey_dev)
1283 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_DISABLE, &result);
1288 static int toshiba_acpi_resume(struct device *device)
1290 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1293 if (dev->hotkey_dev)
1294 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &result);
1300 static SIMPLE_DEV_PM_OPS(toshiba_acpi_pm,
1301 toshiba_acpi_suspend, toshiba_acpi_resume);
1303 static struct acpi_driver toshiba_acpi_driver = {
1304 .name = "Toshiba ACPI driver",
1305 .owner = THIS_MODULE,
1306 .ids = toshiba_device_ids,
1307 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1309 .add = toshiba_acpi_add,
1310 .remove = toshiba_acpi_remove,
1311 .notify = toshiba_acpi_notify,
1313 .drv.pm = &toshiba_acpi_pm,
1316 static int __init toshiba_acpi_init(void)
1321 * Machines with this WMI guid aren't supported due to bugs in
1322 * their AML. This check relies on wmi initializing before
1323 * toshiba_acpi to guarantee guids have been identified.
1325 if (wmi_has_guid(TOSHIBA_WMI_EVENT_GUID))
1328 toshiba_proc_dir = proc_mkdir(PROC_TOSHIBA, acpi_root_dir);
1329 if (!toshiba_proc_dir) {
1330 pr_err("Unable to create proc dir " PROC_TOSHIBA "\n");
1334 ret = acpi_bus_register_driver(&toshiba_acpi_driver);
1336 pr_err("Failed to register ACPI driver: %d\n", ret);
1337 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1343 static void __exit toshiba_acpi_exit(void)
1345 acpi_bus_unregister_driver(&toshiba_acpi_driver);
1346 if (toshiba_proc_dir)
1347 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1350 module_init(toshiba_acpi_init);
1351 module_exit(toshiba_acpi_exit);