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 #define BT_VOICE		11
111 struct bt_voice {
112 	__u16 setting;
113 };
114 
115 #define BT_VOICE_TRANSPARENT			0x0003
116 #define BT_VOICE_CVSD_16BIT			0x0060
117 
118 #define BT_SNDMTU		12
119 #define BT_RCVMTU		13
120 
121 __printf(1, 2)
122 int bt_info(const char *fmt, ...);
123 __printf(1, 2)
124 int bt_err(const char *fmt, ...);
125 
126 #define BT_INFO(fmt, ...)	bt_info(fmt "\n", ##__VA_ARGS__)
127 #define BT_ERR(fmt, ...)	bt_err(fmt "\n", ##__VA_ARGS__)
128 #define BT_DBG(fmt, ...)	pr_debug(fmt "\n", ##__VA_ARGS__)
129 
130 /* Connection and socket states */
131 enum {
132 	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
133 	BT_OPEN,
134 	BT_BOUND,
135 	BT_LISTEN,
136 	BT_CONNECT,
137 	BT_CONNECT2,
138 	BT_CONFIG,
139 	BT_DISCONN,
140 	BT_CLOSED
141 };
142 
143 /* If unused will be removed by compiler */
144 static inline const char *state_to_string(int state)
145 {
146 	switch (state) {
147 	case BT_CONNECTED:
148 		return "BT_CONNECTED";
149 	case BT_OPEN:
150 		return "BT_OPEN";
151 	case BT_BOUND:
152 		return "BT_BOUND";
153 	case BT_LISTEN:
154 		return "BT_LISTEN";
155 	case BT_CONNECT:
156 		return "BT_CONNECT";
157 	case BT_CONNECT2:
158 		return "BT_CONNECT2";
159 	case BT_CONFIG:
160 		return "BT_CONFIG";
161 	case BT_DISCONN:
162 		return "BT_DISCONN";
163 	case BT_CLOSED:
164 		return "BT_CLOSED";
165 	}
166 
167 	return "invalid state";
168 }
169 
170 /* BD Address */
171 typedef struct {
172 	__u8 b[6];
173 } __packed bdaddr_t;
174 
175 /* BD Address type */
176 #define BDADDR_BREDR		0x00
177 #define BDADDR_LE_PUBLIC	0x01
178 #define BDADDR_LE_RANDOM	0x02
179 
180 static inline bool bdaddr_type_is_valid(__u8 type)
181 {
182 	switch (type) {
183 	case BDADDR_BREDR:
184 	case BDADDR_LE_PUBLIC:
185 	case BDADDR_LE_RANDOM:
186 		return true;
187 	}
188 
189 	return false;
190 }
191 
192 static inline bool bdaddr_type_is_le(__u8 type)
193 {
194 	switch (type) {
195 	case BDADDR_LE_PUBLIC:
196 	case BDADDR_LE_RANDOM:
197 		return true;
198 	}
199 
200 	return false;
201 }
202 
203 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
204 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
205 
206 /* Copy, swap, convert BD Address */
207 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
208 {
209 	return memcmp(ba1, ba2, sizeof(bdaddr_t));
210 }
211 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
212 {
213 	memcpy(dst, src, sizeof(bdaddr_t));
214 }
215 
216 void baswap(bdaddr_t *dst, bdaddr_t *src);
217 
218 /* Common socket structures and functions */
219 
220 #define bt_sk(__sk) ((struct bt_sock *) __sk)
221 
222 struct bt_sock {
223 	struct sock sk;
224 	struct list_head accept_q;
225 	struct sock *parent;
226 	unsigned long flags;
227 	void (*skb_msg_name)(struct sk_buff *, void *, int *);
228 };
229 
230 enum {
231 	BT_SK_DEFER_SETUP,
232 	BT_SK_SUSPEND,
233 };
234 
235 struct bt_sock_list {
236 	struct hlist_head head;
237 	rwlock_t          lock;
238 #ifdef CONFIG_PROC_FS
239         int (* custom_seq_show)(struct seq_file *, void *);
240 #endif
241 };
242 
243 int  bt_sock_register(int proto, const struct net_proto_family *ops);
244 void bt_sock_unregister(int proto);
245 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
246 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
247 int  bt_sock_recvmsg(struct kiocb *iocb, struct socket *sock,
248 				struct msghdr *msg, size_t len, int flags);
249 int  bt_sock_stream_recvmsg(struct kiocb *iocb, struct socket *sock,
250 			struct msghdr *msg, size_t len, int flags);
251 uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
252 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
253 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
254 int  bt_sock_wait_ready(struct sock *sk, unsigned long flags);
255 
256 void bt_accept_enqueue(struct sock *parent, struct sock *sk);
257 void bt_accept_unlink(struct sock *sk);
258 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
259 
260 /* Skb helpers */
261 struct l2cap_ctrl {
262 	unsigned int	sframe:1,
263 			poll:1,
264 			final:1,
265 			fcs:1,
266 			sar:2,
267 			super:2;
268 	__u16		reqseq;
269 	__u16		txseq;
270 	__u8		retries;
271 };
272 
273 struct hci_dev;
274 
275 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status);
276 
277 struct hci_req_ctrl {
278 	bool			start;
279 	u8			event;
280 	hci_req_complete_t	complete;
281 };
282 
283 struct bt_skb_cb {
284 	__u8 pkt_type;
285 	__u8 incoming;
286 	__u16 expect;
287 	__u8 force_active;
288 	struct l2cap_chan *chan;
289 	struct l2cap_ctrl control;
290 	struct hci_req_ctrl req;
291 	bdaddr_t bdaddr;
292 	__le16 psm;
293 };
294 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
295 
296 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
297 {
298 	struct sk_buff *skb;
299 
300 	skb = alloc_skb(len + BT_SKB_RESERVE, how);
301 	if (skb) {
302 		skb_reserve(skb, BT_SKB_RESERVE);
303 		bt_cb(skb)->incoming  = 0;
304 	}
305 	return skb;
306 }
307 
308 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
309 					unsigned long len, int nb, int *err)
310 {
311 	struct sk_buff *skb;
312 
313 	skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
314 	if (skb) {
315 		skb_reserve(skb, BT_SKB_RESERVE);
316 		bt_cb(skb)->incoming  = 0;
317 	}
318 
319 	if (!skb && *err)
320 		return NULL;
321 
322 	*err = sock_error(sk);
323 	if (*err)
324 		goto out;
325 
326 	if (sk->sk_shutdown) {
327 		*err = -ECONNRESET;
328 		goto out;
329 	}
330 
331 	return skb;
332 
333 out:
334 	kfree_skb(skb);
335 	return NULL;
336 }
337 
338 int bt_to_errno(__u16 code);
339 
340 int hci_sock_init(void);
341 void hci_sock_cleanup(void);
342 
343 int bt_sysfs_init(void);
344 void bt_sysfs_cleanup(void);
345 
346 int bt_procfs_init(struct net *net, const char *name,
347 		   struct bt_sock_list *sk_list,
348 		   int (*seq_show)(struct seq_file *, void *));
349 void bt_procfs_cleanup(struct net *net, const char *name);
350 
351 extern struct dentry *bt_debugfs;
352 
353 int l2cap_init(void);
354 void l2cap_exit(void);
355 
356 int sco_init(void);
357 void sco_exit(void);
358 
359 void bt_sock_reclassify_lock(struct sock *sk, int proto);
360 
361 #endif /* __BLUETOOTH_H */
362