msg2638.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Driver for MStar msg2638 touchscreens
  4. *
  5. * Copyright (c) 2021 Vincent Knecht <[email protected]>
  6. *
  7. * Checksum and IRQ handler based on mstar_drv_common.c and
  8. * mstar_drv_mutual_fw_control.c
  9. * Copyright (c) 2006-2012 MStar Semiconductor, Inc.
  10. *
  11. * Driver structure based on zinitix.c by Michael Srba <[email protected]>
  12. */
  13. #include <linux/delay.h>
  14. #include <linux/gpio/consumer.h>
  15. #include <linux/i2c.h>
  16. #include <linux/input.h>
  17. #include <linux/input/mt.h>
  18. #include <linux/input/touchscreen.h>
  19. #include <linux/interrupt.h>
  20. #include <linux/kernel.h>
  21. #include <linux/mod_devicetable.h>
  22. #include <linux/module.h>
  23. #include <linux/regulator/consumer.h>
  24. #include <linux/slab.h>
  25. #define MODE_DATA_RAW 0x5A
  26. #define MAX_SUPPORTED_FINGER_NUM 5
  27. #define CHIP_ON_DELAY_MS 15
  28. #define FIRMWARE_ON_DELAY_MS 50
  29. #define RESET_DELAY_MIN_US 10000
  30. #define RESET_DELAY_MAX_US 11000
  31. struct packet {
  32. u8 xy_hi; /* higher bits of x and y coordinates */
  33. u8 x_low;
  34. u8 y_low;
  35. u8 pressure;
  36. };
  37. struct touch_event {
  38. u8 mode;
  39. struct packet pkt[MAX_SUPPORTED_FINGER_NUM];
  40. u8 proximity;
  41. u8 checksum;
  42. };
  43. struct msg2638_ts_data {
  44. struct i2c_client *client;
  45. struct input_dev *input_dev;
  46. struct touchscreen_properties prop;
  47. struct regulator_bulk_data supplies[2];
  48. struct gpio_desc *reset_gpiod;
  49. };
  50. static u8 msg2638_checksum(u8 *data, u32 length)
  51. {
  52. s32 sum = 0;
  53. u32 i;
  54. for (i = 0; i < length; i++)
  55. sum += data[i];
  56. return (u8)((-sum) & 0xFF);
  57. }
  58. static irqreturn_t msg2638_ts_irq_handler(int irq, void *msg2638_handler)
  59. {
  60. struct msg2638_ts_data *msg2638 = msg2638_handler;
  61. struct i2c_client *client = msg2638->client;
  62. struct input_dev *input = msg2638->input_dev;
  63. struct touch_event touch_event;
  64. u32 len = sizeof(touch_event);
  65. struct i2c_msg msg[] = {
  66. {
  67. .addr = client->addr,
  68. .flags = I2C_M_RD,
  69. .len = sizeof(touch_event),
  70. .buf = (u8 *)&touch_event,
  71. },
  72. };
  73. struct packet *p;
  74. u16 x, y;
  75. int ret;
  76. int i;
  77. ret = i2c_transfer(client->adapter, msg, ARRAY_SIZE(msg));
  78. if (ret != ARRAY_SIZE(msg)) {
  79. dev_err(&client->dev,
  80. "Failed I2C transfer in irq handler: %d\n",
  81. ret < 0 ? ret : -EIO);
  82. goto out;
  83. }
  84. if (touch_event.mode != MODE_DATA_RAW)
  85. goto out;
  86. if (msg2638_checksum((u8 *)&touch_event, len - 1) !=
  87. touch_event.checksum) {
  88. dev_err(&client->dev, "Failed checksum!\n");
  89. goto out;
  90. }
  91. for (i = 0; i < MAX_SUPPORTED_FINGER_NUM; i++) {
  92. p = &touch_event.pkt[i];
  93. /* Ignore non-pressed finger data */
  94. if (p->xy_hi == 0xFF && p->x_low == 0xFF && p->y_low == 0xFF)
  95. continue;
  96. x = (((p->xy_hi & 0xF0) << 4) | p->x_low);
  97. y = (((p->xy_hi & 0x0F) << 8) | p->y_low);
  98. input_mt_slot(input, i);
  99. input_mt_report_slot_state(input, MT_TOOL_FINGER, true);
  100. touchscreen_report_pos(input, &msg2638->prop, x, y, true);
  101. }
  102. input_mt_sync_frame(msg2638->input_dev);
  103. input_sync(msg2638->input_dev);
  104. out:
  105. return IRQ_HANDLED;
  106. }
  107. static void msg2638_reset(struct msg2638_ts_data *msg2638)
  108. {
  109. gpiod_set_value_cansleep(msg2638->reset_gpiod, 1);
  110. usleep_range(RESET_DELAY_MIN_US, RESET_DELAY_MAX_US);
  111. gpiod_set_value_cansleep(msg2638->reset_gpiod, 0);
  112. msleep(FIRMWARE_ON_DELAY_MS);
  113. }
  114. static int msg2638_start(struct msg2638_ts_data *msg2638)
  115. {
  116. int error;
  117. error = regulator_bulk_enable(ARRAY_SIZE(msg2638->supplies),
  118. msg2638->supplies);
  119. if (error) {
  120. dev_err(&msg2638->client->dev,
  121. "Failed to enable regulators: %d\n", error);
  122. return error;
  123. }
  124. msleep(CHIP_ON_DELAY_MS);
  125. msg2638_reset(msg2638);
  126. enable_irq(msg2638->client->irq);
  127. return 0;
  128. }
  129. static int msg2638_stop(struct msg2638_ts_data *msg2638)
  130. {
  131. int error;
  132. disable_irq(msg2638->client->irq);
  133. error = regulator_bulk_disable(ARRAY_SIZE(msg2638->supplies),
  134. msg2638->supplies);
  135. if (error) {
  136. dev_err(&msg2638->client->dev,
  137. "Failed to disable regulators: %d\n", error);
  138. return error;
  139. }
  140. return 0;
  141. }
  142. static int msg2638_input_open(struct input_dev *dev)
  143. {
  144. struct msg2638_ts_data *msg2638 = input_get_drvdata(dev);
  145. return msg2638_start(msg2638);
  146. }
  147. static void msg2638_input_close(struct input_dev *dev)
  148. {
  149. struct msg2638_ts_data *msg2638 = input_get_drvdata(dev);
  150. msg2638_stop(msg2638);
  151. }
  152. static int msg2638_init_input_dev(struct msg2638_ts_data *msg2638)
  153. {
  154. struct device *dev = &msg2638->client->dev;
  155. struct input_dev *input_dev;
  156. int error;
  157. input_dev = devm_input_allocate_device(dev);
  158. if (!input_dev) {
  159. dev_err(dev, "Failed to allocate input device.\n");
  160. return -ENOMEM;
  161. }
  162. input_set_drvdata(input_dev, msg2638);
  163. msg2638->input_dev = input_dev;
  164. input_dev->name = "MStar TouchScreen";
  165. input_dev->phys = "input/ts";
  166. input_dev->id.bustype = BUS_I2C;
  167. input_dev->open = msg2638_input_open;
  168. input_dev->close = msg2638_input_close;
  169. input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_X);
  170. input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_Y);
  171. touchscreen_parse_properties(input_dev, true, &msg2638->prop);
  172. if (!msg2638->prop.max_x || !msg2638->prop.max_y) {
  173. dev_err(dev, "touchscreen-size-x and/or touchscreen-size-y not set in properties\n");
  174. return -EINVAL;
  175. }
  176. error = input_mt_init_slots(input_dev, MAX_SUPPORTED_FINGER_NUM,
  177. INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
  178. if (error) {
  179. dev_err(dev, "Failed to initialize MT slots: %d\n", error);
  180. return error;
  181. }
  182. error = input_register_device(input_dev);
  183. if (error) {
  184. dev_err(dev, "Failed to register input device: %d\n", error);
  185. return error;
  186. }
  187. return 0;
  188. }
  189. static int msg2638_ts_probe(struct i2c_client *client)
  190. {
  191. struct device *dev = &client->dev;
  192. struct msg2638_ts_data *msg2638;
  193. int error;
  194. if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
  195. dev_err(dev, "Failed to assert adapter's support for plain I2C.\n");
  196. return -ENXIO;
  197. }
  198. msg2638 = devm_kzalloc(dev, sizeof(*msg2638), GFP_KERNEL);
  199. if (!msg2638)
  200. return -ENOMEM;
  201. msg2638->client = client;
  202. i2c_set_clientdata(client, msg2638);
  203. msg2638->supplies[0].supply = "vdd";
  204. msg2638->supplies[1].supply = "vddio";
  205. error = devm_regulator_bulk_get(dev, ARRAY_SIZE(msg2638->supplies),
  206. msg2638->supplies);
  207. if (error) {
  208. dev_err(dev, "Failed to get regulators: %d\n", error);
  209. return error;
  210. }
  211. msg2638->reset_gpiod = devm_gpiod_get(dev, "reset", GPIOD_OUT_LOW);
  212. if (IS_ERR(msg2638->reset_gpiod)) {
  213. error = PTR_ERR(msg2638->reset_gpiod);
  214. dev_err(dev, "Failed to request reset GPIO: %d\n", error);
  215. return error;
  216. }
  217. error = msg2638_init_input_dev(msg2638);
  218. if (error) {
  219. dev_err(dev, "Failed to initialize input device: %d\n", error);
  220. return error;
  221. }
  222. error = devm_request_threaded_irq(dev, client->irq,
  223. NULL, msg2638_ts_irq_handler,
  224. IRQF_ONESHOT | IRQF_NO_AUTOEN,
  225. client->name, msg2638);
  226. if (error) {
  227. dev_err(dev, "Failed to request IRQ: %d\n", error);
  228. return error;
  229. }
  230. return 0;
  231. }
  232. static int __maybe_unused msg2638_suspend(struct device *dev)
  233. {
  234. struct i2c_client *client = to_i2c_client(dev);
  235. struct msg2638_ts_data *msg2638 = i2c_get_clientdata(client);
  236. mutex_lock(&msg2638->input_dev->mutex);
  237. if (input_device_enabled(msg2638->input_dev))
  238. msg2638_stop(msg2638);
  239. mutex_unlock(&msg2638->input_dev->mutex);
  240. return 0;
  241. }
  242. static int __maybe_unused msg2638_resume(struct device *dev)
  243. {
  244. struct i2c_client *client = to_i2c_client(dev);
  245. struct msg2638_ts_data *msg2638 = i2c_get_clientdata(client);
  246. int ret = 0;
  247. mutex_lock(&msg2638->input_dev->mutex);
  248. if (input_device_enabled(msg2638->input_dev))
  249. ret = msg2638_start(msg2638);
  250. mutex_unlock(&msg2638->input_dev->mutex);
  251. return ret;
  252. }
  253. static SIMPLE_DEV_PM_OPS(msg2638_pm_ops, msg2638_suspend, msg2638_resume);
  254. static const struct of_device_id msg2638_of_match[] = {
  255. { .compatible = "mstar,msg2638" },
  256. { }
  257. };
  258. MODULE_DEVICE_TABLE(of, msg2638_of_match);
  259. static struct i2c_driver msg2638_ts_driver = {
  260. .probe_new = msg2638_ts_probe,
  261. .driver = {
  262. .name = "MStar-TS",
  263. .pm = &msg2638_pm_ops,
  264. .of_match_table = msg2638_of_match,
  265. },
  266. };
  267. module_i2c_driver(msg2638_ts_driver);
  268. MODULE_AUTHOR("Vincent Knecht <[email protected]>");
  269. MODULE_DESCRIPTION("MStar MSG2638 touchscreen driver");
  270. MODULE_LICENSE("GPL v2");