Loading...
1/*
2 * SPEAr Keyboard Driver
3 * Based on omap-keypad driver
4 *
5 * Copyright (C) 2010 ST Microelectronics
6 * Rajeev Kumar <rajeevkumar.linux@gmail.com>
7 *
8 * This file is licensed under the terms of the GNU General Public
9 * License version 2. This program is licensed "as is" without any
10 * warranty of any kind, whether express or implied.
11 */
12
13#include <linux/clk.h>
14#include <linux/errno.h>
15#include <linux/interrupt.h>
16#include <linux/input.h>
17#include <linux/io.h>
18#include <linux/irq.h>
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/of.h>
22#include <linux/platform_device.h>
23#include <linux/slab.h>
24#include <linux/types.h>
25#include <linux/platform_data/keyboard-spear.h>
26
27/* Keyboard Registers */
28#define MODE_CTL_REG 0x00
29#define STATUS_REG 0x0C
30#define DATA_REG 0x10
31#define INTR_MASK 0x54
32
33/* Register Values */
34#define NUM_ROWS 16
35#define NUM_COLS 16
36#define MODE_CTL_PCLK_FREQ_SHIFT 9
37#define MODE_CTL_PCLK_FREQ_MSK 0x7F
38
39#define MODE_CTL_KEYBOARD (0x2 << 0)
40#define MODE_CTL_SCAN_RATE_10 (0x0 << 2)
41#define MODE_CTL_SCAN_RATE_20 (0x1 << 2)
42#define MODE_CTL_SCAN_RATE_40 (0x2 << 2)
43#define MODE_CTL_SCAN_RATE_80 (0x3 << 2)
44#define MODE_CTL_KEYNUM_SHIFT 6
45#define MODE_CTL_START_SCAN (0x1 << 8)
46
47#define STATUS_DATA_AVAIL (0x1 << 1)
48
49#define DATA_ROW_MASK 0xF0
50#define DATA_COLUMN_MASK 0x0F
51
52#define ROW_SHIFT 4
53
54struct spear_kbd {
55 struct input_dev *input;
56 void __iomem *io_base;
57 struct clk *clk;
58 unsigned int irq;
59 unsigned int mode;
60 unsigned int suspended_rate;
61 unsigned short last_key;
62 unsigned short keycodes[NUM_ROWS * NUM_COLS];
63 bool rep;
64 bool irq_wake_enabled;
65 u32 mode_ctl_reg;
66};
67
68static irqreturn_t spear_kbd_interrupt(int irq, void *dev_id)
69{
70 struct spear_kbd *kbd = dev_id;
71 struct input_dev *input = kbd->input;
72 unsigned int key;
73 u32 sts, val;
74
75 sts = readl_relaxed(kbd->io_base + STATUS_REG);
76 if (!(sts & STATUS_DATA_AVAIL))
77 return IRQ_NONE;
78
79 if (kbd->last_key != KEY_RESERVED) {
80 input_report_key(input, kbd->last_key, 0);
81 kbd->last_key = KEY_RESERVED;
82 }
83
84 /* following reads active (row, col) pair */
85 val = readl_relaxed(kbd->io_base + DATA_REG) &
86 (DATA_ROW_MASK | DATA_COLUMN_MASK);
87 key = kbd->keycodes[val];
88
89 input_event(input, EV_MSC, MSC_SCAN, val);
90 input_report_key(input, key, 1);
91 input_sync(input);
92
93 kbd->last_key = key;
94
95 /* clear interrupt */
96 writel_relaxed(0, kbd->io_base + STATUS_REG);
97
98 return IRQ_HANDLED;
99}
100
101static int spear_kbd_open(struct input_dev *dev)
102{
103 struct spear_kbd *kbd = input_get_drvdata(dev);
104 int error;
105 u32 val;
106
107 kbd->last_key = KEY_RESERVED;
108
109 error = clk_enable(kbd->clk);
110 if (error)
111 return error;
112
113 /* keyboard rate to be programmed is input clock (in MHz) - 1 */
114 val = clk_get_rate(kbd->clk) / 1000000 - 1;
115 val = (val & MODE_CTL_PCLK_FREQ_MSK) << MODE_CTL_PCLK_FREQ_SHIFT;
116
117 /* program keyboard */
118 val = MODE_CTL_SCAN_RATE_80 | MODE_CTL_KEYBOARD | val |
119 (kbd->mode << MODE_CTL_KEYNUM_SHIFT);
120 writel_relaxed(val, kbd->io_base + MODE_CTL_REG);
121 writel_relaxed(1, kbd->io_base + STATUS_REG);
122
123 /* start key scan */
124 val = readl_relaxed(kbd->io_base + MODE_CTL_REG);
125 val |= MODE_CTL_START_SCAN;
126 writel_relaxed(val, kbd->io_base + MODE_CTL_REG);
127
128 return 0;
129}
130
131static void spear_kbd_close(struct input_dev *dev)
132{
133 struct spear_kbd *kbd = input_get_drvdata(dev);
134 u32 val;
135
136 /* stop key scan */
137 val = readl_relaxed(kbd->io_base + MODE_CTL_REG);
138 val &= ~MODE_CTL_START_SCAN;
139 writel_relaxed(val, kbd->io_base + MODE_CTL_REG);
140
141 clk_disable(kbd->clk);
142
143 kbd->last_key = KEY_RESERVED;
144}
145
146#ifdef CONFIG_OF
147static int spear_kbd_parse_dt(struct platform_device *pdev,
148 struct spear_kbd *kbd)
149{
150 struct device_node *np = pdev->dev.of_node;
151 int error;
152 u32 val, suspended_rate;
153
154 if (!np) {
155 dev_err(&pdev->dev, "Missing DT data\n");
156 return -EINVAL;
157 }
158
159 if (of_property_read_bool(np, "autorepeat"))
160 kbd->rep = true;
161
162 if (of_property_read_u32(np, "suspended_rate", &suspended_rate))
163 kbd->suspended_rate = suspended_rate;
164
165 error = of_property_read_u32(np, "st,mode", &val);
166 if (error) {
167 dev_err(&pdev->dev, "DT: Invalid or missing mode\n");
168 return error;
169 }
170
171 kbd->mode = val;
172 return 0;
173}
174#else
175static inline int spear_kbd_parse_dt(struct platform_device *pdev,
176 struct spear_kbd *kbd)
177{
178 return -ENOSYS;
179}
180#endif
181
182static int spear_kbd_probe(struct platform_device *pdev)
183{
184 struct kbd_platform_data *pdata = dev_get_platdata(&pdev->dev);
185 const struct matrix_keymap_data *keymap = pdata ? pdata->keymap : NULL;
186 struct spear_kbd *kbd;
187 struct input_dev *input_dev;
188 int irq;
189 int error;
190
191 irq = platform_get_irq(pdev, 0);
192 if (irq < 0)
193 return irq;
194
195 kbd = devm_kzalloc(&pdev->dev, sizeof(*kbd), GFP_KERNEL);
196 if (!kbd) {
197 dev_err(&pdev->dev, "not enough memory for driver data\n");
198 return -ENOMEM;
199 }
200
201 input_dev = devm_input_allocate_device(&pdev->dev);
202 if (!input_dev) {
203 dev_err(&pdev->dev, "unable to allocate input device\n");
204 return -ENOMEM;
205 }
206
207 kbd->input = input_dev;
208 kbd->irq = irq;
209
210 if (!pdata) {
211 error = spear_kbd_parse_dt(pdev, kbd);
212 if (error)
213 return error;
214 } else {
215 kbd->mode = pdata->mode;
216 kbd->rep = pdata->rep;
217 kbd->suspended_rate = pdata->suspended_rate;
218 }
219
220 kbd->io_base = devm_platform_get_and_ioremap_resource(pdev, 0, NULL);
221 if (IS_ERR(kbd->io_base))
222 return PTR_ERR(kbd->io_base);
223
224 kbd->clk = devm_clk_get_prepared(&pdev->dev, NULL);
225 if (IS_ERR(kbd->clk))
226 return PTR_ERR(kbd->clk);
227
228 input_dev->name = "Spear Keyboard";
229 input_dev->phys = "keyboard/input0";
230 input_dev->id.bustype = BUS_HOST;
231 input_dev->id.vendor = 0x0001;
232 input_dev->id.product = 0x0001;
233 input_dev->id.version = 0x0100;
234 input_dev->open = spear_kbd_open;
235 input_dev->close = spear_kbd_close;
236
237 error = matrix_keypad_build_keymap(keymap, NULL, NUM_ROWS, NUM_COLS,
238 kbd->keycodes, input_dev);
239 if (error) {
240 dev_err(&pdev->dev, "Failed to build keymap\n");
241 return error;
242 }
243
244 if (kbd->rep)
245 __set_bit(EV_REP, input_dev->evbit);
246 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
247
248 input_set_drvdata(input_dev, kbd);
249
250 error = devm_request_irq(&pdev->dev, irq, spear_kbd_interrupt, 0,
251 "keyboard", kbd);
252 if (error) {
253 dev_err(&pdev->dev, "request_irq failed\n");
254 return error;
255 }
256
257 error = input_register_device(input_dev);
258 if (error) {
259 dev_err(&pdev->dev, "Unable to register keyboard device\n");
260 return error;
261 }
262
263 device_init_wakeup(&pdev->dev, 1);
264 platform_set_drvdata(pdev, kbd);
265
266 return 0;
267}
268
269static int spear_kbd_suspend(struct device *dev)
270{
271 struct platform_device *pdev = to_platform_device(dev);
272 struct spear_kbd *kbd = platform_get_drvdata(pdev);
273 struct input_dev *input_dev = kbd->input;
274 unsigned int rate = 0, mode_ctl_reg, val;
275
276 guard(mutex)(&input_dev->mutex);
277
278 /* explicitly enable clock as we may program device */
279 clk_enable(kbd->clk);
280
281 mode_ctl_reg = readl_relaxed(kbd->io_base + MODE_CTL_REG);
282
283 if (device_may_wakeup(&pdev->dev)) {
284 if (!enable_irq_wake(kbd->irq))
285 kbd->irq_wake_enabled = true;
286
287 /*
288 * reprogram the keyboard operating frequency as on some
289 * platform it may change during system suspended
290 */
291 if (kbd->suspended_rate)
292 rate = kbd->suspended_rate / 1000000 - 1;
293 else
294 rate = clk_get_rate(kbd->clk) / 1000000 - 1;
295
296 val = mode_ctl_reg &
297 ~(MODE_CTL_PCLK_FREQ_MSK << MODE_CTL_PCLK_FREQ_SHIFT);
298 val |= (rate & MODE_CTL_PCLK_FREQ_MSK)
299 << MODE_CTL_PCLK_FREQ_SHIFT;
300 writel_relaxed(val, kbd->io_base + MODE_CTL_REG);
301
302 } else {
303 if (input_device_enabled(input_dev)) {
304 writel_relaxed(mode_ctl_reg & ~MODE_CTL_START_SCAN,
305 kbd->io_base + MODE_CTL_REG);
306 clk_disable(kbd->clk);
307 }
308 }
309
310 /* store current configuration */
311 if (input_device_enabled(input_dev))
312 kbd->mode_ctl_reg = mode_ctl_reg;
313
314 /* restore previous clk state */
315 clk_disable(kbd->clk);
316
317 return 0;
318}
319
320static int spear_kbd_resume(struct device *dev)
321{
322 struct platform_device *pdev = to_platform_device(dev);
323 struct spear_kbd *kbd = platform_get_drvdata(pdev);
324 struct input_dev *input_dev = kbd->input;
325
326 guard(mutex)(&input_dev->mutex);
327
328 if (device_may_wakeup(&pdev->dev)) {
329 if (kbd->irq_wake_enabled) {
330 kbd->irq_wake_enabled = false;
331 disable_irq_wake(kbd->irq);
332 }
333 } else {
334 if (input_device_enabled(input_dev))
335 clk_enable(kbd->clk);
336 }
337
338 /* restore current configuration */
339 if (input_device_enabled(input_dev))
340 writel_relaxed(kbd->mode_ctl_reg, kbd->io_base + MODE_CTL_REG);
341
342 return 0;
343}
344
345static DEFINE_SIMPLE_DEV_PM_OPS(spear_kbd_pm_ops,
346 spear_kbd_suspend, spear_kbd_resume);
347
348#ifdef CONFIG_OF
349static const struct of_device_id spear_kbd_id_table[] = {
350 { .compatible = "st,spear300-kbd" },
351 {}
352};
353MODULE_DEVICE_TABLE(of, spear_kbd_id_table);
354#endif
355
356static struct platform_driver spear_kbd_driver = {
357 .probe = spear_kbd_probe,
358 .driver = {
359 .name = "keyboard",
360 .pm = pm_sleep_ptr(&spear_kbd_pm_ops),
361 .of_match_table = of_match_ptr(spear_kbd_id_table),
362 },
363};
364module_platform_driver(spear_kbd_driver);
365
366MODULE_AUTHOR("Rajeev Kumar");
367MODULE_DESCRIPTION("SPEAr Keyboard Driver");
368MODULE_LICENSE("GPL");
1/*
2 * SPEAr Keyboard Driver
3 * Based on omap-keypad driver
4 *
5 * Copyright (C) 2010 ST Microelectronics
6 * Rajeev Kumar<rajeev-dlh.kumar@st.com>
7 *
8 * This file is licensed under the terms of the GNU General Public
9 * License version 2. This program is licensed "as is" without any
10 * warranty of any kind, whether express or implied.
11 */
12
13#include <linux/clk.h>
14#include <linux/errno.h>
15#include <linux/init.h>
16#include <linux/interrupt.h>
17#include <linux/input.h>
18#include <linux/io.h>
19#include <linux/irq.h>
20#include <linux/kernel.h>
21#include <linux/module.h>
22#include <linux/platform_device.h>
23#include <linux/pm_wakeup.h>
24#include <linux/slab.h>
25#include <linux/types.h>
26#include <plat/keyboard.h>
27
28/* Keyboard Registers */
29#define MODE_REG 0x00 /* 16 bit reg */
30#define STATUS_REG 0x0C /* 2 bit reg */
31#define DATA_REG 0x10 /* 8 bit reg */
32#define INTR_MASK 0x54
33
34/* Register Values */
35/*
36 * pclk freq mask = (APB FEQ -1)= 82 MHZ.Programme bit 15-9 in mode
37 * control register as 1010010(82MHZ)
38 */
39#define PCLK_FREQ_MSK 0xA400 /* 82 MHz */
40#define START_SCAN 0x0100
41#define SCAN_RATE_10 0x0000
42#define SCAN_RATE_20 0x0004
43#define SCAN_RATE_40 0x0008
44#define SCAN_RATE_80 0x000C
45#define MODE_KEYBOARD 0x0002
46#define DATA_AVAIL 0x2
47
48#define KEY_MASK 0xFF000000
49#define KEY_VALUE 0x00FFFFFF
50#define ROW_MASK 0xF0
51#define COLUMN_MASK 0x0F
52#define ROW_SHIFT 4
53
54struct spear_kbd {
55 struct input_dev *input;
56 struct resource *res;
57 void __iomem *io_base;
58 struct clk *clk;
59 unsigned int irq;
60 unsigned short last_key;
61 unsigned short keycodes[256];
62};
63
64static irqreturn_t spear_kbd_interrupt(int irq, void *dev_id)
65{
66 struct spear_kbd *kbd = dev_id;
67 struct input_dev *input = kbd->input;
68 unsigned int key;
69 u8 sts, val;
70
71 sts = readb(kbd->io_base + STATUS_REG);
72 if (!(sts & DATA_AVAIL))
73 return IRQ_NONE;
74
75 if (kbd->last_key != KEY_RESERVED) {
76 input_report_key(input, kbd->last_key, 0);
77 kbd->last_key = KEY_RESERVED;
78 }
79
80 /* following reads active (row, col) pair */
81 val = readb(kbd->io_base + DATA_REG);
82 key = kbd->keycodes[val];
83
84 input_event(input, EV_MSC, MSC_SCAN, val);
85 input_report_key(input, key, 1);
86 input_sync(input);
87
88 kbd->last_key = key;
89
90 /* clear interrupt */
91 writeb(0, kbd->io_base + STATUS_REG);
92
93 return IRQ_HANDLED;
94}
95
96static int spear_kbd_open(struct input_dev *dev)
97{
98 struct spear_kbd *kbd = input_get_drvdata(dev);
99 int error;
100 u16 val;
101
102 kbd->last_key = KEY_RESERVED;
103
104 error = clk_enable(kbd->clk);
105 if (error)
106 return error;
107
108 /* program keyboard */
109 val = SCAN_RATE_80 | MODE_KEYBOARD | PCLK_FREQ_MSK;
110 writew(val, kbd->io_base + MODE_REG);
111 writeb(1, kbd->io_base + STATUS_REG);
112
113 /* start key scan */
114 val = readw(kbd->io_base + MODE_REG);
115 val |= START_SCAN;
116 writew(val, kbd->io_base + MODE_REG);
117
118 return 0;
119}
120
121static void spear_kbd_close(struct input_dev *dev)
122{
123 struct spear_kbd *kbd = input_get_drvdata(dev);
124 u16 val;
125
126 /* stop key scan */
127 val = readw(kbd->io_base + MODE_REG);
128 val &= ~START_SCAN;
129 writew(val, kbd->io_base + MODE_REG);
130
131 clk_disable(kbd->clk);
132
133 kbd->last_key = KEY_RESERVED;
134}
135
136static int __devinit spear_kbd_probe(struct platform_device *pdev)
137{
138 const struct kbd_platform_data *pdata = pdev->dev.platform_data;
139 const struct matrix_keymap_data *keymap;
140 struct spear_kbd *kbd;
141 struct input_dev *input_dev;
142 struct resource *res;
143 int irq;
144 int error;
145
146 if (!pdata) {
147 dev_err(&pdev->dev, "Invalid platform data\n");
148 return -EINVAL;
149 }
150
151 keymap = pdata->keymap;
152 if (!keymap) {
153 dev_err(&pdev->dev, "no keymap defined\n");
154 return -EINVAL;
155 }
156
157 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
158 if (!res) {
159 dev_err(&pdev->dev, "no keyboard resource defined\n");
160 return -EBUSY;
161 }
162
163 irq = platform_get_irq(pdev, 0);
164 if (irq < 0) {
165 dev_err(&pdev->dev, "not able to get irq for the device\n");
166 return irq;
167 }
168
169 kbd = kzalloc(sizeof(*kbd), GFP_KERNEL);
170 input_dev = input_allocate_device();
171 if (!kbd || !input_dev) {
172 dev_err(&pdev->dev, "out of memory\n");
173 error = -ENOMEM;
174 goto err_free_mem;
175 }
176
177 kbd->input = input_dev;
178 kbd->irq = irq;
179 kbd->res = request_mem_region(res->start, resource_size(res),
180 pdev->name);
181 if (!kbd->res) {
182 dev_err(&pdev->dev, "keyboard region already claimed\n");
183 error = -EBUSY;
184 goto err_free_mem;
185 }
186
187 kbd->io_base = ioremap(res->start, resource_size(res));
188 if (!kbd->io_base) {
189 dev_err(&pdev->dev, "ioremap failed for kbd_region\n");
190 error = -ENOMEM;
191 goto err_release_mem_region;
192 }
193
194 kbd->clk = clk_get(&pdev->dev, NULL);
195 if (IS_ERR(kbd->clk)) {
196 error = PTR_ERR(kbd->clk);
197 goto err_iounmap;
198 }
199
200 input_dev->name = "Spear Keyboard";
201 input_dev->phys = "keyboard/input0";
202 input_dev->dev.parent = &pdev->dev;
203 input_dev->id.bustype = BUS_HOST;
204 input_dev->id.vendor = 0x0001;
205 input_dev->id.product = 0x0001;
206 input_dev->id.version = 0x0100;
207 input_dev->open = spear_kbd_open;
208 input_dev->close = spear_kbd_close;
209
210 __set_bit(EV_KEY, input_dev->evbit);
211 if (pdata->rep)
212 __set_bit(EV_REP, input_dev->evbit);
213 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
214
215 input_dev->keycode = kbd->keycodes;
216 input_dev->keycodesize = sizeof(kbd->keycodes[0]);
217 input_dev->keycodemax = ARRAY_SIZE(kbd->keycodes);
218
219 matrix_keypad_build_keymap(keymap, ROW_SHIFT,
220 input_dev->keycode, input_dev->keybit);
221
222 input_set_drvdata(input_dev, kbd);
223
224 error = request_irq(irq, spear_kbd_interrupt, 0, "keyboard", kbd);
225 if (error) {
226 dev_err(&pdev->dev, "request_irq fail\n");
227 goto err_put_clk;
228 }
229
230 error = input_register_device(input_dev);
231 if (error) {
232 dev_err(&pdev->dev, "Unable to register keyboard device\n");
233 goto err_free_irq;
234 }
235
236 device_init_wakeup(&pdev->dev, 1);
237 platform_set_drvdata(pdev, kbd);
238
239 return 0;
240
241err_free_irq:
242 free_irq(kbd->irq, kbd);
243err_put_clk:
244 clk_put(kbd->clk);
245err_iounmap:
246 iounmap(kbd->io_base);
247err_release_mem_region:
248 release_mem_region(res->start, resource_size(res));
249err_free_mem:
250 input_free_device(input_dev);
251 kfree(kbd);
252
253 return error;
254}
255
256static int __devexit spear_kbd_remove(struct platform_device *pdev)
257{
258 struct spear_kbd *kbd = platform_get_drvdata(pdev);
259
260 free_irq(kbd->irq, kbd);
261 input_unregister_device(kbd->input);
262 clk_put(kbd->clk);
263 iounmap(kbd->io_base);
264 release_mem_region(kbd->res->start, resource_size(kbd->res));
265 kfree(kbd);
266
267 device_init_wakeup(&pdev->dev, 1);
268 platform_set_drvdata(pdev, NULL);
269
270 return 0;
271}
272
273#ifdef CONFIG_PM
274static int spear_kbd_suspend(struct device *dev)
275{
276 struct platform_device *pdev = to_platform_device(dev);
277 struct spear_kbd *kbd = platform_get_drvdata(pdev);
278 struct input_dev *input_dev = kbd->input;
279
280 mutex_lock(&input_dev->mutex);
281
282 if (input_dev->users)
283 clk_enable(kbd->clk);
284
285 if (device_may_wakeup(&pdev->dev))
286 enable_irq_wake(kbd->irq);
287
288 mutex_unlock(&input_dev->mutex);
289
290 return 0;
291}
292
293static int spear_kbd_resume(struct device *dev)
294{
295 struct platform_device *pdev = to_platform_device(dev);
296 struct spear_kbd *kbd = platform_get_drvdata(pdev);
297 struct input_dev *input_dev = kbd->input;
298
299 mutex_lock(&input_dev->mutex);
300
301 if (device_may_wakeup(&pdev->dev))
302 disable_irq_wake(kbd->irq);
303
304 if (input_dev->users)
305 clk_enable(kbd->clk);
306
307 mutex_unlock(&input_dev->mutex);
308
309 return 0;
310}
311
312static const struct dev_pm_ops spear_kbd_pm_ops = {
313 .suspend = spear_kbd_suspend,
314 .resume = spear_kbd_resume,
315};
316#endif
317
318static struct platform_driver spear_kbd_driver = {
319 .probe = spear_kbd_probe,
320 .remove = __devexit_p(spear_kbd_remove),
321 .driver = {
322 .name = "keyboard",
323 .owner = THIS_MODULE,
324#ifdef CONFIG_PM
325 .pm = &spear_kbd_pm_ops,
326#endif
327 },
328};
329
330static int __init spear_kbd_init(void)
331{
332 return platform_driver_register(&spear_kbd_driver);
333}
334module_init(spear_kbd_init);
335
336static void __exit spear_kbd_exit(void)
337{
338 platform_driver_unregister(&spear_kbd_driver);
339}
340module_exit(spear_kbd_exit);
341
342MODULE_AUTHOR("Rajeev Kumar");
343MODULE_DESCRIPTION("SPEAr Keyboard Driver");
344MODULE_LICENSE("GPL");