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