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 #define BT_SECURITY_FIPS	4
69 
70 #define BT_DEFER_SETUP	7
71 
72 #define BT_FLUSHABLE	8
73 
74 #define BT_FLUSHABLE_OFF	0
75 #define BT_FLUSHABLE_ON		1
76 
77 #define BT_POWER	9
78 struct bt_power {
79 	__u8 force_active;
80 };
81 #define BT_POWER_FORCE_ACTIVE_OFF 0
82 #define BT_POWER_FORCE_ACTIVE_ON  1
83 
84 #define BT_CHANNEL_POLICY	10
85 
86 /* BR/EDR only (default policy)
87  *   AMP controllers cannot be used.
88  *   Channel move requests from the remote device are denied.
89  *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
90  */
91 #define BT_CHANNEL_POLICY_BREDR_ONLY		0
92 
93 /* BR/EDR Preferred
94  *   Allow use of AMP controllers.
95  *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
96  *   Channel move requests from the remote device are allowed.
97  */
98 #define BT_CHANNEL_POLICY_BREDR_PREFERRED	1
99 
100 /* AMP Preferred
101  *   Allow use of AMP controllers
102  *   If the L2CAP channel is currently on BR/EDR and AMP controller
103  *     resources are available, initiate a channel move to AMP.
104  *   Channel move requests from the remote device are allowed.
105  *   If the L2CAP socket has not been connected yet, try to create
106  *     and configure the channel directly on an AMP controller rather
107  *     than BR/EDR.
108  */
109 #define BT_CHANNEL_POLICY_AMP_PREFERRED		2
110 
111 #define BT_VOICE		11
112 struct bt_voice {
113 	__u16 setting;
114 };
115 
116 #define BT_VOICE_TRANSPARENT			0x0003
117 #define BT_VOICE_CVSD_16BIT			0x0060
118 
119 #define BT_SNDMTU		12
120 #define BT_RCVMTU		13
121 
122 __printf(1, 2)
123 void bt_info(const char *fmt, ...);
124 __printf(1, 2)
125 void bt_warn(const char *fmt, ...);
126 __printf(1, 2)
127 void bt_err(const char *fmt, ...);
128 __printf(1, 2)
129 void bt_err_ratelimited(const char *fmt, ...);
130 
131 #define BT_INFO(fmt, ...)	bt_info(fmt "\n", ##__VA_ARGS__)
132 #define BT_WARN(fmt, ...)	bt_warn(fmt "\n", ##__VA_ARGS__)
133 #define BT_ERR(fmt, ...)	bt_err(fmt "\n", ##__VA_ARGS__)
134 #define BT_DBG(fmt, ...)	pr_debug(fmt "\n", ##__VA_ARGS__)
135 
136 #define BT_ERR_RATELIMITED(fmt, ...) bt_err_ratelimited(fmt "\n", ##__VA_ARGS__)
137 
138 #define bt_dev_info(hdev, fmt, ...)				\
139 	BT_INFO("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
140 #define bt_dev_warn(hdev, fmt, ...)				\
141 	BT_WARN("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
142 #define bt_dev_err(hdev, fmt, ...)				\
143 	BT_ERR("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
144 #define bt_dev_dbg(hdev, fmt, ...)				\
145 	BT_DBG("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
146 
147 /* Connection and socket states */
148 enum {
149 	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
150 	BT_OPEN,
151 	BT_BOUND,
152 	BT_LISTEN,
153 	BT_CONNECT,
154 	BT_CONNECT2,
155 	BT_CONFIG,
156 	BT_DISCONN,
157 	BT_CLOSED
158 };
159 
160 /* If unused will be removed by compiler */
161 static inline const char *state_to_string(int state)
162 {
163 	switch (state) {
164 	case BT_CONNECTED:
165 		return "BT_CONNECTED";
166 	case BT_OPEN:
167 		return "BT_OPEN";
168 	case BT_BOUND:
169 		return "BT_BOUND";
170 	case BT_LISTEN:
171 		return "BT_LISTEN";
172 	case BT_CONNECT:
173 		return "BT_CONNECT";
174 	case BT_CONNECT2:
175 		return "BT_CONNECT2";
176 	case BT_CONFIG:
177 		return "BT_CONFIG";
178 	case BT_DISCONN:
179 		return "BT_DISCONN";
180 	case BT_CLOSED:
181 		return "BT_CLOSED";
182 	}
183 
184 	return "invalid state";
185 }
186 
187 /* BD Address */
188 typedef struct {
189 	__u8 b[6];
190 } __packed bdaddr_t;
191 
192 /* BD Address type */
193 #define BDADDR_BREDR		0x00
194 #define BDADDR_LE_PUBLIC	0x01
195 #define BDADDR_LE_RANDOM	0x02
196 
197 static inline bool bdaddr_type_is_valid(__u8 type)
198 {
199 	switch (type) {
200 	case BDADDR_BREDR:
201 	case BDADDR_LE_PUBLIC:
202 	case BDADDR_LE_RANDOM:
203 		return true;
204 	}
205 
206 	return false;
207 }
208 
209 static inline bool bdaddr_type_is_le(__u8 type)
210 {
211 	switch (type) {
212 	case BDADDR_LE_PUBLIC:
213 	case BDADDR_LE_RANDOM:
214 		return true;
215 	}
216 
217 	return false;
218 }
219 
220 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
221 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
222 
223 /* Copy, swap, convert BD Address */
224 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
225 {
226 	return memcmp(ba1, ba2, sizeof(bdaddr_t));
227 }
228 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
229 {
230 	memcpy(dst, src, sizeof(bdaddr_t));
231 }
232 
233 void baswap(bdaddr_t *dst, bdaddr_t *src);
234 
235 /* Common socket structures and functions */
236 
237 #define bt_sk(__sk) ((struct bt_sock *) __sk)
238 
239 struct bt_sock {
240 	struct sock sk;
241 	struct list_head accept_q;
242 	struct sock *parent;
243 	unsigned long flags;
244 	void (*skb_msg_name)(struct sk_buff *, void *, int *);
245 };
246 
247 enum {
248 	BT_SK_DEFER_SETUP,
249 	BT_SK_SUSPEND,
250 };
251 
252 struct bt_sock_list {
253 	struct hlist_head head;
254 	rwlock_t          lock;
255 #ifdef CONFIG_PROC_FS
256         int (* custom_seq_show)(struct seq_file *, void *);
257 #endif
258 };
259 
260 int  bt_sock_register(int proto, const struct net_proto_family *ops);
261 void bt_sock_unregister(int proto);
262 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
263 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
264 int  bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
265 		     int flags);
266 int  bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
267 			    size_t len, int flags);
268 uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
269 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
270 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
271 int  bt_sock_wait_ready(struct sock *sk, unsigned long flags);
272 
273 void bt_accept_enqueue(struct sock *parent, struct sock *sk);
274 void bt_accept_unlink(struct sock *sk);
275 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
276 
277 /* Skb helpers */
278 struct l2cap_ctrl {
279 	__u8	sframe:1,
280 		poll:1,
281 		final:1,
282 		fcs:1,
283 		sar:2,
284 		super:2;
285 	__u16	reqseq;
286 	__u16	txseq;
287 	__u8	retries;
288 	__le16  psm;
289 	bdaddr_t bdaddr;
290 	struct l2cap_chan *chan;
291 };
292 
293 struct hci_dev;
294 
295 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
296 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
297 				       u16 opcode, struct sk_buff *skb);
298 
299 struct hci_ctrl {
300 	__u16 opcode;
301 	bool req_start;
302 	u8 req_event;
303 	hci_req_complete_t req_complete;
304 	hci_req_complete_skb_t req_complete_skb;
305 };
306 
307 struct bt_skb_cb {
308 	__u8 pkt_type;
309 	__u8 force_active;
310 	__u16 expect;
311 	__u8 incoming:1;
312 	union {
313 		struct l2cap_ctrl l2cap;
314 		struct hci_ctrl hci;
315 	};
316 };
317 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
318 
319 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
320 {
321 	struct sk_buff *skb;
322 
323 	skb = alloc_skb(len + BT_SKB_RESERVE, how);
324 	if (skb) {
325 		skb_reserve(skb, BT_SKB_RESERVE);
326 		bt_cb(skb)->incoming  = 0;
327 	}
328 	return skb;
329 }
330 
331 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
332 					unsigned long len, int nb, int *err)
333 {
334 	struct sk_buff *skb;
335 
336 	skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
337 	if (skb) {
338 		skb_reserve(skb, BT_SKB_RESERVE);
339 		bt_cb(skb)->incoming  = 0;
340 	}
341 
342 	if (!skb && *err)
343 		return NULL;
344 
345 	*err = sock_error(sk);
346 	if (*err)
347 		goto out;
348 
349 	if (sk->sk_shutdown) {
350 		*err = -ECONNRESET;
351 		goto out;
352 	}
353 
354 	return skb;
355 
356 out:
357 	kfree_skb(skb);
358 	return NULL;
359 }
360 
361 int bt_to_errno(__u16 code);
362 
363 void hci_sock_set_flag(struct sock *sk, int nr);
364 void hci_sock_clear_flag(struct sock *sk, int nr);
365 int hci_sock_test_flag(struct sock *sk, int nr);
366 unsigned short hci_sock_get_channel(struct sock *sk);
367 
368 int hci_sock_init(void);
369 void hci_sock_cleanup(void);
370 
371 int bt_sysfs_init(void);
372 void bt_sysfs_cleanup(void);
373 
374 int bt_procfs_init(struct net *net, const char *name,
375 		   struct bt_sock_list *sk_list,
376 		   int (*seq_show)(struct seq_file *, void *));
377 void bt_procfs_cleanup(struct net *net, const char *name);
378 
379 extern struct dentry *bt_debugfs;
380 
381 int l2cap_init(void);
382 void l2cap_exit(void);
383 
384 #if IS_ENABLED(CONFIG_BT_BREDR)
385 int sco_init(void);
386 void sco_exit(void);
387 #else
388 static inline int sco_init(void)
389 {
390 	return 0;
391 }
392 
393 static inline void sco_exit(void)
394 {
395 }
396 #endif
397 
398 int mgmt_init(void);
399 void mgmt_exit(void);
400 
401 void bt_sock_reclassify_lock(struct sock *sk, int proto);
402 
403 #endif /* __BLUETOOTH_H */
404