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, see <http://www.gnu.org/licenses/>.
25 #include <linux/nfc.h>
26 #include <linux/device.h>
27 #include <linux/skbuff.h>
29 #define nfc_info(dev, fmt, ...) dev_info((dev), "NFC: " fmt, ##__VA_ARGS__)
30 #define nfc_err(dev, fmt, ...) dev_err((dev), "NFC: " fmt, ##__VA_ARGS__)
33 int (*write)(void *dev_id, struct sk_buff *skb);
34 int (*enable)(void *dev_id);
35 void (*disable)(void *dev_id);
41 * data_exchange_cb_t - Definition of nfc_data_exchange callback
43 * @context: nfc_data_exchange cb_context parameter
45 * @err: If an error has occurred during data exchange, it is the
46 * error number. Zero means no error.
48 * When a rx or tx package is lost or corrupted or the target gets out
49 * of the operating field, err is -EIO.
51 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
54 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
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,
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,
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);
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 int (*se_io) (struct nfc_dev *dev, u32 se_idx,
83 u8 *apdu, size_t apdu_length,
84 se_io_cb_t cb, void *cb_context);
87 #define NFC_TARGET_IDX_ANY -1
88 #define NFC_MAX_GT_LEN 48
89 #define NFC_ATR_RES_GT_OFFSET 15
92 * struct nfc_target - NFC target descriptiom
94 * @sens_res: 2 bytes describing the target SENS_RES response, if the target
95 * is a type A one. The %sens_res most significant byte must be byte 2
96 * as described by the NFC Forum digital specification (i.e. the platform
97 * configuration one) while %sens_res least significant byte is byte 1.
101 u32 supported_protocols;
105 u8 nfcid1[NFC_NFCID1_MAXSIZE];
107 u8 nfcid2[NFC_NFCID2_MAXSIZE];
109 u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
111 u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
116 u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
120 * nfc_se - A structure for NFC accessible secure elements.
122 * @idx: The secure element index. User space will enable or
123 * disable a secure element by its index.
124 * @type: The secure element type. It can be SE_UICC or
126 * @state: The secure element state, either enabled or disabled.
130 struct list_head list;
136 struct nfc_genl_data {
138 struct mutex genl_data_mutex;
144 struct nfc_target *targets;
146 int targets_generation;
149 bool fw_download_in_progress;
152 struct nfc_target *active_target;
154 struct nfc_genl_data genl_data;
155 u32 supported_protocols;
157 struct list_head secure_elements;
162 struct timer_list check_pres_timer;
163 struct work_struct check_pres_work;
167 struct rfkill *rfkill;
171 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
173 extern struct class nfc_class;
175 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
176 u32 supported_protocols,
181 * nfc_free_device - free nfc device
183 * @dev: The nfc device to free
185 static inline void nfc_free_device(struct nfc_dev *dev)
187 put_device(&dev->dev);
190 int nfc_register_device(struct nfc_dev *dev);
192 void nfc_unregister_device(struct nfc_dev *dev);
195 * nfc_set_parent_dev - set the parent device
197 * @nfc_dev: The nfc device whose parent is being set
198 * @dev: The parent device
200 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
203 nfc_dev->dev.parent = dev;
207 * nfc_set_drvdata - set driver specifc data
209 * @dev: The nfc device
210 * @data: Pointer to driver specifc data
212 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
214 dev_set_drvdata(&dev->dev, data);
218 * nfc_get_drvdata - get driver specifc data
220 * @dev: The nfc device
222 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
224 return dev_get_drvdata(&dev->dev);
228 * nfc_device_name - get the nfc device name
230 * @dev: The nfc device whose name to return
232 static inline const char *nfc_device_name(struct nfc_dev *dev)
234 return dev_name(&dev->dev);
237 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
238 unsigned int flags, unsigned int size,
240 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
242 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
244 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
246 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
249 int nfc_targets_found(struct nfc_dev *dev,
250 struct nfc_target *targets, int ntargets);
251 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
253 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
254 u8 comm_mode, u8 rf_mode);
256 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
257 u8 *gb, size_t gb_len);
258 int nfc_tm_deactivated(struct nfc_dev *dev);
259 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
261 void nfc_driver_failure(struct nfc_dev *dev, int err);
263 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
264 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
265 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
267 #endif /* __NET_NFC_H */