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.21"
  33
  34 #ifndef AF_BLUETOOTH
  35 #define AF_BLUETOOTH    31
  36 #define PF_BLUETOOTH    AF_BLUETOOTH
  37 #endif
  38
  39 /* Bluetooth versions */
  40 #define BLUETOOTH_VER_1_1       1
  41 #define BLUETOOTH_VER_1_2       2
  42 #define BLUETOOTH_VER_2_0       3
  43
  44 /* Reserv for core and drivers use */
  45 #define BT_SKB_RESERVE  8
  46
  47 #define BTPROTO_L2CAP   0
  48 #define BTPROTO_HCI     1
  49 #define BTPROTO_SCO     2
  50 #define BTPROTO_RFCOMM  3
  51 #define BTPROTO_BNEP    4
  52 #define BTPROTO_CMTP    5
  53 #define BTPROTO_HIDP    6
  54 #define BTPROTO_AVDTP   7
  55
  56 #define SOL_HCI         0
  57 #define SOL_L2CAP       6
  58 #define SOL_SCO         17
  59 #define SOL_RFCOMM      18
  60
  61 #define BT_SECURITY     4
  62 struct bt_security {
  63         __u8 level;
  64         __u8 key_size;
  65 };
  66 #define BT_SECURITY_SDP         0
  67 #define BT_SECURITY_LOW         1
  68 #define BT_SECURITY_MEDIUM      2
  69 #define BT_SECURITY_HIGH        3
  70 #define BT_SECURITY_FIPS        4
  71
  72 #define BT_DEFER_SETUP  7
  73
  74 #define BT_FLUSHABLE    8
  75
  76 #define BT_FLUSHABLE_OFF        0
  77 #define BT_FLUSHABLE_ON         1
  78
  79 #define BT_POWER        9
  80 struct bt_power {
  81         __u8 force_active;
  82 };
  83 #define BT_POWER_FORCE_ACTIVE_OFF 0
  84 #define BT_POWER_FORCE_ACTIVE_ON  1
  85
  86 #define BT_CHANNEL_POLICY       10
  87
  88 /* BR/EDR only (default policy)
  89  *   AMP controllers cannot be used.
  90  *   Channel move requests from the remote device are denied.
  91  *   If the L2CAP channel is currently using AMP, move the channel to BR/EDR.
  92  */
  93 #define BT_CHANNEL_POLICY_BREDR_ONLY            0
  94
  95 /* BR/EDR Preferred
  96  *   Allow use of AMP controllers.
  97  *   If the L2CAP channel is currently on AMP, move it to BR/EDR.
  98  *   Channel move requests from the remote device are allowed.
  99  */
 100 #define BT_CHANNEL_POLICY_BREDR_PREFERRED       1
 101
 102 /* AMP Preferred
 103  *   Allow use of AMP controllers
 104  *   If the L2CAP channel is currently on BR/EDR and AMP controller
 105  *     resources are available, initiate a channel move to AMP.
 106  *   Channel move requests from the remote device are allowed.
 107  *   If the L2CAP socket has not been connected yet, try to create
 108  *     and configure the channel directly on an AMP controller rather
 109  *     than BR/EDR.
 110  */
 111 #define BT_CHANNEL_POLICY_AMP_PREFERRED         2
 112
 113 #define BT_VOICE                11
 114 struct bt_voice {
 115         __u16 setting;
 116 };
 117
 118 #define BT_VOICE_TRANSPARENT                    0x0003
 119 #define BT_VOICE_CVSD_16BIT                     0x0060
 120
 121 #define BT_SNDMTU               12
 122 #define BT_RCVMTU               13
 123
 124 __printf(1, 2)
 125 void bt_info(const char *fmt, ...);
 126 __printf(1, 2)
 127 void bt_warn(const char *fmt, ...);
 128 __printf(1, 2)
 129 void bt_err(const char *fmt, ...);
 130 __printf(1, 2)
 131 void bt_err_ratelimited(const char *fmt, ...);
 132
 133 #define BT_INFO(fmt, ...)       bt_info(fmt "\n", ##__VA_ARGS__)
 134 #define BT_WARN(fmt, ...)       bt_warn(fmt "\n", ##__VA_ARGS__)
 135 #define BT_ERR(fmt, ...)        bt_err(fmt "\n", ##__VA_ARGS__)
 136 #define BT_DBG(fmt, ...)        pr_debug(fmt "\n", ##__VA_ARGS__)
 137
 138 #define BT_ERR_RATELIMITED(fmt, ...) bt_err_ratelimited(fmt "\n", ##__VA_ARGS__)
 139
 140 #define bt_dev_info(hdev, fmt, ...)                             \
 141         BT_INFO("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 142 #define bt_dev_warn(hdev, fmt, ...)                             \
 143         BT_WARN("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 144 #define bt_dev_err(hdev, fmt, ...)                              \
 145         BT_ERR("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 146 #define bt_dev_dbg(hdev, fmt, ...)                              \
 147         BT_DBG("%s: " fmt, (hdev)->name, ##__VA_ARGS__)
 148
 149 /* Connection and socket states */
 150 enum {
 151         BT_CONNECTED = 1, /* Equal to TCP_ESTABLISHED to make net code happy */
 152         BT_OPEN,
 153         BT_BOUND,
 154         BT_LISTEN,
 155         BT_CONNECT,
 156         BT_CONNECT2,
 157         BT_CONFIG,
 158         BT_DISCONN,
 159         BT_CLOSED
 160 };
 161
 162 /* If unused will be removed by compiler */
 163 static inline const char *state_to_string(int state)
 164 {
 165         switch (state) {
 166         case BT_CONNECTED:
 167                 return "BT_CONNECTED";
 168         case BT_OPEN:
 169                 return "BT_OPEN";
 170         case BT_BOUND:
 171                 return "BT_BOUND";
 172         case BT_LISTEN:
 173                 return "BT_LISTEN";
 174         case BT_CONNECT:
 175                 return "BT_CONNECT";
 176         case BT_CONNECT2:
 177                 return "BT_CONNECT2";
 178         case BT_CONFIG:
 179                 return "BT_CONFIG";
 180         case BT_DISCONN:
 181                 return "BT_DISCONN";
 182         case BT_CLOSED:
 183                 return "BT_CLOSED";
 184         }
 185
 186         return "invalid state";
 187 }
 188
 189 /* BD Address */
 190 typedef struct {
 191         __u8 b[6];
 192 } __packed bdaddr_t;
 193
 194 /* BD Address type */
 195 #define BDADDR_BREDR            0x00
 196 #define BDADDR_LE_PUBLIC        0x01
 197 #define BDADDR_LE_RANDOM        0x02
 198
 199 static inline bool bdaddr_type_is_valid(__u8 type)
 200 {
 201         switch (type) {
 202         case BDADDR_BREDR:
 203         case BDADDR_LE_PUBLIC:
 204         case BDADDR_LE_RANDOM:
 205                 return true;
 206         }
 207
 208         return false;
 209 }
 210
 211 static inline bool bdaddr_type_is_le(__u8 type)
 212 {
 213         switch (type) {
 214         case BDADDR_LE_PUBLIC:
 215         case BDADDR_LE_RANDOM:
 216                 return true;
 217         }
 218
 219         return false;
 220 }
 221
 222 #define BDADDR_ANY  (&(bdaddr_t) {{0, 0, 0, 0, 0, 0}})
 223 #define BDADDR_NONE (&(bdaddr_t) {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff}})
 224
 225 /* Copy, swap, convert BD Address */
 226 static inline int bacmp(const bdaddr_t *ba1, const bdaddr_t *ba2)
 227 {
 228         return memcmp(ba1, ba2, sizeof(bdaddr_t));
 229 }
 230 static inline void bacpy(bdaddr_t *dst, const bdaddr_t *src)
 231 {
 232         memcpy(dst, src, sizeof(bdaddr_t));
 233 }
 234
 235 void baswap(bdaddr_t *dst, bdaddr_t *src);
 236
 237 /* Common socket structures and functions */
 238
 239 #define bt_sk(__sk) ((struct bt_sock *) __sk)
 240
 241 struct bt_sock {
 242         struct sock sk;
 243         struct list_head accept_q;
 244         struct sock *parent;
 245         unsigned long flags;
 246         void (*skb_msg_name)(struct sk_buff *, void *, int *);
 247 };
 248
 249 enum {
 250         BT_SK_DEFER_SETUP,
 251         BT_SK_SUSPEND,
 252 };
 253
 254 struct bt_sock_list {
 255         struct hlist_head head;
 256         rwlock_t          lock;
 257 #ifdef CONFIG_PROC_FS
 258         int (* custom_seq_show)(struct seq_file *, void *);
 259 #endif
 260 };
 261
 262 int  bt_sock_register(int proto, const struct net_proto_family *ops);
 263 void bt_sock_unregister(int proto);
 264 void bt_sock_link(struct bt_sock_list *l, struct sock *s);
 265 void bt_sock_unlink(struct bt_sock_list *l, struct sock *s);
 266 int  bt_sock_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
 267                      int flags);
 268 int  bt_sock_stream_recvmsg(struct socket *sock, struct msghdr *msg,
 269                             size_t len, int flags);
 270 uint bt_sock_poll(struct file *file, struct socket *sock, poll_table *wait);
 271 int  bt_sock_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg);
 272 int  bt_sock_wait_state(struct sock *sk, int state, unsigned long timeo);
 273 int  bt_sock_wait_ready(struct sock *sk, unsigned long flags);
 274
 275 void bt_accept_enqueue(struct sock *parent, struct sock *sk);
 276 void bt_accept_unlink(struct sock *sk);
 277 struct sock *bt_accept_dequeue(struct sock *parent, struct socket *newsock);
 278
 279 /* Skb helpers */
 280 struct l2cap_ctrl {
 281         __u8    sframe:1,
 282                 poll:1,
 283                 final:1,
 284                 fcs:1,
 285                 sar:2,
 286                 super:2;
 287         __u16   reqseq;
 288         __u16   txseq;
 289         __u8    retries;
 290         __le16  psm;
 291         bdaddr_t bdaddr;
 292         struct l2cap_chan *chan;
 293 };
 294
 295 struct hci_dev;
 296
 297 typedef void (*hci_req_complete_t)(struct hci_dev *hdev, u8 status, u16 opcode);
 298 typedef void (*hci_req_complete_skb_t)(struct hci_dev *hdev, u8 status,
 299                                        u16 opcode, struct sk_buff *skb);
 300
 301 #define HCI_REQ_START   BIT(0)
 302 #define HCI_REQ_SKB     BIT(1)
 303
 304 struct hci_ctrl {
 305         __u16 opcode;
 306         u8 req_flags;
 307         u8 req_event;
 308         union {
 309                 hci_req_complete_t req_complete;
 310                 hci_req_complete_skb_t req_complete_skb;
 311         };
 312 };
 313
 314 struct bt_skb_cb {
 315         __u8 pkt_type;
 316         __u8 force_active;
 317         __u16 expect;
 318         __u8 incoming:1;
 319         union {
 320                 struct l2cap_ctrl l2cap;
 321                 struct hci_ctrl hci;
 322         };
 323 };
 324 #define bt_cb(skb) ((struct bt_skb_cb *)((skb)->cb))
 325
 326 #define hci_skb_pkt_type(skb) bt_cb((skb))->pkt_type
 327 #define hci_skb_expect(skb) bt_cb((skb))->expect
 328 #define hci_skb_opcode(skb) bt_cb((skb))->hci.opcode
 329
 330 static inline struct sk_buff *bt_skb_alloc(unsigned int len, gfp_t how)
 331 {
 332         struct sk_buff *skb;
 333
 334         skb = alloc_skb(len + BT_SKB_RESERVE, how);
 335         if (skb)
 336                 skb_reserve(skb, BT_SKB_RESERVE);
 337         return skb;
 338 }
 339
 340 static inline struct sk_buff *bt_skb_send_alloc(struct sock *sk,
 341                                         unsigned long len, int nb, int *err)
 342 {
 343         struct sk_buff *skb;
 344
 345         skb = sock_alloc_send_skb(sk, len + BT_SKB_RESERVE, nb, err);
 346         if (skb)
 347                 skb_reserve(skb, BT_SKB_RESERVE);
 348
 349         if (!skb && *err)
 350                 return NULL;
 351
 352         *err = sock_error(sk);
 353         if (*err)
 354                 goto out;
 355
 356         if (sk->sk_shutdown) {
 357                 *err = -ECONNRESET;
 358                 goto out;
 359         }
 360
 361         return skb;
 362
 363 out:
 364         kfree_skb(skb);
 365         return NULL;
 366 }
 367
 368 int bt_to_errno(__u16 code);
 369
 370 void hci_sock_set_flag(struct sock *sk, int nr);
 371 void hci_sock_clear_flag(struct sock *sk, int nr);
 372 int hci_sock_test_flag(struct sock *sk, int nr);
 373 unsigned short hci_sock_get_channel(struct sock *sk);
 374
 375 int hci_sock_init(void);
 376 void hci_sock_cleanup(void);
 377
 378 int bt_sysfs_init(void);
 379 void bt_sysfs_cleanup(void);
 380
 381 int bt_procfs_init(struct net *net, const char *name,
 382                    struct bt_sock_list *sk_list,
 383                    int (*seq_show)(struct seq_file *, void *));
 384 void bt_procfs_cleanup(struct net *net, const char *name);
 385
 386 extern struct dentry *bt_debugfs;
 387
 388 int l2cap_init(void);
 389 void l2cap_exit(void);
 390
 391 #if IS_ENABLED(CONFIG_BT_BREDR)
 392 int sco_init(void);
 393 void sco_exit(void);
 394 #else
 395 static inline int sco_init(void)
 396 {
 397         return 0;
 398 }
 399
 400 static inline void sco_exit(void)
 401 {
 402 }
 403 #endif
 404
 405 int mgmt_init(void);
 406 void mgmt_exit(void);
 407
 408 void bt_sock_reclassify_lock(struct sock *sk, int proto);
 409
 410 #endif /* __BLUETOOTH_H */