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 #define BT_PHY                  14
 125
 126 #define BT_PHY_BR_1M_1SLOT      0x00000001
 127 #define BT_PHY_BR_1M_3SLOT      0x00000002
 128 #define BT_PHY_BR_1M_5SLOT      0x00000004
 129 #define BT_PHY_EDR_2M_1SLOT     0x00000008
 130 #define BT_PHY_EDR_2M_3SLOT     0x00000010
 131 #define BT_PHY_EDR_2M_5SLOT     0x00000020
 132 #define BT_PHY_EDR_3M_1SLOT     0x00000040
 133 #define BT_PHY_EDR_3M_3SLOT     0x00000080
 134 #define BT_PHY_EDR_3M_5SLOT     0x00000100
 135 #define BT_PHY_LE_1M_TX         0x00000200
 136 #define BT_PHY_LE_1M_RX         0x00000400
 137 #define BT_PHY_LE_2M_TX         0x00000800
 138 #define BT_PHY_LE_2M_RX         0x00001000
 139 #define BT_PHY_LE_CODED_TX      0x00002000
 140 #define BT_PHY_LE_CODED_RX      0x00004000
 141
 142 __printf(1, 2)
 143 void bt_info(const char *fmt, ...);
 144 __printf(1, 2)
 145 void bt_warn(const char *fmt, ...);
 146 __printf(1, 2)
 147 void bt_err(const char *fmt, ...);
 148 __printf(1, 2)
 149 void bt_warn_ratelimited(const char *fmt, ...);
 150 __printf(1, 2)
 151 void bt_err_ratelimited(const char *fmt, ...);
 152
 153 #define BT_INFO(fmt, ...)       bt_info(fmt "\n", ##__VA_ARGS__)
 154 #define BT_WARN(fmt, ...)       bt_warn(fmt "\n", ##__VA_ARGS__)
 155 #define BT_ERR(fmt, ...)        bt_err(fmt "\n", ##__VA_ARGS__)
 156 #define BT_DBG(fmt, ...)        pr_debug(fmt "\n", ##__VA_ARGS__)
 157
 158 #define bt_dev_info(hdev, fmt, ...)                             \
 159         BT_INFO("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 160 #define bt_dev_warn(hdev, fmt, ...)                             \
 161         BT_WARN("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 162 #define bt_dev_err(hdev, fmt, ...)                              \
 163         BT_ERR("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 164 #define bt_dev_dbg(hdev, fmt, ...)                              \
 165         BT_DBG("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 166
 167 #define bt_dev_warn_ratelimited(hdev, fmt, ...)                 \
 168         bt_warn_ratelimited("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 169 #define bt_dev_err_ratelimited(hdev, fmt, ...)                  \
 170         bt_err_ratelimited("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 171
 172 /* Connection and socket states */
 173 enum {
 174         BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
 175         BT_OPEN,
 176         BT_BOUND,
 177         BT_LISTEN,
 178         BT_CONNECT,
 179         BT_CONNECT2,
 180         BT_CONFIG,
 181         BT_DISCONN,
 182         BT_CLOSED
 183 };
 184
 185 /* If unused will be removed by compiler */
 186 static inline const char *state_to_string(int state)
 187 {
 188         switch (state) {
 189         case BT_CONNECTED:
 190                 return "BT_CONNECTED";
 191         case BT_OPEN:
 192                 return "BT_OPEN";
 193         case BT_BOUND:
 194                 return "BT_BOUND";
 195         case BT_LISTEN:
 196                 return "BT_LISTEN";
 197         case BT_CONNECT:
 198                 return "BT_CONNECT";
 199         case BT_CONNECT2:
 200                 return "BT_CONNECT2";
 201         case BT_CONFIG:
 202                 return "BT_CONFIG";
 203         case BT_DISCONN:
 204                 return "BT_DISCONN";
 205         case BT_CLOSED:
 206                 return "BT_CLOSED";
 207         }
 208
 209         return "invalid state";
 210 }
 211
 212 /* BD Address */
 213 typedef struct {
 214         __u8 b[6];
 215 } __packed bdaddr_t;
 216
 217 /* BD Address type */
 218 #define BDADDR_BREDR            0x00
 219 #define BDADDR_LE_PUBLIC        0x01
 220 #define BDADDR_LE_RANDOM        0x02
 221
 222 static inline bool bdaddr_type_is_valid(u8 type)
 223 {
 224         switch (type) {
 225         case BDADDR_BREDR:
 226         case BDADDR_LE_PUBLIC:
 227         case BDADDR_LE_RANDOM:
 228                 return true;
 229         }
 230
 231         return false;
 232 }
 233
 234 static inline bool bdaddr_type_is_le(u8 type)
 235 {
 236         switch (type) {
 237         case BDADDR_LE_PUBLIC:
 238         case BDADDR_LE_RANDOM:
 239                 return true;
 240         }
 241
 242         return false;
 243 }
 244
 245 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
 246 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
 247
 248 /* Copy, swap, convert BD Address */
 249 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
 250 {
 251         return memcmp(ba1, ba2, sizeof(bdaddr_t));
 252 }
 253 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
 254 {
 255         memcpy(dst, src, sizeof(bdaddr_t));
 256 }
 257
 258 void baswap(bdaddr_t *dst, const bdaddr_t *src);
 259
 260 /* Common socket structures and functions */
 261
 262 #define bt_sk(__sk) ((struct bt_sock *) __sk)
 263
 264 struct bt_sock {
 265         struct sock sk;
 266         struct list_head accept_q;
 267         struct sock *parent;
 268         unsigned long flags;
 269         void (*skb_msg_name)(struct sk_buff *, void *, int *);
 270 };
 271
 272 enum {
 273         BT_SK_DEFER_SETUP,
 274         BT_SK_SUSPEND,
 275 };
 276
 277 struct bt_sock_list {
 278         struct hlist_head head;
 279         rwlock_t          lock;
 280 #ifdef CONFIG_PROC_FS
 281         int (* custom_seq_show)(struct seq_file *, void *);
 282 #endif
 283 };
 284
 285 int  bt_sock_register(int proto, const struct net_proto_family *ops);
 286 void bt_sock_unregister(int proto);
 287 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
 288 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
 289 int  bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
 290                      int flags);
 291 int  bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
 292                             size_t len, int flags);
 293 __poll_t bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
 294 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
 295 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
 296 int  bt_sock_wait_ready(struct sock *sk, unsigned long flags);
 297
 298 void bt_accept_enqueue(struct sock *parent, struct sock *sk, bool bh);
 299 void bt_accept_unlink(struct sock *sk);
 300 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
 301
 302 /* Skb helpers */
 303 struct l2cap_ctrl {
 304         u8      sframe:1,
 305                 poll:1,
 306                 final:1,
 307                 fcs:1,
 308                 sar:2,
 309                 super:2;
 310
 311         u16     reqseq;
 312         u16     txseq;
 313         u8      retries;
 314         __le16  psm;
 315         bdaddr_t bdaddr;
 316         struct l2cap_chan *chan;
 317 };
 318
 319 struct hci_dev;
 320
 321 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
 322 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
 323                                        u16 opcode, struct sk_buff *skb);
 324
 325 #define HCI_REQ_START   BIT(0)
 326 #define HCI_REQ_SKB     BIT(1)
 327
 328 struct hci_ctrl {
 329         u16 opcode;
 330         u8 req_flags;
 331         u8 req_event;
 332         union {
 333                 hci_req_complete_t req_complete;
 334                 hci_req_complete_skb_t req_complete_skb;
 335         };
 336 };
 337
 338 struct bt_skb_cb {
 339         u8 pkt_type;
 340         u8 force_active;
 341         u16 expect;
 342         u8 incoming:1;
 343         union {
 344                 struct l2cap_ctrl l2cap;
 345                 struct hci_ctrl hci;
 346         };
 347 };
 348 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
 349
 350 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
 351 #define hci_skb_expect(skb) bt_cb((skb))->expect
 352 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
 353
 354 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
 355 {
 356         struct sk_buff *skb;
 357
 358         skb = alloc_skb(len + BT_SKB_RESERVE, how);
 359         if (skb)
 360                 skb_reserve(skb, BT_SKB_RESERVE);
 361         return skb;
 362 }
 363
 364 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
 365                                         unsigned long len, int nb, int *err)
 366 {
 367         struct sk_buff *skb;
 368
 369         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
 370         if (skb)
 371                 skb_reserve(skb, BT_SKB_RESERVE);
 372
 373         if (!skb && *err)
 374                 return NULL;
 375
 376         *err = sock_error(sk);
 377         if (*err)
 378                 goto out;
 379
 380         if (sk->sk_shutdown) {
 381                 *err = -ECONNRESET;
 382                 goto out;
 383         }
 384
 385         return skb;
 386
 387 out:
 388         kfree_skb(skb);
 389         return NULL;
 390 }
 391
 392 int bt_to_errno(u16 code);
 393
 394 void hci_sock_set_flag(struct sock *sk, int nr);
 395 void hci_sock_clear_flag(struct sock *sk, int nr);
 396 int hci_sock_test_flag(struct sock *sk, int nr);
 397 unsigned short hci_sock_get_channel(struct sock *sk);
 398 u32 hci_sock_get_cookie(struct sock *sk);
 399
 400 int hci_sock_init(void);
 401 void hci_sock_cleanup(void);
 402
 403 int bt_sysfs_init(void);
 404 void bt_sysfs_cleanup(void);
 405
 406 int bt_procfs_init(struct net *net, const char *name,
 407                    struct bt_sock_list *sk_list,
 408                    int (*seq_show)(struct seq_file *, void *));
 409 void bt_procfs_cleanup(struct net *net, const char *name);
 410
 411 extern struct dentry *bt_debugfs;
 412
 413 int l2cap_init(void);
 414 void l2cap_exit(void);
 415
 416 #if IS_ENABLED(CONFIG_BT_BREDR)
 417 int sco_init(void);
 418 void sco_exit(void);
 419 #else
 420 static inline int sco_init(void)
 421 {
 422         return 0;
 423 }
 424
 425 static inline void sco_exit(void)
 426 {
 427 }
 428 #endif
 429
 430 int mgmt_init(void);
 431 void mgmt_exit(void);
 432
 433 void bt_sock_reclassify_lock(struct sock *sk, int proto);
 434
 435 #endif /* __BLUETOOTH_H */