xref: /linux/include/net/bluetooth/bluetooth.h (revision 2dbf708448c836754d25fe6108c5bfe1f5697c95)
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 <asm/types.h>
29 #include <asm/byteorder.h>
30 #include <linux/list.h>
31 #include <linux/poll.h>
32 #include <net/sock.h>
33 
34 #ifndef AF_BLUETOOTH
35 #define AF_BLUETOOTH	31
36 #define PF_BLUETOOTH	AF_BLUETOOTH
37 #endif
38 
39 /* Bluetooth versions */
40 #define BLUETOOTH_VER_1_1	1
41 #define BLUETOOTH_VER_1_2	2
42 #define BLUETOOTH_VER_2_0	3
43 
44 /* Reserv for core and drivers use */
45 #define BT_SKB_RESERVE	8
46 
47 #define BTPROTO_L2CAP	0
48 #define BTPROTO_HCI	1
49 #define BTPROTO_SCO	2
50 #define BTPROTO_RFCOMM	3
51 #define BTPROTO_BNEP	4
52 #define BTPROTO_CMTP	5
53 #define BTPROTO_HIDP	6
54 #define BTPROTO_AVDTP	7
55 
56 #define SOL_HCI		0
57 #define SOL_L2CAP	6
58 #define SOL_SCO		17
59 #define SOL_RFCOMM	18
60 
61 #define BT_SECURITY	4
62 struct bt_security {
63 	__u8 level;
64 	__u8 key_size;
65 };
66 #define BT_SECURITY_SDP		0
67 #define BT_SECURITY_LOW		1
68 #define BT_SECURITY_MEDIUM	2
69 #define BT_SECURITY_HIGH	3
70 
71 #define BT_DEFER_SETUP	7
72 
73 #define BT_FLUSHABLE	8
74 
75 #define BT_FLUSHABLE_OFF	0
76 #define BT_FLUSHABLE_ON		1
77 
78 #define BT_POWER	9
79 struct bt_power {
80 	__u8 force_active;
81 };
82 #define BT_POWER_FORCE_ACTIVE_OFF 0
83 #define BT_POWER_FORCE_ACTIVE_ON  1
84 
85 #define BT_CHANNEL_POLICY	10
86 
87 /* BR/EDR only (default policy)
88  *   AMP controllers cannot be used.
89  *   Channel move requests from the remote device are denied.
90  *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
91  */
92 #define BT_CHANNEL_POLICY_BREDR_ONLY		0
93 
94 /* BR/EDR Preferred
95  *   Allow use of AMP controllers.
96  *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
97  *   Channel move requests from the remote device are allowed.
98  */
99 #define BT_CHANNEL_POLICY_BREDR_PREFERRED	1
100 
101 /* AMP Preferred
102  *   Allow use of AMP controllers
103  *   If the L2CAP channel is currently on BR/EDR and AMP controller
104  *     resources are available, initiate a channel move to AMP.
105  *   Channel move requests from the remote device are allowed.
106  *   If the L2CAP socket has not been connected yet, try to create
107  *     and configure the channel directly on an AMP controller rather
108  *     than BR/EDR.
109  */
110 #define BT_CHANNEL_POLICY_AMP_PREFERRED		2
111 
112 __printf(1, 2)
113 int bt_info(const char *fmt, ...);
114 __printf(1, 2)
115 int bt_err(const char *fmt, ...);
116 
117 #define BT_INFO(fmt, ...)	bt_info(fmt "\n", ##__VA_ARGS__)
118 #define BT_ERR(fmt, ...)	bt_err(fmt "\n", ##__VA_ARGS__)
119 #define BT_DBG(fmt, ...)	pr_debug(fmt "\n", ##__VA_ARGS__)
120 
121 /* Connection and socket states */
122 enum {
123 	BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
124 	BT_OPEN,
125 	BT_BOUND,
126 	BT_LISTEN,
127 	BT_CONNECT,
128 	BT_CONNECT2,
129 	BT_CONFIG,
130 	BT_DISCONN,
131 	BT_CLOSED
132 };
133 
134 /* If unused will be removed by compiler */
135 static inline const char *state_to_string(int state)
136 {
137 	switch (state) {
138 	case BT_CONNECTED:
139 		return "BT_CONNECTED";
140 	case BT_OPEN:
141 		return "BT_OPEN";
142 	case BT_BOUND:
143 		return "BT_BOUND";
144 	case BT_LISTEN:
145 		return "BT_LISTEN";
146 	case BT_CONNECT:
147 		return "BT_CONNECT";
148 	case BT_CONNECT2:
149 		return "BT_CONNECT2";
150 	case BT_CONFIG:
151 		return "BT_CONFIG";
152 	case BT_DISCONN:
153 		return "BT_DISCONN";
154 	case BT_CLOSED:
155 		return "BT_CLOSED";
156 	}
157 
158 	return "invalid state";
159 }
160 
161 /* BD Address */
162 typedef struct {
163 	__u8 b[6];
164 } __packed bdaddr_t;
165 
166 #define BDADDR_ANY   (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
167 #define BDADDR_LOCAL (&(bdaddr_t) {{0, 0, 0, 0xff, 0xff, 0xff}})
168 
169 /* Copy, swap, convert BD Address */
170 static inline int bacmp(bdaddr_t *ba1, bdaddr_t *ba2)
171 {
172 	return memcmp(ba1, ba2, sizeof(bdaddr_t));
173 }
174 static inline void bacpy(bdaddr_t *dst, bdaddr_t *src)
175 {
176 	memcpy(dst, src, sizeof(bdaddr_t));
177 }
178 
179 void baswap(bdaddr_t *dst, bdaddr_t *src);
180 char *batostr(bdaddr_t *ba);
181 bdaddr_t *strtoba(char *str);
182 
183 /* Common socket structures and functions */
184 
185 #define bt_sk(__sk) ((struct bt_sock *) __sk)
186 
187 struct bt_sock {
188 	struct sock sk;
189 	bdaddr_t    src;
190 	bdaddr_t    dst;
191 	struct list_head accept_q;
192 	struct sock *parent;
193 	u32 defer_setup;
194 };
195 
196 struct bt_sock_list {
197 	struct hlist_head head;
198 	rwlock_t          lock;
199 };
200 
201 int  bt_sock_register(int proto, const struct net_proto_family *ops);
202 int  bt_sock_unregister(int proto);
203 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
204 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
205 int  bt_sock_recvmsg(struct kiocb *iocb, struct socket *sock,
206 				struct msghdr *msg, size_t len, int flags);
207 int  bt_sock_stream_recvmsg(struct kiocb *iocb, struct socket *sock,
208 			struct msghdr *msg, size_t len, int flags);
209 uint bt_sock_poll(struct file * file, struct socket *sock, poll_table *wait);
210 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
211 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
212 
213 void bt_accept_enqueue(struct sock *parent, struct sock *sk);
214 void bt_accept_unlink(struct sock *sk);
215 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
216 
217 /* Skb helpers */
218 struct bt_skb_cb {
219 	__u8 pkt_type;
220 	__u8 incoming;
221 	__u16 expect;
222 	__u16 tx_seq;
223 	__u8 retries;
224 	__u8 sar;
225 	__u8 force_active;
226 };
227 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
228 
229 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
230 {
231 	struct sk_buff *skb;
232 
233 	if ((skb = alloc_skb(len + BT_SKB_RESERVE, how))) {
234 		skb_reserve(skb, BT_SKB_RESERVE);
235 		bt_cb(skb)->incoming  = 0;
236 	}
237 	return skb;
238 }
239 
240 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
241 					unsigned long len, int nb, int *err)
242 {
243 	struct sk_buff *skb;
244 
245 	release_sock(sk);
246 	if ((skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err))) {
247 		skb_reserve(skb, BT_SKB_RESERVE);
248 		bt_cb(skb)->incoming  = 0;
249 	}
250 	lock_sock(sk);
251 
252 	if (!skb && *err)
253 		return NULL;
254 
255 	*err = sock_error(sk);
256 	if (*err)
257 		goto out;
258 
259 	if (sk->sk_shutdown) {
260 		*err = -ECONNRESET;
261 		goto out;
262 	}
263 
264 	return skb;
265 
266 out:
267 	kfree_skb(skb);
268 	return NULL;
269 }
270 
271 int bt_to_errno(__u16 code);
272 
273 extern int hci_sock_init(void);
274 extern void hci_sock_cleanup(void);
275 
276 extern int bt_sysfs_init(void);
277 extern void bt_sysfs_cleanup(void);
278 
279 extern struct dentry *bt_debugfs;
280 
281 int l2cap_init(void);
282 void l2cap_exit(void);
283 
284 int sco_init(void);
285 void sco_exit(void);
286 
287 void bt_sock_reclassify_lock(struct sock *sk, int proto);
288 
289 #endif /* __BLUETOOTH_H */
290