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