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