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 /* if driver set the new gate, we will skip the old one */
267 if (targets->hci_reader_gate == 0x00)
268 targets->hci_reader_gate = gate;
270 r = nfc_targets_found(hdev->ndev, targets, 1);
280 EXPORT_SYMBOL(nfc_hci_target_discovered);
282 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
288 case NFC_HCI_EVT_TARGET_DISCOVERED:
289 if (skb->len < 1) { /* no status data? */
294 if (skb->data[0] == 3) {
295 /* TODO: Multiple targets in field, none activated
296 * poll is supposedly stopped, but there is no
297 * single target to activate, so nothing to report
299 * if we need to restart poll, we must save the
300 * protocols from the initial poll and reuse here.
304 if (skb->data[0] != 0) {
309 r = nfc_hci_target_discovered(hdev,
310 nfc_hci_pipe2gate(hdev, pipe));
313 if (hdev->ops->event_received) {
314 hdev->ops->event_received(hdev,
315 nfc_hci_pipe2gate(hdev, pipe),
327 /* TODO: There was an error dispatching the event,
328 * how to propagate up to nfc core?
333 static void nfc_hci_cmd_timeout(unsigned long data)
335 struct nfc_hci_dev *hdev = (struct nfc_hci_dev *)data;
337 schedule_work(&hdev->msg_tx_work);
340 static int hci_dev_connect_gates(struct nfc_hci_dev *hdev, u8 gate_count,
341 struct nfc_hci_gate *gates)
344 while (gate_count--) {
345 r = nfc_hci_connect_gate(hdev, NFC_HCI_HOST_CONTROLLER_ID,
346 gates->gate, gates->pipe);
355 static int hci_dev_session_init(struct nfc_hci_dev *hdev)
357 struct sk_buff *skb = NULL;
360 if (hdev->init_data.gates[0].gate != NFC_HCI_ADMIN_GATE)
363 r = nfc_hci_connect_gate(hdev, NFC_HCI_HOST_CONTROLLER_ID,
364 hdev->init_data.gates[0].gate,
365 hdev->init_data.gates[0].pipe);
369 r = nfc_hci_get_param(hdev, NFC_HCI_ADMIN_GATE,
370 NFC_HCI_ADMIN_SESSION_IDENTITY, &skb);
374 if (skb->len && skb->len == strlen(hdev->init_data.session_id))
375 if (memcmp(hdev->init_data.session_id, skb->data,
377 /* TODO ELa: restore gate<->pipe table from
379 * note: it doesn't seem possible to get the chip
380 * currently open gate/pipe table.
381 * It is only possible to obtain the supported
386 * For now, always do a full initialization */
389 r = nfc_hci_disconnect_all_gates(hdev);
393 r = hci_dev_connect_gates(hdev, hdev->init_data.gate_count,
394 hdev->init_data.gates);
398 r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
399 NFC_HCI_ADMIN_SESSION_IDENTITY,
400 hdev->init_data.session_id,
401 strlen(hdev->init_data.session_id));
406 nfc_hci_disconnect_all_gates(hdev);
414 static int hci_dev_version(struct nfc_hci_dev *hdev)
419 r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
420 NFC_HCI_ID_MGMT_VERSION_SW, &skb);
429 hdev->sw_romlib = (skb->data[0] & 0xf0) >> 4;
430 hdev->sw_patch = skb->data[0] & 0x0f;
431 hdev->sw_flashlib_major = skb->data[1];
432 hdev->sw_flashlib_minor = skb->data[2];
436 r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
437 NFC_HCI_ID_MGMT_VERSION_HW, &skb);
446 hdev->hw_derivative = (skb->data[0] & 0xe0) >> 5;
447 hdev->hw_version = skb->data[0] & 0x1f;
448 hdev->hw_mpw = (skb->data[1] & 0xc0) >> 6;
449 hdev->hw_software = skb->data[1] & 0x3f;
450 hdev->hw_bsid = skb->data[2];
454 pr_info("SOFTWARE INFO:\n");
455 pr_info("RomLib : %d\n", hdev->sw_romlib);
456 pr_info("Patch : %d\n", hdev->sw_patch);
457 pr_info("FlashLib Major : %d\n", hdev->sw_flashlib_major);
458 pr_info("FlashLib Minor : %d\n", hdev->sw_flashlib_minor);
459 pr_info("HARDWARE INFO:\n");
460 pr_info("Derivative : %d\n", hdev->hw_derivative);
461 pr_info("HW Version : %d\n", hdev->hw_version);
462 pr_info("#MPW : %d\n", hdev->hw_mpw);
463 pr_info("Software : %d\n", hdev->hw_software);
464 pr_info("BSID Version : %d\n", hdev->hw_bsid);
469 static int hci_dev_up(struct nfc_dev *nfc_dev)
471 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
474 if (hdev->ops->open) {
475 r = hdev->ops->open(hdev);
480 r = nfc_llc_start(hdev->llc);
484 r = hci_dev_session_init(hdev);
488 r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
489 NFC_HCI_EVT_END_OPERATION, NULL, 0);
493 if (hdev->ops->hci_ready) {
494 r = hdev->ops->hci_ready(hdev);
499 r = hci_dev_version(hdev);
506 nfc_llc_stop(hdev->llc);
509 if (hdev->ops->close)
510 hdev->ops->close(hdev);
515 static int hci_dev_down(struct nfc_dev *nfc_dev)
517 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
519 nfc_llc_stop(hdev->llc);
521 if (hdev->ops->close)
522 hdev->ops->close(hdev);
524 memset(hdev->gate2pipe, NFC_HCI_INVALID_PIPE, sizeof(hdev->gate2pipe));
529 static int hci_start_poll(struct nfc_dev *nfc_dev,
530 u32 im_protocols, u32 tm_protocols)
532 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
534 if (hdev->ops->start_poll)
535 return hdev->ops->start_poll(hdev, im_protocols, tm_protocols);
537 return nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
538 NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
541 static void hci_stop_poll(struct nfc_dev *nfc_dev)
543 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
545 nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
546 NFC_HCI_EVT_END_OPERATION, NULL, 0);
549 static int hci_activate_target(struct nfc_dev *nfc_dev,
550 struct nfc_target *target, u32 protocol)
555 static void hci_deactivate_target(struct nfc_dev *nfc_dev,
556 struct nfc_target *target)
560 #define HCI_CB_TYPE_TRANSCEIVE 1
562 static void hci_transceive_cb(void *context, struct sk_buff *skb, int err)
564 struct nfc_hci_dev *hdev = context;
566 switch (hdev->async_cb_type) {
567 case HCI_CB_TYPE_TRANSCEIVE:
569 * TODO: Check RF Error indicator to make sure data is valid.
570 * It seems that HCI cmd can complete without error, but data
571 * can be invalid if an RF error occured? Ignore for now.
574 skb_trim(skb, skb->len - 1); /* RF Err ind */
576 hdev->async_cb(hdev->async_cb_context, skb, err);
585 static int hci_transceive(struct nfc_dev *nfc_dev, struct nfc_target *target,
586 struct sk_buff *skb, data_exchange_cb_t cb,
589 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
592 pr_debug("target_idx=%d\n", target->idx);
594 switch (target->hci_reader_gate) {
595 case NFC_HCI_RF_READER_A_GATE:
596 case NFC_HCI_RF_READER_B_GATE:
597 if (hdev->ops->data_exchange) {
598 r = hdev->ops->data_exchange(hdev, target, skb, cb,
600 if (r <= 0) /* handled */
604 *skb_push(skb, 1) = 0; /* CTR, see spec:10.2.2.1 */
606 hdev->async_cb_type = HCI_CB_TYPE_TRANSCEIVE;
608 hdev->async_cb_context = cb_context;
610 r = nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
611 NFC_HCI_WR_XCHG_DATA, skb->data,
612 skb->len, hci_transceive_cb, hdev);
615 if (hdev->ops->data_exchange) {
616 r = hdev->ops->data_exchange(hdev, target, skb, cb,
631 static int hci_check_presence(struct nfc_dev *nfc_dev,
632 struct nfc_target *target)
634 struct nfc_hci_dev *hdev = nfc_get_drvdata(nfc_dev);
636 if (hdev->ops->check_presence)
637 return hdev->ops->check_presence(hdev, target);
642 static void nfc_hci_failure(struct nfc_hci_dev *hdev, int err)
644 mutex_lock(&hdev->msg_tx_mutex);
646 if (hdev->cmd_pending_msg == NULL) {
647 nfc_driver_failure(hdev->ndev, err);
651 __nfc_hci_cmd_completion(hdev, err, NULL);
654 mutex_unlock(&hdev->msg_tx_mutex);
657 static void nfc_hci_llc_failure(struct nfc_hci_dev *hdev, int err)
659 nfc_hci_failure(hdev, err);
662 static void nfc_hci_recv_from_llc(struct nfc_hci_dev *hdev, struct sk_buff *skb)
664 struct hcp_packet *packet;
667 struct sk_buff *hcp_skb;
669 struct sk_buff *frag_skb;
672 packet = (struct hcp_packet *)skb->data;
673 if ((packet->header & ~NFC_HCI_FRAGMENT) == 0) {
674 skb_queue_tail(&hdev->rx_hcp_frags, skb);
678 /* it's the last fragment. Does it need re-aggregation? */
679 if (skb_queue_len(&hdev->rx_hcp_frags)) {
680 pipe = packet->header & NFC_HCI_FRAGMENT;
681 skb_queue_tail(&hdev->rx_hcp_frags, skb);
684 skb_queue_walk(&hdev->rx_hcp_frags, frag_skb) {
685 msg_len += (frag_skb->len -
686 NFC_HCI_HCP_PACKET_HEADER_LEN);
689 hcp_skb = nfc_alloc_recv_skb(NFC_HCI_HCP_PACKET_HEADER_LEN +
690 msg_len, GFP_KERNEL);
691 if (hcp_skb == NULL) {
692 nfc_hci_failure(hdev, -ENOMEM);
696 *skb_put(hcp_skb, NFC_HCI_HCP_PACKET_HEADER_LEN) = pipe;
698 skb_queue_walk(&hdev->rx_hcp_frags, frag_skb) {
699 msg_len = frag_skb->len - NFC_HCI_HCP_PACKET_HEADER_LEN;
700 memcpy(skb_put(hcp_skb, msg_len),
701 frag_skb->data + NFC_HCI_HCP_PACKET_HEADER_LEN,
705 skb_queue_purge(&hdev->rx_hcp_frags);
707 packet->header &= NFC_HCI_FRAGMENT;
711 /* if this is a response, dispatch immediately to
712 * unblock waiting cmd context. Otherwise, enqueue to dispatch
713 * in separate context where handler can also execute command.
715 packet = (struct hcp_packet *)hcp_skb->data;
716 type = HCP_MSG_GET_TYPE(packet->message.header);
717 if (type == NFC_HCI_HCP_RESPONSE) {
718 pipe = packet->header;
719 instruction = HCP_MSG_GET_CMD(packet->message.header);
720 skb_pull(hcp_skb, NFC_HCI_HCP_PACKET_HEADER_LEN +
721 NFC_HCI_HCP_MESSAGE_HEADER_LEN);
722 nfc_hci_hcp_message_rx(hdev, pipe, type, instruction, hcp_skb);
724 skb_queue_tail(&hdev->msg_rx_queue, hcp_skb);
725 schedule_work(&hdev->msg_rx_work);
729 static struct nfc_ops hci_nfc_ops = {
730 .dev_up = hci_dev_up,
731 .dev_down = hci_dev_down,
732 .start_poll = hci_start_poll,
733 .stop_poll = hci_stop_poll,
734 .activate_target = hci_activate_target,
735 .deactivate_target = hci_deactivate_target,
736 .im_transceive = hci_transceive,
737 .check_presence = hci_check_presence,
740 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
741 struct nfc_hci_init_data *init_data,
743 const char *llc_name,
746 int max_link_payload)
748 struct nfc_hci_dev *hdev;
750 if (ops->xmit == NULL)
756 hdev = kzalloc(sizeof(struct nfc_hci_dev), GFP_KERNEL);
760 hdev->llc = nfc_llc_allocate(llc_name, hdev, ops->xmit,
761 nfc_hci_recv_from_llc, tx_headroom,
762 tx_tailroom, nfc_hci_llc_failure);
763 if (hdev->llc == NULL) {
768 hdev->ndev = nfc_allocate_device(&hci_nfc_ops, protocols,
769 tx_headroom + HCI_CMDS_HEADROOM,
772 nfc_llc_free(hdev->llc);
778 hdev->max_data_link_payload = max_link_payload;
779 hdev->init_data = *init_data;
781 nfc_set_drvdata(hdev->ndev, hdev);
783 memset(hdev->gate2pipe, NFC_HCI_INVALID_PIPE, sizeof(hdev->gate2pipe));
787 EXPORT_SYMBOL(nfc_hci_allocate_device);
789 void nfc_hci_free_device(struct nfc_hci_dev *hdev)
791 nfc_free_device(hdev->ndev);
792 nfc_llc_free(hdev->llc);
795 EXPORT_SYMBOL(nfc_hci_free_device);
797 int nfc_hci_register_device(struct nfc_hci_dev *hdev)
799 mutex_init(&hdev->msg_tx_mutex);
801 INIT_LIST_HEAD(&hdev->msg_tx_queue);
803 INIT_WORK(&hdev->msg_tx_work, nfc_hci_msg_tx_work);
805 init_timer(&hdev->cmd_timer);
806 hdev->cmd_timer.data = (unsigned long)hdev;
807 hdev->cmd_timer.function = nfc_hci_cmd_timeout;
809 skb_queue_head_init(&hdev->rx_hcp_frags);
811 INIT_WORK(&hdev->msg_rx_work, nfc_hci_msg_rx_work);
813 skb_queue_head_init(&hdev->msg_rx_queue);
815 return nfc_register_device(hdev->ndev);
817 EXPORT_SYMBOL(nfc_hci_register_device);
819 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev)
821 struct hci_msg *msg, *n;
823 skb_queue_purge(&hdev->rx_hcp_frags);
824 skb_queue_purge(&hdev->msg_rx_queue);
826 list_for_each_entry_safe(msg, n, &hdev->msg_tx_queue, msg_l) {
827 list_del(&msg->msg_l);
828 skb_queue_purge(&msg->msg_frags);
832 del_timer_sync(&hdev->cmd_timer);
834 nfc_unregister_device(hdev->ndev);
836 cancel_work_sync(&hdev->msg_tx_work);
837 cancel_work_sync(&hdev->msg_rx_work);
839 EXPORT_SYMBOL(nfc_hci_unregister_device);
841 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata)
843 hdev->clientdata = clientdata;
845 EXPORT_SYMBOL(nfc_hci_set_clientdata);
847 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev)
849 return hdev->clientdata;
851 EXPORT_SYMBOL(nfc_hci_get_clientdata);
853 void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err)
855 nfc_hci_failure(hdev, err);
857 EXPORT_SYMBOL(nfc_hci_driver_failure);
859 void inline nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb)
861 nfc_llc_rcv_from_drv(hdev->llc, skb);
863 EXPORT_SYMBOL(nfc_hci_recv_frame);
865 static int __init nfc_hci_init(void)
867 return nfc_llc_init();
870 static void __exit nfc_hci_exit(void)
875 subsys_initcall(nfc_hci_init);
876 module_exit(nfc_hci_exit);
878 MODULE_LICENSE("GPL");
879 MODULE_DESCRIPTION("NFC HCI Core");