2 * Copyright (C) 2011 Instituto Nokia de Tecnologia
5 * Lauro Ramos Venancio <lauro.venancio@openbossa.org>
6 * Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
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.
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.
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.
27 #include <linux/nfc.h>
28 #include <linux/device.h>
29 #include <linux/skbuff.h>
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__)
35 int (*write)(void *dev_id, struct sk_buff *skb);
36 int (*enable)(void *dev_id);
37 void (*disable)(void *dev_id);
43 * data_exchange_cb_t - Definition of nfc_data_exchange callback
45 * @context: nfc_data_exchange cb_context parameter
47 * @err: If an error has occurred during data exchange, it is the
48 * error number. Zero means no error.
50 * When a rx or tx package is lost or corrupted or the target gets out
51 * of the operating field, err is -EIO.
53 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
56 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
61 int (*dev_up)(struct nfc_dev *dev);
62 int (*dev_down)(struct nfc_dev *dev);
63 int (*start_poll)(struct nfc_dev *dev,
64 u32 im_protocols, u32 tm_protocols);
65 void (*stop_poll)(struct nfc_dev *dev);
66 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
67 u8 comm_mode, u8 *gb, size_t gb_len);
68 int (*dep_link_down)(struct nfc_dev *dev);
69 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
71 void (*deactivate_target)(struct nfc_dev *dev,
72 struct nfc_target *target);
73 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
74 struct sk_buff *skb, data_exchange_cb_t cb,
76 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
77 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
78 int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
80 /* Secure Element API */
81 int (*discover_se)(struct nfc_dev *dev);
82 int (*enable_se)(struct nfc_dev *dev, u32 se_idx);
83 int (*disable_se)(struct nfc_dev *dev, u32 se_idx);
84 int (*se_io) (struct nfc_dev *dev, u32 se_idx,
85 u8 *apdu, size_t apdu_length,
86 se_io_cb_t cb, void *cb_context);
89 #define NFC_TARGET_IDX_ANY -1
90 #define NFC_MAX_GT_LEN 48
91 #define NFC_ATR_RES_GT_OFFSET 15
94 * struct nfc_target - NFC target descriptiom
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.
103 u32 supported_protocols;
107 u8 nfcid1[NFC_NFCID1_MAXSIZE];
109 u8 nfcid2[NFC_NFCID2_MAXSIZE];
111 u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
113 u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
119 * nfc_se - A structure for NFC accessible secure elements.
121 * @idx: The secure element index. User space will enable or
122 * disable a secure element by its index.
123 * @type: The secure element type. It can be SE_UICC or
125 * @state: The secure element state, either enabled or disabled.
129 struct list_head list;
135 struct nfc_genl_data {
137 struct mutex genl_data_mutex;
143 struct nfc_target *targets;
145 int targets_generation;
148 bool fw_download_in_progress;
151 struct nfc_target *active_target;
153 struct nfc_genl_data genl_data;
154 u32 supported_protocols;
156 struct list_head secure_elements;
161 struct timer_list check_pres_timer;
162 struct work_struct check_pres_work;
166 struct rfkill *rfkill;
170 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
172 extern struct class nfc_class;
174 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
175 u32 supported_protocols,
180 * nfc_free_device - free nfc device
182 * @dev: The nfc device to free
184 static inline void nfc_free_device(struct nfc_dev *dev)
186 put_device(&dev->dev);
189 int nfc_register_device(struct nfc_dev *dev);
191 void nfc_unregister_device(struct nfc_dev *dev);
194 * nfc_set_parent_dev - set the parent device
196 * @nfc_dev: The nfc device whose parent is being set
197 * @dev: The parent device
199 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
202 nfc_dev->dev.parent = dev;
206 * nfc_set_drvdata - set driver specifc data
208 * @dev: The nfc device
209 * @data: Pointer to driver specifc data
211 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
213 dev_set_drvdata(&dev->dev, data);
217 * nfc_get_drvdata - get driver specifc data
219 * @dev: The nfc device
221 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
223 return dev_get_drvdata(&dev->dev);
227 * nfc_device_name - get the nfc device name
229 * @dev: The nfc device whose name to return
231 static inline const char *nfc_device_name(struct nfc_dev *dev)
233 return dev_name(&dev->dev);
236 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
237 unsigned int flags, unsigned int size,
239 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
241 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
243 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
245 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
248 int nfc_targets_found(struct nfc_dev *dev,
249 struct nfc_target *targets, int ntargets);
250 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
252 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
253 u8 comm_mode, u8 rf_mode);
255 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
256 u8 *gb, size_t gb_len);
257 int nfc_tm_deactivated(struct nfc_dev *dev);
258 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
260 void nfc_driver_failure(struct nfc_dev *dev, int err);
262 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
263 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
264 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
266 #endif /* __NET_NFC_H */