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