Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 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 | |
Eric Lapuyade | 97f1841 | 2012-10-02 18:44:06 +0200 | [diff] [blame] | 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 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 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); |
Waldemar Rymarkiewicz | 96e3240 | 2012-09-20 08:59:10 +0200 | [diff] [blame] | 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 | */ |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 44 | int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb); |
Samuel Ortiz | fe7c580 | 2012-05-15 15:57:06 +0200 | [diff] [blame] | 45 | int (*start_poll) (struct nfc_hci_dev *hdev, |
| 46 | u32 im_protocols, u32 tm_protocols); |
Arron Wang | c40d174 | 2012-09-27 17:32:57 +0800 | [diff] [blame] | 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); |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 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); |
Arron Wang | e810762 | 2012-09-27 17:32:58 +0800 | [diff] [blame] | 54 | int (*im_transceive) (struct nfc_hci_dev *hdev, |
Eric Lapuyade | f3e8fb5 | 2012-09-11 10:43:50 +0200 | [diff] [blame] | 55 | struct nfc_target *target, struct sk_buff *skb, |
| 56 | data_exchange_cb_t cb, void *cb_context); |
Arron Wang | e810762 | 2012-09-27 17:32:58 +0800 | [diff] [blame] | 57 | int (*tm_send)(struct nfc_hci_dev *hdev, struct sk_buff *skb); |
Eric Lapuyade | 1676f75 | 2012-05-07 12:31:16 +0200 | [diff] [blame] | 58 | int (*check_presence)(struct nfc_hci_dev *hdev, |
| 59 | struct nfc_target *target); |
Arron Wang | f7a5f6c | 2012-09-27 17:32:55 +0800 | [diff] [blame] | 60 | void (*event_received)(struct nfc_hci_dev *hdev, u8 gate, u8 event, |
| 61 | struct sk_buff *skb); |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 62 | }; |
| 63 | |
Eric Lapuyade | a10d595 | 2012-06-05 14:42:11 +0200 | [diff] [blame] | 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 |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 75 | struct nfc_hci_init_data { |
| 76 | u8 gate_count; |
Eric Lapuyade | a10d595 | 2012-06-05 14:42:11 +0200 | [diff] [blame] | 77 | struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES]; |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 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 | |
Eric Lapuyade | f0c9103 | 2012-11-26 18:06:27 +0100 | [diff] [blame^] | 90 | bool shutting_down; |
| 91 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 92 | struct mutex msg_tx_mutex; |
| 93 | |
| 94 | struct list_head msg_tx_queue; |
| 95 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 96 | struct work_struct msg_tx_work; |
| 97 | |
| 98 | struct timer_list cmd_timer; |
| 99 | struct hci_msg *cmd_pending_msg; |
| 100 | |
| 101 | struct sk_buff_head rx_hcp_frags; |
| 102 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 103 | struct work_struct msg_rx_work; |
| 104 | |
| 105 | struct sk_buff_head msg_rx_queue; |
| 106 | |
| 107 | struct nfc_hci_ops *ops; |
| 108 | |
Eric Lapuyade | 412fda5 | 2012-09-18 19:45:48 +0200 | [diff] [blame] | 109 | struct nfc_llc *llc; |
| 110 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 111 | struct nfc_hci_init_data init_data; |
| 112 | |
| 113 | void *clientdata; |
| 114 | |
| 115 | u8 gate2pipe[NFC_HCI_MAX_GATES]; |
| 116 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 117 | u8 sw_romlib; |
| 118 | u8 sw_patch; |
| 119 | u8 sw_flashlib_major; |
| 120 | u8 sw_flashlib_minor; |
| 121 | |
| 122 | u8 hw_derivative; |
| 123 | u8 hw_version; |
| 124 | u8 hw_mpw; |
| 125 | u8 hw_software; |
| 126 | u8 hw_bsid; |
Eric Lapuyade | f3e8fb5 | 2012-09-11 10:43:50 +0200 | [diff] [blame] | 127 | |
| 128 | int async_cb_type; |
| 129 | data_exchange_cb_t async_cb; |
| 130 | void *async_cb_context; |
Arron Wang | 7e2afc9 | 2012-09-27 17:32:54 +0800 | [diff] [blame] | 131 | |
| 132 | u8 *gb; |
| 133 | size_t gb_len; |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 134 | }; |
| 135 | |
| 136 | /* hci device allocation */ |
| 137 | struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops, |
| 138 | struct nfc_hci_init_data *init_data, |
| 139 | u32 protocols, |
Eric Lapuyade | 412fda5 | 2012-09-18 19:45:48 +0200 | [diff] [blame] | 140 | const char *llc_name, |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 141 | int tx_headroom, |
| 142 | int tx_tailroom, |
| 143 | int max_link_payload); |
| 144 | void nfc_hci_free_device(struct nfc_hci_dev *hdev); |
| 145 | |
| 146 | int nfc_hci_register_device(struct nfc_hci_dev *hdev); |
| 147 | void nfc_hci_unregister_device(struct nfc_hci_dev *hdev); |
| 148 | |
| 149 | void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata); |
| 150 | void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev); |
| 151 | |
Eric Lapuyade | a9a741a | 2012-04-30 18:21:51 +0200 | [diff] [blame] | 152 | void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err); |
| 153 | |
Eric Lapuyade | 84d4819 | 2012-10-17 16:50:10 +0200 | [diff] [blame] | 154 | int nfc_hci_result_to_errno(u8 result); |
| 155 | |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 156 | /* Host IDs */ |
| 157 | #define NFC_HCI_HOST_CONTROLLER_ID 0x00 |
| 158 | #define NFC_HCI_TERMINAL_HOST_ID 0x01 |
| 159 | #define NFC_HCI_UICC_HOST_ID 0x02 |
| 160 | |
| 161 | /* Host Controller Gates and registry indexes */ |
| 162 | #define NFC_HCI_ADMIN_GATE 0x00 |
| 163 | #define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01 |
| 164 | #define NFC_HCI_ADMIN_MAX_PIPE 0x02 |
| 165 | #define NFC_HCI_ADMIN_WHITELIST 0x03 |
| 166 | #define NFC_HCI_ADMIN_HOST_LIST 0x04 |
| 167 | |
| 168 | #define NFC_HCI_LOOPBACK_GATE 0x04 |
| 169 | |
| 170 | #define NFC_HCI_ID_MGMT_GATE 0x05 |
| 171 | #define NFC_HCI_ID_MGMT_VERSION_SW 0x01 |
| 172 | #define NFC_HCI_ID_MGMT_VERSION_HW 0x03 |
| 173 | #define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04 |
| 174 | #define NFC_HCI_ID_MGMT_MODEL_ID 0x05 |
| 175 | #define NFC_HCI_ID_MGMT_HCI_VERSION 0x02 |
| 176 | #define NFC_HCI_ID_MGMT_GATES_LIST 0x06 |
| 177 | |
| 178 | #define NFC_HCI_LINK_MGMT_GATE 0x06 |
| 179 | #define NFC_HCI_LINK_MGMT_REC_ERROR 0x01 |
| 180 | |
| 181 | #define NFC_HCI_RF_READER_B_GATE 0x11 |
| 182 | #define NFC_HCI_RF_READER_B_PUPI 0x03 |
| 183 | #define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04 |
| 184 | #define NFC_HCI_RF_READER_B_AFI 0x02 |
| 185 | #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01 |
| 186 | #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05 |
| 187 | |
| 188 | #define NFC_HCI_RF_READER_A_GATE 0x13 |
| 189 | #define NFC_HCI_RF_READER_A_UID 0x02 |
| 190 | #define NFC_HCI_RF_READER_A_ATQA 0x04 |
| 191 | #define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05 |
| 192 | #define NFC_HCI_RF_READER_A_SAK 0x03 |
| 193 | #define NFC_HCI_RF_READER_A_FWI_SFGT 0x06 |
| 194 | #define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01 |
| 195 | |
| 196 | #define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5) |
| 197 | #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0 |
| 198 | #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1 |
| 199 | #define NFC_HCI_TYPE_A_SEL_PROT_DEP 2 |
| 200 | #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3 |
| 201 | |
| 202 | /* Generic events */ |
| 203 | #define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01 |
| 204 | #define NFC_HCI_EVT_POST_DATA 0x02 |
| 205 | #define NFC_HCI_EVT_HOT_PLUG 0x03 |
| 206 | |
| 207 | /* Reader RF gates events */ |
| 208 | #define NFC_HCI_EVT_READER_REQUESTED 0x10 |
| 209 | #define NFC_HCI_EVT_END_OPERATION 0x11 |
| 210 | |
| 211 | /* Reader Application gate events */ |
| 212 | #define NFC_HCI_EVT_TARGET_DISCOVERED 0x10 |
| 213 | |
| 214 | /* receiving messages from lower layer */ |
| 215 | void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result, |
| 216 | struct sk_buff *skb); |
| 217 | void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd, |
| 218 | struct sk_buff *skb); |
| 219 | void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event, |
| 220 | struct sk_buff *skb); |
| 221 | void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb); |
| 222 | |
| 223 | /* connecting to gates and sending hci instructions */ |
Eric Lapuyade | a10d595 | 2012-06-05 14:42:11 +0200 | [diff] [blame] | 224 | int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate, |
| 225 | u8 pipe); |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 226 | int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate); |
| 227 | int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev); |
| 228 | int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, |
| 229 | struct sk_buff **skb); |
| 230 | int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx, |
| 231 | const u8 *param, size_t param_len); |
| 232 | int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd, |
| 233 | const u8 *param, size_t param_len, struct sk_buff **skb); |
Eric Lapuyade | e4c4789 | 2012-09-11 10:42:54 +0200 | [diff] [blame] | 234 | int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd, |
| 235 | const u8 *param, size_t param_len, |
| 236 | data_exchange_cb_t cb, void *cb_context); |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 237 | int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response, |
| 238 | const u8 *param, size_t param_len); |
| 239 | int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event, |
| 240 | const u8 *param, size_t param_len); |
Arron Wang | f7a5f6c | 2012-09-27 17:32:55 +0800 | [diff] [blame] | 241 | int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate); |
Eric Lapuyade | 9c5121a | 2012-10-23 11:37:43 +0200 | [diff] [blame] | 242 | u32 nfc_hci_sak_to_protocol(u8 sak); |
Eric Lapuyade | 8b8d2e0 | 2012-04-10 19:43:06 +0200 | [diff] [blame] | 243 | |
| 244 | #endif /* __NET_HCI_H */ |