corgikbd.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. /*
  2. * Keyboard driver for Sharp Corgi models (SL-C7xx)
  3. *
  4. * Copyright (c) 2004-2005 Richard Purdie
  5. *
  6. * Based on xtkbd.c/locomkbd.c
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License version 2 as
  10. * published by the Free Software Foundation.
  11. *
  12. */
  13. #include <linux/delay.h>
  14. #include <linux/platform_device.h>
  15. #include <linux/init.h>
  16. #include <linux/input.h>
  17. #include <linux/interrupt.h>
  18. #include <linux/jiffies.h>
  19. #include <linux/module.h>
  20. #include <linux/slab.h>
  21. #include <asm/arch/corgi.h>
  22. #include <asm/arch/hardware.h>
  23. #include <asm/arch/pxa-regs.h>
  24. #include <asm/hardware/scoop.h>
  25. #define KB_ROWS 8
  26. #define KB_COLS 12
  27. #define KB_ROWMASK(r) (1 << (r))
  28. #define SCANCODE(r,c) ( ((r)<<4) + (c) + 1 )
  29. /* zero code, 124 scancodes */
  30. #define NR_SCANCODES ( SCANCODE(KB_ROWS-1,KB_COLS-1) +1 +1 )
  31. #define SCAN_INTERVAL (50) /* ms */
  32. #define HINGE_SCAN_INTERVAL (250) /* ms */
  33. #define CORGI_KEY_CALENDER KEY_F1
  34. #define CORGI_KEY_ADDRESS KEY_F2
  35. #define CORGI_KEY_FN KEY_F3
  36. #define CORGI_KEY_CANCEL KEY_F4
  37. #define CORGI_KEY_OFF KEY_SUSPEND
  38. #define CORGI_KEY_EXOK KEY_F5
  39. #define CORGI_KEY_EXCANCEL KEY_F6
  40. #define CORGI_KEY_EXJOGDOWN KEY_F7
  41. #define CORGI_KEY_EXJOGUP KEY_F8
  42. #define CORGI_KEY_JAP1 KEY_LEFTCTRL
  43. #define CORGI_KEY_JAP2 KEY_LEFTALT
  44. #define CORGI_KEY_MAIL KEY_F10
  45. #define CORGI_KEY_OK KEY_F11
  46. #define CORGI_KEY_MENU KEY_F12
  47. static unsigned char corgikbd_keycode[NR_SCANCODES] = {
  48. 0, /* 0 */
  49. 0, KEY_1, KEY_3, KEY_5, KEY_6, KEY_7, KEY_9, KEY_0, KEY_BACKSPACE, 0, 0, 0, 0, 0, 0, 0, /* 1-16 */
  50. 0, KEY_2, KEY_4, KEY_R, KEY_Y, KEY_8, KEY_I, KEY_O, KEY_P, 0, 0, 0, 0, 0, 0, 0, /* 17-32 */
  51. KEY_TAB, KEY_Q, KEY_E, KEY_T, KEY_G, KEY_U, KEY_J, KEY_K, 0, 0, 0, 0, 0, 0, 0, 0, /* 33-48 */
  52. CORGI_KEY_CALENDER, KEY_W, KEY_S, KEY_F, KEY_V, KEY_H, KEY_M, KEY_L, 0, KEY_RIGHTSHIFT, 0, 0, 0, 0, 0, 0, /* 49-64 */
  53. CORGI_KEY_ADDRESS, KEY_A, KEY_D, KEY_C, KEY_B, KEY_N, KEY_DOT, 0, KEY_ENTER, 0, KEY_LEFTSHIFT, 0, 0, 0, 0, 0, /* 65-80 */
  54. CORGI_KEY_MAIL, KEY_Z, KEY_X, KEY_MINUS, KEY_SPACE, KEY_COMMA, 0, KEY_UP, 0, 0, 0, CORGI_KEY_FN, 0, 0, 0, 0, /* 81-96 */
  55. KEY_SYSRQ, CORGI_KEY_JAP1, CORGI_KEY_JAP2, CORGI_KEY_CANCEL, CORGI_KEY_OK, CORGI_KEY_MENU, KEY_LEFT, KEY_DOWN, KEY_RIGHT, 0, 0, 0, 0, 0, 0, 0, /* 97-112 */
  56. CORGI_KEY_OFF, CORGI_KEY_EXOK, CORGI_KEY_EXCANCEL, CORGI_KEY_EXJOGDOWN, CORGI_KEY_EXJOGUP, 0, 0, 0, 0, 0, 0, 0, /* 113-124 */
  57. };
  58. struct corgikbd {
  59. unsigned char keycode[ARRAY_SIZE(corgikbd_keycode)];
  60. struct input_dev *input;
  61. spinlock_t lock;
  62. struct timer_list timer;
  63. struct timer_list htimer;
  64. unsigned int suspended;
  65. unsigned long suspend_jiffies;
  66. };
  67. #define KB_DISCHARGE_DELAY 10
  68. #define KB_ACTIVATE_DELAY 10
  69. /* Helper functions for reading the keyboard matrix
  70. * Note: We should really be using pxa_gpio_mode to alter GPDR but it
  71. * requires a function call per GPIO bit which is excessive
  72. * when we need to access 12 bits at once multiple times.
  73. * These functions must be called within local_irq_save()/local_irq_restore()
  74. * or similar.
  75. */
  76. static inline void corgikbd_discharge_all(void)
  77. {
  78. /* STROBE All HiZ */
  79. GPCR2 = CORGI_GPIO_ALL_STROBE_BIT;
  80. GPDR2 &= ~CORGI_GPIO_ALL_STROBE_BIT;
  81. }
  82. static inline void corgikbd_activate_all(void)
  83. {
  84. /* STROBE ALL -> High */
  85. GPSR2 = CORGI_GPIO_ALL_STROBE_BIT;
  86. GPDR2 |= CORGI_GPIO_ALL_STROBE_BIT;
  87. udelay(KB_DISCHARGE_DELAY);
  88. /* Clear any interrupts we may have triggered when altering the GPIO lines */
  89. GEDR1 = CORGI_GPIO_HIGH_SENSE_BIT;
  90. GEDR2 = CORGI_GPIO_LOW_SENSE_BIT;
  91. }
  92. static inline void corgikbd_activate_col(int col)
  93. {
  94. /* STROBE col -> High, not col -> HiZ */
  95. GPSR2 = CORGI_GPIO_STROBE_BIT(col);
  96. GPDR2 = (GPDR2 & ~CORGI_GPIO_ALL_STROBE_BIT) | CORGI_GPIO_STROBE_BIT(col);
  97. }
  98. static inline void corgikbd_reset_col(int col)
  99. {
  100. /* STROBE col -> Low */
  101. GPCR2 = CORGI_GPIO_STROBE_BIT(col);
  102. /* STROBE col -> out, not col -> HiZ */
  103. GPDR2 = (GPDR2 & ~CORGI_GPIO_ALL_STROBE_BIT) | CORGI_GPIO_STROBE_BIT(col);
  104. }
  105. #define GET_ROWS_STATUS(c) (((GPLR1 & CORGI_GPIO_HIGH_SENSE_BIT) >> CORGI_GPIO_HIGH_SENSE_RSHIFT) | ((GPLR2 & CORGI_GPIO_LOW_SENSE_BIT) << CORGI_GPIO_LOW_SENSE_LSHIFT))
  106. /*
  107. * The corgi keyboard only generates interrupts when a key is pressed.
  108. * When a key is pressed, we enable a timer which then scans the
  109. * keyboard to detect when the key is released.
  110. */
  111. /* Scan the hardware keyboard and push any changes up through the input layer */
  112. static void corgikbd_scankeyboard(struct corgikbd *corgikbd_data)
  113. {
  114. unsigned int row, col, rowd;
  115. unsigned long flags;
  116. unsigned int num_pressed;
  117. if (corgikbd_data->suspended)
  118. return;
  119. spin_lock_irqsave(&corgikbd_data->lock, flags);
  120. num_pressed = 0;
  121. for (col = 0; col < KB_COLS; col++) {
  122. /*
  123. * Discharge the output driver capacitatance
  124. * in the keyboard matrix. (Yes it is significant..)
  125. */
  126. corgikbd_discharge_all();
  127. udelay(KB_DISCHARGE_DELAY);
  128. corgikbd_activate_col(col);
  129. udelay(KB_ACTIVATE_DELAY);
  130. rowd = GET_ROWS_STATUS(col);
  131. for (row = 0; row < KB_ROWS; row++) {
  132. unsigned int scancode, pressed;
  133. scancode = SCANCODE(row, col);
  134. pressed = rowd & KB_ROWMASK(row);
  135. input_report_key(corgikbd_data->input, corgikbd_data->keycode[scancode], pressed);
  136. if (pressed)
  137. num_pressed++;
  138. if (pressed && (corgikbd_data->keycode[scancode] == CORGI_KEY_OFF)
  139. && time_after(jiffies, corgikbd_data->suspend_jiffies + HZ)) {
  140. input_event(corgikbd_data->input, EV_PWR, CORGI_KEY_OFF, 1);
  141. corgikbd_data->suspend_jiffies=jiffies;
  142. }
  143. }
  144. corgikbd_reset_col(col);
  145. }
  146. corgikbd_activate_all();
  147. input_sync(corgikbd_data->input);
  148. /* if any keys are pressed, enable the timer */
  149. if (num_pressed)
  150. mod_timer(&corgikbd_data->timer, jiffies + msecs_to_jiffies(SCAN_INTERVAL));
  151. spin_unlock_irqrestore(&corgikbd_data->lock, flags);
  152. }
  153. /*
  154. * corgi keyboard interrupt handler.
  155. */
  156. static irqreturn_t corgikbd_interrupt(int irq, void *dev_id)
  157. {
  158. struct corgikbd *corgikbd_data = dev_id;
  159. if (!timer_pending(&corgikbd_data->timer)) {
  160. /** wait chattering delay **/
  161. udelay(20);
  162. corgikbd_scankeyboard(corgikbd_data);
  163. }
  164. return IRQ_HANDLED;
  165. }
  166. /*
  167. * corgi timer checking for released keys
  168. */
  169. static void corgikbd_timer_callback(unsigned long data)
  170. {
  171. struct corgikbd *corgikbd_data = (struct corgikbd *) data;
  172. corgikbd_scankeyboard(corgikbd_data);
  173. }
  174. /*
  175. * The hinge switches generate no interrupt so they need to be
  176. * monitored by a timer.
  177. *
  178. * We debounce the switches and pass them to the input system.
  179. *
  180. * gprr == 0x00 - Keyboard with Landscape Screen
  181. * 0x08 - No Keyboard with Portrait Screen
  182. * 0x0c - Keyboard and Screen Closed
  183. */
  184. #define READ_GPIO_BIT(x) (GPLR(x) & GPIO_bit(x))
  185. #define HINGE_STABLE_COUNT 2
  186. static int sharpsl_hinge_state;
  187. static int hinge_count;
  188. static void corgikbd_hinge_timer(unsigned long data)
  189. {
  190. struct corgikbd *corgikbd_data = (struct corgikbd *) data;
  191. unsigned long gprr;
  192. unsigned long flags;
  193. gprr = read_scoop_reg(&corgiscoop_device.dev, SCOOP_GPRR) & (CORGI_SCP_SWA | CORGI_SCP_SWB);
  194. gprr |= (READ_GPIO_BIT(CORGI_GPIO_AK_INT) != 0);
  195. if (gprr != sharpsl_hinge_state) {
  196. hinge_count = 0;
  197. sharpsl_hinge_state = gprr;
  198. } else if (hinge_count < HINGE_STABLE_COUNT) {
  199. hinge_count++;
  200. if (hinge_count >= HINGE_STABLE_COUNT) {
  201. spin_lock_irqsave(&corgikbd_data->lock, flags);
  202. input_report_switch(corgikbd_data->input, SW_LID, ((sharpsl_hinge_state & CORGI_SCP_SWA) != 0));
  203. input_report_switch(corgikbd_data->input, SW_TABLET_MODE, ((sharpsl_hinge_state & CORGI_SCP_SWB) != 0));
  204. input_report_switch(corgikbd_data->input, SW_HEADPHONE_INSERT, (READ_GPIO_BIT(CORGI_GPIO_AK_INT) != 0));
  205. input_sync(corgikbd_data->input);
  206. spin_unlock_irqrestore(&corgikbd_data->lock, flags);
  207. }
  208. }
  209. mod_timer(&corgikbd_data->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
  210. }
  211. #ifdef CONFIG_PM
  212. static int corgikbd_suspend(struct platform_device *dev, pm_message_t state)
  213. {
  214. int i;
  215. struct corgikbd *corgikbd = platform_get_drvdata(dev);
  216. corgikbd->suspended = 1;
  217. /* strobe 0 is the power key so this can't be made an input for
  218. powersaving therefore i = 1 */
  219. for (i = 1; i < CORGI_KEY_STROBE_NUM; i++)
  220. pxa_gpio_mode(CORGI_GPIO_KEY_STROBE(i) | GPIO_IN);
  221. return 0;
  222. }
  223. static int corgikbd_resume(struct platform_device *dev)
  224. {
  225. int i;
  226. struct corgikbd *corgikbd = platform_get_drvdata(dev);
  227. for (i = 1; i < CORGI_KEY_STROBE_NUM; i++)
  228. pxa_gpio_mode(CORGI_GPIO_KEY_STROBE(i) | GPIO_OUT | GPIO_DFLT_HIGH);
  229. /* Upon resume, ignore the suspend key for a short while */
  230. corgikbd->suspend_jiffies=jiffies;
  231. corgikbd->suspended = 0;
  232. return 0;
  233. }
  234. #else
  235. #define corgikbd_suspend NULL
  236. #define corgikbd_resume NULL
  237. #endif
  238. static int __init corgikbd_probe(struct platform_device *pdev)
  239. {
  240. struct corgikbd *corgikbd;
  241. struct input_dev *input_dev;
  242. int i, err = -ENOMEM;
  243. corgikbd = kzalloc(sizeof(struct corgikbd), GFP_KERNEL);
  244. input_dev = input_allocate_device();
  245. if (!corgikbd || !input_dev)
  246. goto fail;
  247. platform_set_drvdata(pdev, corgikbd);
  248. corgikbd->input = input_dev;
  249. spin_lock_init(&corgikbd->lock);
  250. /* Init Keyboard rescan timer */
  251. init_timer(&corgikbd->timer);
  252. corgikbd->timer.function = corgikbd_timer_callback;
  253. corgikbd->timer.data = (unsigned long) corgikbd;
  254. /* Init Hinge Timer */
  255. init_timer(&corgikbd->htimer);
  256. corgikbd->htimer.function = corgikbd_hinge_timer;
  257. corgikbd->htimer.data = (unsigned long) corgikbd;
  258. corgikbd->suspend_jiffies=jiffies;
  259. memcpy(corgikbd->keycode, corgikbd_keycode, sizeof(corgikbd->keycode));
  260. input_dev->name = "Corgi Keyboard";
  261. input_dev->phys = "corgikbd/input0";
  262. input_dev->id.bustype = BUS_HOST;
  263. input_dev->id.vendor = 0x0001;
  264. input_dev->id.product = 0x0001;
  265. input_dev->id.version = 0x0100;
  266. input_dev->cdev.dev = &pdev->dev;
  267. input_dev->private = corgikbd;
  268. input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP) | BIT(EV_PWR) | BIT(EV_SW);
  269. input_dev->keycode = corgikbd->keycode;
  270. input_dev->keycodesize = sizeof(unsigned char);
  271. input_dev->keycodemax = ARRAY_SIZE(corgikbd_keycode);
  272. for (i = 0; i < ARRAY_SIZE(corgikbd_keycode); i++)
  273. set_bit(corgikbd->keycode[i], input_dev->keybit);
  274. clear_bit(0, input_dev->keybit);
  275. set_bit(SW_LID, input_dev->swbit);
  276. set_bit(SW_TABLET_MODE, input_dev->swbit);
  277. set_bit(SW_HEADPHONE_INSERT, input_dev->swbit);
  278. err = input_register_device(corgikbd->input);
  279. if (err)
  280. goto fail;
  281. mod_timer(&corgikbd->htimer, jiffies + msecs_to_jiffies(HINGE_SCAN_INTERVAL));
  282. /* Setup sense interrupts - RisingEdge Detect, sense lines as inputs */
  283. for (i = 0; i < CORGI_KEY_SENSE_NUM; i++) {
  284. pxa_gpio_mode(CORGI_GPIO_KEY_SENSE(i) | GPIO_IN);
  285. if (request_irq(CORGI_IRQ_GPIO_KEY_SENSE(i), corgikbd_interrupt,
  286. IRQF_DISABLED | IRQF_TRIGGER_RISING,
  287. "corgikbd", corgikbd))
  288. printk(KERN_WARNING "corgikbd: Can't get IRQ: %d!\n", i);
  289. }
  290. /* Set Strobe lines as outputs - set high */
  291. for (i = 0; i < CORGI_KEY_STROBE_NUM; i++)
  292. pxa_gpio_mode(CORGI_GPIO_KEY_STROBE(i) | GPIO_OUT | GPIO_DFLT_HIGH);
  293. /* Setup the headphone jack as an input */
  294. pxa_gpio_mode(CORGI_GPIO_AK_INT | GPIO_IN);
  295. return 0;
  296. fail: input_free_device(input_dev);
  297. kfree(corgikbd);
  298. return err;
  299. }
  300. static int corgikbd_remove(struct platform_device *pdev)
  301. {
  302. int i;
  303. struct corgikbd *corgikbd = platform_get_drvdata(pdev);
  304. for (i = 0; i < CORGI_KEY_SENSE_NUM; i++)
  305. free_irq(CORGI_IRQ_GPIO_KEY_SENSE(i), corgikbd);
  306. del_timer_sync(&corgikbd->htimer);
  307. del_timer_sync(&corgikbd->timer);
  308. input_unregister_device(corgikbd->input);
  309. kfree(corgikbd);
  310. return 0;
  311. }
  312. static struct platform_driver corgikbd_driver = {
  313. .probe = corgikbd_probe,
  314. .remove = corgikbd_remove,
  315. .suspend = corgikbd_suspend,
  316. .resume = corgikbd_resume,
  317. .driver = {
  318. .name = "corgi-keyboard",
  319. },
  320. };
  321. static int __devinit corgikbd_init(void)
  322. {
  323. return platform_driver_register(&corgikbd_driver);
  324. }
  325. static void __exit corgikbd_exit(void)
  326. {
  327. platform_driver_unregister(&corgikbd_driver);
  328. }
  329. module_init(corgikbd_init);
  330. module_exit(corgikbd_exit);
  331. MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
  332. MODULE_DESCRIPTION("Corgi Keyboard Driver");
  333. MODULE_LICENSE("GPLv2");