blob: 6b2d75dc7c01c9a21c781469c08355731045ffec [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
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
27struct nfc_hci_dev;
28
29struct 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);
Waldemar Rymarkiewicz96e32402012-09-20 08:59:10 +020033 /*
34 * xmit must always send the complete buffer before
35 * returning. Returned result must be 0 for success
36 * or negative for failure.
37 */
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020038 int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
Samuel Ortizfe7c5802012-05-15 15:57:06 +020039 int (*start_poll) (struct nfc_hci_dev *hdev,
40 u32 im_protocols, u32 tm_protocols);
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);
48 int (*data_exchange) (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);
Eric Lapuyade1676f752012-05-07 12:31:16 +020051 int (*check_presence)(struct nfc_hci_dev *hdev,
52 struct nfc_target *target);
Arron Wangf7a5f6c2012-09-27 17:32:55 +080053 void (*event_received)(struct nfc_hci_dev *hdev, u8 gate, u8 event,
54 struct sk_buff *skb);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020055};
56
Eric Lapuyadea10d5952012-06-05 14:42:11 +020057/* Pipes */
58#define NFC_HCI_INVALID_PIPE 0x80
59#define NFC_HCI_LINK_MGMT_PIPE 0x00
60#define NFC_HCI_ADMIN_PIPE 0x01
61
62struct nfc_hci_gate {
63 u8 gate;
64 u8 pipe;
65};
66
67#define NFC_HCI_MAX_CUSTOM_GATES 50
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020068struct nfc_hci_init_data {
69 u8 gate_count;
Eric Lapuyadea10d5952012-06-05 14:42:11 +020070 struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES];
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020071 char session_id[9];
72};
73
74typedef int (*xmit) (struct sk_buff *skb, void *cb_data);
75
76#define NFC_HCI_MAX_GATES 256
77
78struct nfc_hci_dev {
79 struct nfc_dev *ndev;
80
81 u32 max_data_link_payload;
82
83 struct mutex msg_tx_mutex;
84
85 struct list_head msg_tx_queue;
86
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020087 struct work_struct msg_tx_work;
88
89 struct timer_list cmd_timer;
90 struct hci_msg *cmd_pending_msg;
91
92 struct sk_buff_head rx_hcp_frags;
93
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +020094 struct work_struct msg_rx_work;
95
96 struct sk_buff_head msg_rx_queue;
97
98 struct nfc_hci_ops *ops;
99
Eric Lapuyade412fda52012-09-18 19:45:48 +0200100 struct nfc_llc *llc;
101
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200102 struct nfc_hci_init_data init_data;
103
104 void *clientdata;
105
106 u8 gate2pipe[NFC_HCI_MAX_GATES];
107
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200108 u8 sw_romlib;
109 u8 sw_patch;
110 u8 sw_flashlib_major;
111 u8 sw_flashlib_minor;
112
113 u8 hw_derivative;
114 u8 hw_version;
115 u8 hw_mpw;
116 u8 hw_software;
117 u8 hw_bsid;
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200118
119 int async_cb_type;
120 data_exchange_cb_t async_cb;
121 void *async_cb_context;
Arron Wang7e2afc92012-09-27 17:32:54 +0800122
123 u8 *gb;
124 size_t gb_len;
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200125};
126
127/* hci device allocation */
128struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
129 struct nfc_hci_init_data *init_data,
130 u32 protocols,
Eric Lapuyade412fda52012-09-18 19:45:48 +0200131 const char *llc_name,
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200132 int tx_headroom,
133 int tx_tailroom,
134 int max_link_payload);
135void nfc_hci_free_device(struct nfc_hci_dev *hdev);
136
137int nfc_hci_register_device(struct nfc_hci_dev *hdev);
138void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
139
140void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
141void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);
142
Eric Lapuyadea9a741a2012-04-30 18:21:51 +0200143void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err);
144
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200145/* Host IDs */
146#define NFC_HCI_HOST_CONTROLLER_ID 0x00
147#define NFC_HCI_TERMINAL_HOST_ID 0x01
148#define NFC_HCI_UICC_HOST_ID 0x02
149
150/* Host Controller Gates and registry indexes */
151#define NFC_HCI_ADMIN_GATE 0x00
152#define NFC_HCI_ADMIN_SESSION_IDENTITY 0x01
153#define NFC_HCI_ADMIN_MAX_PIPE 0x02
154#define NFC_HCI_ADMIN_WHITELIST 0x03
155#define NFC_HCI_ADMIN_HOST_LIST 0x04
156
157#define NFC_HCI_LOOPBACK_GATE 0x04
158
159#define NFC_HCI_ID_MGMT_GATE 0x05
160#define NFC_HCI_ID_MGMT_VERSION_SW 0x01
161#define NFC_HCI_ID_MGMT_VERSION_HW 0x03
162#define NFC_HCI_ID_MGMT_VENDOR_NAME 0x04
163#define NFC_HCI_ID_MGMT_MODEL_ID 0x05
164#define NFC_HCI_ID_MGMT_HCI_VERSION 0x02
165#define NFC_HCI_ID_MGMT_GATES_LIST 0x06
166
167#define NFC_HCI_LINK_MGMT_GATE 0x06
168#define NFC_HCI_LINK_MGMT_REC_ERROR 0x01
169
170#define NFC_HCI_RF_READER_B_GATE 0x11
171#define NFC_HCI_RF_READER_B_PUPI 0x03
172#define NFC_HCI_RF_READER_B_APPLICATION_DATA 0x04
173#define NFC_HCI_RF_READER_B_AFI 0x02
174#define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE 0x01
175#define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA 0x05
176
177#define NFC_HCI_RF_READER_A_GATE 0x13
178#define NFC_HCI_RF_READER_A_UID 0x02
179#define NFC_HCI_RF_READER_A_ATQA 0x04
180#define NFC_HCI_RF_READER_A_APPLICATION_DATA 0x05
181#define NFC_HCI_RF_READER_A_SAK 0x03
182#define NFC_HCI_RF_READER_A_FWI_SFGT 0x06
183#define NFC_HCI_RF_READER_A_DATARATE_MAX 0x01
184
185#define NFC_HCI_TYPE_A_SEL_PROT(x) (((x) & 0x60) >> 5)
186#define NFC_HCI_TYPE_A_SEL_PROT_MIFARE 0
187#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443 1
188#define NFC_HCI_TYPE_A_SEL_PROT_DEP 2
189#define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP 3
190
191/* Generic events */
192#define NFC_HCI_EVT_HCI_END_OF_OPERATION 0x01
193#define NFC_HCI_EVT_POST_DATA 0x02
194#define NFC_HCI_EVT_HOT_PLUG 0x03
195
196/* Reader RF gates events */
197#define NFC_HCI_EVT_READER_REQUESTED 0x10
198#define NFC_HCI_EVT_END_OPERATION 0x11
199
200/* Reader Application gate events */
201#define NFC_HCI_EVT_TARGET_DISCOVERED 0x10
202
203/* receiving messages from lower layer */
204void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
205 struct sk_buff *skb);
206void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
207 struct sk_buff *skb);
208void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
209 struct sk_buff *skb);
210void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);
211
212/* connecting to gates and sending hci instructions */
Eric Lapuyadea10d5952012-06-05 14:42:11 +0200213int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate,
214 u8 pipe);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200215int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
216int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
217int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
218 struct sk_buff **skb);
219int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
220 const u8 *param, size_t param_len);
221int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
222 const u8 *param, size_t param_len, struct sk_buff **skb);
Eric Lapuyadee4c47892012-09-11 10:42:54 +0200223int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
224 const u8 *param, size_t param_len,
225 data_exchange_cb_t cb, void *cb_context);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200226int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
227 const u8 *param, size_t param_len);
228int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
229 const u8 *param, size_t param_len);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800230int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate);
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200231
232#endif /* __NET_HCI_H */