]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * Copyright (C) 2011 Instituto Nokia de Tecnologia | |
3 | * | |
4 | * Authors: | |
5 | * Lauro Ramos Venancio <lauro.venancio@openbossa.org> | |
6 | * Aloisio Almeida Jr <aloisio.almeida@openbossa.org> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program; if not, write to the | |
20 | * Free Software Foundation, Inc., | |
21 | * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
22 | */ | |
23 | ||
24 | #ifndef __NET_NFC_H | |
25 | #define __NET_NFC_H | |
26 | ||
27 | #include <linux/nfc.h> | |
28 | #include <linux/device.h> | |
29 | #include <linux/skbuff.h> | |
30 | ||
31 | #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__) | |
32 | #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__) | |
33 | ||
34 | struct nfc_phy_ops { | |
35 | int (*write)(void *dev_id, struct sk_buff *skb); | |
36 | int (*enable)(void *dev_id); | |
37 | void (*disable)(void *dev_id); | |
38 | }; | |
39 | ||
40 | struct nfc_dev; | |
41 | ||
42 | /** | |
43 | * data_exchange_cb_t - Definition of nfc_data_exchange callback | |
44 | * | |
45 | * @context: nfc_data_exchange cb_context parameter | |
46 | * @skb: response data | |
47 | * @err: If an error has occurred during data exchange, it is the | |
48 | * error number. Zero means no error. | |
49 | * | |
50 | * When a rx or tx package is lost or corrupted or the target gets out | |
51 | * of the operating field, err is -EIO. | |
52 | */ | |
53 | typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb, | |
54 | int err); | |
55 | ||
56 | struct nfc_target; | |
57 | ||
58 | struct nfc_ops { | |
59 | int (*dev_up)(struct nfc_dev *dev); | |
60 | int (*dev_down)(struct nfc_dev *dev); | |
61 | int (*start_poll)(struct nfc_dev *dev, | |
62 | u32 im_protocols, u32 tm_protocols); | |
63 | void (*stop_poll)(struct nfc_dev *dev); | |
64 | int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target, | |
65 | u8 comm_mode, u8 *gb, size_t gb_len); | |
66 | int (*dep_link_down)(struct nfc_dev *dev); | |
67 | int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target, | |
68 | u32 protocol); | |
69 | void (*deactivate_target)(struct nfc_dev *dev, | |
70 | struct nfc_target *target); | |
71 | int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target, | |
72 | struct sk_buff *skb, data_exchange_cb_t cb, | |
73 | void *cb_context); | |
74 | int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb); | |
75 | int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target); | |
76 | int (*fw_download)(struct nfc_dev *dev, const char *firmware_name); | |
77 | ||
78 | /* Secure Element API */ | |
79 | int (*discover_se)(struct nfc_dev *dev); | |
80 | int (*enable_se)(struct nfc_dev *dev, u32 se_idx); | |
81 | int (*disable_se)(struct nfc_dev *dev, u32 se_idx); | |
82 | }; | |
83 | ||
84 | #define NFC_TARGET_IDX_ANY -1 | |
85 | #define NFC_MAX_GT_LEN 48 | |
86 | #define NFC_ATR_RES_GT_OFFSET 15 | |
87 | ||
88 | /** | |
89 | * struct nfc_target - NFC target descriptiom | |
90 | * | |
91 | * @sens_res: 2 bytes describing the target SENS_RES response, if the target | |
92 | * is a type A one. The %sens_res most significant byte must be byte 2 | |
93 | * as described by the NFC Forum digital specification (i.e. the platform | |
94 | * configuration one) while %sens_res least significant byte is byte 1. | |
95 | */ | |
96 | struct nfc_target { | |
97 | u32 idx; | |
98 | u32 supported_protocols; | |
99 | u16 sens_res; | |
100 | u8 sel_res; | |
101 | u8 nfcid1_len; | |
102 | u8 nfcid1[NFC_NFCID1_MAXSIZE]; | |
103 | u8 nfcid2_len; | |
104 | u8 nfcid2[NFC_NFCID2_MAXSIZE]; | |
105 | u8 sensb_res_len; | |
106 | u8 sensb_res[NFC_SENSB_RES_MAXSIZE]; | |
107 | u8 sensf_res_len; | |
108 | u8 sensf_res[NFC_SENSF_RES_MAXSIZE]; | |
109 | u8 hci_reader_gate; | |
110 | u8 logical_idx; | |
111 | }; | |
112 | ||
113 | /** | |
114 | * nfc_se - A structure for NFC accessible secure elements. | |
115 | * | |
116 | * @idx: The secure element index. User space will enable or | |
117 | * disable a secure element by its index. | |
118 | * @type: The secure element type. It can be SE_UICC or | |
119 | * SE_EMBEDDED. | |
120 | * @state: The secure element state, either enabled or disabled. | |
121 | * | |
122 | */ | |
123 | struct nfc_se { | |
124 | struct list_head list; | |
125 | u32 idx; | |
126 | u16 type; | |
127 | u16 state; | |
128 | }; | |
129 | ||
130 | struct nfc_genl_data { | |
131 | u32 poll_req_portid; | |
132 | struct mutex genl_data_mutex; | |
133 | }; | |
134 | ||
135 | struct nfc_dev { | |
136 | int idx; | |
137 | u32 target_next_idx; | |
138 | struct nfc_target *targets; | |
139 | int n_targets; | |
140 | int targets_generation; | |
141 | struct device dev; | |
142 | bool dev_up; | |
143 | bool fw_download_in_progress; | |
144 | u8 rf_mode; | |
145 | bool polling; | |
146 | struct nfc_target *active_target; | |
147 | bool dep_link_up; | |
148 | struct nfc_genl_data genl_data; | |
149 | u32 supported_protocols; | |
150 | ||
151 | struct list_head secure_elements; | |
152 | ||
153 | int tx_headroom; | |
154 | int tx_tailroom; | |
155 | ||
156 | struct timer_list check_pres_timer; | |
157 | struct work_struct check_pres_work; | |
158 | ||
159 | bool shutting_down; | |
160 | ||
161 | struct rfkill *rfkill; | |
162 | ||
163 | struct nfc_ops *ops; | |
164 | }; | |
165 | #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev) | |
166 | ||
167 | extern struct class nfc_class; | |
168 | ||
169 | struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops, | |
170 | u32 supported_protocols, | |
171 | int tx_headroom, | |
172 | int tx_tailroom); | |
173 | ||
174 | /** | |
175 | * nfc_free_device - free nfc device | |
176 | * | |
177 | * @dev: The nfc device to free | |
178 | */ | |
179 | static inline void nfc_free_device(struct nfc_dev *dev) | |
180 | { | |
181 | put_device(&dev->dev); | |
182 | } | |
183 | ||
184 | int nfc_register_device(struct nfc_dev *dev); | |
185 | ||
186 | void nfc_unregister_device(struct nfc_dev *dev); | |
187 | ||
188 | /** | |
189 | * nfc_set_parent_dev - set the parent device | |
190 | * | |
191 | * @nfc_dev: The nfc device whose parent is being set | |
192 | * @dev: The parent device | |
193 | */ | |
194 | static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev, | |
195 | struct device *dev) | |
196 | { | |
197 | nfc_dev->dev.parent = dev; | |
198 | } | |
199 | ||
200 | /** | |
201 | * nfc_set_drvdata - set driver specifc data | |
202 | * | |
203 | * @dev: The nfc device | |
204 | * @data: Pointer to driver specifc data | |
205 | */ | |
206 | static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data) | |
207 | { | |
208 | dev_set_drvdata(&dev->dev, data); | |
209 | } | |
210 | ||
211 | /** | |
212 | * nfc_get_drvdata - get driver specifc data | |
213 | * | |
214 | * @dev: The nfc device | |
215 | */ | |
216 | static inline void *nfc_get_drvdata(struct nfc_dev *dev) | |
217 | { | |
218 | return dev_get_drvdata(&dev->dev); | |
219 | } | |
220 | ||
221 | /** | |
222 | * nfc_device_name - get the nfc device name | |
223 | * | |
224 | * @dev: The nfc device whose name to return | |
225 | */ | |
226 | static inline const char *nfc_device_name(struct nfc_dev *dev) | |
227 | { | |
228 | return dev_name(&dev->dev); | |
229 | } | |
230 | ||
231 | struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk, | |
232 | unsigned int flags, unsigned int size, | |
233 | unsigned int *err); | |
234 | struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp); | |
235 | ||
236 | int nfc_set_remote_general_bytes(struct nfc_dev *dev, | |
237 | u8 *gt, u8 gt_len); | |
238 | u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len); | |
239 | ||
240 | int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name, | |
241 | u32 result); | |
242 | ||
243 | int nfc_targets_found(struct nfc_dev *dev, | |
244 | struct nfc_target *targets, int ntargets); | |
245 | int nfc_target_lost(struct nfc_dev *dev, u32 target_idx); | |
246 | ||
247 | int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx, | |
248 | u8 comm_mode, u8 rf_mode); | |
249 | ||
250 | int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode, | |
251 | u8 *gb, size_t gb_len); | |
252 | int nfc_tm_deactivated(struct nfc_dev *dev); | |
253 | int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb); | |
254 | ||
255 | void nfc_driver_failure(struct nfc_dev *dev, int err); | |
256 | ||
257 | int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type); | |
258 | int nfc_remove_se(struct nfc_dev *dev, u32 se_idx); | |
259 | struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx); | |
260 | ||
261 | #endif /* __NET_NFC_H */ |