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