~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/net/nfc/nfc.h

Version: ~ [ linux-5.11-rc3 ] ~ [ linux-5.10.7 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.89 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.167 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.215 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.251 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.251 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  * Copyright (C) 2011 Instituto Nokia de Tecnologia
  3  * Copyright (C) 2014 Marvell International Ltd.
  4  *
  5  * Authors:
  6  *    Lauro Ramos Venancio <lauro.venancio@openbossa.org>
  7  *    Aloisio Almeida Jr <aloisio.almeida@openbossa.org>
  8  *
  9  * This program is free software; you can redistribute it and/or modify
 10  * it under the terms of the GNU General Public License as published by
 11  * the Free Software Foundation; either version 2 of the License, or
 12  * (at your option) any later version.
 13  *
 14  * This program is distributed in the hope that it will be useful,
 15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 17  * GNU General Public License for more details.
 18  *
 19  * You should have received a copy of the GNU General Public License
 20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
 21  */
 22 
 23 #ifndef __NET_NFC_H
 24 #define __NET_NFC_H
 25 
 26 #include <linux/nfc.h>
 27 #include <linux/device.h>
 28 #include <linux/skbuff.h>
 29 
 30 #define nfc_dbg(dev, fmt, ...) dev_dbg((dev), "NFC: " fmt, ##__VA_ARGS__)
 31 #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__)
 33 
 34 struct 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 
 40 struct 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  */
 53 typedef void (*data_exchange_cb_t)(void *context, struct sk_buff *skb,
 54                                                                 int err);
 55 
 56 typedef void (*se_io_cb_t)(void *context, u8 *apdu, size_t apdu_len, int err);
 57 
 58 struct nfc_target;
 59 
 60 struct nfc_ops {
 61         int (*dev_up)(struct nfc_dev *dev);
 62         int (*dev_down)(struct nfc_dev *dev);
 63         int (*start_poll)(struct nfc_dev *dev,
 64                           u32 im_protocols, u32 tm_protocols);
 65         void (*stop_poll)(struct nfc_dev *dev);
 66         int (*dep_link_up)(struct nfc_dev *dev, struct nfc_target *target,
 67                            u8 comm_mode, u8 *gb, size_t gb_len);
 68         int (*dep_link_down)(struct nfc_dev *dev);
 69         int (*activate_target)(struct nfc_dev *dev, struct nfc_target *target,
 70                                u32 protocol);
 71         void (*deactivate_target)(struct nfc_dev *dev,
 72                                   struct nfc_target *target, u8 mode);
 73         int (*im_transceive)(struct nfc_dev *dev, struct nfc_target *target,
 74                              struct sk_buff *skb, data_exchange_cb_t cb,
 75                              void *cb_context);
 76         int (*tm_send)(struct nfc_dev *dev, struct sk_buff *skb);
 77         int (*check_presence)(struct nfc_dev *dev, struct nfc_target *target);
 78         int (*fw_download)(struct nfc_dev *dev, const char *firmware_name);
 79 
 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);
 84         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);
 87 };
 88 
 89 #define NFC_TARGET_IDX_ANY -1
 90 #define NFC_MAX_GT_LEN 48
 91 #define NFC_ATR_RES_GT_OFFSET 15
 92 #define NFC_ATR_REQ_GT_OFFSET 14
 93 
 94 /**
 95  * struct nfc_target - NFC target descriptiom
 96  *
 97  * @sens_res: 2 bytes describing the target SENS_RES response, if the target
 98  *      is a type A one. The %sens_res most significant byte must be byte 2
 99  *      as described by the NFC Forum digital specification (i.e. the platform
100  *      configuration one) while %sens_res least significant byte is byte 1.
101  */
102 struct nfc_target {
103         u32 idx;
104         u32 supported_protocols;
105         u16 sens_res;
106         u8 sel_res;
107         u8 nfcid1_len;
108         u8 nfcid1[NFC_NFCID1_MAXSIZE];
109         u8 nfcid2_len;
110         u8 nfcid2[NFC_NFCID2_MAXSIZE];
111         u8 sensb_res_len;
112         u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
113         u8 sensf_res_len;
114         u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
115         u8 hci_reader_gate;
116         u8 logical_idx;
117         u8 is_iso15693;
118         u8 iso15693_dsfid;
119         u8 iso15693_uid[NFC_ISO15693_UID_MAXSIZE];
120 };
121 
122 /**
123  * nfc_se - A structure for NFC accessible secure elements.
124  *
125  * @idx: The secure element index. User space will enable or
126  *       disable a secure element by its index.
127  * @type: The secure element type. It can be SE_UICC or
128  *        SE_EMBEDDED.
129  * @state: The secure element state, either enabled or disabled.
130  *
131  */
132 struct nfc_se {
133         struct list_head list;
134         u32 idx;
135         u16 type;
136         u16 state;
137 };
138 
139 /**
140  * nfc_evt_transaction - A struct for NFC secure element event transaction.
141  *
142  * @aid: The application identifier triggering the event
143  *
144  * @aid_len: The application identifier length [5:16]
145  *
146  * @params: The application parameters transmitted during the transaction
147  *
148  * @params_len: The applications parameters length [0:255]
149  *
150  */
151 #define NFC_MIN_AID_LENGTH      5
152 #define NFC_MAX_AID_LENGTH      16
153 #define NFC_MAX_PARAMS_LENGTH   255
154 
155 #define NFC_EVT_TRANSACTION_AID_TAG     0x81
156 #define NFC_EVT_TRANSACTION_PARAMS_TAG  0x82
157 struct nfc_evt_transaction {
158         u32 aid_len;
159         u8 aid[NFC_MAX_AID_LENGTH];
160         u8 params_len;
161         u8 params[0];
162 } __packed;
163 
164 struct nfc_genl_data {
165         u32 poll_req_portid;
166         struct mutex genl_data_mutex;
167 };
168 
169 struct nfc_vendor_cmd {
170         __u32 vendor_id;
171         __u32 subcmd;
172         int (*doit)(struct nfc_dev *dev, void *data, size_t data_len);
173 };
174 
175 struct nfc_dev {
176         int idx;
177         u32 target_next_idx;
178         struct nfc_target *targets;
179         int n_targets;
180         int targets_generation;
181         struct device dev;
182         bool dev_up;
183         bool fw_download_in_progress;
184         u8 rf_mode;
185         bool polling;
186         struct nfc_target *active_target;
187         bool dep_link_up;
188         struct nfc_genl_data genl_data;
189         u32 supported_protocols;
190 
191         struct list_head secure_elements;
192 
193         int tx_headroom;
194         int tx_tailroom;
195 
196         struct timer_list check_pres_timer;
197         struct work_struct check_pres_work;
198 
199         bool shutting_down;
200 
201         struct rfkill *rfkill;
202 
203         struct nfc_vendor_cmd *vendor_cmds;
204         int n_vendor_cmds;
205 
206         struct nfc_ops *ops;
207         struct genl_info *cur_cmd_info;
208 };
209 #define to_nfc_dev(_dev) container_of(_dev, struct nfc_dev, dev)
210 
211 extern struct class nfc_class;
212 
213 struct nfc_dev *nfc_allocate_device(struct nfc_ops *ops,
214                                     u32 supported_protocols,
215                                     int tx_headroom,
216                                     int tx_tailroom);
217 
218 /**
219  * nfc_free_device - free nfc device
220  *
221  * @dev: The nfc device to free
222  */
223 static inline void nfc_free_device(struct nfc_dev *dev)
224 {
225         put_device(&dev->dev);
226 }
227 
228 int nfc_register_device(struct nfc_dev *dev);
229 
230 void nfc_unregister_device(struct nfc_dev *dev);
231 
232 /**
233  * nfc_set_parent_dev - set the parent device
234  *
235  * @nfc_dev: The nfc device whose parent is being set
236  * @dev: The parent device
237  */
238 static inline void nfc_set_parent_dev(struct nfc_dev *nfc_dev,
239                                       struct device *dev)
240 {
241         nfc_dev->dev.parent = dev;
242 }
243 
244 /**
245  * nfc_set_drvdata - set driver specifc data
246  *
247  * @dev: The nfc device
248  * @data: Pointer to driver specifc data
249  */
250 static inline void nfc_set_drvdata(struct nfc_dev *dev, void *data)
251 {
252         dev_set_drvdata(&dev->dev, data);
253 }
254 
255 /**
256  * nfc_get_drvdata - get driver specifc data
257  *
258  * @dev: The nfc device
259  */
260 static inline void *nfc_get_drvdata(struct nfc_dev *dev)
261 {
262         return dev_get_drvdata(&dev->dev);
263 }
264 
265 /**
266  * nfc_device_name - get the nfc device name
267  *
268  * @dev: The nfc device whose name to return
269  */
270 static inline const char *nfc_device_name(struct nfc_dev *dev)
271 {
272         return dev_name(&dev->dev);
273 }
274 
275 struct sk_buff *nfc_alloc_send_skb(struct nfc_dev *dev, struct sock *sk,
276                                    unsigned int flags, unsigned int size,
277                                    unsigned int *err);
278 struct sk_buff *nfc_alloc_recv_skb(unsigned int size, gfp_t gfp);
279 
280 int nfc_set_remote_general_bytes(struct nfc_dev *dev,
281                                  u8 *gt, u8 gt_len);
282 u8 *nfc_get_local_general_bytes(struct nfc_dev *dev, size_t *gb_len);
283 
284 int nfc_fw_download_done(struct nfc_dev *dev, const char *firmware_name,
285                          u32 result);
286 
287 int nfc_targets_found(struct nfc_dev *dev,
288                       struct nfc_target *targets, int ntargets);
289 int nfc_target_lost(struct nfc_dev *dev, u32 target_idx);
290 
291 int nfc_dep_link_is_up(struct nfc_dev *dev, u32 target_idx,
292                        u8 comm_mode, u8 rf_mode);
293 
294 int nfc_tm_activated(struct nfc_dev *dev, u32 protocol, u8 comm_mode,
295                      u8 *gb, size_t gb_len);
296 int nfc_tm_deactivated(struct nfc_dev *dev);
297 int nfc_tm_data_received(struct nfc_dev *dev, struct sk_buff *skb);
298 
299 void nfc_driver_failure(struct nfc_dev *dev, int err);
300 
301 int nfc_se_transaction(struct nfc_dev *dev, u8 se_idx,
302                        struct nfc_evt_transaction *evt_transaction);
303 int nfc_se_connectivity(struct nfc_dev *dev, u8 se_idx);
304 int nfc_add_se(struct nfc_dev *dev, u32 se_idx, u16 type);
305 int nfc_remove_se(struct nfc_dev *dev, u32 se_idx);
306 struct nfc_se *nfc_find_se(struct nfc_dev *dev, u32 se_idx);
307 
308 void nfc_send_to_raw_sock(struct nfc_dev *dev, struct sk_buff *skb,
309                           u8 payload_type, u8 direction);
310 
311 static inline int nfc_set_vendor_cmds(struct nfc_dev *dev,
312                                       struct nfc_vendor_cmd *cmds,
313                                       int n_cmds)
314 {
315         if (dev->vendor_cmds || dev->n_vendor_cmds)
316                 return -EINVAL;
317 
318         dev->vendor_cmds = cmds;
319         dev->n_vendor_cmds = n_cmds;
320 
321         return 0;
322 }
323 
324 struct sk_buff *__nfc_alloc_vendor_cmd_reply_skb(struct nfc_dev *dev,
325                                                  enum nfc_attrs attr,
326                                                  u32 oui, u32 subcmd,
327                                                  int approxlen);
328 int nfc_vendor_cmd_reply(struct sk_buff *skb);
329 
330 /**
331  * nfc_vendor_cmd_alloc_reply_skb - allocate vendor command reply
332  * @dev: nfc device
333  * @oui: vendor oui
334  * @approxlen: an upper bound of the length of the data that will
335  *      be put into the skb
336  *
337  * This function allocates and pre-fills an skb for a reply to
338  * a vendor command. Since it is intended for a reply, calling
339  * it outside of a vendor command's doit() operation is invalid.
340  *
341  * The returned skb is pre-filled with some identifying data in
342  * a way that any data that is put into the skb (with skb_put(),
343  * nla_put() or similar) will end up being within the
344  * %NFC_ATTR_VENDOR_DATA attribute, so all that needs to be done
345  * with the skb is adding data for the corresponding userspace tool
346  * which can then read that data out of the vendor data attribute.
347  * You must not modify the skb in any other way.
348  *
349  * When done, call nfc_vendor_cmd_reply() with the skb and return
350  * its error code as the result of the doit() operation.
351  *
352  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
353  */
354 static inline struct sk_buff *
355 nfc_vendor_cmd_alloc_reply_skb(struct nfc_dev *dev,
356                                 u32 oui, u32 subcmd, int approxlen)
357 {
358         return __nfc_alloc_vendor_cmd_reply_skb(dev,
359                                                 NFC_ATTR_VENDOR_DATA,
360                                                 oui,
361                                                 subcmd, approxlen);
362 }
363 
364 #endif /* __NET_NFC_H */
365 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp