uart.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Driver for NXP PN532 NFC Chip - UART transport layer
  4. *
  5. * Copyright (C) 2018 Lemonage Software GmbH
  6. * Author: Lars Pöschel <[email protected]>
  7. * All rights reserved.
  8. */
  9. #include <linux/device.h>
  10. #include <linux/kernel.h>
  11. #include <linux/module.h>
  12. #include <linux/nfc.h>
  13. #include <linux/netdevice.h>
  14. #include <linux/of.h>
  15. #include <linux/serdev.h>
  16. #include "pn533.h"
  17. #define PN532_UART_SKB_BUFF_LEN (PN533_CMD_DATAEXCH_DATA_MAXLEN * 2)
  18. enum send_wakeup {
  19. PN532_SEND_NO_WAKEUP = 0,
  20. PN532_SEND_WAKEUP,
  21. PN532_SEND_LAST_WAKEUP,
  22. };
  23. struct pn532_uart_phy {
  24. struct serdev_device *serdev;
  25. struct sk_buff *recv_skb;
  26. struct pn533 *priv;
  27. /*
  28. * send_wakeup variable is used to control if we need to send a wakeup
  29. * request to the pn532 chip prior to our actual command. There is a
  30. * little propability of a race condition. We decided to not mutex the
  31. * variable as the worst that could happen is, that we send a wakeup
  32. * to the chip that is already awake. This does not hurt. It is a
  33. * no-op to the chip.
  34. */
  35. enum send_wakeup send_wakeup;
  36. struct timer_list cmd_timeout;
  37. struct sk_buff *cur_out_buf;
  38. };
  39. static int pn532_uart_send_frame(struct pn533 *dev,
  40. struct sk_buff *out)
  41. {
  42. /* wakeup sequence and dummy bytes for waiting time */
  43. static const u8 wakeup[] = {
  44. 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  45. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
  46. struct pn532_uart_phy *pn532 = dev->phy;
  47. int err;
  48. print_hex_dump_debug("PN532_uart TX: ", DUMP_PREFIX_NONE, 16, 1,
  49. out->data, out->len, false);
  50. pn532->cur_out_buf = out;
  51. if (pn532->send_wakeup) {
  52. err = serdev_device_write(pn532->serdev,
  53. wakeup, sizeof(wakeup),
  54. MAX_SCHEDULE_TIMEOUT);
  55. if (err < 0)
  56. return err;
  57. }
  58. if (pn532->send_wakeup == PN532_SEND_LAST_WAKEUP)
  59. pn532->send_wakeup = PN532_SEND_NO_WAKEUP;
  60. err = serdev_device_write(pn532->serdev, out->data, out->len,
  61. MAX_SCHEDULE_TIMEOUT);
  62. if (err < 0)
  63. return err;
  64. mod_timer(&pn532->cmd_timeout, HZ / 40 + jiffies);
  65. return 0;
  66. }
  67. static int pn532_uart_send_ack(struct pn533 *dev, gfp_t flags)
  68. {
  69. /* spec 7.1.1.3: Preamble, SoPC (2), ACK Code (2), Postamble */
  70. static const u8 ack[PN533_STD_FRAME_ACK_SIZE] = {
  71. 0x00, 0x00, 0xff, 0x00, 0xff, 0x00};
  72. struct pn532_uart_phy *pn532 = dev->phy;
  73. int err;
  74. err = serdev_device_write(pn532->serdev, ack, sizeof(ack),
  75. MAX_SCHEDULE_TIMEOUT);
  76. if (err < 0)
  77. return err;
  78. return 0;
  79. }
  80. static void pn532_uart_abort_cmd(struct pn533 *dev, gfp_t flags)
  81. {
  82. /* An ack will cancel the last issued command */
  83. pn532_uart_send_ack(dev, flags);
  84. /* schedule cmd_complete_work to finish current command execution */
  85. pn533_recv_frame(dev, NULL, -ENOENT);
  86. }
  87. static int pn532_dev_up(struct pn533 *dev)
  88. {
  89. struct pn532_uart_phy *pn532 = dev->phy;
  90. int ret = 0;
  91. ret = serdev_device_open(pn532->serdev);
  92. if (ret)
  93. return ret;
  94. pn532->send_wakeup = PN532_SEND_LAST_WAKEUP;
  95. return ret;
  96. }
  97. static int pn532_dev_down(struct pn533 *dev)
  98. {
  99. struct pn532_uart_phy *pn532 = dev->phy;
  100. serdev_device_close(pn532->serdev);
  101. pn532->send_wakeup = PN532_SEND_WAKEUP;
  102. return 0;
  103. }
  104. static const struct pn533_phy_ops uart_phy_ops = {
  105. .send_frame = pn532_uart_send_frame,
  106. .send_ack = pn532_uart_send_ack,
  107. .abort_cmd = pn532_uart_abort_cmd,
  108. .dev_up = pn532_dev_up,
  109. .dev_down = pn532_dev_down,
  110. };
  111. static void pn532_cmd_timeout(struct timer_list *t)
  112. {
  113. struct pn532_uart_phy *dev = from_timer(dev, t, cmd_timeout);
  114. pn532_uart_send_frame(dev->priv, dev->cur_out_buf);
  115. }
  116. /*
  117. * scans the buffer if it contains a pn532 frame. It is not checked if the
  118. * frame is really valid. This is later done with pn533_rx_frame_is_valid.
  119. * This is useful for malformed or errornous transmitted frames. Adjusts the
  120. * bufferposition where the frame starts, since pn533_recv_frame expects a
  121. * well formed frame.
  122. */
  123. static int pn532_uart_rx_is_frame(struct sk_buff *skb)
  124. {
  125. struct pn533_std_frame *std;
  126. struct pn533_ext_frame *ext;
  127. u16 frame_len;
  128. int i;
  129. for (i = 0; i + PN533_STD_FRAME_ACK_SIZE <= skb->len; i++) {
  130. std = (struct pn533_std_frame *)&skb->data[i];
  131. /* search start code */
  132. if (std->start_frame != cpu_to_be16(PN533_STD_FRAME_SOF))
  133. continue;
  134. /* frame type */
  135. switch (std->datalen) {
  136. case PN533_FRAME_DATALEN_ACK:
  137. if (std->datalen_checksum == 0xff) {
  138. skb_pull(skb, i);
  139. return 1;
  140. }
  141. break;
  142. case PN533_FRAME_DATALEN_ERROR:
  143. if ((std->datalen_checksum == 0xff) &&
  144. (skb->len >=
  145. PN533_STD_ERROR_FRAME_SIZE)) {
  146. skb_pull(skb, i);
  147. return 1;
  148. }
  149. break;
  150. case PN533_FRAME_DATALEN_EXTENDED:
  151. ext = (struct pn533_ext_frame *)&skb->data[i];
  152. frame_len = be16_to_cpu(ext->datalen);
  153. if (skb->len >= frame_len +
  154. sizeof(struct pn533_ext_frame) +
  155. 2 /* CKS + Postamble */) {
  156. skb_pull(skb, i);
  157. return 1;
  158. }
  159. break;
  160. default: /* normal information frame */
  161. frame_len = std->datalen;
  162. if (skb->len >= frame_len +
  163. sizeof(struct pn533_std_frame) +
  164. 2 /* CKS + Postamble */) {
  165. skb_pull(skb, i);
  166. return 1;
  167. }
  168. break;
  169. }
  170. }
  171. return 0;
  172. }
  173. static int pn532_receive_buf(struct serdev_device *serdev,
  174. const unsigned char *data, size_t count)
  175. {
  176. struct pn532_uart_phy *dev = serdev_device_get_drvdata(serdev);
  177. size_t i;
  178. del_timer(&dev->cmd_timeout);
  179. for (i = 0; i < count; i++) {
  180. skb_put_u8(dev->recv_skb, *data++);
  181. if (!pn532_uart_rx_is_frame(dev->recv_skb))
  182. continue;
  183. pn533_recv_frame(dev->priv, dev->recv_skb, 0);
  184. dev->recv_skb = alloc_skb(PN532_UART_SKB_BUFF_LEN, GFP_KERNEL);
  185. if (!dev->recv_skb)
  186. return 0;
  187. }
  188. return i;
  189. }
  190. static const struct serdev_device_ops pn532_serdev_ops = {
  191. .receive_buf = pn532_receive_buf,
  192. .write_wakeup = serdev_device_write_wakeup,
  193. };
  194. static const struct of_device_id pn532_uart_of_match[] = {
  195. { .compatible = "nxp,pn532", },
  196. {},
  197. };
  198. MODULE_DEVICE_TABLE(of, pn532_uart_of_match);
  199. static int pn532_uart_probe(struct serdev_device *serdev)
  200. {
  201. struct pn532_uart_phy *pn532;
  202. struct pn533 *priv;
  203. int err;
  204. err = -ENOMEM;
  205. pn532 = kzalloc(sizeof(*pn532), GFP_KERNEL);
  206. if (!pn532)
  207. goto err_exit;
  208. pn532->recv_skb = alloc_skb(PN532_UART_SKB_BUFF_LEN, GFP_KERNEL);
  209. if (!pn532->recv_skb)
  210. goto err_free;
  211. pn532->serdev = serdev;
  212. serdev_device_set_drvdata(serdev, pn532);
  213. serdev_device_set_client_ops(serdev, &pn532_serdev_ops);
  214. err = serdev_device_open(serdev);
  215. if (err) {
  216. dev_err(&serdev->dev, "Unable to open device\n");
  217. goto err_skb;
  218. }
  219. err = serdev_device_set_baudrate(serdev, 115200);
  220. if (err != 115200) {
  221. err = -EINVAL;
  222. goto err_serdev;
  223. }
  224. serdev_device_set_flow_control(serdev, false);
  225. pn532->send_wakeup = PN532_SEND_WAKEUP;
  226. timer_setup(&pn532->cmd_timeout, pn532_cmd_timeout, 0);
  227. priv = pn53x_common_init(PN533_DEVICE_PN532_AUTOPOLL,
  228. PN533_PROTO_REQ_ACK_RESP,
  229. pn532, &uart_phy_ops, NULL,
  230. &pn532->serdev->dev);
  231. if (IS_ERR(priv)) {
  232. err = PTR_ERR(priv);
  233. goto err_serdev;
  234. }
  235. pn532->priv = priv;
  236. err = pn533_finalize_setup(pn532->priv);
  237. if (err)
  238. goto err_clean;
  239. serdev_device_close(serdev);
  240. err = pn53x_register_nfc(priv, PN533_NO_TYPE_B_PROTOCOLS, &serdev->dev);
  241. if (err) {
  242. pn53x_common_clean(pn532->priv);
  243. goto err_skb;
  244. }
  245. return err;
  246. err_clean:
  247. pn53x_common_clean(pn532->priv);
  248. err_serdev:
  249. serdev_device_close(serdev);
  250. err_skb:
  251. kfree_skb(pn532->recv_skb);
  252. err_free:
  253. kfree(pn532);
  254. err_exit:
  255. return err;
  256. }
  257. static void pn532_uart_remove(struct serdev_device *serdev)
  258. {
  259. struct pn532_uart_phy *pn532 = serdev_device_get_drvdata(serdev);
  260. pn53x_unregister_nfc(pn532->priv);
  261. serdev_device_close(serdev);
  262. pn53x_common_clean(pn532->priv);
  263. del_timer_sync(&pn532->cmd_timeout);
  264. kfree_skb(pn532->recv_skb);
  265. kfree(pn532);
  266. }
  267. static struct serdev_device_driver pn532_uart_driver = {
  268. .probe = pn532_uart_probe,
  269. .remove = pn532_uart_remove,
  270. .driver = {
  271. .name = "pn532_uart",
  272. .of_match_table = pn532_uart_of_match,
  273. },
  274. };
  275. module_serdev_device_driver(pn532_uart_driver);
  276. MODULE_AUTHOR("Lars Pöschel <[email protected]>");
  277. MODULE_DESCRIPTION("PN532 UART driver");
  278. MODULE_LICENSE("GPL");