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