blob: 82fc4e43fc6e9ec156e19e18dddc4d3ec1fbe037 [file] [log] [blame]
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -03001/*
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
Ilan Eliasd5a2ca62012-01-17 11:06:43 +020027#include <linux/nfc.h>
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030028#include <linux/device.h>
29#include <linux/skbuff.h>
30
Joe Perches073a6252013-04-05 12:27:38 -070031#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__)
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030033
Eric Lapuyade08f13ac2013-09-03 11:51:00 +020034struct 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
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030040struct 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 */
53typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
54 int err);
55
Samuel Ortiz72b70b62013-08-28 00:39:48 +020056typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
57
Eric Lapuyade90099432012-05-07 12:31:13 +020058struct nfc_target;
59
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030060struct nfc_ops {
Ilan Elias8b3fe7b2011-09-18 11:19:33 +030061 int (*dev_up)(struct nfc_dev *dev);
62 int (*dev_down)(struct nfc_dev *dev);
Samuel Ortizfe7c5802012-05-15 15:57:06 +020063 int (*start_poll)(struct nfc_dev *dev,
64 u32 im_protocols, u32 tm_protocols);
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030065 void (*stop_poll)(struct nfc_dev *dev);
Eric Lapuyade90099432012-05-07 12:31:13 +020066 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
67 u8 comm_mode, u8 *gb, size_t gb_len);
Samuel Ortiz1ed28f62011-12-14 16:43:09 +010068 int (*dep_link_down)(struct nfc_dev *dev);
Eric Lapuyade90099432012-05-07 12:31:13 +020069 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +010070 u32 protocol);
Eric Lapuyade90099432012-05-07 12:31:13 +020071 void (*deactivate_target)(struct nfc_dev *dev,
72 struct nfc_target *target);
Samuel Ortizbe9ae4c2012-05-16 15:55:48 +020073 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +010074 struct sk_buff *skb, data_exchange_cb_t cb,
75 void *cb_context);
Samuel Ortizbe9ae4c2012-05-16 15:55:48 +020076 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
Eric Lapuyade90099432012-05-07 12:31:13 +020077 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
Samuel Ortiz9ea71872013-07-31 01:19:43 +020078 int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
Samuel Ortiz0a946302013-05-10 11:57:06 +020079
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);
Samuel Ortiz72b70b62013-08-28 00:39:48 +020084 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);
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -030087};
88
Samuel Ortiz1ed28f62011-12-14 16:43:09 +010089#define NFC_TARGET_IDX_ANY -1
90#define NFC_MAX_GT_LEN 48
Ilan Elias767f19a2012-08-15 11:46:24 +030091#define NFC_ATR_RES_GT_OFFSET 15
Samuel Ortiz1ed28f62011-12-14 16:43:09 +010092
Samuel Ortizb9c0c672013-09-24 12:40:44 +020093/**
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 */
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300101struct nfc_target {
102 u32 idx;
103 u32 supported_protocols;
104 u16 sens_res;
105 u8 sel_res;
Ilan Elias288e0712011-12-22 11:51:54 +0200106 u8 nfcid1_len;
Ilan Eliasd5a2ca62012-01-17 11:06:43 +0200107 u8 nfcid1[NFC_NFCID1_MAXSIZE];
Samuel Ortiz322bce92013-05-27 15:29:11 +0200108 u8 nfcid2_len;
109 u8 nfcid2[NFC_NFCID2_MAXSIZE];
Ilan Eliasd5a2ca62012-01-17 11:06:43 +0200110 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];
Eric Lapuyade8b8d2e02012-04-10 19:43:06 +0200114 u8 hci_reader_gate;
Samuel Ortizc4fbb652012-04-10 19:43:09 +0200115 u8 logical_idx;
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300116};
117
Samuel Ortizfed7c252013-05-10 15:28:38 +0200118/**
119 * nfc_se - A structure for NFC accessible secure elements.
120 *
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
124 * SE_EMBEDDED.
125 * @state: The secure element state, either enabled or disabled.
126 *
127 */
128struct nfc_se {
129 struct list_head list;
130 u32 idx;
131 u16 type;
132 u16 state;
133};
134
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300135struct nfc_genl_data {
Eric W. Biederman15e47302012-09-07 20:12:54 +0000136 u32 poll_req_portid;
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300137 struct mutex genl_data_mutex;
138};
139
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300140struct nfc_dev {
Samuel Ortiz7eda8b8e92012-10-22 15:57:58 +0200141 int idx;
Eric Lapuyade01ae0ee2012-04-10 19:43:10 +0200142 u32 target_next_idx;
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300143 struct nfc_target *targets;
144 int n_targets;
145 int targets_generation;
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300146 struct device dev;
Ilan Elias8b3fe7b2011-09-18 11:19:33 +0300147 bool dev_up;
Samuel Ortiz9ea71872013-07-31 01:19:43 +0200148 bool fw_download_in_progress;
Samuel Ortizf212ad52012-05-31 00:02:26 +0200149 u8 rf_mode;
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300150 bool polling;
Eric Lapuyade90099432012-05-07 12:31:13 +0200151 struct nfc_target *active_target;
Samuel Ortiz1ed28f62011-12-14 16:43:09 +0100152 bool dep_link_up;
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300153 struct nfc_genl_data genl_data;
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300154 u32 supported_protocols;
155
Samuel Ortizfed7c252013-05-10 15:28:38 +0200156 struct list_head secure_elements;
Samuel Ortiz390a1bd2012-12-19 19:11:32 +0100157
Samuel Ortize8753042011-08-19 15:47:11 +0200158 int tx_headroom;
159 int tx_tailroom;
160
Eric Lapuyadec8d56ae2012-04-10 19:43:12 +0200161 struct timer_list check_pres_timer;
Eric Lapuyadec8d56ae2012-04-10 19:43:12 +0200162 struct work_struct check_pres_work;
163
Eric Lapuyadef0c91032012-11-26 18:06:27 +0100164 bool shutting_down;
165
Samuel Ortizbe055b22013-04-11 11:52:20 +0200166 struct rfkill *rfkill;
167
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300168 struct nfc_ops *ops;
169};
170#define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
171
172extern struct class nfc_class;
173
174struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +0100175 u32 supported_protocols,
176 int tx_headroom,
177 int tx_tailroom);
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300178
179/**
180 * nfc_free_device - free nfc device
181 *
182 * @dev: The nfc device to free
183 */
184static inline void nfc_free_device(struct nfc_dev *dev)
185{
186 put_device(&dev->dev);
187}
188
189int nfc_register_device(struct nfc_dev *dev);
190
191void nfc_unregister_device(struct nfc_dev *dev);
192
193/**
194 * nfc_set_parent_dev - set the parent device
195 *
196 * @nfc_dev: The nfc device whose parent is being set
197 * @dev: The parent device
198 */
199static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +0100200 struct device *dev)
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300201{
202 nfc_dev->dev.parent = dev;
203}
204
205/**
206 * nfc_set_drvdata - set driver specifc data
207 *
208 * @dev: The nfc device
209 * @data: Pointer to driver specifc data
210 */
211static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
212{
213 dev_set_drvdata(&dev->dev, data);
214}
215
216/**
217 * nfc_get_drvdata - get driver specifc data
218 *
219 * @dev: The nfc device
220 */
221static inline void *nfc_get_drvdata(struct nfc_dev *dev)
222{
223 return dev_get_drvdata(&dev->dev);
224}
225
226/**
227 * nfc_device_name - get the nfc device name
228 *
229 * @dev: The nfc device whose name to return
230 */
231static inline const char *nfc_device_name(struct nfc_dev *dev)
232{
233 return dev_name(&dev->dev);
234}
235
Samuel Ortiz7c7cd3b2011-12-14 16:43:06 +0100236struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +0100237 unsigned int flags, unsigned int size,
238 unsigned int *err);
Samuel Ortiz7c7cd3b2011-12-14 16:43:06 +0100239struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300240
Samuel Ortiz541d9202011-12-14 16:43:10 +0100241int nfc_set_remote_general_bytes(struct nfc_dev *dev,
Samuel Ortiz0a40acb2012-03-05 01:03:53 +0100242 u8 *gt, u8 gt_len);
Samuel Ortizab73b752012-04-10 12:51:52 +0200243u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
Samuel Ortiz541d9202011-12-14 16:43:10 +0100244
Eric Lapuyade352a5f52013-07-19 14:57:55 +0200245int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
246 u32 result);
Eric Lapuyadeef041582013-07-19 14:56:08 +0200247
Samuel Ortiz0a40acb2012-03-05 01:03:53 +0100248int nfc_targets_found(struct nfc_dev *dev,
249 struct nfc_target *targets, int ntargets);
Eric Lapuyadee1da0ef2012-04-10 19:43:05 +0200250int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
Lauro Ramos Venancio4d12b8b2011-07-01 19:31:34 -0300251
Samuel Ortiz1ed28f62011-12-14 16:43:09 +0100252int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
253 u8 comm_mode, u8 rf_mode);
254
Samuel Ortizfc40a8c2012-06-01 13:21:13 +0200255int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
256 u8 *gb, size_t gb_len);
257int nfc_tm_deactivated(struct nfc_dev *dev);
Samuel Ortiz73167ce2012-05-31 00:05:50 +0200258int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
Samuel Ortizfc40a8c2012-06-01 13:21:13 +0200259
Eric Lapuyade456411c2012-06-11 13:49:51 +0200260void nfc_driver_failure(struct nfc_dev *dev, int err);
261
Samuel Ortizfed7c252013-05-10 15:28:38 +0200262int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
263int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
Arron Wangd8eb18e2013-08-23 16:02:08 +0800264struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
Samuel Ortizfed7c252013-05-10 15:28:38 +0200265
Lauro Ramos Venancio3e256b82011-07-01 19:31:33 -0300266#endif /* __NET_NFC_H */