iqs62x-keys.c 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Azoteq IQS620A/621/622/624/625 Keys and Switches
  4. *
  5. * Copyright (C) 2019 Jeff LaBundy <[email protected]>
  6. */
  7. #include <linux/device.h>
  8. #include <linux/input.h>
  9. #include <linux/kernel.h>
  10. #include <linux/mfd/iqs62x.h>
  11. #include <linux/module.h>
  12. #include <linux/notifier.h>
  13. #include <linux/platform_device.h>
  14. #include <linux/property.h>
  15. #include <linux/regmap.h>
  16. #include <linux/slab.h>
  17. enum {
  18. IQS62X_SW_HALL_N,
  19. IQS62X_SW_HALL_S,
  20. };
  21. static const char * const iqs62x_switch_names[] = {
  22. [IQS62X_SW_HALL_N] = "hall-switch-north",
  23. [IQS62X_SW_HALL_S] = "hall-switch-south",
  24. };
  25. struct iqs62x_switch_desc {
  26. enum iqs62x_event_flag flag;
  27. unsigned int code;
  28. bool enabled;
  29. };
  30. struct iqs62x_keys_private {
  31. struct iqs62x_core *iqs62x;
  32. struct input_dev *input;
  33. struct notifier_block notifier;
  34. struct iqs62x_switch_desc switches[ARRAY_SIZE(iqs62x_switch_names)];
  35. unsigned int keycode[IQS62X_NUM_KEYS];
  36. unsigned int keycodemax;
  37. u8 interval;
  38. };
  39. static int iqs62x_keys_parse_prop(struct platform_device *pdev,
  40. struct iqs62x_keys_private *iqs62x_keys)
  41. {
  42. struct fwnode_handle *child;
  43. unsigned int val;
  44. int ret, i;
  45. ret = device_property_count_u32(&pdev->dev, "linux,keycodes");
  46. if (ret > IQS62X_NUM_KEYS) {
  47. dev_err(&pdev->dev, "Too many keycodes present\n");
  48. return -EINVAL;
  49. } else if (ret < 0) {
  50. dev_err(&pdev->dev, "Failed to count keycodes: %d\n", ret);
  51. return ret;
  52. }
  53. iqs62x_keys->keycodemax = ret;
  54. ret = device_property_read_u32_array(&pdev->dev, "linux,keycodes",
  55. iqs62x_keys->keycode,
  56. iqs62x_keys->keycodemax);
  57. if (ret) {
  58. dev_err(&pdev->dev, "Failed to read keycodes: %d\n", ret);
  59. return ret;
  60. }
  61. for (i = 0; i < ARRAY_SIZE(iqs62x_keys->switches); i++) {
  62. child = device_get_named_child_node(&pdev->dev,
  63. iqs62x_switch_names[i]);
  64. if (!child)
  65. continue;
  66. ret = fwnode_property_read_u32(child, "linux,code", &val);
  67. if (ret) {
  68. dev_err(&pdev->dev, "Failed to read switch code: %d\n",
  69. ret);
  70. fwnode_handle_put(child);
  71. return ret;
  72. }
  73. iqs62x_keys->switches[i].code = val;
  74. iqs62x_keys->switches[i].enabled = true;
  75. if (fwnode_property_present(child, "azoteq,use-prox"))
  76. iqs62x_keys->switches[i].flag = (i == IQS62X_SW_HALL_N ?
  77. IQS62X_EVENT_HALL_N_P :
  78. IQS62X_EVENT_HALL_S_P);
  79. else
  80. iqs62x_keys->switches[i].flag = (i == IQS62X_SW_HALL_N ?
  81. IQS62X_EVENT_HALL_N_T :
  82. IQS62X_EVENT_HALL_S_T);
  83. fwnode_handle_put(child);
  84. }
  85. return 0;
  86. }
  87. static int iqs62x_keys_init(struct iqs62x_keys_private *iqs62x_keys)
  88. {
  89. struct iqs62x_core *iqs62x = iqs62x_keys->iqs62x;
  90. enum iqs62x_event_flag flag;
  91. unsigned int event_reg, val;
  92. unsigned int event_mask = 0;
  93. int ret, i;
  94. switch (iqs62x->dev_desc->prod_num) {
  95. case IQS620_PROD_NUM:
  96. case IQS621_PROD_NUM:
  97. case IQS622_PROD_NUM:
  98. event_reg = IQS620_GLBL_EVENT_MASK;
  99. /*
  100. * Discreet button, hysteresis and SAR UI flags represent keys
  101. * and are unmasked if mapped to a valid keycode.
  102. */
  103. for (i = 0; i < iqs62x_keys->keycodemax; i++) {
  104. if (iqs62x_keys->keycode[i] == KEY_RESERVED)
  105. continue;
  106. if (iqs62x_events[i].reg == IQS62X_EVENT_PROX)
  107. event_mask |= iqs62x->dev_desc->prox_mask;
  108. else if (iqs62x_events[i].reg == IQS62X_EVENT_HYST)
  109. event_mask |= (iqs62x->dev_desc->hyst_mask |
  110. iqs62x->dev_desc->sar_mask);
  111. }
  112. ret = regmap_read(iqs62x->regmap, iqs62x->dev_desc->hall_flags,
  113. &val);
  114. if (ret)
  115. return ret;
  116. /*
  117. * Hall UI flags represent switches and are unmasked if their
  118. * corresponding child nodes are present.
  119. */
  120. for (i = 0; i < ARRAY_SIZE(iqs62x_keys->switches); i++) {
  121. if (!(iqs62x_keys->switches[i].enabled))
  122. continue;
  123. flag = iqs62x_keys->switches[i].flag;
  124. if (iqs62x_events[flag].reg != IQS62X_EVENT_HALL)
  125. continue;
  126. event_mask |= iqs62x->dev_desc->hall_mask;
  127. input_report_switch(iqs62x_keys->input,
  128. iqs62x_keys->switches[i].code,
  129. (val & iqs62x_events[flag].mask) ==
  130. iqs62x_events[flag].val);
  131. }
  132. input_sync(iqs62x_keys->input);
  133. break;
  134. case IQS624_PROD_NUM:
  135. event_reg = IQS624_HALL_UI;
  136. /*
  137. * Interval change events represent keys and are unmasked if
  138. * either wheel movement flag is mapped to a valid keycode.
  139. */
  140. if (iqs62x_keys->keycode[IQS62X_EVENT_WHEEL_UP] != KEY_RESERVED)
  141. event_mask |= IQS624_HALL_UI_INT_EVENT;
  142. if (iqs62x_keys->keycode[IQS62X_EVENT_WHEEL_DN] != KEY_RESERVED)
  143. event_mask |= IQS624_HALL_UI_INT_EVENT;
  144. ret = regmap_read(iqs62x->regmap, iqs62x->dev_desc->interval,
  145. &val);
  146. if (ret)
  147. return ret;
  148. iqs62x_keys->interval = val;
  149. break;
  150. default:
  151. return 0;
  152. }
  153. return regmap_update_bits(iqs62x->regmap, event_reg, event_mask, 0);
  154. }
  155. static int iqs62x_keys_notifier(struct notifier_block *notifier,
  156. unsigned long event_flags, void *context)
  157. {
  158. struct iqs62x_event_data *event_data = context;
  159. struct iqs62x_keys_private *iqs62x_keys;
  160. int ret, i;
  161. iqs62x_keys = container_of(notifier, struct iqs62x_keys_private,
  162. notifier);
  163. if (event_flags & BIT(IQS62X_EVENT_SYS_RESET)) {
  164. ret = iqs62x_keys_init(iqs62x_keys);
  165. if (ret) {
  166. dev_err(iqs62x_keys->input->dev.parent,
  167. "Failed to re-initialize device: %d\n", ret);
  168. return NOTIFY_BAD;
  169. }
  170. return NOTIFY_OK;
  171. }
  172. for (i = 0; i < iqs62x_keys->keycodemax; i++) {
  173. if (iqs62x_events[i].reg == IQS62X_EVENT_WHEEL &&
  174. event_data->interval == iqs62x_keys->interval)
  175. continue;
  176. input_report_key(iqs62x_keys->input, iqs62x_keys->keycode[i],
  177. event_flags & BIT(i));
  178. }
  179. for (i = 0; i < ARRAY_SIZE(iqs62x_keys->switches); i++)
  180. if (iqs62x_keys->switches[i].enabled)
  181. input_report_switch(iqs62x_keys->input,
  182. iqs62x_keys->switches[i].code,
  183. event_flags &
  184. BIT(iqs62x_keys->switches[i].flag));
  185. input_sync(iqs62x_keys->input);
  186. if (event_data->interval == iqs62x_keys->interval)
  187. return NOTIFY_OK;
  188. /*
  189. * Each frame contains at most one wheel event (up or down), in which
  190. * case a complementary release cycle is emulated.
  191. */
  192. if (event_flags & BIT(IQS62X_EVENT_WHEEL_UP)) {
  193. input_report_key(iqs62x_keys->input,
  194. iqs62x_keys->keycode[IQS62X_EVENT_WHEEL_UP],
  195. 0);
  196. input_sync(iqs62x_keys->input);
  197. } else if (event_flags & BIT(IQS62X_EVENT_WHEEL_DN)) {
  198. input_report_key(iqs62x_keys->input,
  199. iqs62x_keys->keycode[IQS62X_EVENT_WHEEL_DN],
  200. 0);
  201. input_sync(iqs62x_keys->input);
  202. }
  203. iqs62x_keys->interval = event_data->interval;
  204. return NOTIFY_OK;
  205. }
  206. static int iqs62x_keys_probe(struct platform_device *pdev)
  207. {
  208. struct iqs62x_core *iqs62x = dev_get_drvdata(pdev->dev.parent);
  209. struct iqs62x_keys_private *iqs62x_keys;
  210. struct input_dev *input;
  211. int ret, i;
  212. iqs62x_keys = devm_kzalloc(&pdev->dev, sizeof(*iqs62x_keys),
  213. GFP_KERNEL);
  214. if (!iqs62x_keys)
  215. return -ENOMEM;
  216. platform_set_drvdata(pdev, iqs62x_keys);
  217. ret = iqs62x_keys_parse_prop(pdev, iqs62x_keys);
  218. if (ret)
  219. return ret;
  220. input = devm_input_allocate_device(&pdev->dev);
  221. if (!input)
  222. return -ENOMEM;
  223. input->keycodemax = iqs62x_keys->keycodemax;
  224. input->keycode = iqs62x_keys->keycode;
  225. input->keycodesize = sizeof(*iqs62x_keys->keycode);
  226. input->name = iqs62x->dev_desc->dev_name;
  227. input->id.bustype = BUS_I2C;
  228. for (i = 0; i < iqs62x_keys->keycodemax; i++)
  229. if (iqs62x_keys->keycode[i] != KEY_RESERVED)
  230. input_set_capability(input, EV_KEY,
  231. iqs62x_keys->keycode[i]);
  232. for (i = 0; i < ARRAY_SIZE(iqs62x_keys->switches); i++)
  233. if (iqs62x_keys->switches[i].enabled)
  234. input_set_capability(input, EV_SW,
  235. iqs62x_keys->switches[i].code);
  236. iqs62x_keys->iqs62x = iqs62x;
  237. iqs62x_keys->input = input;
  238. ret = iqs62x_keys_init(iqs62x_keys);
  239. if (ret) {
  240. dev_err(&pdev->dev, "Failed to initialize device: %d\n", ret);
  241. return ret;
  242. }
  243. ret = input_register_device(iqs62x_keys->input);
  244. if (ret) {
  245. dev_err(&pdev->dev, "Failed to register device: %d\n", ret);
  246. return ret;
  247. }
  248. iqs62x_keys->notifier.notifier_call = iqs62x_keys_notifier;
  249. ret = blocking_notifier_chain_register(&iqs62x_keys->iqs62x->nh,
  250. &iqs62x_keys->notifier);
  251. if (ret)
  252. dev_err(&pdev->dev, "Failed to register notifier: %d\n", ret);
  253. return ret;
  254. }
  255. static int iqs62x_keys_remove(struct platform_device *pdev)
  256. {
  257. struct iqs62x_keys_private *iqs62x_keys = platform_get_drvdata(pdev);
  258. int ret;
  259. ret = blocking_notifier_chain_unregister(&iqs62x_keys->iqs62x->nh,
  260. &iqs62x_keys->notifier);
  261. if (ret)
  262. dev_err(&pdev->dev, "Failed to unregister notifier: %d\n", ret);
  263. return ret;
  264. }
  265. static struct platform_driver iqs62x_keys_platform_driver = {
  266. .driver = {
  267. .name = "iqs62x-keys",
  268. },
  269. .probe = iqs62x_keys_probe,
  270. .remove = iqs62x_keys_remove,
  271. };
  272. module_platform_driver(iqs62x_keys_platform_driver);
  273. MODULE_AUTHOR("Jeff LaBundy <[email protected]>");
  274. MODULE_DESCRIPTION("Azoteq IQS620A/621/622/624/625 Keys and Switches");
  275. MODULE_LICENSE("GPL");
  276. MODULE_ALIAS("platform:iqs62x-keys");