1 /* 2 * Copyright (C) 2011 Intel Corporation. All rights reserved. 3 * 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. 8 * 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. 13 * 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. 18 */ 19 20 #ifndef __NET_HCI_H 21 #define __NET_HCI_H 22 23 #include <linux/skbuff.h> 24 25 #include <net/nfc/nfc.h> 26 27 struct nfc_hci_dev; 28 29 struct nfc_hci_ops { 30 int (*open) (struct nfc_hci_dev *hdev); 31 void (*close) (struct nfc_hci_dev *hdev); 32 int (*hci_ready) (struct nfc_hci_dev *hdev); 33 int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb); 34 int (*start_poll) (struct nfc_hci_dev *hdev, u32 protocols); 35 int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate, 36 struct nfc_target *target); 37 int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate, 38 struct nfc_target *target); 39 int (*data_exchange) (struct nfc_hci_dev *hdev, 40 struct nfc_target *target, 41 struct sk_buff *skb, struct sk_buff **res_skb); 42 }; 43 44 #define NFC_HCI_MAX_CUSTOM_GATES 15 45 struct nfc_hci_init_data { 46 u8 gate_count; 47 u8 gates[NFC_HCI_MAX_CUSTOM_GATES]; 48 char session_id[9]; 49 }; 50 51 typedef int (*xmit) (struct sk_buff *skb, void *cb_data); 52 53 #define NFC_HCI_MAX_GATES 256 54 55 struct nfc_hci_dev { 56 struct nfc_dev *ndev; 57 58 u32 max_data_link_payload; 59 60 struct mutex msg_tx_mutex; 61 62 struct list_head msg_tx_queue; 63 64 struct workqueue_struct *msg_tx_wq; 65 struct work_struct msg_tx_work; 66 67 struct timer_list cmd_timer; 68 struct hci_msg *cmd_pending_msg; 69 70 struct sk_buff_head rx_hcp_frags; 71 72 struct workqueue_struct *msg_rx_wq; 73 struct work_struct msg_rx_work; 74 75 struct sk_buff_head msg_rx_queue; 76 77 struct nfc_hci_ops *ops; 78 79 struct nfc_hci_init_data init_data; 80 81 void *clientdata; 82 83 u8 gate2pipe[NFC_HCI_MAX_GATES]; 84 85 bool poll_started; 86 struct nfc_target *targets; 87 int target_count; 88 89 u8 sw_romlib; 90 u8 sw_patch; 91 u8 sw_flashlib_major; 92 u8 sw_flashlib_minor; 93 94 u8 hw_derivative; 95 u8 hw_version; 96 u8 hw_mpw; 97 u8 hw_software; 98 u8 hw_bsid; 99 }; 100 101 /* hci device allocation */ 102 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops, 103 struct nfc_hci_init_data *init_data, 104 u32 protocols, 105 int tx_headroom, 106 int tx_tailroom, 107 int max_link_payload); 108 void nfc_hci_free_device(struct nfc_hci_dev *hdev); 109 110 int nfc_hci_register_device(struct nfc_hci_dev *hdev); 111 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev); 112 113 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata); 114 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev); 115 116 /* Host IDs */ 117 #define NFC_HCI_HOST_CONTROLLER_ID 0x00 118 #define NFC_HCI_TERMINAL_HOST_ID 0x01 119 #define NFC_HCI_UICC_HOST_ID 0x02 120 121 /* Host Controller Gates and registry indexes */ 122 #define NFC_HCI_ADMIN_GATE 0x00 123 #define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01 124 #define NFC_HCI_ADMIN_MAX_PIPE 0x02 125 #define NFC_HCI_ADMIN_WHITELIST 0x03 126 #define NFC_HCI_ADMIN_HOST_LIST 0x04 127 128 #define NFC_HCI_LOOPBACK_GATE 0x04 129 130 #define NFC_HCI_ID_MGMT_GATE 0x05 131 #define NFC_HCI_ID_MGMT_VERSION_SW 0x01 132 #define NFC_HCI_ID_MGMT_VERSION_HW 0x03 133 #define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04 134 #define NFC_HCI_ID_MGMT_MODEL_ID 0x05 135 #define NFC_HCI_ID_MGMT_HCI_VERSION 0x02 136 #define NFC_HCI_ID_MGMT_GATES_LIST 0x06 137 138 #define NFC_HCI_LINK_MGMT_GATE 0x06 139 #define NFC_HCI_LINK_MGMT_REC_ERROR 0x01 140 141 #define NFC_HCI_RF_READER_B_GATE 0x11 142 #define NFC_HCI_RF_READER_B_PUPI 0x03 143 #define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04 144 #define NFC_HCI_RF_READER_B_AFI 0x02 145 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01 146 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05 147 148 #define NFC_HCI_RF_READER_A_GATE 0x13 149 #define NFC_HCI_RF_READER_A_UID 0x02 150 #define NFC_HCI_RF_READER_A_ATQA 0x04 151 #define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05 152 #define NFC_HCI_RF_READER_A_SAK 0x03 153 #define NFC_HCI_RF_READER_A_FWI_SFGT 0x06 154 #define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01 155 156 #define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5) 157 #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0 158 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1 159 #define NFC_HCI_TYPE_A_SEL_PROT_DEP 2 160 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3 161 162 /* Generic events */ 163 #define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01 164 #define NFC_HCI_EVT_POST_DATA 0x02 165 #define NFC_HCI_EVT_HOT_PLUG 0x03 166 167 /* Reader RF gates events */ 168 #define NFC_HCI_EVT_READER_REQUESTED 0x10 169 #define NFC_HCI_EVT_END_OPERATION 0x11 170 171 /* Reader Application gate events */ 172 #define NFC_HCI_EVT_TARGET_DISCOVERED 0x10 173 174 /* receiving messages from lower layer */ 175 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result, 176 struct sk_buff *skb); 177 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd, 178 struct sk_buff *skb); 179 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event, 180 struct sk_buff *skb); 181 void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb); 182 183 /* connecting to gates and sending hci instructions */ 184 int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate); 185 int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate); 186 int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev); 187 int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, 188 struct sk_buff **skb); 189 int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, 190 const u8 *param, size_t param_len); 191 int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd, 192 const u8 *param, size_t param_len, struct sk_buff **skb); 193 int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response, 194 const u8 *param, size_t param_len); 195 int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event, 196 const u8 *param, size_t param_len); 197 198 #endif /* __NET_HCI_H */ 199