2 * max7359_keypad.c - MAX7359 Key Switch Controller Driver
4 * Copyright (C) 2009 Samsung Electronics
5 * Kim Kyuwon <q1.kim@samsung.com>
7 * Based on pxa27x_keypad.c
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * Datasheet: http://www.maxim-ic.com/quick_view2.cfm/qv_pk/5456
16 #include <linux/module.h>
17 #include <linux/i2c.h>
18 #include <linux/slab.h>
19 #include <linux/interrupt.h>
21 #include <linux/input.h>
22 #include <linux/input/matrix_keypad.h>
24 #define MAX7359_MAX_KEY_ROWS 8
25 #define MAX7359_MAX_KEY_COLS 8
26 #define MAX7359_MAX_KEY_NUM (MAX7359_MAX_KEY_ROWS * MAX7359_MAX_KEY_COLS)
27 #define MAX7359_ROW_SHIFT 3
32 #define MAX7359_REG_KEYFIFO 0x00
33 #define MAX7359_REG_CONFIG 0x01
34 #define MAX7359_REG_DEBOUNCE 0x02
35 #define MAX7359_REG_INTERRUPT 0x03
36 #define MAX7359_REG_PORTS 0x04
37 #define MAX7359_REG_KEYREP 0x05
38 #define MAX7359_REG_SLEEP 0x06
41 * Configuration register bits
43 #define MAX7359_CFG_SLEEP (1 << 7)
44 #define MAX7359_CFG_INTERRUPT (1 << 5)
45 #define MAX7359_CFG_KEY_RELEASE (1 << 3)
46 #define MAX7359_CFG_WAKEUP (1 << 1)
47 #define MAX7359_CFG_TIMEOUT (1 << 0)
50 * Autosleep register values (ms)
52 #define MAX7359_AUTOSLEEP_8192 0x01
53 #define MAX7359_AUTOSLEEP_4096 0x02
54 #define MAX7359_AUTOSLEEP_2048 0x03
55 #define MAX7359_AUTOSLEEP_1024 0x04
56 #define MAX7359_AUTOSLEEP_512 0x05
57 #define MAX7359_AUTOSLEEP_256 0x06
59 struct max7359_keypad {
60 /* matrix key code map */
61 unsigned short keycodes[MAX7359_MAX_KEY_NUM];
63 struct input_dev *input_dev;
64 struct i2c_client *client;
67 static int max7359_write_reg(struct i2c_client *client, u8 reg, u8 val)
69 int ret = i2c_smbus_write_byte_data(client, reg, val);
72 dev_err(&client->dev, "%s: reg 0x%x, val 0x%x, err %d\n",
73 __func__, reg, val, ret);
77 static int max7359_read_reg(struct i2c_client *client, int reg)
79 int ret = i2c_smbus_read_byte_data(client, reg);
82 dev_err(&client->dev, "%s: reg 0x%x, err %d\n",
87 static void max7359_build_keycode(struct max7359_keypad *keypad,
88 const struct matrix_keymap_data *keymap_data)
90 struct input_dev *input_dev = keypad->input_dev;
93 for (i = 0; i < keymap_data->keymap_size; i++) {
94 unsigned int key = keymap_data->keymap[i];
95 unsigned int row = KEY_ROW(key);
96 unsigned int col = KEY_COL(key);
97 unsigned int scancode = MATRIX_SCAN_CODE(row, col,
99 unsigned short keycode = KEY_VAL(key);
101 keypad->keycodes[scancode] = keycode;
102 __set_bit(keycode, input_dev->keybit);
104 __clear_bit(KEY_RESERVED, input_dev->keybit);
107 /* runs in an IRQ thread -- can (and will!) sleep */
108 static irqreturn_t max7359_interrupt(int irq, void *dev_id)
110 struct max7359_keypad *keypad = dev_id;
111 struct input_dev *input_dev = keypad->input_dev;
112 int val, row, col, release, code;
114 val = max7359_read_reg(keypad->client, MAX7359_REG_KEYFIFO);
116 col = (val >> 3) & 0x7;
117 release = val & 0x40;
119 code = MATRIX_SCAN_CODE(row, col, MAX7359_ROW_SHIFT);
121 dev_dbg(&keypad->client->dev,
122 "key[%d:%d] %s\n", row, col, release ? "release" : "press");
124 input_event(input_dev, EV_MSC, MSC_SCAN, code);
125 input_report_key(input_dev, keypad->keycodes[code], !release);
126 input_sync(input_dev);
132 * Let MAX7359 fall into a deep sleep:
133 * If no keys are pressed, enter sleep mode for 8192 ms. And if any
134 * key is pressed, the MAX7359 returns to normal operating mode.
136 static inline void max7359_fall_deepsleep(struct i2c_client *client)
138 max7359_write_reg(client, MAX7359_REG_SLEEP, MAX7359_AUTOSLEEP_8192);
142 * Let MAX7359 take a catnap:
143 * Autosleep just for 256 ms.
145 static inline void max7359_take_catnap(struct i2c_client *client)
147 max7359_write_reg(client, MAX7359_REG_SLEEP, MAX7359_AUTOSLEEP_256);
150 static int max7359_open(struct input_dev *dev)
152 struct max7359_keypad *keypad = input_get_drvdata(dev);
154 max7359_take_catnap(keypad->client);
159 static void max7359_close(struct input_dev *dev)
161 struct max7359_keypad *keypad = input_get_drvdata(dev);
163 max7359_fall_deepsleep(keypad->client);
166 static void max7359_initialize(struct i2c_client *client)
168 max7359_write_reg(client, MAX7359_REG_CONFIG,
169 MAX7359_CFG_INTERRUPT | /* Irq clears after host read */
170 MAX7359_CFG_KEY_RELEASE | /* Key release enable */
171 MAX7359_CFG_WAKEUP); /* Key press wakeup enable */
173 /* Full key-scan functionality */
174 max7359_write_reg(client, MAX7359_REG_DEBOUNCE, 0x1F);
176 /* nINT asserts every debounce cycles */
177 max7359_write_reg(client, MAX7359_REG_INTERRUPT, 0x01);
179 max7359_fall_deepsleep(client);
182 static int __devinit max7359_probe(struct i2c_client *client,
183 const struct i2c_device_id *id)
185 const struct matrix_keymap_data *keymap_data = client->dev.platform_data;
186 struct max7359_keypad *keypad;
187 struct input_dev *input_dev;
192 dev_err(&client->dev, "The irq number should not be zero\n");
196 /* Detect MAX7359: The initial Keys FIFO value is '0x3F' */
197 ret = max7359_read_reg(client, MAX7359_REG_KEYFIFO);
199 dev_err(&client->dev, "failed to detect device\n");
203 dev_dbg(&client->dev, "keys FIFO is 0x%02x\n", ret);
205 keypad = kzalloc(sizeof(struct max7359_keypad), GFP_KERNEL);
206 input_dev = input_allocate_device();
207 if (!keypad || !input_dev) {
208 dev_err(&client->dev, "failed to allocate memory\n");
210 goto failed_free_mem;
213 keypad->client = client;
214 keypad->input_dev = input_dev;
216 input_dev->name = client->name;
217 input_dev->id.bustype = BUS_I2C;
218 input_dev->open = max7359_open;
219 input_dev->close = max7359_close;
220 input_dev->dev.parent = &client->dev;
222 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
223 input_dev->keycodesize = sizeof(keypad->keycodes[0]);
224 input_dev->keycodemax = ARRAY_SIZE(keypad->keycodes);
225 input_dev->keycode = keypad->keycodes;
227 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
228 input_set_drvdata(input_dev, keypad);
230 max7359_build_keycode(keypad, keymap_data);
232 error = request_threaded_irq(client->irq, NULL, max7359_interrupt,
233 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
234 client->name, keypad);
236 dev_err(&client->dev, "failed to register interrupt\n");
237 goto failed_free_mem;
240 /* Register the input device */
241 error = input_register_device(input_dev);
243 dev_err(&client->dev, "failed to register input device\n");
244 goto failed_free_irq;
247 /* Initialize MAX7359 */
248 max7359_initialize(client);
250 i2c_set_clientdata(client, keypad);
251 device_init_wakeup(&client->dev, 1);
256 free_irq(client->irq, keypad);
258 input_free_device(input_dev);
263 static int __devexit max7359_remove(struct i2c_client *client)
265 struct max7359_keypad *keypad = i2c_get_clientdata(client);
267 free_irq(client->irq, keypad);
268 input_unregister_device(keypad->input_dev);
275 static int max7359_suspend(struct device *dev)
277 struct i2c_client *client = to_i2c_client(dev);
279 max7359_fall_deepsleep(client);
281 if (device_may_wakeup(&client->dev))
282 enable_irq_wake(client->irq);
287 static int max7359_resume(struct device *dev)
289 struct i2c_client *client = to_i2c_client(dev);
291 if (device_may_wakeup(&client->dev))
292 disable_irq_wake(client->irq);
294 /* Restore the default setting */
295 max7359_take_catnap(client);
301 static SIMPLE_DEV_PM_OPS(max7359_pm, max7359_suspend, max7359_resume);
303 static const struct i2c_device_id max7359_ids[] = {
307 MODULE_DEVICE_TABLE(i2c, max7359_ids);
309 static struct i2c_driver max7359_i2c_driver = {
314 .probe = max7359_probe,
315 .remove = __devexit_p(max7359_remove),
316 .id_table = max7359_ids,
319 static int __init max7359_init(void)
321 return i2c_add_driver(&max7359_i2c_driver);
323 module_init(max7359_init);
325 static void __exit max7359_exit(void)
327 i2c_del_driver(&max7359_i2c_driver);
329 module_exit(max7359_exit);
331 MODULE_AUTHOR("Kim Kyuwon <q1.kim@samsung.com>");
332 MODULE_DESCRIPTION("MAX7359 Key Switch Controller Driver");
333 MODULE_LICENSE("GPL v2");