1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 252fe0cdbSStephen Hemminger /* 352fe0cdbSStephen Hemminger * Fujitsu Lifebook Application Panel button drive 452fe0cdbSStephen Hemminger * 552fe0cdbSStephen Hemminger * Copyright (C) 2007 Stephen Hemminger <shemminger@linux-foundation.org> 652fe0cdbSStephen Hemminger * Copyright (C) 2001-2003 Jochen Eisinger <jochen@penguin-breeder.org> 752fe0cdbSStephen Hemminger * 852fe0cdbSStephen Hemminger * Many Fujitsu Lifebook laptops have a small panel of buttons that are 952fe0cdbSStephen Hemminger * accessible via the i2c/smbus interface. This driver polls those 1052fe0cdbSStephen Hemminger * buttons and generates input events. 1152fe0cdbSStephen Hemminger * 1252fe0cdbSStephen Hemminger * For more details see: 1352fe0cdbSStephen Hemminger * http://apanel.sourceforge.net/tech.php 1452fe0cdbSStephen Hemminger */ 1552fe0cdbSStephen Hemminger 1652fe0cdbSStephen Hemminger #include <linux/kernel.h> 1752fe0cdbSStephen Hemminger #include <linux/module.h> 1852fe0cdbSStephen Hemminger #include <linux/ioport.h> 1952fe0cdbSStephen Hemminger #include <linux/io.h> 2052fe0cdbSStephen Hemminger #include <linux/input-polldev.h> 2152fe0cdbSStephen Hemminger #include <linux/i2c.h> 2252fe0cdbSStephen Hemminger #include <linux/leds.h> 2352fe0cdbSStephen Hemminger 2452fe0cdbSStephen Hemminger #define APANEL_NAME "Fujitsu Application Panel" 2552fe0cdbSStephen Hemminger #define APANEL "apanel" 2652fe0cdbSStephen Hemminger 2752fe0cdbSStephen Hemminger /* How often we poll keys - msecs */ 2852fe0cdbSStephen Hemminger #define POLL_INTERVAL_DEFAULT 1000 2952fe0cdbSStephen Hemminger 3052fe0cdbSStephen Hemminger /* Magic constants in BIOS that tell about buttons */ 3152fe0cdbSStephen Hemminger enum apanel_devid { 3252fe0cdbSStephen Hemminger APANEL_DEV_NONE = 0, 3352fe0cdbSStephen Hemminger APANEL_DEV_APPBTN = 1, 3452fe0cdbSStephen Hemminger APANEL_DEV_CDBTN = 2, 3552fe0cdbSStephen Hemminger APANEL_DEV_LCD = 3, 3652fe0cdbSStephen Hemminger APANEL_DEV_LED = 4, 3752fe0cdbSStephen Hemminger 3852fe0cdbSStephen Hemminger APANEL_DEV_MAX, 3952fe0cdbSStephen Hemminger }; 4052fe0cdbSStephen Hemminger 4152fe0cdbSStephen Hemminger enum apanel_chip { 4252fe0cdbSStephen Hemminger CHIP_NONE = 0, 4352fe0cdbSStephen Hemminger CHIP_OZ992C = 1, 4452fe0cdbSStephen Hemminger CHIP_OZ163T = 2, 4552fe0cdbSStephen Hemminger CHIP_OZ711M3 = 4, 4652fe0cdbSStephen Hemminger }; 4752fe0cdbSStephen Hemminger 4852fe0cdbSStephen Hemminger /* Result of BIOS snooping/probing -- what features are supported */ 4952fe0cdbSStephen Hemminger static enum apanel_chip device_chip[APANEL_DEV_MAX]; 5052fe0cdbSStephen Hemminger 5152fe0cdbSStephen Hemminger #define MAX_PANEL_KEYS 12 5252fe0cdbSStephen Hemminger 5352fe0cdbSStephen Hemminger struct apanel { 5452fe0cdbSStephen Hemminger struct input_polled_dev *ipdev; 551561bfe5SJean Delvare struct i2c_client *client; 5652fe0cdbSStephen Hemminger unsigned short keymap[MAX_PANEL_KEYS]; 5752fe0cdbSStephen Hemminger u16 nkeys; 5852fe0cdbSStephen Hemminger struct led_classdev mail_led; 5952fe0cdbSStephen Hemminger }; 6052fe0cdbSStephen Hemminger 6152fe0cdbSStephen Hemminger 621561bfe5SJean Delvare static int apanel_probe(struct i2c_client *, const struct i2c_device_id *); 6352fe0cdbSStephen Hemminger 6452fe0cdbSStephen Hemminger static void report_key(struct input_dev *input, unsigned keycode) 6552fe0cdbSStephen Hemminger { 6652fe0cdbSStephen Hemminger pr_debug(APANEL ": report key %#x\n", keycode); 6752fe0cdbSStephen Hemminger input_report_key(input, keycode, 1); 6852fe0cdbSStephen Hemminger input_sync(input); 6952fe0cdbSStephen Hemminger 7052fe0cdbSStephen Hemminger input_report_key(input, keycode, 0); 7152fe0cdbSStephen Hemminger input_sync(input); 7252fe0cdbSStephen Hemminger } 7352fe0cdbSStephen Hemminger 7452fe0cdbSStephen Hemminger /* Poll for key changes 7552fe0cdbSStephen Hemminger * 7652fe0cdbSStephen Hemminger * Read Application keys via SMI 7752fe0cdbSStephen Hemminger * A (0x4), B (0x8), Internet (0x2), Email (0x1). 7852fe0cdbSStephen Hemminger * 7952fe0cdbSStephen Hemminger * CD keys: 8052fe0cdbSStephen Hemminger * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800) 8152fe0cdbSStephen Hemminger */ 8252fe0cdbSStephen Hemminger static void apanel_poll(struct input_polled_dev *ipdev) 8352fe0cdbSStephen Hemminger { 8452fe0cdbSStephen Hemminger struct apanel *ap = ipdev->private; 8552fe0cdbSStephen Hemminger struct input_dev *idev = ipdev->input; 8652fe0cdbSStephen Hemminger u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 8752fe0cdbSStephen Hemminger s32 data; 8852fe0cdbSStephen Hemminger int i; 8952fe0cdbSStephen Hemminger 901561bfe5SJean Delvare data = i2c_smbus_read_word_data(ap->client, cmd); 9152fe0cdbSStephen Hemminger if (data < 0) 9252fe0cdbSStephen Hemminger return; /* ignore errors (due to ACPI??) */ 9352fe0cdbSStephen Hemminger 9452fe0cdbSStephen Hemminger /* write back to clear latch */ 951561bfe5SJean Delvare i2c_smbus_write_word_data(ap->client, cmd, 0); 9652fe0cdbSStephen Hemminger 9752fe0cdbSStephen Hemminger if (!data) 9852fe0cdbSStephen Hemminger return; 9952fe0cdbSStephen Hemminger 10052fe0cdbSStephen Hemminger dev_dbg(&idev->dev, APANEL ": data %#x\n", data); 10152fe0cdbSStephen Hemminger for (i = 0; i < idev->keycodemax; i++) 10252fe0cdbSStephen Hemminger if ((1u << i) & data) 10352fe0cdbSStephen Hemminger report_key(idev, ap->keymap[i]); 10452fe0cdbSStephen Hemminger } 10552fe0cdbSStephen Hemminger 1061cd48dc5SDmitry Torokhov static int mail_led_set(struct led_classdev *led, 10752fe0cdbSStephen Hemminger enum led_brightness value) 10852fe0cdbSStephen Hemminger { 10952fe0cdbSStephen Hemminger struct apanel *ap = container_of(led, struct apanel, mail_led); 1101cd48dc5SDmitry Torokhov u16 led_bits = value != LED_OFF ? 0x8000 : 0x0000; 11152fe0cdbSStephen Hemminger 1121cd48dc5SDmitry Torokhov return i2c_smbus_write_word_data(ap->client, 0x10, led_bits); 11352fe0cdbSStephen Hemminger } 11452fe0cdbSStephen Hemminger 1151561bfe5SJean Delvare static int apanel_remove(struct i2c_client *client) 11652fe0cdbSStephen Hemminger { 11752fe0cdbSStephen Hemminger struct apanel *ap = i2c_get_clientdata(client); 11852fe0cdbSStephen Hemminger 11952fe0cdbSStephen Hemminger if (device_chip[APANEL_DEV_LED] != CHIP_NONE) 12052fe0cdbSStephen Hemminger led_classdev_unregister(&ap->mail_led); 12152fe0cdbSStephen Hemminger 12252fe0cdbSStephen Hemminger input_unregister_polled_device(ap->ipdev); 12352fe0cdbSStephen Hemminger input_free_polled_device(ap->ipdev); 12452fe0cdbSStephen Hemminger 12552fe0cdbSStephen Hemminger return 0; 12652fe0cdbSStephen Hemminger } 12752fe0cdbSStephen Hemminger 12852fe0cdbSStephen Hemminger static void apanel_shutdown(struct i2c_client *client) 12952fe0cdbSStephen Hemminger { 1301561bfe5SJean Delvare apanel_remove(client); 13152fe0cdbSStephen Hemminger } 13252fe0cdbSStephen Hemminger 133ce7b39a1SMárton Németh static const struct i2c_device_id apanel_id[] = { 1341561bfe5SJean Delvare { "fujitsu_apanel", 0 }, 1351561bfe5SJean Delvare { } 1361561bfe5SJean Delvare }; 1371561bfe5SJean Delvare MODULE_DEVICE_TABLE(i2c, apanel_id); 1381561bfe5SJean Delvare 13952fe0cdbSStephen Hemminger static struct i2c_driver apanel_driver = { 14052fe0cdbSStephen Hemminger .driver = { 14152fe0cdbSStephen Hemminger .name = APANEL, 14252fe0cdbSStephen Hemminger }, 1431561bfe5SJean Delvare .probe = &apanel_probe, 1441561bfe5SJean Delvare .remove = &apanel_remove, 14552fe0cdbSStephen Hemminger .shutdown = &apanel_shutdown, 1461561bfe5SJean Delvare .id_table = apanel_id, 14752fe0cdbSStephen Hemminger }; 14852fe0cdbSStephen Hemminger 14952fe0cdbSStephen Hemminger static struct apanel apanel = { 15052fe0cdbSStephen Hemminger .keymap = { 15152fe0cdbSStephen Hemminger [0] = KEY_MAIL, 15252fe0cdbSStephen Hemminger [1] = KEY_WWW, 15352fe0cdbSStephen Hemminger [2] = KEY_PROG2, 15452fe0cdbSStephen Hemminger [3] = KEY_PROG1, 15552fe0cdbSStephen Hemminger 15652fe0cdbSStephen Hemminger [8] = KEY_FORWARD, 15752fe0cdbSStephen Hemminger [9] = KEY_REWIND, 15852fe0cdbSStephen Hemminger [10] = KEY_STOPCD, 15952fe0cdbSStephen Hemminger [11] = KEY_PLAYPAUSE, 16052fe0cdbSStephen Hemminger 16152fe0cdbSStephen Hemminger }, 16252fe0cdbSStephen Hemminger .mail_led = { 16352fe0cdbSStephen Hemminger .name = "mail:blue", 1641cd48dc5SDmitry Torokhov .brightness_set_blocking = mail_led_set, 16552fe0cdbSStephen Hemminger }, 16652fe0cdbSStephen Hemminger }; 16752fe0cdbSStephen Hemminger 16852fe0cdbSStephen Hemminger /* NB: Only one panel on the i2c. */ 1691561bfe5SJean Delvare static int apanel_probe(struct i2c_client *client, 1701561bfe5SJean Delvare const struct i2c_device_id *id) 17152fe0cdbSStephen Hemminger { 17252fe0cdbSStephen Hemminger struct apanel *ap; 17352fe0cdbSStephen Hemminger struct input_polled_dev *ipdev; 17452fe0cdbSStephen Hemminger struct input_dev *idev; 17552fe0cdbSStephen Hemminger u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 17652fe0cdbSStephen Hemminger int i, err = -ENOMEM; 17752fe0cdbSStephen Hemminger 17852fe0cdbSStephen Hemminger ap = &apanel; 17952fe0cdbSStephen Hemminger 18052fe0cdbSStephen Hemminger ipdev = input_allocate_polled_device(); 18152fe0cdbSStephen Hemminger if (!ipdev) 18252fe0cdbSStephen Hemminger goto out1; 18352fe0cdbSStephen Hemminger 18452fe0cdbSStephen Hemminger ap->ipdev = ipdev; 1851561bfe5SJean Delvare ap->client = client; 18652fe0cdbSStephen Hemminger 1871561bfe5SJean Delvare i2c_set_clientdata(client, ap); 18852fe0cdbSStephen Hemminger 1891561bfe5SJean Delvare err = i2c_smbus_write_word_data(client, cmd, 0); 19052fe0cdbSStephen Hemminger if (err) { 1911561bfe5SJean Delvare dev_warn(&client->dev, APANEL ": smbus write error %d\n", 19252fe0cdbSStephen Hemminger err); 19352fe0cdbSStephen Hemminger goto out3; 19452fe0cdbSStephen Hemminger } 19552fe0cdbSStephen Hemminger 19652fe0cdbSStephen Hemminger ipdev->poll = apanel_poll; 19752fe0cdbSStephen Hemminger ipdev->poll_interval = POLL_INTERVAL_DEFAULT; 19852fe0cdbSStephen Hemminger ipdev->private = ap; 19952fe0cdbSStephen Hemminger 20052fe0cdbSStephen Hemminger idev = ipdev->input; 20152fe0cdbSStephen Hemminger idev->name = APANEL_NAME " buttons"; 20252fe0cdbSStephen Hemminger idev->phys = "apanel/input0"; 20352fe0cdbSStephen Hemminger idev->id.bustype = BUS_HOST; 2041561bfe5SJean Delvare idev->dev.parent = &client->dev; 20552fe0cdbSStephen Hemminger 20652fe0cdbSStephen Hemminger set_bit(EV_KEY, idev->evbit); 20752fe0cdbSStephen Hemminger 20852fe0cdbSStephen Hemminger idev->keycode = ap->keymap; 20952fe0cdbSStephen Hemminger idev->keycodesize = sizeof(ap->keymap[0]); 21052fe0cdbSStephen Hemminger idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4; 21152fe0cdbSStephen Hemminger 21252fe0cdbSStephen Hemminger for (i = 0; i < idev->keycodemax; i++) 21352fe0cdbSStephen Hemminger if (ap->keymap[i]) 21452fe0cdbSStephen Hemminger set_bit(ap->keymap[i], idev->keybit); 21552fe0cdbSStephen Hemminger 21652fe0cdbSStephen Hemminger err = input_register_polled_device(ipdev); 21752fe0cdbSStephen Hemminger if (err) 21852fe0cdbSStephen Hemminger goto out3; 21952fe0cdbSStephen Hemminger 22052fe0cdbSStephen Hemminger if (device_chip[APANEL_DEV_LED] != CHIP_NONE) { 2211561bfe5SJean Delvare err = led_classdev_register(&client->dev, &ap->mail_led); 22252fe0cdbSStephen Hemminger if (err) 22352fe0cdbSStephen Hemminger goto out4; 22452fe0cdbSStephen Hemminger } 22552fe0cdbSStephen Hemminger 22652fe0cdbSStephen Hemminger return 0; 22752fe0cdbSStephen Hemminger out4: 22852fe0cdbSStephen Hemminger input_unregister_polled_device(ipdev); 22952fe0cdbSStephen Hemminger out3: 23052fe0cdbSStephen Hemminger input_free_polled_device(ipdev); 23152fe0cdbSStephen Hemminger out1: 23252fe0cdbSStephen Hemminger return err; 23352fe0cdbSStephen Hemminger } 23452fe0cdbSStephen Hemminger 23552fe0cdbSStephen Hemminger /* Scan the system ROM for the signature "FJKEYINF" */ 23652fe0cdbSStephen Hemminger static __init const void __iomem *bios_signature(const void __iomem *bios) 23752fe0cdbSStephen Hemminger { 23852fe0cdbSStephen Hemminger ssize_t offset; 23952fe0cdbSStephen Hemminger const unsigned char signature[] = "FJKEYINF"; 24052fe0cdbSStephen Hemminger 24152fe0cdbSStephen Hemminger for (offset = 0; offset < 0x10000; offset += 0x10) { 24252fe0cdbSStephen Hemminger if (check_signature(bios + offset, signature, 24352fe0cdbSStephen Hemminger sizeof(signature)-1)) 24452fe0cdbSStephen Hemminger return bios + offset; 24552fe0cdbSStephen Hemminger } 24652fe0cdbSStephen Hemminger pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n", 24752fe0cdbSStephen Hemminger signature); 24852fe0cdbSStephen Hemminger return NULL; 24952fe0cdbSStephen Hemminger } 25052fe0cdbSStephen Hemminger 25152fe0cdbSStephen Hemminger static int __init apanel_init(void) 25252fe0cdbSStephen Hemminger { 25352fe0cdbSStephen Hemminger void __iomem *bios; 25452fe0cdbSStephen Hemminger const void __iomem *p; 25552fe0cdbSStephen Hemminger u8 devno; 2561561bfe5SJean Delvare unsigned char i2c_addr; 25752fe0cdbSStephen Hemminger int found = 0; 25852fe0cdbSStephen Hemminger 25952fe0cdbSStephen Hemminger bios = ioremap(0xF0000, 0x10000); /* Can't fail */ 26052fe0cdbSStephen Hemminger 26152fe0cdbSStephen Hemminger p = bios_signature(bios); 26252fe0cdbSStephen Hemminger if (!p) { 26352fe0cdbSStephen Hemminger iounmap(bios); 26452fe0cdbSStephen Hemminger return -ENODEV; 26552fe0cdbSStephen Hemminger } 26652fe0cdbSStephen Hemminger 26752fe0cdbSStephen Hemminger /* just use the first address */ 26852fe0cdbSStephen Hemminger p += 8; 2691561bfe5SJean Delvare i2c_addr = readb(p + 3) >> 1; 27052fe0cdbSStephen Hemminger 27152fe0cdbSStephen Hemminger for ( ; (devno = readb(p)) & 0x7f; p += 4) { 27252fe0cdbSStephen Hemminger unsigned char method, slave, chip; 27352fe0cdbSStephen Hemminger 27452fe0cdbSStephen Hemminger method = readb(p + 1); 27552fe0cdbSStephen Hemminger chip = readb(p + 2); 27652fe0cdbSStephen Hemminger slave = readb(p + 3) >> 1; 27752fe0cdbSStephen Hemminger 2781561bfe5SJean Delvare if (slave != i2c_addr) { 27952fe0cdbSStephen Hemminger pr_notice(APANEL ": only one SMBus slave " 280f695c240SColin Ian King "address supported, skipping device...\n"); 28152fe0cdbSStephen Hemminger continue; 28252fe0cdbSStephen Hemminger } 28352fe0cdbSStephen Hemminger 28452fe0cdbSStephen Hemminger /* translate alternative device numbers */ 28552fe0cdbSStephen Hemminger switch (devno) { 28652fe0cdbSStephen Hemminger case 6: 28752fe0cdbSStephen Hemminger devno = APANEL_DEV_APPBTN; 28852fe0cdbSStephen Hemminger break; 28952fe0cdbSStephen Hemminger case 7: 29052fe0cdbSStephen Hemminger devno = APANEL_DEV_LED; 29152fe0cdbSStephen Hemminger break; 29252fe0cdbSStephen Hemminger } 29352fe0cdbSStephen Hemminger 29452fe0cdbSStephen Hemminger if (devno >= APANEL_DEV_MAX) 29552fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown device %u found\n", devno); 29652fe0cdbSStephen Hemminger else if (device_chip[devno] != CHIP_NONE) 297fef5f569SJoe Perches pr_warn(APANEL ": duplicate entry for devno %u\n", 298fef5f569SJoe Perches devno); 29952fe0cdbSStephen Hemminger 30052fe0cdbSStephen Hemminger else if (method != 1 && method != 2 && method != 4) { 30152fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown method %u for devno %u\n", 30252fe0cdbSStephen Hemminger method, devno); 30352fe0cdbSStephen Hemminger } else { 30452fe0cdbSStephen Hemminger device_chip[devno] = (enum apanel_chip) chip; 30552fe0cdbSStephen Hemminger ++found; 30652fe0cdbSStephen Hemminger } 30752fe0cdbSStephen Hemminger } 30852fe0cdbSStephen Hemminger iounmap(bios); 30952fe0cdbSStephen Hemminger 31052fe0cdbSStephen Hemminger if (found == 0) { 31152fe0cdbSStephen Hemminger pr_info(APANEL ": no input devices reported by BIOS\n"); 31252fe0cdbSStephen Hemminger return -EIO; 31352fe0cdbSStephen Hemminger } 31452fe0cdbSStephen Hemminger 31552fe0cdbSStephen Hemminger return i2c_add_driver(&apanel_driver); 31652fe0cdbSStephen Hemminger } 31752fe0cdbSStephen Hemminger module_init(apanel_init); 31852fe0cdbSStephen Hemminger 31952fe0cdbSStephen Hemminger static void __exit apanel_cleanup(void) 32052fe0cdbSStephen Hemminger { 32152fe0cdbSStephen Hemminger i2c_del_driver(&apanel_driver); 32252fe0cdbSStephen Hemminger } 32352fe0cdbSStephen Hemminger module_exit(apanel_cleanup); 32452fe0cdbSStephen Hemminger 32552fe0cdbSStephen Hemminger MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>"); 32652fe0cdbSStephen Hemminger MODULE_DESCRIPTION(APANEL_NAME " driver"); 32752fe0cdbSStephen Hemminger MODULE_LICENSE("GPL"); 32852fe0cdbSStephen Hemminger 32952fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*"); 33052fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*"); 331