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