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, 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);
 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         __u16   reqseq;
 289         __u16   txseq;
 290         __u8    retries;
 291         __le16  psm;
 292         bdaddr_t bdaddr;
 293         struct l2cap_chan *chan;
 294 };
 295
 296 struct hci_dev;
 297
 298 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
 299 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
 300                                        u16 opcode, struct sk_buff *skb);
 301
 302 #define HCI_REQ_START   BIT(0)
 303 #define HCI_REQ_SKB     BIT(1)
 304
 305 struct hci_ctrl {
 306         __u16 opcode;
 307         u8 req_flags;
 308         u8 req_event;
 309         union {
 310                 hci_req_complete_t req_complete;
 311                 hci_req_complete_skb_t req_complete_skb;
 312         };
 313 };
 314
 315 struct bt_skb_cb {
 316         __u8 pkt_type;
 317         __u8 force_active;
 318         __u16 expect;
 319         __u8 incoming:1;
 320         union {
 321                 struct l2cap_ctrl l2cap;
 322                 struct hci_ctrl hci;
 323         };
 324 };
 325 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
 326
 327 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
 328 #define hci_skb_expect(skb) bt_cb((skb))->expect
 329 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
 330
 331 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
 332 {
 333         struct sk_buff *skb;
 334
 335         skb = alloc_skb(len + BT_SKB_RESERVE, how);
 336         if (skb)
 337                 skb_reserve(skb, BT_SKB_RESERVE);
 338         return skb;
 339 }
 340
 341 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
 342                                         unsigned long len, int nb, int *err)
 343 {
 344         struct sk_buff *skb;
 345
 346         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
 347         if (skb)
 348                 skb_reserve(skb, BT_SKB_RESERVE);
 349
 350         if (!skb && *err)
 351                 return NULL;
 352
 353         *err = sock_error(sk);
 354         if (*err)
 355                 goto out;
 356
 357         if (sk->sk_shutdown) {
 358                 *err = -ECONNRESET;
 359                 goto out;
 360         }
 361
 362         return skb;
 363
 364 out:
 365         kfree_skb(skb);
 366         return NULL;
 367 }
 368
 369 int bt_to_errno(__u16 code);
 370
 371 void hci_sock_set_flag(struct sock *sk, int nr);
 372 void hci_sock_clear_flag(struct sock *sk, int nr);
 373 int hci_sock_test_flag(struct sock *sk, int nr);
 374 unsigned short hci_sock_get_channel(struct sock *sk);
 375 u32 hci_sock_get_cookie(struct sock *sk);
 376
 377 int hci_sock_init(void);
 378 void hci_sock_cleanup(void);
 379
 380 int bt_sysfs_init(void);
 381 void bt_sysfs_cleanup(void);
 382
 383 int bt_procfs_init(struct net *net, const char *name,
 384                    struct bt_sock_list *sk_list,
 385                    int (*seq_show)(struct seq_file *, void *));
 386 void bt_procfs_cleanup(struct net *net, const char *name);
 387
 388 extern struct dentry *bt_debugfs;
 389
 390 int l2cap_init(void);
 391 void l2cap_exit(void);
 392
 393 #if IS_ENABLED(CONFIG_BT_BREDR)
 394 int sco_init(void);
 395 void sco_exit(void);
 396 #else
 397 static inline int sco_init(void)
 398 {
 399         return 0;
 400 }
 401
 402 static inline void sco_exit(void)
 403 {
 404 }
 405 #endif
 406
 407 int mgmt_init(void);
 408 void mgmt_exit(void);
 409
 410 void bt_sock_reclassify_lock(struct sock *sk, int proto);
 411
 412 #endif /* __BLUETOOTH_H */