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