]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/bluetooth/bluetooth.h
Bluetooth: Fix locking in bt_accept_enqueue() for BH context
[mirror_ubuntu-bionic-kernel.git] / include / net / bluetooth / bluetooth.h
CommitLineData
38351c66 1/*
1da177e4
LT
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
38351c66
GP
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
1da177e4
LT
18 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19
38351c66
GP
20 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
21 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
1da177e4
LT
22 SOFTWARE IS DISCLAIMED.
23*/
24
25#ifndef __BLUETOOTH_H
26#define __BLUETOOTH_H
27
1da177e4
LT
28#include <linux/poll.h>
29#include <net/sock.h>
256a06c8 30#include <linux/seq_file.h>
1da177e4 31
9e8305b3 32#define BT_SUBSYS_VERSION 2
4037a774 33#define BT_SUBSYS_REVISION 22
dd31506d 34
1da177e4
LT
35#ifndef AF_BLUETOOTH
36#define AF_BLUETOOTH 31
37#define PF_BLUETOOTH AF_BLUETOOTH
38#endif
39
d095c1eb
AE
40/* Bluetooth versions */
41#define BLUETOOTH_VER_1_1 1
42#define BLUETOOTH_VER_1_2 2
43#define BLUETOOTH_VER_2_0 3
44
1da177e4
LT
45/* Reserv for core and drivers use */
46#define BT_SKB_RESERVE 8
47
48#define BTPROTO_L2CAP 0
49#define BTPROTO_HCI 1
50#define BTPROTO_SCO 2
51#define BTPROTO_RFCOMM 3
52#define BTPROTO_BNEP 4
53#define BTPROTO_CMTP 5
54#define BTPROTO_HIDP 6
55#define BTPROTO_AVDTP 7
56
57#define SOL_HCI 0
58#define SOL_L2CAP 6
59#define SOL_SCO 17
60#define SOL_RFCOMM 18
61
8c1b2355
MH
62#define BT_SECURITY 4
63struct bt_security {
64 __u8 level;
8f360119 65 __u8 key_size;
8c1b2355
MH
66};
67#define BT_SECURITY_SDP 0
68#define BT_SECURITY_LOW 1
69#define BT_SECURITY_MEDIUM 2
70#define BT_SECURITY_HIGH 3
7b5a9241 71#define BT_SECURITY_FIPS 4
8c1b2355 72
c4f912e1
MH
73#define BT_DEFER_SETUP 7
74
e702112f
AE
75#define BT_FLUSHABLE 8
76
77#define BT_FLUSHABLE_OFF 0
78#define BT_FLUSHABLE_ON 1
79
14b12d0b
JG
80#define BT_POWER 9
81struct bt_power {
82 __u8 force_active;
83};
84#define BT_POWER_FORCE_ACTIVE_OFF 0
85#define BT_POWER_FORCE_ACTIVE_ON 1
86
c14968b0
MM
87#define BT_CHANNEL_POLICY 10
88
89/* BR/EDR only (default policy)
90 * AMP controllers cannot be used.
91 * Channel move requests from the remote device are denied.
92 * If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
93 */
94#define BT_CHANNEL_POLICY_BREDR_ONLY 0
95
96/* BR/EDR Preferred
97 * Allow use of AMP controllers.
98 * If the L2CAP channel is currently on AMP, move it to BR/EDR.
99 * Channel move requests from the remote device are allowed.
100 */
101#define BT_CHANNEL_POLICY_BREDR_PREFERRED 1
102
103/* AMP Preferred
104 * Allow use of AMP controllers
105 * If the L2CAP channel is currently on BR/EDR and AMP controller
106 * resources are available, initiate a channel move to AMP.
107 * Channel move requests from the remote device are allowed.
108 * If the L2CAP socket has not been connected yet, try to create
109 * and configure the channel directly on an AMP controller rather
110 * than BR/EDR.
111 */
112#define BT_CHANNEL_POLICY_AMP_PREFERRED 2
113
ad10b1a4
FD
114#define BT_VOICE 11
115struct bt_voice {
116 __u16 setting;
117};
118
119#define BT_VOICE_TRANSPARENT 0x0003
120#define BT_VOICE_CVSD_16BIT 0x0060
121
1f435424
JH
122#define BT_SNDMTU 12
123#define BT_RCVMTU 13
124
3ed7003e 125__printf(1, 2)
2b0bf6c8 126void bt_info(const char *fmt, ...);
3ed7003e 127__printf(1, 2)
594b31ea
FD
128void bt_warn(const char *fmt, ...);
129__printf(1, 2)
2b0bf6c8 130void bt_err(const char *fmt, ...);
e781b7f7
SJ
131__printf(1, 2)
132void bt_err_ratelimited(const char *fmt, ...);
3ed7003e
JP
133
134#define BT_INFO(fmt, ...) bt_info(fmt "\n", ##__VA_ARGS__)
594b31ea 135#define BT_WARN(fmt, ...) bt_warn(fmt "\n", ##__VA_ARGS__)
3ed7003e
JP
136#define BT_ERR(fmt, ...) bt_err(fmt "\n", ##__VA_ARGS__)
137#define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__)
1da177e4 138
e781b7f7
SJ
139#define BT_ERR_RATELIMITED(fmt, ...) bt_err_ratelimited(fmt "\n", ##__VA_ARGS__)
140
6f558b70
LP
141#define bt_dev_info(hdev, fmt, ...) \
142 BT_INFO("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
594b31ea
FD
143#define bt_dev_warn(hdev, fmt, ...) \
144 BT_WARN("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
6f558b70
LP
145#define bt_dev_err(hdev, fmt, ...) \
146 BT_ERR("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
147#define bt_dev_dbg(hdev, fmt, ...) \
148 BT_DBG("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
149
2064ee33
MH
150#define bt_dev_err_ratelimited(hdev, fmt, ...) \
151 BT_ERR_RATELIMITED("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
152
1da177e4
LT
153/* Connection and socket states */
154enum {
155 BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
156 BT_OPEN,
157 BT_BOUND,
158 BT_LISTEN,
159 BT_CONNECT,
160 BT_CONNECT2,
161 BT_CONFIG,
162 BT_DISCONN,
163 BT_CLOSED
164};
165
20d1803a
AE
166/* If unused will be removed by compiler */
167static inline const char *state_to_string(int state)
168{
169 switch (state) {
170 case BT_CONNECTED:
171 return "BT_CONNECTED";
172 case BT_OPEN:
173 return "BT_OPEN";
174 case BT_BOUND:
175 return "BT_BOUND";
176 case BT_LISTEN:
177 return "BT_LISTEN";
178 case BT_CONNECT:
179 return "BT_CONNECT";
180 case BT_CONNECT2:
181 return "BT_CONNECT2";
182 case BT_CONFIG:
183 return "BT_CONFIG";
184 case BT_DISCONN:
185 return "BT_DISCONN";
186 case BT_CLOSED:
187 return "BT_CLOSED";
188 }
189
190 return "invalid state";
191}
192
1da177e4
LT
193/* BD Address */
194typedef struct {
195 __u8 b[6];
66c853cc 196} __packed bdaddr_t;
1da177e4 197
591f47f3
AG
198/* BD Address type */
199#define BDADDR_BREDR 0x00
200#define BDADDR_LE_PUBLIC 0x01
201#define BDADDR_LE_RANDOM 0x02
202
21fcf572 203static inline bool bdaddr_type_is_valid(u8 type)
679efe2b
JH
204{
205 switch (type) {
206 case BDADDR_BREDR:
207 case BDADDR_LE_PUBLIC:
208 case BDADDR_LE_RANDOM:
209 return true;
210 }
211
212 return false;
213}
214
21fcf572 215static inline bool bdaddr_type_is_le(u8 type)
679efe2b
JH
216{
217 switch (type) {
218 case BDADDR_LE_PUBLIC:
219 case BDADDR_LE_RANDOM:
220 return true;
221 }
222
223 return false;
224}
225
a59ac2f7
MH
226#define BDADDR_ANY (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
227#define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
1da177e4
LT
228
229/* Copy, swap, convert BD Address */
f53c20e9 230static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
1da177e4
LT
231{
232 return memcmp(ba1, ba2, sizeof(bdaddr_t));
233}
f53c20e9 234static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
1da177e4
LT
235{
236 memcpy(dst, src, sizeof(bdaddr_t));
237}
238
65bce462 239void baswap(bdaddr_t *dst, const bdaddr_t *src);
1da177e4
LT
240
241/* Common socket structures and functions */
242
243#define bt_sk(__sk) ((struct bt_sock *) __sk)
244
245struct bt_sock {
246 struct sock sk;
1da177e4
LT
247 struct list_head accept_q;
248 struct sock *parent;
c5daa683 249 unsigned long flags;
d9763698 250 void (*skb_msg_name)(struct sk_buff *, void *, int *);
c5daa683
GP
251};
252
253enum {
254 BT_SK_DEFER_SETUP,
255 BT_SK_SUSPEND,
1da177e4
LT
256};
257
258struct bt_sock_list {
259 struct hlist_head head;
260 rwlock_t lock;
256a06c8 261#ifdef CONFIG_PROC_FS
256a06c8
MY
262 int (* custom_seq_show)(struct seq_file *, void *);
263#endif
1da177e4
LT
264};
265
ec1b4cf7 266int bt_sock_register(int proto, const struct net_proto_family *ops);
be9f97f0 267void bt_sock_unregister(int proto);
1da177e4
LT
268void bt_sock_link(struct bt_sock_list *l, struct sock *s);
269void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
1b784140
YX
270int bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
271 int flags);
272int bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
273 size_t len, int flags);
c3c7ea65 274uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
3241ad82 275int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
1da177e4 276int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
e793dcf0 277int bt_sock_wait_ready(struct sock *sk, unsigned long flags);
1da177e4 278
a60ccf97 279void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh);
1da177e4
LT
280void bt_accept_unlink(struct sock *sk);
281struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
282
283/* Skb helpers */
00e3112c 284struct l2cap_ctrl {
21fcf572 285 u8 sframe:1,
07758991
MH
286 poll:1,
287 final:1,
288 fcs:1,
289 sar:2,
290 super:2;
21fcf572
PM
291
292 u16 reqseq;
293 u16 txseq;
294 u8 retries;
a4368ff3
JH
295 __le16 psm;
296 bdaddr_t bdaddr;
297 struct l2cap_chan *chan;
00e3112c
MM
298};
299
3119ae95
JH
300struct hci_dev;
301
1904a853 302typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
e6214487
JH
303typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
304 u16 opcode, struct sk_buff *skb);
3119ae95 305
44d27137
JH
306#define HCI_REQ_START BIT(0)
307#define HCI_REQ_SKB BIT(1)
308
242c0ebd 309struct hci_ctrl {
21fcf572 310 u16 opcode;
44d27137 311 u8 req_flags;
242c0ebd 312 u8 req_event;
44d27137
JH
313 union {
314 hci_req_complete_t req_complete;
315 hci_req_complete_skb_t req_complete_skb;
316 };
db6e3e8d
JH
317};
318
1da177e4 319struct bt_skb_cb {
21fcf572
PM
320 u8 pkt_type;
321 u8 force_active;
322 u16 expect;
323 u8 incoming:1;
db6e3e8d
JH
324 union {
325 struct l2cap_ctrl l2cap;
242c0ebd 326 struct hci_ctrl hci;
db6e3e8d 327 };
1da177e4 328};
1c2acffb 329#define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
1da177e4 330
f5c4a42a
MH
331#define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
332#define hci_skb_expect(skb) bt_cb((skb))->expect
333#define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
334
dd0fc66f 335static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
1da177e4
LT
336{
337 struct sk_buff *skb;
338
c3c7ea65 339 skb = alloc_skb(len + BT_SKB_RESERVE, how);
5fcc86bd 340 if (skb)
1da177e4 341 skb_reserve(skb, BT_SKB_RESERVE);
1da177e4
LT
342 return skb;
343}
344
5a9d0a3f
WR
345static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
346 unsigned long len, int nb, int *err)
1da177e4
LT
347{
348 struct sk_buff *skb;
349
c3c7ea65 350 skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
5fcc86bd 351 if (skb)
1da177e4 352 skb_reserve(skb, BT_SKB_RESERVE);
e454c844
GP
353
354 if (!skb && *err)
355 return NULL;
356
357 *err = sock_error(sk);
358 if (*err)
359 goto out;
360
361 if (sk->sk_shutdown) {
362 *err = -ECONNRESET;
363 goto out;
364 }
1da177e4
LT
365
366 return skb;
e454c844
GP
367
368out:
369 kfree_skb(skb);
370 return NULL;
1da177e4
LT
371}
372
21fcf572 373int bt_to_errno(u16 code);
1da177e4 374
6befc644
MH
375void hci_sock_set_flag(struct sock *sk, int nr);
376void hci_sock_clear_flag(struct sock *sk, int nr);
c85be545 377int hci_sock_test_flag(struct sock *sk, int nr);
d0f172b1 378unsigned short hci_sock_get_channel(struct sock *sk);
70ecce91 379u32 hci_sock_get_cookie(struct sock *sk);
6befc644 380
e74e58f8
JP
381int hci_sock_init(void);
382void hci_sock_cleanup(void);
6516455d 383
e74e58f8
JP
384int bt_sysfs_init(void);
385void bt_sysfs_cleanup(void);
6516455d 386
e74e58f8
JP
387int bt_procfs_init(struct net *net, const char *name,
388 struct bt_sock_list *sk_list,
389 int (*seq_show)(struct seq_file *, void *));
390void bt_procfs_cleanup(struct net *net, const char *name);
256a06c8 391
aef7d97c 392extern struct dentry *bt_debugfs;
be9d1227 393
64274518
GP
394int l2cap_init(void);
395void l2cap_exit(void);
64274518 396
ff50e8af 397#if IS_ENABLED(CONFIG_BT_BREDR)
64274518
GP
398int sco_init(void);
399void sco_exit(void);
ff50e8af
AW
400#else
401static inline int sco_init(void)
402{
403 return 0;
404}
405
406static inline void sco_exit(void)
407{
408}
409#endif
64274518 410
6d785aa3
JH
411int mgmt_init(void);
412void mgmt_exit(void);
413
d22015aa
OP
414void bt_sock_reclassify_lock(struct sock *sk, int proto);
415
1da177e4 416#endif /* __BLUETOOTH_H */