blob: 5570f4a316d1f124d2b112420a732608938d8b38 [file] [log] [blame]
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +02001/*
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
Jeff Kirshera6227e22013-12-06 09:13:40 -080015 * along with this program; if not, see <http://www.gnu.org/licenses/>.
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020016 */
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
25struct nfc_hci_dev;
26
27struct nfc_hci_ops {
28 int (*open) (struct nfc_hci_dev *hdev);
29 void (*close) (struct nfc_hci_dev *hdev);
Christophe Ricarde240bc32014-03-25 06:51:49 +010030 int (*load_session) (struct nfc_hci_dev *hdev);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020031 int (*hci_ready) (struct nfc_hci_dev *hdev);
Waldemar Rymarkiewicz96e32402012-09-20 08:59:10 +020032 /*
33 * xmit must always send the complete buffer before
34 * returning. Returned result must be 0 for success
35 * or negative for failure.
36 */
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020037 int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
Samuel Ortizfe7c5802012-05-15 15:57:06 +020038 int (*start_poll) (struct nfc_hci_dev *hdev,
39 u32 im_protocols, u32 tm_protocols);
Christophe Ricard95f76872014-05-20 22:21:57 +020040 void (*stop_poll) (struct nfc_hci_dev *hdev);
Arron Wangc40d1742012-09-27 17:32:57 +080041 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);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020044 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);
Arron Wange8107622012-09-27 17:32:58 +080048 int (*im_transceive) (struct nfc_hci_dev *hdev,
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +020049 struct nfc_target *target, struct sk_buff *skb,
50 data_exchange_cb_t cb, void *cb_context);
Arron Wange8107622012-09-27 17:32:58 +080051 int (*tm_send)(struct nfc_hci_dev *hdev, struct sk_buff *skb);
Eric Lapuyade1676f752012-05-07 12:31:16 +020052 int (*check_presence)(struct nfc_hci_dev *hdev,
53 struct nfc_target *target);
Christophe Ricardfda7a492015-01-27 01:18:11 +010054 int (*event_received)(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
Eric Lapuyade27c31192012-11-28 15:48:44 +010055 struct sk_buff *skb);
Samuel Ortiz9ea71872013-07-31 01:19:43 +020056 int (*fw_download)(struct nfc_hci_dev *hdev, const char *firmware_name);
Samuel Ortiz0a946302013-05-10 11:57:06 +020057 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);
Christophe Ricard9b8d32b2014-11-13 00:30:34 +010060 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);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020063};
64
Eric Lapuyadea10d5952012-06-05 14:42:11 +020065/* Pipes */
Christophe Ricardb3a55b92014-12-02 21:27:52 +010066#define NFC_HCI_DO_NOT_CREATE_PIPE 0x81
Christophe Ricard118278f2015-01-27 01:18:12 +010067#define NFC_HCI_INVALID_PIPE 0x80
68#define NFC_HCI_INVALID_GATE 0xFF
69#define NFC_HCI_INVALID_HOST 0x80
Eric Lapuyadea10d5952012-06-05 14:42:11 +020070#define NFC_HCI_LINK_MGMT_PIPE 0x00
71#define NFC_HCI_ADMIN_PIPE 0x01
72
73struct nfc_hci_gate {
74 u8 gate;
75 u8 pipe;
76};
77
Christophe Ricard118278f2015-01-27 01:18:12 +010078struct nfc_hci_pipe {
79 u8 gate;
80 u8 dest_host;
81};
82
Eric Lapuyadea10d5952012-06-05 14:42:11 +020083#define NFC_HCI_MAX_CUSTOM_GATES 50
Christophe Ricard118278f2015-01-27 01:18:12 +010084#define NFC_HCI_MAX_PIPES 127
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020085struct nfc_hci_init_data {
86 u8 gate_count;
Eric Lapuyadea10d5952012-06-05 14:42:11 +020087 struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES];
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020088 char session_id[9];
89};
90
91typedef int (*xmit) (struct sk_buff *skb, void *cb_data);
92
93#define NFC_HCI_MAX_GATES 256
94
Eric Lapuyadebf71ab82012-12-18 14:15:49 +010095/*
96 * These values can be specified by a driver to indicate it requires some
97 * adaptation of the HCI standard.
98 *
99 * NFC_HCI_QUIRK_SHORT_CLEAR - send HCI_ADM_CLEAR_ALL_PIPE cmd with no params
100 */
101enum {
102 NFC_HCI_QUIRK_SHORT_CLEAR = 0,
103};
104
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200105struct nfc_hci_dev {
106 struct nfc_dev *ndev;
107
108 u32 max_data_link_payload;
109
Eric Lapuyadef0c91032012-11-26 18:06:27 +0100110 bool shutting_down;
111
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200112 struct mutex msg_tx_mutex;
113
114 struct list_head msg_tx_queue;
115
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200116 struct work_struct msg_tx_work;
117
118 struct timer_list cmd_timer;
119 struct hci_msg *cmd_pending_msg;
120
121 struct sk_buff_head rx_hcp_frags;
122
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200123 struct work_struct msg_rx_work;
124
125 struct sk_buff_head msg_rx_queue;
126
127 struct nfc_hci_ops *ops;
128
Eric Lapuyade412fda52012-09-18 19:45:48 +0200129 struct nfc_llc *llc;
130
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200131 struct nfc_hci_init_data init_data;
132
133 void *clientdata;
134
135 u8 gate2pipe[NFC_HCI_MAX_GATES];
Christophe Ricard118278f2015-01-27 01:18:12 +0100136 struct nfc_hci_pipe pipes[NFC_HCI_MAX_PIPES];
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200137
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200138 u8 sw_romlib;
139 u8 sw_patch;
140 u8 sw_flashlib_major;
141 u8 sw_flashlib_minor;
142
143 u8 hw_derivative;
144 u8 hw_version;
145 u8 hw_mpw;
146 u8 hw_software;
147 u8 hw_bsid;
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200148
149 int async_cb_type;
150 data_exchange_cb_t async_cb;
151 void *async_cb_context;
Arron Wang7e2afc92012-09-27 17:32:54 +0800152
153 u8 *gb;
154 size_t gb_len;
Eric Lapuyadebf71ab82012-12-18 14:15:49 +0100155
156 unsigned long quirks;
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200157};
158
159/* hci device allocation */
160struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
161 struct nfc_hci_init_data *init_data,
Eric Lapuyadebf71ab82012-12-18 14:15:49 +0100162 unsigned long quirks,
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200163 u32 protocols,
Eric Lapuyade412fda52012-09-18 19:45:48 +0200164 const char *llc_name,
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200165 int tx_headroom,
166 int tx_tailroom,
167 int max_link_payload);
168void nfc_hci_free_device(struct nfc_hci_dev *hdev);
169
170int nfc_hci_register_device(struct nfc_hci_dev *hdev);
171void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
172
173void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
174void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);
175
Eric Lapuyadea9a741a2012-04-30 18:21:51 +0200176void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err);
177
Eric Lapuyade84d48192012-10-17 16:50:10 +0200178int nfc_hci_result_to_errno(u8 result);
Christophe Ricard118278f2015-01-27 01:18:12 +0100179void nfc_hci_reset_pipes(struct nfc_hci_dev *dev);
180void nfc_hci_reset_pipes_per_host(struct nfc_hci_dev *hdev, u8 host);
Eric Lapuyade84d48192012-10-17 16:50:10 +0200181
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200182/* Host IDs */
183#define NFC_HCI_HOST_CONTROLLER_ID 0x00
184#define NFC_HCI_TERMINAL_HOST_ID 0x01
185#define NFC_HCI_UICC_HOST_ID 0x02
186
187/* Host Controller Gates and registry indexes */
188#define NFC_HCI_ADMIN_GATE 0x00
189#define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01
190#define NFC_HCI_ADMIN_MAX_PIPE 0x02
191#define NFC_HCI_ADMIN_WHITELIST 0x03
192#define NFC_HCI_ADMIN_HOST_LIST 0x04
193
194#define NFC_HCI_LOOPBACK_GATE 0x04
195
196#define NFC_HCI_ID_MGMT_GATE 0x05
197#define NFC_HCI_ID_MGMT_VERSION_SW 0x01
198#define NFC_HCI_ID_MGMT_VERSION_HW 0x03
199#define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04
200#define NFC_HCI_ID_MGMT_MODEL_ID 0x05
201#define NFC_HCI_ID_MGMT_HCI_VERSION 0x02
202#define NFC_HCI_ID_MGMT_GATES_LIST 0x06
203
204#define NFC_HCI_LINK_MGMT_GATE 0x06
205#define NFC_HCI_LINK_MGMT_REC_ERROR 0x01
206
207#define NFC_HCI_RF_READER_B_GATE 0x11
208#define NFC_HCI_RF_READER_B_PUPI 0x03
209#define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04
210#define NFC_HCI_RF_READER_B_AFI 0x02
211#define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01
212#define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05
213
214#define NFC_HCI_RF_READER_A_GATE 0x13
215#define NFC_HCI_RF_READER_A_UID 0x02
216#define NFC_HCI_RF_READER_A_ATQA 0x04
217#define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05
218#define NFC_HCI_RF_READER_A_SAK 0x03
219#define NFC_HCI_RF_READER_A_FWI_SFGT 0x06
220#define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01
221
222#define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5)
223#define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0
224#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1
225#define NFC_HCI_TYPE_A_SEL_PROT_DEP 2
226#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3
227
228/* Generic events */
229#define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01
230#define NFC_HCI_EVT_POST_DATA 0x02
231#define NFC_HCI_EVT_HOT_PLUG 0x03
232
233/* Reader RF gates events */
234#define NFC_HCI_EVT_READER_REQUESTED 0x10
235#define NFC_HCI_EVT_END_OPERATION 0x11
236
237/* Reader Application gate events */
238#define NFC_HCI_EVT_TARGET_DISCOVERED 0x10
239
240/* receiving messages from lower layer */
241void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
242 struct sk_buff *skb);
243void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
244 struct sk_buff *skb);
245void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
246 struct sk_buff *skb);
247void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);
248
249/* connecting to gates and sending hci instructions */
Eric Lapuyadea10d5952012-06-05 14:42:11 +0200250int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate,
251 u8 pipe);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200252int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
253int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
254int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
255 struct sk_buff **skb);
256int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
257 const u8 *param, size_t param_len);
258int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
259 const u8 *param, size_t param_len, struct sk_buff **skb);
Eric Lapuyadee4c47892012-09-11 10:42:54 +0200260int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
261 const u8 *param, size_t param_len,
262 data_exchange_cb_t cb, void *cb_context);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200263int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
264 const u8 *param, size_t param_len);
265int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
266 const u8 *param, size_t param_len);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800267int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate);
Eric Lapuyade9c5121a2012-10-23 11:37:43 +0200268u32 nfc_hci_sak_to_protocol(u8 sak);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200269
270#endif /* __NET_HCI_H */