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 #define BT_SUBSYS_VERSION 2 33 #define BT_SUBSYS_REVISION 22 34 35 #ifndef AF_BLUETOOTH 36 #define AF_BLUETOOTH 31 37 #define PF_BLUETOOTH AF_BLUETOOTH 38 #endif 39 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 46 47 /* Reserv for core and drivers use */ 48 #define BT_SKB_RESERVE 8 49 50 #define BTPROTO_L2CAP 0 51 #define BTPROTO_HCI 1 52 #define BTPROTO_SCO 2 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 58 59 #define SOL_HCI 0 60 #define SOL_L2CAP 6 61 #define SOL_SCO 17 62 #define SOL_RFCOMM 18 63 64 #define BT_SECURITY 4 65 struct bt_security { 66 __u8 level; 67 __u8 key_size; 68 }; 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 74 75 #define BT_DEFER_SETUP 7 76 77 #define BT_FLUSHABLE 8 78 79 #define BT_FLUSHABLE_OFF 0 80 #define BT_FLUSHABLE_ON 1 81 82 #define BT_POWER 9 83 struct bt_power { 84 __u8 force_active; 85 }; 86 #define BT_POWER_FORCE_ACTIVE_OFF 0 87 #define BT_POWER_FORCE_ACTIVE_ON 1 88 89 #define BT_CHANNEL_POLICY 10 90 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. 95 */ 96 #define BT_CHANNEL_POLICY_BREDR_ONLY 0 97 98 /* BR/EDR Preferred 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. 102 */ 103 #define BT_CHANNEL_POLICY_BREDR_PREFERRED 1 104 105 /* AMP Preferred 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 112 * than BR/EDR. 113 */ 114 #define BT_CHANNEL_POLICY_AMP_PREFERRED 2 115 116 #define BT_VOICE 11 117 struct bt_voice { 118 __u16 setting; 119 }; 120 121 #define BT_VOICE_TRANSPARENT 0x0003 122 #define BT_VOICE_CVSD_16BIT 0x0060 123 124 #define BT_SNDMTU 12 125 #define BT_RCVMTU 13 126 #define BT_PHY 14 127 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 143 144 #define BT_MODE 15 145 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 151 152 #define BT_PKT_STATUS 16 153 154 #define BT_SCM_PKT_STATUS 0x03 155 156 #define BT_CODEC 19 157 158 struct bt_codec_caps { 159 __u8 len; 160 __u8 data[]; 161 } __packed; 162 163 struct bt_codec { 164 __u8 id; 165 __u16 cid; 166 __u16 vid; 167 __u8 data_path; 168 __u8 num_caps; 169 } __packed; 170 171 struct bt_codecs { 172 __u8 num_codecs; 173 struct bt_codec codecs[]; 174 } __packed; 175 176 #define BT_CODEC_CVSD 0x02 177 #define BT_CODEC_TRANSPARENT 0x03 178 #define BT_CODEC_MSBC 0x05 179 180 __printf(1, 2) 181 void bt_info(const char *fmt, ...); 182 __printf(1, 2) 183 void bt_warn(const char *fmt, ...); 184 __printf(1, 2) 185 void bt_err(const char *fmt, ...); 186 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG) 187 void bt_dbg_set(bool enable); 188 bool bt_dbg_get(void); 189 __printf(1, 2) 190 void bt_dbg(const char *fmt, ...); 191 #endif 192 __printf(1, 2) 193 void bt_warn_ratelimited(const char *fmt, ...); 194 __printf(1, 2) 195 void bt_err_ratelimited(const char *fmt, ...); 196 197 #define BT_INFO(fmt, ...) bt_info(fmt "\n", ##__VA_ARGS__) 198 #define BT_WARN(fmt, ...) bt_warn(fmt "\n", ##__VA_ARGS__) 199 #define BT_ERR(fmt, ...) bt_err(fmt "\n", ##__VA_ARGS__) 200 201 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG) 202 #define BT_DBG(fmt, ...) bt_dbg(fmt "\n", ##__VA_ARGS__) 203 #else 204 #define BT_DBG(fmt, ...) pr_debug(fmt "\n", ##__VA_ARGS__) 205 #endif 206 207 #define bt_dev_name(hdev) ((hdev) ? (hdev)->name : "null") 208 209 #define bt_dev_info(hdev, fmt, ...) \ 210 BT_INFO("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 211 #define bt_dev_warn(hdev, fmt, ...) \ 212 BT_WARN("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 213 #define bt_dev_err(hdev, fmt, ...) \ 214 BT_ERR("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 215 #define bt_dev_dbg(hdev, fmt, ...) \ 216 BT_DBG("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 217 218 #define bt_dev_warn_ratelimited(hdev, fmt, ...) \ 219 bt_warn_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 220 #define bt_dev_err_ratelimited(hdev, fmt, ...) \ 221 bt_err_ratelimited("%s: " fmt, bt_dev_name(hdev), ##__VA_ARGS__) 222 223 /* Connection and socket states */ 224 enum { 225 BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */ 226 BT_OPEN, 227 BT_BOUND, 228 BT_LISTEN, 229 BT_CONNECT, 230 BT_CONNECT2, 231 BT_CONFIG, 232 BT_DISCONN, 233 BT_CLOSED 234 }; 235 236 /* If unused will be removed by compiler */ 237 static inline const char *state_to_string(int state) 238 { 239 switch (state) { 240 case BT_CONNECTED: 241 return "BT_CONNECTED"; 242 case BT_OPEN: 243 return "BT_OPEN"; 244 case BT_BOUND: 245 return "BT_BOUND"; 246 case BT_LISTEN: 247 return "BT_LISTEN"; 248 case BT_CONNECT: 249 return "BT_CONNECT"; 250 case BT_CONNECT2: 251 return "BT_CONNECT2"; 252 case BT_CONFIG: 253 return "BT_CONFIG"; 254 case BT_DISCONN: 255 return "BT_DISCONN"; 256 case BT_CLOSED: 257 return "BT_CLOSED"; 258 } 259 260 return "invalid state"; 261 } 262 263 /* BD Address */ 264 typedef struct { 265 __u8 b[6]; 266 } __packed bdaddr_t; 267 268 /* BD Address type */ 269 #define BDADDR_BREDR 0x00 270 #define BDADDR_LE_PUBLIC 0x01 271 #define BDADDR_LE_RANDOM 0x02 272 273 static inline bool bdaddr_type_is_valid(u8 type) 274 { 275 switch (type) { 276 case BDADDR_BREDR: 277 case BDADDR_LE_PUBLIC: 278 case BDADDR_LE_RANDOM: 279 return true; 280 } 281 282 return false; 283 } 284 285 static inline bool bdaddr_type_is_le(u8 type) 286 { 287 switch (type) { 288 case BDADDR_LE_PUBLIC: 289 case BDADDR_LE_RANDOM: 290 return true; 291 } 292 293 return false; 294 } 295 296 #define BDADDR_ANY (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}}) 297 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}}) 298 299 /* Copy, swap, convert BD Address */ 300 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2) 301 { 302 return memcmp(ba1, ba2, sizeof(bdaddr_t)); 303 } 304 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src) 305 { 306 memcpy(dst, src, sizeof(bdaddr_t)); 307 } 308 309 void baswap(bdaddr_t *dst, const bdaddr_t *src); 310 311 /* Common socket structures and functions */ 312 313 #define bt_sk(__sk) ((struct bt_sock *) __sk) 314 315 struct bt_sock { 316 struct sock sk; 317 struct list_head accept_q; 318 struct sock *parent; 319 unsigned long flags; 320 void (*skb_msg_name)(struct sk_buff *, void *, int *); 321 void (*skb_put_cmsg)(struct sk_buff *, struct msghdr *, struct sock *); 322 }; 323 324 enum { 325 BT_SK_DEFER_SETUP, 326 BT_SK_SUSPEND, 327 }; 328 329 struct bt_sock_list { 330 struct hlist_head head; 331 rwlock_t lock; 332 #ifdef CONFIG_PROC_FS 333 int (* custom_seq_show)(struct seq_file *, void *); 334 #endif 335 }; 336 337 int bt_sock_register(int proto, const struct net_proto_family *ops); 338 void bt_sock_unregister(int proto); 339 void bt_sock_link(struct bt_sock_list *l, struct sock *s); 340 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s); 341 int bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len, 342 int flags); 343 int bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg, 344 size_t len, int flags); 345 __poll_t bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait); 346 int bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg); 347 int bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo); 348 int bt_sock_wait_ready(struct sock *sk, unsigned int msg_flags); 349 350 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh); 351 void bt_accept_unlink(struct sock *sk); 352 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock); 353 354 /* Skb helpers */ 355 struct l2cap_ctrl { 356 u8 sframe:1, 357 poll:1, 358 final:1, 359 fcs:1, 360 sar:2, 361 super:2; 362 363 u16 reqseq; 364 u16 txseq; 365 u8 retries; 366 __le16 psm; 367 bdaddr_t bdaddr; 368 struct l2cap_chan *chan; 369 }; 370 371 struct sco_ctrl { 372 u8 pkt_status; 373 }; 374 375 struct hci_dev; 376 377 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode); 378 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status, 379 u16 opcode, struct sk_buff *skb); 380 381 #define HCI_REQ_START BIT(0) 382 #define HCI_REQ_SKB BIT(1) 383 384 struct hci_ctrl { 385 struct sock *sk; 386 u16 opcode; 387 u8 req_flags; 388 u8 req_event; 389 union { 390 hci_req_complete_t req_complete; 391 hci_req_complete_skb_t req_complete_skb; 392 }; 393 }; 394 395 struct mgmt_ctrl { 396 struct hci_dev *hdev; 397 u16 opcode; 398 }; 399 400 struct bt_skb_cb { 401 u8 pkt_type; 402 u8 force_active; 403 u16 expect; 404 u8 incoming:1; 405 union { 406 struct l2cap_ctrl l2cap; 407 struct sco_ctrl sco; 408 struct hci_ctrl hci; 409 struct mgmt_ctrl mgmt; 410 }; 411 }; 412 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb)) 413 414 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type 415 #define hci_skb_expect(skb) bt_cb((skb))->expect 416 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode 417 #define hci_skb_event(skb) bt_cb((skb))->hci.req_event 418 #define hci_skb_sk(skb) bt_cb((skb))->hci.sk 419 420 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how) 421 { 422 struct sk_buff *skb; 423 424 skb = alloc_skb(len + BT_SKB_RESERVE, how); 425 if (skb) 426 skb_reserve(skb, BT_SKB_RESERVE); 427 return skb; 428 } 429 430 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk, 431 unsigned long len, int nb, int *err) 432 { 433 struct sk_buff *skb; 434 435 skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err); 436 if (skb) 437 skb_reserve(skb, BT_SKB_RESERVE); 438 439 if (!skb && *err) 440 return NULL; 441 442 *err = sock_error(sk); 443 if (*err) 444 goto out; 445 446 if (sk->sk_shutdown) { 447 *err = -ECONNRESET; 448 goto out; 449 } 450 451 return skb; 452 453 out: 454 kfree_skb(skb); 455 return NULL; 456 } 457 458 /* Shall not be called with lock_sock held */ 459 static inline struct sk_buff *bt_skb_sendmsg(struct sock *sk, 460 struct msghdr *msg, 461 size_t len, size_t mtu, 462 size_t headroom, size_t tailroom) 463 { 464 struct sk_buff *skb; 465 size_t size = min_t(size_t, len, mtu); 466 int err; 467 468 skb = bt_skb_send_alloc(sk, size + headroom + tailroom, 469 msg->msg_flags & MSG_DONTWAIT, &err); 470 if (!skb) 471 return ERR_PTR(err); 472 473 skb_reserve(skb, headroom); 474 skb_tailroom_reserve(skb, mtu, tailroom); 475 476 if (!copy_from_iter_full(skb_put(skb, size), size, &msg->msg_iter)) { 477 kfree_skb(skb); 478 return ERR_PTR(-EFAULT); 479 } 480 481 skb->priority = sk->sk_priority; 482 483 return skb; 484 } 485 486 /* Similar to bt_skb_sendmsg but can split the msg into multiple fragments 487 * accourding to the MTU. 488 */ 489 static inline struct sk_buff *bt_skb_sendmmsg(struct sock *sk, 490 struct msghdr *msg, 491 size_t len, size_t mtu, 492 size_t headroom, size_t tailroom) 493 { 494 struct sk_buff *skb, **frag; 495 496 skb = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom); 497 if (IS_ERR_OR_NULL(skb)) 498 return skb; 499 500 len -= skb->len; 501 if (!len) 502 return skb; 503 504 /* Add remaining data over MTU as continuation fragments */ 505 frag = &skb_shinfo(skb)->frag_list; 506 while (len) { 507 struct sk_buff *tmp; 508 509 tmp = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom); 510 if (IS_ERR(tmp)) { 511 return skb; 512 } 513 514 len -= tmp->len; 515 516 *frag = tmp; 517 frag = &(*frag)->next; 518 } 519 520 return skb; 521 } 522 523 int bt_to_errno(u16 code); 524 525 void hci_sock_set_flag(struct sock *sk, int nr); 526 void hci_sock_clear_flag(struct sock *sk, int nr); 527 int hci_sock_test_flag(struct sock *sk, int nr); 528 unsigned short hci_sock_get_channel(struct sock *sk); 529 u32 hci_sock_get_cookie(struct sock *sk); 530 531 int hci_sock_init(void); 532 void hci_sock_cleanup(void); 533 534 int bt_sysfs_init(void); 535 void bt_sysfs_cleanup(void); 536 537 int bt_procfs_init(struct net *net, const char *name, 538 struct bt_sock_list *sk_list, 539 int (*seq_show)(struct seq_file *, void *)); 540 void bt_procfs_cleanup(struct net *net, const char *name); 541 542 extern struct dentry *bt_debugfs; 543 544 int l2cap_init(void); 545 void l2cap_exit(void); 546 547 #if IS_ENABLED(CONFIG_BT_BREDR) 548 int sco_init(void); 549 void sco_exit(void); 550 #else 551 static inline int sco_init(void) 552 { 553 return 0; 554 } 555 556 static inline void sco_exit(void) 557 { 558 } 559 #endif 560 561 int mgmt_init(void); 562 void mgmt_exit(void); 563 564 void bt_sock_reclassify_lock(struct sock *sk, int proto); 565 566 #endif /* __BLUETOOTH_H */ 567