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