2 * Copyright (C) 2011 Instituto Nokia de Tecnologia
3 * Copyright (C) 2012-2013 Tieto Poland
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the
17 * Free Software Foundation, Inc.,
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include <linux/device.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/usb.h>
26 #include <linux/nfc.h>
27 #include <linux/netdevice.h>
28 #include <net/nfc/nfc.h>
32 #define PN533_VENDOR_ID 0x4CC
33 #define PN533_PRODUCT_ID 0x2533
35 #define SCM_VENDOR_ID 0x4E6
36 #define SCL3711_PRODUCT_ID 0x5591
38 #define SONY_VENDOR_ID 0x054c
39 #define PASORI_PRODUCT_ID 0x02e1
41 #define PN533_DEVICE_STD 0x1
42 #define PN533_DEVICE_PASORI 0x2
44 #define PN533_ALL_PROTOCOLS (NFC_PROTO_JEWEL_MASK | NFC_PROTO_MIFARE_MASK |\
45 NFC_PROTO_FELICA_MASK | NFC_PROTO_ISO14443_MASK |\
46 NFC_PROTO_NFC_DEP_MASK |\
47 NFC_PROTO_ISO14443_B_MASK)
49 #define PN533_NO_TYPE_B_PROTOCOLS (NFC_PROTO_JEWEL_MASK | \
50 NFC_PROTO_MIFARE_MASK | \
51 NFC_PROTO_FELICA_MASK | \
52 NFC_PROTO_ISO14443_MASK | \
53 NFC_PROTO_NFC_DEP_MASK)
55 static const struct usb_device_id pn533_table[] = {
56 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
57 .idVendor = PN533_VENDOR_ID,
58 .idProduct = PN533_PRODUCT_ID,
59 .driver_info = PN533_DEVICE_STD,
61 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
62 .idVendor = SCM_VENDOR_ID,
63 .idProduct = SCL3711_PRODUCT_ID,
64 .driver_info = PN533_DEVICE_STD,
66 { .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
67 .idVendor = SONY_VENDOR_ID,
68 .idProduct = PASORI_PRODUCT_ID,
69 .driver_info = PN533_DEVICE_PASORI,
73 MODULE_DEVICE_TABLE(usb, pn533_table);
75 /* How much time we spend listening for initiators */
76 #define PN533_LISTEN_TIME 2
78 /* Standard pn533 frame definitions */
79 #define PN533_STD_FRAME_HEADER_LEN (sizeof(struct pn533_std_frame) \
80 + 2) /* data[0] TFI, data[1] CC */
81 #define PN533_STD_FRAME_TAIL_LEN 2 /* data[len] DCS, data[len + 1] postamble*/
84 * Max extended frame payload len, excluding TFI and CC
85 * which are already in PN533_FRAME_HEADER_LEN.
87 #define PN533_STD_FRAME_MAX_PAYLOAD_LEN 263
89 #define PN533_STD_FRAME_ACK_SIZE 6 /* Preamble (1), SoPC (2), ACK Code (2),
91 #define PN533_STD_FRAME_CHECKSUM(f) (f->data[f->datalen])
92 #define PN533_STD_FRAME_POSTAMBLE(f) (f->data[f->datalen + 1])
95 #define PN533_STD_FRAME_SOF 0x00FF
97 /* standard frame identifier: in/out/error */
98 #define PN533_STD_FRAME_IDENTIFIER(f) (f->data[0]) /* TFI */
99 #define PN533_STD_FRAME_DIR_OUT 0xD4
100 #define PN533_STD_FRAME_DIR_IN 0xD5
103 #define PN533_STD_FRAME_CMD(f) (f->data[1])
105 #define PN533_CMD_GET_FIRMWARE_VERSION 0x02
106 #define PN533_CMD_RF_CONFIGURATION 0x32
107 #define PN533_CMD_IN_DATA_EXCHANGE 0x40
108 #define PN533_CMD_IN_COMM_THRU 0x42
109 #define PN533_CMD_IN_LIST_PASSIVE_TARGET 0x4A
110 #define PN533_CMD_IN_ATR 0x50
111 #define PN533_CMD_IN_RELEASE 0x52
112 #define PN533_CMD_IN_JUMP_FOR_DEP 0x56
114 #define PN533_CMD_TG_INIT_AS_TARGET 0x8c
115 #define PN533_CMD_TG_GET_DATA 0x86
116 #define PN533_CMD_TG_SET_DATA 0x8e
117 #define PN533_CMD_UNDEF 0xff
119 #define PN533_CMD_RESPONSE(cmd) (cmd + 1)
121 /* PN533 Return codes */
122 #define PN533_CMD_RET_MASK 0x3F
123 #define PN533_CMD_MI_MASK 0x40
124 #define PN533_CMD_RET_SUCCESS 0x00
128 typedef int (*pn533_cmd_complete_t) (struct pn533 *dev, void *arg, int status);
130 typedef int (*pn533_send_async_complete_t) (struct pn533 *dev, void *arg,
131 struct sk_buff *resp);
133 /* structs for pn533 commands */
135 /* PN533_CMD_GET_FIRMWARE_VERSION */
136 struct pn533_fw_version {
143 /* PN533_CMD_RF_CONFIGURATION */
144 #define PN533_CFGITEM_TIMING 0x02
145 #define PN533_CFGITEM_MAX_RETRIES 0x05
146 #define PN533_CFGITEM_PASORI 0x82
148 #define PN533_CONFIG_TIMING_102 0xb
149 #define PN533_CONFIG_TIMING_204 0xc
150 #define PN533_CONFIG_TIMING_409 0xd
151 #define PN533_CONFIG_TIMING_819 0xe
153 #define PN533_CONFIG_MAX_RETRIES_NO_RETRY 0x00
154 #define PN533_CONFIG_MAX_RETRIES_ENDLESS 0xFF
156 struct pn533_config_max_retries {
159 u8 mx_rty_passive_act;
162 struct pn533_config_timing {
168 /* PN533_CMD_IN_LIST_PASSIVE_TARGET */
170 /* felica commands opcode */
171 #define PN533_FELICA_OPC_SENSF_REQ 0
172 #define PN533_FELICA_OPC_SENSF_RES 1
173 /* felica SENSF_REQ parameters */
174 #define PN533_FELICA_SENSF_SC_ALL 0xFFFF
175 #define PN533_FELICA_SENSF_RC_NO_SYSTEM_CODE 0
176 #define PN533_FELICA_SENSF_RC_SYSTEM_CODE 1
177 #define PN533_FELICA_SENSF_RC_ADVANCED_PROTOCOL 2
179 /* type B initiator_data values */
180 #define PN533_TYPE_B_AFI_ALL_FAMILIES 0
181 #define PN533_TYPE_B_POLL_METHOD_TIMESLOT 0
182 #define PN533_TYPE_B_POLL_METHOD_PROBABILISTIC 1
184 union pn533_cmd_poll_initdata {
197 /* Poll modulations */
199 PN533_POLL_MOD_106KBPS_A,
200 PN533_POLL_MOD_212KBPS_FELICA,
201 PN533_POLL_MOD_424KBPS_FELICA,
202 PN533_POLL_MOD_106KBPS_JEWEL,
203 PN533_POLL_MOD_847KBPS_B,
206 __PN533_POLL_MOD_AFTER_LAST,
208 #define PN533_POLL_MOD_MAX (__PN533_POLL_MOD_AFTER_LAST - 1)
210 struct pn533_poll_modulations {
214 union pn533_cmd_poll_initdata initiator_data;
219 static const struct pn533_poll_modulations poll_mod[] = {
220 [PN533_POLL_MOD_106KBPS_A] = {
227 [PN533_POLL_MOD_212KBPS_FELICA] = {
231 .initiator_data.felica = {
232 .opcode = PN533_FELICA_OPC_SENSF_REQ,
233 .sc = PN533_FELICA_SENSF_SC_ALL,
234 .rc = PN533_FELICA_SENSF_RC_NO_SYSTEM_CODE,
240 [PN533_POLL_MOD_424KBPS_FELICA] = {
244 .initiator_data.felica = {
245 .opcode = PN533_FELICA_OPC_SENSF_REQ,
246 .sc = PN533_FELICA_SENSF_SC_ALL,
247 .rc = PN533_FELICA_SENSF_RC_NO_SYSTEM_CODE,
253 [PN533_POLL_MOD_106KBPS_JEWEL] = {
260 [PN533_POLL_MOD_847KBPS_B] = {
264 .initiator_data.type_b = {
265 .afi = PN533_TYPE_B_AFI_ALL_FAMILIES,
267 PN533_TYPE_B_POLL_METHOD_TIMESLOT,
272 [PN533_LISTEN_MOD] = {
277 /* PN533_CMD_IN_ATR */
279 struct pn533_cmd_activate_response {
291 struct pn533_cmd_jump_dep_response {
305 /* PN533_TG_INIT_AS_TARGET */
306 #define PN533_INIT_TARGET_PASSIVE 0x1
307 #define PN533_INIT_TARGET_DEP 0x2
309 #define PN533_INIT_TARGET_RESP_FRAME_MASK 0x3
310 #define PN533_INIT_TARGET_RESP_ACTIVE 0x1
311 #define PN533_INIT_TARGET_RESP_DEP 0x4
314 struct usb_device *udev;
315 struct usb_interface *interface;
316 struct nfc_dev *nfc_dev;
321 struct sk_buff_head resp_q;
323 struct workqueue_struct *wq;
324 struct work_struct cmd_work;
325 struct work_struct cmd_complete_work;
326 struct work_struct poll_work;
327 struct work_struct mi_work;
328 struct work_struct tg_work;
329 struct timer_list listen_timer;
333 pn533_cmd_complete_t cmd_complete;
334 void *cmd_complete_arg;
335 void *cmd_complete_mi_arg;
336 struct mutex cmd_lock;
339 struct pn533_poll_modulations *poll_mod_active[PN533_POLL_MOD_MAX + 1];
343 u32 listen_protocols;
348 u8 tgt_available_prots;
354 struct list_head cmd_queue;
357 struct pn533_frame_ops *ops;
361 struct list_head queue;
364 struct sk_buff *resp;
369 struct pn533_std_frame {
377 struct pn533_frame_ops {
378 void (*tx_frame_init)(void *frame, u8 cmd_code);
379 void (*tx_frame_finish)(void *frame);
380 void (*tx_update_payload_len)(void *frame, int len);
384 bool (*rx_is_frame_valid)(void *frame);
385 int (*rx_frame_size)(void *frame);
390 u8 (*get_cmd_code)(void *frame);
393 /* The rule: value + checksum = 0 */
394 static inline u8 pn533_std_checksum(u8 value)
399 /* The rule: sum(data elements) + checksum = 0 */
400 static u8 pn533_std_data_checksum(u8 *data, int datalen)
405 for (i = 0; i < datalen; i++)
408 return pn533_std_checksum(sum);
411 static void pn533_std_tx_frame_init(void *_frame, u8 cmd_code)
413 struct pn533_std_frame *frame = _frame;
416 frame->start_frame = cpu_to_be16(PN533_STD_FRAME_SOF);
417 PN533_STD_FRAME_IDENTIFIER(frame) = PN533_STD_FRAME_DIR_OUT;
418 PN533_STD_FRAME_CMD(frame) = cmd_code;
422 static void pn533_std_tx_frame_finish(void *_frame)
424 struct pn533_std_frame *frame = _frame;
426 frame->datalen_checksum = pn533_std_checksum(frame->datalen);
428 PN533_STD_FRAME_CHECKSUM(frame) =
429 pn533_std_data_checksum(frame->data, frame->datalen);
431 PN533_STD_FRAME_POSTAMBLE(frame) = 0;
434 static void pn533_std_tx_update_payload_len(void *_frame, int len)
436 struct pn533_std_frame *frame = _frame;
438 frame->datalen += len;
441 static bool pn533_std_rx_frame_is_valid(void *_frame)
444 struct pn533_std_frame *frame = _frame;
446 if (frame->start_frame != cpu_to_be16(PN533_STD_FRAME_SOF))
449 checksum = pn533_std_checksum(frame->datalen);
450 if (checksum != frame->datalen_checksum)
453 checksum = pn533_std_data_checksum(frame->data, frame->datalen);
454 if (checksum != PN533_STD_FRAME_CHECKSUM(frame))
460 static bool pn533_std_rx_frame_is_ack(struct pn533_std_frame *frame)
462 if (frame->start_frame != cpu_to_be16(PN533_STD_FRAME_SOF))
465 if (frame->datalen != 0 || frame->datalen_checksum != 0xFF)
471 static inline int pn533_std_rx_frame_size(void *frame)
473 struct pn533_std_frame *f = frame;
475 return sizeof(struct pn533_std_frame) + f->datalen +
476 PN533_STD_FRAME_TAIL_LEN;
479 static u8 pn533_std_get_cmd_code(void *frame)
481 struct pn533_std_frame *f = frame;
483 return PN533_STD_FRAME_CMD(f);
486 static struct pn533_frame_ops pn533_std_frame_ops = {
487 .tx_frame_init = pn533_std_tx_frame_init,
488 .tx_frame_finish = pn533_std_tx_frame_finish,
489 .tx_update_payload_len = pn533_std_tx_update_payload_len,
490 .tx_header_len = PN533_STD_FRAME_HEADER_LEN,
491 .tx_tail_len = PN533_STD_FRAME_TAIL_LEN,
493 .rx_is_frame_valid = pn533_std_rx_frame_is_valid,
494 .rx_frame_size = pn533_std_rx_frame_size,
495 .rx_header_len = PN533_STD_FRAME_HEADER_LEN,
496 .rx_tail_len = PN533_STD_FRAME_TAIL_LEN,
498 .max_payload_len = PN533_STD_FRAME_MAX_PAYLOAD_LEN,
499 .get_cmd_code = pn533_std_get_cmd_code,
502 static bool pn533_rx_frame_is_cmd_response(struct pn533 *dev, void *frame)
504 return (dev->ops->get_cmd_code(frame) == PN533_CMD_RESPONSE(dev->cmd));
508 static void pn533_wq_cmd_complete(struct work_struct *work)
510 struct pn533 *dev = container_of(work, struct pn533, cmd_complete_work);
513 rc = dev->cmd_complete(dev, dev->cmd_complete_arg, dev->wq_in_error);
514 if (rc != -EINPROGRESS)
515 queue_work(dev->wq, &dev->cmd_work);
518 static void pn533_recv_response(struct urb *urb)
520 struct pn533 *dev = urb->context;
523 switch (urb->status) {
528 nfc_dev_dbg(&dev->interface->dev,
529 "The urb has been canceled (status %d)",
531 dev->wq_in_error = urb->status;
535 nfc_dev_err(&dev->interface->dev,
536 "Urb failure (status %d)", urb->status);
537 dev->wq_in_error = urb->status;
541 in_frame = dev->in_urb->transfer_buffer;
543 nfc_dev_dbg(&dev->interface->dev, "Received a frame.");
544 print_hex_dump_debug("PN533 RX: ", DUMP_PREFIX_NONE, 16, 1, in_frame,
545 dev->ops->rx_frame_size(in_frame), false);
547 if (!dev->ops->rx_is_frame_valid(in_frame)) {
548 nfc_dev_err(&dev->interface->dev, "Received an invalid frame");
549 dev->wq_in_error = -EIO;
553 if (!pn533_rx_frame_is_cmd_response(dev, in_frame)) {
554 nfc_dev_err(&dev->interface->dev,
555 "It it not the response to the last command");
556 dev->wq_in_error = -EIO;
560 dev->wq_in_error = 0;
563 queue_work(dev->wq, &dev->cmd_complete_work);
566 static int pn533_submit_urb_for_response(struct pn533 *dev, gfp_t flags)
568 dev->in_urb->complete = pn533_recv_response;
570 return usb_submit_urb(dev->in_urb, flags);
573 static void pn533_recv_ack(struct urb *urb)
575 struct pn533 *dev = urb->context;
576 struct pn533_std_frame *in_frame;
579 switch (urb->status) {
584 nfc_dev_dbg(&dev->interface->dev,
585 "The urb has been stopped (status %d)",
587 dev->wq_in_error = urb->status;
591 nfc_dev_err(&dev->interface->dev,
592 "Urb failure (status %d)", urb->status);
593 dev->wq_in_error = urb->status;
597 in_frame = dev->in_urb->transfer_buffer;
599 if (!pn533_std_rx_frame_is_ack(in_frame)) {
600 nfc_dev_err(&dev->interface->dev, "Received an invalid ack");
601 dev->wq_in_error = -EIO;
605 rc = pn533_submit_urb_for_response(dev, GFP_ATOMIC);
607 nfc_dev_err(&dev->interface->dev,
608 "usb_submit_urb failed with result %d", rc);
609 dev->wq_in_error = rc;
616 queue_work(dev->wq, &dev->cmd_complete_work);
619 static int pn533_submit_urb_for_ack(struct pn533 *dev, gfp_t flags)
621 dev->in_urb->complete = pn533_recv_ack;
623 return usb_submit_urb(dev->in_urb, flags);
626 static int pn533_send_ack(struct pn533 *dev, gfp_t flags)
628 u8 ack[PN533_STD_FRAME_ACK_SIZE] = {0x00, 0x00, 0xff, 0x00, 0xff, 0x00};
629 /* spec 7.1.1.3: Preamble, SoPC (2), ACK Code (2), Postamble */
632 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
634 dev->out_urb->transfer_buffer = ack;
635 dev->out_urb->transfer_buffer_length = sizeof(ack);
636 rc = usb_submit_urb(dev->out_urb, flags);
641 static int __pn533_send_frame_async(struct pn533 *dev,
645 pn533_cmd_complete_t cmd_complete,
650 dev->cmd = dev->ops->get_cmd_code(out->data);
651 dev->cmd_complete = cmd_complete;
652 dev->cmd_complete_arg = arg;
654 dev->out_urb->transfer_buffer = out->data;
655 dev->out_urb->transfer_buffer_length = out->len;
657 dev->in_urb->transfer_buffer = in->data;
658 dev->in_urb->transfer_buffer_length = in_len;
660 print_hex_dump_debug("PN533 TX: ", DUMP_PREFIX_NONE, 16, 1,
661 out->data, out->len, false);
663 rc = usb_submit_urb(dev->out_urb, GFP_KERNEL);
667 rc = pn533_submit_urb_for_ack(dev, GFP_KERNEL);
674 usb_unlink_urb(dev->out_urb);
678 static void pn533_build_cmd_frame(struct pn533 *dev, u8 cmd_code,
681 /* payload is already there, just update datalen */
682 int payload_len = skb->len;
683 struct pn533_frame_ops *ops = dev->ops;
686 skb_push(skb, ops->tx_header_len);
687 skb_put(skb, ops->tx_tail_len);
689 ops->tx_frame_init(skb->data, cmd_code);
690 ops->tx_update_payload_len(skb->data, payload_len);
691 ops->tx_frame_finish(skb->data);
694 struct pn533_send_async_complete_arg {
695 pn533_send_async_complete_t complete_cb;
696 void *complete_cb_context;
697 struct sk_buff *resp;
701 static int pn533_send_async_complete(struct pn533 *dev, void *_arg, int status)
703 struct pn533_send_async_complete_arg *arg = _arg;
705 struct sk_buff *req = arg->req;
706 struct sk_buff *resp = arg->resp;
713 arg->complete_cb(dev, arg->complete_cb_context,
720 skb_put(resp, dev->ops->rx_frame_size(resp->data));
721 skb_pull(resp, dev->ops->rx_header_len);
722 skb_trim(resp, resp->len - dev->ops->rx_tail_len);
724 rc = arg->complete_cb(dev, arg->complete_cb_context, resp);
730 static int __pn533_send_async(struct pn533 *dev, u8 cmd_code,
731 struct sk_buff *req, struct sk_buff *resp,
733 pn533_send_async_complete_t complete_cb,
734 void *complete_cb_context)
736 struct pn533_cmd *cmd;
737 struct pn533_send_async_complete_arg *arg;
740 nfc_dev_dbg(&dev->interface->dev, "Sending command 0x%x", cmd_code);
742 arg = kzalloc(sizeof(*arg), GFP_KERNEL);
746 arg->complete_cb = complete_cb;
747 arg->complete_cb_context = complete_cb_context;
751 pn533_build_cmd_frame(dev, cmd_code, req);
753 mutex_lock(&dev->cmd_lock);
755 if (!dev->cmd_pending) {
756 rc = __pn533_send_frame_async(dev, req, resp, resp_len,
757 pn533_send_async_complete, arg);
761 dev->cmd_pending = 1;
765 nfc_dev_dbg(&dev->interface->dev, "%s Queueing command 0x%x", __func__,
768 cmd = kzalloc(sizeof(struct pn533_cmd), GFP_KERNEL);
774 INIT_LIST_HEAD(&cmd->queue);
775 cmd->cmd_code = cmd_code;
778 cmd->resp_len = resp_len;
781 list_add_tail(&cmd->queue, &dev->cmd_queue);
788 mutex_unlock(&dev->cmd_lock);
792 static int pn533_send_data_async(struct pn533 *dev, u8 cmd_code,
794 pn533_send_async_complete_t complete_cb,
795 void *complete_cb_context)
797 struct sk_buff *resp;
799 int resp_len = dev->ops->rx_header_len +
800 dev->ops->max_payload_len +
801 dev->ops->rx_tail_len;
803 resp = nfc_alloc_recv_skb(resp_len, GFP_KERNEL);
807 rc = __pn533_send_async(dev, cmd_code, req, resp, resp_len, complete_cb,
808 complete_cb_context);
815 static int pn533_send_cmd_async(struct pn533 *dev, u8 cmd_code,
817 pn533_send_async_complete_t complete_cb,
818 void *complete_cb_context)
820 struct sk_buff *resp;
822 int resp_len = dev->ops->rx_header_len +
823 dev->ops->max_payload_len +
824 dev->ops->rx_tail_len;
826 resp = alloc_skb(resp_len, GFP_KERNEL);
830 rc = __pn533_send_async(dev, cmd_code, req, resp, resp_len, complete_cb,
831 complete_cb_context);
839 * pn533_send_cmd_direct_async
841 * The function sends a piority cmd directly to the chip omiting the cmd
842 * queue. It's intended to be used by chaining mechanism of received responses
843 * where the host has to request every single chunk of data before scheduling
844 * next cmd from the queue.
846 static int pn533_send_cmd_direct_async(struct pn533 *dev, u8 cmd_code,
848 pn533_send_async_complete_t complete_cb,
849 void *complete_cb_context)
851 struct pn533_send_async_complete_arg *arg;
852 struct sk_buff *resp;
854 int resp_len = dev->ops->rx_header_len +
855 dev->ops->max_payload_len +
856 dev->ops->rx_tail_len;
858 resp = alloc_skb(resp_len, GFP_KERNEL);
862 arg = kzalloc(sizeof(*arg), GFP_KERNEL);
868 arg->complete_cb = complete_cb;
869 arg->complete_cb_context = complete_cb_context;
873 pn533_build_cmd_frame(dev, cmd_code, req);
875 rc = __pn533_send_frame_async(dev, req, resp, resp_len,
876 pn533_send_async_complete, arg);
885 static void pn533_wq_cmd(struct work_struct *work)
887 struct pn533 *dev = container_of(work, struct pn533, cmd_work);
888 struct pn533_cmd *cmd;
891 mutex_lock(&dev->cmd_lock);
893 if (list_empty(&dev->cmd_queue)) {
894 dev->cmd_pending = 0;
895 mutex_unlock(&dev->cmd_lock);
899 cmd = list_first_entry(&dev->cmd_queue, struct pn533_cmd, queue);
901 list_del(&cmd->queue);
903 mutex_unlock(&dev->cmd_lock);
905 rc = __pn533_send_frame_async(dev, cmd->req, cmd->resp, cmd->resp_len,
906 pn533_send_async_complete, cmd->arg);
908 dev_kfree_skb(cmd->req);
909 dev_kfree_skb(cmd->resp);
916 struct pn533_sync_cmd_response {
917 struct sk_buff *resp;
918 struct completion done;
921 static int pn533_send_sync_complete(struct pn533 *dev, void *_arg,
922 struct sk_buff *resp)
924 struct pn533_sync_cmd_response *arg = _arg;
927 complete(&arg->done);
932 /* pn533_send_cmd_sync
934 * Please note the req parameter is freed inside the function to
935 * limit a number of return value interpretations by the caller.
937 * 1. negative in case of error during TX path -> req should be freed
939 * 2. negative in case of error during RX path -> req should not be freed
940 * as it's been already freed at the begining of RX path by
943 * 3. valid pointer in case of succesfult RX path
945 * A caller has to check a return value with IS_ERR macro. If the test pass,
946 * the returned pointer is valid.
949 static struct sk_buff *pn533_send_cmd_sync(struct pn533 *dev, u8 cmd_code,
953 struct pn533_sync_cmd_response arg;
955 init_completion(&arg.done);
957 rc = pn533_send_cmd_async(dev, cmd_code, req,
958 pn533_send_sync_complete, &arg);
964 wait_for_completion(&arg.done);
969 static void pn533_send_complete(struct urb *urb)
971 struct pn533 *dev = urb->context;
973 switch (urb->status) {
978 nfc_dev_dbg(&dev->interface->dev,
979 "The urb has been stopped (status %d)",
984 nfc_dev_err(&dev->interface->dev,
985 "Urb failure (status %d)", urb->status);
989 static struct sk_buff *pn533_alloc_skb(struct pn533 *dev, unsigned int size)
993 skb = alloc_skb(dev->ops->tx_header_len +
995 dev->ops->tx_tail_len, GFP_KERNEL);
998 skb_reserve(skb, dev->ops->tx_header_len);
1003 struct pn533_target_type_a {
1011 #define PN533_TYPE_A_SENS_RES_NFCID1(x) ((u8)((be16_to_cpu(x) & 0x00C0) >> 6))
1012 #define PN533_TYPE_A_SENS_RES_SSD(x) ((u8)((be16_to_cpu(x) & 0x001F) >> 0))
1013 #define PN533_TYPE_A_SENS_RES_PLATCONF(x) ((u8)((be16_to_cpu(x) & 0x0F00) >> 8))
1015 #define PN533_TYPE_A_SENS_RES_SSD_JEWEL 0x00
1016 #define PN533_TYPE_A_SENS_RES_PLATCONF_JEWEL 0x0C
1018 #define PN533_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5)
1019 #define PN533_TYPE_A_SEL_CASCADE(x) (((x) & 0x04) >> 2)
1021 #define PN533_TYPE_A_SEL_PROT_MIFARE 0
1022 #define PN533_TYPE_A_SEL_PROT_ISO14443 1
1023 #define PN533_TYPE_A_SEL_PROT_DEP 2
1024 #define PN533_TYPE_A_SEL_PROT_ISO14443_DEP 3
1026 static bool pn533_target_type_a_is_valid(struct pn533_target_type_a *type_a,
1027 int target_data_len)
1032 if (target_data_len < sizeof(struct pn533_target_type_a))
1035 /* The lenght check of nfcid[] and ats[] are not being performed because
1036 the values are not being used */
1038 /* Requirement 4.6.3.3 from NFC Forum Digital Spec */
1039 ssd = PN533_TYPE_A_SENS_RES_SSD(type_a->sens_res);
1040 platconf = PN533_TYPE_A_SENS_RES_PLATCONF(type_a->sens_res);
1042 if ((ssd == PN533_TYPE_A_SENS_RES_SSD_JEWEL &&
1043 platconf != PN533_TYPE_A_SENS_RES_PLATCONF_JEWEL) ||
1044 (ssd != PN533_TYPE_A_SENS_RES_SSD_JEWEL &&
1045 platconf == PN533_TYPE_A_SENS_RES_PLATCONF_JEWEL))
1048 /* Requirements 4.8.2.1, 4.8.2.3, 4.8.2.5 and 4.8.2.7 from NFC Forum */
1049 if (PN533_TYPE_A_SEL_CASCADE(type_a->sel_res) != 0)
1055 static int pn533_target_found_type_a(struct nfc_target *nfc_tgt, u8 *tgt_data,
1058 struct pn533_target_type_a *tgt_type_a;
1060 tgt_type_a = (struct pn533_target_type_a *)tgt_data;
1062 if (!pn533_target_type_a_is_valid(tgt_type_a, tgt_data_len))
1065 switch (PN533_TYPE_A_SEL_PROT(tgt_type_a->sel_res)) {
1066 case PN533_TYPE_A_SEL_PROT_MIFARE:
1067 nfc_tgt->supported_protocols = NFC_PROTO_MIFARE_MASK;
1069 case PN533_TYPE_A_SEL_PROT_ISO14443:
1070 nfc_tgt->supported_protocols = NFC_PROTO_ISO14443_MASK;
1072 case PN533_TYPE_A_SEL_PROT_DEP:
1073 nfc_tgt->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
1075 case PN533_TYPE_A_SEL_PROT_ISO14443_DEP:
1076 nfc_tgt->supported_protocols = NFC_PROTO_ISO14443_MASK |
1077 NFC_PROTO_NFC_DEP_MASK;
1081 nfc_tgt->sens_res = be16_to_cpu(tgt_type_a->sens_res);
1082 nfc_tgt->sel_res = tgt_type_a->sel_res;
1083 nfc_tgt->nfcid1_len = tgt_type_a->nfcid_len;
1084 memcpy(nfc_tgt->nfcid1, tgt_type_a->nfcid_data, nfc_tgt->nfcid1_len);
1089 struct pn533_target_felica {
1098 #define PN533_FELICA_SENSF_NFCID2_DEP_B1 0x01
1099 #define PN533_FELICA_SENSF_NFCID2_DEP_B2 0xFE
1101 static bool pn533_target_felica_is_valid(struct pn533_target_felica *felica,
1102 int target_data_len)
1104 if (target_data_len < sizeof(struct pn533_target_felica))
1107 if (felica->opcode != PN533_FELICA_OPC_SENSF_RES)
1113 static int pn533_target_found_felica(struct nfc_target *nfc_tgt, u8 *tgt_data,
1116 struct pn533_target_felica *tgt_felica;
1118 tgt_felica = (struct pn533_target_felica *)tgt_data;
1120 if (!pn533_target_felica_is_valid(tgt_felica, tgt_data_len))
1123 if ((tgt_felica->nfcid2[0] == PN533_FELICA_SENSF_NFCID2_DEP_B1) &&
1124 (tgt_felica->nfcid2[1] == PN533_FELICA_SENSF_NFCID2_DEP_B2))
1125 nfc_tgt->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
1127 nfc_tgt->supported_protocols = NFC_PROTO_FELICA_MASK;
1129 memcpy(nfc_tgt->sensf_res, &tgt_felica->opcode, 9);
1130 nfc_tgt->sensf_res_len = 9;
1135 struct pn533_target_jewel {
1140 static bool pn533_target_jewel_is_valid(struct pn533_target_jewel *jewel,
1141 int target_data_len)
1146 if (target_data_len < sizeof(struct pn533_target_jewel))
1149 /* Requirement 4.6.3.3 from NFC Forum Digital Spec */
1150 ssd = PN533_TYPE_A_SENS_RES_SSD(jewel->sens_res);
1151 platconf = PN533_TYPE_A_SENS_RES_PLATCONF(jewel->sens_res);
1153 if ((ssd == PN533_TYPE_A_SENS_RES_SSD_JEWEL &&
1154 platconf != PN533_TYPE_A_SENS_RES_PLATCONF_JEWEL) ||
1155 (ssd != PN533_TYPE_A_SENS_RES_SSD_JEWEL &&
1156 platconf == PN533_TYPE_A_SENS_RES_PLATCONF_JEWEL))
1162 static int pn533_target_found_jewel(struct nfc_target *nfc_tgt, u8 *tgt_data,
1165 struct pn533_target_jewel *tgt_jewel;
1167 tgt_jewel = (struct pn533_target_jewel *)tgt_data;
1169 if (!pn533_target_jewel_is_valid(tgt_jewel, tgt_data_len))
1172 nfc_tgt->supported_protocols = NFC_PROTO_JEWEL_MASK;
1173 nfc_tgt->sens_res = be16_to_cpu(tgt_jewel->sens_res);
1174 nfc_tgt->nfcid1_len = 4;
1175 memcpy(nfc_tgt->nfcid1, tgt_jewel->jewelid, nfc_tgt->nfcid1_len);
1180 struct pn533_type_b_prot_info {
1186 #define PN533_TYPE_B_PROT_FCSI(x) (((x) & 0xF0) >> 4)
1187 #define PN533_TYPE_B_PROT_TYPE(x) (((x) & 0x0F) >> 0)
1188 #define PN533_TYPE_B_PROT_TYPE_RFU_MASK 0x8
1190 struct pn533_type_b_sens_res {
1194 struct pn533_type_b_prot_info prot_info;
1197 #define PN533_TYPE_B_OPC_SENSB_RES 0x50
1199 struct pn533_target_type_b {
1200 struct pn533_type_b_sens_res sensb_res;
1205 static bool pn533_target_type_b_is_valid(struct pn533_target_type_b *type_b,
1206 int target_data_len)
1208 if (target_data_len < sizeof(struct pn533_target_type_b))
1211 if (type_b->sensb_res.opcode != PN533_TYPE_B_OPC_SENSB_RES)
1214 if (PN533_TYPE_B_PROT_TYPE(type_b->sensb_res.prot_info.fsci_type) &
1215 PN533_TYPE_B_PROT_TYPE_RFU_MASK)
1221 static int pn533_target_found_type_b(struct nfc_target *nfc_tgt, u8 *tgt_data,
1224 struct pn533_target_type_b *tgt_type_b;
1226 tgt_type_b = (struct pn533_target_type_b *)tgt_data;
1228 if (!pn533_target_type_b_is_valid(tgt_type_b, tgt_data_len))
1231 nfc_tgt->supported_protocols = NFC_PROTO_ISO14443_B_MASK;
1236 static int pn533_target_found(struct pn533 *dev, u8 tg, u8 *tgdata,
1239 struct nfc_target nfc_tgt;
1242 nfc_dev_dbg(&dev->interface->dev, "%s - modulation=%d", __func__,
1243 dev->poll_mod_curr);
1248 memset(&nfc_tgt, 0, sizeof(struct nfc_target));
1250 switch (dev->poll_mod_curr) {
1251 case PN533_POLL_MOD_106KBPS_A:
1252 rc = pn533_target_found_type_a(&nfc_tgt, tgdata, tgdata_len);
1254 case PN533_POLL_MOD_212KBPS_FELICA:
1255 case PN533_POLL_MOD_424KBPS_FELICA:
1256 rc = pn533_target_found_felica(&nfc_tgt, tgdata, tgdata_len);
1258 case PN533_POLL_MOD_106KBPS_JEWEL:
1259 rc = pn533_target_found_jewel(&nfc_tgt, tgdata, tgdata_len);
1261 case PN533_POLL_MOD_847KBPS_B:
1262 rc = pn533_target_found_type_b(&nfc_tgt, tgdata, tgdata_len);
1265 nfc_dev_err(&dev->interface->dev,
1266 "Unknown current poll modulation");
1273 if (!(nfc_tgt.supported_protocols & dev->poll_protocols)) {
1274 nfc_dev_dbg(&dev->interface->dev,
1275 "The Tg found doesn't have the desired protocol");
1279 nfc_dev_dbg(&dev->interface->dev,
1280 "Target found - supported protocols: 0x%x",
1281 nfc_tgt.supported_protocols);
1283 dev->tgt_available_prots = nfc_tgt.supported_protocols;
1285 nfc_targets_found(dev->nfc_dev, &nfc_tgt, 1);
1290 static inline void pn533_poll_next_mod(struct pn533 *dev)
1292 dev->poll_mod_curr = (dev->poll_mod_curr + 1) % dev->poll_mod_count;
1295 static void pn533_poll_reset_mod_list(struct pn533 *dev)
1297 dev->poll_mod_count = 0;
1300 static void pn533_poll_add_mod(struct pn533 *dev, u8 mod_index)
1302 dev->poll_mod_active[dev->poll_mod_count] =
1303 (struct pn533_poll_modulations *)&poll_mod[mod_index];
1304 dev->poll_mod_count++;
1307 static void pn533_poll_create_mod_list(struct pn533 *dev,
1308 u32 im_protocols, u32 tm_protocols)
1310 pn533_poll_reset_mod_list(dev);
1312 if ((im_protocols & NFC_PROTO_MIFARE_MASK) ||
1313 (im_protocols & NFC_PROTO_ISO14443_MASK) ||
1314 (im_protocols & NFC_PROTO_NFC_DEP_MASK))
1315 pn533_poll_add_mod(dev, PN533_POLL_MOD_106KBPS_A);
1317 if (im_protocols & NFC_PROTO_FELICA_MASK ||
1318 im_protocols & NFC_PROTO_NFC_DEP_MASK) {
1319 pn533_poll_add_mod(dev, PN533_POLL_MOD_212KBPS_FELICA);
1320 pn533_poll_add_mod(dev, PN533_POLL_MOD_424KBPS_FELICA);
1323 if (im_protocols & NFC_PROTO_JEWEL_MASK)
1324 pn533_poll_add_mod(dev, PN533_POLL_MOD_106KBPS_JEWEL);
1326 if (im_protocols & NFC_PROTO_ISO14443_B_MASK)
1327 pn533_poll_add_mod(dev, PN533_POLL_MOD_847KBPS_B);
1330 pn533_poll_add_mod(dev, PN533_LISTEN_MOD);
1333 static int pn533_start_poll_complete(struct pn533 *dev, struct sk_buff *resp)
1335 u8 nbtg, tg, *tgdata;
1338 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1340 nbtg = resp->data[0];
1342 tgdata = &resp->data[2];
1343 tgdata_len = resp->len - 2; /* nbtg + tg */
1346 rc = pn533_target_found(dev, tg, tgdata, tgdata_len);
1348 /* We must stop the poll after a valid target found */
1350 pn533_poll_reset_mod_list(dev);
1358 static struct sk_buff *pn533_alloc_poll_tg_frame(struct pn533 *dev)
1360 struct sk_buff *skb;
1361 u8 *felica, *nfcid3, *gb;
1363 u8 *gbytes = dev->gb;
1364 size_t gbytes_len = dev->gb_len;
1366 u8 felica_params[18] = {0x1, 0xfe, /* DEP */
1367 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, /* random */
1368 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
1369 0xff, 0xff}; /* System code */
1371 u8 mifare_params[6] = {0x1, 0x1, /* SENS_RES */
1373 0x40}; /* SEL_RES for DEP */
1375 unsigned int skb_len = 36 + /* mode (1), mifare (6),
1376 felica (18), nfcid3 (10), gb_len (1) */
1380 skb = pn533_alloc_skb(dev, skb_len);
1384 /* DEP support only */
1385 *skb_put(skb, 1) = PN533_INIT_TARGET_DEP;
1388 memcpy(skb_put(skb, 6), mifare_params, 6);
1391 felica = skb_put(skb, 18);
1392 memcpy(felica, felica_params, 18);
1393 get_random_bytes(felica + 2, 6);
1396 nfcid3 = skb_put(skb, 10);
1397 memset(nfcid3, 0, 10);
1398 memcpy(nfcid3, felica, 8);
1401 *skb_put(skb, 1) = gbytes_len;
1403 gb = skb_put(skb, gbytes_len);
1404 memcpy(gb, gbytes, gbytes_len);
1407 *skb_put(skb, 1) = 0;
1412 #define PN533_CMD_DATAEXCH_HEAD_LEN 1
1413 #define PN533_CMD_DATAEXCH_DATA_MAXLEN 262
1414 static int pn533_tm_get_data_complete(struct pn533 *dev, void *arg,
1415 struct sk_buff *resp)
1419 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1422 return PTR_ERR(resp);
1424 status = resp->data[0];
1425 skb_pull(resp, sizeof(status));
1428 nfc_tm_deactivated(dev->nfc_dev);
1430 dev_kfree_skb(resp);
1434 return nfc_tm_data_received(dev->nfc_dev, resp);
1437 static void pn533_wq_tg_get_data(struct work_struct *work)
1439 struct pn533 *dev = container_of(work, struct pn533, tg_work);
1441 struct sk_buff *skb;
1444 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1446 skb = pn533_alloc_skb(dev, 0);
1450 rc = pn533_send_data_async(dev, PN533_CMD_TG_GET_DATA, skb,
1451 pn533_tm_get_data_complete, NULL);
1459 #define ATR_REQ_GB_OFFSET 17
1460 static int pn533_init_target_complete(struct pn533 *dev, struct sk_buff *resp)
1462 u8 mode, *cmd, comm_mode = NFC_COMM_PASSIVE, *gb;
1466 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1468 if (resp->len < ATR_REQ_GB_OFFSET + 1)
1471 mode = resp->data[0];
1472 cmd = &resp->data[1];
1474 nfc_dev_dbg(&dev->interface->dev, "Target mode 0x%x len %d\n",
1477 if ((mode & PN533_INIT_TARGET_RESP_FRAME_MASK) ==
1478 PN533_INIT_TARGET_RESP_ACTIVE)
1479 comm_mode = NFC_COMM_ACTIVE;
1481 if ((mode & PN533_INIT_TARGET_RESP_DEP) == 0) /* Only DEP supported */
1484 gb = cmd + ATR_REQ_GB_OFFSET;
1485 gb_len = resp->len - (ATR_REQ_GB_OFFSET + 1);
1487 rc = nfc_tm_activated(dev->nfc_dev, NFC_PROTO_NFC_DEP_MASK,
1488 comm_mode, gb, gb_len);
1490 nfc_dev_err(&dev->interface->dev,
1491 "Error when signaling target activation");
1496 queue_work(dev->wq, &dev->tg_work);
1501 static void pn533_listen_mode_timer(unsigned long data)
1503 struct pn533 *dev = (struct pn533 *)data;
1505 nfc_dev_dbg(&dev->interface->dev, "Listen mode timeout");
1507 /* An ack will cancel the last issued command (poll) */
1508 pn533_send_ack(dev, GFP_ATOMIC);
1510 dev->cancel_listen = 1;
1512 pn533_poll_next_mod(dev);
1514 queue_work(dev->wq, &dev->poll_work);
1517 static int pn533_poll_complete(struct pn533 *dev, void *arg,
1518 struct sk_buff *resp)
1520 struct pn533_poll_modulations *cur_mod;
1523 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1528 nfc_dev_err(&dev->interface->dev, "%s Poll complete error %d",
1531 if (rc == -ENOENT) {
1532 if (dev->poll_mod_count != 0)
1536 } else if (rc < 0) {
1537 nfc_dev_err(&dev->interface->dev,
1538 "Error %d when running poll", rc);
1543 cur_mod = dev->poll_mod_active[dev->poll_mod_curr];
1545 if (cur_mod->len == 0) { /* Target mode */
1546 del_timer(&dev->listen_timer);
1547 rc = pn533_init_target_complete(dev, resp);
1551 /* Initiator mode */
1552 rc = pn533_start_poll_complete(dev, resp);
1556 if (!dev->poll_mod_count) {
1557 nfc_dev_dbg(&dev->interface->dev, "Polling has been stoped.");
1561 pn533_poll_next_mod(dev);
1562 queue_work(dev->wq, &dev->poll_work);
1565 dev_kfree_skb(resp);
1569 nfc_dev_err(&dev->interface->dev, "Polling operation has been stopped");
1571 pn533_poll_reset_mod_list(dev);
1572 dev->poll_protocols = 0;
1576 static struct sk_buff *pn533_alloc_poll_in_frame(struct pn533 *dev,
1577 struct pn533_poll_modulations *mod)
1579 struct sk_buff *skb;
1581 skb = pn533_alloc_skb(dev, mod->len);
1585 memcpy(skb_put(skb, mod->len), &mod->data, mod->len);
1590 static int pn533_send_poll_frame(struct pn533 *dev)
1592 struct pn533_poll_modulations *mod;
1593 struct sk_buff *skb;
1597 mod = dev->poll_mod_active[dev->poll_mod_curr];
1599 nfc_dev_dbg(&dev->interface->dev, "%s mod len %d\n",
1600 __func__, mod->len);
1602 if (mod->len == 0) { /* Listen mode */
1603 cmd_code = PN533_CMD_TG_INIT_AS_TARGET;
1604 skb = pn533_alloc_poll_tg_frame(dev);
1605 } else { /* Polling mode */
1606 cmd_code = PN533_CMD_IN_LIST_PASSIVE_TARGET;
1607 skb = pn533_alloc_poll_in_frame(dev, mod);
1611 nfc_dev_err(&dev->interface->dev, "Failed to allocate skb.");
1615 rc = pn533_send_cmd_async(dev, cmd_code, skb, pn533_poll_complete,
1619 nfc_dev_err(&dev->interface->dev, "Polling loop error %d", rc);
1625 static void pn533_wq_poll(struct work_struct *work)
1627 struct pn533 *dev = container_of(work, struct pn533, poll_work);
1628 struct pn533_poll_modulations *cur_mod;
1631 cur_mod = dev->poll_mod_active[dev->poll_mod_curr];
1633 nfc_dev_dbg(&dev->interface->dev,
1634 "%s cancel_listen %d modulation len %d",
1635 __func__, dev->cancel_listen, cur_mod->len);
1637 if (dev->cancel_listen == 1) {
1638 dev->cancel_listen = 0;
1639 usb_kill_urb(dev->in_urb);
1642 rc = pn533_send_poll_frame(dev);
1646 if (cur_mod->len == 0 && dev->poll_mod_count > 1)
1647 mod_timer(&dev->listen_timer, jiffies + PN533_LISTEN_TIME * HZ);
1652 static int pn533_start_poll(struct nfc_dev *nfc_dev,
1653 u32 im_protocols, u32 tm_protocols)
1655 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1657 nfc_dev_dbg(&dev->interface->dev,
1658 "%s: im protocols 0x%x tm protocols 0x%x",
1659 __func__, im_protocols, tm_protocols);
1661 if (dev->tgt_active_prot) {
1662 nfc_dev_err(&dev->interface->dev,
1663 "Cannot poll with a target already activated");
1667 if (dev->tgt_mode) {
1668 nfc_dev_err(&dev->interface->dev,
1669 "Cannot poll while already being activated");
1674 dev->gb = nfc_get_local_general_bytes(nfc_dev, &dev->gb_len);
1675 if (dev->gb == NULL)
1679 dev->poll_mod_curr = 0;
1680 pn533_poll_create_mod_list(dev, im_protocols, tm_protocols);
1681 dev->poll_protocols = im_protocols;
1682 dev->listen_protocols = tm_protocols;
1684 return pn533_send_poll_frame(dev);
1687 static void pn533_stop_poll(struct nfc_dev *nfc_dev)
1689 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1691 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1693 del_timer(&dev->listen_timer);
1695 if (!dev->poll_mod_count) {
1696 nfc_dev_dbg(&dev->interface->dev,
1697 "Polling operation was not running");
1701 /* An ack will cancel the last issued command (poll) */
1702 pn533_send_ack(dev, GFP_KERNEL);
1704 /* prevent pn533_start_poll_complete to issue a new poll meanwhile */
1705 usb_kill_urb(dev->in_urb);
1707 pn533_poll_reset_mod_list(dev);
1710 static int pn533_activate_target_nfcdep(struct pn533 *dev)
1712 struct pn533_cmd_activate_response *rsp;
1716 struct sk_buff *skb;
1717 struct sk_buff *resp;
1719 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1721 skb = pn533_alloc_skb(dev, sizeof(u8) * 2); /*TG + Next*/
1725 *skb_put(skb, sizeof(u8)) = 1; /* TG */
1726 *skb_put(skb, sizeof(u8)) = 0; /* Next */
1728 resp = pn533_send_cmd_sync(dev, PN533_CMD_IN_ATR, skb);
1730 return PTR_ERR(resp);
1732 rsp = (struct pn533_cmd_activate_response *)resp->data;
1733 rc = rsp->status & PN533_CMD_RET_MASK;
1734 if (rc != PN533_CMD_RET_SUCCESS) {
1735 nfc_dev_err(&dev->interface->dev,
1736 "Target activation failed (error 0x%x)", rc);
1737 dev_kfree_skb(resp);
1741 /* ATR_RES general bytes are located at offset 16 */
1742 gt_len = resp->len - 16;
1743 rc = nfc_set_remote_general_bytes(dev->nfc_dev, rsp->gt, gt_len);
1745 dev_kfree_skb(resp);
1749 static int pn533_activate_target(struct nfc_dev *nfc_dev,
1750 struct nfc_target *target, u32 protocol)
1752 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1755 nfc_dev_dbg(&dev->interface->dev, "%s - protocol=%u", __func__,
1758 if (dev->poll_mod_count) {
1759 nfc_dev_err(&dev->interface->dev,
1760 "Cannot activate while polling");
1764 if (dev->tgt_active_prot) {
1765 nfc_dev_err(&dev->interface->dev,
1766 "There is already an active target");
1770 if (!dev->tgt_available_prots) {
1771 nfc_dev_err(&dev->interface->dev,
1772 "There is no available target to activate");
1776 if (!(dev->tgt_available_prots & (1 << protocol))) {
1777 nfc_dev_err(&dev->interface->dev,
1778 "Target doesn't support requested proto %u",
1783 if (protocol == NFC_PROTO_NFC_DEP) {
1784 rc = pn533_activate_target_nfcdep(dev);
1786 nfc_dev_err(&dev->interface->dev,
1787 "Activating target with DEP failed %d", rc);
1792 dev->tgt_active_prot = protocol;
1793 dev->tgt_available_prots = 0;
1798 static void pn533_deactivate_target(struct nfc_dev *nfc_dev,
1799 struct nfc_target *target)
1801 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1803 struct sk_buff *skb;
1804 struct sk_buff *resp;
1808 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1810 if (!dev->tgt_active_prot) {
1811 nfc_dev_err(&dev->interface->dev, "There is no active target");
1815 dev->tgt_active_prot = 0;
1816 skb_queue_purge(&dev->resp_q);
1818 skb = pn533_alloc_skb(dev, sizeof(u8));
1822 *skb_put(skb, 1) = 1; /* TG*/
1824 resp = pn533_send_cmd_sync(dev, PN533_CMD_IN_RELEASE, skb);
1828 rc = resp->data[0] & PN533_CMD_RET_MASK;
1829 if (rc != PN533_CMD_RET_SUCCESS)
1830 nfc_dev_err(&dev->interface->dev,
1831 "Error 0x%x when releasing the target", rc);
1833 dev_kfree_skb(resp);
1838 static int pn533_in_dep_link_up_complete(struct pn533 *dev, void *arg,
1839 struct sk_buff *resp)
1841 struct pn533_cmd_jump_dep_response *rsp;
1844 u8 active = *(u8 *)arg;
1849 return PTR_ERR(resp);
1851 if (dev->tgt_available_prots &&
1852 !(dev->tgt_available_prots & (1 << NFC_PROTO_NFC_DEP))) {
1853 nfc_dev_err(&dev->interface->dev,
1854 "The target does not support DEP");
1859 rsp = (struct pn533_cmd_jump_dep_response *)resp->data;
1861 rc = rsp->status & PN533_CMD_RET_MASK;
1862 if (rc != PN533_CMD_RET_SUCCESS) {
1863 nfc_dev_err(&dev->interface->dev,
1864 "Bringing DEP link up failed (error 0x%x)", rc);
1868 if (!dev->tgt_available_prots) {
1869 struct nfc_target nfc_target;
1871 nfc_dev_dbg(&dev->interface->dev, "Creating new target");
1873 nfc_target.supported_protocols = NFC_PROTO_NFC_DEP_MASK;
1874 nfc_target.nfcid1_len = 10;
1875 memcpy(nfc_target.nfcid1, rsp->nfcid3t, nfc_target.nfcid1_len);
1876 rc = nfc_targets_found(dev->nfc_dev, &nfc_target, 1);
1880 dev->tgt_available_prots = 0;
1883 dev->tgt_active_prot = NFC_PROTO_NFC_DEP;
1885 /* ATR_RES general bytes are located at offset 17 */
1886 target_gt_len = resp->len - 17;
1887 rc = nfc_set_remote_general_bytes(dev->nfc_dev,
1888 rsp->gt, target_gt_len);
1890 rc = nfc_dep_link_is_up(dev->nfc_dev,
1891 dev->nfc_dev->targets[0].idx,
1892 !active, NFC_RF_INITIATOR);
1895 dev_kfree_skb(resp);
1899 static int pn533_mod_to_baud(struct pn533 *dev)
1901 switch (dev->poll_mod_curr) {
1902 case PN533_POLL_MOD_106KBPS_A:
1904 case PN533_POLL_MOD_212KBPS_FELICA:
1906 case PN533_POLL_MOD_424KBPS_FELICA:
1913 #define PASSIVE_DATA_LEN 5
1914 static int pn533_dep_link_up(struct nfc_dev *nfc_dev, struct nfc_target *target,
1915 u8 comm_mode, u8 *gb, size_t gb_len)
1917 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1918 struct sk_buff *skb;
1919 int rc, baud, skb_len;
1922 u8 passive_data[PASSIVE_DATA_LEN] = {0x00, 0xff, 0xff, 0x00, 0x3};
1924 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1926 if (dev->poll_mod_count) {
1927 nfc_dev_err(&dev->interface->dev,
1928 "Cannot bring the DEP link up while polling");
1932 if (dev->tgt_active_prot) {
1933 nfc_dev_err(&dev->interface->dev,
1934 "There is already an active target");
1938 baud = pn533_mod_to_baud(dev);
1940 nfc_dev_err(&dev->interface->dev,
1941 "Invalid curr modulation %d", dev->poll_mod_curr);
1945 skb_len = 3 + gb_len; /* ActPass + BR + Next */
1946 if (comm_mode == NFC_COMM_PASSIVE)
1947 skb_len += PASSIVE_DATA_LEN;
1949 skb = pn533_alloc_skb(dev, skb_len);
1953 *skb_put(skb, 1) = !comm_mode; /* ActPass */
1954 *skb_put(skb, 1) = baud; /* Baud rate */
1956 next = skb_put(skb, 1); /* Next */
1959 if (comm_mode == NFC_COMM_PASSIVE && baud > 0) {
1960 memcpy(skb_put(skb, PASSIVE_DATA_LEN), passive_data,
1965 if (gb != NULL && gb_len > 0) {
1966 memcpy(skb_put(skb, gb_len), gb, gb_len);
1967 *next |= 4; /* We have some Gi */
1972 arg = kmalloc(sizeof(*arg), GFP_KERNEL);
1980 rc = pn533_send_cmd_async(dev, PN533_CMD_IN_JUMP_FOR_DEP, skb,
1981 pn533_in_dep_link_up_complete, arg);
1991 static int pn533_dep_link_down(struct nfc_dev *nfc_dev)
1993 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
1995 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
1997 pn533_poll_reset_mod_list(dev);
1999 if (dev->tgt_mode || dev->tgt_active_prot) {
2000 pn533_send_ack(dev, GFP_KERNEL);
2001 usb_kill_urb(dev->in_urb);
2004 dev->tgt_active_prot = 0;
2007 skb_queue_purge(&dev->resp_q);
2012 struct pn533_data_exchange_arg {
2013 data_exchange_cb_t cb;
2017 static struct sk_buff *pn533_build_response(struct pn533 *dev)
2019 struct sk_buff *skb, *tmp, *t;
2020 unsigned int skb_len = 0, tmp_len = 0;
2022 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2024 if (skb_queue_empty(&dev->resp_q))
2027 if (skb_queue_len(&dev->resp_q) == 1) {
2028 skb = skb_dequeue(&dev->resp_q);
2032 skb_queue_walk_safe(&dev->resp_q, tmp, t)
2033 skb_len += tmp->len;
2035 nfc_dev_dbg(&dev->interface->dev, "%s total length %d\n",
2038 skb = alloc_skb(skb_len, GFP_KERNEL);
2042 skb_put(skb, skb_len);
2044 skb_queue_walk_safe(&dev->resp_q, tmp, t) {
2045 memcpy(skb->data + tmp_len, tmp->data, tmp->len);
2046 tmp_len += tmp->len;
2050 skb_queue_purge(&dev->resp_q);
2055 static int pn533_data_exchange_complete(struct pn533 *dev, void *_arg,
2056 struct sk_buff *resp)
2058 struct pn533_data_exchange_arg *arg = _arg;
2059 struct sk_buff *skb;
2063 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2070 status = resp->data[0];
2071 ret = status & PN533_CMD_RET_MASK;
2072 mi = status & PN533_CMD_MI_MASK;
2074 skb_pull(resp, sizeof(status));
2076 if (ret != PN533_CMD_RET_SUCCESS) {
2077 nfc_dev_err(&dev->interface->dev,
2078 "Exchanging data failed (error 0x%x)", ret);
2083 skb_queue_tail(&dev->resp_q, resp);
2086 dev->cmd_complete_mi_arg = arg;
2087 queue_work(dev->wq, &dev->mi_work);
2088 return -EINPROGRESS;
2091 skb = pn533_build_response(dev);
2095 arg->cb(arg->cb_context, skb, 0);
2100 dev_kfree_skb(resp);
2102 skb_queue_purge(&dev->resp_q);
2103 arg->cb(arg->cb_context, NULL, rc);
2108 static int pn533_transceive(struct nfc_dev *nfc_dev,
2109 struct nfc_target *target, struct sk_buff *skb,
2110 data_exchange_cb_t cb, void *cb_context)
2112 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
2113 struct pn533_data_exchange_arg *arg = NULL;
2116 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2118 if (skb->len > PN533_CMD_DATAEXCH_DATA_MAXLEN) {
2119 /* TODO: Implement support to multi-part data exchange */
2120 nfc_dev_err(&dev->interface->dev,
2121 "Data length greater than the max allowed: %d",
2122 PN533_CMD_DATAEXCH_DATA_MAXLEN);
2127 if (!dev->tgt_active_prot) {
2128 nfc_dev_err(&dev->interface->dev,
2129 "Can't exchange data if there is no active target");
2134 arg = kmalloc(sizeof(*arg), GFP_KERNEL);
2141 arg->cb_context = cb_context;
2143 switch (dev->device_type) {
2144 case PN533_DEVICE_PASORI:
2145 if (dev->tgt_active_prot == NFC_PROTO_FELICA) {
2146 rc = pn533_send_data_async(dev, PN533_CMD_IN_COMM_THRU,
2148 pn533_data_exchange_complete,
2154 *skb_push(skb, sizeof(u8)) = 1; /*TG*/
2156 rc = pn533_send_data_async(dev, PN533_CMD_IN_DATA_EXCHANGE,
2157 skb, pn533_data_exchange_complete,
2163 if (rc < 0) /* rc from send_async */
2174 static int pn533_tm_send_complete(struct pn533 *dev, void *arg,
2175 struct sk_buff *resp)
2179 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2182 return PTR_ERR(resp);
2184 status = resp->data[0];
2186 dev_kfree_skb(resp);
2189 nfc_tm_deactivated(dev->nfc_dev);
2196 queue_work(dev->wq, &dev->tg_work);
2201 static int pn533_tm_send(struct nfc_dev *nfc_dev, struct sk_buff *skb)
2203 struct pn533 *dev = nfc_get_drvdata(nfc_dev);
2206 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2208 if (skb->len > PN533_CMD_DATAEXCH_DATA_MAXLEN) {
2209 nfc_dev_err(&dev->interface->dev,
2210 "Data length greater than the max allowed: %d",
2211 PN533_CMD_DATAEXCH_DATA_MAXLEN);
2215 rc = pn533_send_data_async(dev, PN533_CMD_TG_SET_DATA, skb,
2216 pn533_tm_send_complete, NULL);
2223 static void pn533_wq_mi_recv(struct work_struct *work)
2225 struct pn533 *dev = container_of(work, struct pn533, mi_work);
2227 struct sk_buff *skb;
2230 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2232 skb = pn533_alloc_skb(dev, PN533_CMD_DATAEXCH_HEAD_LEN);
2236 switch (dev->device_type) {
2237 case PN533_DEVICE_PASORI:
2238 if (dev->tgt_active_prot == NFC_PROTO_FELICA) {
2239 rc = pn533_send_cmd_direct_async(dev,
2240 PN533_CMD_IN_COMM_THRU,
2242 pn533_data_exchange_complete,
2243 dev->cmd_complete_mi_arg);
2248 *skb_put(skb, sizeof(u8)) = 1; /*TG*/
2250 rc = pn533_send_cmd_direct_async(dev,
2251 PN533_CMD_IN_DATA_EXCHANGE,
2253 pn533_data_exchange_complete,
2254 dev->cmd_complete_mi_arg);
2259 if (rc == 0) /* success */
2262 nfc_dev_err(&dev->interface->dev,
2263 "Error %d when trying to perform data_exchange", rc);
2266 kfree(dev->cmd_complete_arg);
2269 pn533_send_ack(dev, GFP_KERNEL);
2270 queue_work(dev->wq, &dev->cmd_work);
2273 static int pn533_set_configuration(struct pn533 *dev, u8 cfgitem, u8 *cfgdata,
2276 struct sk_buff *skb;
2277 struct sk_buff *resp;
2281 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2283 skb_len = sizeof(cfgitem) + cfgdata_len; /* cfgitem + cfgdata */
2285 skb = pn533_alloc_skb(dev, skb_len);
2289 *skb_put(skb, sizeof(cfgitem)) = cfgitem;
2290 memcpy(skb_put(skb, cfgdata_len), cfgdata, cfgdata_len);
2292 resp = pn533_send_cmd_sync(dev, PN533_CMD_RF_CONFIGURATION, skb);
2294 return PTR_ERR(resp);
2296 dev_kfree_skb(resp);
2300 static int pn533_get_firmware_version(struct pn533 *dev,
2301 struct pn533_fw_version *fv)
2303 struct sk_buff *skb;
2304 struct sk_buff *resp;
2306 skb = pn533_alloc_skb(dev, 0);
2310 resp = pn533_send_cmd_sync(dev, PN533_CMD_GET_FIRMWARE_VERSION, skb);
2312 return PTR_ERR(resp);
2314 fv->ic = resp->data[0];
2315 fv->ver = resp->data[1];
2316 fv->rev = resp->data[2];
2317 fv->support = resp->data[3];
2319 dev_kfree_skb(resp);
2323 static int pn533_pasori_fw_reset(struct pn533 *dev)
2325 struct sk_buff *skb;
2326 struct sk_buff *resp;
2328 nfc_dev_dbg(&dev->interface->dev, "%s", __func__);
2330 skb = pn533_alloc_skb(dev, sizeof(u8));
2334 *skb_put(skb, sizeof(u8)) = 0x1;
2336 resp = pn533_send_cmd_sync(dev, 0x18, skb);
2338 return PTR_ERR(resp);
2340 dev_kfree_skb(resp);
2345 static struct nfc_ops pn533_nfc_ops = {
2348 .dep_link_up = pn533_dep_link_up,
2349 .dep_link_down = pn533_dep_link_down,
2350 .start_poll = pn533_start_poll,
2351 .stop_poll = pn533_stop_poll,
2352 .activate_target = pn533_activate_target,
2353 .deactivate_target = pn533_deactivate_target,
2354 .im_transceive = pn533_transceive,
2355 .tm_send = pn533_tm_send,
2358 static int pn533_setup(struct pn533 *dev)
2360 struct pn533_config_max_retries max_retries;
2361 struct pn533_config_timing timing;
2362 u8 pasori_cfg[3] = {0x08, 0x01, 0x08};
2365 switch (dev->device_type) {
2366 case PN533_DEVICE_STD:
2367 max_retries.mx_rty_atr = PN533_CONFIG_MAX_RETRIES_ENDLESS;
2368 max_retries.mx_rty_psl = 2;
2369 max_retries.mx_rty_passive_act =
2370 PN533_CONFIG_MAX_RETRIES_NO_RETRY;
2372 timing.rfu = PN533_CONFIG_TIMING_102;
2373 timing.atr_res_timeout = PN533_CONFIG_TIMING_204;
2374 timing.dep_timeout = PN533_CONFIG_TIMING_409;
2378 case PN533_DEVICE_PASORI:
2379 max_retries.mx_rty_atr = 0x2;
2380 max_retries.mx_rty_psl = 0x1;
2381 max_retries.mx_rty_passive_act =
2382 PN533_CONFIG_MAX_RETRIES_NO_RETRY;
2384 timing.rfu = PN533_CONFIG_TIMING_102;
2385 timing.atr_res_timeout = PN533_CONFIG_TIMING_102;
2386 timing.dep_timeout = PN533_CONFIG_TIMING_204;
2391 nfc_dev_err(&dev->interface->dev, "Unknown device type %d\n",
2396 rc = pn533_set_configuration(dev, PN533_CFGITEM_MAX_RETRIES,
2397 (u8 *)&max_retries, sizeof(max_retries));
2399 nfc_dev_err(&dev->interface->dev,
2400 "Error on setting MAX_RETRIES config");
2405 rc = pn533_set_configuration(dev, PN533_CFGITEM_TIMING,
2406 (u8 *)&timing, sizeof(timing));
2408 nfc_dev_err(&dev->interface->dev,
2409 "Error on setting RF timings");
2413 switch (dev->device_type) {
2414 case PN533_DEVICE_STD:
2417 case PN533_DEVICE_PASORI:
2418 pn533_pasori_fw_reset(dev);
2420 rc = pn533_set_configuration(dev, PN533_CFGITEM_PASORI,
2423 nfc_dev_err(&dev->interface->dev,
2424 "Error while settings PASORI config");
2428 pn533_pasori_fw_reset(dev);
2436 static int pn533_probe(struct usb_interface *interface,
2437 const struct usb_device_id *id)
2439 struct pn533_fw_version fw_ver;
2441 struct usb_host_interface *iface_desc;
2442 struct usb_endpoint_descriptor *endpoint;
2443 int in_endpoint = 0;
2444 int out_endpoint = 0;
2449 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2453 dev->udev = usb_get_dev(interface_to_usbdev(interface));
2454 dev->interface = interface;
2455 mutex_init(&dev->cmd_lock);
2457 iface_desc = interface->cur_altsetting;
2458 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
2459 endpoint = &iface_desc->endpoint[i].desc;
2461 if (!in_endpoint && usb_endpoint_is_bulk_in(endpoint))
2462 in_endpoint = endpoint->bEndpointAddress;
2464 if (!out_endpoint && usb_endpoint_is_bulk_out(endpoint))
2465 out_endpoint = endpoint->bEndpointAddress;
2468 if (!in_endpoint || !out_endpoint) {
2469 nfc_dev_err(&interface->dev,
2470 "Could not find bulk-in or bulk-out endpoint");
2475 dev->in_urb = usb_alloc_urb(0, GFP_KERNEL);
2476 dev->out_urb = usb_alloc_urb(0, GFP_KERNEL);
2478 if (!dev->in_urb || !dev->out_urb)
2481 usb_fill_bulk_urb(dev->in_urb, dev->udev,
2482 usb_rcvbulkpipe(dev->udev, in_endpoint),
2483 NULL, 0, NULL, dev);
2484 usb_fill_bulk_urb(dev->out_urb, dev->udev,
2485 usb_sndbulkpipe(dev->udev, out_endpoint),
2486 NULL, 0, pn533_send_complete, dev);
2488 INIT_WORK(&dev->cmd_work, pn533_wq_cmd);
2489 INIT_WORK(&dev->cmd_complete_work, pn533_wq_cmd_complete);
2490 INIT_WORK(&dev->mi_work, pn533_wq_mi_recv);
2491 INIT_WORK(&dev->tg_work, pn533_wq_tg_get_data);
2492 INIT_WORK(&dev->poll_work, pn533_wq_poll);
2493 dev->wq = alloc_ordered_workqueue("pn533", 0);
2494 if (dev->wq == NULL)
2497 init_timer(&dev->listen_timer);
2498 dev->listen_timer.data = (unsigned long) dev;
2499 dev->listen_timer.function = pn533_listen_mode_timer;
2501 skb_queue_head_init(&dev->resp_q);
2503 INIT_LIST_HEAD(&dev->cmd_queue);
2505 usb_set_intfdata(interface, dev);
2507 dev->ops = &pn533_std_frame_ops;
2509 dev->device_type = id->driver_info;
2510 switch (dev->device_type) {
2511 case PN533_DEVICE_STD:
2512 protocols = PN533_ALL_PROTOCOLS;
2515 case PN533_DEVICE_PASORI:
2516 protocols = PN533_NO_TYPE_B_PROTOCOLS;
2520 nfc_dev_err(&dev->interface->dev, "Unknown device type %d\n",
2526 memset(&fw_ver, 0, sizeof(fw_ver));
2527 rc = pn533_get_firmware_version(dev, &fw_ver);
2531 nfc_dev_info(&dev->interface->dev,
2532 "NXP PN533 firmware ver %d.%d now attached",
2533 fw_ver.ver, fw_ver.rev);
2536 dev->nfc_dev = nfc_allocate_device(&pn533_nfc_ops, protocols,
2538 dev->ops->tx_header_len +
2539 PN533_CMD_DATAEXCH_HEAD_LEN,
2540 dev->ops->tx_tail_len);
2544 nfc_set_parent_dev(dev->nfc_dev, &interface->dev);
2545 nfc_set_drvdata(dev->nfc_dev, dev);
2547 rc = nfc_register_device(dev->nfc_dev);
2551 rc = pn533_setup(dev);
2553 goto unregister_nfc_dev;
2558 nfc_unregister_device(dev->nfc_dev);
2561 nfc_free_device(dev->nfc_dev);
2564 destroy_workqueue(dev->wq);
2566 usb_free_urb(dev->in_urb);
2567 usb_free_urb(dev->out_urb);
2572 static void pn533_disconnect(struct usb_interface *interface)
2575 struct pn533_cmd *cmd, *n;
2577 dev = usb_get_intfdata(interface);
2578 usb_set_intfdata(interface, NULL);
2580 nfc_unregister_device(dev->nfc_dev);
2581 nfc_free_device(dev->nfc_dev);
2583 usb_kill_urb(dev->in_urb);
2584 usb_kill_urb(dev->out_urb);
2586 destroy_workqueue(dev->wq);
2588 skb_queue_purge(&dev->resp_q);
2590 del_timer(&dev->listen_timer);
2592 list_for_each_entry_safe(cmd, n, &dev->cmd_queue, queue) {
2593 list_del(&cmd->queue);
2597 usb_free_urb(dev->in_urb);
2598 usb_free_urb(dev->out_urb);
2601 nfc_dev_info(&interface->dev, "NXP PN533 NFC device disconnected");
2604 static struct usb_driver pn533_driver = {
2606 .probe = pn533_probe,
2607 .disconnect = pn533_disconnect,
2608 .id_table = pn533_table,
2611 module_usb_driver(pn533_driver);
2613 MODULE_AUTHOR("Lauro Ramos Venancio <lauro.venancio@openbossa.org>");
2614 MODULE_AUTHOR("Aloisio Almeida Jr <aloisio.almeida@openbossa.org>");
2615 MODULE_AUTHOR("Waldemar Rymarkiewicz <waldemar.rymarkiewicz@tieto.com>");
2616 MODULE_DESCRIPTION("PN533 usb driver ver " VERSION);
2617 MODULE_VERSION(VERSION);
2618 MODULE_LICENSE("GPL");