d76b0e4e67c4ff2d5229c2f96c455b551aba0bb9
[platform/kernel/linux-starfive.git] / drivers / input / keyboard / adp5589-keys.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Description:  keypad driver for ADP5589, ADP5585
4  *               I2C QWERTY Keypad and IO Expander
5  * Bugs: Enter bugs at http://blackfin.uclinux.org/
6  *
7  * Copyright (C) 2010-2011 Analog Devices Inc.
8  */
9
10 #include <linux/bitops.h>
11 #include <linux/module.h>
12 #include <linux/interrupt.h>
13 #include <linux/irq.h>
14 #include <linux/workqueue.h>
15 #include <linux/errno.h>
16 #include <linux/pm.h>
17 #include <linux/platform_device.h>
18 #include <linux/input.h>
19 #include <linux/i2c.h>
20 #include <linux/gpio.h>
21 #include <linux/slab.h>
22
23 #include <linux/input/adp5589.h>
24
25 /* ADP5589/ADP5585 Common Registers */
26 #define ADP5589_5_ID                    0x00
27 #define ADP5589_5_INT_STATUS            0x01
28 #define ADP5589_5_STATUS                0x02
29 #define ADP5589_5_FIFO_1                0x03
30 #define ADP5589_5_FIFO_2                0x04
31 #define ADP5589_5_FIFO_3                0x05
32 #define ADP5589_5_FIFO_4                0x06
33 #define ADP5589_5_FIFO_5                0x07
34 #define ADP5589_5_FIFO_6                0x08
35 #define ADP5589_5_FIFO_7                0x09
36 #define ADP5589_5_FIFO_8                0x0A
37 #define ADP5589_5_FIFO_9                0x0B
38 #define ADP5589_5_FIFO_10               0x0C
39 #define ADP5589_5_FIFO_11               0x0D
40 #define ADP5589_5_FIFO_12               0x0E
41 #define ADP5589_5_FIFO_13               0x0F
42 #define ADP5589_5_FIFO_14               0x10
43 #define ADP5589_5_FIFO_15               0x11
44 #define ADP5589_5_FIFO_16               0x12
45 #define ADP5589_5_GPI_INT_STAT_A        0x13
46 #define ADP5589_5_GPI_INT_STAT_B        0x14
47
48 /* ADP5589 Registers */
49 #define ADP5589_GPI_INT_STAT_C          0x15
50 #define ADP5589_GPI_STATUS_A            0x16
51 #define ADP5589_GPI_STATUS_B            0x17
52 #define ADP5589_GPI_STATUS_C            0x18
53 #define ADP5589_RPULL_CONFIG_A          0x19
54 #define ADP5589_RPULL_CONFIG_B          0x1A
55 #define ADP5589_RPULL_CONFIG_C          0x1B
56 #define ADP5589_RPULL_CONFIG_D          0x1C
57 #define ADP5589_RPULL_CONFIG_E          0x1D
58 #define ADP5589_GPI_INT_LEVEL_A         0x1E
59 #define ADP5589_GPI_INT_LEVEL_B         0x1F
60 #define ADP5589_GPI_INT_LEVEL_C         0x20
61 #define ADP5589_GPI_EVENT_EN_A          0x21
62 #define ADP5589_GPI_EVENT_EN_B          0x22
63 #define ADP5589_GPI_EVENT_EN_C          0x23
64 #define ADP5589_GPI_INTERRUPT_EN_A      0x24
65 #define ADP5589_GPI_INTERRUPT_EN_B      0x25
66 #define ADP5589_GPI_INTERRUPT_EN_C      0x26
67 #define ADP5589_DEBOUNCE_DIS_A          0x27
68 #define ADP5589_DEBOUNCE_DIS_B          0x28
69 #define ADP5589_DEBOUNCE_DIS_C          0x29
70 #define ADP5589_GPO_DATA_OUT_A          0x2A
71 #define ADP5589_GPO_DATA_OUT_B          0x2B
72 #define ADP5589_GPO_DATA_OUT_C          0x2C
73 #define ADP5589_GPO_OUT_MODE_A          0x2D
74 #define ADP5589_GPO_OUT_MODE_B          0x2E
75 #define ADP5589_GPO_OUT_MODE_C          0x2F
76 #define ADP5589_GPIO_DIRECTION_A        0x30
77 #define ADP5589_GPIO_DIRECTION_B        0x31
78 #define ADP5589_GPIO_DIRECTION_C        0x32
79 #define ADP5589_UNLOCK1                 0x33
80 #define ADP5589_UNLOCK2                 0x34
81 #define ADP5589_EXT_LOCK_EVENT          0x35
82 #define ADP5589_UNLOCK_TIMERS           0x36
83 #define ADP5589_LOCK_CFG                0x37
84 #define ADP5589_RESET1_EVENT_A          0x38
85 #define ADP5589_RESET1_EVENT_B          0x39
86 #define ADP5589_RESET1_EVENT_C          0x3A
87 #define ADP5589_RESET2_EVENT_A          0x3B
88 #define ADP5589_RESET2_EVENT_B          0x3C
89 #define ADP5589_RESET_CFG               0x3D
90 #define ADP5589_PWM_OFFT_LOW            0x3E
91 #define ADP5589_PWM_OFFT_HIGH           0x3F
92 #define ADP5589_PWM_ONT_LOW             0x40
93 #define ADP5589_PWM_ONT_HIGH            0x41
94 #define ADP5589_PWM_CFG                 0x42
95 #define ADP5589_CLOCK_DIV_CFG           0x43
96 #define ADP5589_LOGIC_1_CFG             0x44
97 #define ADP5589_LOGIC_2_CFG             0x45
98 #define ADP5589_LOGIC_FF_CFG            0x46
99 #define ADP5589_LOGIC_INT_EVENT_EN      0x47
100 #define ADP5589_POLL_PTIME_CFG          0x48
101 #define ADP5589_PIN_CONFIG_A            0x49
102 #define ADP5589_PIN_CONFIG_B            0x4A
103 #define ADP5589_PIN_CONFIG_C            0x4B
104 #define ADP5589_PIN_CONFIG_D            0x4C
105 #define ADP5589_GENERAL_CFG             0x4D
106 #define ADP5589_INT_EN                  0x4E
107
108 /* ADP5585 Registers */
109 #define ADP5585_GPI_STATUS_A            0x15
110 #define ADP5585_GPI_STATUS_B            0x16
111 #define ADP5585_RPULL_CONFIG_A          0x17
112 #define ADP5585_RPULL_CONFIG_B          0x18
113 #define ADP5585_RPULL_CONFIG_C          0x19
114 #define ADP5585_RPULL_CONFIG_D          0x1A
115 #define ADP5585_GPI_INT_LEVEL_A         0x1B
116 #define ADP5585_GPI_INT_LEVEL_B         0x1C
117 #define ADP5585_GPI_EVENT_EN_A          0x1D
118 #define ADP5585_GPI_EVENT_EN_B          0x1E
119 #define ADP5585_GPI_INTERRUPT_EN_A      0x1F
120 #define ADP5585_GPI_INTERRUPT_EN_B      0x20
121 #define ADP5585_DEBOUNCE_DIS_A          0x21
122 #define ADP5585_DEBOUNCE_DIS_B          0x22
123 #define ADP5585_GPO_DATA_OUT_A          0x23
124 #define ADP5585_GPO_DATA_OUT_B          0x24
125 #define ADP5585_GPO_OUT_MODE_A          0x25
126 #define ADP5585_GPO_OUT_MODE_B          0x26
127 #define ADP5585_GPIO_DIRECTION_A        0x27
128 #define ADP5585_GPIO_DIRECTION_B        0x28
129 #define ADP5585_RESET1_EVENT_A          0x29
130 #define ADP5585_RESET1_EVENT_B          0x2A
131 #define ADP5585_RESET1_EVENT_C          0x2B
132 #define ADP5585_RESET2_EVENT_A          0x2C
133 #define ADP5585_RESET2_EVENT_B          0x2D
134 #define ADP5585_RESET_CFG               0x2E
135 #define ADP5585_PWM_OFFT_LOW            0x2F
136 #define ADP5585_PWM_OFFT_HIGH           0x30
137 #define ADP5585_PWM_ONT_LOW             0x31
138 #define ADP5585_PWM_ONT_HIGH            0x32
139 #define ADP5585_PWM_CFG                 0x33
140 #define ADP5585_LOGIC_CFG               0x34
141 #define ADP5585_LOGIC_FF_CFG            0x35
142 #define ADP5585_LOGIC_INT_EVENT_EN      0x36
143 #define ADP5585_POLL_PTIME_CFG          0x37
144 #define ADP5585_PIN_CONFIG_A            0x38
145 #define ADP5585_PIN_CONFIG_B            0x39
146 #define ADP5585_PIN_CONFIG_D            0x3A
147 #define ADP5585_GENERAL_CFG             0x3B
148 #define ADP5585_INT_EN                  0x3C
149
150 /* ID Register */
151 #define ADP5589_5_DEVICE_ID_MASK        0xF
152 #define ADP5589_5_MAN_ID_MASK           0xF
153 #define ADP5589_5_MAN_ID_SHIFT          4
154 #define ADP5589_5_MAN_ID                0x02
155
156 /* GENERAL_CFG Register */
157 #define OSC_EN          BIT(7)
158 #define CORE_CLK(x)     (((x) & 0x3) << 5)
159 #define LCK_TRK_LOGIC   BIT(4)          /* ADP5589 only */
160 #define LCK_TRK_GPI     BIT(3)          /* ADP5589 only */
161 #define INT_CFG         BIT(1)
162 #define RST_CFG         BIT(0)
163
164 /* INT_EN Register */
165 #define LOGIC2_IEN      BIT(5)          /* ADP5589 only */
166 #define LOGIC1_IEN      BIT(4)
167 #define LOCK_IEN        BIT(3)          /* ADP5589 only */
168 #define OVRFLOW_IEN     BIT(2)
169 #define GPI_IEN         BIT(1)
170 #define EVENT_IEN       BIT(0)
171
172 /* Interrupt Status Register */
173 #define LOGIC2_INT      BIT(5)          /* ADP5589 only */
174 #define LOGIC1_INT      BIT(4)
175 #define LOCK_INT        BIT(3)          /* ADP5589 only */
176 #define OVRFLOW_INT     BIT(2)
177 #define GPI_INT         BIT(1)
178 #define EVENT_INT       BIT(0)
179
180 /* STATUS Register */
181 #define LOGIC2_STAT     BIT(7)          /* ADP5589 only */
182 #define LOGIC1_STAT     BIT(6)
183 #define LOCK_STAT       BIT(5)          /* ADP5589 only */
184 #define KEC             0x1F
185
186 /* PIN_CONFIG_D Register */
187 #define C4_EXTEND_CFG   BIT(6)          /* RESET2 */
188 #define R4_EXTEND_CFG   BIT(5)          /* RESET1 */
189
190 /* LOCK_CFG */
191 #define LOCK_EN         BIT(0)
192
193 #define PTIME_MASK      0x3
194 #define LTIME_MASK      0x3             /* ADP5589 only */
195
196 /* Key Event Register xy */
197 #define KEY_EV_PRESSED  BIT(7)
198 #define KEY_EV_MASK     0x7F
199
200 #define KEYP_MAX_EVENT          16
201 #define ADP5589_MAXGPIO         19
202 #define ADP5585_MAXGPIO         11 /* 10 on the ADP5585-01, 11 on ADP5585-02 */
203
204 enum {
205         ADP5589,
206         ADP5585_01,
207         ADP5585_02
208 };
209
210 struct adp_constants {
211         u8 maxgpio;
212         u8 keymapsize;
213         u8 gpi_pin_row_base;
214         u8 gpi_pin_row_end;
215         u8 gpi_pin_col_base;
216         u8 gpi_pin_base;
217         u8 gpi_pin_end;
218         u8 gpimapsize_max;
219         u8 max_row_num;
220         u8 max_col_num;
221         u8 row_mask;
222         u8 col_mask;
223         u8 col_shift;
224         u8 c4_extend_cfg;
225         u8 (*bank) (u8 offset);
226         u8 (*bit) (u8 offset);
227         u8 (*reg) (u8 reg);
228 };
229
230 struct adp5589_kpad {
231         struct i2c_client *client;
232         struct input_dev *input;
233         const struct adp_constants *var;
234         unsigned short keycode[ADP5589_KEYMAPSIZE];
235         const struct adp5589_gpi_map *gpimap;
236         unsigned short gpimapsize;
237         unsigned extend_cfg;
238         bool is_adp5585;
239         bool support_row5;
240 #ifdef CONFIG_GPIOLIB
241         unsigned char gpiomap[ADP5589_MAXGPIO];
242         struct gpio_chip gc;
243         struct mutex gpio_lock; /* Protect cached dir, dat_out */
244         u8 dat_out[3];
245         u8 dir[3];
246 #endif
247 };
248
249 /*
250  *  ADP5589 / ADP5585 derivative / variant handling
251  */
252
253
254 /* ADP5589 */
255
256 static unsigned char adp5589_bank(unsigned char offset)
257 {
258         return offset >> 3;
259 }
260
261 static unsigned char adp5589_bit(unsigned char offset)
262 {
263         return 1u << (offset & 0x7);
264 }
265
266 static unsigned char adp5589_reg(unsigned char reg)
267 {
268         return reg;
269 }
270
271 static const struct adp_constants const_adp5589 = {
272         .maxgpio                = ADP5589_MAXGPIO,
273         .keymapsize             = ADP5589_KEYMAPSIZE,
274         .gpi_pin_row_base       = ADP5589_GPI_PIN_ROW_BASE,
275         .gpi_pin_row_end        = ADP5589_GPI_PIN_ROW_END,
276         .gpi_pin_col_base       = ADP5589_GPI_PIN_COL_BASE,
277         .gpi_pin_base           = ADP5589_GPI_PIN_BASE,
278         .gpi_pin_end            = ADP5589_GPI_PIN_END,
279         .gpimapsize_max         = ADP5589_GPIMAPSIZE_MAX,
280         .c4_extend_cfg          = 12,
281         .max_row_num            = ADP5589_MAX_ROW_NUM,
282         .max_col_num            = ADP5589_MAX_COL_NUM,
283         .row_mask               = ADP5589_ROW_MASK,
284         .col_mask               = ADP5589_COL_MASK,
285         .col_shift              = ADP5589_COL_SHIFT,
286         .bank                   = adp5589_bank,
287         .bit                    = adp5589_bit,
288         .reg                    = adp5589_reg,
289 };
290
291 /* ADP5585 */
292
293 static unsigned char adp5585_bank(unsigned char offset)
294 {
295         return offset > ADP5585_MAX_ROW_NUM;
296 }
297
298 static unsigned char adp5585_bit(unsigned char offset)
299 {
300         return (offset > ADP5585_MAX_ROW_NUM) ?
301                 1u << (offset - ADP5585_COL_SHIFT) : 1u << offset;
302 }
303
304 static const unsigned char adp5585_reg_lut[] = {
305         [ADP5589_GPI_STATUS_A]          = ADP5585_GPI_STATUS_A,
306         [ADP5589_GPI_STATUS_B]          = ADP5585_GPI_STATUS_B,
307         [ADP5589_RPULL_CONFIG_A]        = ADP5585_RPULL_CONFIG_A,
308         [ADP5589_RPULL_CONFIG_B]        = ADP5585_RPULL_CONFIG_B,
309         [ADP5589_RPULL_CONFIG_C]        = ADP5585_RPULL_CONFIG_C,
310         [ADP5589_RPULL_CONFIG_D]        = ADP5585_RPULL_CONFIG_D,
311         [ADP5589_GPI_INT_LEVEL_A]       = ADP5585_GPI_INT_LEVEL_A,
312         [ADP5589_GPI_INT_LEVEL_B]       = ADP5585_GPI_INT_LEVEL_B,
313         [ADP5589_GPI_EVENT_EN_A]        = ADP5585_GPI_EVENT_EN_A,
314         [ADP5589_GPI_EVENT_EN_B]        = ADP5585_GPI_EVENT_EN_B,
315         [ADP5589_GPI_INTERRUPT_EN_A]    = ADP5585_GPI_INTERRUPT_EN_A,
316         [ADP5589_GPI_INTERRUPT_EN_B]    = ADP5585_GPI_INTERRUPT_EN_B,
317         [ADP5589_DEBOUNCE_DIS_A]        = ADP5585_DEBOUNCE_DIS_A,
318         [ADP5589_DEBOUNCE_DIS_B]        = ADP5585_DEBOUNCE_DIS_B,
319         [ADP5589_GPO_DATA_OUT_A]        = ADP5585_GPO_DATA_OUT_A,
320         [ADP5589_GPO_DATA_OUT_B]        = ADP5585_GPO_DATA_OUT_B,
321         [ADP5589_GPO_OUT_MODE_A]        = ADP5585_GPO_OUT_MODE_A,
322         [ADP5589_GPO_OUT_MODE_B]        = ADP5585_GPO_OUT_MODE_B,
323         [ADP5589_GPIO_DIRECTION_A]      = ADP5585_GPIO_DIRECTION_A,
324         [ADP5589_GPIO_DIRECTION_B]      = ADP5585_GPIO_DIRECTION_B,
325         [ADP5589_RESET1_EVENT_A]        = ADP5585_RESET1_EVENT_A,
326         [ADP5589_RESET1_EVENT_B]        = ADP5585_RESET1_EVENT_B,
327         [ADP5589_RESET1_EVENT_C]        = ADP5585_RESET1_EVENT_C,
328         [ADP5589_RESET2_EVENT_A]        = ADP5585_RESET2_EVENT_A,
329         [ADP5589_RESET2_EVENT_B]        = ADP5585_RESET2_EVENT_B,
330         [ADP5589_RESET_CFG]             = ADP5585_RESET_CFG,
331         [ADP5589_PWM_OFFT_LOW]          = ADP5585_PWM_OFFT_LOW,
332         [ADP5589_PWM_OFFT_HIGH]         = ADP5585_PWM_OFFT_HIGH,
333         [ADP5589_PWM_ONT_LOW]           = ADP5585_PWM_ONT_LOW,
334         [ADP5589_PWM_ONT_HIGH]          = ADP5585_PWM_ONT_HIGH,
335         [ADP5589_PWM_CFG]               = ADP5585_PWM_CFG,
336         [ADP5589_LOGIC_1_CFG]           = ADP5585_LOGIC_CFG,
337         [ADP5589_LOGIC_FF_CFG]          = ADP5585_LOGIC_FF_CFG,
338         [ADP5589_LOGIC_INT_EVENT_EN]    = ADP5585_LOGIC_INT_EVENT_EN,
339         [ADP5589_POLL_PTIME_CFG]        = ADP5585_POLL_PTIME_CFG,
340         [ADP5589_PIN_CONFIG_A]          = ADP5585_PIN_CONFIG_A,
341         [ADP5589_PIN_CONFIG_B]          = ADP5585_PIN_CONFIG_B,
342         [ADP5589_PIN_CONFIG_D]          = ADP5585_PIN_CONFIG_D,
343         [ADP5589_GENERAL_CFG]           = ADP5585_GENERAL_CFG,
344         [ADP5589_INT_EN]                = ADP5585_INT_EN,
345 };
346
347 static unsigned char adp5585_reg(unsigned char reg)
348 {
349         return adp5585_reg_lut[reg];
350 }
351
352 static const struct adp_constants const_adp5585 = {
353         .maxgpio                = ADP5585_MAXGPIO,
354         .keymapsize             = ADP5585_KEYMAPSIZE,
355         .gpi_pin_row_base       = ADP5585_GPI_PIN_ROW_BASE,
356         .gpi_pin_row_end        = ADP5585_GPI_PIN_ROW_END,
357         .gpi_pin_col_base       = ADP5585_GPI_PIN_COL_BASE,
358         .gpi_pin_base           = ADP5585_GPI_PIN_BASE,
359         .gpi_pin_end            = ADP5585_GPI_PIN_END,
360         .gpimapsize_max         = ADP5585_GPIMAPSIZE_MAX,
361         .c4_extend_cfg          = 10,
362         .max_row_num            = ADP5585_MAX_ROW_NUM,
363         .max_col_num            = ADP5585_MAX_COL_NUM,
364         .row_mask               = ADP5585_ROW_MASK,
365         .col_mask               = ADP5585_COL_MASK,
366         .col_shift              = ADP5585_COL_SHIFT,
367         .bank                   = adp5585_bank,
368         .bit                    = adp5585_bit,
369         .reg                    = adp5585_reg,
370 };
371
372 static int adp5589_read(struct i2c_client *client, u8 reg)
373 {
374         int ret = i2c_smbus_read_byte_data(client, reg);
375
376         if (ret < 0)
377                 dev_err(&client->dev, "Read Error\n");
378
379         return ret;
380 }
381
382 static int adp5589_write(struct i2c_client *client, u8 reg, u8 val)
383 {
384         return i2c_smbus_write_byte_data(client, reg, val);
385 }
386
387 #ifdef CONFIG_GPIOLIB
388 static int adp5589_gpio_get_value(struct gpio_chip *chip, unsigned off)
389 {
390         struct adp5589_kpad *kpad = gpiochip_get_data(chip);
391         unsigned int bank = kpad->var->bank(kpad->gpiomap[off]);
392         unsigned int bit = kpad->var->bit(kpad->gpiomap[off]);
393
394         return !!(adp5589_read(kpad->client,
395                                kpad->var->reg(ADP5589_GPI_STATUS_A) + bank) &
396                                bit);
397 }
398
399 static void adp5589_gpio_set_value(struct gpio_chip *chip,
400                                    unsigned off, int val)
401 {
402         struct adp5589_kpad *kpad = gpiochip_get_data(chip);
403         unsigned int bank = kpad->var->bank(kpad->gpiomap[off]);
404         unsigned int bit = kpad->var->bit(kpad->gpiomap[off]);
405
406         mutex_lock(&kpad->gpio_lock);
407
408         if (val)
409                 kpad->dat_out[bank] |= bit;
410         else
411                 kpad->dat_out[bank] &= ~bit;
412
413         adp5589_write(kpad->client, kpad->var->reg(ADP5589_GPO_DATA_OUT_A) +
414                       bank, kpad->dat_out[bank]);
415
416         mutex_unlock(&kpad->gpio_lock);
417 }
418
419 static int adp5589_gpio_direction_input(struct gpio_chip *chip, unsigned off)
420 {
421         struct adp5589_kpad *kpad = gpiochip_get_data(chip);
422         unsigned int bank = kpad->var->bank(kpad->gpiomap[off]);
423         unsigned int bit = kpad->var->bit(kpad->gpiomap[off]);
424         int ret;
425
426         mutex_lock(&kpad->gpio_lock);
427
428         kpad->dir[bank] &= ~bit;
429         ret = adp5589_write(kpad->client,
430                             kpad->var->reg(ADP5589_GPIO_DIRECTION_A) + bank,
431                             kpad->dir[bank]);
432
433         mutex_unlock(&kpad->gpio_lock);
434
435         return ret;
436 }
437
438 static int adp5589_gpio_direction_output(struct gpio_chip *chip,
439                                          unsigned off, int val)
440 {
441         struct adp5589_kpad *kpad = gpiochip_get_data(chip);
442         unsigned int bank = kpad->var->bank(kpad->gpiomap[off]);
443         unsigned int bit = kpad->var->bit(kpad->gpiomap[off]);
444         int ret;
445
446         mutex_lock(&kpad->gpio_lock);
447
448         kpad->dir[bank] |= bit;
449
450         if (val)
451                 kpad->dat_out[bank] |= bit;
452         else
453                 kpad->dat_out[bank] &= ~bit;
454
455         ret = adp5589_write(kpad->client, kpad->var->reg(ADP5589_GPO_DATA_OUT_A)
456                             + bank, kpad->dat_out[bank]);
457         ret |= adp5589_write(kpad->client,
458                              kpad->var->reg(ADP5589_GPIO_DIRECTION_A) + bank,
459                              kpad->dir[bank]);
460
461         mutex_unlock(&kpad->gpio_lock);
462
463         return ret;
464 }
465
466 static int adp5589_build_gpiomap(struct adp5589_kpad *kpad,
467                                 const struct adp5589_kpad_platform_data *pdata)
468 {
469         bool pin_used[ADP5589_MAXGPIO];
470         int n_unused = 0;
471         int i;
472
473         memset(pin_used, false, sizeof(pin_used));
474
475         for (i = 0; i < kpad->var->maxgpio; i++)
476                 if (pdata->keypad_en_mask & BIT(i))
477                         pin_used[i] = true;
478
479         for (i = 0; i < kpad->gpimapsize; i++)
480                 pin_used[kpad->gpimap[i].pin - kpad->var->gpi_pin_base] = true;
481
482         if (kpad->extend_cfg & R4_EXTEND_CFG)
483                 pin_used[4] = true;
484
485         if (kpad->extend_cfg & C4_EXTEND_CFG)
486                 pin_used[kpad->var->c4_extend_cfg] = true;
487
488         if (!kpad->support_row5)
489                 pin_used[5] = true;
490
491         for (i = 0; i < kpad->var->maxgpio; i++)
492                 if (!pin_used[i])
493                         kpad->gpiomap[n_unused++] = i;
494
495         return n_unused;
496 }
497
498 static int adp5589_gpio_add(struct adp5589_kpad *kpad)
499 {
500         struct device *dev = &kpad->client->dev;
501         const struct adp5589_kpad_platform_data *pdata = dev_get_platdata(dev);
502         const struct adp5589_gpio_platform_data *gpio_data = pdata->gpio_data;
503         int i, error;
504
505         if (!gpio_data)
506                 return 0;
507
508         kpad->gc.parent = dev;
509         kpad->gc.ngpio = adp5589_build_gpiomap(kpad, pdata);
510         if (kpad->gc.ngpio == 0) {
511                 dev_info(dev, "No unused gpios left to export\n");
512                 return 0;
513         }
514
515         kpad->gc.direction_input = adp5589_gpio_direction_input;
516         kpad->gc.direction_output = adp5589_gpio_direction_output;
517         kpad->gc.get = adp5589_gpio_get_value;
518         kpad->gc.set = adp5589_gpio_set_value;
519         kpad->gc.can_sleep = 1;
520
521         kpad->gc.base = gpio_data->gpio_start;
522         kpad->gc.label = kpad->client->name;
523         kpad->gc.owner = THIS_MODULE;
524
525         mutex_init(&kpad->gpio_lock);
526
527         error = devm_gpiochip_add_data(dev, &kpad->gc, kpad);
528         if (error)
529                 return error;
530
531         for (i = 0; i <= kpad->var->bank(kpad->var->maxgpio); i++) {
532                 kpad->dat_out[i] = adp5589_read(kpad->client, kpad->var->reg(
533                                                 ADP5589_GPO_DATA_OUT_A) + i);
534                 kpad->dir[i] = adp5589_read(kpad->client, kpad->var->reg(
535                                             ADP5589_GPIO_DIRECTION_A) + i);
536         }
537
538         return 0;
539 }
540 #else
541 static inline int adp5589_gpio_add(struct adp5589_kpad *kpad)
542 {
543         return 0;
544 }
545 #endif
546
547 static void adp5589_report_switches(struct adp5589_kpad *kpad,
548                                     int key, int key_val)
549 {
550         int i;
551
552         for (i = 0; i < kpad->gpimapsize; i++) {
553                 if (key_val == kpad->gpimap[i].pin) {
554                         input_report_switch(kpad->input,
555                                             kpad->gpimap[i].sw_evt,
556                                             key & KEY_EV_PRESSED);
557                         break;
558                 }
559         }
560 }
561
562 static void adp5589_report_events(struct adp5589_kpad *kpad, int ev_cnt)
563 {
564         int i;
565
566         for (i = 0; i < ev_cnt; i++) {
567                 int key = adp5589_read(kpad->client, ADP5589_5_FIFO_1 + i);
568                 int key_val = key & KEY_EV_MASK;
569
570                 if (key_val >= kpad->var->gpi_pin_base &&
571                     key_val <= kpad->var->gpi_pin_end) {
572                         adp5589_report_switches(kpad, key, key_val);
573                 } else {
574                         input_report_key(kpad->input,
575                                          kpad->keycode[key_val - 1],
576                                          key & KEY_EV_PRESSED);
577                 }
578         }
579 }
580
581 static irqreturn_t adp5589_irq(int irq, void *handle)
582 {
583         struct adp5589_kpad *kpad = handle;
584         struct i2c_client *client = kpad->client;
585         int status, ev_cnt;
586
587         status = adp5589_read(client, ADP5589_5_INT_STATUS);
588
589         if (status & OVRFLOW_INT)       /* Unlikely and should never happen */
590                 dev_err(&client->dev, "Event Overflow Error\n");
591
592         if (status & EVENT_INT) {
593                 ev_cnt = adp5589_read(client, ADP5589_5_STATUS) & KEC;
594                 if (ev_cnt) {
595                         adp5589_report_events(kpad, ev_cnt);
596                         input_sync(kpad->input);
597                 }
598         }
599
600         adp5589_write(client, ADP5589_5_INT_STATUS, status); /* Status is W1C */
601
602         return IRQ_HANDLED;
603 }
604
605 static int adp5589_get_evcode(struct adp5589_kpad *kpad, unsigned short key)
606 {
607         int i;
608
609         for (i = 0; i < kpad->var->keymapsize; i++)
610                 if (key == kpad->keycode[i])
611                         return (i + 1) | KEY_EV_PRESSED;
612
613         dev_err(&kpad->client->dev, "RESET/UNLOCK key not in keycode map\n");
614
615         return -EINVAL;
616 }
617
618 static int adp5589_setup(struct adp5589_kpad *kpad)
619 {
620         struct i2c_client *client = kpad->client;
621         const struct adp5589_kpad_platform_data *pdata =
622                 dev_get_platdata(&client->dev);
623         u8 (*reg) (u8) = kpad->var->reg;
624         unsigned char evt_mode1 = 0, evt_mode2 = 0, evt_mode3 = 0;
625         unsigned char pull_mask = 0;
626         int i, ret;
627
628         ret = adp5589_write(client, reg(ADP5589_PIN_CONFIG_A),
629                             pdata->keypad_en_mask & kpad->var->row_mask);
630         ret |= adp5589_write(client, reg(ADP5589_PIN_CONFIG_B),
631                              (pdata->keypad_en_mask >> kpad->var->col_shift) &
632                              kpad->var->col_mask);
633
634         if (!kpad->is_adp5585)
635                 ret |= adp5589_write(client, ADP5589_PIN_CONFIG_C,
636                                      (pdata->keypad_en_mask >> 16) & 0xFF);
637
638         if (!kpad->is_adp5585 && pdata->en_keylock) {
639                 ret |= adp5589_write(client, ADP5589_UNLOCK1,
640                                      pdata->unlock_key1);
641                 ret |= adp5589_write(client, ADP5589_UNLOCK2,
642                                      pdata->unlock_key2);
643                 ret |= adp5589_write(client, ADP5589_UNLOCK_TIMERS,
644                                      pdata->unlock_timer & LTIME_MASK);
645                 ret |= adp5589_write(client, ADP5589_LOCK_CFG, LOCK_EN);
646         }
647
648         for (i = 0; i < KEYP_MAX_EVENT; i++)
649                 ret |= adp5589_read(client, ADP5589_5_FIFO_1 + i);
650
651         for (i = 0; i < pdata->gpimapsize; i++) {
652                 unsigned short pin = pdata->gpimap[i].pin;
653
654                 if (pin <= kpad->var->gpi_pin_row_end) {
655                         evt_mode1 |= BIT(pin - kpad->var->gpi_pin_row_base);
656                 } else {
657                         evt_mode2 |=
658                             BIT(pin - kpad->var->gpi_pin_col_base) & 0xFF;
659                         if (!kpad->is_adp5585)
660                                 evt_mode3 |=
661                                     BIT(pin - kpad->var->gpi_pin_col_base) >> 8;
662                 }
663         }
664
665         if (pdata->gpimapsize) {
666                 ret |= adp5589_write(client, reg(ADP5589_GPI_EVENT_EN_A),
667                                      evt_mode1);
668                 ret |= adp5589_write(client, reg(ADP5589_GPI_EVENT_EN_B),
669                                      evt_mode2);
670                 if (!kpad->is_adp5585)
671                         ret |= adp5589_write(client,
672                                              reg(ADP5589_GPI_EVENT_EN_C),
673                                              evt_mode3);
674         }
675
676         if (pdata->pull_dis_mask & pdata->pullup_en_100k &
677                 pdata->pullup_en_300k & pdata->pulldown_en_300k)
678                 dev_warn(&client->dev, "Conflicting pull resistor config\n");
679
680         for (i = 0; i <= kpad->var->max_row_num; i++) {
681                 unsigned int val = 0, bit = BIT(i);
682                 if (pdata->pullup_en_300k & bit)
683                         val = 0;
684                 else if (pdata->pulldown_en_300k & bit)
685                         val = 1;
686                 else if (pdata->pullup_en_100k & bit)
687                         val = 2;
688                 else if (pdata->pull_dis_mask & bit)
689                         val = 3;
690
691                 pull_mask |= val << (2 * (i & 0x3));
692
693                 if (i % 4 == 3 || i == kpad->var->max_row_num) {
694                         ret |= adp5589_write(client, reg(ADP5585_RPULL_CONFIG_A)
695                                              + (i >> 2), pull_mask);
696                         pull_mask = 0;
697                 }
698         }
699
700         for (i = 0; i <= kpad->var->max_col_num; i++) {
701                 unsigned int val = 0, bit = BIT(i + kpad->var->col_shift);
702                 if (pdata->pullup_en_300k & bit)
703                         val = 0;
704                 else if (pdata->pulldown_en_300k & bit)
705                         val = 1;
706                 else if (pdata->pullup_en_100k & bit)
707                         val = 2;
708                 else if (pdata->pull_dis_mask & bit)
709                         val = 3;
710
711                 pull_mask |= val << (2 * (i & 0x3));
712
713                 if (i % 4 == 3 || i == kpad->var->max_col_num) {
714                         ret |= adp5589_write(client,
715                                              reg(ADP5585_RPULL_CONFIG_C) +
716                                              (i >> 2), pull_mask);
717                         pull_mask = 0;
718                 }
719         }
720
721         if (pdata->reset1_key_1 && pdata->reset1_key_2 && pdata->reset1_key_3) {
722                 ret |= adp5589_write(client, reg(ADP5589_RESET1_EVENT_A),
723                                      adp5589_get_evcode(kpad,
724                                                         pdata->reset1_key_1));
725                 ret |= adp5589_write(client, reg(ADP5589_RESET1_EVENT_B),
726                                      adp5589_get_evcode(kpad,
727                                                         pdata->reset1_key_2));
728                 ret |= adp5589_write(client, reg(ADP5589_RESET1_EVENT_C),
729                                      adp5589_get_evcode(kpad,
730                                                         pdata->reset1_key_3));
731                 kpad->extend_cfg |= R4_EXTEND_CFG;
732         }
733
734         if (pdata->reset2_key_1 && pdata->reset2_key_2) {
735                 ret |= adp5589_write(client, reg(ADP5589_RESET2_EVENT_A),
736                                      adp5589_get_evcode(kpad,
737                                                         pdata->reset2_key_1));
738                 ret |= adp5589_write(client, reg(ADP5589_RESET2_EVENT_B),
739                                      adp5589_get_evcode(kpad,
740                                                         pdata->reset2_key_2));
741                 kpad->extend_cfg |= C4_EXTEND_CFG;
742         }
743
744         if (kpad->extend_cfg) {
745                 ret |= adp5589_write(client, reg(ADP5589_RESET_CFG),
746                                      pdata->reset_cfg);
747                 ret |= adp5589_write(client, reg(ADP5589_PIN_CONFIG_D),
748                                      kpad->extend_cfg);
749         }
750
751         ret |= adp5589_write(client, reg(ADP5589_DEBOUNCE_DIS_A),
752                             pdata->debounce_dis_mask & kpad->var->row_mask);
753
754         ret |= adp5589_write(client, reg(ADP5589_DEBOUNCE_DIS_B),
755                              (pdata->debounce_dis_mask >> kpad->var->col_shift)
756                              & kpad->var->col_mask);
757
758         if (!kpad->is_adp5585)
759                 ret |= adp5589_write(client, reg(ADP5589_DEBOUNCE_DIS_C),
760                                      (pdata->debounce_dis_mask >> 16) & 0xFF);
761
762         ret |= adp5589_write(client, reg(ADP5589_POLL_PTIME_CFG),
763                              pdata->scan_cycle_time & PTIME_MASK);
764         ret |= adp5589_write(client, ADP5589_5_INT_STATUS,
765                              (kpad->is_adp5585 ? 0 : LOGIC2_INT) |
766                              LOGIC1_INT | OVRFLOW_INT |
767                              (kpad->is_adp5585 ? 0 : LOCK_INT) |
768                              GPI_INT | EVENT_INT);      /* Status is W1C */
769
770         ret |= adp5589_write(client, reg(ADP5589_GENERAL_CFG),
771                              INT_CFG | OSC_EN | CORE_CLK(3));
772         ret |= adp5589_write(client, reg(ADP5589_INT_EN),
773                              OVRFLOW_IEN | GPI_IEN | EVENT_IEN);
774
775         if (ret < 0) {
776                 dev_err(&client->dev, "Write Error\n");
777                 return ret;
778         }
779
780         return 0;
781 }
782
783 static void adp5589_report_switch_state(struct adp5589_kpad *kpad)
784 {
785         int gpi_stat_tmp, pin_loc;
786         int i;
787         int gpi_stat1 = adp5589_read(kpad->client,
788                                      kpad->var->reg(ADP5589_GPI_STATUS_A));
789         int gpi_stat2 = adp5589_read(kpad->client,
790                                      kpad->var->reg(ADP5589_GPI_STATUS_B));
791         int gpi_stat3 = !kpad->is_adp5585 ?
792                         adp5589_read(kpad->client, ADP5589_GPI_STATUS_C) : 0;
793
794         for (i = 0; i < kpad->gpimapsize; i++) {
795                 unsigned short pin = kpad->gpimap[i].pin;
796
797                 if (pin <= kpad->var->gpi_pin_row_end) {
798                         gpi_stat_tmp = gpi_stat1;
799                         pin_loc = pin - kpad->var->gpi_pin_row_base;
800                 } else if ((pin - kpad->var->gpi_pin_col_base) < 8) {
801                         gpi_stat_tmp = gpi_stat2;
802                         pin_loc = pin - kpad->var->gpi_pin_col_base;
803                 } else {
804                         gpi_stat_tmp = gpi_stat3;
805                         pin_loc = pin - kpad->var->gpi_pin_col_base - 8;
806                 }
807
808                 if (gpi_stat_tmp < 0) {
809                         dev_err(&kpad->client->dev,
810                                 "Can't read GPIO_DAT_STAT switch %d, default to OFF\n",
811                                 pin);
812                         gpi_stat_tmp = 0;
813                 }
814
815                 input_report_switch(kpad->input,
816                                     kpad->gpimap[i].sw_evt,
817                                     !(gpi_stat_tmp & BIT(pin_loc)));
818         }
819
820         input_sync(kpad->input);
821 }
822
823 static int adp5589_keypad_add(struct adp5589_kpad *kpad, unsigned int revid)
824 {
825         struct i2c_client *client = kpad->client;
826         const struct adp5589_kpad_platform_data *pdata =
827                 dev_get_platdata(&client->dev);
828         struct input_dev *input;
829         unsigned int i;
830         int error;
831
832         if (!((pdata->keypad_en_mask & kpad->var->row_mask) &&
833                         (pdata->keypad_en_mask >> kpad->var->col_shift)) ||
834                         !pdata->keymap) {
835                 dev_err(&client->dev, "no rows, cols or keymap from pdata\n");
836                 return -EINVAL;
837         }
838
839         if (pdata->keymapsize != kpad->var->keymapsize) {
840                 dev_err(&client->dev, "invalid keymapsize\n");
841                 return -EINVAL;
842         }
843
844         if (!pdata->gpimap && pdata->gpimapsize) {
845                 dev_err(&client->dev, "invalid gpimap from pdata\n");
846                 return -EINVAL;
847         }
848
849         if (pdata->gpimapsize > kpad->var->gpimapsize_max) {
850                 dev_err(&client->dev, "invalid gpimapsize\n");
851                 return -EINVAL;
852         }
853
854         for (i = 0; i < pdata->gpimapsize; i++) {
855                 unsigned short pin = pdata->gpimap[i].pin;
856
857                 if (pin < kpad->var->gpi_pin_base ||
858                                 pin > kpad->var->gpi_pin_end) {
859                         dev_err(&client->dev, "invalid gpi pin data\n");
860                         return -EINVAL;
861                 }
862
863                 if (BIT(pin - kpad->var->gpi_pin_row_base) &
864                                 pdata->keypad_en_mask) {
865                         dev_err(&client->dev, "invalid gpi row/col data\n");
866                         return -EINVAL;
867                 }
868         }
869
870         if (!client->irq) {
871                 dev_err(&client->dev, "no IRQ?\n");
872                 return -EINVAL;
873         }
874
875         input = devm_input_allocate_device(&client->dev);
876         if (!input)
877                 return -ENOMEM;
878
879         kpad->input = input;
880
881         input->name = client->name;
882         input->phys = "adp5589-keys/input0";
883         input->dev.parent = &client->dev;
884
885         input_set_drvdata(input, kpad);
886
887         input->id.bustype = BUS_I2C;
888         input->id.vendor = 0x0001;
889         input->id.product = 0x0001;
890         input->id.version = revid;
891
892         input->keycodesize = sizeof(kpad->keycode[0]);
893         input->keycodemax = pdata->keymapsize;
894         input->keycode = kpad->keycode;
895
896         memcpy(kpad->keycode, pdata->keymap,
897                pdata->keymapsize * input->keycodesize);
898
899         kpad->gpimap = pdata->gpimap;
900         kpad->gpimapsize = pdata->gpimapsize;
901
902         /* setup input device */
903         __set_bit(EV_KEY, input->evbit);
904
905         if (pdata->repeat)
906                 __set_bit(EV_REP, input->evbit);
907
908         for (i = 0; i < input->keycodemax; i++)
909                 if (kpad->keycode[i] <= KEY_MAX)
910                         __set_bit(kpad->keycode[i], input->keybit);
911         __clear_bit(KEY_RESERVED, input->keybit);
912
913         if (kpad->gpimapsize)
914                 __set_bit(EV_SW, input->evbit);
915         for (i = 0; i < kpad->gpimapsize; i++)
916                 __set_bit(kpad->gpimap[i].sw_evt, input->swbit);
917
918         error = input_register_device(input);
919         if (error) {
920                 dev_err(&client->dev, "unable to register input device\n");
921                 return error;
922         }
923
924         error = devm_request_threaded_irq(&client->dev, client->irq,
925                                           NULL, adp5589_irq,
926                                           IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
927                                           client->dev.driver->name, kpad);
928         if (error) {
929                 dev_err(&client->dev, "unable to request irq %d\n", client->irq);
930                 return error;
931         }
932
933         return 0;
934 }
935
936 static void adp5589_clear_config(void *data)
937 {
938         struct i2c_client *client = data;
939         struct adp5589_kpad *kpad = i2c_get_clientdata(client);
940
941         adp5589_write(client, kpad->var->reg(ADP5589_GENERAL_CFG), 0);
942 }
943
944 static int adp5589_probe(struct i2c_client *client,
945                          const struct i2c_device_id *id)
946 {
947         struct adp5589_kpad *kpad;
948         const struct adp5589_kpad_platform_data *pdata =
949                 dev_get_platdata(&client->dev);
950         unsigned int revid;
951         int error, ret;
952
953         if (!i2c_check_functionality(client->adapter,
954                                      I2C_FUNC_SMBUS_BYTE_DATA)) {
955                 dev_err(&client->dev, "SMBUS Byte Data not Supported\n");
956                 return -EIO;
957         }
958
959         if (!pdata) {
960                 dev_err(&client->dev, "no platform data?\n");
961                 return -EINVAL;
962         }
963
964         kpad = devm_kzalloc(&client->dev, sizeof(*kpad), GFP_KERNEL);
965         if (!kpad)
966                 return -ENOMEM;
967
968         kpad->client = client;
969
970         switch (id->driver_data) {
971         case ADP5585_02:
972                 kpad->support_row5 = true;
973                 fallthrough;
974         case ADP5585_01:
975                 kpad->is_adp5585 = true;
976                 kpad->var = &const_adp5585;
977                 break;
978         case ADP5589:
979                 kpad->support_row5 = true;
980                 kpad->var = &const_adp5589;
981                 break;
982         }
983
984         error = devm_add_action_or_reset(&client->dev, adp5589_clear_config,
985                                          client);
986         if (error)
987                 return error;
988
989         ret = adp5589_read(client, ADP5589_5_ID);
990         if (ret < 0)
991                 return ret;
992
993         revid = (u8) ret & ADP5589_5_DEVICE_ID_MASK;
994
995         if (pdata->keymapsize) {
996                 error = adp5589_keypad_add(kpad, revid);
997                 if (error)
998                         return error;
999         }
1000
1001         error = adp5589_setup(kpad);
1002         if (error)
1003                 return error;
1004
1005         if (kpad->gpimapsize)
1006                 adp5589_report_switch_state(kpad);
1007
1008         error = adp5589_gpio_add(kpad);
1009         if (error)
1010                 return error;
1011
1012         i2c_set_clientdata(client, kpad);
1013
1014         dev_info(&client->dev, "Rev.%d keypad, irq %d\n", revid, client->irq);
1015         return 0;
1016 }
1017
1018 static int __maybe_unused adp5589_suspend(struct device *dev)
1019 {
1020         struct adp5589_kpad *kpad = dev_get_drvdata(dev);
1021         struct i2c_client *client = kpad->client;
1022
1023         if (!kpad->input)
1024                 return 0;
1025
1026         disable_irq(client->irq);
1027
1028         if (device_may_wakeup(&client->dev))
1029                 enable_irq_wake(client->irq);
1030
1031         return 0;
1032 }
1033
1034 static int __maybe_unused adp5589_resume(struct device *dev)
1035 {
1036         struct adp5589_kpad *kpad = dev_get_drvdata(dev);
1037         struct i2c_client *client = kpad->client;
1038
1039         if (!kpad->input)
1040                 return 0;
1041
1042         if (device_may_wakeup(&client->dev))
1043                 disable_irq_wake(client->irq);
1044
1045         enable_irq(client->irq);
1046
1047         return 0;
1048 }
1049
1050 static SIMPLE_DEV_PM_OPS(adp5589_dev_pm_ops, adp5589_suspend, adp5589_resume);
1051
1052 static const struct i2c_device_id adp5589_id[] = {
1053         {"adp5589-keys", ADP5589},
1054         {"adp5585-keys", ADP5585_01},
1055         {"adp5585-02-keys", ADP5585_02}, /* Adds ROW5 to ADP5585 */
1056         {}
1057 };
1058
1059 MODULE_DEVICE_TABLE(i2c, adp5589_id);
1060
1061 static struct i2c_driver adp5589_driver = {
1062         .driver = {
1063                 .name = KBUILD_MODNAME,
1064                 .pm = &adp5589_dev_pm_ops,
1065         },
1066         .probe = adp5589_probe,
1067         .id_table = adp5589_id,
1068 };
1069
1070 module_i2c_driver(adp5589_driver);
1071
1072 MODULE_LICENSE("GPL");
1073 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
1074 MODULE_DESCRIPTION("ADP5589/ADP5585 Keypad driver");