include/net/bluetooth/bluetooth.h

   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 __printf(1, 2)
 157 void bt_info(const char *fmt, ...);
 158 __printf(1, 2)
 159 void bt_warn(const char *fmt, ...);
 160 __printf(1, 2)
 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);
 165 __printf(1, 2)
 166 void bt_dbg(const char *fmt, ...);
 167 #endif
 168 __printf(1, 2)
 169 void bt_warn_ratelimited(const char *fmt, ...);
 170 __printf(1, 2)
 171 void bt_err_ratelimited(const char *fmt, ...);
 172
 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__)
 176
 177 #if IS_ENABLED(CONFIG_BT_FEATURE_DEBUG)
 178 #define BT_DBG(fmt, ...)        bt_dbg(fmt "\n", ##__VA_ARGS__)
 179 #else
 180 #define BT_DBG(fmt, ...)        pr_debug(fmt "\n", ##__VA_ARGS__)
 181 #endif
 182
 183 #define bt_dev_name(hdev) ((hdev) ? (hdev)->name : "null")
 184
 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__)
 193
 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__)
 198
 199 /* Connection and socket states */
 200 enum {
 201         BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
 202         BT_OPEN,
 203         BT_BOUND,
 204         BT_LISTEN,
 205         BT_CONNECT,
 206         BT_CONNECT2,
 207         BT_CONFIG,
 208         BT_DISCONN,
 209         BT_CLOSED
 210 };
 211
 212 /* If unused will be removed by compiler */
 213 static inline const char *state_to_string(int state)
 214 {
 215         switch (state) {
 216         case BT_CONNECTED:
 217                 return "BT_CONNECTED";
 218         case BT_OPEN:
 219                 return "BT_OPEN";
 220         case BT_BOUND:
 221                 return "BT_BOUND";
 222         case BT_LISTEN:
 223                 return "BT_LISTEN";
 224         case BT_CONNECT:
 225                 return "BT_CONNECT";
 226         case BT_CONNECT2:
 227                 return "BT_CONNECT2";
 228         case BT_CONFIG:
 229                 return "BT_CONFIG";
 230         case BT_DISCONN:
 231                 return "BT_DISCONN";
 232         case BT_CLOSED:
 233                 return "BT_CLOSED";
 234         }
 235
 236         return "invalid state";
 237 }
 238
 239 /* BD Address */
 240 typedef struct {
 241         __u8 b[6];
 242 } __packed bdaddr_t;
 243
 244 /* BD Address type */
 245 #define BDADDR_BREDR            0x00
 246 #define BDADDR_LE_PUBLIC        0x01
 247 #define BDADDR_LE_RANDOM        0x02
 248
 249 static inline bool bdaddr_type_is_valid(u8 type)
 250 {
 251         switch (type) {
 252         case BDADDR_BREDR:
 253         case BDADDR_LE_PUBLIC:
 254         case BDADDR_LE_RANDOM:
 255                 return true;
 256         }
 257
 258         return false;
 259 }
 260
 261 static inline bool bdaddr_type_is_le(u8 type)
 262 {
 263         switch (type) {
 264         case BDADDR_LE_PUBLIC:
 265         case BDADDR_LE_RANDOM:
 266                 return true;
 267         }
 268
 269         return false;
 270 }
 271
 272 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
 273 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
 274
 275 /* Copy, swap, convert BD Address */
 276 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
 277 {
 278         return memcmp(ba1, ba2, sizeof(bdaddr_t));
 279 }
 280 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
 281 {
 282         memcpy(dst, src, sizeof(bdaddr_t));
 283 }
 284
 285 void baswap(bdaddr_t *dst, const bdaddr_t *src);
 286
 287 /* Common socket structures and functions */
 288
 289 #define bt_sk(__sk) ((struct bt_sock *) __sk)
 290
 291 struct bt_sock {
 292         struct sock sk;
 293         struct list_head accept_q;
 294         struct sock *parent;
 295         unsigned long flags;
 296         void (*skb_msg_name)(struct sk_buff *, void *, int *);
 297         void (*skb_put_cmsg)(struct sk_buff *, struct msghdr *, struct sock *);
 298 };
 299
 300 enum {
 301         BT_SK_DEFER_SETUP,
 302         BT_SK_SUSPEND,
 303 };
 304
 305 struct bt_sock_list {
 306         struct hlist_head head;
 307         rwlock_t          lock;
 308 #ifdef CONFIG_PROC_FS
 309         int (* custom_seq_show)(struct seq_file *, void *);
 310 #endif
 311 };
 312
 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,
 318                      int flags);
 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);
 325
 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);
 329
 330 /* Skb helpers */
 331 struct l2cap_ctrl {
 332         u8      sframe:1,
 333                 poll:1,
 334                 final:1,
 335                 fcs:1,
 336                 sar:2,
 337                 super:2;
 338
 339         u16     reqseq;
 340         u16     txseq;
 341         u8      retries;
 342         __le16  psm;
 343         bdaddr_t bdaddr;
 344         struct l2cap_chan *chan;
 345 };
 346
 347 struct sco_ctrl {
 348         u8      pkt_status;
 349 };
 350
 351 struct hci_dev;
 352
 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);
 356
 357 #define HCI_REQ_START   BIT(0)
 358 #define HCI_REQ_SKB     BIT(1)
 359
 360 struct hci_ctrl {
 361         u16 opcode;
 362         u8 req_flags;
 363         u8 req_event;
 364         union {
 365                 hci_req_complete_t req_complete;
 366                 hci_req_complete_skb_t req_complete_skb;
 367         };
 368 };
 369
 370 struct bt_skb_cb {
 371         u8 pkt_type;
 372         u8 force_active;
 373         u16 expect;
 374         u8 incoming:1;
 375         union {
 376                 struct l2cap_ctrl l2cap;
 377                 struct sco_ctrl sco;
 378                 struct hci_ctrl hci;
 379         };
 380 };
 381 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
 382
 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
 386
 387 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
 388 {
 389         struct sk_buff *skb;
 390
 391         skb = alloc_skb(len + BT_SKB_RESERVE, how);
 392         if (skb)
 393                 skb_reserve(skb, BT_SKB_RESERVE);
 394         return skb;
 395 }
 396
 397 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
 398                                         unsigned long len, int nb, int *err)
 399 {
 400         struct sk_buff *skb;
 401
 402         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
 403         if (skb)
 404                 skb_reserve(skb, BT_SKB_RESERVE);
 405
 406         if (!skb && *err)
 407                 return NULL;
 408
 409         *err = sock_error(sk);
 410         if (*err)
 411                 goto out;
 412
 413         if (sk->sk_shutdown) {
 414                 *err = -ECONNRESET;
 415                 goto out;
 416         }
 417
 418         return skb;
 419
 420 out:
 421         kfree_skb(skb);
 422         return NULL;
 423 }
 424
 425 /* Shall not be called with lock_sock held */
 426 static inline struct sk_buff *bt_skb_sendmsg(struct sock *sk,
 427                                              struct msghdr *msg,
 428                                              size_t len, size_t mtu,
 429                                              size_t headroom, size_t tailroom)
 430 {
 431         struct sk_buff *skb;
 432         size_t size = min_t(size_t, len, mtu);
 433         int err;
 434
 435         skb = bt_skb_send_alloc(sk, size + headroom + tailroom,
 436                                 msg->msg_flags & MSG_DONTWAIT, &err);
 437         if (!skb)
 438                 return ERR_PTR(err);
 439
 440         skb_reserve(skb, headroom);
 441         skb_tailroom_reserve(skb, mtu, tailroom);
 442
 443         if (!copy_from_iter_full(skb_put(skb, size), size, &msg->msg_iter)) {
 444                 kfree_skb(skb);
 445                 return ERR_PTR(-EFAULT);
 446         }
 447
 448         skb->priority = sk->sk_priority;
 449
 450         return skb;
 451 }
 452
 453 /* Similar to bt_skb_sendmsg but can split the msg into multiple fragments
 454  * accourding to the MTU.
 455  */
 456 static inline struct sk_buff *bt_skb_sendmmsg(struct sock *sk,
 457                                               struct msghdr *msg,
 458                                               size_t len, size_t mtu,
 459                                               size_t headroom, size_t tailroom)
 460 {
 461         struct sk_buff *skb, **frag;
 462
 463         skb = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
 464         if (IS_ERR_OR_NULL(skb))
 465                 return skb;
 466
 467         len -= skb->len;
 468         if (!len)
 469                 return skb;
 470
 471         /* Add remaining data over MTU as continuation fragments */
 472         frag = &skb_shinfo(skb)->frag_list;
 473         while (len) {
 474                 struct sk_buff *tmp;
 475
 476                 tmp = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
 477                 if (IS_ERR(tmp)) {
 478                         return skb;
 479                 }
 480
 481                 len -= tmp->len;
 482
 483                 *frag = tmp;
 484                 frag = &(*frag)->next;
 485         }
 486
 487         return skb;
 488 }
 489
 490 static inline int bt_copy_from_sockptr(void *dst, size_t dst_size,
 491                                        sockptr_t src, size_t src_size)
 492 {
 493         if (dst_size > src_size)
 494                 return -EINVAL;
 495
 496         return copy_from_sockptr(dst, src, dst_size);
 497 }
 498
 499 int bt_to_errno(u16 code);
 500
 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);
 506
 507 int hci_sock_init(void);
 508 void hci_sock_cleanup(void);
 509
 510 int bt_sysfs_init(void);
 511 void bt_sysfs_cleanup(void);
 512
 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);
 517
 518 extern struct dentry *bt_debugfs;
 519
 520 int l2cap_init(void);
 521 void l2cap_exit(void);
 522
 523 #if IS_ENABLED(CONFIG_BT_BREDR)
 524 int sco_init(void);
 525 void sco_exit(void);
 526 #else
 527 static inline int sco_init(void)
 528 {
 529         return 0;
 530 }
 531
 532 static inline void sco_exit(void)
 533 {
 534 }
 535 #endif
 536
 537 int mgmt_init(void);
 538 void mgmt_exit(void);
 539
 540 void bt_sock_reclassify_lock(struct sock *sk, int proto);
 541
 542 #endif /* __BLUETOOTH_H */