1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
230ba3eadSSriramakrishnan Govindarajan /*
330ba3eadSSriramakrishnan Govindarajan * Driver for keys on TCA6416 I2C IO expander
430ba3eadSSriramakrishnan Govindarajan *
530ba3eadSSriramakrishnan Govindarajan * Copyright (C) 2010 Texas Instruments
630ba3eadSSriramakrishnan Govindarajan *
730ba3eadSSriramakrishnan Govindarajan * Author : Sriramakrishnan.A.G. <srk@ti.com>
830ba3eadSSriramakrishnan Govindarajan */
930ba3eadSSriramakrishnan Govindarajan
1030ba3eadSSriramakrishnan Govindarajan #include <linux/types.h>
1130ba3eadSSriramakrishnan Govindarajan #include <linux/module.h>
1230ba3eadSSriramakrishnan Govindarajan #include <linux/init.h>
1330ba3eadSSriramakrishnan Govindarajan #include <linux/delay.h>
1430ba3eadSSriramakrishnan Govindarajan #include <linux/slab.h>
1530ba3eadSSriramakrishnan Govindarajan #include <linux/interrupt.h>
1630ba3eadSSriramakrishnan Govindarajan #include <linux/workqueue.h>
1730ba3eadSSriramakrishnan Govindarajan #include <linux/i2c.h>
1830ba3eadSSriramakrishnan Govindarajan #include <linux/input.h>
1930ba3eadSSriramakrishnan Govindarajan #include <linux/tca6416_keypad.h>
2030ba3eadSSriramakrishnan Govindarajan
2130ba3eadSSriramakrishnan Govindarajan #define TCA6416_INPUT 0
2230ba3eadSSriramakrishnan Govindarajan #define TCA6416_OUTPUT 1
2330ba3eadSSriramakrishnan Govindarajan #define TCA6416_INVERT 2
2430ba3eadSSriramakrishnan Govindarajan #define TCA6416_DIRECTION 3
2530ba3eadSSriramakrishnan Govindarajan
26*57b0c96fSDmitry Torokhov #define TCA6416_POLL_INTERVAL 100 /* msec */
27*57b0c96fSDmitry Torokhov
2830ba3eadSSriramakrishnan Govindarajan static const struct i2c_device_id tca6416_id[] = {
2930ba3eadSSriramakrishnan Govindarajan { "tca6416-keys", 16, },
30b8a3d6bcSTony SIM { "tca6408-keys", 8, },
3130ba3eadSSriramakrishnan Govindarajan { }
3230ba3eadSSriramakrishnan Govindarajan };
3330ba3eadSSriramakrishnan Govindarajan MODULE_DEVICE_TABLE(i2c, tca6416_id);
3430ba3eadSSriramakrishnan Govindarajan
3530ba3eadSSriramakrishnan Govindarajan struct tca6416_keypad_chip {
3630ba3eadSSriramakrishnan Govindarajan uint16_t reg_output;
3730ba3eadSSriramakrishnan Govindarajan uint16_t reg_direction;
3830ba3eadSSriramakrishnan Govindarajan uint16_t reg_input;
3930ba3eadSSriramakrishnan Govindarajan
4030ba3eadSSriramakrishnan Govindarajan struct i2c_client *client;
4130ba3eadSSriramakrishnan Govindarajan struct input_dev *input;
42b8a3d6bcSTony SIM int io_size;
43b8a3d6bcSTony SIM u16 pinmask;
4430ba3eadSSriramakrishnan Govindarajan bool use_polling;
4594bef5d5SGustavo A. R. Silva struct tca6416_button buttons[];
4630ba3eadSSriramakrishnan Govindarajan };
4730ba3eadSSriramakrishnan Govindarajan
tca6416_write_reg(struct tca6416_keypad_chip * chip,int reg,u16 val)4830ba3eadSSriramakrishnan Govindarajan static int tca6416_write_reg(struct tca6416_keypad_chip *chip, int reg, u16 val)
4930ba3eadSSriramakrishnan Govindarajan {
5030ba3eadSSriramakrishnan Govindarajan int error;
5130ba3eadSSriramakrishnan Govindarajan
52b8a3d6bcSTony SIM error = chip->io_size > 8 ?
53b8a3d6bcSTony SIM i2c_smbus_write_word_data(chip->client, reg << 1, val) :
54b8a3d6bcSTony SIM i2c_smbus_write_byte_data(chip->client, reg, val);
5530ba3eadSSriramakrishnan Govindarajan if (error < 0) {
5630ba3eadSSriramakrishnan Govindarajan dev_err(&chip->client->dev,
5730ba3eadSSriramakrishnan Govindarajan "%s failed, reg: %d, val: %d, error: %d\n",
5830ba3eadSSriramakrishnan Govindarajan __func__, reg, val, error);
5930ba3eadSSriramakrishnan Govindarajan return error;
6030ba3eadSSriramakrishnan Govindarajan }
6130ba3eadSSriramakrishnan Govindarajan
6230ba3eadSSriramakrishnan Govindarajan return 0;
6330ba3eadSSriramakrishnan Govindarajan }
6430ba3eadSSriramakrishnan Govindarajan
tca6416_read_reg(struct tca6416_keypad_chip * chip,int reg,u16 * val)6530ba3eadSSriramakrishnan Govindarajan static int tca6416_read_reg(struct tca6416_keypad_chip *chip, int reg, u16 *val)
6630ba3eadSSriramakrishnan Govindarajan {
6730ba3eadSSriramakrishnan Govindarajan int retval;
6830ba3eadSSriramakrishnan Govindarajan
69b8a3d6bcSTony SIM retval = chip->io_size > 8 ?
70b8a3d6bcSTony SIM i2c_smbus_read_word_data(chip->client, reg << 1) :
71b8a3d6bcSTony SIM i2c_smbus_read_byte_data(chip->client, reg);
7230ba3eadSSriramakrishnan Govindarajan if (retval < 0) {
7330ba3eadSSriramakrishnan Govindarajan dev_err(&chip->client->dev, "%s failed, reg: %d, error: %d\n",
7430ba3eadSSriramakrishnan Govindarajan __func__, reg, retval);
7530ba3eadSSriramakrishnan Govindarajan return retval;
7630ba3eadSSriramakrishnan Govindarajan }
7730ba3eadSSriramakrishnan Govindarajan
7830ba3eadSSriramakrishnan Govindarajan *val = (u16)retval;
7930ba3eadSSriramakrishnan Govindarajan return 0;
8030ba3eadSSriramakrishnan Govindarajan }
8130ba3eadSSriramakrishnan Govindarajan
tca6416_keys_scan(struct input_dev * input)82*57b0c96fSDmitry Torokhov static void tca6416_keys_scan(struct input_dev *input)
8330ba3eadSSriramakrishnan Govindarajan {
84*57b0c96fSDmitry Torokhov struct tca6416_keypad_chip *chip = input_get_drvdata(input);
8530ba3eadSSriramakrishnan Govindarajan u16 reg_val, val;
8630ba3eadSSriramakrishnan Govindarajan int error, i, pin_index;
8730ba3eadSSriramakrishnan Govindarajan
8830ba3eadSSriramakrishnan Govindarajan error = tca6416_read_reg(chip, TCA6416_INPUT, ®_val);
8930ba3eadSSriramakrishnan Govindarajan if (error)
9030ba3eadSSriramakrishnan Govindarajan return;
9130ba3eadSSriramakrishnan Govindarajan
9230ba3eadSSriramakrishnan Govindarajan reg_val &= chip->pinmask;
9330ba3eadSSriramakrishnan Govindarajan
9430ba3eadSSriramakrishnan Govindarajan /* Figure out which lines have changed */
9530ba3eadSSriramakrishnan Govindarajan val = reg_val ^ chip->reg_input;
9630ba3eadSSriramakrishnan Govindarajan chip->reg_input = reg_val;
9730ba3eadSSriramakrishnan Govindarajan
9830ba3eadSSriramakrishnan Govindarajan for (i = 0, pin_index = 0; i < 16; i++) {
9930ba3eadSSriramakrishnan Govindarajan if (val & (1 << i)) {
10030ba3eadSSriramakrishnan Govindarajan struct tca6416_button *button = &chip->buttons[pin_index];
10130ba3eadSSriramakrishnan Govindarajan unsigned int type = button->type ?: EV_KEY;
10230ba3eadSSriramakrishnan Govindarajan int state = ((reg_val & (1 << i)) ? 1 : 0)
10330ba3eadSSriramakrishnan Govindarajan ^ button->active_low;
10430ba3eadSSriramakrishnan Govindarajan
10530ba3eadSSriramakrishnan Govindarajan input_event(input, type, button->code, !!state);
10630ba3eadSSriramakrishnan Govindarajan input_sync(input);
10730ba3eadSSriramakrishnan Govindarajan }
10830ba3eadSSriramakrishnan Govindarajan
10930ba3eadSSriramakrishnan Govindarajan if (chip->pinmask & (1 << i))
11030ba3eadSSriramakrishnan Govindarajan pin_index++;
11130ba3eadSSriramakrishnan Govindarajan }
11230ba3eadSSriramakrishnan Govindarajan }
11330ba3eadSSriramakrishnan Govindarajan
11430ba3eadSSriramakrishnan Govindarajan /*
11530ba3eadSSriramakrishnan Govindarajan * This is threaded IRQ handler and this can (and will) sleep.
11630ba3eadSSriramakrishnan Govindarajan */
tca6416_keys_isr(int irq,void * dev_id)11730ba3eadSSriramakrishnan Govindarajan static irqreturn_t tca6416_keys_isr(int irq, void *dev_id)
11830ba3eadSSriramakrishnan Govindarajan {
119*57b0c96fSDmitry Torokhov tca6416_keys_scan(dev_id);
12030ba3eadSSriramakrishnan Govindarajan
12130ba3eadSSriramakrishnan Govindarajan return IRQ_HANDLED;
12230ba3eadSSriramakrishnan Govindarajan }
12330ba3eadSSriramakrishnan Govindarajan
tca6416_keys_open(struct input_dev * dev)12430ba3eadSSriramakrishnan Govindarajan static int tca6416_keys_open(struct input_dev *dev)
12530ba3eadSSriramakrishnan Govindarajan {
12630ba3eadSSriramakrishnan Govindarajan struct tca6416_keypad_chip *chip = input_get_drvdata(dev);
12730ba3eadSSriramakrishnan Govindarajan
128*57b0c96fSDmitry Torokhov if (!chip->use_polling) {
12930ba3eadSSriramakrishnan Govindarajan /* Get initial device state in case it has switches */
130*57b0c96fSDmitry Torokhov tca6416_keys_scan(dev);
131687fe7dfSDmitry Torokhov enable_irq(chip->client->irq);
132*57b0c96fSDmitry Torokhov }
13330ba3eadSSriramakrishnan Govindarajan
13430ba3eadSSriramakrishnan Govindarajan return 0;
13530ba3eadSSriramakrishnan Govindarajan }
13630ba3eadSSriramakrishnan Govindarajan
tca6416_keys_close(struct input_dev * dev)13730ba3eadSSriramakrishnan Govindarajan static void tca6416_keys_close(struct input_dev *dev)
13830ba3eadSSriramakrishnan Govindarajan {
13930ba3eadSSriramakrishnan Govindarajan struct tca6416_keypad_chip *chip = input_get_drvdata(dev);
14030ba3eadSSriramakrishnan Govindarajan
141*57b0c96fSDmitry Torokhov if (!chip->use_polling)
142687fe7dfSDmitry Torokhov disable_irq(chip->client->irq);
14330ba3eadSSriramakrishnan Govindarajan }
14430ba3eadSSriramakrishnan Govindarajan
tca6416_setup_registers(struct tca6416_keypad_chip * chip)1455298cc4cSBill Pemberton static int tca6416_setup_registers(struct tca6416_keypad_chip *chip)
14630ba3eadSSriramakrishnan Govindarajan {
14730ba3eadSSriramakrishnan Govindarajan int error;
14830ba3eadSSriramakrishnan Govindarajan
14930ba3eadSSriramakrishnan Govindarajan error = tca6416_read_reg(chip, TCA6416_OUTPUT, &chip->reg_output);
15030ba3eadSSriramakrishnan Govindarajan if (error)
15130ba3eadSSriramakrishnan Govindarajan return error;
15230ba3eadSSriramakrishnan Govindarajan
15330ba3eadSSriramakrishnan Govindarajan error = tca6416_read_reg(chip, TCA6416_DIRECTION, &chip->reg_direction);
15430ba3eadSSriramakrishnan Govindarajan if (error)
15530ba3eadSSriramakrishnan Govindarajan return error;
15630ba3eadSSriramakrishnan Govindarajan
15730ba3eadSSriramakrishnan Govindarajan /* ensure that keypad pins are set to input */
15830ba3eadSSriramakrishnan Govindarajan error = tca6416_write_reg(chip, TCA6416_DIRECTION,
15930ba3eadSSriramakrishnan Govindarajan chip->reg_direction | chip->pinmask);
16030ba3eadSSriramakrishnan Govindarajan if (error)
16130ba3eadSSriramakrishnan Govindarajan return error;
16230ba3eadSSriramakrishnan Govindarajan
16330ba3eadSSriramakrishnan Govindarajan error = tca6416_read_reg(chip, TCA6416_DIRECTION, &chip->reg_direction);
16430ba3eadSSriramakrishnan Govindarajan if (error)
16530ba3eadSSriramakrishnan Govindarajan return error;
16630ba3eadSSriramakrishnan Govindarajan
16730ba3eadSSriramakrishnan Govindarajan error = tca6416_read_reg(chip, TCA6416_INPUT, &chip->reg_input);
16830ba3eadSSriramakrishnan Govindarajan if (error)
16930ba3eadSSriramakrishnan Govindarajan return error;
17030ba3eadSSriramakrishnan Govindarajan
17130ba3eadSSriramakrishnan Govindarajan chip->reg_input &= chip->pinmask;
17230ba3eadSSriramakrishnan Govindarajan
17330ba3eadSSriramakrishnan Govindarajan return 0;
17430ba3eadSSriramakrishnan Govindarajan }
17530ba3eadSSriramakrishnan Govindarajan
tca6416_keypad_probe(struct i2c_client * client)1763da11976SUwe Kleine-König static int tca6416_keypad_probe(struct i2c_client *client)
17730ba3eadSSriramakrishnan Govindarajan {
1783da11976SUwe Kleine-König const struct i2c_device_id *id = i2c_client_get_device_id(client);
17930ba3eadSSriramakrishnan Govindarajan struct tca6416_keys_platform_data *pdata;
18030ba3eadSSriramakrishnan Govindarajan struct tca6416_keypad_chip *chip;
18130ba3eadSSriramakrishnan Govindarajan struct input_dev *input;
18230ba3eadSSriramakrishnan Govindarajan int error;
18330ba3eadSSriramakrishnan Govindarajan int i;
18430ba3eadSSriramakrishnan Govindarajan
18530ba3eadSSriramakrishnan Govindarajan /* Check functionality */
18630ba3eadSSriramakrishnan Govindarajan if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE)) {
18730ba3eadSSriramakrishnan Govindarajan dev_err(&client->dev, "%s adapter not supported\n",
18830ba3eadSSriramakrishnan Govindarajan dev_driver_string(&client->adapter->dev));
18930ba3eadSSriramakrishnan Govindarajan return -ENODEV;
19030ba3eadSSriramakrishnan Govindarajan }
19130ba3eadSSriramakrishnan Govindarajan
192c838cb3dSJingoo Han pdata = dev_get_platdata(&client->dev);
19330ba3eadSSriramakrishnan Govindarajan if (!pdata) {
19430ba3eadSSriramakrishnan Govindarajan dev_dbg(&client->dev, "no platform data\n");
19530ba3eadSSriramakrishnan Govindarajan return -EINVAL;
19630ba3eadSSriramakrishnan Govindarajan }
19730ba3eadSSriramakrishnan Govindarajan
19891a4c690SYangtao Li chip = devm_kzalloc(&client->dev,
19991a4c690SYangtao Li struct_size(chip, buttons, pdata->nbuttons),
20091a4c690SYangtao Li GFP_KERNEL);
20191a4c690SYangtao Li if (!chip)
20291a4c690SYangtao Li return -ENOMEM;
20391a4c690SYangtao Li
20491a4c690SYangtao Li input = devm_input_allocate_device(&client->dev);
20591a4c690SYangtao Li if (!input)
20691a4c690SYangtao Li return -ENOMEM;
20730ba3eadSSriramakrishnan Govindarajan
20830ba3eadSSriramakrishnan Govindarajan chip->client = client;
20930ba3eadSSriramakrishnan Govindarajan chip->input = input;
210b8a3d6bcSTony SIM chip->io_size = id->driver_data;
21130ba3eadSSriramakrishnan Govindarajan chip->pinmask = pdata->pinmask;
21230ba3eadSSriramakrishnan Govindarajan chip->use_polling = pdata->use_polling;
21330ba3eadSSriramakrishnan Govindarajan
21430ba3eadSSriramakrishnan Govindarajan input->phys = "tca6416-keys/input0";
21530ba3eadSSriramakrishnan Govindarajan input->name = client->name;
21630ba3eadSSriramakrishnan Govindarajan
21730ba3eadSSriramakrishnan Govindarajan input->open = tca6416_keys_open;
21830ba3eadSSriramakrishnan Govindarajan input->close = tca6416_keys_close;
21930ba3eadSSriramakrishnan Govindarajan
22030ba3eadSSriramakrishnan Govindarajan input->id.bustype = BUS_HOST;
22130ba3eadSSriramakrishnan Govindarajan input->id.vendor = 0x0001;
22230ba3eadSSriramakrishnan Govindarajan input->id.product = 0x0001;
22330ba3eadSSriramakrishnan Govindarajan input->id.version = 0x0100;
22430ba3eadSSriramakrishnan Govindarajan
22530ba3eadSSriramakrishnan Govindarajan /* Enable auto repeat feature of Linux input subsystem */
22630ba3eadSSriramakrishnan Govindarajan if (pdata->rep)
22730ba3eadSSriramakrishnan Govindarajan __set_bit(EV_REP, input->evbit);
22830ba3eadSSriramakrishnan Govindarajan
22930ba3eadSSriramakrishnan Govindarajan for (i = 0; i < pdata->nbuttons; i++) {
23030ba3eadSSriramakrishnan Govindarajan unsigned int type;
23130ba3eadSSriramakrishnan Govindarajan
23230ba3eadSSriramakrishnan Govindarajan chip->buttons[i] = pdata->buttons[i];
23330ba3eadSSriramakrishnan Govindarajan type = (pdata->buttons[i].type) ?: EV_KEY;
23430ba3eadSSriramakrishnan Govindarajan input_set_capability(input, type, pdata->buttons[i].code);
23530ba3eadSSriramakrishnan Govindarajan }
23630ba3eadSSriramakrishnan Govindarajan
23730ba3eadSSriramakrishnan Govindarajan input_set_drvdata(input, chip);
23830ba3eadSSriramakrishnan Govindarajan
23930ba3eadSSriramakrishnan Govindarajan /*
24030ba3eadSSriramakrishnan Govindarajan * Initialize cached registers from their original values.
24130ba3eadSSriramakrishnan Govindarajan * we can't share this chip with another i2c master.
24230ba3eadSSriramakrishnan Govindarajan */
24330ba3eadSSriramakrishnan Govindarajan error = tca6416_setup_registers(chip);
24430ba3eadSSriramakrishnan Govindarajan if (error)
24591a4c690SYangtao Li return error;
24630ba3eadSSriramakrishnan Govindarajan
247*57b0c96fSDmitry Torokhov if (chip->use_polling) {
248*57b0c96fSDmitry Torokhov error = input_setup_polling(input, tca6416_keys_scan);
249*57b0c96fSDmitry Torokhov if (error) {
250*57b0c96fSDmitry Torokhov dev_err(&client->dev, "Failed to setup polling\n");
251*57b0c96fSDmitry Torokhov return error;
252*57b0c96fSDmitry Torokhov }
253*57b0c96fSDmitry Torokhov
254*57b0c96fSDmitry Torokhov input_set_poll_interval(input, TCA6416_POLL_INTERVAL);
255*57b0c96fSDmitry Torokhov } else {
25691a4c690SYangtao Li error = devm_request_threaded_irq(&client->dev, client->irq,
25791a4c690SYangtao Li NULL, tca6416_keys_isr,
2589b7e31bbSLars-Peter Clausen IRQF_TRIGGER_FALLING |
25991a4c690SYangtao Li IRQF_ONESHOT |
26091a4c690SYangtao Li IRQF_NO_AUTOEN,
261*57b0c96fSDmitry Torokhov "tca6416-keypad", input);
26230ba3eadSSriramakrishnan Govindarajan if (error) {
26330ba3eadSSriramakrishnan Govindarajan dev_dbg(&client->dev,
26430ba3eadSSriramakrishnan Govindarajan "Unable to claim irq %d; error %d\n",
265687fe7dfSDmitry Torokhov client->irq, error);
26691a4c690SYangtao Li return error;
26730ba3eadSSriramakrishnan Govindarajan }
26830ba3eadSSriramakrishnan Govindarajan }
26930ba3eadSSriramakrishnan Govindarajan
27030ba3eadSSriramakrishnan Govindarajan error = input_register_device(input);
27130ba3eadSSriramakrishnan Govindarajan if (error) {
27230ba3eadSSriramakrishnan Govindarajan dev_dbg(&client->dev,
27330ba3eadSSriramakrishnan Govindarajan "Unable to register input device, error: %d\n", error);
27491a4c690SYangtao Li return error;
27530ba3eadSSriramakrishnan Govindarajan }
27630ba3eadSSriramakrishnan Govindarajan
27730ba3eadSSriramakrishnan Govindarajan i2c_set_clientdata(client, chip);
27830ba3eadSSriramakrishnan Govindarajan
27930ba3eadSSriramakrishnan Govindarajan return 0;
28030ba3eadSSriramakrishnan Govindarajan }
28130ba3eadSSriramakrishnan Govindarajan
28230ba3eadSSriramakrishnan Govindarajan static struct i2c_driver tca6416_keypad_driver = {
28330ba3eadSSriramakrishnan Govindarajan .driver = {
28430ba3eadSSriramakrishnan Govindarajan .name = "tca6416-keypad",
28530ba3eadSSriramakrishnan Govindarajan },
286d8bde56dSUwe Kleine-König .probe = tca6416_keypad_probe,
28730ba3eadSSriramakrishnan Govindarajan .id_table = tca6416_id,
28830ba3eadSSriramakrishnan Govindarajan };
28930ba3eadSSriramakrishnan Govindarajan
tca6416_keypad_init(void)29030ba3eadSSriramakrishnan Govindarajan static int __init tca6416_keypad_init(void)
29130ba3eadSSriramakrishnan Govindarajan {
29230ba3eadSSriramakrishnan Govindarajan return i2c_add_driver(&tca6416_keypad_driver);
29330ba3eadSSriramakrishnan Govindarajan }
29430ba3eadSSriramakrishnan Govindarajan
29530ba3eadSSriramakrishnan Govindarajan subsys_initcall(tca6416_keypad_init);
29630ba3eadSSriramakrishnan Govindarajan
tca6416_keypad_exit(void)29730ba3eadSSriramakrishnan Govindarajan static void __exit tca6416_keypad_exit(void)
29830ba3eadSSriramakrishnan Govindarajan {
29930ba3eadSSriramakrishnan Govindarajan i2c_del_driver(&tca6416_keypad_driver);
30030ba3eadSSriramakrishnan Govindarajan }
30130ba3eadSSriramakrishnan Govindarajan module_exit(tca6416_keypad_exit);
30230ba3eadSSriramakrishnan Govindarajan
30330ba3eadSSriramakrishnan Govindarajan MODULE_AUTHOR("Sriramakrishnan <srk@ti.com>");
304c154703bSChristophe JAILLET MODULE_DESCRIPTION("Keypad driver over tca6416 IO expander");
30530ba3eadSSriramakrishnan Govindarajan MODULE_LICENSE("GPL");
306