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