navpoint.c 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Synaptics NavPoint (PXA27x SSP/SPI) driver.
  4. *
  5. * Copyright (C) 2012 Paul Parsons <lost.distance@yahoo.com>
  6. */
  7. #include <linux/kernel.h>
  8. #include <linux/module.h>
  9. #include <linux/platform_device.h>
  10. #include <linux/clk.h>
  11. #include <linux/delay.h>
  12. #include <linux/gpio.h>
  13. #include <linux/input.h>
  14. #include <linux/input/navpoint.h>
  15. #include <linux/interrupt.h>
  16. #include <linux/mutex.h>
  17. #include <linux/pxa2xx_ssp.h>
  18. #include <linux/slab.h>
  19. /*
  20. * Synaptics Modular Embedded Protocol: Module Packet Format.
  21. * Module header byte 2:0 = Length (# bytes that follow)
  22. * Module header byte 4:3 = Control
  23. * Module header byte 7:5 = Module Address
  24. */
  25. #define HEADER_LENGTH(byte) ((byte) & 0x07)
  26. #define HEADER_CONTROL(byte) (((byte) >> 3) & 0x03)
  27. #define HEADER_ADDRESS(byte) ((byte) >> 5)
  28. struct navpoint {
  29. struct ssp_device *ssp;
  30. struct input_dev *input;
  31. struct device *dev;
  32. int gpio;
  33. int index;
  34. u8 data[1 + HEADER_LENGTH(0xff)];
  35. };
  36. /*
  37. * Initialization values for SSCR0_x, SSCR1_x, SSSR_x.
  38. */
  39. static const u32 sscr0 = 0
  40. | SSCR0_TUM /* TIM = 1; No TUR interrupts */
  41. | SSCR0_RIM /* RIM = 1; No ROR interrupts */
  42. | SSCR0_SSE /* SSE = 1; SSP enabled */
  43. | SSCR0_Motorola /* FRF = 0; Motorola SPI */
  44. | SSCR0_DataSize(16) /* DSS = 15; Data size = 16-bit */
  45. ;
  46. static const u32 sscr1 = 0
  47. | SSCR1_SCFR /* SCFR = 1; SSPSCLK only during transfers */
  48. | SSCR1_SCLKDIR /* SCLKDIR = 1; Slave mode */
  49. | SSCR1_SFRMDIR /* SFRMDIR = 1; Slave mode */
  50. | SSCR1_RWOT /* RWOT = 1; Receive without transmit mode */
  51. | SSCR1_RxTresh(1) /* RFT = 0; Receive FIFO threshold = 1 */
  52. | SSCR1_SPH /* SPH = 1; SSPSCLK inactive 0.5 + 1 cycles */
  53. | SSCR1_RIE /* RIE = 1; Receive FIFO interrupt enabled */
  54. ;
  55. static const u32 sssr = 0
  56. | SSSR_BCE /* BCE = 1; Clear BCE */
  57. | SSSR_TUR /* TUR = 1; Clear TUR */
  58. | SSSR_EOC /* EOC = 1; Clear EOC */
  59. | SSSR_TINT /* TINT = 1; Clear TINT */
  60. | SSSR_PINT /* PINT = 1; Clear PINT */
  61. | SSSR_ROR /* ROR = 1; Clear ROR */
  62. ;
  63. /*
  64. * MEP Query $22: Touchpad Coordinate Range Query is not supported by
  65. * the NavPoint module, so sampled values provide the default limits.
  66. */
  67. #define NAVPOINT_X_MIN 1278
  68. #define NAVPOINT_X_MAX 5340
  69. #define NAVPOINT_Y_MIN 1572
  70. #define NAVPOINT_Y_MAX 4396
  71. #define NAVPOINT_PRESSURE_MIN 0
  72. #define NAVPOINT_PRESSURE_MAX 255
  73. static void navpoint_packet(struct navpoint *navpoint)
  74. {
  75. int finger;
  76. int gesture;
  77. int x, y, z;
  78. switch (navpoint->data[0]) {
  79. case 0xff: /* Garbage (packet?) between reset and Hello packet */
  80. case 0x00: /* Module 0, NULL packet */
  81. break;
  82. case 0x0e: /* Module 0, Absolute packet */
  83. finger = (navpoint->data[1] & 0x01);
  84. gesture = (navpoint->data[1] & 0x02);
  85. x = ((navpoint->data[2] & 0x1f) << 8) | navpoint->data[3];
  86. y = ((navpoint->data[4] & 0x1f) << 8) | navpoint->data[5];
  87. z = navpoint->data[6];
  88. input_report_key(navpoint->input, BTN_TOUCH, finger);
  89. input_report_abs(navpoint->input, ABS_X, x);
  90. input_report_abs(navpoint->input, ABS_Y, y);
  91. input_report_abs(navpoint->input, ABS_PRESSURE, z);
  92. input_report_key(navpoint->input, BTN_TOOL_FINGER, finger);
  93. input_report_key(navpoint->input, BTN_LEFT, gesture);
  94. input_sync(navpoint->input);
  95. break;
  96. case 0x19: /* Module 0, Hello packet */
  97. if ((navpoint->data[1] & 0xf0) == 0x10)
  98. break;
  99. fallthrough;
  100. default:
  101. dev_warn(navpoint->dev,
  102. "spurious packet: data=0x%02x,0x%02x,...\n",
  103. navpoint->data[0], navpoint->data[1]);
  104. break;
  105. }
  106. }
  107. static irqreturn_t navpoint_irq(int irq, void *dev_id)
  108. {
  109. struct navpoint *navpoint = dev_id;
  110. struct ssp_device *ssp = navpoint->ssp;
  111. irqreturn_t ret = IRQ_NONE;
  112. u32 status;
  113. status = pxa_ssp_read_reg(ssp, SSSR);
  114. if (status & sssr) {
  115. dev_warn(navpoint->dev,
  116. "unexpected interrupt: status=0x%08x\n", status);
  117. pxa_ssp_write_reg(ssp, SSSR, (status & sssr));
  118. ret = IRQ_HANDLED;
  119. }
  120. while (status & SSSR_RNE) {
  121. u32 data;
  122. data = pxa_ssp_read_reg(ssp, SSDR);
  123. navpoint->data[navpoint->index + 0] = (data >> 8);
  124. navpoint->data[navpoint->index + 1] = data;
  125. navpoint->index += 2;
  126. if (HEADER_LENGTH(navpoint->data[0]) < navpoint->index) {
  127. navpoint_packet(navpoint);
  128. navpoint->index = 0;
  129. }
  130. status = pxa_ssp_read_reg(ssp, SSSR);
  131. ret = IRQ_HANDLED;
  132. }
  133. return ret;
  134. }
  135. static void navpoint_up(struct navpoint *navpoint)
  136. {
  137. struct ssp_device *ssp = navpoint->ssp;
  138. int timeout;
  139. clk_prepare_enable(ssp->clk);
  140. pxa_ssp_write_reg(ssp, SSCR1, sscr1);
  141. pxa_ssp_write_reg(ssp, SSSR, sssr);
  142. pxa_ssp_write_reg(ssp, SSTO, 0);
  143. pxa_ssp_write_reg(ssp, SSCR0, sscr0); /* SSCR0_SSE written last */
  144. /* Wait until SSP port is ready for slave clock operations */
  145. for (timeout = 100; timeout != 0; --timeout) {
  146. if (!(pxa_ssp_read_reg(ssp, SSSR) & SSSR_CSS))
  147. break;
  148. msleep(1);
  149. }
  150. if (timeout == 0)
  151. dev_err(navpoint->dev,
  152. "timeout waiting for SSSR[CSS] to clear\n");
  153. if (gpio_is_valid(navpoint->gpio))
  154. gpio_set_value(navpoint->gpio, 1);
  155. }
  156. static void navpoint_down(struct navpoint *navpoint)
  157. {
  158. struct ssp_device *ssp = navpoint->ssp;
  159. if (gpio_is_valid(navpoint->gpio))
  160. gpio_set_value(navpoint->gpio, 0);
  161. pxa_ssp_write_reg(ssp, SSCR0, 0);
  162. clk_disable_unprepare(ssp->clk);
  163. }
  164. static int navpoint_open(struct input_dev *input)
  165. {
  166. struct navpoint *navpoint = input_get_drvdata(input);
  167. navpoint_up(navpoint);
  168. return 0;
  169. }
  170. static void navpoint_close(struct input_dev *input)
  171. {
  172. struct navpoint *navpoint = input_get_drvdata(input);
  173. navpoint_down(navpoint);
  174. }
  175. static int navpoint_probe(struct platform_device *pdev)
  176. {
  177. const struct navpoint_platform_data *pdata =
  178. dev_get_platdata(&pdev->dev);
  179. struct ssp_device *ssp;
  180. struct input_dev *input;
  181. struct navpoint *navpoint;
  182. int error;
  183. if (!pdata) {
  184. dev_err(&pdev->dev, "no platform data\n");
  185. return -EINVAL;
  186. }
  187. if (gpio_is_valid(pdata->gpio)) {
  188. error = gpio_request_one(pdata->gpio, GPIOF_OUT_INIT_LOW,
  189. "SYNAPTICS_ON");
  190. if (error)
  191. return error;
  192. }
  193. ssp = pxa_ssp_request(pdata->port, pdev->name);
  194. if (!ssp) {
  195. error = -ENODEV;
  196. goto err_free_gpio;
  197. }
  198. /* HaRET does not disable devices before jumping into Linux */
  199. if (pxa_ssp_read_reg(ssp, SSCR0) & SSCR0_SSE) {
  200. pxa_ssp_write_reg(ssp, SSCR0, 0);
  201. dev_warn(&pdev->dev, "ssp%d already enabled\n", pdata->port);
  202. }
  203. navpoint = kzalloc(sizeof(*navpoint), GFP_KERNEL);
  204. input = input_allocate_device();
  205. if (!navpoint || !input) {
  206. error = -ENOMEM;
  207. goto err_free_mem;
  208. }
  209. navpoint->ssp = ssp;
  210. navpoint->input = input;
  211. navpoint->dev = &pdev->dev;
  212. navpoint->gpio = pdata->gpio;
  213. input->name = pdev->name;
  214. input->dev.parent = &pdev->dev;
  215. __set_bit(EV_KEY, input->evbit);
  216. __set_bit(EV_ABS, input->evbit);
  217. __set_bit(BTN_LEFT, input->keybit);
  218. __set_bit(BTN_TOUCH, input->keybit);
  219. __set_bit(BTN_TOOL_FINGER, input->keybit);
  220. input_set_abs_params(input, ABS_X,
  221. NAVPOINT_X_MIN, NAVPOINT_X_MAX, 0, 0);
  222. input_set_abs_params(input, ABS_Y,
  223. NAVPOINT_Y_MIN, NAVPOINT_Y_MAX, 0, 0);
  224. input_set_abs_params(input, ABS_PRESSURE,
  225. NAVPOINT_PRESSURE_MIN, NAVPOINT_PRESSURE_MAX,
  226. 0, 0);
  227. input->open = navpoint_open;
  228. input->close = navpoint_close;
  229. input_set_drvdata(input, navpoint);
  230. error = request_irq(ssp->irq, navpoint_irq, 0, pdev->name, navpoint);
  231. if (error)
  232. goto err_free_mem;
  233. error = input_register_device(input);
  234. if (error)
  235. goto err_free_irq;
  236. platform_set_drvdata(pdev, navpoint);
  237. dev_dbg(&pdev->dev, "ssp%d, irq %d\n", pdata->port, ssp->irq);
  238. return 0;
  239. err_free_irq:
  240. free_irq(ssp->irq, navpoint);
  241. err_free_mem:
  242. input_free_device(input);
  243. kfree(navpoint);
  244. pxa_ssp_free(ssp);
  245. err_free_gpio:
  246. if (gpio_is_valid(pdata->gpio))
  247. gpio_free(pdata->gpio);
  248. return error;
  249. }
  250. static int navpoint_remove(struct platform_device *pdev)
  251. {
  252. const struct navpoint_platform_data *pdata =
  253. dev_get_platdata(&pdev->dev);
  254. struct navpoint *navpoint = platform_get_drvdata(pdev);
  255. struct ssp_device *ssp = navpoint->ssp;
  256. free_irq(ssp->irq, navpoint);
  257. input_unregister_device(navpoint->input);
  258. kfree(navpoint);
  259. pxa_ssp_free(ssp);
  260. if (gpio_is_valid(pdata->gpio))
  261. gpio_free(pdata->gpio);
  262. return 0;
  263. }
  264. static int __maybe_unused navpoint_suspend(struct device *dev)
  265. {
  266. struct platform_device *pdev = to_platform_device(dev);
  267. struct navpoint *navpoint = platform_get_drvdata(pdev);
  268. struct input_dev *input = navpoint->input;
  269. mutex_lock(&input->mutex);
  270. if (input->users)
  271. navpoint_down(navpoint);
  272. mutex_unlock(&input->mutex);
  273. return 0;
  274. }
  275. static int __maybe_unused navpoint_resume(struct device *dev)
  276. {
  277. struct platform_device *pdev = to_platform_device(dev);
  278. struct navpoint *navpoint = platform_get_drvdata(pdev);
  279. struct input_dev *input = navpoint->input;
  280. mutex_lock(&input->mutex);
  281. if (input->users)
  282. navpoint_up(navpoint);
  283. mutex_unlock(&input->mutex);
  284. return 0;
  285. }
  286. static SIMPLE_DEV_PM_OPS(navpoint_pm_ops, navpoint_suspend, navpoint_resume);
  287. static struct platform_driver navpoint_driver = {
  288. .probe = navpoint_probe,
  289. .remove = navpoint_remove,
  290. .driver = {
  291. .name = "navpoint",
  292. .pm = &navpoint_pm_ops,
  293. },
  294. };
  295. module_platform_driver(navpoint_driver);
  296. MODULE_AUTHOR("Paul Parsons <lost.distance@yahoo.com>");
  297. MODULE_DESCRIPTION("Synaptics NavPoint (PXA27x SSP/SPI) driver");
  298. MODULE_LICENSE("GPL");
  299. MODULE_ALIAS("platform:navpoint");