nfc: nci: hci: Add check on skb nci_hci_send_cmd parameter
[linux-2.6-block.git] / include / net / nfc / nfc.h
CommitLineData
3e256b8f
LRV
1/*
2 * Copyright (C) 2011 Instituto Nokia de Tecnologia
a99903ec 3 * Copyright (C) 2014 Marvell International Ltd.
3e256b8f
LRV
4 *
5 * Authors:
6 * Lauro Ramos Venancio <lauro.venancio@openbossa.org>
7 * Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
a6227e26 20 * along with this program; if not, see <http://www.gnu.org/licenses/>.
3e256b8f
LRV
21 */
22
23#ifndef __NET_NFC_H
24#define __NET_NFC_H
25
d5a2ca60 26#include <linux/nfc.h>
3e256b8f
LRV
27#include <linux/device.h>
28#include <linux/skbuff.h>
29
073a625f
JP
30#define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
31#define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
3e256b8f 32
08f13acf
EL
33struct nfc_phy_ops {
34 int (*write)(void *dev_id, struct sk_buff *skb);
35 int (*enable)(void *dev_id);
36 void (*disable)(void *dev_id);
37};
38
3e256b8f
LRV
39struct nfc_dev;
40
41/**
42 * data_exchange_cb_t - Definition of nfc_data_exchange callback
43 *
44 * @context: nfc_data_exchange cb_context parameter
45 * @skb: response data
46 * @err: If an error has occurred during data exchange, it is the
47 * error number. Zero means no error.
48 *
49 * When a rx or tx package is lost or corrupted or the target gets out
50 * of the operating field, err is -EIO.
51 */
52typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
53 int err);
54
72b70b6e
SO
55typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
56
90099433
EL
57struct nfc_target;
58
3e256b8f 59struct nfc_ops {
8b3fe7b5
IE
60 int (*dev_up)(struct nfc_dev *dev);
61 int (*dev_down)(struct nfc_dev *dev);
fe7c5800
SO
62 int (*start_poll)(struct nfc_dev *dev,
63 u32 im_protocols, u32 tm_protocols);
3e256b8f 64 void (*stop_poll)(struct nfc_dev *dev);
90099433
EL
65 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
66 u8 comm_mode, u8 *gb, size_t gb_len);
1ed28f61 67 int (*dep_link_down)(struct nfc_dev *dev);
90099433 68 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
0a40acb2 69 u32 protocol);
90099433
EL
70 void (*deactivate_target)(struct nfc_dev *dev,
71 struct nfc_target *target);
be9ae4ce 72 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
0a40acb2
SO
73 struct sk_buff *skb, data_exchange_cb_t cb,
74 void *cb_context);
be9ae4ce 75 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
90099433 76 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
9ea7187c 77 int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
0a946301
SO
78
79 /* Secure Element API */
80 int (*discover_se)(struct nfc_dev *dev);
81 int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
82 int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
72b70b6e
SO
83 int (*se_io) (struct nfc_dev *dev, u32 se_idx,
84 u8 *apdu, size_t apdu_length,
85 se_io_cb_t cb, void *cb_context);
3e256b8f
LRV
86};
87
1ed28f61
SO
88#define NFC_TARGET_IDX_ANY -1
89#define NFC_MAX_GT_LEN 48
767f19ae 90#define NFC_ATR_RES_GT_OFFSET 15
a99903ec 91#define NFC_ATR_REQ_GT_OFFSET 14
1ed28f61 92
b9c0c678
SO
93/**
94 * struct nfc_target - NFC target descriptiom
95 *
96 * @sens_res: 2 bytes describing the target SENS_RES response, if the target
97 * is a type A one. The %sens_res most significant byte must be byte 2
98 * as described by the NFC Forum digital specification (i.e. the platform
99 * configuration one) while %sens_res least significant byte is byte 1.
100 */
4d12b8b1
LRV
101struct nfc_target {
102 u32 idx;
103 u32 supported_protocols;
104 u16 sens_res;
105 u8 sel_res;
288e0713 106 u8 nfcid1_len;
d5a2ca60 107 u8 nfcid1[NFC_NFCID1_MAXSIZE];
322bce95
SO
108 u8 nfcid2_len;
109 u8 nfcid2[NFC_NFCID2_MAXSIZE];
d5a2ca60
IE
110 u8 sensb_res_len;
111 u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
112 u8 sensf_res_len;
113 u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
8b8d2e08 114 u8 hci_reader_gate;
c4fbb651 115 u8 logical_idx;
e487e4dc
MG
116 u8 is_iso15693;
117 u8 iso15693_dsfid;
118 u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
4d12b8b1
LRV
119};
120
fed7c25e
SO
121/**
122 * nfc_se - A structure for NFC accessible secure elements.
123 *
124 * @idx: The secure element index. User space will enable or
125 * disable a secure element by its index.
126 * @type: The secure element type. It can be SE_UICC or
127 * SE_EMBEDDED.
128 * @state: The secure element state, either enabled or disabled.
129 *
130 */
131struct nfc_se {
132 struct list_head list;
133 u32 idx;
134 u16 type;
135 u16 state;
136};
137
447b27c4
CR
138/**
139 * nfc_evt_transaction - A struct for NFC secure element event transaction.
140 *
141 * @aid: The application identifier triggering the event
142 *
143 * @aid_len: The application identifier length [5:16]
144 *
145 * @params: The application parameters transmitted during the transaction
146 *
147 * @params_len: The applications parameters length [0:255]
148 *
149 */
150#define NFC_MIN_AID_LENGTH 5
151#define NFC_MAX_AID_LENGTH 16
152#define NFC_MAX_PARAMS_LENGTH 255
153
154#define NFC_EVT_TRANSACTION_AID_TAG 0x81
155#define NFC_EVT_TRANSACTION_PARAMS_TAG 0x82
156struct nfc_evt_transaction {
157 u32 aid_len;
158 u8 aid[NFC_MAX_AID_LENGTH];
159 u8 params_len;
0fc4a129 160 u8 params[0];
447b27c4
CR
161} __packed;
162
4d12b8b1 163struct nfc_genl_data {
15e47304 164 u32 poll_req_portid;
4d12b8b1
LRV
165 struct mutex genl_data_mutex;
166};
167
8115dd59
SO
168struct nfc_vendor_cmd {
169 __u32 vendor_id;
170 __u32 subcmd;
171 int (*doit)(struct nfc_dev *dev, void *data, size_t data_len);
172};
173
3e256b8f 174struct nfc_dev {
7eda8b8e 175 int idx;
01ae0eea 176 u32 target_next_idx;
4d12b8b1
LRV
177 struct nfc_target *targets;
178 int n_targets;
179 int targets_generation;
3e256b8f 180 struct device dev;
8b3fe7b5 181 bool dev_up;
9ea7187c 182 bool fw_download_in_progress;
f212ad5e 183 u8 rf_mode;
3e256b8f 184 bool polling;
90099433 185 struct nfc_target *active_target;
1ed28f61 186 bool dep_link_up;
4d12b8b1 187 struct nfc_genl_data genl_data;
3e256b8f
LRV
188 u32 supported_protocols;
189
fed7c25e 190 struct list_head secure_elements;
390a1bd8 191
e8753043
SO
192 int tx_headroom;
193 int tx_tailroom;
194
c8d56ae7 195 struct timer_list check_pres_timer;
c8d56ae7
EL
196 struct work_struct check_pres_work;
197
f0c91038
EL
198 bool shutting_down;
199
be055b2f
SO
200 struct rfkill *rfkill;
201
8115dd59
SO
202 struct nfc_vendor_cmd *vendor_cmds;
203 int n_vendor_cmds;
204
3e256b8f
LRV
205 struct nfc_ops *ops;
206};
207#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
208
209extern struct class nfc_class;
210
211struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
0a40acb2
SO
212 u32 supported_protocols,
213 int tx_headroom,
214 int tx_tailroom);
3e256b8f
LRV
215
216/**
217 * nfc_free_device - free nfc device
218 *
219 * @dev: The nfc device to free
220 */
221static inline void nfc_free_device(struct nfc_dev *dev)
222{
223 put_device(&dev->dev);
224}
225
226int nfc_register_device(struct nfc_dev *dev);
227
228void nfc_unregister_device(struct nfc_dev *dev);
229
230/**
231 * nfc_set_parent_dev - set the parent device
232 *
233 * @nfc_dev: The nfc device whose parent is being set
234 * @dev: The parent device
235 */
236static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
0a40acb2 237 struct device *dev)
3e256b8f
LRV
238{
239 nfc_dev->dev.parent = dev;
240}
241
242/**
243 * nfc_set_drvdata - set driver specifc data
244 *
245 * @dev: The nfc device
246 * @data: Pointer to driver specifc data
247 */
248static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
249{
250 dev_set_drvdata(&dev->dev, data);
251}
252
253/**
254 * nfc_get_drvdata - get driver specifc data
255 *
256 * @dev: The nfc device
257 */
258static inline void *nfc_get_drvdata(struct nfc_dev *dev)
259{
260 return dev_get_drvdata(&dev->dev);
261}
262
263/**
264 * nfc_device_name - get the nfc device name
265 *
266 * @dev: The nfc device whose name to return
267 */
268static inline const char *nfc_device_name(struct nfc_dev *dev)
269{
270 return dev_name(&dev->dev);
271}
272
7c7cd3bf 273struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
0a40acb2
SO
274 unsigned int flags, unsigned int size,
275 unsigned int *err);
7c7cd3bf 276struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
3e256b8f 277
541d920b 278int nfc_set_remote_general_bytes(struct nfc_dev *dev,
0a40acb2 279 u8 *gt, u8 gt_len);
ab73b751 280u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
541d920b 281
352a5f5f
EL
282int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
283 u32 result);
ef04158e 284
0a40acb2
SO
285int nfc_targets_found(struct nfc_dev *dev,
286 struct nfc_target *targets, int ntargets);
e1da0efa 287int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
4d12b8b1 288
1ed28f61
SO
289int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
290 u8 comm_mode, u8 rf_mode);
291
fc40a8c1
SO
292int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
293 u8 *gb, size_t gb_len);
294int nfc_tm_deactivated(struct nfc_dev *dev);
73167ced 295int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
fc40a8c1 296
456411ca
EL
297void nfc_driver_failure(struct nfc_dev *dev, int err);
298
447b27c4
CR
299int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx,
300 struct nfc_evt_transaction *evt_transaction);
fed7c25e
SO
301int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
302int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
d8eb18ee 303struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
fed7c25e 304
57be1f3f
HT
305void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
306 u8 payload_type, u8 direction);
307
8115dd59
SO
308static inline int nfc_set_vendor_cmds(struct nfc_dev *dev,
309 struct nfc_vendor_cmd *cmds,
310 int n_cmds)
311{
312 if (dev->vendor_cmds || dev->n_vendor_cmds)
313 return -EINVAL;
314
315 dev->vendor_cmds = cmds;
316 dev->n_vendor_cmds = n_cmds;
317
318 return 0;
319}
320
3e256b8f 321#endif /* __NET_NFC_H */