1 /*
2    BlueZ - Bluetooth protocol stack for Linux
3    Copyright (C) 2000-2001 Qualcomm Incorporated
4 
5    Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License version 2 as
9    published by the Free Software Foundation;
10 
11    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
12    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
14    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
15    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
16    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 
20    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
21    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
22    SOFTWARE IS DISCLAIMED.
23 */
24 
25 #ifndef __BLUETOOTH_H
26 #define __BLUETOOTH_H
27 
28 #include <linux/poll.h>
29 #include <net/sock.h>
30 #include <linux/seq_file.h>
31 
32 #ifndef AF_BLUETOOTH
33 #define AF_BLUETOOTH	31
34 #define PF_BLUETOOTH	AF_BLUETOOTH
35 #endif
36 
37 /* Bluetooth versions */
38 #define BLUETOOTH_VER_1_1	1
39 #define BLUETOOTH_VER_1_2	2
40 #define BLUETOOTH_VER_2_0	3
41 
42 /* Reserv for core and drivers use */
43 #define BT_SKB_RESERVE	8
44 
45 #define BTPROTO_L2CAP	0
46 #define BTPROTO_HCI	1
47 #define BTPROTO_SCO	2
48 #define BTPROTO_RFCOMM	3
49 #define BTPROTO_BNEP	4
50 #define BTPROTO_CMTP	5
51 #define BTPROTO_HIDP	6
52 #define BTPROTO_AVDTP	7
53 
54 #define SOL_HCI		0
55 #define SOL_L2CAP	6
56 #define SOL_SCO		17
57 #define SOL_RFCOMM	18
58 
59 #define BT_SECURITY	4
60 struct bt_security {
61 	__u8 level;
62 	__u8 key_size;
63 };
64 #define BT_SECURITY_SDP		0
65 #define BT_SECURITY_LOW		1
66 #define BT_SECURITY_MEDIUM	2
67 #define BT_SECURITY_HIGH	3
68 
69 #define BT_DEFER_SETUP	7
70 
71 #define BT_FLUSHABLE	8
72 
73 #define BT_FLUSHABLE_OFF	0
74 #define BT_FLUSHABLE_ON		1
75 
76 #define BT_POWER	9
77 struct bt_power {
78 	__u8 force_active;
79 };
80 #define BT_POWER_FORCE_ACTIVE_OFF 0
81 #define BT_POWER_FORCE_ACTIVE_ON  1
82 
83 #define BT_CHANNEL_POLICY	10
84 
85 /* BR/EDR only (default policy)
86  *   AMP controllers cannot be used.
87  *   Channel move requests from the remote device are denied.
88  *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
89  */
90 #define BT_CHANNEL_POLICY_BREDR_ONLY		0
91 
92 /* BR/EDR Preferred
93  *   Allow use of AMP controllers.
94  *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
95  *   Channel move requests from the remote device are allowed.
96  */
97 #define BT_CHANNEL_POLICY_BREDR_PREFERRED	1
98 
99 /* AMP Preferred
100  *   Allow use of AMP controllers
101  *   If the L2CAP channel is currently on BR/EDR and AMP controller
102  *     resources are available, initiate a channel move to AMP.
103  *   Channel move requests from the remote device are allowed.
104  *   If the L2CAP socket has not been connected yet, try to create
105  *     and configure the channel directly on an AMP controller rather
106  *     than BR/EDR.
107  */
108 #define BT_CHANNEL_POLICY_AMP_PREFERRED		2
109 
110 __printf(1, 2)
111 int bt_info(const char *fmt, ...);
112 __printf(1, 2)
113 int bt_err(const char *fmt, ...);
114 
115 #define BT_INFO(fmt, ...)	bt_info(fmt "\n", ##__VA_ARGS__)
116 #define BT_ERR(fmt, ...)	bt_err(fmt "\n", ##__VA_ARGS__)
117 #define BT_DBG(fmt, ...)	pr_debug(fmt "\n", ##__VA_ARGS__)
118 
119 /* Connection and socket states */
120 enum {
121 	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
122 	BT_OPEN,
123 	BT_BOUND,
124 	BT_LISTEN,
125 	BT_CONNECT,
126 	BT_CONNECT2,
127 	BT_CONFIG,
128 	BT_DISCONN,
129 	BT_CLOSED
130 };
131 
132 /* If unused will be removed by compiler */
133 static inline const char *state_to_string(int state)
134 {
135 	switch (state) {
136 	case BT_CONNECTED:
137 		return "BT_CONNECTED";
138 	case BT_OPEN:
139 		return "BT_OPEN";
140 	case BT_BOUND:
141 		return "BT_BOUND";
142 	case BT_LISTEN:
143 		return "BT_LISTEN";
144 	case BT_CONNECT:
145 		return "BT_CONNECT";
146 	case BT_CONNECT2:
147 		return "BT_CONNECT2";
148 	case BT_CONFIG:
149 		return "BT_CONFIG";
150 	case BT_DISCONN:
151 		return "BT_DISCONN";
152 	case BT_CLOSED:
153 		return "BT_CLOSED";
154 	}
155 
156 	return "invalid state";
157 }
158 
159 /* BD Address */
160 typedef struct {
161 	__u8 b[6];
162 } __packed bdaddr_t;
163 
164 /* BD Address type */
165 #define BDADDR_BREDR		0x00
166 #define BDADDR_LE_PUBLIC	0x01
167 #define BDADDR_LE_RANDOM	0x02
168 
169 static inline bool bdaddr_type_is_valid(__u8 type)
170 {
171 	switch (type) {
172 	case BDADDR_BREDR:
173 	case BDADDR_LE_PUBLIC:
174 	case BDADDR_LE_RANDOM:
175 		return true;
176 	}
177 
178 	return false;
179 }
180 
181 static inline bool bdaddr_type_is_le(__u8 type)
182 {
183 	switch (type) {
184 	case BDADDR_LE_PUBLIC:
185 	case BDADDR_LE_RANDOM:
186 		return true;
187 	}
188 
189 	return false;
190 }
191 
192 #define BDADDR_ANY   (&(bdaddr_t) {{0, 0, 0, 0, 0, 0} })
193 #define BDADDR_LOCAL (&(bdaddr_t) {{0, 0, 0, 0xff, 0xff, 0xff} })
194 
195 /* Copy, swap, convert BD Address */
196 static inline int bacmp(bdaddr_t *ba1, bdaddr_t *ba2)
197 {
198 	return memcmp(ba1, ba2, sizeof(bdaddr_t));
199 }
200 static inline void bacpy(bdaddr_t *dst, bdaddr_t *src)
201 {
202 	memcpy(dst, src, sizeof(bdaddr_t));
203 }
204 
205 void baswap(bdaddr_t *dst, bdaddr_t *src);
206 
207 /* Common socket structures and functions */
208 
209 #define bt_sk(__sk) ((struct bt_sock *) __sk)
210 
211 struct bt_sock {
212 	struct sock sk;
213 	bdaddr_t    src;
214 	bdaddr_t    dst;
215 	struct list_head accept_q;
216 	struct sock *parent;
217 	unsigned long flags;
218 };
219 
220 enum {
221 	BT_SK_DEFER_SETUP,
222 	BT_SK_SUSPEND,
223 };
224 
225 struct bt_sock_list {
226 	struct hlist_head head;
227 	rwlock_t          lock;
228 #ifdef CONFIG_PROC_FS
229         struct file_operations   fops;
230         int (* custom_seq_show)(struct seq_file *, void *);
231 #endif
232 };
233 
234 int  bt_sock_register(int proto, const struct net_proto_family *ops);
235 int  bt_sock_unregister(int proto);
236 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
237 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
238 int  bt_sock_recvmsg(struct kiocb *iocb, struct socket *sock,
239 				struct msghdr *msg, size_t len, int flags);
240 int  bt_sock_stream_recvmsg(struct kiocb *iocb, struct socket *sock,
241 			struct msghdr *msg, size_t len, int flags);
242 uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
243 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
244 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
245 
246 void bt_accept_enqueue(struct sock *parent, struct sock *sk);
247 void bt_accept_unlink(struct sock *sk);
248 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
249 
250 /* Skb helpers */
251 struct l2cap_ctrl {
252 	unsigned int	sframe:1,
253 			poll:1,
254 			final:1,
255 			fcs:1,
256 			sar:2,
257 			super:2;
258 	__u16		reqseq;
259 	__u16		txseq;
260 	__u8		retries;
261 };
262 
263 struct bt_skb_cb {
264 	__u8 pkt_type;
265 	__u8 incoming;
266 	__u16 expect;
267 	__u8 force_active;
268 	struct l2cap_ctrl control;
269 };
270 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
271 
272 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
273 {
274 	struct sk_buff *skb;
275 
276 	skb = alloc_skb(len + BT_SKB_RESERVE, how);
277 	if (skb) {
278 		skb_reserve(skb, BT_SKB_RESERVE);
279 		bt_cb(skb)->incoming  = 0;
280 	}
281 	return skb;
282 }
283 
284 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
285 					unsigned long len, int nb, int *err)
286 {
287 	struct sk_buff *skb;
288 
289 	skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
290 	if (skb) {
291 		skb_reserve(skb, BT_SKB_RESERVE);
292 		bt_cb(skb)->incoming  = 0;
293 	}
294 
295 	if (!skb && *err)
296 		return NULL;
297 
298 	*err = sock_error(sk);
299 	if (*err)
300 		goto out;
301 
302 	if (sk->sk_shutdown) {
303 		*err = -ECONNRESET;
304 		goto out;
305 	}
306 
307 	return skb;
308 
309 out:
310 	kfree_skb(skb);
311 	return NULL;
312 }
313 
314 int bt_to_errno(__u16 code);
315 
316 extern int hci_sock_init(void);
317 extern void hci_sock_cleanup(void);
318 
319 extern int bt_sysfs_init(void);
320 extern void bt_sysfs_cleanup(void);
321 
322 extern int  bt_procfs_init(struct module* module, struct net *net, const char *name,
323 			   struct bt_sock_list* sk_list,
324 			   int (* seq_show)(struct seq_file *, void *));
325 extern void bt_procfs_cleanup(struct net *net, const char *name);
326 
327 extern struct dentry *bt_debugfs;
328 
329 int l2cap_init(void);
330 void l2cap_exit(void);
331 
332 int sco_init(void);
333 void sco_exit(void);
334 
335 void bt_sock_reclassify_lock(struct sock *sk, int proto);
336 
337 #endif /* __BLUETOOTH_H */
338