2 * Copyright (C) 2012 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the
16 * Free Software Foundation, Inc.,
17 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 #define pr_fmt(fmt) "hci: %s: " fmt, __func__
22 #include <linux/init.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/nfc.h>
27 #include <net/nfc/nfc.h>
28 #include <net/nfc/hci.h>
29 #include <net/nfc/llc.h>
33 /* Largest headroom needed for outgoing HCI commands */
34 #define HCI_CMDS_HEADROOM 1
36 static int nfc_hci_result_to_errno(u8 result)
41 case NFC_HCI_ANY_E_TIMEOUT:
48 static void nfc_hci_msg_tx_work(struct work_struct *work)
50 struct nfc_hci_dev *hdev = container_of(work, struct nfc_hci_dev,
56 mutex_lock(&hdev->msg_tx_mutex);
58 if (hdev->cmd_pending_msg) {
59 if (timer_pending(&hdev->cmd_timer) == 0) {
60 if (hdev->cmd_pending_msg->cb)
61 hdev->cmd_pending_msg->cb(hdev->
66 kfree(hdev->cmd_pending_msg);
67 hdev->cmd_pending_msg = NULL;
73 if (list_empty(&hdev->msg_tx_queue))
76 msg = list_first_entry(&hdev->msg_tx_queue, struct hci_msg, msg_l);
77 list_del(&msg->msg_l);
79 pr_debug("msg_tx_queue has a cmd to send\n");
80 while ((skb = skb_dequeue(&msg->msg_frags)) != NULL) {
81 r = nfc_llc_xmit_from_hci(hdev->llc, skb);
84 skb_queue_purge(&msg->msg_frags);
86 msg->cb(msg->cb_context, NULL, r);
95 if (msg->wait_response == false) {
100 hdev->cmd_pending_msg = msg;
101 mod_timer(&hdev->cmd_timer, jiffies +
102 msecs_to_jiffies(hdev->cmd_pending_msg->completion_delay));
105 mutex_unlock(&hdev->msg_tx_mutex);
108 static void nfc_hci_msg_rx_work(struct work_struct *work)
110 struct nfc_hci_dev *hdev = container_of(work, struct nfc_hci_dev,
113 struct hcp_message *message;
118 while ((skb = skb_dequeue(&hdev->msg_rx_queue)) != NULL) {
120 skb_pull(skb, NFC_HCI_HCP_PACKET_HEADER_LEN);
121 message = (struct hcp_message *)skb->data;
122 type = HCP_MSG_GET_TYPE(message->header);
123 instruction = HCP_MSG_GET_CMD(message->header);
124 skb_pull(skb, NFC_HCI_HCP_MESSAGE_HEADER_LEN);
126 nfc_hci_hcp_message_rx(hdev, pipe, type, instruction, skb);
130 static void __nfc_hci_cmd_completion(struct nfc_hci_dev *hdev, int err,
133 del_timer_sync(&hdev->cmd_timer);
135 if (hdev->cmd_pending_msg->cb)
136 hdev->cmd_pending_msg->cb(hdev->cmd_pending_msg->cb_context,
141 kfree(hdev->cmd_pending_msg);
142 hdev->cmd_pending_msg = NULL;
144 schedule_work(&hdev->msg_tx_work);
147 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
150 mutex_lock(&hdev->msg_tx_mutex);
152 if (hdev->cmd_pending_msg == NULL) {
157 __nfc_hci_cmd_completion(hdev, nfc_hci_result_to_errno(result), skb);
160 mutex_unlock(&hdev->msg_tx_mutex);
163 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
169 static u32 nfc_hci_sak_to_protocol(u8 sak)
171 switch (NFC_HCI_TYPE_A_SEL_PROT(sak)) {
172 case NFC_HCI_TYPE_A_SEL_PROT_MIFARE:
173 return NFC_PROTO_MIFARE_MASK;
174 case NFC_HCI_TYPE_A_SEL_PROT_ISO14443:
175 return NFC_PROTO_ISO14443_MASK;
176 case NFC_HCI_TYPE_A_SEL_PROT_DEP:
177 return NFC_PROTO_NFC_DEP_MASK;
178 case NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP:
179 return NFC_PROTO_ISO14443_MASK | NFC_PROTO_NFC_DEP_MASK;
185 int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate)
187 struct nfc_target *targets;
188 struct sk_buff *atqa_skb = NULL;
189 struct sk_buff *sak_skb = NULL;
190 struct sk_buff *uid_skb = NULL;
193 pr_debug("from gate %d\n", gate);
195 targets = kzalloc(sizeof(struct nfc_target), GFP_KERNEL);
200 case NFC_HCI_RF_READER_A_GATE:
201 r = nfc_hci_get_param(hdev, NFC_HCI_RF_READER_A_GATE,
202 NFC_HCI_RF_READER_A_ATQA, &atqa_skb);
206 r = nfc_hci_get_param(hdev, NFC_HCI_RF_READER_A_GATE,
207 NFC_HCI_RF_READER_A_SAK, &sak_skb);
211 if (atqa_skb->len != 2 || sak_skb->len != 1) {
216 targets->supported_protocols =
217 nfc_hci_sak_to_protocol(sak_skb->data[0]);
218 if (targets->supported_protocols == 0xffffffff) {
223 targets->sens_res = be16_to_cpu(*(u16 *)atqa_skb->data);
224 targets->sel_res = sak_skb->data[0];
226 r = nfc_hci_get_param(hdev, NFC_HCI_RF_READER_A_GATE,
227 NFC_HCI_RF_READER_A_UID, &uid_skb);
231 if (uid_skb->len == 0 || uid_skb->len > NFC_NFCID1_MAXSIZE) {
236 memcpy(targets->nfcid1, uid_skb->data, uid_skb->len);
237 targets->nfcid1_len = uid_skb->len;
239 if (hdev->ops->complete_target_discovered) {
240 r = hdev->ops->complete_target_discovered(hdev, gate,
246 case NFC_HCI_RF_READER_B_GATE:
247 targets->supported_protocols = NFC_PROTO_ISO14443_B_MASK;
250 if (hdev->ops->target_from_gate)
251 r = hdev->ops->target_from_gate(hdev, gate, targets);
257 if (hdev->ops->complete_target_discovered) {
258 r = hdev->ops->complete_target_discovered(hdev, gate,
266 targets->hci_reader_gate = gate;
268 r = nfc_targets_found(hdev->ndev, targets, 1);
278 EXPORT_SYMBOL(nfc_hci_target_discovered);
280 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
286 case NFC_HCI_EVT_TARGET_DISCOVERED:
287 if (skb->len < 1) { /* no status data? */
292 if (skb->data[0] == 3) {
293 /* TODO: Multiple targets in field, none activated
294 * poll is supposedly stopped, but there is no
295 * single target to activate, so nothing to report
297 * if we need to restart poll, we must save the
298 * protocols from the initial poll and reuse here.
302 if (skb->data[0] != 0) {
307 r = nfc_hci_target_discovered(hdev,
308 nfc_hci_pipe2gate(hdev, pipe));
311 if (hdev->ops->event_received) {
312 hdev->ops->event_received(hdev,
313 nfc_hci_pipe2gate(hdev, pipe),
325 /* TODO: There was an error dispatching the event,
326 * how to propagate up to nfc core?
331 static void nfc_hci_cmd_timeout(unsigned long data)
333 struct nfc_hci_dev *hdev = (struct nfc_hci_dev *)data;
335 schedule_work(&hdev->msg_tx_work);
338 static int hci_dev_connect_gates(struct nfc_hci_dev *hdev, u8 gate_count,
339 struct nfc_hci_gate *gates)
342 while (gate_count--) {
343 r = nfc_hci_connect_gate(hdev, NFC_HCI_HOST_CONTROLLER_ID,
344 gates->gate, gates->pipe);
353 static int hci_dev_session_init(struct nfc_hci_dev *hdev)
355 struct sk_buff *skb = NULL;
358 if (hdev->init_data.gates[0].gate != NFC_HCI_ADMIN_GATE)
361 r = nfc_hci_connect_gate(hdev, NFC_HCI_HOST_CONTROLLER_ID,
362 hdev->init_data.gates[0].gate,
363 hdev->init_data.gates[0].pipe);
367 r = nfc_hci_get_param(hdev, NFC_HCI_ADMIN_GATE,
368 NFC_HCI_ADMIN_SESSION_IDENTITY, &skb);
372 if (skb->len && skb->len == strlen(hdev->init_data.session_id))
373 if (memcmp(hdev->init_data.session_id, skb->data,
375 /* TODO ELa: restore gate<->pipe table from
377 * note: it doesn't seem possible to get the chip
378 * currently open gate/pipe table.
379 * It is only possible to obtain the supported
384 * For now, always do a full initialization */
387 r = nfc_hci_disconnect_all_gates(hdev);
391 r = hci_dev_connect_gates(hdev, hdev->init_data.gate_count,
392 hdev->init_data.gates);
396 r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
397 NFC_HCI_ADMIN_SESSION_IDENTITY,
398 hdev->init_data.session_id,
399 strlen(hdev->init_data.session_id));
404 nfc_hci_disconnect_all_gates(hdev);
412 static int hci_dev_version(struct nfc_hci_dev *hdev)
417 r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
418 NFC_HCI_ID_MGMT_VERSION_SW, &skb);
427 hdev->sw_romlib = (skb->data[0] & 0xf0) >> 4;
428 hdev->sw_patch = skb->data[0] & 0x0f;
429 hdev->sw_flashlib_major = skb->data[1];
430 hdev->sw_flashlib_minor = skb->data[2];
434 r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
435 NFC_HCI_ID_MGMT_VERSION_HW, &skb);
444 hdev->hw_derivative = (skb->data[0] & 0xe0) >> 5;
445 hdev->hw_version = skb->data[0] & 0x1f;
446 hdev->hw_mpw = (skb->data[1] & 0xc0) >> 6;
447 hdev->hw_software = skb->data[1] & 0x3f;
448 hdev->hw_bsid = skb->data[2];
452 pr_info("SOFTWARE INFO:\n");
453 pr_info("RomLib : %d\n", hdev->sw_romlib);
454 pr_info("Patch : %d\n", hdev->sw_patch);
455 pr_info("FlashLib Major : %d\n", hdev->sw_flashlib_major);
456 pr_info("FlashLib Minor : %d\n", hdev->sw_flashlib_minor);
457 pr_info("HARDWARE INFO:\n");
458 pr_info("Derivative : %d\n", hdev->hw_derivative);
459 pr_info("HW Version : %d\n", hdev->hw_version);
460 pr_info("#MPW : %d\n", hdev->hw_mpw);
461 pr_info("Software : %d\n", hdev->hw_software);
462 pr_info("BSID Version : %d\n", hdev->hw_bsid);
467 static int hci_dev_up(struct nfc_dev *nfc_dev)
469 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
472 if (hdev->ops->open) {
473 r = hdev->ops->open(hdev);
478 r = nfc_llc_start(hdev->llc);
482 r = hci_dev_session_init(hdev);
486 r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
487 NFC_HCI_EVT_END_OPERATION, NULL, 0);
491 if (hdev->ops->hci_ready) {
492 r = hdev->ops->hci_ready(hdev);
497 r = hci_dev_version(hdev);
504 nfc_llc_stop(hdev->llc);
507 if (hdev->ops->close)
508 hdev->ops->close(hdev);
513 static int hci_dev_down(struct nfc_dev *nfc_dev)
515 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
517 nfc_llc_stop(hdev->llc);
519 if (hdev->ops->close)
520 hdev->ops->close(hdev);
522 memset(hdev->gate2pipe, NFC_HCI_INVALID_PIPE, sizeof(hdev->gate2pipe));
527 static int hci_start_poll(struct nfc_dev *nfc_dev,
528 u32 im_protocols, u32 tm_protocols)
530 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
532 if (hdev->ops->start_poll)
533 return hdev->ops->start_poll(hdev, im_protocols, tm_protocols);
535 return nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
536 NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
539 static void hci_stop_poll(struct nfc_dev *nfc_dev)
541 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
543 nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
544 NFC_HCI_EVT_END_OPERATION, NULL, 0);
547 static int hci_activate_target(struct nfc_dev *nfc_dev,
548 struct nfc_target *target, u32 protocol)
553 static void hci_deactivate_target(struct nfc_dev *nfc_dev,
554 struct nfc_target *target)
558 #define HCI_CB_TYPE_TRANSCEIVE 1
560 static void hci_transceive_cb(void *context, struct sk_buff *skb, int err)
562 struct nfc_hci_dev *hdev = context;
564 switch (hdev->async_cb_type) {
565 case HCI_CB_TYPE_TRANSCEIVE:
567 * TODO: Check RF Error indicator to make sure data is valid.
568 * It seems that HCI cmd can complete without error, but data
569 * can be invalid if an RF error occured? Ignore for now.
572 skb_trim(skb, skb->len - 1); /* RF Err ind */
574 hdev->async_cb(hdev->async_cb_context, skb, err);
583 static int hci_transceive(struct nfc_dev *nfc_dev, struct nfc_target *target,
584 struct sk_buff *skb, data_exchange_cb_t cb,
587 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
590 pr_debug("target_idx=%d\n", target->idx);
592 switch (target->hci_reader_gate) {
593 case NFC_HCI_RF_READER_A_GATE:
594 case NFC_HCI_RF_READER_B_GATE:
595 if (hdev->ops->data_exchange) {
596 r = hdev->ops->data_exchange(hdev, target, skb, cb,
598 if (r <= 0) /* handled */
602 *skb_push(skb, 1) = 0; /* CTR, see spec:10.2.2.1 */
604 hdev->async_cb_type = HCI_CB_TYPE_TRANSCEIVE;
606 hdev->async_cb_context = cb_context;
608 r = nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
609 NFC_HCI_WR_XCHG_DATA, skb->data,
610 skb->len, hci_transceive_cb, hdev);
613 if (hdev->ops->data_exchange) {
614 r = hdev->ops->data_exchange(hdev, target, skb, cb,
629 static int hci_check_presence(struct nfc_dev *nfc_dev,
630 struct nfc_target *target)
632 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
634 if (hdev->ops->check_presence)
635 return hdev->ops->check_presence(hdev, target);
640 static void nfc_hci_failure(struct nfc_hci_dev *hdev, int err)
642 mutex_lock(&hdev->msg_tx_mutex);
644 if (hdev->cmd_pending_msg == NULL) {
645 nfc_driver_failure(hdev->ndev, err);
649 __nfc_hci_cmd_completion(hdev, err, NULL);
652 mutex_unlock(&hdev->msg_tx_mutex);
655 static void nfc_hci_llc_failure(struct nfc_hci_dev *hdev, int err)
657 nfc_hci_failure(hdev, err);
660 static void nfc_hci_recv_from_llc(struct nfc_hci_dev *hdev, struct sk_buff *skb)
662 struct hcp_packet *packet;
665 struct sk_buff *hcp_skb;
667 struct sk_buff *frag_skb;
670 packet = (struct hcp_packet *)skb->data;
671 if ((packet->header & ~NFC_HCI_FRAGMENT) == 0) {
672 skb_queue_tail(&hdev->rx_hcp_frags, skb);
676 /* it's the last fragment. Does it need re-aggregation? */
677 if (skb_queue_len(&hdev->rx_hcp_frags)) {
678 pipe = packet->header & NFC_HCI_FRAGMENT;
679 skb_queue_tail(&hdev->rx_hcp_frags, skb);
682 skb_queue_walk(&hdev->rx_hcp_frags, frag_skb) {
683 msg_len += (frag_skb->len -
684 NFC_HCI_HCP_PACKET_HEADER_LEN);
687 hcp_skb = nfc_alloc_recv_skb(NFC_HCI_HCP_PACKET_HEADER_LEN +
688 msg_len, GFP_KERNEL);
689 if (hcp_skb == NULL) {
690 nfc_hci_failure(hdev, -ENOMEM);
694 *skb_put(hcp_skb, NFC_HCI_HCP_PACKET_HEADER_LEN) = pipe;
696 skb_queue_walk(&hdev->rx_hcp_frags, frag_skb) {
697 msg_len = frag_skb->len - NFC_HCI_HCP_PACKET_HEADER_LEN;
698 memcpy(skb_put(hcp_skb, msg_len),
699 frag_skb->data + NFC_HCI_HCP_PACKET_HEADER_LEN,
703 skb_queue_purge(&hdev->rx_hcp_frags);
705 packet->header &= NFC_HCI_FRAGMENT;
709 /* if this is a response, dispatch immediately to
710 * unblock waiting cmd context. Otherwise, enqueue to dispatch
711 * in separate context where handler can also execute command.
713 packet = (struct hcp_packet *)hcp_skb->data;
714 type = HCP_MSG_GET_TYPE(packet->message.header);
715 if (type == NFC_HCI_HCP_RESPONSE) {
716 pipe = packet->header;
717 instruction = HCP_MSG_GET_CMD(packet->message.header);
718 skb_pull(hcp_skb, NFC_HCI_HCP_PACKET_HEADER_LEN +
719 NFC_HCI_HCP_MESSAGE_HEADER_LEN);
720 nfc_hci_hcp_message_rx(hdev, pipe, type, instruction, hcp_skb);
722 skb_queue_tail(&hdev->msg_rx_queue, hcp_skb);
723 schedule_work(&hdev->msg_rx_work);
727 static struct nfc_ops hci_nfc_ops = {
728 .dev_up = hci_dev_up,
729 .dev_down = hci_dev_down,
730 .start_poll = hci_start_poll,
731 .stop_poll = hci_stop_poll,
732 .activate_target = hci_activate_target,
733 .deactivate_target = hci_deactivate_target,
734 .im_transceive = hci_transceive,
735 .check_presence = hci_check_presence,
738 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
739 struct nfc_hci_init_data *init_data,
741 const char *llc_name,
744 int max_link_payload)
746 struct nfc_hci_dev *hdev;
748 if (ops->xmit == NULL)
754 hdev = kzalloc(sizeof(struct nfc_hci_dev), GFP_KERNEL);
758 hdev->llc = nfc_llc_allocate(llc_name, hdev, ops->xmit,
759 nfc_hci_recv_from_llc, tx_headroom,
760 tx_tailroom, nfc_hci_llc_failure);
761 if (hdev->llc == NULL) {
766 hdev->ndev = nfc_allocate_device(&hci_nfc_ops, protocols,
767 tx_headroom + HCI_CMDS_HEADROOM,
770 nfc_llc_free(hdev->llc);
776 hdev->max_data_link_payload = max_link_payload;
777 hdev->init_data = *init_data;
779 nfc_set_drvdata(hdev->ndev, hdev);
781 memset(hdev->gate2pipe, NFC_HCI_INVALID_PIPE, sizeof(hdev->gate2pipe));
785 EXPORT_SYMBOL(nfc_hci_allocate_device);
787 void nfc_hci_free_device(struct nfc_hci_dev *hdev)
789 nfc_free_device(hdev->ndev);
790 nfc_llc_free(hdev->llc);
793 EXPORT_SYMBOL(nfc_hci_free_device);
795 int nfc_hci_register_device(struct nfc_hci_dev *hdev)
797 mutex_init(&hdev->msg_tx_mutex);
799 INIT_LIST_HEAD(&hdev->msg_tx_queue);
801 INIT_WORK(&hdev->msg_tx_work, nfc_hci_msg_tx_work);
803 init_timer(&hdev->cmd_timer);
804 hdev->cmd_timer.data = (unsigned long)hdev;
805 hdev->cmd_timer.function = nfc_hci_cmd_timeout;
807 skb_queue_head_init(&hdev->rx_hcp_frags);
809 INIT_WORK(&hdev->msg_rx_work, nfc_hci_msg_rx_work);
811 skb_queue_head_init(&hdev->msg_rx_queue);
813 return nfc_register_device(hdev->ndev);
815 EXPORT_SYMBOL(nfc_hci_register_device);
817 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev)
819 struct hci_msg *msg, *n;
821 skb_queue_purge(&hdev->rx_hcp_frags);
822 skb_queue_purge(&hdev->msg_rx_queue);
824 list_for_each_entry_safe(msg, n, &hdev->msg_tx_queue, msg_l) {
825 list_del(&msg->msg_l);
826 skb_queue_purge(&msg->msg_frags);
830 del_timer_sync(&hdev->cmd_timer);
832 nfc_unregister_device(hdev->ndev);
834 cancel_work_sync(&hdev->msg_tx_work);
835 cancel_work_sync(&hdev->msg_rx_work);
837 EXPORT_SYMBOL(nfc_hci_unregister_device);
839 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata)
841 hdev->clientdata = clientdata;
843 EXPORT_SYMBOL(nfc_hci_set_clientdata);
845 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev)
847 return hdev->clientdata;
849 EXPORT_SYMBOL(nfc_hci_get_clientdata);
851 void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err)
853 nfc_hci_failure(hdev, err);
855 EXPORT_SYMBOL(nfc_hci_driver_failure);
857 void inline nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb)
859 nfc_llc_rcv_from_drv(hdev->llc, skb);
861 EXPORT_SYMBOL(nfc_hci_recv_frame);
863 static int __init nfc_hci_init(void)
865 return nfc_llc_init();
868 static void __exit nfc_hci_exit(void)
873 subsys_initcall(nfc_hci_init);
874 module_exit(nfc_hci_exit);
876 MODULE_LICENSE("GPL");
877 MODULE_DESCRIPTION("NFC HCI Core");