GNU Linux-libre 5.10.215-gnu1
[releases.git] / drivers / nfc / pn533 / usb.c
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
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
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
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
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
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
156 struct pn533_out_arg {
157         struct pn533_usb_phy *phy;
158         struct completion done;
159 };
160
161 static int pn533_usb_send_frame(struct pn533 *dev,
162                                 struct sk_buff *out)
163 {
164         struct pn533_usb_phy *phy = dev->phy;
165         struct pn533_out_arg arg;
166         void *cntx;
167         int rc;
168
169         if (phy->priv == NULL)
170                 phy->priv = dev;
171
172         phy->out_urb->transfer_buffer = out->data;
173         phy->out_urb->transfer_buffer_length = out->len;
174
175         print_hex_dump_debug("PN533 TX: ", DUMP_PREFIX_NONE, 16, 1,
176                              out->data, out->len, false);
177
178         arg.phy = phy;
179         init_completion(&arg.done);
180         cntx = phy->out_urb->context;
181         phy->out_urb->context = &arg;
182
183         rc = usb_submit_urb(phy->out_urb, GFP_KERNEL);
184         if (rc)
185                 return rc;
186
187         wait_for_completion(&arg.done);
188         phy->out_urb->context = cntx;
189
190         if (dev->protocol_type == PN533_PROTO_REQ_RESP) {
191                 /* request for response for sent packet directly */
192                 rc = pn533_submit_urb_for_response(phy, GFP_KERNEL);
193                 if (rc)
194                         goto error;
195         } else if (dev->protocol_type == PN533_PROTO_REQ_ACK_RESP) {
196                 /* request for ACK if that's the case */
197                 rc = pn533_submit_urb_for_ack(phy, GFP_KERNEL);
198                 if (rc)
199                         goto error;
200         }
201
202         return 0;
203
204 error:
205         usb_unlink_urb(phy->out_urb);
206         return rc;
207 }
208
209 static void pn533_usb_abort_cmd(struct pn533 *dev, gfp_t flags)
210 {
211         struct pn533_usb_phy *phy = dev->phy;
212
213         /* ACR122U does not support any command which aborts last
214          * issued command i.e. as ACK for standard PN533. Additionally,
215          * it behaves stange, sending broken or incorrect responses,
216          * when we cancel urb before the chip will send response.
217          */
218         if (dev->device_type == PN533_DEVICE_ACR122U)
219                 return;
220
221         /* An ack will cancel the last issued command */
222         pn533_usb_send_ack(dev, flags);
223
224         /* cancel the urb request */
225         usb_kill_urb(phy->in_urb);
226 }
227
228 /* ACR122 specific structs and functions */
229
230 /* ACS ACR122 pn533 frame definitions */
231 #define PN533_ACR122_TX_FRAME_HEADER_LEN (sizeof(struct pn533_acr122_tx_frame) \
232                                           + 2)
233 #define PN533_ACR122_TX_FRAME_TAIL_LEN 0
234 #define PN533_ACR122_RX_FRAME_HEADER_LEN (sizeof(struct pn533_acr122_rx_frame) \
235                                           + 2)
236 #define PN533_ACR122_RX_FRAME_TAIL_LEN 2
237 #define PN533_ACR122_FRAME_MAX_PAYLOAD_LEN PN533_STD_FRAME_MAX_PAYLOAD_LEN
238
239 /* CCID messages types */
240 #define PN533_ACR122_PC_TO_RDR_ICCPOWERON 0x62
241 #define PN533_ACR122_PC_TO_RDR_ESCAPE 0x6B
242
243 #define PN533_ACR122_RDR_TO_PC_ESCAPE 0x83
244
245
246 struct pn533_acr122_ccid_hdr {
247         u8 type;
248         u32 datalen;
249         u8 slot;
250         u8 seq;
251
252         /*
253          * 3 msg specific bytes or status, error and 1 specific
254          * byte for reposnse msg
255          */
256         u8 params[3];
257         u8 data[]; /* payload */
258 } __packed;
259
260 struct pn533_acr122_apdu_hdr {
261         u8 class;
262         u8 ins;
263         u8 p1;
264         u8 p2;
265 } __packed;
266
267 struct pn533_acr122_tx_frame {
268         struct pn533_acr122_ccid_hdr ccid;
269         struct pn533_acr122_apdu_hdr apdu;
270         u8 datalen;
271         u8 data[]; /* pn533 frame: TFI ... */
272 } __packed;
273
274 struct pn533_acr122_rx_frame {
275         struct pn533_acr122_ccid_hdr ccid;
276         u8 data[]; /* pn533 frame : TFI ... */
277 } __packed;
278
279 static void pn533_acr122_tx_frame_init(void *_frame, u8 cmd_code)
280 {
281         struct pn533_acr122_tx_frame *frame = _frame;
282
283         frame->ccid.type = PN533_ACR122_PC_TO_RDR_ESCAPE;
284         /* sizeof(apdu_hdr) + sizeof(datalen) */
285         frame->ccid.datalen = sizeof(frame->apdu) + 1;
286         frame->ccid.slot = 0;
287         frame->ccid.seq = 0;
288         frame->ccid.params[0] = 0;
289         frame->ccid.params[1] = 0;
290         frame->ccid.params[2] = 0;
291
292         frame->data[0] = PN533_STD_FRAME_DIR_OUT;
293         frame->data[1] = cmd_code;
294         frame->datalen = 2;  /* data[0] + data[1] */
295
296         frame->apdu.class = 0xFF;
297         frame->apdu.ins = 0;
298         frame->apdu.p1 = 0;
299         frame->apdu.p2 = 0;
300 }
301
302 static void pn533_acr122_tx_frame_finish(void *_frame)
303 {
304         struct pn533_acr122_tx_frame *frame = _frame;
305
306         frame->ccid.datalen += frame->datalen;
307 }
308
309 static void pn533_acr122_tx_update_payload_len(void *_frame, int len)
310 {
311         struct pn533_acr122_tx_frame *frame = _frame;
312
313         frame->datalen += len;
314 }
315
316 static bool pn533_acr122_is_rx_frame_valid(void *_frame, struct pn533 *dev)
317 {
318         struct pn533_acr122_rx_frame *frame = _frame;
319
320         if (frame->ccid.type != 0x83)
321                 return false;
322
323         if (!frame->ccid.datalen)
324                 return false;
325
326         if (frame->data[frame->ccid.datalen - 2] == 0x63)
327                 return false;
328
329         return true;
330 }
331
332 static int pn533_acr122_rx_frame_size(void *frame)
333 {
334         struct pn533_acr122_rx_frame *f = frame;
335
336         /* f->ccid.datalen already includes tail length */
337         return sizeof(struct pn533_acr122_rx_frame) + f->ccid.datalen;
338 }
339
340 static u8 pn533_acr122_get_cmd_code(void *frame)
341 {
342         struct pn533_acr122_rx_frame *f = frame;
343
344         return PN533_FRAME_CMD(f);
345 }
346
347 static struct pn533_frame_ops pn533_acr122_frame_ops = {
348         .tx_frame_init = pn533_acr122_tx_frame_init,
349         .tx_frame_finish = pn533_acr122_tx_frame_finish,
350         .tx_update_payload_len = pn533_acr122_tx_update_payload_len,
351         .tx_header_len = PN533_ACR122_TX_FRAME_HEADER_LEN,
352         .tx_tail_len = PN533_ACR122_TX_FRAME_TAIL_LEN,
353
354         .rx_is_frame_valid = pn533_acr122_is_rx_frame_valid,
355         .rx_header_len = PN533_ACR122_RX_FRAME_HEADER_LEN,
356         .rx_tail_len = PN533_ACR122_RX_FRAME_TAIL_LEN,
357         .rx_frame_size = pn533_acr122_rx_frame_size,
358
359         .max_payload_len = PN533_ACR122_FRAME_MAX_PAYLOAD_LEN,
360         .get_cmd_code = pn533_acr122_get_cmd_code,
361 };
362
363 struct pn533_acr122_poweron_rdr_arg {
364         int rc;
365         struct completion done;
366 };
367
368 static void pn533_acr122_poweron_rdr_resp(struct urb *urb)
369 {
370         struct pn533_acr122_poweron_rdr_arg *arg = urb->context;
371
372         dev_dbg(&urb->dev->dev, "%s\n", __func__);
373
374         print_hex_dump_debug("ACR122 RX: ", DUMP_PREFIX_NONE, 16, 1,
375                        urb->transfer_buffer, urb->transfer_buffer_length,
376                        false);
377
378         arg->rc = urb->status;
379         complete(&arg->done);
380 }
381
382 static int pn533_acr122_poweron_rdr(struct pn533_usb_phy *phy)
383 {
384         /* Power on th reader (CCID cmd) */
385         u8 cmd[10] = {PN533_ACR122_PC_TO_RDR_ICCPOWERON,
386                       0, 0, 0, 0, 0, 0, 3, 0, 0};
387         char *buffer;
388         int transferred;
389         int rc;
390         void *cntx;
391         struct pn533_acr122_poweron_rdr_arg arg;
392
393         dev_dbg(&phy->udev->dev, "%s\n", __func__);
394
395         buffer = kmemdup(cmd, sizeof(cmd), GFP_KERNEL);
396         if (!buffer)
397                 return -ENOMEM;
398
399         init_completion(&arg.done);
400         cntx = phy->in_urb->context;  /* backup context */
401
402         phy->in_urb->complete = pn533_acr122_poweron_rdr_resp;
403         phy->in_urb->context = &arg;
404
405         print_hex_dump_debug("ACR122 TX: ", DUMP_PREFIX_NONE, 16, 1,
406                        cmd, sizeof(cmd), false);
407
408         rc = usb_bulk_msg(phy->udev, phy->out_urb->pipe, buffer, sizeof(cmd),
409                           &transferred, 5000);
410         kfree(buffer);
411         if (rc || (transferred != sizeof(cmd))) {
412                 nfc_err(&phy->udev->dev,
413                         "Reader power on cmd error %d\n", rc);
414                 return rc;
415         }
416
417         rc =  usb_submit_urb(phy->in_urb, GFP_KERNEL);
418         if (rc) {
419                 nfc_err(&phy->udev->dev,
420                         "Can't submit reader poweron cmd response %d\n", rc);
421                 return rc;
422         }
423
424         wait_for_completion(&arg.done);
425         phy->in_urb->context = cntx; /* restore context */
426
427         return arg.rc;
428 }
429
430 static void pn533_out_complete(struct urb *urb)
431 {
432         struct pn533_out_arg *arg = urb->context;
433         struct pn533_usb_phy *phy = arg->phy;
434
435         switch (urb->status) {
436         case 0:
437                 break; /* success */
438         case -ECONNRESET:
439         case -ENOENT:
440                 dev_dbg(&phy->udev->dev,
441                         "The urb has been stopped (status %d)\n",
442                         urb->status);
443                 break;
444         case -ESHUTDOWN:
445         default:
446                 nfc_err(&phy->udev->dev,
447                         "Urb failure (status %d)\n",
448                         urb->status);
449         }
450
451         complete(&arg->done);
452 }
453
454 static void pn533_ack_complete(struct urb *urb)
455 {
456         struct pn533_usb_phy *phy = urb->context;
457
458         switch (urb->status) {
459         case 0:
460                 break; /* success */
461         case -ECONNRESET:
462         case -ENOENT:
463                 dev_dbg(&phy->udev->dev,
464                         "The urb has been stopped (status %d)\n",
465                         urb->status);
466                 break;
467         case -ESHUTDOWN:
468         default:
469                 nfc_err(&phy->udev->dev,
470                         "Urb failure (status %d)\n",
471                         urb->status);
472         }
473 }
474
475 static struct pn533_phy_ops usb_phy_ops = {
476         .send_frame = pn533_usb_send_frame,
477         .send_ack = pn533_usb_send_ack,
478         .abort_cmd = pn533_usb_abort_cmd,
479 };
480
481 static int pn533_usb_probe(struct usb_interface *interface,
482                         const struct usb_device_id *id)
483 {
484         struct pn533 *priv;
485         struct pn533_usb_phy *phy;
486         struct usb_host_interface *iface_desc;
487         struct usb_endpoint_descriptor *endpoint;
488         int in_endpoint = 0;
489         int out_endpoint = 0;
490         int rc = -ENOMEM;
491         int i;
492         u32 protocols;
493         enum pn533_protocol_type protocol_type = PN533_PROTO_REQ_ACK_RESP;
494         struct pn533_frame_ops *fops = NULL;
495         unsigned char *in_buf;
496         int in_buf_len = PN533_EXT_FRAME_HEADER_LEN +
497                          PN533_STD_FRAME_MAX_PAYLOAD_LEN +
498                          PN533_STD_FRAME_TAIL_LEN;
499
500         phy = devm_kzalloc(&interface->dev, sizeof(*phy), GFP_KERNEL);
501         if (!phy)
502                 return -ENOMEM;
503
504         in_buf = kzalloc(in_buf_len, GFP_KERNEL);
505         if (!in_buf)
506                 return -ENOMEM;
507
508         phy->udev = usb_get_dev(interface_to_usbdev(interface));
509         phy->interface = interface;
510
511         iface_desc = interface->cur_altsetting;
512         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
513                 endpoint = &iface_desc->endpoint[i].desc;
514
515                 if (!in_endpoint && usb_endpoint_is_bulk_in(endpoint))
516                         in_endpoint = endpoint->bEndpointAddress;
517
518                 if (!out_endpoint && usb_endpoint_is_bulk_out(endpoint))
519                         out_endpoint = endpoint->bEndpointAddress;
520         }
521
522         if (!in_endpoint || !out_endpoint) {
523                 nfc_err(&interface->dev,
524                         "Could not find bulk-in or bulk-out endpoint\n");
525                 rc = -ENODEV;
526                 goto error;
527         }
528
529         phy->in_urb = usb_alloc_urb(0, GFP_KERNEL);
530         phy->out_urb = usb_alloc_urb(0, GFP_KERNEL);
531         phy->ack_urb = usb_alloc_urb(0, GFP_KERNEL);
532
533         if (!phy->in_urb || !phy->out_urb || !phy->ack_urb)
534                 goto error;
535
536         usb_fill_bulk_urb(phy->in_urb, phy->udev,
537                           usb_rcvbulkpipe(phy->udev, in_endpoint),
538                           in_buf, in_buf_len, NULL, phy);
539
540         usb_fill_bulk_urb(phy->out_urb, phy->udev,
541                           usb_sndbulkpipe(phy->udev, out_endpoint),
542                           NULL, 0, pn533_out_complete, phy);
543         usb_fill_bulk_urb(phy->ack_urb, phy->udev,
544                           usb_sndbulkpipe(phy->udev, out_endpoint),
545                           NULL, 0, pn533_ack_complete, phy);
546
547         switch (id->driver_info) {
548         case PN533_DEVICE_STD:
549                 protocols = PN533_ALL_PROTOCOLS;
550                 break;
551
552         case PN533_DEVICE_PASORI:
553                 protocols = PN533_NO_TYPE_B_PROTOCOLS;
554                 break;
555
556         case PN533_DEVICE_ACR122U:
557                 protocols = PN533_NO_TYPE_B_PROTOCOLS;
558                 fops = &pn533_acr122_frame_ops;
559                 protocol_type = PN533_PROTO_REQ_RESP,
560
561                 rc = pn533_acr122_poweron_rdr(phy);
562                 if (rc < 0) {
563                         nfc_err(&interface->dev,
564                                 "Couldn't poweron the reader (error %d)\n", rc);
565                         goto error;
566                 }
567                 break;
568
569         default:
570                 nfc_err(&interface->dev, "Unknown device type %lu\n",
571                         id->driver_info);
572                 rc = -EINVAL;
573                 goto error;
574         }
575
576         priv = pn53x_common_init(id->driver_info, protocol_type,
577                                         phy, &usb_phy_ops, fops,
578                                         &phy->udev->dev);
579
580         if (IS_ERR(priv)) {
581                 rc = PTR_ERR(priv);
582                 goto error;
583         }
584
585         phy->priv = priv;
586
587         rc = pn533_finalize_setup(priv);
588         if (rc)
589                 goto err_clean;
590
591         usb_set_intfdata(interface, phy);
592         rc = pn53x_register_nfc(priv, protocols, &interface->dev);
593         if (rc)
594                 goto err_clean;
595
596         return 0;
597
598 err_clean:
599         pn53x_common_clean(priv);
600 error:
601         usb_kill_urb(phy->in_urb);
602         usb_kill_urb(phy->out_urb);
603         usb_kill_urb(phy->ack_urb);
604
605         usb_free_urb(phy->in_urb);
606         usb_free_urb(phy->out_urb);
607         usb_free_urb(phy->ack_urb);
608         usb_put_dev(phy->udev);
609         kfree(in_buf);
610         kfree(phy->ack_buffer);
611
612         return rc;
613 }
614
615 static void pn533_usb_disconnect(struct usb_interface *interface)
616 {
617         struct pn533_usb_phy *phy = usb_get_intfdata(interface);
618
619         if (!phy)
620                 return;
621
622         pn53x_unregister_nfc(phy->priv);
623         pn53x_common_clean(phy->priv);
624
625         usb_set_intfdata(interface, NULL);
626
627         usb_kill_urb(phy->in_urb);
628         usb_kill_urb(phy->out_urb);
629         usb_kill_urb(phy->ack_urb);
630
631         kfree(phy->in_urb->transfer_buffer);
632         usb_free_urb(phy->in_urb);
633         usb_free_urb(phy->out_urb);
634         usb_free_urb(phy->ack_urb);
635         kfree(phy->ack_buffer);
636
637         nfc_info(&interface->dev, "NXP PN533 NFC device disconnected\n");
638 }
639
640 static struct usb_driver pn533_usb_driver = {
641         .name =         "pn533_usb",
642         .probe =        pn533_usb_probe,
643         .disconnect =   pn533_usb_disconnect,
644         .id_table =     pn533_usb_table,
645 };
646
647 module_usb_driver(pn533_usb_driver);
648
649 MODULE_AUTHOR("Lauro Ramos Venancio <lauro.venancio@openbossa.org>");
650 MODULE_AUTHOR("Aloisio Almeida Jr <aloisio.almeida@openbossa.org>");
651 MODULE_AUTHOR("Waldemar Rymarkiewicz <waldemar.rymarkiewicz@tieto.com>");
652 MODULE_DESCRIPTION("PN533 USB driver ver " VERSION);
653 MODULE_VERSION(VERSION);
654 MODULE_LICENSE("GPL");