mei_phy.c 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Copyright (c) 2013, Intel Corporation.
  4. *
  5. * MEI Library for mei bus nfc device access
  6. */
  7. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  8. #include <linux/module.h>
  9. #include <linux/slab.h>
  10. #include <linux/nfc.h>
  11. #include "mei_phy.h"
  12. struct mei_nfc_hdr {
  13. u8 cmd;
  14. u8 status;
  15. u16 req_id;
  16. u32 reserved;
  17. u16 data_size;
  18. } __packed;
  19. struct mei_nfc_cmd {
  20. struct mei_nfc_hdr hdr;
  21. u8 sub_command;
  22. u8 data[];
  23. } __packed;
  24. struct mei_nfc_reply {
  25. struct mei_nfc_hdr hdr;
  26. u8 sub_command;
  27. u8 reply_status;
  28. u8 data[];
  29. } __packed;
  30. struct mei_nfc_if_version {
  31. u8 radio_version_sw[3];
  32. u8 reserved[3];
  33. u8 radio_version_hw[3];
  34. u8 i2c_addr;
  35. u8 fw_ivn;
  36. u8 vendor_id;
  37. u8 radio_type;
  38. } __packed;
  39. struct mei_nfc_connect {
  40. u8 fw_ivn;
  41. u8 vendor_id;
  42. } __packed;
  43. struct mei_nfc_connect_resp {
  44. u8 fw_ivn;
  45. u8 vendor_id;
  46. u16 me_major;
  47. u16 me_minor;
  48. u16 me_hotfix;
  49. u16 me_build;
  50. } __packed;
  51. #define MEI_NFC_CMD_MAINTENANCE 0x00
  52. #define MEI_NFC_CMD_HCI_SEND 0x01
  53. #define MEI_NFC_CMD_HCI_RECV 0x02
  54. #define MEI_NFC_SUBCMD_CONNECT 0x00
  55. #define MEI_NFC_SUBCMD_IF_VERSION 0x01
  56. #define MEI_NFC_MAX_READ (MEI_NFC_HEADER_SIZE + MEI_NFC_MAX_HCI_PAYLOAD)
  57. #define MEI_DUMP_SKB_IN(info, skb) \
  58. do { \
  59. pr_debug("%s:\n", info); \
  60. print_hex_dump_debug("mei in : ", DUMP_PREFIX_OFFSET, \
  61. 16, 1, (skb)->data, (skb)->len, false); \
  62. } while (0)
  63. #define MEI_DUMP_SKB_OUT(info, skb) \
  64. do { \
  65. pr_debug("%s:\n", info); \
  66. print_hex_dump_debug("mei out: ", DUMP_PREFIX_OFFSET, \
  67. 16, 1, (skb)->data, (skb)->len, false); \
  68. } while (0)
  69. #define MEI_DUMP_NFC_HDR(info, _hdr) \
  70. do { \
  71. pr_debug("%s:\n", info); \
  72. pr_debug("cmd=%02d status=%d req_id=%d rsvd=%d size=%d\n", \
  73. (_hdr)->cmd, (_hdr)->status, (_hdr)->req_id, \
  74. (_hdr)->reserved, (_hdr)->data_size); \
  75. } while (0)
  76. static int mei_nfc_if_version(struct nfc_mei_phy *phy)
  77. {
  78. struct mei_nfc_cmd cmd;
  79. struct mei_nfc_reply *reply = NULL;
  80. struct mei_nfc_if_version *version;
  81. size_t if_version_length;
  82. int bytes_recv, r;
  83. memset(&cmd, 0, sizeof(struct mei_nfc_cmd));
  84. cmd.hdr.cmd = MEI_NFC_CMD_MAINTENANCE;
  85. cmd.hdr.data_size = 1;
  86. cmd.sub_command = MEI_NFC_SUBCMD_IF_VERSION;
  87. MEI_DUMP_NFC_HDR("version", &cmd.hdr);
  88. r = mei_cldev_send(phy->cldev, (u8 *)&cmd, sizeof(struct mei_nfc_cmd));
  89. if (r < 0) {
  90. pr_err("Could not send IF version cmd\n");
  91. return r;
  92. }
  93. /* to be sure on the stack we alloc memory */
  94. if_version_length = sizeof(struct mei_nfc_reply) +
  95. sizeof(struct mei_nfc_if_version);
  96. reply = kzalloc(if_version_length, GFP_KERNEL);
  97. if (!reply)
  98. return -ENOMEM;
  99. bytes_recv = mei_cldev_recv(phy->cldev, (u8 *)reply, if_version_length);
  100. if (bytes_recv < 0 || bytes_recv < if_version_length) {
  101. pr_err("Could not read IF version\n");
  102. r = -EIO;
  103. goto err;
  104. }
  105. version = (struct mei_nfc_if_version *)reply->data;
  106. phy->fw_ivn = version->fw_ivn;
  107. phy->vendor_id = version->vendor_id;
  108. phy->radio_type = version->radio_type;
  109. err:
  110. kfree(reply);
  111. return r;
  112. }
  113. static int mei_nfc_connect(struct nfc_mei_phy *phy)
  114. {
  115. struct mei_nfc_cmd *cmd, *reply;
  116. struct mei_nfc_connect *connect;
  117. struct mei_nfc_connect_resp *connect_resp;
  118. size_t connect_length, connect_resp_length;
  119. int bytes_recv, r;
  120. connect_length = sizeof(struct mei_nfc_cmd) +
  121. sizeof(struct mei_nfc_connect);
  122. connect_resp_length = sizeof(struct mei_nfc_cmd) +
  123. sizeof(struct mei_nfc_connect_resp);
  124. cmd = kzalloc(connect_length, GFP_KERNEL);
  125. if (!cmd)
  126. return -ENOMEM;
  127. connect = (struct mei_nfc_connect *)cmd->data;
  128. reply = kzalloc(connect_resp_length, GFP_KERNEL);
  129. if (!reply) {
  130. kfree(cmd);
  131. return -ENOMEM;
  132. }
  133. connect_resp = (struct mei_nfc_connect_resp *)reply->data;
  134. cmd->hdr.cmd = MEI_NFC_CMD_MAINTENANCE;
  135. cmd->hdr.data_size = 3;
  136. cmd->sub_command = MEI_NFC_SUBCMD_CONNECT;
  137. connect->fw_ivn = phy->fw_ivn;
  138. connect->vendor_id = phy->vendor_id;
  139. MEI_DUMP_NFC_HDR("connect request", &cmd->hdr);
  140. r = mei_cldev_send(phy->cldev, (u8 *)cmd, connect_length);
  141. if (r < 0) {
  142. pr_err("Could not send connect cmd %d\n", r);
  143. goto err;
  144. }
  145. bytes_recv = mei_cldev_recv(phy->cldev, (u8 *)reply,
  146. connect_resp_length);
  147. if (bytes_recv < 0) {
  148. r = bytes_recv;
  149. pr_err("Could not read connect response %d\n", r);
  150. goto err;
  151. }
  152. MEI_DUMP_NFC_HDR("connect reply", &reply->hdr);
  153. pr_info("IVN 0x%x Vendor ID 0x%x\n",
  154. connect_resp->fw_ivn, connect_resp->vendor_id);
  155. pr_info("ME FW %d.%d.%d.%d\n",
  156. connect_resp->me_major, connect_resp->me_minor,
  157. connect_resp->me_hotfix, connect_resp->me_build);
  158. r = 0;
  159. err:
  160. kfree(reply);
  161. kfree(cmd);
  162. return r;
  163. }
  164. static int mei_nfc_send(struct nfc_mei_phy *phy, const u8 *buf, size_t length)
  165. {
  166. struct mei_nfc_hdr *hdr;
  167. u8 *mei_buf;
  168. int err;
  169. err = -ENOMEM;
  170. mei_buf = kzalloc(length + MEI_NFC_HEADER_SIZE, GFP_KERNEL);
  171. if (!mei_buf)
  172. goto out;
  173. hdr = (struct mei_nfc_hdr *)mei_buf;
  174. hdr->cmd = MEI_NFC_CMD_HCI_SEND;
  175. hdr->status = 0;
  176. hdr->req_id = phy->req_id;
  177. hdr->reserved = 0;
  178. hdr->data_size = length;
  179. MEI_DUMP_NFC_HDR("send", hdr);
  180. memcpy(mei_buf + MEI_NFC_HEADER_SIZE, buf, length);
  181. err = mei_cldev_send(phy->cldev, mei_buf, length + MEI_NFC_HEADER_SIZE);
  182. if (err < 0)
  183. goto out;
  184. if (!wait_event_interruptible_timeout(phy->send_wq,
  185. phy->recv_req_id == phy->req_id, HZ)) {
  186. pr_err("NFC MEI command timeout\n");
  187. err = -ETIME;
  188. } else {
  189. phy->req_id++;
  190. }
  191. out:
  192. kfree(mei_buf);
  193. return err;
  194. }
  195. /*
  196. * Writing a frame must not return the number of written bytes.
  197. * It must return either zero for success, or <0 for error.
  198. * In addition, it must not alter the skb
  199. */
  200. static int nfc_mei_phy_write(void *phy_id, struct sk_buff *skb)
  201. {
  202. struct nfc_mei_phy *phy = phy_id;
  203. int r;
  204. MEI_DUMP_SKB_OUT("mei frame sent", skb);
  205. r = mei_nfc_send(phy, skb->data, skb->len);
  206. if (r > 0)
  207. r = 0;
  208. return r;
  209. }
  210. static int mei_nfc_recv(struct nfc_mei_phy *phy, u8 *buf, size_t length)
  211. {
  212. struct mei_nfc_hdr *hdr;
  213. int received_length;
  214. received_length = mei_cldev_recv(phy->cldev, buf, length);
  215. if (received_length < 0)
  216. return received_length;
  217. hdr = (struct mei_nfc_hdr *) buf;
  218. MEI_DUMP_NFC_HDR("receive", hdr);
  219. if (hdr->cmd == MEI_NFC_CMD_HCI_SEND) {
  220. phy->recv_req_id = hdr->req_id;
  221. wake_up(&phy->send_wq);
  222. return 0;
  223. }
  224. return received_length;
  225. }
  226. static void nfc_mei_rx_cb(struct mei_cl_device *cldev)
  227. {
  228. struct nfc_mei_phy *phy = mei_cldev_get_drvdata(cldev);
  229. struct sk_buff *skb;
  230. int reply_size;
  231. if (!phy)
  232. return;
  233. if (phy->hard_fault != 0)
  234. return;
  235. skb = alloc_skb(MEI_NFC_MAX_READ, GFP_KERNEL);
  236. if (!skb)
  237. return;
  238. reply_size = mei_nfc_recv(phy, skb->data, MEI_NFC_MAX_READ);
  239. if (reply_size < MEI_NFC_HEADER_SIZE) {
  240. kfree_skb(skb);
  241. return;
  242. }
  243. skb_put(skb, reply_size);
  244. skb_pull(skb, MEI_NFC_HEADER_SIZE);
  245. MEI_DUMP_SKB_IN("mei frame read", skb);
  246. nfc_hci_recv_frame(phy->hdev, skb);
  247. }
  248. static int nfc_mei_phy_enable(void *phy_id)
  249. {
  250. int r;
  251. struct nfc_mei_phy *phy = phy_id;
  252. if (phy->powered == 1)
  253. return 0;
  254. r = mei_cldev_enable(phy->cldev);
  255. if (r < 0) {
  256. pr_err("Could not enable device %d\n", r);
  257. return r;
  258. }
  259. r = mei_nfc_if_version(phy);
  260. if (r < 0) {
  261. pr_err("Could not enable device %d\n", r);
  262. goto err;
  263. }
  264. r = mei_nfc_connect(phy);
  265. if (r < 0) {
  266. pr_err("Could not connect to device %d\n", r);
  267. goto err;
  268. }
  269. r = mei_cldev_register_rx_cb(phy->cldev, nfc_mei_rx_cb);
  270. if (r) {
  271. pr_err("Event cb registration failed %d\n", r);
  272. goto err;
  273. }
  274. phy->powered = 1;
  275. return 0;
  276. err:
  277. phy->powered = 0;
  278. mei_cldev_disable(phy->cldev);
  279. return r;
  280. }
  281. static void nfc_mei_phy_disable(void *phy_id)
  282. {
  283. struct nfc_mei_phy *phy = phy_id;
  284. mei_cldev_disable(phy->cldev);
  285. phy->powered = 0;
  286. }
  287. const struct nfc_phy_ops mei_phy_ops = {
  288. .write = nfc_mei_phy_write,
  289. .enable = nfc_mei_phy_enable,
  290. .disable = nfc_mei_phy_disable,
  291. };
  292. EXPORT_SYMBOL_GPL(mei_phy_ops);
  293. struct nfc_mei_phy *nfc_mei_phy_alloc(struct mei_cl_device *cldev)
  294. {
  295. struct nfc_mei_phy *phy;
  296. phy = kzalloc(sizeof(struct nfc_mei_phy), GFP_KERNEL);
  297. if (!phy)
  298. return NULL;
  299. phy->cldev = cldev;
  300. init_waitqueue_head(&phy->send_wq);
  301. mei_cldev_set_drvdata(cldev, phy);
  302. return phy;
  303. }
  304. EXPORT_SYMBOL_GPL(nfc_mei_phy_alloc);
  305. void nfc_mei_phy_free(struct nfc_mei_phy *phy)
  306. {
  307. mei_cldev_disable(phy->cldev);
  308. kfree(phy);
  309. }
  310. EXPORT_SYMBOL_GPL(nfc_mei_phy_free);
  311. MODULE_LICENSE("GPL");
  312. MODULE_DESCRIPTION("mei bus NFC device interface");