2 * Fujitsu Lifebook Application Panel button drive
4 * Copyright (C) 2007 Stephen Hemminger <shemminger@linux-foundation.org>
5 * Copyright (C) 2001-2003 Jochen Eisinger <jochen@penguin-breeder.org>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published by
9 * the Free Software Foundation.
11 * Many Fujitsu Lifebook laptops have a small panel of buttons that are
12 * accessible via the i2c/smbus interface. This driver polls those
13 * buttons and generates input events.
15 * For more details see:
16 * http://apanel.sourceforge.net/tech.php
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/ioport.h>
23 #include <linux/input-polldev.h>
24 #include <linux/i2c.h>
25 #include <linux/workqueue.h>
26 #include <linux/leds.h>
28 #define APANEL_NAME "Fujitsu Application Panel"
29 #define APANEL "apanel"
31 /* How often we poll keys - msecs */
32 #define POLL_INTERVAL_DEFAULT 1000
34 /* Magic constants in BIOS that tell about buttons */
37 APANEL_DEV_APPBTN = 1,
52 /* Result of BIOS snooping/probing -- what features are supported */
53 static enum apanel_chip device_chip[APANEL_DEV_MAX];
55 #define MAX_PANEL_KEYS 12
58 struct input_polled_dev *ipdev;
59 struct i2c_client *client;
60 unsigned short keymap[MAX_PANEL_KEYS];
63 struct work_struct led_work;
64 struct led_classdev mail_led;
68 static int apanel_probe(struct i2c_client *, const struct i2c_device_id *);
70 static void report_key(struct input_dev *input, unsigned keycode)
72 pr_debug(APANEL ": report key %#x\n", keycode);
73 input_report_key(input, keycode, 1);
76 input_report_key(input, keycode, 0);
80 /* Poll for key changes
82 * Read Application keys via SMI
83 * A (0x4), B (0x8), Internet (0x2), Email (0x1).
86 * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800)
88 static void apanel_poll(struct input_polled_dev *ipdev)
90 struct apanel *ap = ipdev->private;
91 struct input_dev *idev = ipdev->input;
92 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
96 data = i2c_smbus_read_word_data(ap->client, cmd);
98 return; /* ignore errors (due to ACPI??) */
100 /* write back to clear latch */
101 i2c_smbus_write_word_data(ap->client, cmd, 0);
106 dev_dbg(&idev->dev, APANEL ": data %#x\n", data);
107 for (i = 0; i < idev->keycodemax; i++)
108 if ((1u << i) & data)
109 report_key(idev, ap->keymap[i]);
112 /* Track state changes of LED */
113 static void led_update(struct work_struct *work)
115 struct apanel *ap = container_of(work, struct apanel, led_work);
117 i2c_smbus_write_word_data(ap->client, 0x10, ap->led_bits);
120 static void mail_led_set(struct led_classdev *led,
121 enum led_brightness value)
123 struct apanel *ap = container_of(led, struct apanel, mail_led);
125 if (value != LED_OFF)
126 ap->led_bits |= 0x8000;
128 ap->led_bits &= ~0x8000;
130 schedule_work(&ap->led_work);
133 static int apanel_remove(struct i2c_client *client)
135 struct apanel *ap = i2c_get_clientdata(client);
137 if (device_chip[APANEL_DEV_LED] != CHIP_NONE)
138 led_classdev_unregister(&ap->mail_led);
140 input_unregister_polled_device(ap->ipdev);
141 input_free_polled_device(ap->ipdev);
146 static void apanel_shutdown(struct i2c_client *client)
148 apanel_remove(client);
151 static const struct i2c_device_id apanel_id[] = {
152 { "fujitsu_apanel", 0 },
155 MODULE_DEVICE_TABLE(i2c, apanel_id);
157 static struct i2c_driver apanel_driver = {
161 .probe = &apanel_probe,
162 .remove = &apanel_remove,
163 .shutdown = &apanel_shutdown,
164 .id_table = apanel_id,
167 static struct apanel apanel = {
177 [11] = KEY_PLAYPAUSE,
182 .brightness_set = mail_led_set,
186 /* NB: Only one panel on the i2c. */
187 static int apanel_probe(struct i2c_client *client,
188 const struct i2c_device_id *id)
191 struct input_polled_dev *ipdev;
192 struct input_dev *idev;
193 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
194 int i, err = -ENOMEM;
198 ipdev = input_allocate_polled_device();
205 i2c_set_clientdata(client, ap);
207 err = i2c_smbus_write_word_data(client, cmd, 0);
209 dev_warn(&client->dev, APANEL ": smbus write error %d\n",
214 ipdev->poll = apanel_poll;
215 ipdev->poll_interval = POLL_INTERVAL_DEFAULT;
219 idev->name = APANEL_NAME " buttons";
220 idev->phys = "apanel/input0";
221 idev->id.bustype = BUS_HOST;
222 idev->dev.parent = &client->dev;
224 set_bit(EV_KEY, idev->evbit);
226 idev->keycode = ap->keymap;
227 idev->keycodesize = sizeof(ap->keymap[0]);
228 idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4;
230 for (i = 0; i < idev->keycodemax; i++)
232 set_bit(ap->keymap[i], idev->keybit);
234 err = input_register_polled_device(ipdev);
238 INIT_WORK(&ap->led_work, led_update);
239 if (device_chip[APANEL_DEV_LED] != CHIP_NONE) {
240 err = led_classdev_register(&client->dev, &ap->mail_led);
247 input_unregister_polled_device(ipdev);
249 input_free_polled_device(ipdev);
254 /* Scan the system ROM for the signature "FJKEYINF" */
255 static __init const void __iomem *bios_signature(const void __iomem *bios)
258 const unsigned char signature[] = "FJKEYINF";
260 for (offset = 0; offset < 0x10000; offset += 0x10) {
261 if (check_signature(bios + offset, signature,
262 sizeof(signature)-1))
263 return bios + offset;
265 pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n",
270 static int __init apanel_init(void)
273 const void __iomem *p;
275 unsigned char i2c_addr;
278 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
280 p = bios_signature(bios);
286 /* just use the first address */
288 i2c_addr = readb(p + 3) >> 1;
290 for ( ; (devno = readb(p)) & 0x7f; p += 4) {
291 unsigned char method, slave, chip;
293 method = readb(p + 1);
295 slave = readb(p + 3) >> 1;
297 if (slave != i2c_addr) {
298 pr_notice(APANEL ": only one SMBus slave "
299 "address supported, skipping device...\n");
303 /* translate alternative device numbers */
306 devno = APANEL_DEV_APPBTN;
309 devno = APANEL_DEV_LED;
313 if (devno >= APANEL_DEV_MAX)
314 pr_notice(APANEL ": unknown device %u found\n", devno);
315 else if (device_chip[devno] != CHIP_NONE)
316 pr_warn(APANEL ": duplicate entry for devno %u\n",
319 else if (method != 1 && method != 2 && method != 4) {
320 pr_notice(APANEL ": unknown method %u for devno %u\n",
323 device_chip[devno] = (enum apanel_chip) chip;
330 pr_info(APANEL ": no input devices reported by BIOS\n");
334 return i2c_add_driver(&apanel_driver);
336 module_init(apanel_init);
338 static void __exit apanel_cleanup(void)
340 i2c_del_driver(&apanel_driver);
342 module_exit(apanel_cleanup);
344 MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>");
345 MODULE_DESCRIPTION(APANEL_NAME " driver");
346 MODULE_LICENSE("GPL");
348 MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*");
349 MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*");