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> 20071ec845SDmitry Torokhov #include <linux/input.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 { 54071ec845SDmitry Torokhov struct input_dev *idev; 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 61071ec845SDmitry Torokhov static const unsigned short apanel_keymap[MAX_PANEL_KEYS] = { 62071ec845SDmitry Torokhov [0] = KEY_MAIL, 63071ec845SDmitry Torokhov [1] = KEY_WWW, 64071ec845SDmitry Torokhov [2] = KEY_PROG2, 65071ec845SDmitry Torokhov [3] = KEY_PROG1, 6652fe0cdbSStephen Hemminger 67071ec845SDmitry Torokhov [8] = KEY_FORWARD, 68071ec845SDmitry Torokhov [9] = KEY_REWIND, 69071ec845SDmitry Torokhov [10] = KEY_STOPCD, 70071ec845SDmitry Torokhov [11] = KEY_PLAYPAUSE, 71071ec845SDmitry Torokhov }; 7252fe0cdbSStephen Hemminger 7352fe0cdbSStephen Hemminger static void report_key(struct input_dev *input, unsigned keycode) 7452fe0cdbSStephen Hemminger { 75071ec845SDmitry Torokhov dev_dbg(input->dev.parent, "report key %#x\n", keycode); 7652fe0cdbSStephen Hemminger input_report_key(input, keycode, 1); 7752fe0cdbSStephen Hemminger input_sync(input); 7852fe0cdbSStephen Hemminger 7952fe0cdbSStephen Hemminger input_report_key(input, keycode, 0); 8052fe0cdbSStephen Hemminger input_sync(input); 8152fe0cdbSStephen Hemminger } 8252fe0cdbSStephen Hemminger 8352fe0cdbSStephen Hemminger /* Poll for key changes 8452fe0cdbSStephen Hemminger * 8552fe0cdbSStephen Hemminger * Read Application keys via SMI 8652fe0cdbSStephen Hemminger * A (0x4), B (0x8), Internet (0x2), Email (0x1). 8752fe0cdbSStephen Hemminger * 8852fe0cdbSStephen Hemminger * CD keys: 8952fe0cdbSStephen Hemminger * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800) 9052fe0cdbSStephen Hemminger */ 91071ec845SDmitry Torokhov static void apanel_poll(struct input_dev *idev) 9252fe0cdbSStephen Hemminger { 93071ec845SDmitry Torokhov struct apanel *ap = input_get_drvdata(idev); 9452fe0cdbSStephen Hemminger u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 9552fe0cdbSStephen Hemminger s32 data; 9652fe0cdbSStephen Hemminger int i; 9752fe0cdbSStephen Hemminger 981561bfe5SJean Delvare data = i2c_smbus_read_word_data(ap->client, cmd); 9952fe0cdbSStephen Hemminger if (data < 0) 10052fe0cdbSStephen Hemminger return; /* ignore errors (due to ACPI??) */ 10152fe0cdbSStephen Hemminger 10252fe0cdbSStephen Hemminger /* write back to clear latch */ 1031561bfe5SJean Delvare i2c_smbus_write_word_data(ap->client, cmd, 0); 10452fe0cdbSStephen Hemminger 10552fe0cdbSStephen Hemminger if (!data) 10652fe0cdbSStephen Hemminger return; 10752fe0cdbSStephen Hemminger 10852fe0cdbSStephen Hemminger dev_dbg(&idev->dev, APANEL ": data %#x\n", data); 10952fe0cdbSStephen Hemminger for (i = 0; i < idev->keycodemax; i++) 11052fe0cdbSStephen Hemminger if ((1u << i) & data) 11152fe0cdbSStephen Hemminger report_key(idev, ap->keymap[i]); 11252fe0cdbSStephen Hemminger } 11352fe0cdbSStephen Hemminger 1141cd48dc5SDmitry Torokhov static int mail_led_set(struct led_classdev *led, 11552fe0cdbSStephen Hemminger enum led_brightness value) 11652fe0cdbSStephen Hemminger { 11752fe0cdbSStephen Hemminger struct apanel *ap = container_of(led, struct apanel, mail_led); 1181cd48dc5SDmitry Torokhov u16 led_bits = value != LED_OFF ? 0x8000 : 0x0000; 11952fe0cdbSStephen Hemminger 1201cd48dc5SDmitry Torokhov return i2c_smbus_write_word_data(ap->client, 0x10, led_bits); 12152fe0cdbSStephen Hemminger } 12252fe0cdbSStephen Hemminger 123071ec845SDmitry Torokhov static int apanel_probe(struct i2c_client *client, 124071ec845SDmitry Torokhov const struct i2c_device_id *id) 12552fe0cdbSStephen Hemminger { 126071ec845SDmitry Torokhov struct apanel *ap; 127071ec845SDmitry Torokhov struct input_dev *idev; 128071ec845SDmitry Torokhov u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8; 129071ec845SDmitry Torokhov int i, err; 13052fe0cdbSStephen Hemminger 131071ec845SDmitry Torokhov ap = devm_kzalloc(&client->dev, sizeof(*ap), GFP_KERNEL); 132071ec845SDmitry Torokhov if (!ap) 133071ec845SDmitry Torokhov return -ENOMEM; 13452fe0cdbSStephen Hemminger 135071ec845SDmitry Torokhov idev = devm_input_allocate_device(&client->dev); 136071ec845SDmitry Torokhov if (!idev) 137071ec845SDmitry Torokhov return -ENOMEM; 138071ec845SDmitry Torokhov 139071ec845SDmitry Torokhov ap->idev = idev; 140071ec845SDmitry Torokhov ap->client = client; 141071ec845SDmitry Torokhov 142071ec845SDmitry Torokhov i2c_set_clientdata(client, ap); 143071ec845SDmitry Torokhov 144071ec845SDmitry Torokhov err = i2c_smbus_write_word_data(client, cmd, 0); 145071ec845SDmitry Torokhov if (err) { 146071ec845SDmitry Torokhov dev_warn(&client->dev, "smbus write error %d\n", err); 147071ec845SDmitry Torokhov return err; 148071ec845SDmitry Torokhov } 149071ec845SDmitry Torokhov 150071ec845SDmitry Torokhov input_set_drvdata(idev, ap); 151071ec845SDmitry Torokhov 152071ec845SDmitry Torokhov idev->name = APANEL_NAME " buttons"; 153071ec845SDmitry Torokhov idev->phys = "apanel/input0"; 154071ec845SDmitry Torokhov idev->id.bustype = BUS_HOST; 155071ec845SDmitry Torokhov 156071ec845SDmitry Torokhov memcpy(ap->keymap, apanel_keymap, sizeof(apanel_keymap)); 157071ec845SDmitry Torokhov idev->keycode = ap->keymap; 158071ec845SDmitry Torokhov idev->keycodesize = sizeof(ap->keymap[0]); 159071ec845SDmitry Torokhov idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4; 160071ec845SDmitry Torokhov 161071ec845SDmitry Torokhov set_bit(EV_KEY, idev->evbit); 162071ec845SDmitry Torokhov for (i = 0; i < idev->keycodemax; i++) 163071ec845SDmitry Torokhov if (ap->keymap[i]) 164071ec845SDmitry Torokhov set_bit(ap->keymap[i], idev->keybit); 165071ec845SDmitry Torokhov 166071ec845SDmitry Torokhov err = input_setup_polling(idev, apanel_poll); 167071ec845SDmitry Torokhov if (err) 168071ec845SDmitry Torokhov return err; 169071ec845SDmitry Torokhov 170071ec845SDmitry Torokhov input_set_poll_interval(idev, POLL_INTERVAL_DEFAULT); 171071ec845SDmitry Torokhov 172071ec845SDmitry Torokhov err = input_register_device(idev); 173071ec845SDmitry Torokhov if (err) 174071ec845SDmitry Torokhov return err; 175071ec845SDmitry Torokhov 176071ec845SDmitry Torokhov if (device_chip[APANEL_DEV_LED] != CHIP_NONE) { 177071ec845SDmitry Torokhov ap->mail_led.name = "mail:blue"; 178071ec845SDmitry Torokhov ap->mail_led.brightness_set_blocking = mail_led_set; 179071ec845SDmitry Torokhov err = devm_led_classdev_register(&client->dev, &ap->mail_led); 180071ec845SDmitry Torokhov if (err) 181071ec845SDmitry Torokhov return err; 182071ec845SDmitry Torokhov } 18352fe0cdbSStephen Hemminger 18452fe0cdbSStephen Hemminger return 0; 18552fe0cdbSStephen Hemminger } 18652fe0cdbSStephen Hemminger 18752fe0cdbSStephen Hemminger static void apanel_shutdown(struct i2c_client *client) 18852fe0cdbSStephen Hemminger { 189071ec845SDmitry Torokhov struct apanel *ap = i2c_get_clientdata(client); 190071ec845SDmitry Torokhov 191071ec845SDmitry Torokhov if (device_chip[APANEL_DEV_LED] != CHIP_NONE) 192071ec845SDmitry Torokhov led_set_brightness(&ap->mail_led, LED_OFF); 19352fe0cdbSStephen Hemminger } 19452fe0cdbSStephen Hemminger 195ce7b39a1SMárton Németh static const struct i2c_device_id apanel_id[] = { 1961561bfe5SJean Delvare { "fujitsu_apanel", 0 }, 1971561bfe5SJean Delvare { } 1981561bfe5SJean Delvare }; 1991561bfe5SJean Delvare MODULE_DEVICE_TABLE(i2c, apanel_id); 2001561bfe5SJean Delvare 20152fe0cdbSStephen Hemminger static struct i2c_driver apanel_driver = { 20252fe0cdbSStephen Hemminger .driver = { 20352fe0cdbSStephen Hemminger .name = APANEL, 20452fe0cdbSStephen Hemminger }, 205071ec845SDmitry Torokhov .probe = apanel_probe, 206071ec845SDmitry Torokhov .shutdown = apanel_shutdown, 2071561bfe5SJean Delvare .id_table = apanel_id, 20852fe0cdbSStephen Hemminger }; 20952fe0cdbSStephen Hemminger 21052fe0cdbSStephen Hemminger /* Scan the system ROM for the signature "FJKEYINF" */ 21152fe0cdbSStephen Hemminger static __init const void __iomem *bios_signature(const void __iomem *bios) 21252fe0cdbSStephen Hemminger { 21352fe0cdbSStephen Hemminger ssize_t offset; 21452fe0cdbSStephen Hemminger const unsigned char signature[] = "FJKEYINF"; 21552fe0cdbSStephen Hemminger 21652fe0cdbSStephen Hemminger for (offset = 0; offset < 0x10000; offset += 0x10) { 21752fe0cdbSStephen Hemminger if (check_signature(bios + offset, signature, 21852fe0cdbSStephen Hemminger sizeof(signature)-1)) 21952fe0cdbSStephen Hemminger return bios + offset; 22052fe0cdbSStephen Hemminger } 22152fe0cdbSStephen Hemminger pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n", 22252fe0cdbSStephen Hemminger signature); 22352fe0cdbSStephen Hemminger return NULL; 22452fe0cdbSStephen Hemminger } 22552fe0cdbSStephen Hemminger 22652fe0cdbSStephen Hemminger static int __init apanel_init(void) 22752fe0cdbSStephen Hemminger { 22852fe0cdbSStephen Hemminger void __iomem *bios; 22952fe0cdbSStephen Hemminger const void __iomem *p; 23052fe0cdbSStephen Hemminger u8 devno; 2311561bfe5SJean Delvare unsigned char i2c_addr; 23252fe0cdbSStephen Hemminger int found = 0; 23352fe0cdbSStephen Hemminger 23452fe0cdbSStephen Hemminger bios = ioremap(0xF0000, 0x10000); /* Can't fail */ 23552fe0cdbSStephen Hemminger 23652fe0cdbSStephen Hemminger p = bios_signature(bios); 23752fe0cdbSStephen Hemminger if (!p) { 23852fe0cdbSStephen Hemminger iounmap(bios); 23952fe0cdbSStephen Hemminger return -ENODEV; 24052fe0cdbSStephen Hemminger } 24152fe0cdbSStephen Hemminger 24252fe0cdbSStephen Hemminger /* just use the first address */ 24352fe0cdbSStephen Hemminger p += 8; 2441561bfe5SJean Delvare i2c_addr = readb(p + 3) >> 1; 24552fe0cdbSStephen Hemminger 24652fe0cdbSStephen Hemminger for ( ; (devno = readb(p)) & 0x7f; p += 4) { 24752fe0cdbSStephen Hemminger unsigned char method, slave, chip; 24852fe0cdbSStephen Hemminger 24952fe0cdbSStephen Hemminger method = readb(p + 1); 25052fe0cdbSStephen Hemminger chip = readb(p + 2); 25152fe0cdbSStephen Hemminger slave = readb(p + 3) >> 1; 25252fe0cdbSStephen Hemminger 2531561bfe5SJean Delvare if (slave != i2c_addr) { 25452fe0cdbSStephen Hemminger pr_notice(APANEL ": only one SMBus slave " 255f695c240SColin Ian King "address supported, skipping device...\n"); 25652fe0cdbSStephen Hemminger continue; 25752fe0cdbSStephen Hemminger } 25852fe0cdbSStephen Hemminger 25952fe0cdbSStephen Hemminger /* translate alternative device numbers */ 26052fe0cdbSStephen Hemminger switch (devno) { 26152fe0cdbSStephen Hemminger case 6: 26252fe0cdbSStephen Hemminger devno = APANEL_DEV_APPBTN; 26352fe0cdbSStephen Hemminger break; 26452fe0cdbSStephen Hemminger case 7: 26552fe0cdbSStephen Hemminger devno = APANEL_DEV_LED; 26652fe0cdbSStephen Hemminger break; 26752fe0cdbSStephen Hemminger } 26852fe0cdbSStephen Hemminger 26952fe0cdbSStephen Hemminger if (devno >= APANEL_DEV_MAX) 27052fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown device %u found\n", devno); 27152fe0cdbSStephen Hemminger else if (device_chip[devno] != CHIP_NONE) 272fef5f569SJoe Perches pr_warn(APANEL ": duplicate entry for devno %u\n", 273fef5f569SJoe Perches devno); 27452fe0cdbSStephen Hemminger 27552fe0cdbSStephen Hemminger else if (method != 1 && method != 2 && method != 4) { 27652fe0cdbSStephen Hemminger pr_notice(APANEL ": unknown method %u for devno %u\n", 27752fe0cdbSStephen Hemminger method, devno); 27852fe0cdbSStephen Hemminger } else { 27952fe0cdbSStephen Hemminger device_chip[devno] = (enum apanel_chip) chip; 28052fe0cdbSStephen Hemminger ++found; 28152fe0cdbSStephen Hemminger } 28252fe0cdbSStephen Hemminger } 28352fe0cdbSStephen Hemminger iounmap(bios); 28452fe0cdbSStephen Hemminger 28552fe0cdbSStephen Hemminger if (found == 0) { 28652fe0cdbSStephen Hemminger pr_info(APANEL ": no input devices reported by BIOS\n"); 28752fe0cdbSStephen Hemminger return -EIO; 28852fe0cdbSStephen Hemminger } 28952fe0cdbSStephen Hemminger 29052fe0cdbSStephen Hemminger return i2c_add_driver(&apanel_driver); 29152fe0cdbSStephen Hemminger } 29252fe0cdbSStephen Hemminger module_init(apanel_init); 29352fe0cdbSStephen Hemminger 29452fe0cdbSStephen Hemminger static void __exit apanel_cleanup(void) 29552fe0cdbSStephen Hemminger { 29652fe0cdbSStephen Hemminger i2c_del_driver(&apanel_driver); 29752fe0cdbSStephen Hemminger } 29852fe0cdbSStephen Hemminger module_exit(apanel_cleanup); 29952fe0cdbSStephen Hemminger 30052fe0cdbSStephen Hemminger MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>"); 30152fe0cdbSStephen Hemminger MODULE_DESCRIPTION(APANEL_NAME " driver"); 30252fe0cdbSStephen Hemminger MODULE_LICENSE("GPL"); 30352fe0cdbSStephen Hemminger 30452fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*"); 30552fe0cdbSStephen Hemminger MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*"); 306