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, see <http://www.gnu.org/licenses/>. 16 */ 17 18 #ifndef __NET_HCI_H 19 #define __NET_HCI_H 20 21 #include <linux/skbuff.h> 22 23 #include <net/nfc/nfc.h> 24 25 struct nfc_hci_dev; 26 27 struct nfc_hci_ops { 28 int (*open) (struct nfc_hci_dev *hdev); 29 void (*close) (struct nfc_hci_dev *hdev); 30 int (*load_session) (struct nfc_hci_dev *hdev); 31 int (*hci_ready) (struct nfc_hci_dev *hdev); 32 /* 33 * xmit must always send the complete buffer before 34 * returning. Returned result must be 0 for success 35 * or negative for failure. 36 */ 37 int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb); 38 int (*start_poll) (struct nfc_hci_dev *hdev, 39 u32 im_protocols, u32 tm_protocols); 40 int (*dep_link_up)(struct nfc_hci_dev *hdev, struct nfc_target *target, 41 u8 comm_mode, u8 *gb, size_t gb_len); 42 int (*dep_link_down)(struct nfc_hci_dev *hdev); 43 int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate, 44 struct nfc_target *target); 45 int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate, 46 struct nfc_target *target); 47 int (*im_transceive) (struct nfc_hci_dev *hdev, 48 struct nfc_target *target, struct sk_buff *skb, 49 data_exchange_cb_t cb, void *cb_context); 50 int (*tm_send)(struct nfc_hci_dev *hdev, struct sk_buff *skb); 51 int (*check_presence)(struct nfc_hci_dev *hdev, 52 struct nfc_target *target); 53 int (*event_received)(struct nfc_hci_dev *hdev, u8 gate, u8 event, 54 struct sk_buff *skb); 55 int (*fw_download)(struct nfc_hci_dev *hdev, const char *firmware_name); 56 int (*discover_se)(struct nfc_hci_dev *dev); 57 int (*enable_se)(struct nfc_hci_dev *dev, u32 se_idx); 58 int (*disable_se)(struct nfc_hci_dev *dev, u32 se_idx); 59 }; 60 61 /* Pipes */ 62 #define NFC_HCI_INVALID_PIPE 0x80 63 #define NFC_HCI_LINK_MGMT_PIPE 0x00 64 #define NFC_HCI_ADMIN_PIPE 0x01 65 66 struct nfc_hci_gate { 67 u8 gate; 68 u8 pipe; 69 }; 70 71 #define NFC_HCI_MAX_CUSTOM_GATES 50 72 struct nfc_hci_init_data { 73 u8 gate_count; 74 struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES]; 75 char session_id[9]; 76 }; 77 78 typedef int (*xmit) (struct sk_buff *skb, void *cb_data); 79 80 #define NFC_HCI_MAX_GATES 256 81 82 /* 83 * These values can be specified by a driver to indicate it requires some 84 * adaptation of the HCI standard. 85 * 86 * NFC_HCI_QUIRK_SHORT_CLEAR - send HCI_ADM_CLEAR_ALL_PIPE cmd with no params 87 */ 88 enum { 89 NFC_HCI_QUIRK_SHORT_CLEAR = 0, 90 }; 91 92 struct nfc_hci_dev { 93 struct nfc_dev *ndev; 94 95 u32 max_data_link_payload; 96 97 bool shutting_down; 98 99 struct mutex msg_tx_mutex; 100 101 struct list_head msg_tx_queue; 102 103 struct work_struct msg_tx_work; 104 105 struct timer_list cmd_timer; 106 struct hci_msg *cmd_pending_msg; 107 108 struct sk_buff_head rx_hcp_frags; 109 110 struct work_struct msg_rx_work; 111 112 struct sk_buff_head msg_rx_queue; 113 114 struct nfc_hci_ops *ops; 115 116 struct nfc_llc *llc; 117 118 struct nfc_hci_init_data init_data; 119 120 void *clientdata; 121 122 u8 gate2pipe[NFC_HCI_MAX_GATES]; 123 124 u8 sw_romlib; 125 u8 sw_patch; 126 u8 sw_flashlib_major; 127 u8 sw_flashlib_minor; 128 129 u8 hw_derivative; 130 u8 hw_version; 131 u8 hw_mpw; 132 u8 hw_software; 133 u8 hw_bsid; 134 135 int async_cb_type; 136 data_exchange_cb_t async_cb; 137 void *async_cb_context; 138 139 u8 *gb; 140 size_t gb_len; 141 142 unsigned long quirks; 143 }; 144 145 /* hci device allocation */ 146 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops, 147 struct nfc_hci_init_data *init_data, 148 unsigned long quirks, 149 u32 protocols, 150 const char *llc_name, 151 int tx_headroom, 152 int tx_tailroom, 153 int max_link_payload); 154 void nfc_hci_free_device(struct nfc_hci_dev *hdev); 155 156 int nfc_hci_register_device(struct nfc_hci_dev *hdev); 157 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev); 158 159 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata); 160 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev); 161 162 void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err); 163 164 int nfc_hci_result_to_errno(u8 result); 165 166 /* Host IDs */ 167 #define NFC_HCI_HOST_CONTROLLER_ID 0x00 168 #define NFC_HCI_TERMINAL_HOST_ID 0x01 169 #define NFC_HCI_UICC_HOST_ID 0x02 170 171 /* Host Controller Gates and registry indexes */ 172 #define NFC_HCI_ADMIN_GATE 0x00 173 #define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01 174 #define NFC_HCI_ADMIN_MAX_PIPE 0x02 175 #define NFC_HCI_ADMIN_WHITELIST 0x03 176 #define NFC_HCI_ADMIN_HOST_LIST 0x04 177 178 #define NFC_HCI_LOOPBACK_GATE 0x04 179 180 #define NFC_HCI_ID_MGMT_GATE 0x05 181 #define NFC_HCI_ID_MGMT_VERSION_SW 0x01 182 #define NFC_HCI_ID_MGMT_VERSION_HW 0x03 183 #define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04 184 #define NFC_HCI_ID_MGMT_MODEL_ID 0x05 185 #define NFC_HCI_ID_MGMT_HCI_VERSION 0x02 186 #define NFC_HCI_ID_MGMT_GATES_LIST 0x06 187 188 #define NFC_HCI_LINK_MGMT_GATE 0x06 189 #define NFC_HCI_LINK_MGMT_REC_ERROR 0x01 190 191 #define NFC_HCI_RF_READER_B_GATE 0x11 192 #define NFC_HCI_RF_READER_B_PUPI 0x03 193 #define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04 194 #define NFC_HCI_RF_READER_B_AFI 0x02 195 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01 196 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05 197 198 #define NFC_HCI_RF_READER_A_GATE 0x13 199 #define NFC_HCI_RF_READER_A_UID 0x02 200 #define NFC_HCI_RF_READER_A_ATQA 0x04 201 #define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05 202 #define NFC_HCI_RF_READER_A_SAK 0x03 203 #define NFC_HCI_RF_READER_A_FWI_SFGT 0x06 204 #define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01 205 206 #define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5) 207 #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0 208 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1 209 #define NFC_HCI_TYPE_A_SEL_PROT_DEP 2 210 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3 211 212 /* Generic events */ 213 #define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01 214 #define NFC_HCI_EVT_POST_DATA 0x02 215 #define NFC_HCI_EVT_HOT_PLUG 0x03 216 217 /* Reader RF gates events */ 218 #define NFC_HCI_EVT_READER_REQUESTED 0x10 219 #define NFC_HCI_EVT_END_OPERATION 0x11 220 221 /* Reader Application gate events */ 222 #define NFC_HCI_EVT_TARGET_DISCOVERED 0x10 223 224 /* receiving messages from lower layer */ 225 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result, 226 struct sk_buff *skb); 227 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd, 228 struct sk_buff *skb); 229 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event, 230 struct sk_buff *skb); 231 void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb); 232 233 /* connecting to gates and sending hci instructions */ 234 int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate, 235 u8 pipe); 236 int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate); 237 int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev); 238 int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, 239 struct sk_buff **skb); 240 int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, 241 const u8 *param, size_t param_len); 242 int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd, 243 const u8 *param, size_t param_len, struct sk_buff **skb); 244 int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd, 245 const u8 *param, size_t param_len, 246 data_exchange_cb_t cb, void *cb_context); 247 int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response, 248 const u8 *param, size_t param_len); 249 int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event, 250 const u8 *param, size_t param_len); 251 int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate); 252 u32 nfc_hci_sak_to_protocol(u8 sak); 253 254 #endif /* __NET_HCI_H */ 255