hil_kbd.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. /*
  2. * Generic linux-input device driver for keyboard devices
  3. *
  4. * Copyright (c) 2001 Brian S. Julin
  5. * All rights reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. * 1. Redistributions of source code must retain the above copyright
  11. * notice, this list of conditions, and the following disclaimer,
  12. * without modification.
  13. * 2. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * Alternatively, this software may be distributed under the terms of the
  17. * GNU General Public License ("GPL").
  18. *
  19. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  23. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28. *
  29. * References:
  30. * HP-HIL Technical Reference Manual. Hewlett Packard Product No. 45918A
  31. *
  32. */
  33. #include <linux/hil.h>
  34. #include <linux/input.h>
  35. #include <linux/serio.h>
  36. #include <linux/kernel.h>
  37. #include <linux/module.h>
  38. #include <linux/init.h>
  39. #include <linux/slab.h>
  40. #include <linux/pci_ids.h>
  41. #define PREFIX "HIL KEYB: "
  42. #define HIL_GENERIC_NAME "HIL keyboard"
  43. MODULE_AUTHOR("Brian S. Julin <bri@calyx.com>");
  44. MODULE_DESCRIPTION(HIL_GENERIC_NAME " driver");
  45. MODULE_LICENSE("Dual BSD/GPL");
  46. #define HIL_KBD_MAX_LENGTH 16
  47. #define HIL_KBD_SET1_UPBIT 0x01
  48. #define HIL_KBD_SET1_SHIFT 1
  49. static unsigned int hil_kbd_set1[HIL_KEYCODES_SET1_TBLSIZE] =
  50. { HIL_KEYCODES_SET1 };
  51. #define HIL_KBD_SET2_UPBIT 0x01
  52. #define HIL_KBD_SET2_SHIFT 1
  53. /* Set2 is user defined */
  54. #define HIL_KBD_SET3_UPBIT 0x80
  55. #define HIL_KBD_SET3_SHIFT 0
  56. static unsigned int hil_kbd_set3[HIL_KEYCODES_SET3_TBLSIZE] =
  57. { HIL_KEYCODES_SET3 };
  58. static char hil_language[][16] = { HIL_LOCALE_MAP };
  59. struct hil_kbd {
  60. struct input_dev *dev;
  61. struct serio *serio;
  62. /* Input buffer and index for packets from HIL bus. */
  63. hil_packet data[HIL_KBD_MAX_LENGTH];
  64. int idx4; /* four counts per packet */
  65. /* Raw device info records from HIL bus, see hil.h for fields. */
  66. char idd[HIL_KBD_MAX_LENGTH]; /* DID byte and IDD record */
  67. char rsc[HIL_KBD_MAX_LENGTH]; /* RSC record */
  68. char exd[HIL_KBD_MAX_LENGTH]; /* EXD record */
  69. char rnm[HIL_KBD_MAX_LENGTH + 1]; /* RNM record + NULL term. */
  70. /* Something to sleep around with. */
  71. struct semaphore sem;
  72. };
  73. /* Process a complete packet after transfer from the HIL */
  74. static void hil_kbd_process_record(struct hil_kbd *kbd)
  75. {
  76. struct input_dev *dev = kbd->dev;
  77. hil_packet *data = kbd->data;
  78. hil_packet p;
  79. int idx, i, cnt;
  80. idx = kbd->idx4/4;
  81. p = data[idx - 1];
  82. if ((p & ~HIL_CMDCT_POL) ==
  83. (HIL_ERR_INT | HIL_PKT_CMD | HIL_CMD_POL)) goto report;
  84. if ((p & ~HIL_CMDCT_RPL) ==
  85. (HIL_ERR_INT | HIL_PKT_CMD | HIL_CMD_RPL)) goto report;
  86. /* Not a poll response. See if we are loading config records. */
  87. switch (p & HIL_PKT_DATA_MASK) {
  88. case HIL_CMD_IDD:
  89. for (i = 0; i < idx; i++)
  90. kbd->idd[i] = kbd->data[i] & HIL_PKT_DATA_MASK;
  91. for (; i < HIL_KBD_MAX_LENGTH; i++)
  92. kbd->idd[i] = 0;
  93. break;
  94. case HIL_CMD_RSC:
  95. for (i = 0; i < idx; i++)
  96. kbd->rsc[i] = kbd->data[i] & HIL_PKT_DATA_MASK;
  97. for (; i < HIL_KBD_MAX_LENGTH; i++)
  98. kbd->rsc[i] = 0;
  99. break;
  100. case HIL_CMD_EXD:
  101. for (i = 0; i < idx; i++)
  102. kbd->exd[i] = kbd->data[i] & HIL_PKT_DATA_MASK;
  103. for (; i < HIL_KBD_MAX_LENGTH; i++)
  104. kbd->exd[i] = 0;
  105. break;
  106. case HIL_CMD_RNM:
  107. for (i = 0; i < idx; i++)
  108. kbd->rnm[i] = kbd->data[i] & HIL_PKT_DATA_MASK;
  109. for (; i < HIL_KBD_MAX_LENGTH + 1; i++)
  110. kbd->rnm[i] = '\0';
  111. break;
  112. default:
  113. /* These occur when device isn't present */
  114. if (p == (HIL_ERR_INT | HIL_PKT_CMD)) break;
  115. /* Anything else we'd like to know about. */
  116. printk(KERN_WARNING PREFIX "Device sent unknown record %x\n", p);
  117. break;
  118. }
  119. goto out;
  120. report:
  121. cnt = 1;
  122. switch (kbd->data[0] & HIL_POL_CHARTYPE_MASK) {
  123. case HIL_POL_CHARTYPE_NONE:
  124. break;
  125. case HIL_POL_CHARTYPE_ASCII:
  126. while (cnt < idx - 1)
  127. input_report_key(dev, kbd->data[cnt++] & 0x7f, 1);
  128. break;
  129. case HIL_POL_CHARTYPE_RSVD1:
  130. case HIL_POL_CHARTYPE_RSVD2:
  131. case HIL_POL_CHARTYPE_BINARY:
  132. while (cnt < idx - 1)
  133. input_report_key(dev, kbd->data[cnt++], 1);
  134. break;
  135. case HIL_POL_CHARTYPE_SET1:
  136. while (cnt < idx - 1) {
  137. unsigned int key;
  138. int up;
  139. key = kbd->data[cnt++];
  140. up = key & HIL_KBD_SET1_UPBIT;
  141. key &= (~HIL_KBD_SET1_UPBIT & 0xff);
  142. key = hil_kbd_set1[key >> HIL_KBD_SET1_SHIFT];
  143. if (key != KEY_RESERVED)
  144. input_report_key(dev, key, !up);
  145. }
  146. break;
  147. case HIL_POL_CHARTYPE_SET2:
  148. while (cnt < idx - 1) {
  149. unsigned int key;
  150. int up;
  151. key = kbd->data[cnt++];
  152. up = key & HIL_KBD_SET2_UPBIT;
  153. key &= (~HIL_KBD_SET1_UPBIT & 0xff);
  154. key = key >> HIL_KBD_SET2_SHIFT;
  155. if (key != KEY_RESERVED)
  156. input_report_key(dev, key, !up);
  157. }
  158. break;
  159. case HIL_POL_CHARTYPE_SET3:
  160. while (cnt < idx - 1) {
  161. unsigned int key;
  162. int up;
  163. key = kbd->data[cnt++];
  164. up = key & HIL_KBD_SET3_UPBIT;
  165. key &= (~HIL_KBD_SET1_UPBIT & 0xff);
  166. key = hil_kbd_set3[key >> HIL_KBD_SET3_SHIFT];
  167. if (key != KEY_RESERVED)
  168. input_report_key(dev, key, !up);
  169. }
  170. break;
  171. }
  172. out:
  173. kbd->idx4 = 0;
  174. up(&kbd->sem);
  175. }
  176. static void hil_kbd_process_err(struct hil_kbd *kbd) {
  177. printk(KERN_WARNING PREFIX "errored HIL packet\n");
  178. kbd->idx4 = 0;
  179. up(&kbd->sem);
  180. }
  181. static irqreturn_t hil_kbd_interrupt(struct serio *serio,
  182. unsigned char data, unsigned int flags)
  183. {
  184. struct hil_kbd *kbd;
  185. hil_packet packet;
  186. int idx;
  187. kbd = serio_get_drvdata(serio);
  188. if (kbd == NULL) {
  189. BUG();
  190. return IRQ_HANDLED;
  191. }
  192. if (kbd->idx4 >= (HIL_KBD_MAX_LENGTH * sizeof(hil_packet))) {
  193. hil_kbd_process_err(kbd);
  194. return IRQ_HANDLED;
  195. }
  196. idx = kbd->idx4/4;
  197. if (!(kbd->idx4 % 4)) kbd->data[idx] = 0;
  198. packet = kbd->data[idx];
  199. packet |= ((hil_packet)data) << ((3 - (kbd->idx4 % 4)) * 8);
  200. kbd->data[idx] = packet;
  201. /* Records of N 4-byte hil_packets must terminate with a command. */
  202. if ((++(kbd->idx4)) % 4) return IRQ_HANDLED;
  203. if ((packet & 0xffff0000) != HIL_ERR_INT) {
  204. hil_kbd_process_err(kbd);
  205. return IRQ_HANDLED;
  206. }
  207. if (packet & HIL_PKT_CMD) hil_kbd_process_record(kbd);
  208. return IRQ_HANDLED;
  209. }
  210. static void hil_kbd_disconnect(struct serio *serio)
  211. {
  212. struct hil_kbd *kbd;
  213. kbd = serio_get_drvdata(serio);
  214. if (kbd == NULL) {
  215. BUG();
  216. return;
  217. }
  218. serio_close(serio);
  219. input_unregister_device(kbd->dev);
  220. kfree(kbd);
  221. }
  222. static int hil_kbd_connect(struct serio *serio, struct serio_driver *drv)
  223. {
  224. struct hil_kbd *kbd;
  225. uint8_t did, *idd;
  226. int i;
  227. kbd = kzalloc(sizeof(*kbd), GFP_KERNEL);
  228. if (!kbd)
  229. return -ENOMEM;
  230. kbd->dev = input_allocate_device();
  231. if (!kbd->dev)
  232. goto bail0;
  233. kbd->dev->private = kbd;
  234. if (serio_open(serio, drv))
  235. goto bail1;
  236. serio_set_drvdata(serio, kbd);
  237. kbd->serio = serio;
  238. init_MUTEX_LOCKED(&(kbd->sem));
  239. /* Get device info. MLC driver supplies devid/status/etc. */
  240. serio->write(serio, 0);
  241. serio->write(serio, 0);
  242. serio->write(serio, HIL_PKT_CMD >> 8);
  243. serio->write(serio, HIL_CMD_IDD);
  244. down(&(kbd->sem));
  245. serio->write(serio, 0);
  246. serio->write(serio, 0);
  247. serio->write(serio, HIL_PKT_CMD >> 8);
  248. serio->write(serio, HIL_CMD_RSC);
  249. down(&(kbd->sem));
  250. serio->write(serio, 0);
  251. serio->write(serio, 0);
  252. serio->write(serio, HIL_PKT_CMD >> 8);
  253. serio->write(serio, HIL_CMD_RNM);
  254. down(&(kbd->sem));
  255. serio->write(serio, 0);
  256. serio->write(serio, 0);
  257. serio->write(serio, HIL_PKT_CMD >> 8);
  258. serio->write(serio, HIL_CMD_EXD);
  259. down(&(kbd->sem));
  260. up(&(kbd->sem));
  261. did = kbd->idd[0];
  262. idd = kbd->idd + 1;
  263. switch (did & HIL_IDD_DID_TYPE_MASK) {
  264. case HIL_IDD_DID_TYPE_KB_INTEGRAL:
  265. case HIL_IDD_DID_TYPE_KB_ITF:
  266. case HIL_IDD_DID_TYPE_KB_RSVD:
  267. case HIL_IDD_DID_TYPE_CHAR:
  268. printk(KERN_INFO PREFIX "HIL keyboard found (did = 0x%02x, lang = %s)\n",
  269. did, hil_language[did & HIL_IDD_DID_TYPE_KB_LANG_MASK]);
  270. break;
  271. default:
  272. goto bail2;
  273. }
  274. if(HIL_IDD_NUM_BUTTONS(idd) || HIL_IDD_NUM_AXES_PER_SET(*idd)) {
  275. printk(KERN_INFO PREFIX "keyboards only, no combo devices supported.\n");
  276. goto bail2;
  277. }
  278. kbd->dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REP);
  279. kbd->dev->ledbit[0] = BIT(LED_NUML) | BIT(LED_CAPSL) | BIT(LED_SCROLLL);
  280. kbd->dev->keycodemax = HIL_KEYCODES_SET1_TBLSIZE;
  281. kbd->dev->keycodesize = sizeof(hil_kbd_set1[0]);
  282. kbd->dev->keycode = hil_kbd_set1;
  283. kbd->dev->name = strlen(kbd->rnm) ? kbd->rnm : HIL_GENERIC_NAME;
  284. kbd->dev->phys = "hpkbd/input0"; /* XXX */
  285. kbd->dev->id.bustype = BUS_HIL;
  286. kbd->dev->id.vendor = PCI_VENDOR_ID_HP;
  287. kbd->dev->id.product = 0x0001; /* TODO: get from kbd->rsc */
  288. kbd->dev->id.version = 0x0100; /* TODO: get from kbd->rsc */
  289. kbd->dev->cdev.dev = &serio->dev;
  290. for (i = 0; i < 128; i++) {
  291. set_bit(hil_kbd_set1[i], kbd->dev->keybit);
  292. set_bit(hil_kbd_set3[i], kbd->dev->keybit);
  293. }
  294. clear_bit(0, kbd->dev->keybit);
  295. input_register_device(kbd->dev);
  296. printk(KERN_INFO "input: %s, ID: %d\n",
  297. kbd->dev->name, did);
  298. serio->write(serio, 0);
  299. serio->write(serio, 0);
  300. serio->write(serio, HIL_PKT_CMD >> 8);
  301. serio->write(serio, HIL_CMD_EK1); /* Enable Keyswitch Autorepeat 1 */
  302. down(&(kbd->sem));
  303. up(&(kbd->sem));
  304. return 0;
  305. bail2:
  306. serio_close(serio);
  307. serio_set_drvdata(serio, NULL);
  308. bail1:
  309. input_free_device(kbd->dev);
  310. bail0:
  311. kfree(kbd);
  312. return -EIO;
  313. }
  314. static struct serio_device_id hil_kbd_ids[] = {
  315. {
  316. .type = SERIO_HIL_MLC,
  317. .proto = SERIO_HIL,
  318. .id = SERIO_ANY,
  319. .extra = SERIO_ANY,
  320. },
  321. { 0 }
  322. };
  323. struct serio_driver hil_kbd_serio_drv = {
  324. .driver = {
  325. .name = "hil_kbd",
  326. },
  327. .description = "HP HIL keyboard driver",
  328. .id_table = hil_kbd_ids,
  329. .connect = hil_kbd_connect,
  330. .disconnect = hil_kbd_disconnect,
  331. .interrupt = hil_kbd_interrupt
  332. };
  333. static int __init hil_kbd_init(void)
  334. {
  335. return serio_register_driver(&hil_kbd_serio_drv);
  336. }
  337. static void __exit hil_kbd_exit(void)
  338. {
  339. serio_unregister_driver(&hil_kbd_serio_drv);
  340. }
  341. module_init(hil_kbd_init);
  342. module_exit(hil_kbd_exit);