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
  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
  62 #define BT_SECURITY     4
  63 struct bt_security {
  64         __u8 level;
  65         __u8 key_size;
  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
  71 #define BT_SECURITY_FIPS        4
  72
  73 #define BT_DEFER_SETUP  7
  74
  75 #define BT_FLUSHABLE    8
  76
  77 #define BT_FLUSHABLE_OFF        0
  78 #define BT_FLUSHABLE_ON         1
  79
  80 #define BT_POWER        9
  81 struct bt_power {
  82         __u8 force_active;
  83 };
  84 #define BT_POWER_FORCE_ACTIVE_OFF 0
  85 #define BT_POWER_FORCE_ACTIVE_ON  1
  86
  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
 114 #define BT_VOICE                11
 115 struct bt_voice {
 116         __u16 setting;
 117 };
 118
 119 #define BT_VOICE_TRANSPARENT                    0x0003
 120 #define BT_VOICE_CVSD_16BIT                     0x0060
 121
 122 #define BT_SNDMTU               12
 123 #define BT_RCVMTU               13
 124
 125 __printf(1, 2)
 126 void bt_info(const char *fmt, ...);
 127 __printf(1, 2)
 128 void bt_warn(const char *fmt, ...);
 129 __printf(1, 2)
 130 void bt_err(const char *fmt, ...);
 131 __printf(1, 2)
 132 void bt_err_ratelimited(const char *fmt, ...);
 133
 134 #define BT_INFO(fmt, ...)       bt_info(fmt "\n", ##__VA_ARGS__)
 135 #define BT_WARN(fmt, ...)       bt_warn(fmt "\n", ##__VA_ARGS__)
 136 #define BT_ERR(fmt, ...)        bt_err(fmt "\n", ##__VA_ARGS__)
 137 #define BT_DBG(fmt, ...)        pr_debug(fmt "\n", ##__VA_ARGS__)
 138
 139 #define BT_ERR_RATELIMITED(fmt, ...) bt_err_ratelimited(fmt "\n", ##__VA_ARGS__)
 140
 141 #define bt_dev_info(hdev, fmt, ...)                             \
 142         BT_INFO("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 143 #define bt_dev_warn(hdev, fmt, ...)                             \
 144         BT_WARN("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 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
 150 /* Connection and socket states */
 151 enum {
 152         BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
 153         BT_OPEN,
 154         BT_BOUND,
 155         BT_LISTEN,
 156         BT_CONNECT,
 157         BT_CONNECT2,
 158         BT_CONFIG,
 159         BT_DISCONN,
 160         BT_CLOSED
 161 };
 162
 163 /* If unused will be removed by compiler */
 164 static inline const char *state_to_string(int state)
 165 {
 166         switch (state) {
 167         case BT_CONNECTED:
 168                 return "BT_CONNECTED";
 169         case BT_OPEN:
 170                 return "BT_OPEN";
 171         case BT_BOUND:
 172                 return "BT_BOUND";
 173         case BT_LISTEN:
 174                 return "BT_LISTEN";
 175         case BT_CONNECT:
 176                 return "BT_CONNECT";
 177         case BT_CONNECT2:
 178                 return "BT_CONNECT2";
 179         case BT_CONFIG:
 180                 return "BT_CONFIG";
 181         case BT_DISCONN:
 182                 return "BT_DISCONN";
 183         case BT_CLOSED:
 184                 return "BT_CLOSED";
 185         }
 186
 187         return "invalid state";
 188 }
 189
 190 /* BD Address */
 191 typedef struct {
 192         __u8 b[6];
 193 } __packed bdaddr_t;
 194
 195 /* BD Address type */
 196 #define BDADDR_BREDR            0x00
 197 #define BDADDR_LE_PUBLIC        0x01
 198 #define BDADDR_LE_RANDOM        0x02
 199
 200 static inline bool bdaddr_type_is_valid(u8 type)
 201 {
 202         switch (type) {
 203         case BDADDR_BREDR:
 204         case BDADDR_LE_PUBLIC:
 205         case BDADDR_LE_RANDOM:
 206                 return true;
 207         }
 208
 209         return false;
 210 }
 211
 212 static inline bool bdaddr_type_is_le(u8 type)
 213 {
 214         switch (type) {
 215         case BDADDR_LE_PUBLIC:
 216         case BDADDR_LE_RANDOM:
 217                 return true;
 218         }
 219
 220         return false;
 221 }
 222
 223 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
 224 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
 225
 226 /* Copy, swap, convert BD Address */
 227 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
 228 {
 229         return memcmp(ba1, ba2, sizeof(bdaddr_t));
 230 }
 231 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
 232 {
 233         memcpy(dst, src, sizeof(bdaddr_t));
 234 }
 235
 236 void baswap(bdaddr_t *dst, const bdaddr_t *src);
 237
 238 /* Common socket structures and functions */
 239
 240 #define bt_sk(__sk) ((struct bt_sock *) __sk)
 241
 242 struct bt_sock {
 243         struct sock sk;
 244         struct list_head accept_q;
 245         struct sock *parent;
 246         unsigned long flags;
 247         void (*skb_msg_name)(struct sk_buff *, void *, int *);
 248 };
 249
 250 enum {
 251         BT_SK_DEFER_SETUP,
 252         BT_SK_SUSPEND,
 253 };
 254
 255 struct bt_sock_list {
 256         struct hlist_head head;
 257         rwlock_t          lock;
 258 #ifdef CONFIG_PROC_FS
 259         int (* custom_seq_show)(struct seq_file *, void *);
 260 #endif
 261 };
 262
 263 int  bt_sock_register(int proto, const struct net_proto_family *ops);
 264 void bt_sock_unregister(int proto);
 265 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
 266 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
 267 int  bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
 268                      int flags);
 269 int  bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
 270                             size_t len, int flags);
 271 uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
 272 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
 273 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
 274 int  bt_sock_wait_ready(struct sock *sk, unsigned long flags);
 275
 276 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh);
 277 void bt_accept_unlink(struct sock *sk);
 278 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
 279
 280 /* Skb helpers */
 281 struct l2cap_ctrl {
 282         u8      sframe:1,
 283                 poll:1,
 284                 final:1,
 285                 fcs:1,
 286                 sar:2,
 287                 super:2;
 288
 289         u16     reqseq;
 290         u16     txseq;
 291         u8      retries;
 292         __le16  psm;
 293         bdaddr_t bdaddr;
 294         struct l2cap_chan *chan;
 295 };
 296
 297 struct hci_dev;
 298
 299 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
 300 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
 301                                        u16 opcode, struct sk_buff *skb);
 302
 303 #define HCI_REQ_START   BIT(0)
 304 #define HCI_REQ_SKB     BIT(1)
 305
 306 struct hci_ctrl {
 307         u16 opcode;
 308         u8 req_flags;
 309         u8 req_event;
 310         union {
 311                 hci_req_complete_t req_complete;
 312                 hci_req_complete_skb_t req_complete_skb;
 313         };
 314 };
 315
 316 struct bt_skb_cb {
 317         u8 pkt_type;
 318         u8 force_active;
 319         u16 expect;
 320         u8 incoming:1;
 321         union {
 322                 struct l2cap_ctrl l2cap;
 323                 struct hci_ctrl hci;
 324         };
 325 };
 326 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
 327
 328 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
 329 #define hci_skb_expect(skb) bt_cb((skb))->expect
 330 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
 331
 332 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
 333 {
 334         struct sk_buff *skb;
 335
 336         skb = alloc_skb(len + BT_SKB_RESERVE, how);
 337         if (skb)
 338                 skb_reserve(skb, BT_SKB_RESERVE);
 339         return skb;
 340 }
 341
 342 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
 343                                         unsigned long len, int nb, int *err)
 344 {
 345         struct sk_buff *skb;
 346
 347         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
 348         if (skb)
 349                 skb_reserve(skb, BT_SKB_RESERVE);
 350
 351         if (!skb && *err)
 352                 return NULL;
 353
 354         *err = sock_error(sk);
 355         if (*err)
 356                 goto out;
 357
 358         if (sk->sk_shutdown) {
 359                 *err = -ECONNRESET;
 360                 goto out;
 361         }
 362
 363         return skb;
 364
 365 out:
 366         kfree_skb(skb);
 367         return NULL;
 368 }
 369
 370 /* Shall not be called with lock_sock held */
 371 static inline struct sk_buff *bt_skb_sendmsg(struct sock *sk,
 372                                              struct msghdr *msg,
 373                                              size_t len, size_t mtu,
 374                                              size_t headroom, size_t tailroom)
 375 {
 376         struct sk_buff *skb;
 377         size_t size = min_t(size_t, len, mtu);
 378         int err;
 379
 380         skb = bt_skb_send_alloc(sk, size + headroom + tailroom,
 381                                 msg->msg_flags & MSG_DONTWAIT, &err);
 382         if (!skb)
 383                 return ERR_PTR(err);
 384
 385         skb_reserve(skb, headroom);
 386         skb_tailroom_reserve(skb, mtu, tailroom);
 387
 388         if (!copy_from_iter_full(skb_put(skb, size), size, &msg->msg_iter)) {
 389                 kfree_skb(skb);
 390                 return ERR_PTR(-EFAULT);
 391         }
 392
 393         skb->priority = sk->sk_priority;
 394
 395         return skb;
 396 }
 397
 398 /* Similar to bt_skb_sendmsg but can split the msg into multiple fragments
 399  * accourding to the MTU.
 400  */
 401 static inline struct sk_buff *bt_skb_sendmmsg(struct sock *sk,
 402                                               struct msghdr *msg,
 403                                               size_t len, size_t mtu,
 404                                               size_t headroom, size_t tailroom)
 405 {
 406         struct sk_buff *skb, **frag;
 407
 408         skb = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
 409         if (IS_ERR_OR_NULL(skb))
 410                 return skb;
 411
 412         len -= skb->len;
 413         if (!len)
 414                 return skb;
 415
 416         /* Add remaining data over MTU as continuation fragments */
 417         frag = &skb_shinfo(skb)->frag_list;
 418         while (len) {
 419                 struct sk_buff *tmp;
 420
 421                 tmp = bt_skb_sendmsg(sk, msg, len, mtu, headroom, tailroom);
 422                 if (IS_ERR(tmp)) {
 423                         return skb;
 424                 }
 425
 426                 len -= tmp->len;
 427
 428                 *frag = tmp;
 429                 frag = &(*frag)->next;
 430         }
 431
 432         return skb;
 433 }
 434
 435 int bt_to_errno(u16 code);
 436
 437 void hci_sock_set_flag(struct sock *sk, int nr);
 438 void hci_sock_clear_flag(struct sock *sk, int nr);
 439 int hci_sock_test_flag(struct sock *sk, int nr);
 440 unsigned short hci_sock_get_channel(struct sock *sk);
 441 u32 hci_sock_get_cookie(struct sock *sk);
 442
 443 int hci_sock_init(void);
 444 void hci_sock_cleanup(void);
 445
 446 int bt_sysfs_init(void);
 447 void bt_sysfs_cleanup(void);
 448
 449 int bt_procfs_init(struct net *net, const char *name,
 450                    struct bt_sock_list *sk_list,
 451                    int (*seq_show)(struct seq_file *, void *));
 452 void bt_procfs_cleanup(struct net *net, const char *name);
 453
 454 extern struct dentry *bt_debugfs;
 455
 456 int l2cap_init(void);
 457 void l2cap_exit(void);
 458
 459 #if IS_ENABLED(CONFIG_BT_BREDR)
 460 int sco_init(void);
 461 void sco_exit(void);
 462 #else
 463 static inline int sco_init(void)
 464 {
 465         return 0;
 466 }
 467
 468 static inline void sco_exit(void)
 469 {
 470 }
 471 #endif
 472
 473 int mgmt_init(void);
 474 void mgmt_exit(void);
 475
 476 void bt_sock_reclassify_lock(struct sock *sk, int proto);
 477
 478 #endif /* __BLUETOOTH_H */