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/export.h>
32 #include <linux/sched.h>
33 #include <linux/bitops.h>
34 #include <linux/skbuff.h>
37 #include <net/nfc/nci.h>
38 #include <net/nfc/nci_core.h>
39 #include <linux/nfc.h>
41 static void nci_cmd_work(struct work_struct *work);
42 static void nci_rx_work(struct work_struct *work);
43 static void nci_tx_work(struct work_struct *work);
45 /* ---- NCI requests ---- */
47 void nci_req_complete(struct nci_dev *ndev, int result)
49 if (ndev->req_status == NCI_REQ_PEND) {
50 ndev->req_result = result;
51 ndev->req_status = NCI_REQ_DONE;
52 complete(&ndev->req_completion);
56 static void nci_req_cancel(struct nci_dev *ndev, int err)
58 if (ndev->req_status == NCI_REQ_PEND) {
59 ndev->req_result = err;
60 ndev->req_status = NCI_REQ_CANCELED;
61 complete(&ndev->req_completion);
65 /* Execute request and wait for completion. */
66 static int __nci_request(struct nci_dev *ndev,
67 void (*req)(struct nci_dev *ndev, unsigned long opt),
72 unsigned long completion_rc;
74 ndev->req_status = NCI_REQ_PEND;
76 init_completion(&ndev->req_completion);
78 completion_rc = wait_for_completion_interruptible_timeout(
79 &ndev->req_completion,
82 nfc_dbg("wait_for_completion return %ld", completion_rc);
84 if (completion_rc > 0) {
85 switch (ndev->req_status) {
87 rc = nci_to_errno(ndev->req_result);
90 case NCI_REQ_CANCELED:
91 rc = -ndev->req_result;
99 nfc_err("wait_for_completion_interruptible_timeout failed %ld",
102 rc = ((completion_rc == 0) ? (-ETIMEDOUT) : (completion_rc));
105 ndev->req_status = ndev->req_result = 0;
110 static inline int nci_request(struct nci_dev *ndev,
111 void (*req)(struct nci_dev *ndev, unsigned long opt),
112 unsigned long opt, __u32 timeout)
116 if (!test_bit(NCI_UP, &ndev->flags))
119 /* Serialize all requests */
120 mutex_lock(&ndev->req_lock);
121 rc = __nci_request(ndev, req, opt, timeout);
122 mutex_unlock(&ndev->req_lock);
127 static void nci_reset_req(struct nci_dev *ndev, unsigned long opt)
129 nci_send_cmd(ndev, NCI_OP_CORE_RESET_CMD, 0, NULL);
132 static void nci_init_req(struct nci_dev *ndev, unsigned long opt)
134 nci_send_cmd(ndev, NCI_OP_CORE_INIT_CMD, 0, NULL);
137 static void nci_init_complete_req(struct nci_dev *ndev, unsigned long opt)
139 struct nci_core_conn_create_cmd conn_cmd;
140 struct nci_rf_disc_map_cmd cmd;
141 struct disc_map_config *cfg = cmd.mapping_configs;
142 __u8 *num = &cmd.num_mapping_configs;
145 /* create static rf connection */
146 conn_cmd.target_handle = 0;
147 conn_cmd.num_target_specific_params = 0;
148 nci_send_cmd(ndev, NCI_OP_CORE_CONN_CREATE_CMD, 2, &conn_cmd);
150 /* set rf mapping configurations */
153 /* by default mapping is set to NCI_RF_INTERFACE_FRAME */
154 for (i = 0; i < ndev->num_supported_rf_interfaces; i++) {
155 if (ndev->supported_rf_interfaces[i] ==
156 NCI_RF_INTERFACE_ISO_DEP) {
157 cfg[*num].rf_protocol = NCI_RF_PROTOCOL_ISO_DEP;
158 cfg[*num].mode = NCI_DISC_MAP_MODE_BOTH;
159 cfg[*num].rf_interface_type = NCI_RF_INTERFACE_ISO_DEP;
161 } else if (ndev->supported_rf_interfaces[i] ==
162 NCI_RF_INTERFACE_NFC_DEP) {
163 cfg[*num].rf_protocol = NCI_RF_PROTOCOL_NFC_DEP;
164 cfg[*num].mode = NCI_DISC_MAP_MODE_BOTH;
165 cfg[*num].rf_interface_type = NCI_RF_INTERFACE_NFC_DEP;
169 if (*num == NCI_MAX_NUM_MAPPING_CONFIGS)
173 nci_send_cmd(ndev, NCI_OP_RF_DISCOVER_MAP_CMD,
174 (1 + ((*num)*sizeof(struct disc_map_config))),
178 static void nci_rf_discover_req(struct nci_dev *ndev, unsigned long opt)
180 struct nci_rf_disc_cmd cmd;
181 __u32 protocols = opt;
183 cmd.num_disc_configs = 0;
185 if ((cmd.num_disc_configs < NCI_MAX_NUM_RF_CONFIGS) &&
186 (protocols & NFC_PROTO_JEWEL_MASK
187 || protocols & NFC_PROTO_MIFARE_MASK
188 || protocols & NFC_PROTO_ISO14443_MASK
189 || protocols & NFC_PROTO_NFC_DEP_MASK)) {
190 cmd.disc_configs[cmd.num_disc_configs].type =
191 NCI_DISCOVERY_TYPE_POLL_A_PASSIVE;
192 cmd.disc_configs[cmd.num_disc_configs].frequency = 1;
193 cmd.num_disc_configs++;
196 if ((cmd.num_disc_configs < NCI_MAX_NUM_RF_CONFIGS) &&
197 (protocols & NFC_PROTO_ISO14443_MASK)) {
198 cmd.disc_configs[cmd.num_disc_configs].type =
199 NCI_DISCOVERY_TYPE_POLL_B_PASSIVE;
200 cmd.disc_configs[cmd.num_disc_configs].frequency = 1;
201 cmd.num_disc_configs++;
204 if ((cmd.num_disc_configs < NCI_MAX_NUM_RF_CONFIGS) &&
205 (protocols & NFC_PROTO_FELICA_MASK
206 || protocols & NFC_PROTO_NFC_DEP_MASK)) {
207 cmd.disc_configs[cmd.num_disc_configs].type =
208 NCI_DISCOVERY_TYPE_POLL_F_PASSIVE;
209 cmd.disc_configs[cmd.num_disc_configs].frequency = 1;
210 cmd.num_disc_configs++;
213 nci_send_cmd(ndev, NCI_OP_RF_DISCOVER_CMD,
214 (1 + (cmd.num_disc_configs*sizeof(struct disc_config))),
218 static void nci_rf_deactivate_req(struct nci_dev *ndev, unsigned long opt)
220 struct nci_rf_deactivate_cmd cmd;
222 cmd.type = NCI_DEACTIVATE_TYPE_IDLE_MODE;
224 nci_send_cmd(ndev, NCI_OP_RF_DEACTIVATE_CMD,
225 sizeof(struct nci_rf_deactivate_cmd),
229 static int nci_open_device(struct nci_dev *ndev)
233 mutex_lock(&ndev->req_lock);
235 if (test_bit(NCI_UP, &ndev->flags)) {
240 if (ndev->ops->open(ndev)) {
245 atomic_set(&ndev->cmd_cnt, 1);
247 set_bit(NCI_INIT, &ndev->flags);
249 rc = __nci_request(ndev, nci_reset_req, 0,
250 msecs_to_jiffies(NCI_RESET_TIMEOUT));
253 rc = __nci_request(ndev, nci_init_req, 0,
254 msecs_to_jiffies(NCI_INIT_TIMEOUT));
258 rc = __nci_request(ndev, nci_init_complete_req, 0,
259 msecs_to_jiffies(NCI_INIT_TIMEOUT));
262 clear_bit(NCI_INIT, &ndev->flags);
265 set_bit(NCI_UP, &ndev->flags);
267 /* Init failed, cleanup */
268 skb_queue_purge(&ndev->cmd_q);
269 skb_queue_purge(&ndev->rx_q);
270 skb_queue_purge(&ndev->tx_q);
272 ndev->ops->close(ndev);
277 mutex_unlock(&ndev->req_lock);
281 static int nci_close_device(struct nci_dev *ndev)
283 nci_req_cancel(ndev, ENODEV);
284 mutex_lock(&ndev->req_lock);
286 if (!test_and_clear_bit(NCI_UP, &ndev->flags)) {
287 del_timer_sync(&ndev->cmd_timer);
288 mutex_unlock(&ndev->req_lock);
292 /* Drop RX and TX queues */
293 skb_queue_purge(&ndev->rx_q);
294 skb_queue_purge(&ndev->tx_q);
296 /* Flush RX and TX wq */
297 flush_workqueue(ndev->rx_wq);
298 flush_workqueue(ndev->tx_wq);
301 skb_queue_purge(&ndev->cmd_q);
302 atomic_set(&ndev->cmd_cnt, 1);
304 set_bit(NCI_INIT, &ndev->flags);
305 __nci_request(ndev, nci_reset_req, 0,
306 msecs_to_jiffies(NCI_RESET_TIMEOUT));
307 clear_bit(NCI_INIT, &ndev->flags);
310 flush_workqueue(ndev->cmd_wq);
312 /* After this point our queues are empty
313 * and no works are scheduled. */
314 ndev->ops->close(ndev);
319 mutex_unlock(&ndev->req_lock);
324 /* NCI command timer function */
325 static void nci_cmd_timer(unsigned long arg)
327 struct nci_dev *ndev = (void *) arg;
331 atomic_set(&ndev->cmd_cnt, 1);
332 queue_work(ndev->cmd_wq, &ndev->cmd_work);
335 static int nci_dev_up(struct nfc_dev *nfc_dev)
337 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
341 return nci_open_device(ndev);
344 static int nci_dev_down(struct nfc_dev *nfc_dev)
346 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
350 return nci_close_device(ndev);
353 static int nci_start_poll(struct nfc_dev *nfc_dev, __u32 protocols)
355 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
360 if (test_bit(NCI_DISCOVERY, &ndev->flags)) {
361 nfc_err("unable to start poll, since poll is already active");
365 if (ndev->target_active_prot) {
366 nfc_err("there is an active target");
370 if (test_bit(NCI_POLL_ACTIVE, &ndev->flags)) {
371 nfc_dbg("target is active, implicitly deactivate...");
373 rc = nci_request(ndev, nci_rf_deactivate_req, 0,
374 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT));
379 rc = nci_request(ndev, nci_rf_discover_req, protocols,
380 msecs_to_jiffies(NCI_RF_DISC_TIMEOUT));
383 ndev->poll_prots = protocols;
388 static void nci_stop_poll(struct nfc_dev *nfc_dev)
390 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
394 if (!test_bit(NCI_DISCOVERY, &ndev->flags)) {
395 nfc_err("unable to stop poll, since poll is not active");
399 nci_request(ndev, nci_rf_deactivate_req, 0,
400 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT));
403 static int nci_activate_target(struct nfc_dev *nfc_dev, __u32 target_idx,
406 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
408 nfc_dbg("entry, target_idx %d, protocol 0x%x", target_idx, protocol);
410 if (!test_bit(NCI_POLL_ACTIVE, &ndev->flags)) {
411 nfc_err("there is no available target to activate");
415 if (ndev->target_active_prot) {
416 nfc_err("there is already an active target");
420 if (!(ndev->target_available_prots & (1 << protocol))) {
421 nfc_err("target does not support the requested protocol 0x%x",
426 ndev->target_active_prot = protocol;
427 ndev->target_available_prots = 0;
432 static void nci_deactivate_target(struct nfc_dev *nfc_dev, __u32 target_idx)
434 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
436 nfc_dbg("entry, target_idx %d", target_idx);
438 if (!ndev->target_active_prot) {
439 nfc_err("unable to deactivate target, no active target");
443 ndev->target_active_prot = 0;
445 if (test_bit(NCI_POLL_ACTIVE, &ndev->flags)) {
446 nci_request(ndev, nci_rf_deactivate_req, 0,
447 msecs_to_jiffies(NCI_RF_DEACTIVATE_TIMEOUT));
451 static int nci_data_exchange(struct nfc_dev *nfc_dev, __u32 target_idx,
453 data_exchange_cb_t cb,
456 struct nci_dev *ndev = nfc_get_drvdata(nfc_dev);
459 nfc_dbg("entry, target_idx %d, len %d", target_idx, skb->len);
461 if (!ndev->target_active_prot) {
462 nfc_err("unable to exchange data, no active target");
466 if (test_and_set_bit(NCI_DATA_EXCHANGE, &ndev->flags))
469 /* store cb and context to be used on receiving data */
470 ndev->data_exchange_cb = cb;
471 ndev->data_exchange_cb_context = cb_context;
473 rc = nci_send_data(ndev, ndev->conn_id, skb);
475 clear_bit(NCI_DATA_EXCHANGE, &ndev->flags);
480 static struct nfc_ops nci_nfc_ops = {
481 .dev_up = nci_dev_up,
482 .dev_down = nci_dev_down,
483 .start_poll = nci_start_poll,
484 .stop_poll = nci_stop_poll,
485 .activate_target = nci_activate_target,
486 .deactivate_target = nci_deactivate_target,
487 .data_exchange = nci_data_exchange,
490 /* ---- Interface to NCI drivers ---- */
493 * nci_allocate_device - allocate a new nci device
495 * @ops: device operations
496 * @supported_protocols: NFC protocols supported by the device
498 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
499 __u32 supported_protocols,
503 struct nci_dev *ndev;
505 nfc_dbg("entry, supported_protocols 0x%x", supported_protocols);
507 if (!ops->open || !ops->close || !ops->send)
510 if (!supported_protocols)
513 ndev = kzalloc(sizeof(struct nci_dev), GFP_KERNEL);
518 ndev->tx_headroom = tx_headroom;
519 ndev->tx_tailroom = tx_tailroom;
521 ndev->nfc_dev = nfc_allocate_device(&nci_nfc_ops,
523 tx_headroom + NCI_DATA_HDR_SIZE,
528 nfc_set_drvdata(ndev->nfc_dev, ndev);
536 EXPORT_SYMBOL(nci_allocate_device);
539 * nci_free_device - deallocate nci device
541 * @ndev: The nci device to deallocate
543 void nci_free_device(struct nci_dev *ndev)
547 nfc_free_device(ndev->nfc_dev);
550 EXPORT_SYMBOL(nci_free_device);
553 * nci_register_device - register a nci device in the nfc subsystem
555 * @dev: The nci device to register
557 int nci_register_device(struct nci_dev *ndev)
560 struct device *dev = &ndev->nfc_dev->dev;
565 rc = nfc_register_device(ndev->nfc_dev);
571 INIT_WORK(&ndev->cmd_work, nci_cmd_work);
572 snprintf(name, sizeof(name), "%s_nci_cmd_wq", dev_name(dev));
573 ndev->cmd_wq = create_singlethread_workqueue(name);
579 INIT_WORK(&ndev->rx_work, nci_rx_work);
580 snprintf(name, sizeof(name), "%s_nci_rx_wq", dev_name(dev));
581 ndev->rx_wq = create_singlethread_workqueue(name);
584 goto destroy_cmd_wq_exit;
587 INIT_WORK(&ndev->tx_work, nci_tx_work);
588 snprintf(name, sizeof(name), "%s_nci_tx_wq", dev_name(dev));
589 ndev->tx_wq = create_singlethread_workqueue(name);
592 goto destroy_rx_wq_exit;
595 skb_queue_head_init(&ndev->cmd_q);
596 skb_queue_head_init(&ndev->rx_q);
597 skb_queue_head_init(&ndev->tx_q);
599 setup_timer(&ndev->cmd_timer, nci_cmd_timer,
600 (unsigned long) ndev);
602 mutex_init(&ndev->req_lock);
607 destroy_workqueue(ndev->rx_wq);
610 destroy_workqueue(ndev->cmd_wq);
613 nfc_unregister_device(ndev->nfc_dev);
618 EXPORT_SYMBOL(nci_register_device);
621 * nci_unregister_device - unregister a nci device in the nfc subsystem
623 * @dev: The nci device to unregister
625 void nci_unregister_device(struct nci_dev *ndev)
629 nci_close_device(ndev);
631 destroy_workqueue(ndev->cmd_wq);
632 destroy_workqueue(ndev->rx_wq);
633 destroy_workqueue(ndev->tx_wq);
635 nfc_unregister_device(ndev->nfc_dev);
637 EXPORT_SYMBOL(nci_unregister_device);
640 * nci_recv_frame - receive frame from NCI drivers
642 * @skb: The sk_buff to receive
644 int nci_recv_frame(struct sk_buff *skb)
646 struct nci_dev *ndev = (struct nci_dev *) skb->dev;
648 nfc_dbg("entry, len %d", skb->len);
650 if (!ndev || (!test_bit(NCI_UP, &ndev->flags)
651 && !test_bit(NCI_INIT, &ndev->flags))) {
656 /* Queue frame for rx worker thread */
657 skb_queue_tail(&ndev->rx_q, skb);
658 queue_work(ndev->rx_wq, &ndev->rx_work);
662 EXPORT_SYMBOL(nci_recv_frame);
664 static int nci_send_frame(struct sk_buff *skb)
666 struct nci_dev *ndev = (struct nci_dev *) skb->dev;
668 nfc_dbg("entry, len %d", skb->len);
675 /* Get rid of skb owner, prior to sending to the driver. */
678 return ndev->ops->send(skb);
681 /* Send NCI command */
682 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload)
684 struct nci_ctrl_hdr *hdr;
687 nfc_dbg("entry, opcode 0x%x, plen %d", opcode, plen);
689 skb = nci_skb_alloc(ndev, (NCI_CTRL_HDR_SIZE + plen), GFP_KERNEL);
691 nfc_err("no memory for command");
695 hdr = (struct nci_ctrl_hdr *) skb_put(skb, NCI_CTRL_HDR_SIZE);
696 hdr->gid = nci_opcode_gid(opcode);
697 hdr->oid = nci_opcode_oid(opcode);
700 nci_mt_set((__u8 *)hdr, NCI_MT_CMD_PKT);
701 nci_pbf_set((__u8 *)hdr, NCI_PBF_LAST);
704 memcpy(skb_put(skb, plen), payload, plen);
706 skb->dev = (void *) ndev;
708 skb_queue_tail(&ndev->cmd_q, skb);
709 queue_work(ndev->cmd_wq, &ndev->cmd_work);
714 /* ---- NCI TX Data worker thread ---- */
716 static void nci_tx_work(struct work_struct *work)
718 struct nci_dev *ndev = container_of(work, struct nci_dev, tx_work);
721 nfc_dbg("entry, credits_cnt %d", atomic_read(&ndev->credits_cnt));
723 /* Send queued tx data */
724 while (atomic_read(&ndev->credits_cnt)) {
725 skb = skb_dequeue(&ndev->tx_q);
729 atomic_dec(&ndev->credits_cnt);
731 nfc_dbg("NCI TX: MT=data, PBF=%d, conn_id=%d, plen=%d",
733 nci_conn_id(skb->data),
734 nci_plen(skb->data));
740 /* ----- NCI RX worker thread (data & control) ----- */
742 static void nci_rx_work(struct work_struct *work)
744 struct nci_dev *ndev = container_of(work, struct nci_dev, rx_work);
747 while ((skb = skb_dequeue(&ndev->rx_q))) {
749 switch (nci_mt(skb->data)) {
751 nci_rsp_packet(ndev, skb);
755 nci_ntf_packet(ndev, skb);
758 case NCI_MT_DATA_PKT:
759 nci_rx_data_packet(ndev, skb);
763 nfc_err("unknown MT 0x%x", nci_mt(skb->data));
770 /* ----- NCI TX CMD worker thread ----- */
772 static void nci_cmd_work(struct work_struct *work)
774 struct nci_dev *ndev = container_of(work, struct nci_dev, cmd_work);
777 nfc_dbg("entry, cmd_cnt %d", atomic_read(&ndev->cmd_cnt));
779 /* Send queued command */
780 if (atomic_read(&ndev->cmd_cnt)) {
781 skb = skb_dequeue(&ndev->cmd_q);
785 atomic_dec(&ndev->cmd_cnt);
787 nfc_dbg("NCI TX: MT=cmd, PBF=%d, GID=0x%x, OID=0x%x, plen=%d",
789 nci_opcode_gid(nci_opcode(skb->data)),
790 nci_opcode_oid(nci_opcode(skb->data)),
791 nci_plen(skb->data));
795 mod_timer(&ndev->cmd_timer,
796 jiffies + msecs_to_jiffies(NCI_CMD_TIMEOUT));