nomadik-ske-keypad.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright (C) ST-Ericsson SA 2010
  4. *
  5. * Author: Naveen Kumar G <naveen.gaddipati@stericsson.com> for ST-Ericsson
  6. * Author: Sundar Iyer <sundar.iyer@stericsson.com> for ST-Ericsson
  7. *
  8. * Keypad controller driver for the SKE (Scroll Key Encoder) module used in
  9. * the Nomadik 8815 and Ux500 platforms.
  10. */
  11. #include <linux/platform_device.h>
  12. #include <linux/interrupt.h>
  13. #include <linux/spinlock.h>
  14. #include <linux/io.h>
  15. #include <linux/delay.h>
  16. #include <linux/input.h>
  17. #include <linux/slab.h>
  18. #include <linux/clk.h>
  19. #include <linux/module.h>
  20. #include <linux/platform_data/keypad-nomadik-ske.h>
  21. /* SKE_CR bits */
  22. #define SKE_KPMLT (0x1 << 6)
  23. #define SKE_KPCN (0x7 << 3)
  24. #define SKE_KPASEN (0x1 << 2)
  25. #define SKE_KPASON (0x1 << 7)
  26. /* SKE_IMSC bits */
  27. #define SKE_KPIMA (0x1 << 2)
  28. /* SKE_ICR bits */
  29. #define SKE_KPICS (0x1 << 3)
  30. #define SKE_KPICA (0x1 << 2)
  31. /* SKE_RIS bits */
  32. #define SKE_KPRISA (0x1 << 2)
  33. #define SKE_KEYPAD_ROW_SHIFT 3
  34. #define SKE_KPD_NUM_ROWS 8
  35. #define SKE_KPD_NUM_COLS 8
  36. /* keypad auto scan registers */
  37. #define SKE_ASR0 0x20
  38. #define SKE_ASR1 0x24
  39. #define SKE_ASR2 0x28
  40. #define SKE_ASR3 0x2C
  41. #define SKE_NUM_ASRX_REGISTERS (4)
  42. #define KEY_PRESSED_DELAY 10
  43. /**
  44. * struct ske_keypad - data structure used by keypad driver
  45. * @irq: irq no
  46. * @reg_base: ske registers base address
  47. * @input: pointer to input device object
  48. * @board: keypad platform device
  49. * @keymap: matrix scan code table for keycodes
  50. * @clk: clock structure pointer
  51. */
  52. struct ske_keypad {
  53. int irq;
  54. void __iomem *reg_base;
  55. struct input_dev *input;
  56. const struct ske_keypad_platform_data *board;
  57. unsigned short keymap[SKE_KPD_NUM_ROWS * SKE_KPD_NUM_COLS];
  58. struct clk *clk;
  59. struct clk *pclk;
  60. spinlock_t ske_keypad_lock;
  61. };
  62. static void ske_keypad_set_bits(struct ske_keypad *keypad, u16 addr,
  63. u8 mask, u8 data)
  64. {
  65. u32 ret;
  66. spin_lock(&keypad->ske_keypad_lock);
  67. ret = readl(keypad->reg_base + addr);
  68. ret &= ~mask;
  69. ret |= data;
  70. writel(ret, keypad->reg_base + addr);
  71. spin_unlock(&keypad->ske_keypad_lock);
  72. }
  73. /*
  74. * ske_keypad_chip_init: init keypad controller configuration
  75. *
  76. * Enable Multi key press detection, auto scan mode
  77. */
  78. static int __init ske_keypad_chip_init(struct ske_keypad *keypad)
  79. {
  80. u32 value;
  81. int timeout = keypad->board->debounce_ms;
  82. /* check SKE_RIS to be 0 */
  83. while ((readl(keypad->reg_base + SKE_RIS) != 0x00000000) && timeout--)
  84. cpu_relax();
  85. if (timeout == -1)
  86. return -EINVAL;
  87. /*
  88. * set debounce value
  89. * keypad dbounce is configured in DBCR[15:8]
  90. * dbounce value in steps of 32/32.768 ms
  91. */
  92. spin_lock(&keypad->ske_keypad_lock);
  93. value = readl(keypad->reg_base + SKE_DBCR);
  94. value = value & 0xff;
  95. value |= ((keypad->board->debounce_ms * 32000)/32768) << 8;
  96. writel(value, keypad->reg_base + SKE_DBCR);
  97. spin_unlock(&keypad->ske_keypad_lock);
  98. /* enable multi key detection */
  99. ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPMLT);
  100. /*
  101. * set up the number of columns
  102. * KPCN[5:3] defines no. of keypad columns to be auto scanned
  103. */
  104. value = (keypad->board->kcol - 1) << 3;
  105. ske_keypad_set_bits(keypad, SKE_CR, SKE_KPCN, value);
  106. /* clear keypad interrupt for auto(and pending SW) scans */
  107. ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA | SKE_KPICS);
  108. /* un-mask keypad interrupts */
  109. ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
  110. /* enable automatic scan */
  111. ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPASEN);
  112. return 0;
  113. }
  114. static void ske_keypad_report(struct ske_keypad *keypad, u8 status, int col)
  115. {
  116. int row = 0, code, pos;
  117. struct input_dev *input = keypad->input;
  118. u32 ske_ris;
  119. int key_pressed;
  120. int num_of_rows;
  121. /* find out the row */
  122. num_of_rows = hweight8(status);
  123. do {
  124. pos = __ffs(status);
  125. row = pos;
  126. status &= ~(1 << pos);
  127. code = MATRIX_SCAN_CODE(row, col, SKE_KEYPAD_ROW_SHIFT);
  128. ske_ris = readl(keypad->reg_base + SKE_RIS);
  129. key_pressed = ske_ris & SKE_KPRISA;
  130. input_event(input, EV_MSC, MSC_SCAN, code);
  131. input_report_key(input, keypad->keymap[code], key_pressed);
  132. input_sync(input);
  133. num_of_rows--;
  134. } while (num_of_rows);
  135. }
  136. static void ske_keypad_read_data(struct ske_keypad *keypad)
  137. {
  138. u8 status;
  139. int col = 0;
  140. int ske_asr, i;
  141. /*
  142. * Read the auto scan registers
  143. *
  144. * Each SKE_ASRx (x=0 to x=3) contains two row values.
  145. * lower byte contains row value for column 2*x,
  146. * upper byte contains row value for column 2*x + 1
  147. */
  148. for (i = 0; i < SKE_NUM_ASRX_REGISTERS; i++) {
  149. ske_asr = readl(keypad->reg_base + SKE_ASR0 + (4 * i));
  150. if (!ske_asr)
  151. continue;
  152. /* now that ASRx is zero, find out the coloumn x and row y */
  153. status = ske_asr & 0xff;
  154. if (status) {
  155. col = i * 2;
  156. ske_keypad_report(keypad, status, col);
  157. }
  158. status = (ske_asr & 0xff00) >> 8;
  159. if (status) {
  160. col = (i * 2) + 1;
  161. ske_keypad_report(keypad, status, col);
  162. }
  163. }
  164. }
  165. static irqreturn_t ske_keypad_irq(int irq, void *dev_id)
  166. {
  167. struct ske_keypad *keypad = dev_id;
  168. int timeout = keypad->board->debounce_ms;
  169. /* disable auto scan interrupt; mask the interrupt generated */
  170. ske_keypad_set_bits(keypad, SKE_IMSC, ~SKE_KPIMA, 0x0);
  171. ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA);
  172. while ((readl(keypad->reg_base + SKE_CR) & SKE_KPASON) && --timeout)
  173. cpu_relax();
  174. /* SKEx registers are stable and can be read */
  175. ske_keypad_read_data(keypad);
  176. /* wait until raw interrupt is clear */
  177. while ((readl(keypad->reg_base + SKE_RIS)) && --timeout)
  178. msleep(KEY_PRESSED_DELAY);
  179. /* enable auto scan interrupts */
  180. ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
  181. return IRQ_HANDLED;
  182. }
  183. static int __init ske_keypad_probe(struct platform_device *pdev)
  184. {
  185. const struct ske_keypad_platform_data *plat =
  186. dev_get_platdata(&pdev->dev);
  187. struct ske_keypad *keypad;
  188. struct input_dev *input;
  189. struct resource *res;
  190. int irq;
  191. int error;
  192. if (!plat) {
  193. dev_err(&pdev->dev, "invalid keypad platform data\n");
  194. return -EINVAL;
  195. }
  196. irq = platform_get_irq(pdev, 0);
  197. if (irq < 0)
  198. return -EINVAL;
  199. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  200. if (!res) {
  201. dev_err(&pdev->dev, "missing platform resources\n");
  202. return -EINVAL;
  203. }
  204. keypad = kzalloc(sizeof(struct ske_keypad), GFP_KERNEL);
  205. input = input_allocate_device();
  206. if (!keypad || !input) {
  207. dev_err(&pdev->dev, "failed to allocate keypad memory\n");
  208. error = -ENOMEM;
  209. goto err_free_mem;
  210. }
  211. keypad->irq = irq;
  212. keypad->board = plat;
  213. keypad->input = input;
  214. spin_lock_init(&keypad->ske_keypad_lock);
  215. if (!request_mem_region(res->start, resource_size(res), pdev->name)) {
  216. dev_err(&pdev->dev, "failed to request I/O memory\n");
  217. error = -EBUSY;
  218. goto err_free_mem;
  219. }
  220. keypad->reg_base = ioremap(res->start, resource_size(res));
  221. if (!keypad->reg_base) {
  222. dev_err(&pdev->dev, "failed to remap I/O memory\n");
  223. error = -ENXIO;
  224. goto err_free_mem_region;
  225. }
  226. keypad->pclk = clk_get(&pdev->dev, "apb_pclk");
  227. if (IS_ERR(keypad->pclk)) {
  228. dev_err(&pdev->dev, "failed to get pclk\n");
  229. error = PTR_ERR(keypad->pclk);
  230. goto err_iounmap;
  231. }
  232. keypad->clk = clk_get(&pdev->dev, NULL);
  233. if (IS_ERR(keypad->clk)) {
  234. dev_err(&pdev->dev, "failed to get clk\n");
  235. error = PTR_ERR(keypad->clk);
  236. goto err_pclk;
  237. }
  238. input->id.bustype = BUS_HOST;
  239. input->name = "ux500-ske-keypad";
  240. input->dev.parent = &pdev->dev;
  241. error = matrix_keypad_build_keymap(plat->keymap_data, NULL,
  242. SKE_KPD_NUM_ROWS, SKE_KPD_NUM_COLS,
  243. keypad->keymap, input);
  244. if (error) {
  245. dev_err(&pdev->dev, "Failed to build keymap\n");
  246. goto err_clk;
  247. }
  248. input_set_capability(input, EV_MSC, MSC_SCAN);
  249. if (!plat->no_autorepeat)
  250. __set_bit(EV_REP, input->evbit);
  251. error = clk_prepare_enable(keypad->pclk);
  252. if (error) {
  253. dev_err(&pdev->dev, "Failed to prepare/enable pclk\n");
  254. goto err_clk;
  255. }
  256. error = clk_prepare_enable(keypad->clk);
  257. if (error) {
  258. dev_err(&pdev->dev, "Failed to prepare/enable clk\n");
  259. goto err_pclk_disable;
  260. }
  261. /* go through board initialization helpers */
  262. if (keypad->board->init)
  263. keypad->board->init();
  264. error = ske_keypad_chip_init(keypad);
  265. if (error) {
  266. dev_err(&pdev->dev, "unable to init keypad hardware\n");
  267. goto err_clk_disable;
  268. }
  269. error = request_threaded_irq(keypad->irq, NULL, ske_keypad_irq,
  270. IRQF_ONESHOT, "ske-keypad", keypad);
  271. if (error) {
  272. dev_err(&pdev->dev, "allocate irq %d failed\n", keypad->irq);
  273. goto err_clk_disable;
  274. }
  275. error = input_register_device(input);
  276. if (error) {
  277. dev_err(&pdev->dev,
  278. "unable to register input device: %d\n", error);
  279. goto err_free_irq;
  280. }
  281. if (plat->wakeup_enable)
  282. device_init_wakeup(&pdev->dev, true);
  283. platform_set_drvdata(pdev, keypad);
  284. return 0;
  285. err_free_irq:
  286. free_irq(keypad->irq, keypad);
  287. err_clk_disable:
  288. clk_disable_unprepare(keypad->clk);
  289. err_pclk_disable:
  290. clk_disable_unprepare(keypad->pclk);
  291. err_clk:
  292. clk_put(keypad->clk);
  293. err_pclk:
  294. clk_put(keypad->pclk);
  295. err_iounmap:
  296. iounmap(keypad->reg_base);
  297. err_free_mem_region:
  298. release_mem_region(res->start, resource_size(res));
  299. err_free_mem:
  300. input_free_device(input);
  301. kfree(keypad);
  302. return error;
  303. }
  304. static int ske_keypad_remove(struct platform_device *pdev)
  305. {
  306. struct ske_keypad *keypad = platform_get_drvdata(pdev);
  307. struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  308. free_irq(keypad->irq, keypad);
  309. input_unregister_device(keypad->input);
  310. clk_disable_unprepare(keypad->clk);
  311. clk_put(keypad->clk);
  312. if (keypad->board->exit)
  313. keypad->board->exit();
  314. iounmap(keypad->reg_base);
  315. release_mem_region(res->start, resource_size(res));
  316. kfree(keypad);
  317. return 0;
  318. }
  319. #ifdef CONFIG_PM_SLEEP
  320. static int ske_keypad_suspend(struct device *dev)
  321. {
  322. struct platform_device *pdev = to_platform_device(dev);
  323. struct ske_keypad *keypad = platform_get_drvdata(pdev);
  324. int irq = platform_get_irq(pdev, 0);
  325. if (device_may_wakeup(dev))
  326. enable_irq_wake(irq);
  327. else
  328. ske_keypad_set_bits(keypad, SKE_IMSC, ~SKE_KPIMA, 0x0);
  329. return 0;
  330. }
  331. static int ske_keypad_resume(struct device *dev)
  332. {
  333. struct platform_device *pdev = to_platform_device(dev);
  334. struct ske_keypad *keypad = platform_get_drvdata(pdev);
  335. int irq = platform_get_irq(pdev, 0);
  336. if (device_may_wakeup(dev))
  337. disable_irq_wake(irq);
  338. else
  339. ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
  340. return 0;
  341. }
  342. #endif
  343. static SIMPLE_DEV_PM_OPS(ske_keypad_dev_pm_ops,
  344. ske_keypad_suspend, ske_keypad_resume);
  345. static struct platform_driver ske_keypad_driver = {
  346. .driver = {
  347. .name = "nmk-ske-keypad",
  348. .pm = &ske_keypad_dev_pm_ops,
  349. },
  350. .remove = ske_keypad_remove,
  351. };
  352. module_platform_driver_probe(ske_keypad_driver, ske_keypad_probe);
  353. MODULE_LICENSE("GPL v2");
  354. MODULE_AUTHOR("Naveen Kumar <naveen.gaddipati@stericsson.com> / Sundar Iyer <sundar.iyer@stericsson.com>");
  355. MODULE_DESCRIPTION("Nomadik Scroll-Key-Encoder Keypad Driver");
  356. MODULE_ALIAS("platform:nomadik-ske-keypad");