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, 0x9e, { KEY_RFKILL } },
153 { KE_KEY, 0x101, { KEY_MUTE } },
154 { KE_KEY, 0x102, { KEY_ZOOMOUT } },
155 { KE_KEY, 0x103, { KEY_ZOOMIN } },
156 { KE_KEY, 0x12c, { KEY_KBDILLUMTOGGLE } },
157 { KE_KEY, 0x139, { KEY_ZOOMRESET } },
158 { KE_KEY, 0x13b, { KEY_COFFEE } },
159 { KE_KEY, 0x13c, { KEY_BATTERY } },
160 { KE_KEY, 0x13d, { KEY_SLEEP } },
161 { KE_KEY, 0x13e, { KEY_SUSPEND } },
162 { KE_KEY, 0x13f, { KEY_SWITCHVIDEOMODE } },
163 { KE_KEY, 0x140, { KEY_BRIGHTNESSDOWN } },
164 { KE_KEY, 0x141, { KEY_BRIGHTNESSUP } },
165 { KE_KEY, 0x142, { KEY_WLAN } },
166 { KE_KEY, 0x143, { KEY_TOUCHPAD_TOGGLE } },
167 { KE_KEY, 0x17f, { KEY_FN } },
168 { KE_KEY, 0xb05, { KEY_PROG2 } },
169 { KE_KEY, 0xb06, { KEY_WWW } },
170 { KE_KEY, 0xb07, { KEY_MAIL } },
171 { KE_KEY, 0xb30, { KEY_STOP } },
172 { KE_KEY, 0xb31, { KEY_PREVIOUSSONG } },
173 { KE_KEY, 0xb32, { KEY_NEXTSONG } },
174 { KE_KEY, 0xb33, { KEY_PLAYPAUSE } },
175 { KE_KEY, 0xb5a, { KEY_MEDIA } },
176 { KE_IGNORE, 0x1430, { KEY_RESERVED } },
183 static __inline__ void _set_bit(u32 * word, u32 mask, int value)
185 *word = (*word & ~mask) | (mask * value);
188 /* acpi interface wrappers
191 static int write_acpi_int(const char *methodName, int val)
195 status = acpi_execute_simple_method(NULL, (char *)methodName, val);
196 return (status == AE_OK) ? 0 : -EIO;
199 /* Perform a raw HCI call. Here we don't care about input or output buffer
202 static acpi_status hci_raw(struct toshiba_acpi_dev *dev,
203 const u32 in[HCI_WORDS], u32 out[HCI_WORDS])
205 struct acpi_object_list params;
206 union acpi_object in_objs[HCI_WORDS];
207 struct acpi_buffer results;
208 union acpi_object out_objs[HCI_WORDS + 1];
212 params.count = HCI_WORDS;
213 params.pointer = in_objs;
214 for (i = 0; i < HCI_WORDS; ++i) {
215 in_objs[i].type = ACPI_TYPE_INTEGER;
216 in_objs[i].integer.value = in[i];
219 results.length = sizeof(out_objs);
220 results.pointer = out_objs;
222 status = acpi_evaluate_object(dev->acpi_dev->handle,
223 (char *)dev->method_hci, ¶ms,
225 if ((status == AE_OK) && (out_objs->package.count <= HCI_WORDS)) {
226 for (i = 0; i < out_objs->package.count; ++i) {
227 out[i] = out_objs->package.elements[i].integer.value;
234 /* common hci tasks (get or set one or two value)
236 * In addition to the ACPI status, the HCI system returns a result which
237 * may be useful (such as "not supported").
240 static acpi_status hci_write1(struct toshiba_acpi_dev *dev, u32 reg,
241 u32 in1, u32 *result)
243 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, 0, 0, 0 };
245 acpi_status status = hci_raw(dev, in, out);
246 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
250 static acpi_status hci_read1(struct toshiba_acpi_dev *dev, u32 reg,
251 u32 *out1, u32 *result)
253 u32 in[HCI_WORDS] = { HCI_GET, reg, 0, 0, 0, 0 };
255 acpi_status status = hci_raw(dev, in, out);
257 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
261 static acpi_status hci_write2(struct toshiba_acpi_dev *dev, u32 reg,
262 u32 in1, u32 in2, u32 *result)
264 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, in2, 0, 0 };
266 acpi_status status = hci_raw(dev, in, out);
267 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
271 static acpi_status hci_read2(struct toshiba_acpi_dev *dev, u32 reg,
272 u32 *out1, u32 *out2, u32 *result)
274 u32 in[HCI_WORDS] = { HCI_GET, reg, *out1, *out2, 0, 0 };
276 acpi_status status = hci_raw(dev, in, out);
279 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
283 /* Illumination support */
284 static int toshiba_illumination_available(struct toshiba_acpi_dev *dev)
286 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
291 status = hci_raw(dev, in, out);
292 if (ACPI_FAILURE(status)) {
293 pr_info("Illumination device not available\n");
297 status = hci_raw(dev, in, out);
301 static void toshiba_illumination_set(struct led_classdev *cdev,
302 enum led_brightness brightness)
304 struct toshiba_acpi_dev *dev = container_of(cdev,
305 struct toshiba_acpi_dev, led_dev);
306 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
310 /* First request : initialize communication. */
312 status = hci_raw(dev, in, out);
313 if (ACPI_FAILURE(status)) {
314 pr_info("Illumination device not available\n");
319 /* Switch the illumination on */
323 status = hci_raw(dev, in, out);
324 if (ACPI_FAILURE(status)) {
325 pr_info("ACPI call for illumination failed\n");
329 /* Switch the illumination off */
333 status = hci_raw(dev, in, out);
334 if (ACPI_FAILURE(status)) {
335 pr_info("ACPI call for illumination failed.\n");
340 /* Last request : close communication. */
344 hci_raw(dev, in, out);
347 static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev)
349 struct toshiba_acpi_dev *dev = container_of(cdev,
350 struct toshiba_acpi_dev, led_dev);
351 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
354 enum led_brightness result;
356 /*Â First request : initialize communication. */
358 status = hci_raw(dev, in, out);
359 if (ACPI_FAILURE(status)) {
360 pr_info("Illumination device not available\n");
364 /* Check the illumination */
367 status = hci_raw(dev, in, out);
368 if (ACPI_FAILURE(status)) {
369 pr_info("ACPI call for illumination failed.\n");
373 result = out[2] ? LED_FULL : LED_OFF;
375 /* Last request : close communication. */
379 hci_raw(dev, in, out);
384 /* Bluetooth rfkill handlers */
386 static u32 hci_get_bt_present(struct toshiba_acpi_dev *dev, bool *present)
393 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
394 if (hci_result == HCI_SUCCESS)
395 *present = (value & HCI_WIRELESS_BT_PRESENT) ? true : false;
400 static u32 hci_get_radio_state(struct toshiba_acpi_dev *dev, bool *radio_state)
407 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
409 *radio_state = value & HCI_WIRELESS_KILL_SWITCH;
413 static int bt_rfkill_set_block(void *data, bool blocked)
415 struct toshiba_acpi_dev *dev = data;
416 u32 result1, result2;
421 value = (blocked == false);
423 mutex_lock(&dev->mutex);
424 if (hci_get_radio_state(dev, &radio_state) != HCI_SUCCESS) {
434 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_POWER, &result1);
435 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_ATTACH, &result2);
437 if (result1 != HCI_SUCCESS || result2 != HCI_SUCCESS)
442 mutex_unlock(&dev->mutex);
446 static void bt_rfkill_poll(struct rfkill *rfkill, void *data)
451 struct toshiba_acpi_dev *dev = data;
453 mutex_lock(&dev->mutex);
455 hci_result = hci_get_radio_state(dev, &value);
456 if (hci_result != HCI_SUCCESS) {
457 /* Can't do anything useful */
458 mutex_unlock(&dev->mutex);
462 new_rfk_state = value;
464 mutex_unlock(&dev->mutex);
466 if (rfkill_set_hw_state(rfkill, !new_rfk_state))
467 bt_rfkill_set_block(data, true);
470 static const struct rfkill_ops toshiba_rfk_ops = {
471 .set_block = bt_rfkill_set_block,
472 .poll = bt_rfkill_poll,
475 static int get_tr_backlight_status(struct toshiba_acpi_dev *dev, bool *enabled)
480 hci_read1(dev, HCI_TR_BACKLIGHT, &status, &hci_result);
482 return hci_result == HCI_SUCCESS ? 0 : -EIO;
485 static int set_tr_backlight_status(struct toshiba_acpi_dev *dev, bool enable)
490 hci_write1(dev, HCI_TR_BACKLIGHT, value, &hci_result);
491 return hci_result == HCI_SUCCESS ? 0 : -EIO;
494 static struct proc_dir_entry *toshiba_proc_dir /*= 0*/ ;
496 static int __get_lcd_brightness(struct toshiba_acpi_dev *dev)
502 if (dev->tr_backlight_supported) {
504 int ret = get_tr_backlight_status(dev, &enabled);
512 hci_read1(dev, HCI_LCD_BRIGHTNESS, &value, &hci_result);
513 if (hci_result == HCI_SUCCESS)
514 return brightness + (value >> HCI_LCD_BRIGHTNESS_SHIFT);
519 static int get_lcd_brightness(struct backlight_device *bd)
521 struct toshiba_acpi_dev *dev = bl_get_data(bd);
522 return __get_lcd_brightness(dev);
525 static int lcd_proc_show(struct seq_file *m, void *v)
527 struct toshiba_acpi_dev *dev = m->private;
531 if (!dev->backlight_dev)
534 levels = dev->backlight_dev->props.max_brightness + 1;
535 value = get_lcd_brightness(dev->backlight_dev);
537 seq_printf(m, "brightness: %d\n", value);
538 seq_printf(m, "brightness_levels: %d\n", levels);
542 pr_err("Error reading LCD brightness\n");
546 static int lcd_proc_open(struct inode *inode, struct file *file)
548 return single_open(file, lcd_proc_show, PDE_DATA(inode));
551 static int set_lcd_brightness(struct toshiba_acpi_dev *dev, int value)
555 if (dev->tr_backlight_supported) {
556 bool enable = !value;
557 int ret = set_tr_backlight_status(dev, enable);
564 value = value << HCI_LCD_BRIGHTNESS_SHIFT;
565 hci_write1(dev, HCI_LCD_BRIGHTNESS, value, &hci_result);
566 return hci_result == HCI_SUCCESS ? 0 : -EIO;
569 static int set_lcd_status(struct backlight_device *bd)
571 struct toshiba_acpi_dev *dev = bl_get_data(bd);
572 return set_lcd_brightness(dev, bd->props.brightness);
575 static ssize_t lcd_proc_write(struct file *file, const char __user *buf,
576 size_t count, loff_t *pos)
578 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
583 int levels = dev->backlight_dev->props.max_brightness + 1;
585 len = min(count, sizeof(cmd) - 1);
586 if (copy_from_user(cmd, buf, len))
590 if (sscanf(cmd, " brightness : %i", &value) == 1 &&
591 value >= 0 && value < levels) {
592 ret = set_lcd_brightness(dev, value);
601 static const struct file_operations lcd_proc_fops = {
602 .owner = THIS_MODULE,
603 .open = lcd_proc_open,
606 .release = single_release,
607 .write = lcd_proc_write,
610 static int get_video_status(struct toshiba_acpi_dev *dev, u32 *status)
614 hci_read1(dev, HCI_VIDEO_OUT, status, &hci_result);
615 return hci_result == HCI_SUCCESS ? 0 : -EIO;
618 static int video_proc_show(struct seq_file *m, void *v)
620 struct toshiba_acpi_dev *dev = m->private;
624 ret = get_video_status(dev, &value);
626 int is_lcd = (value & HCI_VIDEO_OUT_LCD) ? 1 : 0;
627 int is_crt = (value & HCI_VIDEO_OUT_CRT) ? 1 : 0;
628 int is_tv = (value & HCI_VIDEO_OUT_TV) ? 1 : 0;
629 seq_printf(m, "lcd_out: %d\n", is_lcd);
630 seq_printf(m, "crt_out: %d\n", is_crt);
631 seq_printf(m, "tv_out: %d\n", is_tv);
637 static int video_proc_open(struct inode *inode, struct file *file)
639 return single_open(file, video_proc_show, PDE_DATA(inode));
642 static ssize_t video_proc_write(struct file *file, const char __user *buf,
643 size_t count, loff_t *pos)
645 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
655 cmd = kmalloc(count + 1, GFP_KERNEL);
658 if (copy_from_user(cmd, buf, count)) {
666 /* scan expression. Multiple expressions may be delimited with ;
668 * NOTE: to keep scanning simple, invalid fields are ignored
671 if (sscanf(buffer, " lcd_out : %i", &value) == 1)
673 else if (sscanf(buffer, " crt_out : %i", &value) == 1)
675 else if (sscanf(buffer, " tv_out : %i", &value) == 1)
677 /* advance to one character past the next ; */
682 while (remain && *(buffer - 1) != ';');
687 ret = get_video_status(dev, &video_out);
689 unsigned int new_video_out = video_out;
691 _set_bit(&new_video_out, HCI_VIDEO_OUT_LCD, lcd_out);
693 _set_bit(&new_video_out, HCI_VIDEO_OUT_CRT, crt_out);
695 _set_bit(&new_video_out, HCI_VIDEO_OUT_TV, tv_out);
696 /* To avoid unnecessary video disruption, only write the new
697 * video setting if something changed. */
698 if (new_video_out != video_out)
699 ret = write_acpi_int(METHOD_VIDEO_OUT, new_video_out);
702 return ret ? ret : count;
705 static const struct file_operations video_proc_fops = {
706 .owner = THIS_MODULE,
707 .open = video_proc_open,
710 .release = single_release,
711 .write = video_proc_write,
714 static int get_fan_status(struct toshiba_acpi_dev *dev, u32 *status)
718 hci_read1(dev, HCI_FAN, status, &hci_result);
719 return hci_result == HCI_SUCCESS ? 0 : -EIO;
722 static int fan_proc_show(struct seq_file *m, void *v)
724 struct toshiba_acpi_dev *dev = m->private;
728 ret = get_fan_status(dev, &value);
730 seq_printf(m, "running: %d\n", (value > 0));
731 seq_printf(m, "force_on: %d\n", dev->force_fan);
737 static int fan_proc_open(struct inode *inode, struct file *file)
739 return single_open(file, fan_proc_show, PDE_DATA(inode));
742 static ssize_t fan_proc_write(struct file *file, const char __user *buf,
743 size_t count, loff_t *pos)
745 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
751 len = min(count, sizeof(cmd) - 1);
752 if (copy_from_user(cmd, buf, len))
756 if (sscanf(cmd, " force_on : %i", &value) == 1 &&
757 value >= 0 && value <= 1) {
758 hci_write1(dev, HCI_FAN, value, &hci_result);
759 if (hci_result != HCI_SUCCESS)
762 dev->force_fan = value;
770 static const struct file_operations fan_proc_fops = {
771 .owner = THIS_MODULE,
772 .open = fan_proc_open,
775 .release = single_release,
776 .write = fan_proc_write,
779 static int keys_proc_show(struct seq_file *m, void *v)
781 struct toshiba_acpi_dev *dev = m->private;
785 if (!dev->key_event_valid && dev->system_event_supported) {
786 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
787 if (hci_result == HCI_SUCCESS) {
788 dev->key_event_valid = 1;
789 dev->last_key_event = value;
790 } else if (hci_result == HCI_EMPTY) {
791 /* better luck next time */
792 } else if (hci_result == HCI_NOT_SUPPORTED) {
793 /* This is a workaround for an unresolved issue on
794 * some machines where system events sporadically
795 * become disabled. */
796 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
797 pr_notice("Re-enabled hotkeys\n");
799 pr_err("Error reading hotkey status\n");
804 seq_printf(m, "hotkey_ready: %d\n", dev->key_event_valid);
805 seq_printf(m, "hotkey: 0x%04x\n", dev->last_key_event);
809 static int keys_proc_open(struct inode *inode, struct file *file)
811 return single_open(file, keys_proc_show, PDE_DATA(inode));
814 static ssize_t keys_proc_write(struct file *file, const char __user *buf,
815 size_t count, loff_t *pos)
817 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
822 len = min(count, sizeof(cmd) - 1);
823 if (copy_from_user(cmd, buf, len))
827 if (sscanf(cmd, " hotkey_ready : %i", &value) == 1 && value == 0) {
828 dev->key_event_valid = 0;
836 static const struct file_operations keys_proc_fops = {
837 .owner = THIS_MODULE,
838 .open = keys_proc_open,
841 .release = single_release,
842 .write = keys_proc_write,
845 static int version_proc_show(struct seq_file *m, void *v)
847 seq_printf(m, "driver: %s\n", TOSHIBA_ACPI_VERSION);
848 seq_printf(m, "proc_interface: %d\n", PROC_INTERFACE_VERSION);
852 static int version_proc_open(struct inode *inode, struct file *file)
854 return single_open(file, version_proc_show, PDE_DATA(inode));
857 static const struct file_operations version_proc_fops = {
858 .owner = THIS_MODULE,
859 .open = version_proc_open,
862 .release = single_release,
865 /* proc and module init
868 #define PROC_TOSHIBA "toshiba"
870 static void create_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
872 if (dev->backlight_dev)
873 proc_create_data("lcd", S_IRUGO | S_IWUSR, toshiba_proc_dir,
874 &lcd_proc_fops, dev);
875 if (dev->video_supported)
876 proc_create_data("video", S_IRUGO | S_IWUSR, toshiba_proc_dir,
877 &video_proc_fops, dev);
878 if (dev->fan_supported)
879 proc_create_data("fan", S_IRUGO | S_IWUSR, toshiba_proc_dir,
880 &fan_proc_fops, dev);
882 proc_create_data("keys", S_IRUGO | S_IWUSR, toshiba_proc_dir,
883 &keys_proc_fops, dev);
884 proc_create_data("version", S_IRUGO, toshiba_proc_dir,
885 &version_proc_fops, dev);
888 static void remove_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
890 if (dev->backlight_dev)
891 remove_proc_entry("lcd", toshiba_proc_dir);
892 if (dev->video_supported)
893 remove_proc_entry("video", toshiba_proc_dir);
894 if (dev->fan_supported)
895 remove_proc_entry("fan", toshiba_proc_dir);
897 remove_proc_entry("keys", toshiba_proc_dir);
898 remove_proc_entry("version", toshiba_proc_dir);
901 static const struct backlight_ops toshiba_backlight_data = {
902 .options = BL_CORE_SUSPENDRESUME,
903 .get_brightness = get_lcd_brightness,
904 .update_status = set_lcd_status,
907 static bool toshiba_acpi_i8042_filter(unsigned char data, unsigned char str,
913 if (unlikely(data == 0xe0))
916 if ((data & 0x7f) == TOS1900_FN_SCAN) {
917 schedule_work(&toshiba_acpi->hotkey_work);
924 static void toshiba_acpi_hotkey_work(struct work_struct *work)
926 acpi_handle ec_handle = ec_get_handle();
932 status = acpi_evaluate_object(ec_handle, "NTFY", NULL, NULL);
933 if (ACPI_FAILURE(status))
934 pr_err("ACPI NTFY method execution failed\n");
938 * Returns hotkey scancode, or < 0 on failure.
940 static int toshiba_acpi_query_hotkey(struct toshiba_acpi_dev *dev)
942 unsigned long long value;
945 status = acpi_evaluate_integer(dev->acpi_dev->handle, "INFO",
947 if (ACPI_FAILURE(status)) {
948 pr_err("ACPI INFO method execution failed\n");
955 static void toshiba_acpi_report_hotkey(struct toshiba_acpi_dev *dev,
958 if (scancode == 0x100)
961 /* act on key press; ignore key release */
965 if (!sparse_keymap_report_event(dev->hotkey_dev, scancode, 1, true))
966 pr_info("Unknown key %x\n", scancode);
969 static int toshiba_acpi_setup_keyboard(struct toshiba_acpi_dev *dev)
972 acpi_handle ec_handle;
976 dev->hotkey_dev = input_allocate_device();
977 if (!dev->hotkey_dev)
980 dev->hotkey_dev->name = "Toshiba input device";
981 dev->hotkey_dev->phys = "toshiba_acpi/input0";
982 dev->hotkey_dev->id.bustype = BUS_HOST;
984 error = sparse_keymap_setup(dev->hotkey_dev, toshiba_acpi_keymap, NULL);
989 * For some machines the SCI responsible for providing hotkey
990 * notification doesn't fire. We can trigger the notification
991 * whenever the Fn key is pressed using the NTFY method, if
992 * supported, so if it's present set up an i8042 key filter
996 ec_handle = ec_get_handle();
997 if (ec_handle && acpi_has_method(ec_handle, "NTFY")) {
998 INIT_WORK(&dev->hotkey_work, toshiba_acpi_hotkey_work);
1000 error = i8042_install_filter(toshiba_acpi_i8042_filter);
1002 pr_err("Error installing key filter\n");
1003 goto err_free_keymap;
1006 dev->ntfy_supported = 1;
1010 * Determine hotkey query interface. Prefer using the INFO
1011 * method when it is available.
1013 if (acpi_has_method(dev->acpi_dev->handle, "INFO"))
1014 dev->info_supported = 1;
1016 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
1017 if (hci_result == HCI_SUCCESS)
1018 dev->system_event_supported = 1;
1021 if (!dev->info_supported && !dev->system_event_supported) {
1022 pr_warn("No hotkey query interface found\n");
1023 goto err_remove_filter;
1026 status = acpi_evaluate_object(dev->acpi_dev->handle, "ENAB", NULL, NULL);
1027 if (ACPI_FAILURE(status)) {
1028 pr_info("Unable to enable hotkeys\n");
1030 goto err_remove_filter;
1033 error = input_register_device(dev->hotkey_dev);
1035 pr_info("Unable to register input device\n");
1036 goto err_remove_filter;
1039 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &hci_result);
1043 if (dev->ntfy_supported)
1044 i8042_remove_filter(toshiba_acpi_i8042_filter);
1046 sparse_keymap_free(dev->hotkey_dev);
1048 input_free_device(dev->hotkey_dev);
1049 dev->hotkey_dev = NULL;
1053 static int toshiba_acpi_setup_backlight(struct toshiba_acpi_dev *dev)
1055 struct backlight_properties props;
1061 * Some machines don't support the backlight methods at all, and
1062 * others support it read-only. Either of these is pretty useless,
1063 * so only register the backlight device if the backlight method
1064 * supports both reads and writes.
1066 brightness = __get_lcd_brightness(dev);
1069 ret = set_lcd_brightness(dev, brightness);
1071 pr_debug("Backlight method is read-only, disabling backlight support\n");
1075 /* Determine whether or not BIOS supports transflective backlight */
1076 ret = get_tr_backlight_status(dev, &enabled);
1077 dev->tr_backlight_supported = !ret;
1079 memset(&props, 0, sizeof(props));
1080 props.type = BACKLIGHT_PLATFORM;
1081 props.max_brightness = HCI_LCD_BRIGHTNESS_LEVELS - 1;
1083 /* adding an extra level and having 0 change to transflective mode */
1084 if (dev->tr_backlight_supported)
1085 props.max_brightness++;
1087 dev->backlight_dev = backlight_device_register("toshiba",
1088 &dev->acpi_dev->dev,
1090 &toshiba_backlight_data,
1092 if (IS_ERR(dev->backlight_dev)) {
1093 ret = PTR_ERR(dev->backlight_dev);
1094 pr_err("Could not register toshiba backlight device\n");
1095 dev->backlight_dev = NULL;
1099 dev->backlight_dev->props.brightness = brightness;
1103 static int toshiba_acpi_remove(struct acpi_device *acpi_dev)
1105 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1107 remove_toshiba_proc_entries(dev);
1109 if (dev->ntfy_supported) {
1110 i8042_remove_filter(toshiba_acpi_i8042_filter);
1111 cancel_work_sync(&dev->hotkey_work);
1114 if (dev->hotkey_dev) {
1115 input_unregister_device(dev->hotkey_dev);
1116 sparse_keymap_free(dev->hotkey_dev);
1120 rfkill_unregister(dev->bt_rfk);
1121 rfkill_destroy(dev->bt_rfk);
1124 if (dev->backlight_dev)
1125 backlight_device_unregister(dev->backlight_dev);
1127 if (dev->illumination_supported)
1128 led_classdev_unregister(&dev->led_dev);
1131 toshiba_acpi = NULL;
1138 static const char *find_hci_method(acpi_handle handle)
1140 if (acpi_has_method(handle, "GHCI"))
1143 if (acpi_has_method(handle, "SPFC"))
1149 static int toshiba_acpi_add(struct acpi_device *acpi_dev)
1151 struct toshiba_acpi_dev *dev;
1152 const char *hci_method;
1160 pr_info("Toshiba Laptop ACPI Extras version %s\n",
1161 TOSHIBA_ACPI_VERSION);
1163 hci_method = find_hci_method(acpi_dev->handle);
1165 pr_err("HCI interface not found\n");
1169 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1172 dev->acpi_dev = acpi_dev;
1173 dev->method_hci = hci_method;
1174 acpi_dev->driver_data = dev;
1176 if (toshiba_acpi_setup_keyboard(dev))
1177 pr_info("Unable to activate hotkeys\n");
1179 mutex_init(&dev->mutex);
1181 ret = toshiba_acpi_setup_backlight(dev);
1185 /* Register rfkill switch for Bluetooth */
1186 if (hci_get_bt_present(dev, &bt_present) == HCI_SUCCESS && bt_present) {
1187 dev->bt_rfk = rfkill_alloc("Toshiba Bluetooth",
1189 RFKILL_TYPE_BLUETOOTH,
1193 pr_err("unable to allocate rfkill device\n");
1198 ret = rfkill_register(dev->bt_rfk);
1200 pr_err("unable to register rfkill device\n");
1201 rfkill_destroy(dev->bt_rfk);
1206 if (toshiba_illumination_available(dev)) {
1207 dev->led_dev.name = "toshiba::illumination";
1208 dev->led_dev.max_brightness = 1;
1209 dev->led_dev.brightness_set = toshiba_illumination_set;
1210 dev->led_dev.brightness_get = toshiba_illumination_get;
1211 if (!led_classdev_register(&acpi_dev->dev, &dev->led_dev))
1212 dev->illumination_supported = 1;
1215 /* Determine whether or not BIOS supports fan and video interfaces */
1217 ret = get_video_status(dev, &dummy);
1218 dev->video_supported = !ret;
1220 ret = get_fan_status(dev, &dummy);
1221 dev->fan_supported = !ret;
1223 create_toshiba_proc_entries(dev);
1230 toshiba_acpi_remove(acpi_dev);
1234 static void toshiba_acpi_notify(struct acpi_device *acpi_dev, u32 event)
1236 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1237 u32 hci_result, value;
1244 if (dev->info_supported) {
1245 scancode = toshiba_acpi_query_hotkey(dev);
1247 pr_err("Failed to query hotkey event\n");
1248 else if (scancode != 0)
1249 toshiba_acpi_report_hotkey(dev, scancode);
1250 } else if (dev->system_event_supported) {
1252 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
1253 switch (hci_result) {
1255 toshiba_acpi_report_hotkey(dev, (int)value);
1257 case HCI_NOT_SUPPORTED:
1259 * This is a workaround for an unresolved
1260 * issue on some machines where system events
1261 * sporadically become disabled.
1263 hci_write1(dev, HCI_SYSTEM_EVENT, 1,
1265 pr_notice("Re-enabled hotkeys\n");
1271 } while (retries && hci_result != HCI_EMPTY);
1275 #ifdef CONFIG_PM_SLEEP
1276 static int toshiba_acpi_suspend(struct device *device)
1278 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1281 if (dev->hotkey_dev)
1282 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_DISABLE, &result);
1287 static int toshiba_acpi_resume(struct device *device)
1289 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1292 if (dev->hotkey_dev)
1293 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &result);
1299 static SIMPLE_DEV_PM_OPS(toshiba_acpi_pm,
1300 toshiba_acpi_suspend, toshiba_acpi_resume);
1302 static struct acpi_driver toshiba_acpi_driver = {
1303 .name = "Toshiba ACPI driver",
1304 .owner = THIS_MODULE,
1305 .ids = toshiba_device_ids,
1306 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1308 .add = toshiba_acpi_add,
1309 .remove = toshiba_acpi_remove,
1310 .notify = toshiba_acpi_notify,
1312 .drv.pm = &toshiba_acpi_pm,
1315 static int __init toshiba_acpi_init(void)
1320 * Machines with this WMI guid aren't supported due to bugs in
1321 * their AML. This check relies on wmi initializing before
1322 * toshiba_acpi to guarantee guids have been identified.
1324 if (wmi_has_guid(TOSHIBA_WMI_EVENT_GUID))
1327 toshiba_proc_dir = proc_mkdir(PROC_TOSHIBA, acpi_root_dir);
1328 if (!toshiba_proc_dir) {
1329 pr_err("Unable to create proc dir " PROC_TOSHIBA "\n");
1333 ret = acpi_bus_register_driver(&toshiba_acpi_driver);
1335 pr_err("Failed to register ACPI driver: %d\n", ret);
1336 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1342 static void __exit toshiba_acpi_exit(void)
1344 acpi_bus_unregister_driver(&toshiba_acpi_driver);
1345 if (toshiba_proc_dir)
1346 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1349 module_init(toshiba_acpi_init);
1350 module_exit(toshiba_acpi_exit);