2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (C) 2000-2001 Qualcomm Incorporated
5 Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
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;
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.
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.
28 #include <linux/poll.h>
30 #include <linux/seq_file.h>
32 #define BT_SUBSYS_VERSION 2
33 #define BT_SUBSYS_REVISION 22
36 #define AF_BLUETOOTH 31
37 #define PF_BLUETOOTH AF_BLUETOOTH
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 #define BLUETOOTH_VER_2_1 4
45 #define BLUETOOTH_VER_4_0 6
47 /* Reserv for core and drivers use */
48 #define BT_SKB_RESERVE 8
50 #define BTPROTO_L2CAP 0
53 #define BTPROTO_RFCOMM 3
54 #define BTPROTO_BNEP 4
55 #define BTPROTO_CMTP 5
56 #define BTPROTO_HIDP 6
57 #define BTPROTO_AVDTP 7
69 #define BT_SECURITY_SDP 0
70 #define BT_SECURITY_LOW 1
71 #define BT_SECURITY_MEDIUM 2
72 #define BT_SECURITY_HIGH 3
73 #define BT_SECURITY_FIPS 4
75 #define BT_DEFER_SETUP 7
77 #define BT_FLUSHABLE 8
79 #define BT_FLUSHABLE_OFF 0
80 #define BT_FLUSHABLE_ON 1
86 #define BT_POWER_FORCE_ACTIVE_OFF 0
87 #define BT_POWER_FORCE_ACTIVE_ON 1
89 #define BT_CHANNEL_POLICY 10
91 /* BR/EDR only (default policy)
92 * AMP controllers cannot be used.
93 * Channel move requests from the remote device are denied.
94 * If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
96 #define BT_CHANNEL_POLICY_BREDR_ONLY 0
99 * Allow use of AMP controllers.
100 * If the L2CAP channel is currently on AMP, move it to BR/EDR.
101 * Channel move requests from the remote device are allowed.
103 #define BT_CHANNEL_POLICY_BREDR_PREFERRED 1
106 * Allow use of AMP controllers
107 * If the L2CAP channel is currently on BR/EDR and AMP controller
108 * resources are available, initiate a channel move to AMP.
109 * Channel move requests from the remote device are allowed.
110 * If the L2CAP socket has not been connected yet, try to create
111 * and configure the channel directly on an AMP controller rather
114 #define BT_CHANNEL_POLICY_AMP_PREFERRED 2
121 #define BT_VOICE_TRANSPARENT 0x0003
122 #define BT_VOICE_CVSD_16BIT 0x0060
128 #define BT_PHY_BR_1M_1SLOT 0x00000001
129 #define BT_PHY_BR_1M_3SLOT 0x00000002
130 #define BT_PHY_BR_1M_5SLOT 0x00000004
131 #define BT_PHY_EDR_2M_1SLOT 0x00000008
132 #define BT_PHY_EDR_2M_3SLOT 0x00000010
133 #define BT_PHY_EDR_2M_5SLOT 0x00000020
134 #define BT_PHY_EDR_3M_1SLOT 0x00000040
135 #define BT_PHY_EDR_3M_3SLOT 0x00000080
136 #define BT_PHY_EDR_3M_5SLOT 0x00000100
137 #define BT_PHY_LE_1M_TX 0x00000200
138 #define BT_PHY_LE_1M_RX 0x00000400
139 #define BT_PHY_LE_2M_TX 0x00000800
140 #define BT_PHY_LE_2M_RX 0x00001000
141 #define BT_PHY_LE_CODED_TX 0x00002000
142 #define BT_PHY_LE_CODED_RX 0x00004000
146 #define BT_MODE_BASIC 0x00
147 #define BT_MODE_ERTM 0x01
148 #define BT_MODE_STREAMING 0x02
149 #define BT_MODE_LE_FLOWCTL 0x03
150 #define BT_MODE_EXT_FLOWCTL 0x04
152 #define BT_PKT_STATUS 16
154 #define BT_SCM_PKT_STATUS 0x03
157 void bt_info(const char *fmt, ...);
159 void bt_warn(const char *fmt, ...);
161 void bt_err(const char *fmt, ...);
162 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG)
163 void bt_dbg_set(bool enable);
164 bool bt_dbg_get(void);
166 void bt_dbg(const char *fmt, ...);
169 void bt_warn_ratelimited(const char *fmt, ...);
171 void bt_err_ratelimited(const char *fmt, ...);
173 #define BT_INFO(fmt, ...) bt_info(fmt "\n", ##__VA_ARGS__)
174 #define BT_WARN(fmt, ...) bt_warn(fmt "\n", ##__VA_ARGS__)
175 #define BT_ERR(fmt, ...) bt_err(fmt "\n", ##__VA_ARGS__)
177 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG)
178 #define BT_DBG(fmt, ...) bt_dbg(fmt "\n", ##__VA_ARGS__)
180 #define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__)
183 #define bt_dev_name(hdev) ((hdev) ? (hdev)->name : "null")
185 #define bt_dev_info(hdev, fmt, ...) \
186 BT_INFO("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
187 #define bt_dev_warn(hdev, fmt, ...) \
188 BT_WARN("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
189 #define bt_dev_err(hdev, fmt, ...) \
190 BT_ERR("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
191 #define bt_dev_dbg(hdev, fmt, ...) \
192 BT_DBG("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
194 #define bt_dev_warn_ratelimited(hdev, fmt, ...) \
195 bt_warn_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
196 #define bt_dev_err_ratelimited(hdev, fmt, ...) \
197 bt_err_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__)
199 /* Connection and socket states */
201 BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
212 /* If unused will be removed by compiler */
213 static inline const char *state_to_string(int state)
217 return "BT_CONNECTED";
227 return "BT_CONNECT2";
236 return "invalid state";
244 /* BD Address type */
245 #define BDADDR_BREDR 0x00
246 #define BDADDR_LE_PUBLIC 0x01
247 #define BDADDR_LE_RANDOM 0x02
249 static inline bool bdaddr_type_is_valid(u8 type)
253 case BDADDR_LE_PUBLIC:
254 case BDADDR_LE_RANDOM:
261 static inline bool bdaddr_type_is_le(u8 type)
264 case BDADDR_LE_PUBLIC:
265 case BDADDR_LE_RANDOM:
272 #define BDADDR_ANY (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
273 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
275 /* Copy, swap, convert BD Address */
276 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
278 return memcmp(ba1, ba2, sizeof(bdaddr_t));
280 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
282 memcpy(dst, src, sizeof(bdaddr_t));
285 void baswap(bdaddr_t *dst, const bdaddr_t *src);
287 /* Common socket structures and functions */
289 #define bt_sk(__sk) ((struct bt_sock *) __sk)
293 struct list_head accept_q;
296 void (*skb_msg_name)(struct sk_buff *, void *, int *);
297 void (*skb_put_cmsg)(struct sk_buff *, struct msghdr *, struct sock *);
305 struct bt_sock_list {
306 struct hlist_head head;
308 #ifdef CONFIG_PROC_FS
309 int (* custom_seq_show)(struct seq_file *, void *);
313 int bt_sock_register(int proto, const struct net_proto_family *ops);
314 void bt_sock_unregister(int proto);
315 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
316 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
317 int bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
319 int bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
320 size_t len, int flags);
321 __poll_t bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
322 int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
323 int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
324 int bt_sock_wait_ready(struct sock *sk, unsigned long flags);
326 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh);
327 void bt_accept_unlink(struct sock *sk);
328 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
344 struct l2cap_chan *chan;
353 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
354 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
355 u16 opcode, struct sk_buff *skb);
357 #define HCI_REQ_START BIT(0)
358 #define HCI_REQ_SKB BIT(1)
365 hci_req_complete_t req_complete;
366 hci_req_complete_skb_t req_complete_skb;
376 struct l2cap_ctrl l2cap;
381 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
383 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
384 #define hci_skb_expect(skb) bt_cb((skb))->expect
385 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
387 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
391 skb = alloc_skb(len + BT_SKB_RESERVE, how);
393 skb_reserve(skb, BT_SKB_RESERVE);
397 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
398 unsigned long len, int nb, int *err)
402 skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
404 skb_reserve(skb, BT_SKB_RESERVE);
409 *err = sock_error(sk);
413 if (sk->sk_shutdown) {
425 /* Shall not be called with lock_sock held */
426 static inline struct sk_buff *bt_skb_sendmsg(struct sock *sk,
428 size_t len, size_t mtu,
429 size_t headroom, size_t tailroom)
432 size_t size = min_t(size_t, len, mtu);
435 skb = bt_skb_send_alloc(sk, size + headroom + tailroom,
436 msg->msg_flags & MSG_DONTWAIT, &err);
440 skb_reserve(skb, headroom);
441 skb_tailroom_reserve(skb, mtu, tailroom);
443 if (!copy_from_iter_full(skb_put(skb, size), size, &msg->msg_iter)) {
445 return ERR_PTR(-EFAULT);
448 skb->priority = sk->sk_priority;
453 /* Similar to bt_skb_sendmsg but can split the msg into multiple fragments
454 * accourding to the MTU.
456 static inline struct sk_buff *bt_skb_sendmmsg(struct sock *sk,
458 size_t len, size_t mtu,
459 size_t headroom, size_t tailroom)
461 struct sk_buff *skb, **frag;
463 skb = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
464 if (IS_ERR_OR_NULL(skb))
471 /* Add remaining data over MTU as continuation fragments */
472 frag = &skb_shinfo(skb)->frag_list;
476 tmp = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
484 frag = &(*frag)->next;
490 static inline int bt_copy_from_sockptr(void *dst, size_t dst_size,
491 sockptr_t src, size_t src_size)
493 if (dst_size > src_size)
496 return copy_from_sockptr(dst, src, dst_size);
499 int bt_to_errno(u16 code);
501 void hci_sock_set_flag(struct sock *sk, int nr);
502 void hci_sock_clear_flag(struct sock *sk, int nr);
503 int hci_sock_test_flag(struct sock *sk, int nr);
504 unsigned short hci_sock_get_channel(struct sock *sk);
505 u32 hci_sock_get_cookie(struct sock *sk);
507 int hci_sock_init(void);
508 void hci_sock_cleanup(void);
510 int bt_sysfs_init(void);
511 void bt_sysfs_cleanup(void);
513 int bt_procfs_init(struct net *net, const char *name,
514 struct bt_sock_list *sk_list,
515 int (*seq_show)(struct seq_file *, void *));
516 void bt_procfs_cleanup(struct net *net, const char *name);
518 extern struct dentry *bt_debugfs;
520 int l2cap_init(void);
521 void l2cap_exit(void);
523 #if IS_ENABLED(CONFIG_BT_BREDR)
527 static inline int sco_init(void)
532 static inline void sco_exit(void)
538 void mgmt_exit(void);
540 void bt_sock_reclassify_lock(struct sock *sk, int proto);
542 #endif /* __BLUETOOTH_H */