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