2 * The NFC Controller Interface is the communication protocol between an
3 * NFC Controller (NFCC) and a Device Host (DH).
5 * Copyright (C) 2011 Texas Instruments, Inc.
7 * Written by Ilan Elias <ilane@ti.com>
10 * This file is based on hci_core.c, which was written
11 * by Maxim Krasnyansky.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2
15 * as published by the Free Software Foundation
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <linux/types.h>
29 #include <linux/workqueue.h>
30 #include <linux/completion.h>
31 #include <linux/sched.h>
32 #include <linux/bitops.h>
33 #include <linux/skbuff.h>
36 #include <net/nfc/nci.h>
37 #include <net/nfc/nci_core.h>
38 #include <linux/nfc.h>
40 static void nci_cmd_work(struct work_struct
*work
);
41 static void nci_rx_work(struct work_struct
*work
);
42 static void nci_tx_work(struct work_struct
*work
);
44 /* ---- NCI requests ---- */
46 void nci_req_complete(struct nci_dev
*ndev
, int result
)
48 if (ndev
->req_status
== NCI_REQ_PEND
) {
49 ndev
->req_result
= result
;
50 ndev
->req_status
= NCI_REQ_DONE
;
51 complete(&ndev
->req_completion
);
55 static void nci_req_cancel(struct nci_dev
*ndev
, int err
)
57 if (ndev
->req_status
== NCI_REQ_PEND
) {
58 ndev
->req_result
= err
;
59 ndev
->req_status
= NCI_REQ_CANCELED
;
60 complete(&ndev
->req_completion
);
64 /* Execute request and wait for completion. */
65 static int __nci_request(struct nci_dev
*ndev
,
66 void (*req
)(struct nci_dev
*ndev
, unsigned long opt
),
71 unsigned long completion_rc
;
73 ndev
->req_status
= NCI_REQ_PEND
;
75 init_completion(&ndev
->req_completion
);
77 completion_rc
= wait_for_completion_interruptible_timeout(
78 &ndev
->req_completion
,
81 nfc_dbg("wait_for_completion return %ld", completion_rc
);
83 if (completion_rc
> 0) {
84 switch (ndev
->req_status
) {
86 rc
= nci_to_errno(ndev
->req_result
);
89 case NCI_REQ_CANCELED
:
90 rc
= -ndev
->req_result
;
98 nfc_err("wait_for_completion_interruptible_timeout failed %ld",
101 rc
= ((completion_rc
== 0) ? (-ETIMEDOUT
) : (completion_rc
));
104 ndev
->req_status
= ndev
->req_result
= 0;
109 static inline int nci_request(struct nci_dev
*ndev
,
110 void (*req
)(struct nci_dev
*ndev
, unsigned long opt
),
111 unsigned long opt
, __u32 timeout
)
115 if (!test_bit(NCI_UP
, &ndev
->flags
))
118 /* Serialize all requests */
119 mutex_lock(&ndev
->req_lock
);
120 rc
= __nci_request(ndev
, req
, opt
, timeout
);
121 mutex_unlock(&ndev
->req_lock
);
126 static void nci_reset_req(struct nci_dev
*ndev
, unsigned long opt
)
128 struct nci_core_reset_cmd cmd
;
130 cmd
.reset_type
= NCI_RESET_TYPE_RESET_CONFIG
;
131 nci_send_cmd(ndev
, NCI_OP_CORE_RESET_CMD
, 1, &cmd
);
134 static void nci_init_req(struct nci_dev
*ndev
, unsigned long opt
)
136 nci_send_cmd(ndev
, NCI_OP_CORE_INIT_CMD
, 0, NULL
);
139 static void nci_init_complete_req(struct nci_dev
*ndev
, unsigned long opt
)
141 struct nci_rf_disc_map_cmd cmd
;
142 struct disc_map_config
*cfg
= cmd
.mapping_configs
;
143 __u8
*num
= &cmd
.num_mapping_configs
;
146 /* set rf mapping configurations */
149 /* by default mapping is set to NCI_RF_INTERFACE_FRAME */
150 for (i
= 0; i
< ndev
->num_supported_rf_interfaces
; i
++) {
151 if (ndev
->supported_rf_interfaces
[i
] ==
152 NCI_RF_INTERFACE_ISO_DEP
) {
153 cfg
[*num
].rf_protocol
= NCI_RF_PROTOCOL_ISO_DEP
;
154 cfg
[*num
].mode
= NCI_DISC_MAP_MODE_BOTH
;
155 cfg
[*num
].rf_interface_type
= NCI_RF_INTERFACE_ISO_DEP
;
157 } else if (ndev
->supported_rf_interfaces
[i
] ==
158 NCI_RF_INTERFACE_NFC_DEP
) {
159 cfg
[*num
].rf_protocol
= NCI_RF_PROTOCOL_NFC_DEP
;
160 cfg
[*num
].mode
= NCI_DISC_MAP_MODE_BOTH
;
161 cfg
[*num
].rf_interface_type
= NCI_RF_INTERFACE_NFC_DEP
;
165 if (*num
== NCI_MAX_NUM_MAPPING_CONFIGS
)
169 nci_send_cmd(ndev
, NCI_OP_RF_DISCOVER_MAP_CMD
,
170 (1 + ((*num
)*sizeof(struct disc_map_config
))),
174 static void nci_rf_discover_req(struct nci_dev
*ndev
, unsigned long opt
)
176 struct nci_rf_disc_cmd cmd
;
177 __u32 protocols
= opt
;
179 cmd
.num_disc_configs
= 0;
181 if ((cmd
.num_disc_configs
< NCI_MAX_NUM_RF_CONFIGS
) &&
182 (protocols
& NFC_PROTO_JEWEL_MASK
183 || protocols
& NFC_PROTO_MIFARE_MASK
184 || protocols
& NFC_PROTO_ISO14443_MASK
185 || protocols
& NFC_PROTO_NFC_DEP_MASK
)) {
186 cmd
.disc_configs
[cmd
.num_disc_configs
].type
=
187 NCI_DISCOVERY_TYPE_POLL_A_PASSIVE
;
188 cmd
.disc_configs
[cmd
.num_disc_configs
].frequency
= 1;
189 cmd
.num_disc_configs
++;
192 if ((cmd
.num_disc_configs
< NCI_MAX_NUM_RF_CONFIGS
) &&
193 (protocols
& NFC_PROTO_ISO14443_MASK
)) {
194 cmd
.disc_configs
[cmd
.num_disc_configs
].type
=
195 NCI_DISCOVERY_TYPE_POLL_B_PASSIVE
;
196 cmd
.disc_configs
[cmd
.num_disc_configs
].frequency
= 1;
197 cmd
.num_disc_configs
++;
200 if ((cmd
.num_disc_configs
< NCI_MAX_NUM_RF_CONFIGS
) &&
201 (protocols
& NFC_PROTO_FELICA_MASK
202 || protocols
& NFC_PROTO_NFC_DEP_MASK
)) {
203 cmd
.disc_configs
[cmd
.num_disc_configs
].type
=
204 NCI_DISCOVERY_TYPE_POLL_F_PASSIVE
;
205 cmd
.disc_configs
[cmd
.num_disc_configs
].frequency
= 1;
206 cmd
.num_disc_configs
++;
209 nci_send_cmd(ndev
, NCI_OP_RF_DISCOVER_CMD
,
210 (1 + (cmd
.num_disc_configs
*sizeof(struct disc_config
))),
214 static void nci_rf_deactivate_req(struct nci_dev
*ndev
, unsigned long opt
)
216 struct nci_rf_deactivate_cmd cmd
;
218 cmd
.type
= NCI_DEACTIVATE_TYPE_IDLE_MODE
;
220 nci_send_cmd(ndev
, NCI_OP_RF_DEACTIVATE_CMD
,
221 sizeof(struct nci_rf_deactivate_cmd
),
225 static int nci_open_device(struct nci_dev
*ndev
)
229 mutex_lock(&ndev
->req_lock
);
231 if (test_bit(NCI_UP
, &ndev
->flags
)) {
236 if (ndev
->ops
->open(ndev
)) {
241 atomic_set(&ndev
->cmd_cnt
, 1);
243 set_bit(NCI_INIT
, &ndev
->flags
);
245 rc
= __nci_request(ndev
, nci_reset_req
, 0,
246 msecs_to_jiffies(NCI_RESET_TIMEOUT
));
249 rc
= __nci_request(ndev
, nci_init_req
, 0,
250 msecs_to_jiffies(NCI_INIT_TIMEOUT
));
254 rc
= __nci_request(ndev
, nci_init_complete_req
, 0,
255 msecs_to_jiffies(NCI_INIT_TIMEOUT
));
258 clear_bit(NCI_INIT
, &ndev
->flags
);
261 set_bit(NCI_UP
, &ndev
->flags
);
263 /* Init failed, cleanup */
264 skb_queue_purge(&ndev
->cmd_q
);
265 skb_queue_purge(&ndev
->rx_q
);
266 skb_queue_purge(&ndev
->tx_q
);
268 ndev
->ops
->close(ndev
);
273 mutex_unlock(&ndev
->req_lock
);
277 static int nci_close_device(struct nci_dev
*ndev
)
279 nci_req_cancel(ndev
, ENODEV
);
280 mutex_lock(&ndev
->req_lock
);
282 if (!test_and_clear_bit(NCI_UP
, &ndev
->flags
)) {
283 del_timer_sync(&ndev
->cmd_timer
);
284 mutex_unlock(&ndev
->req_lock
);
288 /* Drop RX and TX queues */
289 skb_queue_purge(&ndev
->rx_q
);
290 skb_queue_purge(&ndev
->tx_q
);
292 /* Flush RX and TX wq */
293 flush_workqueue(ndev
->rx_wq
);
294 flush_workqueue(ndev
->tx_wq
);
297 skb_queue_purge(&ndev
->cmd_q
);
298 atomic_set(&ndev
->cmd_cnt
, 1);
300 set_bit(NCI_INIT
, &ndev
->flags
);
301 __nci_request(ndev
, nci_reset_req
, 0,
302 msecs_to_jiffies(NCI_RESET_TIMEOUT
));
303 clear_bit(NCI_INIT
, &ndev
->flags
);
306 flush_workqueue(ndev
->cmd_wq
);
308 /* After this point our queues are empty
309 * and no works are scheduled. */
310 ndev
->ops
->close(ndev
);
315 mutex_unlock(&ndev
->req_lock
);
320 /* NCI command timer function */
321 static void nci_cmd_timer(unsigned long arg
)
323 struct nci_dev
*ndev
= (void *) arg
;
327 atomic_set(&ndev
->cmd_cnt
, 1);
328 queue_work(ndev
->cmd_wq
, &ndev
->cmd_work
);
331 static int nci_dev_up(struct nfc_dev
*nfc_dev
)
333 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
337 return nci_open_device(ndev
);
340 static int nci_dev_down(struct nfc_dev
*nfc_dev
)
342 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
346 return nci_close_device(ndev
);
349 static int nci_start_poll(struct nfc_dev
*nfc_dev
, __u32 protocols
)
351 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
356 if (test_bit(NCI_DISCOVERY
, &ndev
->flags
)) {
357 nfc_err("unable to start poll, since poll is already active");
361 if (ndev
->target_active_prot
) {
362 nfc_err("there is an active target");
366 if (test_bit(NCI_POLL_ACTIVE
, &ndev
->flags
)) {
367 nfc_dbg("target is active, implicitly deactivate...");
369 rc
= nci_request(ndev
, nci_rf_deactivate_req
, 0,
370 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT
));
375 rc
= nci_request(ndev
, nci_rf_discover_req
, protocols
,
376 msecs_to_jiffies(NCI_RF_DISC_TIMEOUT
));
379 ndev
->poll_prots
= protocols
;
384 static void nci_stop_poll(struct nfc_dev
*nfc_dev
)
386 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
390 if (!test_bit(NCI_DISCOVERY
, &ndev
->flags
)) {
391 nfc_err("unable to stop poll, since poll is not active");
395 nci_request(ndev
, nci_rf_deactivate_req
, 0,
396 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT
));
399 static int nci_activate_target(struct nfc_dev
*nfc_dev
, __u32 target_idx
,
402 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
404 nfc_dbg("entry, target_idx %d, protocol 0x%x", target_idx
, protocol
);
406 if (!test_bit(NCI_POLL_ACTIVE
, &ndev
->flags
)) {
407 nfc_err("there is no available target to activate");
411 if (ndev
->target_active_prot
) {
412 nfc_err("there is already an active target");
416 if (!(ndev
->target_available_prots
& (1 << protocol
))) {
417 nfc_err("target does not support the requested protocol 0x%x",
422 ndev
->target_active_prot
= protocol
;
423 ndev
->target_available_prots
= 0;
428 static void nci_deactivate_target(struct nfc_dev
*nfc_dev
, __u32 target_idx
)
430 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
432 nfc_dbg("entry, target_idx %d", target_idx
);
434 if (!ndev
->target_active_prot
) {
435 nfc_err("unable to deactivate target, no active target");
439 ndev
->target_active_prot
= 0;
441 if (test_bit(NCI_POLL_ACTIVE
, &ndev
->flags
)) {
442 nci_request(ndev
, nci_rf_deactivate_req
, 0,
443 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT
));
447 static int nci_data_exchange(struct nfc_dev
*nfc_dev
, __u32 target_idx
,
449 data_exchange_cb_t cb
,
452 struct nci_dev
*ndev
= nfc_get_drvdata(nfc_dev
);
455 nfc_dbg("entry, target_idx %d, len %d", target_idx
, skb
->len
);
457 if (!ndev
->target_active_prot
) {
458 nfc_err("unable to exchange data, no active target");
462 if (test_and_set_bit(NCI_DATA_EXCHANGE
, &ndev
->flags
))
465 /* store cb and context to be used on receiving data */
466 ndev
->data_exchange_cb
= cb
;
467 ndev
->data_exchange_cb_context
= cb_context
;
469 rc
= nci_send_data(ndev
, NCI_STATIC_RF_CONN_ID
, skb
);
471 clear_bit(NCI_DATA_EXCHANGE
, &ndev
->flags
);
476 static struct nfc_ops nci_nfc_ops
= {
477 .dev_up
= nci_dev_up
,
478 .dev_down
= nci_dev_down
,
479 .start_poll
= nci_start_poll
,
480 .stop_poll
= nci_stop_poll
,
481 .activate_target
= nci_activate_target
,
482 .deactivate_target
= nci_deactivate_target
,
483 .data_exchange
= nci_data_exchange
,
486 /* ---- Interface to NCI drivers ---- */
489 * nci_allocate_device - allocate a new nci device
491 * @ops: device operations
492 * @supported_protocols: NFC protocols supported by the device
494 struct nci_dev
*nci_allocate_device(struct nci_ops
*ops
,
495 __u32 supported_protocols
,
499 struct nci_dev
*ndev
;
501 nfc_dbg("entry, supported_protocols 0x%x", supported_protocols
);
503 if (!ops
->open
|| !ops
->close
|| !ops
->send
)
506 if (!supported_protocols
)
509 ndev
= kzalloc(sizeof(struct nci_dev
), GFP_KERNEL
);
514 ndev
->tx_headroom
= tx_headroom
;
515 ndev
->tx_tailroom
= tx_tailroom
;
517 ndev
->nfc_dev
= nfc_allocate_device(&nci_nfc_ops
,
519 tx_headroom
+ NCI_DATA_HDR_SIZE
,
524 nfc_set_drvdata(ndev
->nfc_dev
, ndev
);
532 EXPORT_SYMBOL(nci_allocate_device
);
535 * nci_free_device - deallocate nci device
537 * @ndev: The nci device to deallocate
539 void nci_free_device(struct nci_dev
*ndev
)
543 nfc_free_device(ndev
->nfc_dev
);
546 EXPORT_SYMBOL(nci_free_device
);
549 * nci_register_device - register a nci device in the nfc subsystem
551 * @dev: The nci device to register
553 int nci_register_device(struct nci_dev
*ndev
)
556 struct device
*dev
= &ndev
->nfc_dev
->dev
;
561 rc
= nfc_register_device(ndev
->nfc_dev
);
567 INIT_WORK(&ndev
->cmd_work
, nci_cmd_work
);
568 snprintf(name
, sizeof(name
), "%s_nci_cmd_wq", dev_name(dev
));
569 ndev
->cmd_wq
= create_singlethread_workqueue(name
);
575 INIT_WORK(&ndev
->rx_work
, nci_rx_work
);
576 snprintf(name
, sizeof(name
), "%s_nci_rx_wq", dev_name(dev
));
577 ndev
->rx_wq
= create_singlethread_workqueue(name
);
580 goto destroy_cmd_wq_exit
;
583 INIT_WORK(&ndev
->tx_work
, nci_tx_work
);
584 snprintf(name
, sizeof(name
), "%s_nci_tx_wq", dev_name(dev
));
585 ndev
->tx_wq
= create_singlethread_workqueue(name
);
588 goto destroy_rx_wq_exit
;
591 skb_queue_head_init(&ndev
->cmd_q
);
592 skb_queue_head_init(&ndev
->rx_q
);
593 skb_queue_head_init(&ndev
->tx_q
);
595 setup_timer(&ndev
->cmd_timer
, nci_cmd_timer
,
596 (unsigned long) ndev
);
598 mutex_init(&ndev
->req_lock
);
603 destroy_workqueue(ndev
->rx_wq
);
606 destroy_workqueue(ndev
->cmd_wq
);
609 nfc_unregister_device(ndev
->nfc_dev
);
614 EXPORT_SYMBOL(nci_register_device
);
617 * nci_unregister_device - unregister a nci device in the nfc subsystem
619 * @dev: The nci device to unregister
621 void nci_unregister_device(struct nci_dev
*ndev
)
625 nci_close_device(ndev
);
627 destroy_workqueue(ndev
->cmd_wq
);
628 destroy_workqueue(ndev
->rx_wq
);
629 destroy_workqueue(ndev
->tx_wq
);
631 nfc_unregister_device(ndev
->nfc_dev
);
633 EXPORT_SYMBOL(nci_unregister_device
);
636 * nci_recv_frame - receive frame from NCI drivers
638 * @skb: The sk_buff to receive
640 int nci_recv_frame(struct sk_buff
*skb
)
642 struct nci_dev
*ndev
= (struct nci_dev
*) skb
->dev
;
644 nfc_dbg("entry, len %d", skb
->len
);
646 if (!ndev
|| (!test_bit(NCI_UP
, &ndev
->flags
)
647 && !test_bit(NCI_INIT
, &ndev
->flags
))) {
652 /* Queue frame for rx worker thread */
653 skb_queue_tail(&ndev
->rx_q
, skb
);
654 queue_work(ndev
->rx_wq
, &ndev
->rx_work
);
658 EXPORT_SYMBOL(nci_recv_frame
);
660 static int nci_send_frame(struct sk_buff
*skb
)
662 struct nci_dev
*ndev
= (struct nci_dev
*) skb
->dev
;
664 nfc_dbg("entry, len %d", skb
->len
);
671 /* Get rid of skb owner, prior to sending to the driver. */
674 return ndev
->ops
->send(skb
);
677 /* Send NCI command */
678 int nci_send_cmd(struct nci_dev
*ndev
, __u16 opcode
, __u8 plen
, void *payload
)
680 struct nci_ctrl_hdr
*hdr
;
683 nfc_dbg("entry, opcode 0x%x, plen %d", opcode
, plen
);
685 skb
= nci_skb_alloc(ndev
, (NCI_CTRL_HDR_SIZE
+ plen
), GFP_KERNEL
);
687 nfc_err("no memory for command");
691 hdr
= (struct nci_ctrl_hdr
*) skb_put(skb
, NCI_CTRL_HDR_SIZE
);
692 hdr
->gid
= nci_opcode_gid(opcode
);
693 hdr
->oid
= nci_opcode_oid(opcode
);
696 nci_mt_set((__u8
*)hdr
, NCI_MT_CMD_PKT
);
697 nci_pbf_set((__u8
*)hdr
, NCI_PBF_LAST
);
700 memcpy(skb_put(skb
, plen
), payload
, plen
);
702 skb
->dev
= (void *) ndev
;
704 skb_queue_tail(&ndev
->cmd_q
, skb
);
705 queue_work(ndev
->cmd_wq
, &ndev
->cmd_work
);
710 /* ---- NCI TX Data worker thread ---- */
712 static void nci_tx_work(struct work_struct
*work
)
714 struct nci_dev
*ndev
= container_of(work
, struct nci_dev
, tx_work
);
717 nfc_dbg("entry, credits_cnt %d", atomic_read(&ndev
->credits_cnt
));
719 /* Send queued tx data */
720 while (atomic_read(&ndev
->credits_cnt
)) {
721 skb
= skb_dequeue(&ndev
->tx_q
);
725 /* Check if data flow control is used */
726 if (atomic_read(&ndev
->credits_cnt
) !=
727 NCI_DATA_FLOW_CONTROL_NOT_USED
)
728 atomic_dec(&ndev
->credits_cnt
);
730 nfc_dbg("NCI TX: MT=data, PBF=%d, conn_id=%d, plen=%d",
732 nci_conn_id(skb
->data
),
733 nci_plen(skb
->data
));
739 /* ----- NCI RX worker thread (data & control) ----- */
741 static void nci_rx_work(struct work_struct
*work
)
743 struct nci_dev
*ndev
= container_of(work
, struct nci_dev
, rx_work
);
746 while ((skb
= skb_dequeue(&ndev
->rx_q
))) {
748 switch (nci_mt(skb
->data
)) {
750 nci_rsp_packet(ndev
, skb
);
754 nci_ntf_packet(ndev
, skb
);
757 case NCI_MT_DATA_PKT
:
758 nci_rx_data_packet(ndev
, skb
);
762 nfc_err("unknown MT 0x%x", nci_mt(skb
->data
));
769 /* ----- NCI TX CMD worker thread ----- */
771 static void nci_cmd_work(struct work_struct
*work
)
773 struct nci_dev
*ndev
= container_of(work
, struct nci_dev
, cmd_work
);
776 nfc_dbg("entry, cmd_cnt %d", atomic_read(&ndev
->cmd_cnt
));
778 /* Send queued command */
779 if (atomic_read(&ndev
->cmd_cnt
)) {
780 skb
= skb_dequeue(&ndev
->cmd_q
);
784 atomic_dec(&ndev
->cmd_cnt
);
786 nfc_dbg("NCI TX: MT=cmd, PBF=%d, GID=0x%x, OID=0x%x, plen=%d",
788 nci_opcode_gid(nci_opcode(skb
->data
)),
789 nci_opcode_oid(nci_opcode(skb
->data
)),
790 nci_plen(skb
->data
));
794 mod_timer(&ndev
->cmd_timer
,
795 jiffies
+ msecs_to_jiffies(NCI_CMD_TIMEOUT
));