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.
81 * SCI stands for "System Configuration Interface" which aim is to
82 * conceal differences in hardware between different models.
88 #define HCI_SET 0xff00
89 #define HCI_GET 0xfe00
90 #define SCI_OPEN 0xf100
91 #define SCI_CLOSE 0xf200
92 #define SCI_GET 0xf300
93 #define SCI_SET 0xf400
96 #define HCI_SUCCESS 0x0000
97 #define HCI_FAILURE 0x1000
98 #define HCI_NOT_SUPPORTED 0x8000
99 #define HCI_EMPTY 0x8c00
100 #define SCI_OPEN_CLOSE_OK 0x0044
101 #define SCI_ALREADY_OPEN 0x8100
102 #define SCI_NOT_OPENED 0x8200
103 #define SCI_NOT_PRESENT 0x8600
106 #define HCI_FAN 0x0004
107 #define HCI_TR_BACKLIGHT 0x0005
108 #define HCI_SYSTEM_EVENT 0x0016
109 #define HCI_VIDEO_OUT 0x001c
110 #define HCI_HOTKEY_EVENT 0x001e
111 #define HCI_LCD_BRIGHTNESS 0x002a
112 #define HCI_WIRELESS 0x0056
114 /* field definitions */
115 #define HCI_HOTKEY_DISABLE 0x0b
116 #define HCI_HOTKEY_ENABLE 0x09
117 #define HCI_LCD_BRIGHTNESS_BITS 3
118 #define HCI_LCD_BRIGHTNESS_SHIFT (16-HCI_LCD_BRIGHTNESS_BITS)
119 #define HCI_LCD_BRIGHTNESS_LEVELS (1 << HCI_LCD_BRIGHTNESS_BITS)
120 #define HCI_VIDEO_OUT_LCD 0x1
121 #define HCI_VIDEO_OUT_CRT 0x2
122 #define HCI_VIDEO_OUT_TV 0x4
123 #define HCI_WIRELESS_KILL_SWITCH 0x01
124 #define HCI_WIRELESS_BT_PRESENT 0x0f
125 #define HCI_WIRELESS_BT_ATTACH 0x40
126 #define HCI_WIRELESS_BT_POWER 0x80
128 struct toshiba_acpi_dev {
129 struct acpi_device *acpi_dev;
130 const char *method_hci;
131 struct rfkill *bt_rfk;
132 struct input_dev *hotkey_dev;
133 struct work_struct hotkey_work;
134 struct backlight_device *backlight_dev;
135 struct led_classdev led_dev;
141 unsigned int illumination_supported:1;
142 unsigned int video_supported:1;
143 unsigned int fan_supported:1;
144 unsigned int system_event_supported:1;
145 unsigned int ntfy_supported:1;
146 unsigned int info_supported:1;
147 unsigned int tr_backlight_supported:1;
152 static struct toshiba_acpi_dev *toshiba_acpi;
154 static const struct acpi_device_id toshiba_device_ids[] = {
160 MODULE_DEVICE_TABLE(acpi, toshiba_device_ids);
162 static const struct key_entry toshiba_acpi_keymap[] = {
163 { KE_KEY, 0x9e, { KEY_RFKILL } },
164 { KE_KEY, 0x101, { KEY_MUTE } },
165 { KE_KEY, 0x102, { KEY_ZOOMOUT } },
166 { KE_KEY, 0x103, { KEY_ZOOMIN } },
167 { KE_KEY, 0x12c, { KEY_KBDILLUMTOGGLE } },
168 { KE_KEY, 0x139, { KEY_ZOOMRESET } },
169 { KE_KEY, 0x13b, { KEY_COFFEE } },
170 { KE_KEY, 0x13c, { KEY_BATTERY } },
171 { KE_KEY, 0x13d, { KEY_SLEEP } },
172 { KE_KEY, 0x13e, { KEY_SUSPEND } },
173 { KE_KEY, 0x13f, { KEY_SWITCHVIDEOMODE } },
174 { KE_KEY, 0x140, { KEY_BRIGHTNESSDOWN } },
175 { KE_KEY, 0x141, { KEY_BRIGHTNESSUP } },
176 { KE_KEY, 0x142, { KEY_WLAN } },
177 { KE_KEY, 0x143, { KEY_TOUCHPAD_TOGGLE } },
178 { KE_KEY, 0x17f, { KEY_FN } },
179 { KE_KEY, 0xb05, { KEY_PROG2 } },
180 { KE_KEY, 0xb06, { KEY_WWW } },
181 { KE_KEY, 0xb07, { KEY_MAIL } },
182 { KE_KEY, 0xb30, { KEY_STOP } },
183 { KE_KEY, 0xb31, { KEY_PREVIOUSSONG } },
184 { KE_KEY, 0xb32, { KEY_NEXTSONG } },
185 { KE_KEY, 0xb33, { KEY_PLAYPAUSE } },
186 { KE_KEY, 0xb5a, { KEY_MEDIA } },
187 { KE_IGNORE, 0x1430, { KEY_RESERVED } },
194 static __inline__ void _set_bit(u32 * word, u32 mask, int value)
196 *word = (*word & ~mask) | (mask * value);
199 /* acpi interface wrappers
202 static int write_acpi_int(const char *methodName, int val)
206 status = acpi_execute_simple_method(NULL, (char *)methodName, val);
207 return (status == AE_OK) ? 0 : -EIO;
210 /* Perform a raw HCI call. Here we don't care about input or output buffer
213 static acpi_status hci_raw(struct toshiba_acpi_dev *dev,
214 const u32 in[HCI_WORDS], u32 out[HCI_WORDS])
216 struct acpi_object_list params;
217 union acpi_object in_objs[HCI_WORDS];
218 struct acpi_buffer results;
219 union acpi_object out_objs[HCI_WORDS + 1];
223 params.count = HCI_WORDS;
224 params.pointer = in_objs;
225 for (i = 0; i < HCI_WORDS; ++i) {
226 in_objs[i].type = ACPI_TYPE_INTEGER;
227 in_objs[i].integer.value = in[i];
230 results.length = sizeof(out_objs);
231 results.pointer = out_objs;
233 status = acpi_evaluate_object(dev->acpi_dev->handle,
234 (char *)dev->method_hci, ¶ms,
236 if ((status == AE_OK) && (out_objs->package.count <= HCI_WORDS)) {
237 for (i = 0; i < out_objs->package.count; ++i) {
238 out[i] = out_objs->package.elements[i].integer.value;
245 /* common hci tasks (get or set one or two value)
247 * In addition to the ACPI status, the HCI system returns a result which
248 * may be useful (such as "not supported").
251 static acpi_status hci_write1(struct toshiba_acpi_dev *dev, u32 reg,
252 u32 in1, u32 *result)
254 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, 0, 0, 0 };
256 acpi_status status = hci_raw(dev, in, out);
257 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
261 static acpi_status hci_read1(struct toshiba_acpi_dev *dev, u32 reg,
262 u32 *out1, u32 *result)
264 u32 in[HCI_WORDS] = { HCI_GET, reg, 0, 0, 0, 0 };
266 acpi_status status = hci_raw(dev, in, out);
268 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
272 static acpi_status hci_write2(struct toshiba_acpi_dev *dev, u32 reg,
273 u32 in1, u32 in2, u32 *result)
275 u32 in[HCI_WORDS] = { HCI_SET, reg, in1, in2, 0, 0 };
277 acpi_status status = hci_raw(dev, in, out);
278 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
282 static acpi_status hci_read2(struct toshiba_acpi_dev *dev, u32 reg,
283 u32 *out1, u32 *out2, u32 *result)
285 u32 in[HCI_WORDS] = { HCI_GET, reg, *out1, *out2, 0, 0 };
287 acpi_status status = hci_raw(dev, in, out);
290 *result = (status == AE_OK) ? out[0] : HCI_FAILURE;
297 static int sci_open(struct toshiba_acpi_dev *dev)
299 u32 in[HCI_WORDS] = { SCI_OPEN, 0, 0, 0, 0, 0 };
303 status = hci_raw(dev, in, out);
304 if (ACPI_FAILURE(status) || out[0] == HCI_FAILURE) {
305 pr_err("ACPI call to open SCI failed\n");
309 if (out[0] == SCI_OPEN_CLOSE_OK) {
311 } else if (out[0] == SCI_ALREADY_OPEN) {
312 pr_info("Toshiba SCI already opened\n");
314 } else if (out[0] == SCI_NOT_PRESENT) {
315 pr_info("Toshiba SCI is not present\n");
321 static void sci_close(struct toshiba_acpi_dev *dev)
323 u32 in[HCI_WORDS] = { SCI_CLOSE, 0, 0, 0, 0, 0 };
327 status = hci_raw(dev, in, out);
328 if (ACPI_FAILURE(status) || out[0] == HCI_FAILURE) {
329 pr_err("ACPI call to close SCI failed\n");
333 if (out[0] == SCI_OPEN_CLOSE_OK)
335 else if (out[0] == SCI_NOT_OPENED)
336 pr_info("Toshiba SCI not opened\n");
337 else if (out[0] == SCI_NOT_PRESENT)
338 pr_info("Toshiba SCI is not present\n");
341 static acpi_status sci_read(struct toshiba_acpi_dev *dev, u32 reg,
342 u32 *out1, u32 *result)
344 u32 in[HCI_WORDS] = { SCI_GET, reg, 0, 0, 0, 0 };
346 acpi_status status = hci_raw(dev, in, out);
348 *result = (ACPI_SUCCESS(status)) ? out[0] : HCI_FAILURE;
352 static acpi_status sci_write(struct toshiba_acpi_dev *dev, u32 reg,
353 u32 in1, u32 *result)
355 u32 in[HCI_WORDS] = { SCI_SET, reg, in1, 0, 0, 0 };
357 acpi_status status = hci_raw(dev, in, out);
358 *result = (ACPI_SUCCESS(status)) ? out[0] : HCI_FAILURE;
362 /* Illumination support */
363 static int toshiba_illumination_available(struct toshiba_acpi_dev *dev)
365 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
370 status = hci_raw(dev, in, out);
371 if (ACPI_FAILURE(status)) {
372 pr_info("Illumination device not available\n");
376 status = hci_raw(dev, in, out);
380 static void toshiba_illumination_set(struct led_classdev *cdev,
381 enum led_brightness brightness)
383 struct toshiba_acpi_dev *dev = container_of(cdev,
384 struct toshiba_acpi_dev, led_dev);
385 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
389 /* First request : initialize communication. */
391 status = hci_raw(dev, in, out);
392 if (ACPI_FAILURE(status)) {
393 pr_info("Illumination device not available\n");
398 /* Switch the illumination on */
402 status = hci_raw(dev, in, out);
403 if (ACPI_FAILURE(status)) {
404 pr_info("ACPI call for illumination failed\n");
408 /* Switch the illumination off */
412 status = hci_raw(dev, in, out);
413 if (ACPI_FAILURE(status)) {
414 pr_info("ACPI call for illumination failed.\n");
419 /* Last request : close communication. */
423 hci_raw(dev, in, out);
426 static enum led_brightness toshiba_illumination_get(struct led_classdev *cdev)
428 struct toshiba_acpi_dev *dev = container_of(cdev,
429 struct toshiba_acpi_dev, led_dev);
430 u32 in[HCI_WORDS] = { 0, 0, 0, 0, 0, 0 };
433 enum led_brightness result;
435 /*Â First request : initialize communication. */
437 status = hci_raw(dev, in, out);
438 if (ACPI_FAILURE(status)) {
439 pr_info("Illumination device not available\n");
443 /* Check the illumination */
446 status = hci_raw(dev, in, out);
447 if (ACPI_FAILURE(status)) {
448 pr_info("ACPI call for illumination failed.\n");
452 result = out[2] ? LED_FULL : LED_OFF;
454 /* Last request : close communication. */
458 hci_raw(dev, in, out);
463 /* Bluetooth rfkill handlers */
465 static u32 hci_get_bt_present(struct toshiba_acpi_dev *dev, bool *present)
472 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
473 if (hci_result == HCI_SUCCESS)
474 *present = (value & HCI_WIRELESS_BT_PRESENT) ? true : false;
479 static u32 hci_get_radio_state(struct toshiba_acpi_dev *dev, bool *radio_state)
486 hci_read2(dev, HCI_WIRELESS, &value, &value2, &hci_result);
488 *radio_state = value & HCI_WIRELESS_KILL_SWITCH;
492 static int bt_rfkill_set_block(void *data, bool blocked)
494 struct toshiba_acpi_dev *dev = data;
495 u32 result1, result2;
500 value = (blocked == false);
502 mutex_lock(&dev->mutex);
503 if (hci_get_radio_state(dev, &radio_state) != HCI_SUCCESS) {
513 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_POWER, &result1);
514 hci_write2(dev, HCI_WIRELESS, value, HCI_WIRELESS_BT_ATTACH, &result2);
516 if (result1 != HCI_SUCCESS || result2 != HCI_SUCCESS)
521 mutex_unlock(&dev->mutex);
525 static void bt_rfkill_poll(struct rfkill *rfkill, void *data)
530 struct toshiba_acpi_dev *dev = data;
532 mutex_lock(&dev->mutex);
534 hci_result = hci_get_radio_state(dev, &value);
535 if (hci_result != HCI_SUCCESS) {
536 /* Can't do anything useful */
537 mutex_unlock(&dev->mutex);
541 new_rfk_state = value;
543 mutex_unlock(&dev->mutex);
545 if (rfkill_set_hw_state(rfkill, !new_rfk_state))
546 bt_rfkill_set_block(data, true);
549 static const struct rfkill_ops toshiba_rfk_ops = {
550 .set_block = bt_rfkill_set_block,
551 .poll = bt_rfkill_poll,
554 static int get_tr_backlight_status(struct toshiba_acpi_dev *dev, bool *enabled)
559 hci_read1(dev, HCI_TR_BACKLIGHT, &status, &hci_result);
561 return hci_result == HCI_SUCCESS ? 0 : -EIO;
564 static int set_tr_backlight_status(struct toshiba_acpi_dev *dev, bool enable)
569 hci_write1(dev, HCI_TR_BACKLIGHT, value, &hci_result);
570 return hci_result == HCI_SUCCESS ? 0 : -EIO;
573 static struct proc_dir_entry *toshiba_proc_dir /*= 0*/ ;
575 static int __get_lcd_brightness(struct toshiba_acpi_dev *dev)
581 if (dev->tr_backlight_supported) {
583 int ret = get_tr_backlight_status(dev, &enabled);
591 hci_read1(dev, HCI_LCD_BRIGHTNESS, &value, &hci_result);
592 if (hci_result == HCI_SUCCESS)
593 return brightness + (value >> HCI_LCD_BRIGHTNESS_SHIFT);
598 static int get_lcd_brightness(struct backlight_device *bd)
600 struct toshiba_acpi_dev *dev = bl_get_data(bd);
601 return __get_lcd_brightness(dev);
604 static int lcd_proc_show(struct seq_file *m, void *v)
606 struct toshiba_acpi_dev *dev = m->private;
610 if (!dev->backlight_dev)
613 levels = dev->backlight_dev->props.max_brightness + 1;
614 value = get_lcd_brightness(dev->backlight_dev);
616 seq_printf(m, "brightness: %d\n", value);
617 seq_printf(m, "brightness_levels: %d\n", levels);
621 pr_err("Error reading LCD brightness\n");
625 static int lcd_proc_open(struct inode *inode, struct file *file)
627 return single_open(file, lcd_proc_show, PDE_DATA(inode));
630 static int set_lcd_brightness(struct toshiba_acpi_dev *dev, int value)
634 if (dev->tr_backlight_supported) {
635 bool enable = !value;
636 int ret = set_tr_backlight_status(dev, enable);
643 value = value << HCI_LCD_BRIGHTNESS_SHIFT;
644 hci_write1(dev, HCI_LCD_BRIGHTNESS, value, &hci_result);
645 return hci_result == HCI_SUCCESS ? 0 : -EIO;
648 static int set_lcd_status(struct backlight_device *bd)
650 struct toshiba_acpi_dev *dev = bl_get_data(bd);
651 return set_lcd_brightness(dev, bd->props.brightness);
654 static ssize_t lcd_proc_write(struct file *file, const char __user *buf,
655 size_t count, loff_t *pos)
657 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
662 int levels = dev->backlight_dev->props.max_brightness + 1;
664 len = min(count, sizeof(cmd) - 1);
665 if (copy_from_user(cmd, buf, len))
669 if (sscanf(cmd, " brightness : %i", &value) == 1 &&
670 value >= 0 && value < levels) {
671 ret = set_lcd_brightness(dev, value);
680 static const struct file_operations lcd_proc_fops = {
681 .owner = THIS_MODULE,
682 .open = lcd_proc_open,
685 .release = single_release,
686 .write = lcd_proc_write,
689 static int get_video_status(struct toshiba_acpi_dev *dev, u32 *status)
693 hci_read1(dev, HCI_VIDEO_OUT, status, &hci_result);
694 return hci_result == HCI_SUCCESS ? 0 : -EIO;
697 static int video_proc_show(struct seq_file *m, void *v)
699 struct toshiba_acpi_dev *dev = m->private;
703 ret = get_video_status(dev, &value);
705 int is_lcd = (value & HCI_VIDEO_OUT_LCD) ? 1 : 0;
706 int is_crt = (value & HCI_VIDEO_OUT_CRT) ? 1 : 0;
707 int is_tv = (value & HCI_VIDEO_OUT_TV) ? 1 : 0;
708 seq_printf(m, "lcd_out: %d\n", is_lcd);
709 seq_printf(m, "crt_out: %d\n", is_crt);
710 seq_printf(m, "tv_out: %d\n", is_tv);
716 static int video_proc_open(struct inode *inode, struct file *file)
718 return single_open(file, video_proc_show, PDE_DATA(inode));
721 static ssize_t video_proc_write(struct file *file, const char __user *buf,
722 size_t count, loff_t *pos)
724 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
734 cmd = kmalloc(count + 1, GFP_KERNEL);
737 if (copy_from_user(cmd, buf, count)) {
745 /* scan expression. Multiple expressions may be delimited with ;
747 * NOTE: to keep scanning simple, invalid fields are ignored
750 if (sscanf(buffer, " lcd_out : %i", &value) == 1)
752 else if (sscanf(buffer, " crt_out : %i", &value) == 1)
754 else if (sscanf(buffer, " tv_out : %i", &value) == 1)
756 /* advance to one character past the next ; */
761 while (remain && *(buffer - 1) != ';');
766 ret = get_video_status(dev, &video_out);
768 unsigned int new_video_out = video_out;
770 _set_bit(&new_video_out, HCI_VIDEO_OUT_LCD, lcd_out);
772 _set_bit(&new_video_out, HCI_VIDEO_OUT_CRT, crt_out);
774 _set_bit(&new_video_out, HCI_VIDEO_OUT_TV, tv_out);
775 /* To avoid unnecessary video disruption, only write the new
776 * video setting if something changed. */
777 if (new_video_out != video_out)
778 ret = write_acpi_int(METHOD_VIDEO_OUT, new_video_out);
781 return ret ? ret : count;
784 static const struct file_operations video_proc_fops = {
785 .owner = THIS_MODULE,
786 .open = video_proc_open,
789 .release = single_release,
790 .write = video_proc_write,
793 static int get_fan_status(struct toshiba_acpi_dev *dev, u32 *status)
797 hci_read1(dev, HCI_FAN, status, &hci_result);
798 return hci_result == HCI_SUCCESS ? 0 : -EIO;
801 static int fan_proc_show(struct seq_file *m, void *v)
803 struct toshiba_acpi_dev *dev = m->private;
807 ret = get_fan_status(dev, &value);
809 seq_printf(m, "running: %d\n", (value > 0));
810 seq_printf(m, "force_on: %d\n", dev->force_fan);
816 static int fan_proc_open(struct inode *inode, struct file *file)
818 return single_open(file, fan_proc_show, PDE_DATA(inode));
821 static ssize_t fan_proc_write(struct file *file, const char __user *buf,
822 size_t count, loff_t *pos)
824 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
830 len = min(count, sizeof(cmd) - 1);
831 if (copy_from_user(cmd, buf, len))
835 if (sscanf(cmd, " force_on : %i", &value) == 1 &&
836 value >= 0 && value <= 1) {
837 hci_write1(dev, HCI_FAN, value, &hci_result);
838 if (hci_result != HCI_SUCCESS)
841 dev->force_fan = value;
849 static const struct file_operations fan_proc_fops = {
850 .owner = THIS_MODULE,
851 .open = fan_proc_open,
854 .release = single_release,
855 .write = fan_proc_write,
858 static int keys_proc_show(struct seq_file *m, void *v)
860 struct toshiba_acpi_dev *dev = m->private;
864 if (!dev->key_event_valid && dev->system_event_supported) {
865 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
866 if (hci_result == HCI_SUCCESS) {
867 dev->key_event_valid = 1;
868 dev->last_key_event = value;
869 } else if (hci_result == HCI_EMPTY) {
870 /* better luck next time */
871 } else if (hci_result == HCI_NOT_SUPPORTED) {
872 /* This is a workaround for an unresolved issue on
873 * some machines where system events sporadically
874 * become disabled. */
875 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
876 pr_notice("Re-enabled hotkeys\n");
878 pr_err("Error reading hotkey status\n");
883 seq_printf(m, "hotkey_ready: %d\n", dev->key_event_valid);
884 seq_printf(m, "hotkey: 0x%04x\n", dev->last_key_event);
888 static int keys_proc_open(struct inode *inode, struct file *file)
890 return single_open(file, keys_proc_show, PDE_DATA(inode));
893 static ssize_t keys_proc_write(struct file *file, const char __user *buf,
894 size_t count, loff_t *pos)
896 struct toshiba_acpi_dev *dev = PDE_DATA(file_inode(file));
901 len = min(count, sizeof(cmd) - 1);
902 if (copy_from_user(cmd, buf, len))
906 if (sscanf(cmd, " hotkey_ready : %i", &value) == 1 && value == 0) {
907 dev->key_event_valid = 0;
915 static const struct file_operations keys_proc_fops = {
916 .owner = THIS_MODULE,
917 .open = keys_proc_open,
920 .release = single_release,
921 .write = keys_proc_write,
924 static int version_proc_show(struct seq_file *m, void *v)
926 seq_printf(m, "driver: %s\n", TOSHIBA_ACPI_VERSION);
927 seq_printf(m, "proc_interface: %d\n", PROC_INTERFACE_VERSION);
931 static int version_proc_open(struct inode *inode, struct file *file)
933 return single_open(file, version_proc_show, PDE_DATA(inode));
936 static const struct file_operations version_proc_fops = {
937 .owner = THIS_MODULE,
938 .open = version_proc_open,
941 .release = single_release,
944 /* proc and module init
947 #define PROC_TOSHIBA "toshiba"
949 static void create_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
951 if (dev->backlight_dev)
952 proc_create_data("lcd", S_IRUGO | S_IWUSR, toshiba_proc_dir,
953 &lcd_proc_fops, dev);
954 if (dev->video_supported)
955 proc_create_data("video", S_IRUGO | S_IWUSR, toshiba_proc_dir,
956 &video_proc_fops, dev);
957 if (dev->fan_supported)
958 proc_create_data("fan", S_IRUGO | S_IWUSR, toshiba_proc_dir,
959 &fan_proc_fops, dev);
961 proc_create_data("keys", S_IRUGO | S_IWUSR, toshiba_proc_dir,
962 &keys_proc_fops, dev);
963 proc_create_data("version", S_IRUGO, toshiba_proc_dir,
964 &version_proc_fops, dev);
967 static void remove_toshiba_proc_entries(struct toshiba_acpi_dev *dev)
969 if (dev->backlight_dev)
970 remove_proc_entry("lcd", toshiba_proc_dir);
971 if (dev->video_supported)
972 remove_proc_entry("video", toshiba_proc_dir);
973 if (dev->fan_supported)
974 remove_proc_entry("fan", toshiba_proc_dir);
976 remove_proc_entry("keys", toshiba_proc_dir);
977 remove_proc_entry("version", toshiba_proc_dir);
980 static const struct backlight_ops toshiba_backlight_data = {
981 .options = BL_CORE_SUSPENDRESUME,
982 .get_brightness = get_lcd_brightness,
983 .update_status = set_lcd_status,
986 static bool toshiba_acpi_i8042_filter(unsigned char data, unsigned char str,
992 if (unlikely(data == 0xe0))
995 if ((data & 0x7f) == TOS1900_FN_SCAN) {
996 schedule_work(&toshiba_acpi->hotkey_work);
1003 static void toshiba_acpi_hotkey_work(struct work_struct *work)
1005 acpi_handle ec_handle = ec_get_handle();
1011 status = acpi_evaluate_object(ec_handle, "NTFY", NULL, NULL);
1012 if (ACPI_FAILURE(status))
1013 pr_err("ACPI NTFY method execution failed\n");
1017 * Returns hotkey scancode, or < 0 on failure.
1019 static int toshiba_acpi_query_hotkey(struct toshiba_acpi_dev *dev)
1021 unsigned long long value;
1024 status = acpi_evaluate_integer(dev->acpi_dev->handle, "INFO",
1026 if (ACPI_FAILURE(status)) {
1027 pr_err("ACPI INFO method execution failed\n");
1034 static void toshiba_acpi_report_hotkey(struct toshiba_acpi_dev *dev,
1037 if (scancode == 0x100)
1040 /* act on key press; ignore key release */
1041 if (scancode & 0x80)
1044 if (!sparse_keymap_report_event(dev->hotkey_dev, scancode, 1, true))
1045 pr_info("Unknown key %x\n", scancode);
1048 static int toshiba_acpi_setup_keyboard(struct toshiba_acpi_dev *dev)
1051 acpi_handle ec_handle;
1055 dev->hotkey_dev = input_allocate_device();
1056 if (!dev->hotkey_dev)
1059 dev->hotkey_dev->name = "Toshiba input device";
1060 dev->hotkey_dev->phys = "toshiba_acpi/input0";
1061 dev->hotkey_dev->id.bustype = BUS_HOST;
1063 error = sparse_keymap_setup(dev->hotkey_dev, toshiba_acpi_keymap, NULL);
1068 * For some machines the SCI responsible for providing hotkey
1069 * notification doesn't fire. We can trigger the notification
1070 * whenever the Fn key is pressed using the NTFY method, if
1071 * supported, so if it's present set up an i8042 key filter
1075 ec_handle = ec_get_handle();
1076 if (ec_handle && acpi_has_method(ec_handle, "NTFY")) {
1077 INIT_WORK(&dev->hotkey_work, toshiba_acpi_hotkey_work);
1079 error = i8042_install_filter(toshiba_acpi_i8042_filter);
1081 pr_err("Error installing key filter\n");
1082 goto err_free_keymap;
1085 dev->ntfy_supported = 1;
1089 * Determine hotkey query interface. Prefer using the INFO
1090 * method when it is available.
1092 if (acpi_has_method(dev->acpi_dev->handle, "INFO"))
1093 dev->info_supported = 1;
1095 hci_write1(dev, HCI_SYSTEM_EVENT, 1, &hci_result);
1096 if (hci_result == HCI_SUCCESS)
1097 dev->system_event_supported = 1;
1100 if (!dev->info_supported && !dev->system_event_supported) {
1101 pr_warn("No hotkey query interface found\n");
1102 goto err_remove_filter;
1105 status = acpi_evaluate_object(dev->acpi_dev->handle, "ENAB", NULL, NULL);
1106 if (ACPI_FAILURE(status)) {
1107 pr_info("Unable to enable hotkeys\n");
1109 goto err_remove_filter;
1112 error = input_register_device(dev->hotkey_dev);
1114 pr_info("Unable to register input device\n");
1115 goto err_remove_filter;
1118 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &hci_result);
1122 if (dev->ntfy_supported)
1123 i8042_remove_filter(toshiba_acpi_i8042_filter);
1125 sparse_keymap_free(dev->hotkey_dev);
1127 input_free_device(dev->hotkey_dev);
1128 dev->hotkey_dev = NULL;
1132 static int toshiba_acpi_setup_backlight(struct toshiba_acpi_dev *dev)
1134 struct backlight_properties props;
1140 * Some machines don't support the backlight methods at all, and
1141 * others support it read-only. Either of these is pretty useless,
1142 * so only register the backlight device if the backlight method
1143 * supports both reads and writes.
1145 brightness = __get_lcd_brightness(dev);
1148 ret = set_lcd_brightness(dev, brightness);
1150 pr_debug("Backlight method is read-only, disabling backlight support\n");
1154 /* Determine whether or not BIOS supports transflective backlight */
1155 ret = get_tr_backlight_status(dev, &enabled);
1156 dev->tr_backlight_supported = !ret;
1158 memset(&props, 0, sizeof(props));
1159 props.type = BACKLIGHT_PLATFORM;
1160 props.max_brightness = HCI_LCD_BRIGHTNESS_LEVELS - 1;
1162 /* adding an extra level and having 0 change to transflective mode */
1163 if (dev->tr_backlight_supported)
1164 props.max_brightness++;
1166 dev->backlight_dev = backlight_device_register("toshiba",
1167 &dev->acpi_dev->dev,
1169 &toshiba_backlight_data,
1171 if (IS_ERR(dev->backlight_dev)) {
1172 ret = PTR_ERR(dev->backlight_dev);
1173 pr_err("Could not register toshiba backlight device\n");
1174 dev->backlight_dev = NULL;
1178 dev->backlight_dev->props.brightness = brightness;
1182 static int toshiba_acpi_remove(struct acpi_device *acpi_dev)
1184 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1186 remove_toshiba_proc_entries(dev);
1188 if (dev->ntfy_supported) {
1189 i8042_remove_filter(toshiba_acpi_i8042_filter);
1190 cancel_work_sync(&dev->hotkey_work);
1193 if (dev->hotkey_dev) {
1194 input_unregister_device(dev->hotkey_dev);
1195 sparse_keymap_free(dev->hotkey_dev);
1199 rfkill_unregister(dev->bt_rfk);
1200 rfkill_destroy(dev->bt_rfk);
1203 if (dev->backlight_dev)
1204 backlight_device_unregister(dev->backlight_dev);
1206 if (dev->illumination_supported)
1207 led_classdev_unregister(&dev->led_dev);
1210 toshiba_acpi = NULL;
1217 static const char *find_hci_method(acpi_handle handle)
1219 if (acpi_has_method(handle, "GHCI"))
1222 if (acpi_has_method(handle, "SPFC"))
1228 static int toshiba_acpi_add(struct acpi_device *acpi_dev)
1230 struct toshiba_acpi_dev *dev;
1231 const char *hci_method;
1239 pr_info("Toshiba Laptop ACPI Extras version %s\n",
1240 TOSHIBA_ACPI_VERSION);
1242 hci_method = find_hci_method(acpi_dev->handle);
1244 pr_err("HCI interface not found\n");
1248 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1251 dev->acpi_dev = acpi_dev;
1252 dev->method_hci = hci_method;
1253 acpi_dev->driver_data = dev;
1255 if (toshiba_acpi_setup_keyboard(dev))
1256 pr_info("Unable to activate hotkeys\n");
1258 mutex_init(&dev->mutex);
1260 ret = toshiba_acpi_setup_backlight(dev);
1264 /* Register rfkill switch for Bluetooth */
1265 if (hci_get_bt_present(dev, &bt_present) == HCI_SUCCESS && bt_present) {
1266 dev->bt_rfk = rfkill_alloc("Toshiba Bluetooth",
1268 RFKILL_TYPE_BLUETOOTH,
1272 pr_err("unable to allocate rfkill device\n");
1277 ret = rfkill_register(dev->bt_rfk);
1279 pr_err("unable to register rfkill device\n");
1280 rfkill_destroy(dev->bt_rfk);
1285 if (toshiba_illumination_available(dev)) {
1286 dev->led_dev.name = "toshiba::illumination";
1287 dev->led_dev.max_brightness = 1;
1288 dev->led_dev.brightness_set = toshiba_illumination_set;
1289 dev->led_dev.brightness_get = toshiba_illumination_get;
1290 if (!led_classdev_register(&acpi_dev->dev, &dev->led_dev))
1291 dev->illumination_supported = 1;
1294 /* Determine whether or not BIOS supports fan and video interfaces */
1296 ret = get_video_status(dev, &dummy);
1297 dev->video_supported = !ret;
1299 ret = get_fan_status(dev, &dummy);
1300 dev->fan_supported = !ret;
1302 create_toshiba_proc_entries(dev);
1309 toshiba_acpi_remove(acpi_dev);
1313 static void toshiba_acpi_notify(struct acpi_device *acpi_dev, u32 event)
1315 struct toshiba_acpi_dev *dev = acpi_driver_data(acpi_dev);
1316 u32 hci_result, value;
1323 if (dev->info_supported) {
1324 scancode = toshiba_acpi_query_hotkey(dev);
1326 pr_err("Failed to query hotkey event\n");
1327 else if (scancode != 0)
1328 toshiba_acpi_report_hotkey(dev, scancode);
1329 } else if (dev->system_event_supported) {
1331 hci_read1(dev, HCI_SYSTEM_EVENT, &value, &hci_result);
1332 switch (hci_result) {
1334 toshiba_acpi_report_hotkey(dev, (int)value);
1336 case HCI_NOT_SUPPORTED:
1338 * This is a workaround for an unresolved
1339 * issue on some machines where system events
1340 * sporadically become disabled.
1342 hci_write1(dev, HCI_SYSTEM_EVENT, 1,
1344 pr_notice("Re-enabled hotkeys\n");
1350 } while (retries && hci_result != HCI_EMPTY);
1354 #ifdef CONFIG_PM_SLEEP
1355 static int toshiba_acpi_suspend(struct device *device)
1357 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1360 if (dev->hotkey_dev)
1361 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_DISABLE, &result);
1366 static int toshiba_acpi_resume(struct device *device)
1368 struct toshiba_acpi_dev *dev = acpi_driver_data(to_acpi_device(device));
1371 if (dev->hotkey_dev)
1372 hci_write1(dev, HCI_HOTKEY_EVENT, HCI_HOTKEY_ENABLE, &result);
1378 static SIMPLE_DEV_PM_OPS(toshiba_acpi_pm,
1379 toshiba_acpi_suspend, toshiba_acpi_resume);
1381 static struct acpi_driver toshiba_acpi_driver = {
1382 .name = "Toshiba ACPI driver",
1383 .owner = THIS_MODULE,
1384 .ids = toshiba_device_ids,
1385 .flags = ACPI_DRIVER_ALL_NOTIFY_EVENTS,
1387 .add = toshiba_acpi_add,
1388 .remove = toshiba_acpi_remove,
1389 .notify = toshiba_acpi_notify,
1391 .drv.pm = &toshiba_acpi_pm,
1394 static int __init toshiba_acpi_init(void)
1399 * Machines with this WMI guid aren't supported due to bugs in
1400 * their AML. This check relies on wmi initializing before
1401 * toshiba_acpi to guarantee guids have been identified.
1403 if (wmi_has_guid(TOSHIBA_WMI_EVENT_GUID))
1406 toshiba_proc_dir = proc_mkdir(PROC_TOSHIBA, acpi_root_dir);
1407 if (!toshiba_proc_dir) {
1408 pr_err("Unable to create proc dir " PROC_TOSHIBA "\n");
1412 ret = acpi_bus_register_driver(&toshiba_acpi_driver);
1414 pr_err("Failed to register ACPI driver: %d\n", ret);
1415 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1421 static void __exit toshiba_acpi_exit(void)
1423 acpi_bus_unregister_driver(&toshiba_acpi_driver);
1424 if (toshiba_proc_dir)
1425 remove_proc_entry(PROC_TOSHIBA, acpi_root_dir);
1428 module_init(toshiba_acpi_init);
1429 module_exit(toshiba_acpi_exit);