xref: /openbmc/linux/include/net/nfc/nfc.h (revision 63dc02bd)
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_ops {
52 	int (*dev_up)(struct nfc_dev *dev);
53 	int (*dev_down)(struct nfc_dev *dev);
54 	int (*start_poll)(struct nfc_dev *dev, u32 protocols);
55 	void (*stop_poll)(struct nfc_dev *dev);
56 	int (*dep_link_up)(struct nfc_dev *dev, int target_idx, u8 comm_mode,
57 			   u8 *gb, size_t gb_len);
58 	int (*dep_link_down)(struct nfc_dev *dev);
59 	int (*activate_target)(struct nfc_dev *dev, u32 target_idx,
60 			       u32 protocol);
61 	void (*deactivate_target)(struct nfc_dev *dev, u32 target_idx);
62 	int (*data_exchange)(struct nfc_dev *dev, u32 target_idx,
63 			     struct sk_buff *skb, data_exchange_cb_t cb,
64 			     void *cb_context);
65 };
66 
67 #define NFC_TARGET_IDX_ANY -1
68 #define NFC_MAX_GT_LEN 48
69 
70 struct nfc_target {
71 	u32 idx;
72 	u32 supported_protocols;
73 	u16 sens_res;
74 	u8 sel_res;
75 	u8 nfcid1_len;
76 	u8 nfcid1[NFC_NFCID1_MAXSIZE];
77 	u8 sensb_res_len;
78 	u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
79 	u8 sensf_res_len;
80 	u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
81 };
82 
83 struct nfc_genl_data {
84 	u32 poll_req_pid;
85 	struct mutex genl_data_mutex;
86 };
87 
88 struct nfc_dev {
89 	unsigned idx;
90 	struct nfc_target *targets;
91 	int n_targets;
92 	int targets_generation;
93 	spinlock_t targets_lock;
94 	struct device dev;
95 	bool dev_up;
96 	bool polling;
97 	bool remote_activated;
98 	bool dep_link_up;
99 	u32 dep_rf_mode;
100 	struct nfc_genl_data genl_data;
101 	u32 supported_protocols;
102 
103 	int tx_headroom;
104 	int tx_tailroom;
105 
106 	struct nfc_ops *ops;
107 };
108 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
109 
110 extern struct class nfc_class;
111 
112 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
113 				    u32 supported_protocols,
114 				    int tx_headroom,
115 				    int tx_tailroom);
116 
117 /**
118  * nfc_free_device - free nfc device
119  *
120  * @dev: The nfc device to free
121  */
122 static inline void nfc_free_device(struct nfc_dev *dev)
123 {
124 	put_device(&dev->dev);
125 }
126 
127 int nfc_register_device(struct nfc_dev *dev);
128 
129 void nfc_unregister_device(struct nfc_dev *dev);
130 
131 /**
132  * nfc_set_parent_dev - set the parent device
133  *
134  * @nfc_dev: The nfc device whose parent is being set
135  * @dev: The parent device
136  */
137 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
138 				      struct device *dev)
139 {
140 	nfc_dev->dev.parent = dev;
141 }
142 
143 /**
144  * nfc_set_drvdata - set driver specifc data
145  *
146  * @dev: The nfc device
147  * @data: Pointer to driver specifc data
148  */
149 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
150 {
151 	dev_set_drvdata(&dev->dev, data);
152 }
153 
154 /**
155  * nfc_get_drvdata - get driver specifc data
156  *
157  * @dev: The nfc device
158  */
159 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
160 {
161 	return dev_get_drvdata(&dev->dev);
162 }
163 
164 /**
165  * nfc_device_name - get the nfc device name
166  *
167  * @dev: The nfc device whose name to return
168  */
169 static inline const char *nfc_device_name(struct nfc_dev *dev)
170 {
171 	return dev_name(&dev->dev);
172 }
173 
174 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
175 				   unsigned int flags, unsigned int size,
176 				   unsigned int *err);
177 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
178 
179 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
180 				 u8 *gt, u8 gt_len);
181 
182 int nfc_targets_found(struct nfc_dev *dev,
183 		      struct nfc_target *targets, int ntargets);
184 
185 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
186 		       u8 comm_mode, u8 rf_mode);
187 
188 #endif /* __NET_NFC_H */
189