synaptics_tcm_i2c.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. /*
  2. * Synaptics TCM touchscreen driver
  3. *
  4. * Copyright (C) 2017-2019 Synaptics Incorporated. All rights reserved.
  5. *
  6. * Copyright (C) 2017-2019 Scott Lin <[email protected]>
  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 as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED "AS-IS," AND SYNAPTICS
  19. * EXPRESSLY DISCLAIMS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING ANY
  20. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
  21. * AND ANY WARRANTIES OF NON-INFRINGEMENT OF ANY INTELLECTUAL PROPERTY RIGHTS.
  22. * IN NO EVENT SHALL SYNAPTICS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23. * SPECIAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR IN CONNECTION
  24. * WITH THE USE OF THE INFORMATION CONTAINED IN THIS DOCUMENT, HOWEVER CAUSED
  25. * AND BASED ON ANY THEORY OF LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  26. * NEGLIGENCE OR OTHER TORTIOUS ACTION, AND EVEN IF SYNAPTICS WAS ADVISED OF
  27. * THE POSSIBILITY OF SUCH DAMAGE. IF A TRIBUNAL OF COMPETENT JURISDICTION DOES
  28. * NOT PERMIT THE DISCLAIMER OF DIRECT DAMAGES OR ANY OTHER DAMAGES, SYNAPTICS'
  29. * TOTAL CUMULATIVE LIABILITY TO ANY PARTY SHALL NOT EXCEED ONE HUNDRED U.S.
  30. * DOLLARS.
  31. */
  32. #include <linux/i2c.h>
  33. #include <linux/of_gpio.h>
  34. #include "synaptics_tcm_core.h"
  35. #include "linux/moduleparam.h"
  36. #define XFER_ATTEMPTS 10
  37. static unsigned char *buf;
  38. static unsigned int buf_size;
  39. static struct syna_tcm_bus_io bus_io;
  40. static struct syna_tcm_hw_interface hw_if;
  41. static struct platform_device *syna_tcm_i2c_device;
  42. static struct drm_panel *active_tcm_panel;
  43. struct drm_panel *tcm_get_panel(void)
  44. {
  45. return active_tcm_panel;
  46. }
  47. EXPORT_SYMBOL(tcm_get_panel);
  48. #ifdef CONFIG_OF
  49. static int parse_dt(struct device *dev, struct syna_tcm_board_data *bdata)
  50. {
  51. int retval;
  52. struct device_node *np = dev->of_node;
  53. retval = of_get_named_gpio_flags(np,
  54. "synaptics,irq-gpio", 0,
  55. (enum of_gpio_flags *)&bdata->irq_flags);
  56. if (!gpio_is_valid(retval)) {
  57. if (retval != -EPROBE_DEFER)
  58. dev_err(dev, "Error getting irq_gpio\n");
  59. return retval;
  60. }
  61. bdata->irq_gpio = retval;
  62. of_property_read_u32(np, "synaptics,irq-on-state",
  63. &bdata->irq_on_state);
  64. of_property_read_string(np, "synaptics,pwr-reg-name",
  65. &bdata->pwr_reg_name);
  66. of_property_read_string(np, "synaptics,bus-reg-name",
  67. &bdata->bus_reg_name);
  68. of_property_read_string(np, "synaptics,firmware-name",
  69. &bdata->fw_name);
  70. bdata->power_gpio = of_get_named_gpio_flags(np,
  71. "synaptics,power-gpio", 0, NULL);
  72. retval = of_property_read_u32(np, "synaptics,power-on-state",
  73. &bdata->power_on_state);
  74. if (retval < 0) {
  75. LOGD(dev, "Failed to read synaptics,power-on-state\n");
  76. bdata->power_on_state = 0;
  77. }
  78. retval = of_property_read_u32(np, "synaptics,power-delay-ms",
  79. &bdata->power_delay_ms);
  80. if (retval < 0) {
  81. LOGE(dev, "Failed to read synaptics,power-delay-ms\n");
  82. return retval;
  83. }
  84. retval = of_get_named_gpio_flags(np,
  85. "synaptics,reset-gpio", 0, NULL);
  86. if (!gpio_is_valid(retval)) {
  87. if (retval != -EPROBE_DEFER)
  88. dev_err(dev, "Error getting reset gpio\n");
  89. return retval;
  90. }
  91. bdata->reset_gpio = retval;
  92. retval = of_property_read_u32(np, "synaptics,reset-on-state",
  93. &bdata->reset_on_state);
  94. if (retval < 0) {
  95. LOGE(dev, "Failed to read synaptics,reset-on-state\n");
  96. return retval;
  97. }
  98. retval = of_property_read_u32(np, "synaptics,reset-active-ms",
  99. &bdata->reset_active_ms);
  100. if (retval < 0) {
  101. LOGE(dev, "Failed to read synaptics,reset-active-ms\n");
  102. return retval;
  103. }
  104. retval = of_property_read_u32(np, "synaptics,reset-delay-ms",
  105. &bdata->reset_delay_ms);
  106. if (retval < 0) {
  107. LOGE(dev, "Unable to read synaptics,reset-delay-ms\n");
  108. return retval;
  109. }
  110. bdata->x_flip = of_property_read_bool(np, "synaptics,x-flip");
  111. bdata->y_flip = of_property_read_bool(np, "synaptics,y-flip");
  112. bdata->swap_axes = of_property_read_bool(np, "synaptics,swap-axes");
  113. retval = of_property_read_u32(np, "synaptics,ubl-i2c-addr",
  114. &bdata->ubl_i2c_addr);
  115. if (retval < 0) {
  116. LOGE(dev, "Unable to read synaptics,ubl-i2c-addr\n");
  117. return retval;
  118. }
  119. bdata->extend_report = of_property_read_bool(np,
  120. "synaptics,extend_report");
  121. return 0;
  122. }
  123. #endif
  124. static int syna_tcm_i2c_alloc_mem(struct syna_tcm_hcd *tcm_hcd,
  125. unsigned int size)
  126. {
  127. struct i2c_client *i2c = to_i2c_client(tcm_hcd->pdev->dev.parent);
  128. if (size > buf_size) {
  129. if (buf_size)
  130. kfree(buf);
  131. buf = kmalloc(size, GFP_KERNEL);
  132. if (!buf) {
  133. LOGE(&i2c->dev,
  134. "Failed to allocate memory for buf\n");
  135. buf_size = 0;
  136. return -ENOMEM;
  137. }
  138. buf_size = size;
  139. }
  140. return 0;
  141. }
  142. static int syna_tcm_i2c_rmi_read(struct syna_tcm_hcd *tcm_hcd,
  143. unsigned short addr, unsigned char *data, unsigned int length)
  144. {
  145. int retval = 0;
  146. unsigned char address;
  147. unsigned int attempt;
  148. struct i2c_msg msg[2];
  149. struct i2c_client *i2c = to_i2c_client(tcm_hcd->pdev->dev.parent);
  150. const struct syna_tcm_board_data *bdata = tcm_hcd->hw_if->bdata;
  151. mutex_lock(&tcm_hcd->io_ctrl_mutex);
  152. address = (unsigned char)addr;
  153. msg[0].addr = bdata->ubl_i2c_addr;
  154. msg[0].flags = 0;
  155. msg[0].len = 1;
  156. msg[0].buf = &address;
  157. msg[1].addr = bdata->ubl_i2c_addr;
  158. msg[1].flags = I2C_M_RD;
  159. msg[1].len = length;
  160. msg[1].buf = data;
  161. for (attempt = 0; attempt < XFER_ATTEMPTS; attempt++) {
  162. if (i2c_transfer(i2c->adapter, msg, 2) == 2) {
  163. retval = length;
  164. goto exit;
  165. }
  166. LOGD(&i2c->dev, "Transfer attempt %d times\n", attempt + 1);
  167. if (attempt + 1 == XFER_ATTEMPTS) {
  168. LOGE(&i2c->dev, "Transfer failed\n");
  169. retval = -EIO;
  170. goto exit;
  171. }
  172. msleep(20);
  173. }
  174. exit:
  175. mutex_unlock(&tcm_hcd->io_ctrl_mutex);
  176. return retval;
  177. }
  178. static int syna_tcm_i2c_rmi_write(struct syna_tcm_hcd *tcm_hcd,
  179. unsigned short addr, unsigned char *data, unsigned int length)
  180. {
  181. int retval;
  182. unsigned int attempt;
  183. unsigned int byte_count;
  184. struct i2c_msg msg;
  185. struct i2c_client *i2c = to_i2c_client(tcm_hcd->pdev->dev.parent);
  186. const struct syna_tcm_board_data *bdata = tcm_hcd->hw_if->bdata;
  187. mutex_lock(&tcm_hcd->io_ctrl_mutex);
  188. byte_count = length + 1;
  189. retval = syna_tcm_i2c_alloc_mem(tcm_hcd, byte_count);
  190. if (retval < 0) {
  191. LOGE(&i2c->dev,
  192. "Failed to allocate memory\n");
  193. goto exit;
  194. }
  195. buf[0] = (unsigned char)addr;
  196. retval = secure_memcpy(&buf[1],
  197. buf_size - 1,
  198. data,
  199. length,
  200. length);
  201. if (retval < 0) {
  202. LOGE(&i2c->dev,
  203. "Failed to copy write data\n");
  204. goto exit;
  205. }
  206. msg.addr = bdata->ubl_i2c_addr;
  207. msg.flags = 0;
  208. msg.len = byte_count;
  209. msg.buf = buf;
  210. for (attempt = 0; attempt < XFER_ATTEMPTS; attempt++) {
  211. if (i2c_transfer(i2c->adapter, &msg, 1) == 1) {
  212. retval = length;
  213. goto exit;
  214. }
  215. LOGD(&i2c->dev, "Transfer attempt %d times\n", attempt + 1);
  216. if (attempt + 1 == XFER_ATTEMPTS) {
  217. LOGE(&i2c->dev, "Transfer failed\n");
  218. retval = -EIO;
  219. goto exit;
  220. }
  221. msleep(20);
  222. }
  223. exit:
  224. mutex_unlock(&tcm_hcd->io_ctrl_mutex);
  225. return retval;
  226. }
  227. static int syna_tcm_i2c_read(struct syna_tcm_hcd *tcm_hcd, unsigned char *data,
  228. unsigned int length)
  229. {
  230. int retval = 0;
  231. unsigned int attempt;
  232. struct i2c_msg msg;
  233. struct i2c_client *i2c = to_i2c_client(tcm_hcd->pdev->dev.parent);
  234. mutex_lock(&tcm_hcd->io_ctrl_mutex);
  235. msg.addr = i2c->addr;
  236. msg.flags = I2C_M_RD;
  237. msg.len = length;
  238. msg.buf = data;
  239. for (attempt = 0; attempt < XFER_ATTEMPTS; attempt++) {
  240. if (i2c_transfer(i2c->adapter, &msg, 1) == 1) {
  241. retval = length;
  242. goto exit;
  243. }
  244. LOGD(&i2c->dev, "Transfer attempt %d times\n", attempt + 1);
  245. if (attempt + 1 == XFER_ATTEMPTS) {
  246. LOGE(&i2c->dev, "Transfer failed\n");
  247. retval = -EIO;
  248. goto exit;
  249. }
  250. msleep(20);
  251. }
  252. exit:
  253. mutex_unlock(&tcm_hcd->io_ctrl_mutex);
  254. return retval;
  255. }
  256. static int syna_tcm_i2c_write(struct syna_tcm_hcd *tcm_hcd, unsigned char *data,
  257. unsigned int length)
  258. {
  259. int retval = 0;
  260. unsigned int attempt;
  261. struct i2c_msg msg;
  262. struct i2c_client *i2c = to_i2c_client(tcm_hcd->pdev->dev.parent);
  263. mutex_lock(&tcm_hcd->io_ctrl_mutex);
  264. msg.addr = i2c->addr;
  265. msg.flags = 0;
  266. msg.len = length;
  267. msg.buf = data;
  268. for (attempt = 0; attempt < XFER_ATTEMPTS; attempt++) {
  269. if (i2c_transfer(i2c->adapter, &msg, 1) == 1) {
  270. retval = length;
  271. goto exit;
  272. }
  273. LOGD(&i2c->dev, "Transfer attempt %d times\n", attempt + 1);
  274. if (attempt + 1 == XFER_ATTEMPTS) {
  275. LOGE(&i2c->dev, "Transfer failed\n");
  276. retval = -EIO;
  277. goto exit;
  278. }
  279. msleep(20);
  280. }
  281. exit:
  282. mutex_unlock(&tcm_hcd->io_ctrl_mutex);
  283. return retval;
  284. }
  285. static int syna_tcm_check_dt(struct device_node *np)
  286. {
  287. int i;
  288. int count;
  289. struct device_node *node;
  290. struct drm_panel *panel;
  291. count = of_count_phandle_with_args(np, "panel", NULL);
  292. if (count <= 0)
  293. return 0;
  294. for (i = 0; i < count; i++) {
  295. node = of_parse_phandle(np, "panel", i);
  296. panel = of_drm_find_panel(node);
  297. of_node_put(node);
  298. if (!IS_ERR(panel)) {
  299. active_tcm_panel = panel;
  300. return 0;
  301. }
  302. }
  303. return PTR_ERR(panel);
  304. }
  305. static int syna_tcm_check_default_tp(struct device_node *dt, const char *prop)
  306. {
  307. const char *active_tp;
  308. const char *compatible;
  309. char *start;
  310. int ret;
  311. ret = of_property_read_string(dt->parent, prop, &active_tp);
  312. if (ret) {
  313. pr_err(" %s:fail to read %s %d\n", __func__, prop, ret);
  314. return -ENODEV;
  315. }
  316. ret = of_property_read_string(dt, "compatible", &compatible);
  317. if (ret < 0) {
  318. pr_err(" %s:fail to read %s %d\n", __func__, "compatible", ret);
  319. return -ENODEV;
  320. }
  321. start = strnstr(active_tp, compatible, strlen(active_tp));
  322. if (start == NULL) {
  323. pr_err(" %s:no match compatible, %s, %s\n",
  324. __func__, compatible, active_tp);
  325. ret = -ENODEV;
  326. }
  327. return ret;
  328. }
  329. static int syna_tcm_i2c_probe(struct i2c_client *i2c,
  330. const struct i2c_device_id *dev_id)
  331. {
  332. int retval;
  333. struct device_node *dt = i2c->dev.of_node;
  334. retval = syna_tcm_check_dt(dt);
  335. if (retval == -EPROBE_DEFER)
  336. return retval;
  337. if (retval) {
  338. if (!syna_tcm_check_default_tp(dt, "qcom,i2c-touch-active"))
  339. retval = -EPROBE_DEFER;
  340. else
  341. retval = -ENODEV;
  342. return retval;
  343. }
  344. syna_tcm_i2c_device = platform_device_alloc(PLATFORM_DRIVER_NAME, 0);
  345. if (!syna_tcm_i2c_device) {
  346. LOGE(&i2c->dev,
  347. "Failed to allocate platform device\n");
  348. return -ENOMEM;
  349. }
  350. #ifdef CONFIG_OF
  351. hw_if.bdata = devm_kzalloc(&i2c->dev, sizeof(*hw_if.bdata), GFP_KERNEL);
  352. if (!hw_if.bdata) {
  353. LOGE(&i2c->dev,
  354. "Failed to allocate memory for board data\n");
  355. return -ENOMEM;
  356. }
  357. retval = parse_dt(&i2c->dev, hw_if.bdata);
  358. if (retval < 0) {
  359. LOGE(&i2c->dev, "Failed to parse dt\n");
  360. return retval;
  361. }
  362. #else
  363. hw_if.bdata = i2c->dev.platform_data;
  364. #endif
  365. bus_io.type = BUS_I2C;
  366. bus_io.read = syna_tcm_i2c_read;
  367. bus_io.write = syna_tcm_i2c_write;
  368. bus_io.rmi_read = syna_tcm_i2c_rmi_read;
  369. bus_io.rmi_write = syna_tcm_i2c_rmi_write;
  370. hw_if.bus_io = &bus_io;
  371. syna_tcm_i2c_device->dev.parent = &i2c->dev;
  372. syna_tcm_i2c_device->dev.platform_data = &hw_if;
  373. retval = platform_device_add(syna_tcm_i2c_device);
  374. if (retval < 0) {
  375. LOGE(&i2c->dev,
  376. "Failed to add platform device\n");
  377. return retval;
  378. }
  379. return 0;
  380. }
  381. static int syna_tcm_i2c_remove(struct i2c_client *i2c)
  382. {
  383. syna_tcm_i2c_device->dev.platform_data = NULL;
  384. platform_device_unregister(syna_tcm_i2c_device);
  385. return 0;
  386. }
  387. static const struct i2c_device_id syna_tcm_id_table[] = {
  388. {I2C_MODULE_NAME, 0},
  389. {},
  390. };
  391. MODULE_DEVICE_TABLE(i2c, syna_tcm_id_table);
  392. #ifdef CONFIG_OF
  393. static const struct of_device_id syna_tcm_of_match_table[] = {
  394. {
  395. .compatible = "synaptics,tcm-i2c",
  396. },
  397. {},
  398. };
  399. MODULE_DEVICE_TABLE(of, syna_tcm_of_match_table);
  400. #else
  401. #define syna_tcm_of_match_table NULL
  402. #endif
  403. static struct i2c_driver syna_tcm_i2c_driver = {
  404. .driver = {
  405. .name = I2C_MODULE_NAME,
  406. .owner = THIS_MODULE,
  407. .of_match_table = syna_tcm_of_match_table,
  408. },
  409. .probe = syna_tcm_i2c_probe,
  410. .remove = syna_tcm_i2c_remove,
  411. .id_table = syna_tcm_id_table,
  412. };
  413. int syna_tcm_bus_init(void)
  414. {
  415. return i2c_add_driver(&syna_tcm_i2c_driver);
  416. }
  417. EXPORT_SYMBOL(syna_tcm_bus_init);
  418. void syna_tcm_bus_exit(void)
  419. {
  420. kfree(buf);
  421. i2c_del_driver(&syna_tcm_i2c_driver);
  422. }
  423. EXPORT_SYMBOL(syna_tcm_bus_exit);
  424. MODULE_AUTHOR("Synaptics, Inc.");
  425. MODULE_DESCRIPTION("Synaptics TCM I2C Bus Module");
  426. MODULE_LICENSE("GPL v2");