ep93xx_keypad.c 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Driver for the Cirrus EP93xx matrix keypad controller.
  4. *
  5. * Copyright (c) 2008 H Hartley Sweeten <hsweeten@visionengravers.com>
  6. *
  7. * Based on the pxa27x matrix keypad controller by Rodolfo Giometti.
  8. *
  9. * NOTE:
  10. *
  11. * The 3-key reset is triggered by pressing the 3 keys in
  12. * Row 0, Columns 2, 4, and 7 at the same time. This action can
  13. * be disabled by setting the EP93XX_KEYPAD_DISABLE_3_KEY flag.
  14. *
  15. * Normal operation for the matrix does not autorepeat the key press.
  16. * This action can be enabled by setting the EP93XX_KEYPAD_AUTOREPEAT
  17. * flag.
  18. */
  19. #include <linux/module.h>
  20. #include <linux/platform_device.h>
  21. #include <linux/interrupt.h>
  22. #include <linux/clk.h>
  23. #include <linux/io.h>
  24. #include <linux/input/matrix_keypad.h>
  25. #include <linux/slab.h>
  26. #include <linux/soc/cirrus/ep93xx.h>
  27. #include <linux/platform_data/keypad-ep93xx.h>
  28. /*
  29. * Keypad Interface Register offsets
  30. */
  31. #define KEY_INIT 0x00 /* Key Scan Initialization register */
  32. #define KEY_DIAG 0x04 /* Key Scan Diagnostic register */
  33. #define KEY_REG 0x08 /* Key Value Capture register */
  34. /* Key Scan Initialization Register bit defines */
  35. #define KEY_INIT_DBNC_MASK (0x00ff0000)
  36. #define KEY_INIT_DBNC_SHIFT (16)
  37. #define KEY_INIT_DIS3KY (1<<15)
  38. #define KEY_INIT_DIAG (1<<14)
  39. #define KEY_INIT_BACK (1<<13)
  40. #define KEY_INIT_T2 (1<<12)
  41. #define KEY_INIT_PRSCL_MASK (0x000003ff)
  42. #define KEY_INIT_PRSCL_SHIFT (0)
  43. /* Key Scan Diagnostic Register bit defines */
  44. #define KEY_DIAG_MASK (0x0000003f)
  45. #define KEY_DIAG_SHIFT (0)
  46. /* Key Value Capture Register bit defines */
  47. #define KEY_REG_K (1<<15)
  48. #define KEY_REG_INT (1<<14)
  49. #define KEY_REG_2KEYS (1<<13)
  50. #define KEY_REG_1KEY (1<<12)
  51. #define KEY_REG_KEY2_MASK (0x00000fc0)
  52. #define KEY_REG_KEY2_SHIFT (6)
  53. #define KEY_REG_KEY1_MASK (0x0000003f)
  54. #define KEY_REG_KEY1_SHIFT (0)
  55. #define EP93XX_MATRIX_SIZE (EP93XX_MATRIX_ROWS * EP93XX_MATRIX_COLS)
  56. struct ep93xx_keypad {
  57. struct ep93xx_keypad_platform_data *pdata;
  58. struct input_dev *input_dev;
  59. struct clk *clk;
  60. void __iomem *mmio_base;
  61. unsigned short keycodes[EP93XX_MATRIX_SIZE];
  62. int key1;
  63. int key2;
  64. int irq;
  65. bool enabled;
  66. };
  67. static irqreturn_t ep93xx_keypad_irq_handler(int irq, void *dev_id)
  68. {
  69. struct ep93xx_keypad *keypad = dev_id;
  70. struct input_dev *input_dev = keypad->input_dev;
  71. unsigned int status;
  72. int keycode, key1, key2;
  73. status = __raw_readl(keypad->mmio_base + KEY_REG);
  74. keycode = (status & KEY_REG_KEY1_MASK) >> KEY_REG_KEY1_SHIFT;
  75. key1 = keypad->keycodes[keycode];
  76. keycode = (status & KEY_REG_KEY2_MASK) >> KEY_REG_KEY2_SHIFT;
  77. key2 = keypad->keycodes[keycode];
  78. if (status & KEY_REG_2KEYS) {
  79. if (keypad->key1 && key1 != keypad->key1 && key2 != keypad->key1)
  80. input_report_key(input_dev, keypad->key1, 0);
  81. if (keypad->key2 && key1 != keypad->key2 && key2 != keypad->key2)
  82. input_report_key(input_dev, keypad->key2, 0);
  83. input_report_key(input_dev, key1, 1);
  84. input_report_key(input_dev, key2, 1);
  85. keypad->key1 = key1;
  86. keypad->key2 = key2;
  87. } else if (status & KEY_REG_1KEY) {
  88. if (keypad->key1 && key1 != keypad->key1)
  89. input_report_key(input_dev, keypad->key1, 0);
  90. if (keypad->key2 && key1 != keypad->key2)
  91. input_report_key(input_dev, keypad->key2, 0);
  92. input_report_key(input_dev, key1, 1);
  93. keypad->key1 = key1;
  94. keypad->key2 = 0;
  95. } else {
  96. input_report_key(input_dev, keypad->key1, 0);
  97. input_report_key(input_dev, keypad->key2, 0);
  98. keypad->key1 = keypad->key2 = 0;
  99. }
  100. input_sync(input_dev);
  101. return IRQ_HANDLED;
  102. }
  103. static void ep93xx_keypad_config(struct ep93xx_keypad *keypad)
  104. {
  105. struct ep93xx_keypad_platform_data *pdata = keypad->pdata;
  106. unsigned int val = 0;
  107. clk_set_rate(keypad->clk, pdata->clk_rate);
  108. if (pdata->flags & EP93XX_KEYPAD_DISABLE_3_KEY)
  109. val |= KEY_INIT_DIS3KY;
  110. if (pdata->flags & EP93XX_KEYPAD_DIAG_MODE)
  111. val |= KEY_INIT_DIAG;
  112. if (pdata->flags & EP93XX_KEYPAD_BACK_DRIVE)
  113. val |= KEY_INIT_BACK;
  114. if (pdata->flags & EP93XX_KEYPAD_TEST_MODE)
  115. val |= KEY_INIT_T2;
  116. val |= ((pdata->debounce << KEY_INIT_DBNC_SHIFT) & KEY_INIT_DBNC_MASK);
  117. val |= ((pdata->prescale << KEY_INIT_PRSCL_SHIFT) & KEY_INIT_PRSCL_MASK);
  118. __raw_writel(val, keypad->mmio_base + KEY_INIT);
  119. }
  120. static int ep93xx_keypad_open(struct input_dev *pdev)
  121. {
  122. struct ep93xx_keypad *keypad = input_get_drvdata(pdev);
  123. if (!keypad->enabled) {
  124. ep93xx_keypad_config(keypad);
  125. clk_enable(keypad->clk);
  126. keypad->enabled = true;
  127. }
  128. return 0;
  129. }
  130. static void ep93xx_keypad_close(struct input_dev *pdev)
  131. {
  132. struct ep93xx_keypad *keypad = input_get_drvdata(pdev);
  133. if (keypad->enabled) {
  134. clk_disable(keypad->clk);
  135. keypad->enabled = false;
  136. }
  137. }
  138. #ifdef CONFIG_PM_SLEEP
  139. static int ep93xx_keypad_suspend(struct device *dev)
  140. {
  141. struct platform_device *pdev = to_platform_device(dev);
  142. struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
  143. struct input_dev *input_dev = keypad->input_dev;
  144. mutex_lock(&input_dev->mutex);
  145. if (keypad->enabled) {
  146. clk_disable(keypad->clk);
  147. keypad->enabled = false;
  148. }
  149. mutex_unlock(&input_dev->mutex);
  150. if (device_may_wakeup(&pdev->dev))
  151. enable_irq_wake(keypad->irq);
  152. return 0;
  153. }
  154. static int ep93xx_keypad_resume(struct device *dev)
  155. {
  156. struct platform_device *pdev = to_platform_device(dev);
  157. struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
  158. struct input_dev *input_dev = keypad->input_dev;
  159. if (device_may_wakeup(&pdev->dev))
  160. disable_irq_wake(keypad->irq);
  161. mutex_lock(&input_dev->mutex);
  162. if (input_dev->users) {
  163. if (!keypad->enabled) {
  164. ep93xx_keypad_config(keypad);
  165. clk_enable(keypad->clk);
  166. keypad->enabled = true;
  167. }
  168. }
  169. mutex_unlock(&input_dev->mutex);
  170. return 0;
  171. }
  172. #endif
  173. static SIMPLE_DEV_PM_OPS(ep93xx_keypad_pm_ops,
  174. ep93xx_keypad_suspend, ep93xx_keypad_resume);
  175. static int ep93xx_keypad_probe(struct platform_device *pdev)
  176. {
  177. struct ep93xx_keypad *keypad;
  178. const struct matrix_keymap_data *keymap_data;
  179. struct input_dev *input_dev;
  180. struct resource *res;
  181. int err;
  182. keypad = kzalloc(sizeof(struct ep93xx_keypad), GFP_KERNEL);
  183. if (!keypad)
  184. return -ENOMEM;
  185. keypad->pdata = dev_get_platdata(&pdev->dev);
  186. if (!keypad->pdata) {
  187. err = -EINVAL;
  188. goto failed_free;
  189. }
  190. keymap_data = keypad->pdata->keymap_data;
  191. if (!keymap_data) {
  192. err = -EINVAL;
  193. goto failed_free;
  194. }
  195. keypad->irq = platform_get_irq(pdev, 0);
  196. if (keypad->irq < 0) {
  197. err = keypad->irq;
  198. goto failed_free;
  199. }
  200. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  201. if (!res) {
  202. err = -ENXIO;
  203. goto failed_free;
  204. }
  205. res = request_mem_region(res->start, resource_size(res), pdev->name);
  206. if (!res) {
  207. err = -EBUSY;
  208. goto failed_free;
  209. }
  210. keypad->mmio_base = ioremap(res->start, resource_size(res));
  211. if (keypad->mmio_base == NULL) {
  212. err = -ENXIO;
  213. goto failed_free_mem;
  214. }
  215. err = ep93xx_keypad_acquire_gpio(pdev);
  216. if (err)
  217. goto failed_free_io;
  218. keypad->clk = clk_get(&pdev->dev, NULL);
  219. if (IS_ERR(keypad->clk)) {
  220. err = PTR_ERR(keypad->clk);
  221. goto failed_free_gpio;
  222. }
  223. input_dev = input_allocate_device();
  224. if (!input_dev) {
  225. err = -ENOMEM;
  226. goto failed_put_clk;
  227. }
  228. keypad->input_dev = input_dev;
  229. input_dev->name = pdev->name;
  230. input_dev->id.bustype = BUS_HOST;
  231. input_dev->open = ep93xx_keypad_open;
  232. input_dev->close = ep93xx_keypad_close;
  233. input_dev->dev.parent = &pdev->dev;
  234. err = matrix_keypad_build_keymap(keymap_data, NULL,
  235. EP93XX_MATRIX_ROWS, EP93XX_MATRIX_COLS,
  236. keypad->keycodes, input_dev);
  237. if (err)
  238. goto failed_free_dev;
  239. if (keypad->pdata->flags & EP93XX_KEYPAD_AUTOREPEAT)
  240. __set_bit(EV_REP, input_dev->evbit);
  241. input_set_drvdata(input_dev, keypad);
  242. err = request_irq(keypad->irq, ep93xx_keypad_irq_handler,
  243. 0, pdev->name, keypad);
  244. if (err)
  245. goto failed_free_dev;
  246. err = input_register_device(input_dev);
  247. if (err)
  248. goto failed_free_irq;
  249. platform_set_drvdata(pdev, keypad);
  250. device_init_wakeup(&pdev->dev, 1);
  251. return 0;
  252. failed_free_irq:
  253. free_irq(keypad->irq, keypad);
  254. failed_free_dev:
  255. input_free_device(input_dev);
  256. failed_put_clk:
  257. clk_put(keypad->clk);
  258. failed_free_gpio:
  259. ep93xx_keypad_release_gpio(pdev);
  260. failed_free_io:
  261. iounmap(keypad->mmio_base);
  262. failed_free_mem:
  263. release_mem_region(res->start, resource_size(res));
  264. failed_free:
  265. kfree(keypad);
  266. return err;
  267. }
  268. static int ep93xx_keypad_remove(struct platform_device *pdev)
  269. {
  270. struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
  271. struct resource *res;
  272. free_irq(keypad->irq, keypad);
  273. if (keypad->enabled)
  274. clk_disable(keypad->clk);
  275. clk_put(keypad->clk);
  276. input_unregister_device(keypad->input_dev);
  277. ep93xx_keypad_release_gpio(pdev);
  278. iounmap(keypad->mmio_base);
  279. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  280. release_mem_region(res->start, resource_size(res));
  281. kfree(keypad);
  282. return 0;
  283. }
  284. static struct platform_driver ep93xx_keypad_driver = {
  285. .driver = {
  286. .name = "ep93xx-keypad",
  287. .pm = &ep93xx_keypad_pm_ops,
  288. },
  289. .probe = ep93xx_keypad_probe,
  290. .remove = ep93xx_keypad_remove,
  291. };
  292. module_platform_driver(ep93xx_keypad_driver);
  293. MODULE_LICENSE("GPL");
  294. MODULE_AUTHOR("H Hartley Sweeten <hsweeten@visionengravers.com>");
  295. MODULE_DESCRIPTION("EP93xx Matrix Keypad Controller");
  296. MODULE_ALIAS("platform:ep93xx-keypad");