Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
795e6bf3 MD |
2 | /* |
3 | * SuperH KEYSC Keypad Driver | |
4 | * | |
5 | * Copyright (C) 2008 Magnus Damm | |
6 | * | |
7 | * Based on gpio_keys.c, Copyright 2005 Phil Blundell | |
795e6bf3 MD |
8 | */ |
9 | ||
10 | #include <linux/kernel.h> | |
11 | #include <linux/module.h> | |
795e6bf3 MD |
12 | #include <linux/interrupt.h> |
13 | #include <linux/irq.h> | |
14 | #include <linux/delay.h> | |
15 | #include <linux/platform_device.h> | |
16 | #include <linux/input.h> | |
fc1d003d | 17 | #include <linux/input/sh_keysc.h> |
324e5ade | 18 | #include <linux/bitmap.h> |
b6d2a3e6 | 19 | #include <linux/pm_runtime.h> |
795e6bf3 | 20 | #include <linux/io.h> |
5a0e3ad6 | 21 | #include <linux/slab.h> |
795e6bf3 | 22 | |
795e6bf3 MD |
23 | static const struct { |
24 | unsigned char kymd, keyout, keyin; | |
25 | } sh_keysc_mode[] = { | |
26 | [SH_KEYSC_MODE_1] = { 0, 6, 5 }, | |
27 | [SH_KEYSC_MODE_2] = { 1, 5, 6 }, | |
28 | [SH_KEYSC_MODE_3] = { 2, 4, 7 }, | |
3bf12763 MD |
29 | [SH_KEYSC_MODE_4] = { 3, 6, 6 }, |
30 | [SH_KEYSC_MODE_5] = { 4, 6, 7 }, | |
cca23d0b | 31 | [SH_KEYSC_MODE_6] = { 5, 8, 8 }, |
795e6bf3 MD |
32 | }; |
33 | ||
34 | struct sh_keysc_priv { | |
35 | void __iomem *iomem_base; | |
324e5ade | 36 | DECLARE_BITMAP(last_keys, SH_KEYSC_MAXKEYS); |
795e6bf3 MD |
37 | struct input_dev *input; |
38 | struct sh_keysc_info pdata; | |
39 | }; | |
40 | ||
2b14a808 MD |
41 | #define KYCR1 0 |
42 | #define KYCR2 1 | |
43 | #define KYINDR 2 | |
44 | #define KYOUTDR 3 | |
45 | ||
46 | #define KYCR2_IRQ_LEVEL 0x10 | |
47 | #define KYCR2_IRQ_DISABLED 0x00 | |
48 | ||
49 | static unsigned long sh_keysc_read(struct sh_keysc_priv *p, int reg_nr) | |
50 | { | |
51 | return ioread16(p->iomem_base + (reg_nr << 2)); | |
52 | } | |
53 | ||
54 | static void sh_keysc_write(struct sh_keysc_priv *p, int reg_nr, | |
55 | unsigned long value) | |
56 | { | |
57 | iowrite16(value, p->iomem_base + (reg_nr << 2)); | |
58 | } | |
59 | ||
60 | static void sh_keysc_level_mode(struct sh_keysc_priv *p, | |
61 | unsigned long keys_set) | |
62 | { | |
63 | struct sh_keysc_info *pdata = &p->pdata; | |
64 | ||
65 | sh_keysc_write(p, KYOUTDR, 0); | |
66 | sh_keysc_write(p, KYCR2, KYCR2_IRQ_LEVEL | (keys_set << 8)); | |
67 | ||
68 | if (pdata->kycr2_delay) | |
69 | udelay(pdata->kycr2_delay); | |
70 | } | |
71 | ||
324e5ade MD |
72 | static void sh_keysc_map_dbg(struct device *dev, unsigned long *map, |
73 | const char *str) | |
74 | { | |
75 | int k; | |
76 | ||
77 | for (k = 0; k < BITS_TO_LONGS(SH_KEYSC_MAXKEYS); k++) | |
78 | dev_dbg(dev, "%s[%d] 0x%lx\n", str, k, map[k]); | |
79 | } | |
80 | ||
795e6bf3 MD |
81 | static irqreturn_t sh_keysc_isr(int irq, void *dev_id) |
82 | { | |
83 | struct platform_device *pdev = dev_id; | |
84 | struct sh_keysc_priv *priv = platform_get_drvdata(pdev); | |
85 | struct sh_keysc_info *pdata = &priv->pdata; | |
324e5ade MD |
86 | int keyout_nr = sh_keysc_mode[pdata->mode].keyout; |
87 | int keyin_nr = sh_keysc_mode[pdata->mode].keyin; | |
88 | DECLARE_BITMAP(keys, SH_KEYSC_MAXKEYS); | |
89 | DECLARE_BITMAP(keys0, SH_KEYSC_MAXKEYS); | |
90 | DECLARE_BITMAP(keys1, SH_KEYSC_MAXKEYS); | |
795e6bf3 | 91 | unsigned char keyin_set, tmp; |
324e5ade | 92 | int i, k, n; |
795e6bf3 MD |
93 | |
94 | dev_dbg(&pdev->dev, "isr!\n"); | |
95 | ||
324e5ade MD |
96 | bitmap_fill(keys1, SH_KEYSC_MAXKEYS); |
97 | bitmap_zero(keys0, SH_KEYSC_MAXKEYS); | |
795e6bf3 MD |
98 | |
99 | do { | |
324e5ade | 100 | bitmap_zero(keys, SH_KEYSC_MAXKEYS); |
795e6bf3 MD |
101 | keyin_set = 0; |
102 | ||
2b14a808 | 103 | sh_keysc_write(priv, KYCR2, KYCR2_IRQ_DISABLED); |
795e6bf3 | 104 | |
324e5ade MD |
105 | for (i = 0; i < keyout_nr; i++) { |
106 | n = keyin_nr * i; | |
107 | ||
108 | /* drive one KEYOUT pin low, read KEYIN pins */ | |
8f8be243 | 109 | sh_keysc_write(priv, KYOUTDR, 0xffff ^ (3 << (i * 2))); |
795e6bf3 | 110 | udelay(pdata->delay); |
2b14a808 MD |
111 | tmp = sh_keysc_read(priv, KYINDR); |
112 | ||
324e5ade MD |
113 | /* set bit if key press has been detected */ |
114 | for (k = 0; k < keyin_nr; k++) { | |
115 | if (tmp & (1 << k)) | |
116 | __set_bit(n + k, keys); | |
117 | } | |
118 | ||
119 | /* keep track of which KEYIN bits that have been set */ | |
120 | keyin_set |= tmp ^ ((1 << keyin_nr) - 1); | |
795e6bf3 MD |
121 | } |
122 | ||
2b14a808 | 123 | sh_keysc_level_mode(priv, keyin_set); |
1f85d381 | 124 | |
324e5ade MD |
125 | bitmap_complement(keys, keys, SH_KEYSC_MAXKEYS); |
126 | bitmap_and(keys1, keys1, keys, SH_KEYSC_MAXKEYS); | |
127 | bitmap_or(keys0, keys0, keys, SH_KEYSC_MAXKEYS); | |
795e6bf3 | 128 | |
324e5ade | 129 | sh_keysc_map_dbg(&pdev->dev, keys, "keys"); |
795e6bf3 | 130 | |
2b14a808 | 131 | } while (sh_keysc_read(priv, KYCR2) & 0x01); |
795e6bf3 | 132 | |
324e5ade MD |
133 | sh_keysc_map_dbg(&pdev->dev, priv->last_keys, "last_keys"); |
134 | sh_keysc_map_dbg(&pdev->dev, keys0, "keys0"); | |
135 | sh_keysc_map_dbg(&pdev->dev, keys1, "keys1"); | |
795e6bf3 MD |
136 | |
137 | for (i = 0; i < SH_KEYSC_MAXKEYS; i++) { | |
138 | k = pdata->keycodes[i]; | |
139 | if (!k) | |
140 | continue; | |
141 | ||
324e5ade | 142 | if (test_bit(i, keys0) == test_bit(i, priv->last_keys)) |
795e6bf3 MD |
143 | continue; |
144 | ||
324e5ade | 145 | if (test_bit(i, keys1) || test_bit(i, keys0)) { |
795e6bf3 | 146 | input_event(priv->input, EV_KEY, k, 1); |
324e5ade | 147 | __set_bit(i, priv->last_keys); |
795e6bf3 MD |
148 | } |
149 | ||
324e5ade | 150 | if (!test_bit(i, keys1)) { |
795e6bf3 | 151 | input_event(priv->input, EV_KEY, k, 0); |
324e5ade | 152 | __clear_bit(i, priv->last_keys); |
795e6bf3 MD |
153 | } |
154 | ||
155 | } | |
156 | input_sync(priv->input); | |
157 | ||
158 | return IRQ_HANDLED; | |
159 | } | |
160 | ||
5298cc4c | 161 | static int sh_keysc_probe(struct platform_device *pdev) |
795e6bf3 MD |
162 | { |
163 | struct sh_keysc_priv *priv; | |
164 | struct sh_keysc_info *pdata; | |
165 | struct resource *res; | |
166 | struct input_dev *input; | |
24d01c06 | 167 | int i; |
795e6bf3 MD |
168 | int irq, error; |
169 | ||
c838cb3d | 170 | if (!dev_get_platdata(&pdev->dev)) { |
795e6bf3 MD |
171 | dev_err(&pdev->dev, "no platform data defined\n"); |
172 | error = -EINVAL; | |
173 | goto err0; | |
174 | } | |
175 | ||
176 | error = -ENXIO; | |
177 | res = platform_get_resource(pdev, IORESOURCE_MEM, 0); | |
178 | if (res == NULL) { | |
179 | dev_err(&pdev->dev, "failed to get I/O memory\n"); | |
180 | goto err0; | |
181 | } | |
182 | ||
183 | irq = platform_get_irq(pdev, 0); | |
0bec8b7e | 184 | if (irq < 0) |
795e6bf3 | 185 | goto err0; |
795e6bf3 MD |
186 | |
187 | priv = kzalloc(sizeof(*priv), GFP_KERNEL); | |
188 | if (priv == NULL) { | |
189 | dev_err(&pdev->dev, "failed to allocate driver data\n"); | |
190 | error = -ENOMEM; | |
191 | goto err0; | |
192 | } | |
193 | ||
194 | platform_set_drvdata(pdev, priv); | |
c838cb3d | 195 | memcpy(&priv->pdata, dev_get_platdata(&pdev->dev), sizeof(priv->pdata)); |
795e6bf3 MD |
196 | pdata = &priv->pdata; |
197 | ||
4bdc0d67 | 198 | priv->iomem_base = ioremap(res->start, resource_size(res)); |
795e6bf3 MD |
199 | if (priv->iomem_base == NULL) { |
200 | dev_err(&pdev->dev, "failed to remap I/O memory\n"); | |
201 | error = -ENXIO; | |
d3aa43a9 | 202 | goto err1; |
795e6bf3 MD |
203 | } |
204 | ||
205 | priv->input = input_allocate_device(); | |
206 | if (!priv->input) { | |
207 | dev_err(&pdev->dev, "failed to allocate input device\n"); | |
208 | error = -ENOMEM; | |
b6d2a3e6 | 209 | goto err2; |
795e6bf3 MD |
210 | } |
211 | ||
212 | input = priv->input; | |
213 | input->evbit[0] = BIT_MASK(EV_KEY); | |
214 | ||
215 | input->name = pdev->name; | |
216 | input->phys = "sh-keysc-keys/input0"; | |
217 | input->dev.parent = &pdev->dev; | |
218 | ||
219 | input->id.bustype = BUS_HOST; | |
220 | input->id.vendor = 0x0001; | |
221 | input->id.product = 0x0001; | |
222 | input->id.version = 0x0100; | |
223 | ||
24d01c06 DT |
224 | input->keycode = pdata->keycodes; |
225 | input->keycodesize = sizeof(pdata->keycodes[0]); | |
226 | input->keycodemax = ARRAY_SIZE(pdata->keycodes); | |
227 | ||
2dfb9a85 MD |
228 | error = request_threaded_irq(irq, NULL, sh_keysc_isr, IRQF_ONESHOT, |
229 | dev_name(&pdev->dev), pdev); | |
795e6bf3 MD |
230 | if (error) { |
231 | dev_err(&pdev->dev, "failed to request IRQ\n"); | |
b6d2a3e6 | 232 | goto err3; |
795e6bf3 MD |
233 | } |
234 | ||
24d01c06 DT |
235 | for (i = 0; i < SH_KEYSC_MAXKEYS; i++) |
236 | __set_bit(pdata->keycodes[i], input->keybit); | |
237 | __clear_bit(KEY_RESERVED, input->keybit); | |
795e6bf3 MD |
238 | |
239 | error = input_register_device(input); | |
240 | if (error) { | |
241 | dev_err(&pdev->dev, "failed to register input device\n"); | |
b6d2a3e6 | 242 | goto err4; |
795e6bf3 MD |
243 | } |
244 | ||
b6d2a3e6 MD |
245 | pm_runtime_enable(&pdev->dev); |
246 | pm_runtime_get_sync(&pdev->dev); | |
090d951b | 247 | |
2b14a808 MD |
248 | sh_keysc_write(priv, KYCR1, (sh_keysc_mode[pdata->mode].kymd << 8) | |
249 | pdata->scan_timing); | |
250 | sh_keysc_level_mode(priv, 0); | |
a29b99ec MD |
251 | |
252 | device_init_wakeup(&pdev->dev, 1); | |
24d01c06 | 253 | |
795e6bf3 | 254 | return 0; |
24d01c06 | 255 | |
090d951b | 256 | err4: |
b6d2a3e6 | 257 | free_irq(irq, pdev); |
090d951b | 258 | err3: |
b6d2a3e6 | 259 | input_free_device(input); |
795e6bf3 | 260 | err2: |
d3aa43a9 | 261 | iounmap(priv->iomem_base); |
795e6bf3 | 262 | err1: |
795e6bf3 MD |
263 | kfree(priv); |
264 | err0: | |
265 | return error; | |
266 | } | |
267 | ||
e340089d | 268 | static void sh_keysc_remove(struct platform_device *pdev) |
795e6bf3 MD |
269 | { |
270 | struct sh_keysc_priv *priv = platform_get_drvdata(pdev); | |
795e6bf3 | 271 | |
2b14a808 | 272 | sh_keysc_write(priv, KYCR2, KYCR2_IRQ_DISABLED); |
795e6bf3 MD |
273 | |
274 | input_unregister_device(priv->input); | |
275 | free_irq(platform_get_irq(pdev, 0), pdev); | |
795e6bf3 MD |
276 | iounmap(priv->iomem_base); |
277 | ||
b6d2a3e6 MD |
278 | pm_runtime_put_sync(&pdev->dev); |
279 | pm_runtime_disable(&pdev->dev); | |
090d951b | 280 | |
795e6bf3 | 281 | kfree(priv); |
795e6bf3 MD |
282 | } |
283 | ||
a29b99ec MD |
284 | static int sh_keysc_suspend(struct device *dev) |
285 | { | |
49976927 MD |
286 | struct platform_device *pdev = to_platform_device(dev); |
287 | struct sh_keysc_priv *priv = platform_get_drvdata(pdev); | |
4ba50df6 | 288 | int irq = platform_get_irq(pdev, 0); |
a29b99ec MD |
289 | unsigned short value; |
290 | ||
2b14a808 | 291 | value = sh_keysc_read(priv, KYCR1); |
795e6bf3 | 292 | |
4ba50df6 | 293 | if (device_may_wakeup(dev)) { |
b6d2a3e6 | 294 | sh_keysc_write(priv, KYCR1, value | 0x80); |
4ba50df6 | 295 | enable_irq_wake(irq); |
24d01c06 | 296 | } else { |
b6d2a3e6 MD |
297 | sh_keysc_write(priv, KYCR1, value & ~0x80); |
298 | pm_runtime_put_sync(dev); | |
24d01c06 | 299 | } |
a29b99ec | 300 | |
a29b99ec MD |
301 | return 0; |
302 | } | |
303 | ||
4ba50df6 MD |
304 | static int sh_keysc_resume(struct device *dev) |
305 | { | |
306 | struct platform_device *pdev = to_platform_device(dev); | |
307 | int irq = platform_get_irq(pdev, 0); | |
308 | ||
309 | if (device_may_wakeup(dev)) | |
310 | disable_irq_wake(irq); | |
b6d2a3e6 MD |
311 | else |
312 | pm_runtime_get_sync(dev); | |
4ba50df6 MD |
313 | |
314 | return 0; | |
315 | } | |
316 | ||
aebc2380 JC |
317 | static DEFINE_SIMPLE_DEV_PM_OPS(sh_keysc_dev_pm_ops, |
318 | sh_keysc_suspend, sh_keysc_resume); | |
795e6bf3 | 319 | |
12d0cef7 | 320 | static struct platform_driver sh_keysc_device_driver = { |
795e6bf3 | 321 | .probe = sh_keysc_probe, |
2c19d015 | 322 | .remove = sh_keysc_remove, |
795e6bf3 MD |
323 | .driver = { |
324 | .name = "sh_keysc", | |
aebc2380 | 325 | .pm = pm_sleep_ptr(&sh_keysc_dev_pm_ops), |
795e6bf3 MD |
326 | } |
327 | }; | |
5146c84f | 328 | module_platform_driver(sh_keysc_device_driver); |
795e6bf3 MD |
329 | |
330 | MODULE_AUTHOR("Magnus Damm"); | |
331 | MODULE_DESCRIPTION("SuperH KEYSC Keypad Driver"); | |
332 | MODULE_LICENSE("GPL"); |