xref: /linux/include/net/nfc/nfc.h (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
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_dev_info(dev, fmt, arg...) dev_info((dev), "NFC: " fmt "\n", ## arg)
32 #define nfc_dev_err(dev, fmt, arg...) dev_err((dev), "NFC: " fmt "\n", ## arg)
33 #define nfc_dev_dbg(dev, fmt, arg...) dev_dbg((dev), fmt "\n", ## arg)
34 
35 struct nfc_dev;
36 
37 /**
38  * data_exchange_cb_t - Definition of nfc_data_exchange callback
39  *
40  * @context: nfc_data_exchange cb_context parameter
41  * @skb: response data
42  * @err: If an error has occurred during data exchange, it is the
43  *	error number. Zero means no error.
44  *
45  * When a rx or tx package is lost or corrupted or the target gets out
46  * of the operating field, err is -EIO.
47  */
48 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
49 								int err);
50 
51 struct nfc_target;
52 
53 struct nfc_ops {
54 	int (*dev_up)(struct nfc_dev *dev);
55 	int (*dev_down)(struct nfc_dev *dev);
56 	int (*start_poll)(struct nfc_dev *dev, u32 protocols);
57 	void (*stop_poll)(struct nfc_dev *dev);
58 	int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
59 			   u8 comm_mode, u8 *gb, size_t gb_len);
60 	int (*dep_link_down)(struct nfc_dev *dev);
61 	int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
62 			       u32 protocol);
63 	void (*deactivate_target)(struct nfc_dev *dev,
64 				  struct nfc_target *target);
65 	int (*data_exchange)(struct nfc_dev *dev, struct nfc_target *target,
66 			     struct sk_buff *skb, data_exchange_cb_t cb,
67 			     void *cb_context);
68 	int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
69 };
70 
71 #define NFC_TARGET_IDX_ANY -1
72 #define NFC_MAX_GT_LEN 48
73 
74 struct nfc_target {
75 	u32 idx;
76 	u32 supported_protocols;
77 	u16 sens_res;
78 	u8 sel_res;
79 	u8 nfcid1_len;
80 	u8 nfcid1[NFC_NFCID1_MAXSIZE];
81 	u8 sensb_res_len;
82 	u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
83 	u8 sensf_res_len;
84 	u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
85 	u8 hci_reader_gate;
86 	u8 logical_idx;
87 };
88 
89 struct nfc_genl_data {
90 	u32 poll_req_pid;
91 	struct mutex genl_data_mutex;
92 };
93 
94 struct nfc_dev {
95 	unsigned int idx;
96 	u32 target_next_idx;
97 	struct nfc_target *targets;
98 	int n_targets;
99 	int targets_generation;
100 	struct device dev;
101 	bool dev_up;
102 	bool polling;
103 	struct nfc_target *active_target;
104 	bool dep_link_up;
105 	u32 dep_rf_mode;
106 	struct nfc_genl_data genl_data;
107 	u32 supported_protocols;
108 
109 	int tx_headroom;
110 	int tx_tailroom;
111 
112 	struct timer_list check_pres_timer;
113 	struct workqueue_struct *check_pres_wq;
114 	struct work_struct check_pres_work;
115 
116 	struct nfc_ops *ops;
117 };
118 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
119 
120 extern struct class nfc_class;
121 
122 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
123 				    u32 supported_protocols,
124 				    int tx_headroom,
125 				    int tx_tailroom);
126 
127 /**
128  * nfc_free_device - free nfc device
129  *
130  * @dev: The nfc device to free
131  */
132 static inline void nfc_free_device(struct nfc_dev *dev)
133 {
134 	put_device(&dev->dev);
135 }
136 
137 int nfc_register_device(struct nfc_dev *dev);
138 
139 void nfc_unregister_device(struct nfc_dev *dev);
140 
141 /**
142  * nfc_set_parent_dev - set the parent device
143  *
144  * @nfc_dev: The nfc device whose parent is being set
145  * @dev: The parent device
146  */
147 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
148 				      struct device *dev)
149 {
150 	nfc_dev->dev.parent = dev;
151 }
152 
153 /**
154  * nfc_set_drvdata - set driver specifc data
155  *
156  * @dev: The nfc device
157  * @data: Pointer to driver specifc data
158  */
159 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
160 {
161 	dev_set_drvdata(&dev->dev, data);
162 }
163 
164 /**
165  * nfc_get_drvdata - get driver specifc data
166  *
167  * @dev: The nfc device
168  */
169 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
170 {
171 	return dev_get_drvdata(&dev->dev);
172 }
173 
174 /**
175  * nfc_device_name - get the nfc device name
176  *
177  * @dev: The nfc device whose name to return
178  */
179 static inline const char *nfc_device_name(struct nfc_dev *dev)
180 {
181 	return dev_name(&dev->dev);
182 }
183 
184 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
185 				   unsigned int flags, unsigned int size,
186 				   unsigned int *err);
187 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
188 
189 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
190 				 u8 *gt, u8 gt_len);
191 
192 int nfc_targets_found(struct nfc_dev *dev,
193 		      struct nfc_target *targets, int ntargets);
194 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
195 
196 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
197 		       u8 comm_mode, u8 rf_mode);
198 
199 #endif /* __NET_NFC_H */
200