152fe0cdbSStephen Hemminger /* 252fe0cdbSStephen Hemminger * Fujitsu Lifebook Application Panel button drive 352fe0cdbSStephen Hemminger * 452fe0cdbSStephen Hemminger * Copyright (C) 2007 Stephen Hemminger <shemminger@linux-foundation.org> 552fe0cdbSStephen Hemminger * Copyright (C) 2001-2003 Jochen Eisinger <jochen@penguin-breeder.org> 652fe0cdbSStephen Hemminger * 752fe0cdbSStephen Hemminger * This program is free software; you can redistribute it and/or modify it 852fe0cdbSStephen Hemminger * under the terms of the GNU General Public License version 2 as published by 952fe0cdbSStephen Hemminger * the Free Software Foundation. 1052fe0cdbSStephen Hemminger * 1152fe0cdbSStephen Hemminger * Many Fujitsu Lifebook laptops have a small panel of buttons that are 1252fe0cdbSStephen Hemminger * accessible via the i2c/smbus interface. This driver polls those 1352fe0cdbSStephen Hemminger * buttons and generates input events. 1452fe0cdbSStephen Hemminger * 1552fe0cdbSStephen Hemminger * For more details see: 1652fe0cdbSStephen Hemminger * http://apanel.sourceforge.net/tech.php 1752fe0cdbSStephen Hemminger */ 1852fe0cdbSStephen Hemminger 1952fe0cdbSStephen Hemminger #include <linux/kernel.h> 2052fe0cdbSStephen Hemminger #include <linux/module.h> 2152fe0cdbSStephen Hemminger #include <linux/ioport.h> 2252fe0cdbSStephen Hemminger #include <linux/io.h> 2352fe0cdbSStephen Hemminger #include <linux/input-polldev.h> 2452fe0cdbSStephen Hemminger #include <linux/i2c.h> 2552fe0cdbSStephen Hemminger #include <linux/workqueue.h> 2652fe0cdbSStephen Hemminger #include <linux/leds.h> 2752fe0cdbSStephen Hemminger 2852fe0cdbSStephen Hemminger #define APANEL_NAME "Fujitsu Application Panel" 2952fe0cdbSStephen Hemminger #define APANEL_VERSION "1.3.1" 3052fe0cdbSStephen Hemminger #define APANEL "apanel" 3152fe0cdbSStephen Hemminger 3252fe0cdbSStephen Hemminger /* How often we poll keys - msecs */ 3352fe0cdbSStephen Hemminger #define POLL_INTERVAL_DEFAULT 1000 3452fe0cdbSStephen Hemminger 3552fe0cdbSStephen Hemminger /* Magic constants in BIOS that tell about buttons */ 3652fe0cdbSStephen Hemminger enum apanel_devid { 3752fe0cdbSStephen Hemminger APANEL_DEV_NONE = 0, 3852fe0cdbSStephen Hemminger APANEL_DEV_APPBTN = 1, 3952fe0cdbSStephen Hemminger APANEL_DEV_CDBTN = 2, 4052fe0cdbSStephen Hemminger APANEL_DEV_LCD = 3, 4152fe0cdbSStephen Hemminger APANEL_DEV_LED = 4, 4252fe0cdbSStephen Hemminger 4352fe0cdbSStephen Hemminger APANEL_DEV_MAX, 4452fe0cdbSStephen Hemminger }; 4552fe0cdbSStephen Hemminger 4652fe0cdbSStephen Hemminger enum apanel_chip { 4752fe0cdbSStephen Hemminger CHIP_NONE = 0, 4852fe0cdbSStephen Hemminger CHIP_OZ992C = 1, 4952fe0cdbSStephen Hemminger CHIP_OZ163T = 2, 5052fe0cdbSStephen Hemminger CHIP_OZ711M3 = 4, 5152fe0cdbSStephen Hemminger }; 5252fe0cdbSStephen Hemminger 5352fe0cdbSStephen Hemminger /* Result of BIOS snooping/probing -- what features are supported */ 5452fe0cdbSStephen Hemminger static enum apanel_chip device_chip[APANEL_DEV_MAX]; 5552fe0cdbSStephen Hemminger 5652fe0cdbSStephen Hemminger #define MAX_PANEL_KEYS 12 5752fe0cdbSStephen Hemminger 5852fe0cdbSStephen Hemminger struct apanel { 5952fe0cdbSStephen Hemminger struct input_polled_dev *ipdev; 601561bfe5SJean Delvare struct i2c_client *client; 6152fe0cdbSStephen Hemminger unsigned short keymap[MAX_PANEL_KEYS]; 6252fe0cdbSStephen Hemminger u16 nkeys; 6352fe0cdbSStephen Hemminger u16 led_bits; 6452fe0cdbSStephen Hemminger struct work_struct led_work; 6552fe0cdbSStephen Hemminger struct led_classdev mail_led; 6652fe0cdbSStephen Hemminger }; 6752fe0cdbSStephen Hemminger 6852fe0cdbSStephen Hemminger 691561bfe5SJean Delvare static int apanel_probe(struct i2c_client *, const struct i2c_device_id *); 7052fe0cdbSStephen Hemminger 7152fe0cdbSStephen Hemminger static void report_key(struct input_dev *input, unsigned keycode) 7252fe0cdbSStephen Hemminger { 7352fe0cdbSStephen Hemminger pr_debug(APANEL ": report key %#x\n", keycode); 7452fe0cdbSStephen Hemminger input_report_key(input, keycode, 1); 7552fe0cdbSStephen Hemminger input_sync(input); 7652fe0cdbSStephen Hemminger 7752fe0cdbSStephen Hemminger input_report_key(input, keycode, 0); 7852fe0cdbSStephen Hemminger input_sync(input); 7952fe0cdbSStephen Hemminger } 8052fe0cdbSStephen Hemminger 8152fe0cdbSStephen Hemminger /* Poll for key changes 8252fe0cdbSStephen Hemminger * 8352fe0cdbSStephen Hemminger * Read Application keys via SMI 8452fe0cdbSStephen Hemminger * A (0x4), B (0x8), Internet (0x2), Email (0x1). 8552fe0cdbSStephen Hemminger * 8652fe0cdbSStephen Hemminger * CD keys: 8752fe0cdbSStephen Hemminger * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800) 8852fe0cdbSStephen Hemminger */ 8952fe0cdbSStephen Hemminger static void apanel_poll(struct input_polled_dev *ipdev) 9052fe0cdbSStephen Hemminger { 9152fe0cdbSStephen Hemminger struct apanel *ap = ipdev->private; 9252fe0cdbSStephen Hemminger struct input_dev *idev = ipdev->input; 9352fe0cdbSStephen Hemminger u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 9452fe0cdbSStephen Hemminger s32 data; 9552fe0cdbSStephen Hemminger int i; 9652fe0cdbSStephen Hemminger 971561bfe5SJean Delvare data = i2c_smbus_read_word_data(ap->client, cmd); 9852fe0cdbSStephen Hemminger if (data < 0) 9952fe0cdbSStephen Hemminger return; /* ignore errors (due to ACPI??) */ 10052fe0cdbSStephen Hemminger 10152fe0cdbSStephen Hemminger /* write back to clear latch */ 1021561bfe5SJean Delvare i2c_smbus_write_word_data(ap->client, cmd, 0); 10352fe0cdbSStephen Hemminger 10452fe0cdbSStephen Hemminger if (!data) 10552fe0cdbSStephen Hemminger return; 10652fe0cdbSStephen Hemminger 10752fe0cdbSStephen Hemminger dev_dbg(&idev->dev, APANEL ": data %#x\n", data); 10852fe0cdbSStephen Hemminger for (i = 0; i < idev->keycodemax; i++) 10952fe0cdbSStephen Hemminger if ((1u << i) & data) 11052fe0cdbSStephen Hemminger report_key(idev, ap->keymap[i]); 11152fe0cdbSStephen Hemminger } 11252fe0cdbSStephen Hemminger 11352fe0cdbSStephen Hemminger /* Track state changes of LED */ 11452fe0cdbSStephen Hemminger static void led_update(struct work_struct *work) 11552fe0cdbSStephen Hemminger { 11652fe0cdbSStephen Hemminger struct apanel *ap = container_of(work, struct apanel, led_work); 11752fe0cdbSStephen Hemminger 1181561bfe5SJean Delvare i2c_smbus_write_word_data(ap->client, 0x10, ap->led_bits); 11952fe0cdbSStephen Hemminger } 12052fe0cdbSStephen Hemminger 12152fe0cdbSStephen Hemminger static void mail_led_set(struct led_classdev *led, 12252fe0cdbSStephen Hemminger enum led_brightness value) 12352fe0cdbSStephen Hemminger { 12452fe0cdbSStephen Hemminger struct apanel *ap = container_of(led, struct apanel, mail_led); 12552fe0cdbSStephen Hemminger 12652fe0cdbSStephen Hemminger if (value != LED_OFF) 12752fe0cdbSStephen Hemminger ap->led_bits |= 0x8000; 12852fe0cdbSStephen Hemminger else 12952fe0cdbSStephen Hemminger ap->led_bits &= ~0x8000; 13052fe0cdbSStephen Hemminger 13152fe0cdbSStephen Hemminger schedule_work(&ap->led_work); 13252fe0cdbSStephen Hemminger } 13352fe0cdbSStephen Hemminger 1341561bfe5SJean Delvare static int apanel_remove(struct i2c_client *client) 13552fe0cdbSStephen Hemminger { 13652fe0cdbSStephen Hemminger struct apanel *ap = i2c_get_clientdata(client); 13752fe0cdbSStephen Hemminger 13852fe0cdbSStephen Hemminger if (device_chip[APANEL_DEV_LED] != CHIP_NONE) 13952fe0cdbSStephen Hemminger led_classdev_unregister(&ap->mail_led); 14052fe0cdbSStephen Hemminger 14152fe0cdbSStephen Hemminger input_unregister_polled_device(ap->ipdev); 14252fe0cdbSStephen Hemminger input_free_polled_device(ap->ipdev); 14352fe0cdbSStephen Hemminger 14452fe0cdbSStephen Hemminger return 0; 14552fe0cdbSStephen Hemminger } 14652fe0cdbSStephen Hemminger 14752fe0cdbSStephen Hemminger static void apanel_shutdown(struct i2c_client *client) 14852fe0cdbSStephen Hemminger { 1491561bfe5SJean Delvare apanel_remove(client); 15052fe0cdbSStephen Hemminger } 15152fe0cdbSStephen Hemminger 1521561bfe5SJean Delvare static struct i2c_device_id apanel_id[] = { 1531561bfe5SJean Delvare { "fujitsu_apanel", 0 }, 1541561bfe5SJean Delvare { } 1551561bfe5SJean Delvare }; 1561561bfe5SJean Delvare MODULE_DEVICE_TABLE(i2c, apanel_id); 1571561bfe5SJean Delvare 15852fe0cdbSStephen Hemminger static struct i2c_driver apanel_driver = { 15952fe0cdbSStephen Hemminger .driver = { 16052fe0cdbSStephen Hemminger .name = APANEL, 16152fe0cdbSStephen Hemminger }, 1621561bfe5SJean Delvare .probe = &apanel_probe, 1631561bfe5SJean Delvare .remove = &apanel_remove, 16452fe0cdbSStephen Hemminger .shutdown = &apanel_shutdown, 1651561bfe5SJean Delvare .id_table = apanel_id, 16652fe0cdbSStephen Hemminger }; 16752fe0cdbSStephen Hemminger 16852fe0cdbSStephen Hemminger static struct apanel apanel = { 16952fe0cdbSStephen Hemminger .keymap = { 17052fe0cdbSStephen Hemminger [0] = KEY_MAIL, 17152fe0cdbSStephen Hemminger [1] = KEY_WWW, 17252fe0cdbSStephen Hemminger [2] = KEY_PROG2, 17352fe0cdbSStephen Hemminger [3] = KEY_PROG1, 17452fe0cdbSStephen Hemminger 17552fe0cdbSStephen Hemminger [8] = KEY_FORWARD, 17652fe0cdbSStephen Hemminger [9] = KEY_REWIND, 17752fe0cdbSStephen Hemminger [10] = KEY_STOPCD, 17852fe0cdbSStephen Hemminger [11] = KEY_PLAYPAUSE, 17952fe0cdbSStephen Hemminger 18052fe0cdbSStephen Hemminger }, 18152fe0cdbSStephen Hemminger .mail_led = { 18252fe0cdbSStephen Hemminger .name = "mail:blue", 18352fe0cdbSStephen Hemminger .brightness_set = mail_led_set, 18452fe0cdbSStephen Hemminger }, 18552fe0cdbSStephen Hemminger }; 18652fe0cdbSStephen Hemminger 18752fe0cdbSStephen Hemminger /* NB: Only one panel on the i2c. */ 1881561bfe5SJean Delvare static int apanel_probe(struct i2c_client *client, 1891561bfe5SJean Delvare const struct i2c_device_id *id) 19052fe0cdbSStephen Hemminger { 19152fe0cdbSStephen Hemminger struct apanel *ap; 19252fe0cdbSStephen Hemminger struct input_polled_dev *ipdev; 19352fe0cdbSStephen Hemminger struct input_dev *idev; 19452fe0cdbSStephen Hemminger u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 19552fe0cdbSStephen Hemminger int i, err = -ENOMEM; 19652fe0cdbSStephen Hemminger 19752fe0cdbSStephen Hemminger ap = &apanel; 19852fe0cdbSStephen Hemminger 19952fe0cdbSStephen Hemminger ipdev = input_allocate_polled_device(); 20052fe0cdbSStephen Hemminger if (!ipdev) 20152fe0cdbSStephen Hemminger goto out1; 20252fe0cdbSStephen Hemminger 20352fe0cdbSStephen Hemminger ap->ipdev = ipdev; 2041561bfe5SJean Delvare ap->client = client; 20552fe0cdbSStephen Hemminger 2061561bfe5SJean Delvare i2c_set_clientdata(client, ap); 20752fe0cdbSStephen Hemminger 2081561bfe5SJean Delvare err = i2c_smbus_write_word_data(client, cmd, 0); 20952fe0cdbSStephen Hemminger if (err) { 2101561bfe5SJean Delvare dev_warn(&client->dev, APANEL ": smbus write error %d\n", 21152fe0cdbSStephen Hemminger err); 21252fe0cdbSStephen Hemminger goto out3; 21352fe0cdbSStephen Hemminger } 21452fe0cdbSStephen Hemminger 21552fe0cdbSStephen Hemminger ipdev->poll = apanel_poll; 21652fe0cdbSStephen Hemminger ipdev->poll_interval = POLL_INTERVAL_DEFAULT; 21752fe0cdbSStephen Hemminger ipdev->private = ap; 21852fe0cdbSStephen Hemminger 21952fe0cdbSStephen Hemminger idev = ipdev->input; 22052fe0cdbSStephen Hemminger idev->name = APANEL_NAME " buttons"; 22152fe0cdbSStephen Hemminger idev->phys = "apanel/input0"; 22252fe0cdbSStephen Hemminger idev->id.bustype = BUS_HOST; 2231561bfe5SJean Delvare idev->dev.parent = &client->dev; 22452fe0cdbSStephen Hemminger 22552fe0cdbSStephen Hemminger set_bit(EV_KEY, idev->evbit); 22652fe0cdbSStephen Hemminger 22752fe0cdbSStephen Hemminger idev->keycode = ap->keymap; 22852fe0cdbSStephen Hemminger idev->keycodesize = sizeof(ap->keymap[0]); 22952fe0cdbSStephen Hemminger idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4; 23052fe0cdbSStephen Hemminger 23152fe0cdbSStephen Hemminger for (i = 0; i < idev->keycodemax; i++) 23252fe0cdbSStephen Hemminger if (ap->keymap[i]) 23352fe0cdbSStephen Hemminger set_bit(ap->keymap[i], idev->keybit); 23452fe0cdbSStephen Hemminger 23552fe0cdbSStephen Hemminger err = input_register_polled_device(ipdev); 23652fe0cdbSStephen Hemminger if (err) 23752fe0cdbSStephen Hemminger goto out3; 23852fe0cdbSStephen Hemminger 23952fe0cdbSStephen Hemminger INIT_WORK(&ap->led_work, led_update); 24052fe0cdbSStephen Hemminger if (device_chip[APANEL_DEV_LED] != CHIP_NONE) { 2411561bfe5SJean Delvare err = led_classdev_register(&client->dev, &ap->mail_led); 24252fe0cdbSStephen Hemminger if (err) 24352fe0cdbSStephen Hemminger goto out4; 24452fe0cdbSStephen Hemminger } 24552fe0cdbSStephen Hemminger 24652fe0cdbSStephen Hemminger return 0; 24752fe0cdbSStephen Hemminger out4: 24852fe0cdbSStephen Hemminger input_unregister_polled_device(ipdev); 24952fe0cdbSStephen Hemminger out3: 25052fe0cdbSStephen Hemminger input_free_polled_device(ipdev); 25152fe0cdbSStephen Hemminger out1: 25252fe0cdbSStephen Hemminger return err; 25352fe0cdbSStephen Hemminger } 25452fe0cdbSStephen Hemminger 25552fe0cdbSStephen Hemminger /* Scan the system ROM for the signature "FJKEYINF" */ 25652fe0cdbSStephen Hemminger static __init const void __iomem *bios_signature(const void __iomem *bios) 25752fe0cdbSStephen Hemminger { 25852fe0cdbSStephen Hemminger ssize_t offset; 25952fe0cdbSStephen Hemminger const unsigned char signature[] = "FJKEYINF"; 26052fe0cdbSStephen Hemminger 26152fe0cdbSStephen Hemminger for (offset = 0; offset < 0x10000; offset += 0x10) { 26252fe0cdbSStephen Hemminger if (check_signature(bios + offset, signature, 26352fe0cdbSStephen Hemminger sizeof(signature)-1)) 26452fe0cdbSStephen Hemminger return bios + offset; 26552fe0cdbSStephen Hemminger } 26652fe0cdbSStephen Hemminger pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n", 26752fe0cdbSStephen Hemminger signature); 26852fe0cdbSStephen Hemminger return NULL; 26952fe0cdbSStephen Hemminger } 27052fe0cdbSStephen Hemminger 27152fe0cdbSStephen Hemminger static int __init apanel_init(void) 27252fe0cdbSStephen Hemminger { 27352fe0cdbSStephen Hemminger void __iomem *bios; 27452fe0cdbSStephen Hemminger const void __iomem *p; 27552fe0cdbSStephen Hemminger u8 devno; 2761561bfe5SJean Delvare unsigned char i2c_addr; 27752fe0cdbSStephen Hemminger int found = 0; 27852fe0cdbSStephen Hemminger 27952fe0cdbSStephen Hemminger bios = ioremap(0xF0000, 0x10000); /* Can't fail */ 28052fe0cdbSStephen Hemminger 28152fe0cdbSStephen Hemminger p = bios_signature(bios); 28252fe0cdbSStephen Hemminger if (!p) { 28352fe0cdbSStephen Hemminger iounmap(bios); 28452fe0cdbSStephen Hemminger return -ENODEV; 28552fe0cdbSStephen Hemminger } 28652fe0cdbSStephen Hemminger 28752fe0cdbSStephen Hemminger /* just use the first address */ 28852fe0cdbSStephen Hemminger p += 8; 2891561bfe5SJean Delvare i2c_addr = readb(p + 3) >> 1; 29052fe0cdbSStephen Hemminger 29152fe0cdbSStephen Hemminger for ( ; (devno = readb(p)) & 0x7f; p += 4) { 29252fe0cdbSStephen Hemminger unsigned char method, slave, chip; 29352fe0cdbSStephen Hemminger 29452fe0cdbSStephen Hemminger method = readb(p + 1); 29552fe0cdbSStephen Hemminger chip = readb(p + 2); 29652fe0cdbSStephen Hemminger slave = readb(p + 3) >> 1; 29752fe0cdbSStephen Hemminger 2981561bfe5SJean Delvare if (slave != i2c_addr) { 29952fe0cdbSStephen Hemminger pr_notice(APANEL ": only one SMBus slave " 30052fe0cdbSStephen Hemminger "address supported, skiping device...\n"); 30152fe0cdbSStephen Hemminger continue; 30252fe0cdbSStephen Hemminger } 30352fe0cdbSStephen Hemminger 30452fe0cdbSStephen Hemminger /* translate alternative device numbers */ 30552fe0cdbSStephen Hemminger switch (devno) { 30652fe0cdbSStephen Hemminger case 6: 30752fe0cdbSStephen Hemminger devno = APANEL_DEV_APPBTN; 30852fe0cdbSStephen Hemminger break; 30952fe0cdbSStephen Hemminger case 7: 31052fe0cdbSStephen Hemminger devno = APANEL_DEV_LED; 31152fe0cdbSStephen Hemminger break; 31252fe0cdbSStephen Hemminger } 31352fe0cdbSStephen Hemminger 31452fe0cdbSStephen Hemminger if (devno >= APANEL_DEV_MAX) 31552fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown device %u found\n", devno); 31652fe0cdbSStephen Hemminger else if (device_chip[devno] != CHIP_NONE) 31752fe0cdbSStephen Hemminger pr_warning(APANEL ": duplicate entry for devno %u\n", devno); 31852fe0cdbSStephen Hemminger 31952fe0cdbSStephen Hemminger else if (method != 1 && method != 2 && method != 4) { 32052fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown method %u for devno %u\n", 32152fe0cdbSStephen Hemminger method, devno); 32252fe0cdbSStephen Hemminger } else { 32352fe0cdbSStephen Hemminger device_chip[devno] = (enum apanel_chip) chip; 32452fe0cdbSStephen Hemminger ++found; 32552fe0cdbSStephen Hemminger } 32652fe0cdbSStephen Hemminger } 32752fe0cdbSStephen Hemminger iounmap(bios); 32852fe0cdbSStephen Hemminger 32952fe0cdbSStephen Hemminger if (found == 0) { 33052fe0cdbSStephen Hemminger pr_info(APANEL ": no input devices reported by BIOS\n"); 33152fe0cdbSStephen Hemminger return -EIO; 33252fe0cdbSStephen Hemminger } 33352fe0cdbSStephen Hemminger 33452fe0cdbSStephen Hemminger return i2c_add_driver(&apanel_driver); 33552fe0cdbSStephen Hemminger } 33652fe0cdbSStephen Hemminger module_init(apanel_init); 33752fe0cdbSStephen Hemminger 33852fe0cdbSStephen Hemminger static void __exit apanel_cleanup(void) 33952fe0cdbSStephen Hemminger { 34052fe0cdbSStephen Hemminger i2c_del_driver(&apanel_driver); 34152fe0cdbSStephen Hemminger } 34252fe0cdbSStephen Hemminger module_exit(apanel_cleanup); 34352fe0cdbSStephen Hemminger 34452fe0cdbSStephen Hemminger MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>"); 34552fe0cdbSStephen Hemminger MODULE_DESCRIPTION(APANEL_NAME " driver"); 34652fe0cdbSStephen Hemminger MODULE_LICENSE("GPL"); 34752fe0cdbSStephen Hemminger MODULE_VERSION(APANEL_VERSION); 34852fe0cdbSStephen Hemminger 34952fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*"); 35052fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*"); 351