1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * Driver for NXP PN533 NFC Chip - USB transport layer
4 *
5 * Copyright (C) 2011 Instituto Nokia de Tecnologia
6 * Copyright (C) 2012-2013 Tieto Poland
7 */
8
9 #include <linux/device.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/slab.h>
13 #include <linux/usb.h>
14 #include <linux/nfc.h>
15 #include <linux/netdevice.h>
16 #include <net/nfc/nfc.h>
17 #include "pn533.h"
18
19 #define VERSION "0.1"
20
21 #define PN533_VENDOR_ID 0x4CC
22 #define PN533_PRODUCT_ID 0x2533
23
24 #define SCM_VENDOR_ID 0x4E6
25 #define SCL3711_PRODUCT_ID 0x5591
26
27 #define SONY_VENDOR_ID 0x054c
28 #define PASORI_PRODUCT_ID 0x02e1
29
30 #define ACS_VENDOR_ID 0x072f
31 #define ACR122U_PRODUCT_ID 0x2200
32
33 static const struct usb_device_id pn533_usb_table[] = {
34 { USB_DEVICE(PN533_VENDOR_ID, PN533_PRODUCT_ID),
35 .driver_info = PN533_DEVICE_STD },
36 { USB_DEVICE(SCM_VENDOR_ID, SCL3711_PRODUCT_ID),
37 .driver_info = PN533_DEVICE_STD },
38 { USB_DEVICE(SONY_VENDOR_ID, PASORI_PRODUCT_ID),
39 .driver_info = PN533_DEVICE_PASORI },
40 { USB_DEVICE(ACS_VENDOR_ID, ACR122U_PRODUCT_ID),
41 .driver_info = PN533_DEVICE_ACR122U },
42 { }
43 };
44 MODULE_DEVICE_TABLE(usb, pn533_usb_table);
45
46 struct pn533_usb_phy {
47 struct usb_device *udev;
48 struct usb_interface *interface;
49
50 struct urb *out_urb;
51 struct urb *in_urb;
52
53 struct urb *ack_urb;
54 u8 *ack_buffer;
55
56 struct pn533 *priv;
57 };
58
pn533_recv_response(struct urb * urb)59 static void pn533_recv_response(struct urb *urb)
60 {
61 struct pn533_usb_phy *phy = urb->context;
62 struct sk_buff *skb = NULL;
63
64 if (!urb->status) {
65 skb = alloc_skb(urb->actual_length, GFP_ATOMIC);
66 if (!skb) {
67 nfc_err(&phy->udev->dev, "failed to alloc memory\n");
68 } else {
69 skb_put_data(skb, urb->transfer_buffer,
70 urb->actual_length);
71 }
72 }
73
74 pn533_recv_frame(phy->priv, skb, urb->status);
75 }
76
pn533_submit_urb_for_response(struct pn533_usb_phy * phy,gfp_t flags)77 static int pn533_submit_urb_for_response(struct pn533_usb_phy *phy, gfp_t flags)
78 {
79 phy->in_urb->complete = pn533_recv_response;
80
81 return usb_submit_urb(phy->in_urb, flags);
82 }
83
pn533_recv_ack(struct urb * urb)84 static void pn533_recv_ack(struct urb *urb)
85 {
86 struct pn533_usb_phy *phy = urb->context;
87 struct pn533 *priv = phy->priv;
88 struct pn533_cmd *cmd = priv->cmd;
89 struct pn533_std_frame *in_frame;
90 int rc;
91
92 cmd->status = urb->status;
93
94 switch (urb->status) {
95 case 0:
96 break; /* success */
97 case -ECONNRESET:
98 case -ENOENT:
99 dev_dbg(&phy->udev->dev,
100 "The urb has been stopped (status %d)\n",
101 urb->status);
102 goto sched_wq;
103 case -ESHUTDOWN:
104 default:
105 nfc_err(&phy->udev->dev,
106 "Urb failure (status %d)\n", urb->status);
107 goto sched_wq;
108 }
109
110 in_frame = phy->in_urb->transfer_buffer;
111
112 if (!pn533_rx_frame_is_ack(in_frame)) {
113 nfc_err(&phy->udev->dev, "Received an invalid ack\n");
114 cmd->status = -EIO;
115 goto sched_wq;
116 }
117
118 rc = pn533_submit_urb_for_response(phy, GFP_ATOMIC);
119 if (rc) {
120 nfc_err(&phy->udev->dev,
121 "usb_submit_urb failed with result %d\n", rc);
122 cmd->status = rc;
123 goto sched_wq;
124 }
125
126 return;
127
128 sched_wq:
129 queue_work(priv->wq, &priv->cmd_complete_work);
130 }
131
pn533_submit_urb_for_ack(struct pn533_usb_phy * phy,gfp_t flags)132 static int pn533_submit_urb_for_ack(struct pn533_usb_phy *phy, gfp_t flags)
133 {
134 phy->in_urb->complete = pn533_recv_ack;
135
136 return usb_submit_urb(phy->in_urb, flags);
137 }
138
pn533_usb_send_ack(struct pn533 * dev,gfp_t flags)139 static int pn533_usb_send_ack(struct pn533 *dev, gfp_t flags)
140 {
141 struct pn533_usb_phy *phy = dev->phy;
142 static const u8 ack[6] = {0x00, 0x00, 0xff, 0x00, 0xff, 0x00};
143 /* spec 7.1.1.3: Preamble, SoPC (2), ACK Code (2), Postamble */
144
145 if (!phy->ack_buffer) {
146 phy->ack_buffer = kmemdup(ack, sizeof(ack), flags);
147 if (!phy->ack_buffer)
148 return -ENOMEM;
149 }
150
151 phy->ack_urb->transfer_buffer = phy->ack_buffer;
152 phy->ack_urb->transfer_buffer_length = sizeof(ack);
153 return usb_submit_urb(phy->ack_urb, flags);
154 }
155
pn533_usb_send_frame(struct pn533 * dev,struct sk_buff * out)156 static int pn533_usb_send_frame(struct pn533 *dev,
157 struct sk_buff *out)
158 {
159 struct pn533_usb_phy *phy = dev->phy;
160 int rc;
161
162 if (phy->priv == NULL)
163 phy->priv = dev;
164
165 phy->out_urb->transfer_buffer = out->data;
166 phy->out_urb->transfer_buffer_length = out->len;
167
168 print_hex_dump_debug("PN533 TX: ", DUMP_PREFIX_NONE, 16, 1,
169 out->data, out->len, false);
170
171 rc = usb_submit_urb(phy->out_urb, GFP_KERNEL);
172 if (rc)
173 return rc;
174
175 if (dev->protocol_type == PN533_PROTO_REQ_RESP) {
176 /* request for response for sent packet directly */
177 rc = pn533_submit_urb_for_response(phy, GFP_KERNEL);
178 if (rc)
179 goto error;
180 } else if (dev->protocol_type == PN533_PROTO_REQ_ACK_RESP) {
181 /* request for ACK if that's the case */
182 rc = pn533_submit_urb_for_ack(phy, GFP_KERNEL);
183 if (rc)
184 goto error;
185 }
186
187 return 0;
188
189 error:
190 usb_unlink_urb(phy->out_urb);
191 return rc;
192 }
193
pn533_usb_abort_cmd(struct pn533 * dev,gfp_t flags)194 static void pn533_usb_abort_cmd(struct pn533 *dev, gfp_t flags)
195 {
196 struct pn533_usb_phy *phy = dev->phy;
197
198 /* ACR122U does not support any command which aborts last
199 * issued command i.e. as ACK for standard PN533. Additionally,
200 * it behaves stange, sending broken or incorrect responses,
201 * when we cancel urb before the chip will send response.
202 */
203 if (dev->device_type == PN533_DEVICE_ACR122U)
204 return;
205
206 /* An ack will cancel the last issued command */
207 pn533_usb_send_ack(dev, flags);
208
209 /* cancel the urb request */
210 usb_kill_urb(phy->in_urb);
211 }
212
213 /* ACR122 specific structs and functions */
214
215 /* ACS ACR122 pn533 frame definitions */
216 #define PN533_ACR122_TX_FRAME_HEADER_LEN (sizeof(struct pn533_acr122_tx_frame) \
217 + 2)
218 #define PN533_ACR122_TX_FRAME_TAIL_LEN 0
219 #define PN533_ACR122_RX_FRAME_HEADER_LEN (sizeof(struct pn533_acr122_rx_frame) \
220 + 2)
221 #define PN533_ACR122_RX_FRAME_TAIL_LEN 2
222 #define PN533_ACR122_FRAME_MAX_PAYLOAD_LEN PN533_STD_FRAME_MAX_PAYLOAD_LEN
223
224 /* CCID messages types */
225 #define PN533_ACR122_PC_TO_RDR_ICCPOWERON 0x62
226 #define PN533_ACR122_PC_TO_RDR_ESCAPE 0x6B
227
228 #define PN533_ACR122_RDR_TO_PC_ESCAPE 0x83
229
230
231 struct pn533_acr122_ccid_hdr {
232 u8 type;
233 u32 datalen;
234 u8 slot;
235 u8 seq;
236
237 /*
238 * 3 msg specific bytes or status, error and 1 specific
239 * byte for reposnse msg
240 */
241 u8 params[3];
242 u8 data[]; /* payload */
243 } __packed;
244
245 struct pn533_acr122_apdu_hdr {
246 u8 class;
247 u8 ins;
248 u8 p1;
249 u8 p2;
250 } __packed;
251
252 struct pn533_acr122_tx_frame {
253 struct pn533_acr122_ccid_hdr ccid;
254 struct pn533_acr122_apdu_hdr apdu;
255 u8 datalen;
256 u8 data[]; /* pn533 frame: TFI ... */
257 } __packed;
258
259 struct pn533_acr122_rx_frame {
260 struct pn533_acr122_ccid_hdr ccid;
261 u8 data[]; /* pn533 frame : TFI ... */
262 } __packed;
263
pn533_acr122_tx_frame_init(void * _frame,u8 cmd_code)264 static void pn533_acr122_tx_frame_init(void *_frame, u8 cmd_code)
265 {
266 struct pn533_acr122_tx_frame *frame = _frame;
267
268 frame->ccid.type = PN533_ACR122_PC_TO_RDR_ESCAPE;
269 /* sizeof(apdu_hdr) + sizeof(datalen) */
270 frame->ccid.datalen = sizeof(frame->apdu) + 1;
271 frame->ccid.slot = 0;
272 frame->ccid.seq = 0;
273 frame->ccid.params[0] = 0;
274 frame->ccid.params[1] = 0;
275 frame->ccid.params[2] = 0;
276
277 frame->data[0] = PN533_STD_FRAME_DIR_OUT;
278 frame->data[1] = cmd_code;
279 frame->datalen = 2; /* data[0] + data[1] */
280
281 frame->apdu.class = 0xFF;
282 frame->apdu.ins = 0;
283 frame->apdu.p1 = 0;
284 frame->apdu.p2 = 0;
285 }
286
pn533_acr122_tx_frame_finish(void * _frame)287 static void pn533_acr122_tx_frame_finish(void *_frame)
288 {
289 struct pn533_acr122_tx_frame *frame = _frame;
290
291 frame->ccid.datalen += frame->datalen;
292 }
293
pn533_acr122_tx_update_payload_len(void * _frame,int len)294 static void pn533_acr122_tx_update_payload_len(void *_frame, int len)
295 {
296 struct pn533_acr122_tx_frame *frame = _frame;
297
298 frame->datalen += len;
299 }
300
pn533_acr122_is_rx_frame_valid(void * _frame,struct pn533 * dev)301 static bool pn533_acr122_is_rx_frame_valid(void *_frame, struct pn533 *dev)
302 {
303 struct pn533_acr122_rx_frame *frame = _frame;
304
305 if (frame->ccid.type != 0x83)
306 return false;
307
308 if (!frame->ccid.datalen)
309 return false;
310
311 if (frame->data[frame->ccid.datalen - 2] == 0x63)
312 return false;
313
314 return true;
315 }
316
pn533_acr122_rx_frame_size(void * frame)317 static int pn533_acr122_rx_frame_size(void *frame)
318 {
319 struct pn533_acr122_rx_frame *f = frame;
320
321 /* f->ccid.datalen already includes tail length */
322 return sizeof(struct pn533_acr122_rx_frame) + f->ccid.datalen;
323 }
324
pn533_acr122_get_cmd_code(void * frame)325 static u8 pn533_acr122_get_cmd_code(void *frame)
326 {
327 struct pn533_acr122_rx_frame *f = frame;
328
329 return PN533_FRAME_CMD(f);
330 }
331
332 static struct pn533_frame_ops pn533_acr122_frame_ops = {
333 .tx_frame_init = pn533_acr122_tx_frame_init,
334 .tx_frame_finish = pn533_acr122_tx_frame_finish,
335 .tx_update_payload_len = pn533_acr122_tx_update_payload_len,
336 .tx_header_len = PN533_ACR122_TX_FRAME_HEADER_LEN,
337 .tx_tail_len = PN533_ACR122_TX_FRAME_TAIL_LEN,
338
339 .rx_is_frame_valid = pn533_acr122_is_rx_frame_valid,
340 .rx_header_len = PN533_ACR122_RX_FRAME_HEADER_LEN,
341 .rx_tail_len = PN533_ACR122_RX_FRAME_TAIL_LEN,
342 .rx_frame_size = pn533_acr122_rx_frame_size,
343
344 .max_payload_len = PN533_ACR122_FRAME_MAX_PAYLOAD_LEN,
345 .get_cmd_code = pn533_acr122_get_cmd_code,
346 };
347
348 struct pn533_acr122_poweron_rdr_arg {
349 int rc;
350 struct completion done;
351 };
352
pn533_acr122_poweron_rdr_resp(struct urb * urb)353 static void pn533_acr122_poweron_rdr_resp(struct urb *urb)
354 {
355 struct pn533_acr122_poweron_rdr_arg *arg = urb->context;
356
357 print_hex_dump_debug("ACR122 RX: ", DUMP_PREFIX_NONE, 16, 1,
358 urb->transfer_buffer, urb->transfer_buffer_length,
359 false);
360
361 arg->rc = urb->status;
362 complete(&arg->done);
363 }
364
pn533_acr122_poweron_rdr(struct pn533_usb_phy * phy)365 static int pn533_acr122_poweron_rdr(struct pn533_usb_phy *phy)
366 {
367 /* Power on th reader (CCID cmd) */
368 u8 cmd[10] = {PN533_ACR122_PC_TO_RDR_ICCPOWERON,
369 0, 0, 0, 0, 0, 0, 3, 0, 0};
370 char *buffer;
371 int transferred;
372 int rc;
373 void *cntx;
374 struct pn533_acr122_poweron_rdr_arg arg;
375
376 buffer = kmemdup(cmd, sizeof(cmd), GFP_KERNEL);
377 if (!buffer)
378 return -ENOMEM;
379
380 init_completion(&arg.done);
381 cntx = phy->in_urb->context; /* backup context */
382
383 phy->in_urb->complete = pn533_acr122_poweron_rdr_resp;
384 phy->in_urb->context = &arg;
385
386 print_hex_dump_debug("ACR122 TX: ", DUMP_PREFIX_NONE, 16, 1,
387 cmd, sizeof(cmd), false);
388
389 rc = usb_bulk_msg(phy->udev, phy->out_urb->pipe, buffer, sizeof(cmd),
390 &transferred, 5000);
391 kfree(buffer);
392 if (rc || (transferred != sizeof(cmd))) {
393 nfc_err(&phy->udev->dev,
394 "Reader power on cmd error %d\n", rc);
395 return rc;
396 }
397
398 rc = usb_submit_urb(phy->in_urb, GFP_KERNEL);
399 if (rc) {
400 nfc_err(&phy->udev->dev,
401 "Can't submit reader poweron cmd response %d\n", rc);
402 return rc;
403 }
404
405 wait_for_completion(&arg.done);
406 phy->in_urb->context = cntx; /* restore context */
407
408 return arg.rc;
409 }
410
pn533_send_complete(struct urb * urb)411 static void pn533_send_complete(struct urb *urb)
412 {
413 struct pn533_usb_phy *phy = urb->context;
414
415 switch (urb->status) {
416 case 0:
417 break; /* success */
418 case -ECONNRESET:
419 case -ENOENT:
420 dev_dbg(&phy->udev->dev,
421 "The urb has been stopped (status %d)\n",
422 urb->status);
423 break;
424 case -ESHUTDOWN:
425 default:
426 nfc_err(&phy->udev->dev,
427 "Urb failure (status %d)\n",
428 urb->status);
429 }
430 }
431
432 static const struct pn533_phy_ops usb_phy_ops = {
433 .send_frame = pn533_usb_send_frame,
434 .send_ack = pn533_usb_send_ack,
435 .abort_cmd = pn533_usb_abort_cmd,
436 };
437
pn533_usb_probe(struct usb_interface * interface,const struct usb_device_id * id)438 static int pn533_usb_probe(struct usb_interface *interface,
439 const struct usb_device_id *id)
440 {
441 struct pn533 *priv;
442 struct pn533_usb_phy *phy;
443 struct usb_host_interface *iface_desc;
444 struct usb_endpoint_descriptor *endpoint;
445 int in_endpoint = 0;
446 int out_endpoint = 0;
447 int rc = -ENOMEM;
448 int i;
449 u32 protocols;
450 enum pn533_protocol_type protocol_type = PN533_PROTO_REQ_ACK_RESP;
451 struct pn533_frame_ops *fops = NULL;
452 unsigned char *in_buf;
453 int in_buf_len = PN533_EXT_FRAME_HEADER_LEN +
454 PN533_STD_FRAME_MAX_PAYLOAD_LEN +
455 PN533_STD_FRAME_TAIL_LEN;
456
457 phy = devm_kzalloc(&interface->dev, sizeof(*phy), GFP_KERNEL);
458 if (!phy)
459 return -ENOMEM;
460
461 in_buf = kzalloc(in_buf_len, GFP_KERNEL);
462 if (!in_buf)
463 return -ENOMEM;
464
465 phy->udev = usb_get_dev(interface_to_usbdev(interface));
466 phy->interface = interface;
467
468 iface_desc = interface->cur_altsetting;
469 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
470 endpoint = &iface_desc->endpoint[i].desc;
471
472 if (!in_endpoint && usb_endpoint_is_bulk_in(endpoint))
473 in_endpoint = endpoint->bEndpointAddress;
474
475 if (!out_endpoint && usb_endpoint_is_bulk_out(endpoint))
476 out_endpoint = endpoint->bEndpointAddress;
477 }
478
479 if (!in_endpoint || !out_endpoint) {
480 nfc_err(&interface->dev,
481 "Could not find bulk-in or bulk-out endpoint\n");
482 rc = -ENODEV;
483 goto error;
484 }
485
486 phy->in_urb = usb_alloc_urb(0, GFP_KERNEL);
487 phy->out_urb = usb_alloc_urb(0, GFP_KERNEL);
488 phy->ack_urb = usb_alloc_urb(0, GFP_KERNEL);
489
490 if (!phy->in_urb || !phy->out_urb || !phy->ack_urb)
491 goto error;
492
493 usb_fill_bulk_urb(phy->in_urb, phy->udev,
494 usb_rcvbulkpipe(phy->udev, in_endpoint),
495 in_buf, in_buf_len, NULL, phy);
496
497 usb_fill_bulk_urb(phy->out_urb, phy->udev,
498 usb_sndbulkpipe(phy->udev, out_endpoint),
499 NULL, 0, pn533_send_complete, phy);
500 usb_fill_bulk_urb(phy->ack_urb, phy->udev,
501 usb_sndbulkpipe(phy->udev, out_endpoint),
502 NULL, 0, pn533_send_complete, phy);
503
504 switch (id->driver_info) {
505 case PN533_DEVICE_STD:
506 protocols = PN533_ALL_PROTOCOLS;
507 break;
508
509 case PN533_DEVICE_PASORI:
510 protocols = PN533_NO_TYPE_B_PROTOCOLS;
511 break;
512
513 case PN533_DEVICE_ACR122U:
514 protocols = PN533_NO_TYPE_B_PROTOCOLS;
515 fops = &pn533_acr122_frame_ops;
516 protocol_type = PN533_PROTO_REQ_RESP;
517
518 rc = pn533_acr122_poweron_rdr(phy);
519 if (rc < 0) {
520 nfc_err(&interface->dev,
521 "Couldn't poweron the reader (error %d)\n", rc);
522 goto error;
523 }
524 break;
525
526 default:
527 nfc_err(&interface->dev, "Unknown device type %lu\n",
528 id->driver_info);
529 rc = -EINVAL;
530 goto error;
531 }
532
533 priv = pn53x_common_init(id->driver_info, protocol_type,
534 phy, &usb_phy_ops, fops,
535 &phy->udev->dev);
536
537 if (IS_ERR(priv)) {
538 rc = PTR_ERR(priv);
539 goto error;
540 }
541
542 phy->priv = priv;
543
544 rc = pn533_finalize_setup(priv);
545 if (rc)
546 goto err_clean;
547
548 usb_set_intfdata(interface, phy);
549 rc = pn53x_register_nfc(priv, protocols, &interface->dev);
550 if (rc)
551 goto err_clean;
552
553 return 0;
554
555 err_clean:
556 pn53x_common_clean(priv);
557 error:
558 usb_kill_urb(phy->in_urb);
559 usb_kill_urb(phy->out_urb);
560 usb_kill_urb(phy->ack_urb);
561
562 usb_free_urb(phy->in_urb);
563 usb_free_urb(phy->out_urb);
564 usb_free_urb(phy->ack_urb);
565 usb_put_dev(phy->udev);
566 kfree(in_buf);
567 kfree(phy->ack_buffer);
568
569 return rc;
570 }
571
pn533_usb_disconnect(struct usb_interface * interface)572 static void pn533_usb_disconnect(struct usb_interface *interface)
573 {
574 struct pn533_usb_phy *phy = usb_get_intfdata(interface);
575
576 if (!phy)
577 return;
578
579 pn53x_unregister_nfc(phy->priv);
580 pn53x_common_clean(phy->priv);
581
582 usb_set_intfdata(interface, NULL);
583
584 usb_kill_urb(phy->in_urb);
585 usb_kill_urb(phy->out_urb);
586 usb_kill_urb(phy->ack_urb);
587
588 kfree(phy->in_urb->transfer_buffer);
589 usb_free_urb(phy->in_urb);
590 usb_free_urb(phy->out_urb);
591 usb_free_urb(phy->ack_urb);
592 kfree(phy->ack_buffer);
593
594 nfc_info(&interface->dev, "NXP PN533 NFC device disconnected\n");
595 }
596
597 static struct usb_driver pn533_usb_driver = {
598 .name = "pn533_usb",
599 .probe = pn533_usb_probe,
600 .disconnect = pn533_usb_disconnect,
601 .id_table = pn533_usb_table,
602 };
603
604 module_usb_driver(pn533_usb_driver);
605
606 MODULE_AUTHOR("Lauro Ramos Venancio <lauro.venancio@openbossa.org>");
607 MODULE_AUTHOR("Aloisio Almeida Jr <aloisio.almeida@openbossa.org>");
608 MODULE_AUTHOR("Waldemar Rymarkiewicz <waldemar.rymarkiewicz@tieto.com>");
609 MODULE_DESCRIPTION("PN533 USB driver ver " VERSION);
610 MODULE_VERSION(VERSION);
611 MODULE_LICENSE("GPL");
612