]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/net/nfc/nfc.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[mirror_ubuntu-jammy-kernel.git] / include / net / nfc / nfc.h
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,
57 u32 im_protocols, u32 tm_protocols);
58 void (*stop_poll)(struct nfc_dev *dev);
59 int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
60 u8 comm_mode, u8 *gb, size_t gb_len);
61 int (*dep_link_down)(struct nfc_dev *dev);
62 int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
63 u32 protocol);
64 void (*deactivate_target)(struct nfc_dev *dev,
65 struct nfc_target *target);
66 int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
67 struct sk_buff *skb, data_exchange_cb_t cb,
68 void *cb_context);
69 int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
70 int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
71 };
72
73 #define NFC_TARGET_IDX_ANY -1
74 #define NFC_MAX_GT_LEN 48
75 #define NFC_ATR_RES_GT_OFFSET 15
76
77 struct nfc_target {
78 u32 idx;
79 u32 supported_protocols;
80 u16 sens_res;
81 u8 sel_res;
82 u8 nfcid1_len;
83 u8 nfcid1[NFC_NFCID1_MAXSIZE];
84 u8 sensb_res_len;
85 u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
86 u8 sensf_res_len;
87 u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
88 u8 hci_reader_gate;
89 u8 logical_idx;
90 };
91
92 struct nfc_genl_data {
93 u32 poll_req_portid;
94 struct mutex genl_data_mutex;
95 };
96
97 struct nfc_dev {
98 unsigned int idx;
99 u32 target_next_idx;
100 struct nfc_target *targets;
101 int n_targets;
102 int targets_generation;
103 struct device dev;
104 bool dev_up;
105 u8 rf_mode;
106 bool polling;
107 struct nfc_target *active_target;
108 bool dep_link_up;
109 struct nfc_genl_data genl_data;
110 u32 supported_protocols;
111
112 int tx_headroom;
113 int tx_tailroom;
114
115 struct timer_list check_pres_timer;
116 struct work_struct check_pres_work;
117
118 struct nfc_ops *ops;
119 };
120 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
121
122 extern struct class nfc_class;
123
124 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
125 u32 supported_protocols,
126 int tx_headroom,
127 int tx_tailroom);
128
129 /**
130 * nfc_free_device - free nfc device
131 *
132 * @dev: The nfc device to free
133 */
134 static inline void nfc_free_device(struct nfc_dev *dev)
135 {
136 put_device(&dev->dev);
137 }
138
139 int nfc_register_device(struct nfc_dev *dev);
140
141 void nfc_unregister_device(struct nfc_dev *dev);
142
143 /**
144 * nfc_set_parent_dev - set the parent device
145 *
146 * @nfc_dev: The nfc device whose parent is being set
147 * @dev: The parent device
148 */
149 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
150 struct device *dev)
151 {
152 nfc_dev->dev.parent = dev;
153 }
154
155 /**
156 * nfc_set_drvdata - set driver specifc data
157 *
158 * @dev: The nfc device
159 * @data: Pointer to driver specifc data
160 */
161 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
162 {
163 dev_set_drvdata(&dev->dev, data);
164 }
165
166 /**
167 * nfc_get_drvdata - get driver specifc data
168 *
169 * @dev: The nfc device
170 */
171 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
172 {
173 return dev_get_drvdata(&dev->dev);
174 }
175
176 /**
177 * nfc_device_name - get the nfc device name
178 *
179 * @dev: The nfc device whose name to return
180 */
181 static inline const char *nfc_device_name(struct nfc_dev *dev)
182 {
183 return dev_name(&dev->dev);
184 }
185
186 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
187 unsigned int flags, unsigned int size,
188 unsigned int *err);
189 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
190
191 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
192 u8 *gt, u8 gt_len);
193 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
194
195 int nfc_targets_found(struct nfc_dev *dev,
196 struct nfc_target *targets, int ntargets);
197 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
198
199 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
200 u8 comm_mode, u8 rf_mode);
201
202 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
203 u8 *gb, size_t gb_len);
204 int nfc_tm_deactivated(struct nfc_dev *dev);
205 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
206
207 void nfc_driver_failure(struct nfc_dev *dev, int err);
208
209 #endif /* __NET_NFC_H */