sparse-keymap.c 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. /*
  2. * Generic support for sparse keymaps
  3. *
  4. * Copyright (c) 2009 Dmitry Torokhov
  5. *
  6. * Derived from wistron button driver:
  7. * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
  8. * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
  9. * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
  10. *
  11. * This program is free software; you can redistribute it and/or modify it
  12. * under the terms of the GNU General Public License version 2 as published by
  13. * the Free Software Foundation.
  14. */
  15. #include <linux/input.h>
  16. #include <linux/input/sparse-keymap.h>
  17. MODULE_AUTHOR("Dmitry Torokhov <dtor@mail.ru>");
  18. MODULE_DESCRIPTION("Generic support for sparse keymaps");
  19. MODULE_LICENSE("GPL v2");
  20. MODULE_VERSION("0.1");
  21. /**
  22. * sparse_keymap_entry_from_scancode - perform sparse keymap lookup
  23. * @dev: Input device using sparse keymap
  24. * @code: Scan code
  25. *
  26. * This function is used to perform &struct key_entry lookup in an
  27. * input device using sparse keymap.
  28. */
  29. struct key_entry *sparse_keymap_entry_from_scancode(struct input_dev *dev,
  30. unsigned int code)
  31. {
  32. struct key_entry *key;
  33. for (key = dev->keycode; key->type != KE_END; key++)
  34. if (code == key->code)
  35. return key;
  36. return NULL;
  37. }
  38. EXPORT_SYMBOL(sparse_keymap_entry_from_scancode);
  39. /**
  40. * sparse_keymap_entry_from_keycode - perform sparse keymap lookup
  41. * @dev: Input device using sparse keymap
  42. * @keycode: Key code
  43. *
  44. * This function is used to perform &struct key_entry lookup in an
  45. * input device using sparse keymap.
  46. */
  47. struct key_entry *sparse_keymap_entry_from_keycode(struct input_dev *dev,
  48. unsigned int keycode)
  49. {
  50. struct key_entry *key;
  51. for (key = dev->keycode; key->type != KE_END; key++)
  52. if (key->type == KE_KEY && keycode == key->keycode)
  53. return key;
  54. return NULL;
  55. }
  56. EXPORT_SYMBOL(sparse_keymap_entry_from_keycode);
  57. static int sparse_keymap_getkeycode(struct input_dev *dev,
  58. int scancode, int *keycode)
  59. {
  60. const struct key_entry *key =
  61. sparse_keymap_entry_from_scancode(dev, scancode);
  62. if (key && key->type == KE_KEY) {
  63. *keycode = key->keycode;
  64. return 0;
  65. }
  66. return -EINVAL;
  67. }
  68. static int sparse_keymap_setkeycode(struct input_dev *dev,
  69. int scancode, int keycode)
  70. {
  71. struct key_entry *key;
  72. int old_keycode;
  73. if (keycode < 0 || keycode > KEY_MAX)
  74. return -EINVAL;
  75. key = sparse_keymap_entry_from_scancode(dev, scancode);
  76. if (key && key->type == KE_KEY) {
  77. old_keycode = key->keycode;
  78. key->keycode = keycode;
  79. set_bit(keycode, dev->keybit);
  80. if (!sparse_keymap_entry_from_keycode(dev, old_keycode))
  81. clear_bit(old_keycode, dev->keybit);
  82. return 0;
  83. }
  84. return -EINVAL;
  85. }
  86. /**
  87. * sparse_keymap_setup - set up sparse keymap for an input device
  88. * @dev: Input device
  89. * @keymap: Keymap in form of array of &key_entry structures ending
  90. * with %KE_END type entry
  91. * @setup: Function that can be used to adjust keymap entries
  92. * depending on device's deeds, may be %NULL
  93. *
  94. * The function calculates size and allocates copy of the original
  95. * keymap after which sets up input device event bits appropriately.
  96. * Before destroying input device allocated keymap should be freed
  97. * with a call to sparse_keymap_free().
  98. */
  99. int sparse_keymap_setup(struct input_dev *dev,
  100. const struct key_entry *keymap,
  101. int (*setup)(struct input_dev *, struct key_entry *))
  102. {
  103. size_t map_size = 1; /* to account for the last KE_END entry */
  104. const struct key_entry *e;
  105. struct key_entry *map, *entry;
  106. int i;
  107. int error;
  108. for (e = keymap; e->type != KE_END; e++)
  109. map_size++;
  110. map = kcalloc(map_size, sizeof (struct key_entry), GFP_KERNEL);
  111. if (!map)
  112. return -ENOMEM;
  113. memcpy(map, keymap, map_size * sizeof (struct key_entry));
  114. for (i = 0; i < map_size; i++) {
  115. entry = &map[i];
  116. if (setup) {
  117. error = setup(dev, entry);
  118. if (error)
  119. goto err_out;
  120. }
  121. switch (entry->type) {
  122. case KE_KEY:
  123. __set_bit(EV_KEY, dev->evbit);
  124. __set_bit(entry->keycode, dev->keybit);
  125. break;
  126. case KE_SW:
  127. __set_bit(EV_SW, dev->evbit);
  128. __set_bit(entry->sw.code, dev->swbit);
  129. break;
  130. }
  131. }
  132. dev->keycode = map;
  133. dev->keycodemax = map_size;
  134. dev->getkeycode = sparse_keymap_getkeycode;
  135. dev->setkeycode = sparse_keymap_setkeycode;
  136. return 0;
  137. err_out:
  138. kfree(keymap);
  139. return error;
  140. }
  141. EXPORT_SYMBOL(sparse_keymap_setup);
  142. /**
  143. * sparse_keymap_free - free memory allocated for sparse keymap
  144. * @dev: Input device using sparse keymap
  145. *
  146. * This function is used to free memory allocated by sparse keymap
  147. * in an input device that was set up by sparse_keymap_setup().
  148. */
  149. void sparse_keymap_free(struct input_dev *dev)
  150. {
  151. kfree(dev->keycode);
  152. dev->keycode = NULL;
  153. dev->keycodemax = 0;
  154. dev->getkeycode = NULL;
  155. dev->setkeycode = NULL;
  156. }
  157. EXPORT_SYMBOL(sparse_keymap_free);
  158. /**
  159. * sparse_keymap_report_entry - report event corresponding to given key entry
  160. * @dev: Input device for which event should be reported
  161. * @ke: key entry describing event
  162. * @value: Value that should be reported (ignored by %KE_SW entries)
  163. * @autorelease: Signals whether release event should be emitted for %KE_KEY
  164. * entries right after reporting press event, ignored by all other
  165. * entries
  166. *
  167. * This function is used to report input event described by given
  168. * &struct key_entry.
  169. */
  170. void sparse_keymap_report_entry(struct input_dev *dev, const struct key_entry *ke,
  171. unsigned int value, bool autorelease)
  172. {
  173. switch (ke->type) {
  174. case KE_KEY:
  175. input_report_key(dev, ke->keycode, value);
  176. input_sync(dev);
  177. if (value && autorelease) {
  178. input_report_key(dev, ke->keycode, 0);
  179. input_sync(dev);
  180. }
  181. break;
  182. case KE_SW:
  183. value = ke->sw.value;
  184. /* fall through */
  185. case KE_VSW:
  186. input_report_switch(dev, ke->sw.code, value);
  187. break;
  188. }
  189. }
  190. EXPORT_SYMBOL(sparse_keymap_report_entry);
  191. /**
  192. * sparse_keymap_report_event - report event corresponding to given scancode
  193. * @dev: Input device using sparse keymap
  194. * @code: Scan code
  195. * @value: Value that should be reported (ignored by %KE_SW entries)
  196. * @autorelease: Signals whether release event should be emitted for %KE_KEY
  197. * entries right after reporting press event, ignored by all other
  198. * entries
  199. *
  200. * This function is used to perform lookup in an input device using sparse
  201. * keymap and report corresponding event. Returns %true if lookup was
  202. * successful and %false otherwise.
  203. */
  204. bool sparse_keymap_report_event(struct input_dev *dev, unsigned int code,
  205. unsigned int value, bool autorelease)
  206. {
  207. const struct key_entry *ke =
  208. sparse_keymap_entry_from_scancode(dev, code);
  209. if (ke) {
  210. sparse_keymap_report_entry(dev, ke, value, autorelease);
  211. return true;
  212. }
  213. return false;
  214. }
  215. EXPORT_SYMBOL(sparse_keymap_report_event);