include/net/bluetooth/l2cap.h

   1 /*
   2    BlueZ - Bluetooth protocol stack for Linux
   3    Copyright (C) 2000-2001 Qualcomm Incorporated
   4    Copyright (C) 2009-2010 Gustavo F. Padovan <gustavo@padovan.org>
   5    Copyright (C) 2010 Google Inc.
   6
   7    Written 2000,2001 by Maxim Krasnyansky <maxk@qualcomm.com>
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License version 2 as
  11    published by the Free Software Foundation;
  12
  13    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  14    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
  16    IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
  17    CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
  18    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  19    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  20    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21
  22    ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
  23    COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
  24    SOFTWARE IS DISCLAIMED.
  25 */
  26
  27 #ifndef __L2CAP_H
  28 #define __L2CAP_H
  29
  30 /* L2CAP defaults */
  31 #define L2CAP_DEFAULT_MTU               672
  32 #define L2CAP_DEFAULT_MIN_MTU           48
  33 #define L2CAP_DEFAULT_FLUSH_TO          0xffff
  34 #define L2CAP_DEFAULT_TX_WINDOW         63
  35 #define L2CAP_DEFAULT_MAX_TX            3
  36 #define L2CAP_DEFAULT_RETRANS_TO        2000    /* 2 seconds */
  37 #define L2CAP_DEFAULT_MONITOR_TO        12000   /* 12 seconds */
  38 #define L2CAP_DEFAULT_MAX_PDU_SIZE      1009    /* Sized for 3-DH5 packet */
  39 #define L2CAP_DEFAULT_ACK_TO            200
  40 #define L2CAP_LOCAL_BUSY_TRIES          12
  41 #define L2CAP_LE_DEFAULT_MTU            23
  42
  43 #define L2CAP_CONN_TIMEOUT      (40000) /* 40 seconds */
  44 #define L2CAP_INFO_TIMEOUT      (4000)  /*  4 seconds */
  45
  46 /* L2CAP socket address */
  47 struct sockaddr_l2 {
  48         sa_family_t     l2_family;
  49         __le16          l2_psm;
  50         bdaddr_t        l2_bdaddr;
  51         __le16          l2_cid;
  52 };
  53
  54 /* L2CAP socket options */
  55 #define L2CAP_OPTIONS   0x01
  56 struct l2cap_options {
  57         __u16 omtu;
  58         __u16 imtu;
  59         __u16 flush_to;
  60         __u8  mode;
  61         __u8  fcs;
  62         __u8  max_tx;
  63         __u16 txwin_size;
  64 };
  65
  66 #define L2CAP_CONNINFO  0x02
  67 struct l2cap_conninfo {
  68         __u16 hci_handle;
  69         __u8  dev_class[3];
  70 };
  71
  72 #define L2CAP_LM        0x03
  73 #define L2CAP_LM_MASTER         0x0001
  74 #define L2CAP_LM_AUTH           0x0002
  75 #define L2CAP_LM_ENCRYPT        0x0004
  76 #define L2CAP_LM_TRUSTED        0x0008
  77 #define L2CAP_LM_RELIABLE       0x0010
  78 #define L2CAP_LM_SECURE         0x0020
  79
  80 /* L2CAP command codes */
  81 #define L2CAP_COMMAND_REJ       0x01
  82 #define L2CAP_CONN_REQ          0x02
  83 #define L2CAP_CONN_RSP          0x03
  84 #define L2CAP_CONF_REQ          0x04
  85 #define L2CAP_CONF_RSP          0x05
  86 #define L2CAP_DISCONN_REQ       0x06
  87 #define L2CAP_DISCONN_RSP       0x07
  88 #define L2CAP_ECHO_REQ          0x08
  89 #define L2CAP_ECHO_RSP          0x09
  90 #define L2CAP_INFO_REQ          0x0a
  91 #define L2CAP_INFO_RSP          0x0b
  92
  93 /* L2CAP feature mask */
  94 #define L2CAP_FEAT_FLOWCTL      0x00000001
  95 #define L2CAP_FEAT_RETRANS      0x00000002
  96 #define L2CAP_FEAT_ERTM         0x00000008
  97 #define L2CAP_FEAT_STREAMING    0x00000010
  98 #define L2CAP_FEAT_FCS          0x00000020
  99 #define L2CAP_FEAT_FIXED_CHAN   0x00000080
 100
 101 /* L2CAP checksum option */
 102 #define L2CAP_FCS_NONE          0x00
 103 #define L2CAP_FCS_CRC16         0x01
 104
 105 /* L2CAP Control Field bit masks */
 106 #define L2CAP_CTRL_SAR               0xC000
 107 #define L2CAP_CTRL_REQSEQ            0x3F00
 108 #define L2CAP_CTRL_TXSEQ             0x007E
 109 #define L2CAP_CTRL_RETRANS           0x0080
 110 #define L2CAP_CTRL_FINAL             0x0080
 111 #define L2CAP_CTRL_POLL              0x0010
 112 #define L2CAP_CTRL_SUPERVISE         0x000C
 113 #define L2CAP_CTRL_FRAME_TYPE        0x0001 /* I- or S-Frame */
 114
 115 #define L2CAP_CTRL_TXSEQ_SHIFT      1
 116 #define L2CAP_CTRL_REQSEQ_SHIFT     8
 117 #define L2CAP_CTRL_SAR_SHIFT       14
 118
 119 /* L2CAP Supervisory Function */
 120 #define L2CAP_SUPER_RCV_READY           0x0000
 121 #define L2CAP_SUPER_REJECT              0x0004
 122 #define L2CAP_SUPER_RCV_NOT_READY       0x0008
 123 #define L2CAP_SUPER_SELECT_REJECT       0x000C
 124
 125 /* L2CAP Segmentation and Reassembly */
 126 #define L2CAP_SDU_UNSEGMENTED       0x0000
 127 #define L2CAP_SDU_START             0x4000
 128 #define L2CAP_SDU_END               0x8000
 129 #define L2CAP_SDU_CONTINUE          0xC000
 130
 131 /* L2CAP structures */
 132 struct l2cap_hdr {
 133         __le16     len;
 134         __le16     cid;
 135 } __packed;
 136 #define L2CAP_HDR_SIZE          4
 137
 138 struct l2cap_cmd_hdr {
 139         __u8       code;
 140         __u8       ident;
 141         __le16     len;
 142 } __packed;
 143 #define L2CAP_CMD_HDR_SIZE      4
 144
 145 struct l2cap_cmd_rej {
 146         __le16     reason;
 147 } __packed;
 148
 149 struct l2cap_conn_req {
 150         __le16     psm;
 151         __le16     scid;
 152 } __packed;
 153
 154 struct l2cap_conn_rsp {
 155         __le16     dcid;
 156         __le16     scid;
 157         __le16     result;
 158         __le16     status;
 159 } __packed;
 160
 161 /* channel indentifier */
 162 #define L2CAP_CID_SIGNALING     0x0001
 163 #define L2CAP_CID_CONN_LESS     0x0002
 164 #define L2CAP_CID_LE_DATA       0x0004
 165 #define L2CAP_CID_LE_SIGNALING  0x0005
 166 #define L2CAP_CID_SMP           0x0006
 167 #define L2CAP_CID_DYN_START     0x0040
 168 #define L2CAP_CID_DYN_END       0xffff
 169
 170 /* connect result */
 171 #define L2CAP_CR_SUCCESS        0x0000
 172 #define L2CAP_CR_PEND           0x0001
 173 #define L2CAP_CR_BAD_PSM        0x0002
 174 #define L2CAP_CR_SEC_BLOCK      0x0003
 175 #define L2CAP_CR_NO_MEM         0x0004
 176
 177 /* connect status */
 178 #define L2CAP_CS_NO_INFO        0x0000
 179 #define L2CAP_CS_AUTHEN_PEND    0x0001
 180 #define L2CAP_CS_AUTHOR_PEND    0x0002
 181
 182 struct l2cap_conf_req {
 183         __le16     dcid;
 184         __le16     flags;
 185         __u8       data[0];
 186 } __packed;
 187
 188 struct l2cap_conf_rsp {
 189         __le16     scid;
 190         __le16     flags;
 191         __le16     result;
 192         __u8       data[0];
 193 } __packed;
 194
 195 #define L2CAP_CONF_SUCCESS      0x0000
 196 #define L2CAP_CONF_UNACCEPT     0x0001
 197 #define L2CAP_CONF_REJECT       0x0002
 198 #define L2CAP_CONF_UNKNOWN      0x0003
 199
 200 struct l2cap_conf_opt {
 201         __u8       type;
 202         __u8       len;
 203         __u8       val[0];
 204 } __packed;
 205 #define L2CAP_CONF_OPT_SIZE     2
 206
 207 #define L2CAP_CONF_HINT         0x80
 208 #define L2CAP_CONF_MASK         0x7f
 209
 210 #define L2CAP_CONF_MTU          0x01
 211 #define L2CAP_CONF_FLUSH_TO     0x02
 212 #define L2CAP_CONF_QOS          0x03
 213 #define L2CAP_CONF_RFC          0x04
 214 #define L2CAP_CONF_FCS          0x05
 215
 216 #define L2CAP_CONF_MAX_SIZE     22
 217
 218 struct l2cap_conf_rfc {
 219         __u8       mode;
 220         __u8       txwin_size;
 221         __u8       max_transmit;
 222         __le16     retrans_timeout;
 223         __le16     monitor_timeout;
 224         __le16     max_pdu_size;
 225 } __packed;
 226
 227 #define L2CAP_MODE_BASIC        0x00
 228 #define L2CAP_MODE_RETRANS      0x01
 229 #define L2CAP_MODE_FLOWCTL      0x02
 230 #define L2CAP_MODE_ERTM         0x03
 231 #define L2CAP_MODE_STREAMING    0x04
 232
 233 struct l2cap_disconn_req {
 234         __le16     dcid;
 235         __le16     scid;
 236 } __packed;
 237
 238 struct l2cap_disconn_rsp {
 239         __le16     dcid;
 240         __le16     scid;
 241 } __packed;
 242
 243 struct l2cap_info_req {
 244         __le16      type;
 245 } __packed;
 246
 247 struct l2cap_info_rsp {
 248         __le16      type;
 249         __le16      result;
 250         __u8        data[0];
 251 } __packed;
 252
 253 /* info type */
 254 #define L2CAP_IT_CL_MTU     0x0001
 255 #define L2CAP_IT_FEAT_MASK  0x0002
 256 #define L2CAP_IT_FIXED_CHAN 0x0003
 257
 258 /* info result */
 259 #define L2CAP_IR_SUCCESS    0x0000
 260 #define L2CAP_IR_NOTSUPP    0x0001
 261
 262 /* ----- L2CAP connections ----- */
 263 struct l2cap_chan_list {
 264         struct sock     *head;
 265         rwlock_t        lock;
 266         long            num;
 267 };
 268
 269 struct l2cap_conn {
 270         struct hci_conn *hcon;
 271
 272         bdaddr_t        *dst;
 273         bdaddr_t        *src;
 274
 275         unsigned int    mtu;
 276
 277         __u32           feat_mask;
 278
 279         __u8            info_state;
 280         __u8            info_ident;
 281
 282         struct timer_list info_timer;
 283
 284         spinlock_t      lock;
 285
 286         struct sk_buff *rx_skb;
 287         __u32           rx_len;
 288         __u8            rx_ident;
 289         __u8            tx_ident;
 290
 291         __u8            disc_reason;
 292
 293         struct l2cap_chan_list chan_list;
 294 };
 295
 296 struct sock_del_list {
 297         struct sock *sk;
 298         struct list_head list;
 299 };
 300
 301 #define L2CAP_INFO_CL_MTU_REQ_SENT      0x01
 302 #define L2CAP_INFO_FEAT_MASK_REQ_SENT   0x04
 303 #define L2CAP_INFO_FEAT_MASK_REQ_DONE   0x08
 304
 305 /* ----- L2CAP channel and socket info ----- */
 306 #define l2cap_pi(sk) ((struct l2cap_pinfo *) sk)
 307 #define TX_QUEUE(sk) (&l2cap_pi(sk)->tx_queue)
 308 #define SREJ_QUEUE(sk) (&l2cap_pi(sk)->srej_queue)
 309 #define BUSY_QUEUE(sk) (&l2cap_pi(sk)->busy_queue)
 310 #define SREJ_LIST(sk) (&l2cap_pi(sk)->srej_l.list)
 311
 312 struct srej_list {
 313         __u8    tx_seq;
 314         struct list_head list;
 315 };
 316
 317 struct l2cap_pinfo {
 318         struct bt_sock  bt;
 319         __le16          psm;
 320         __u16           dcid;
 321         __u16           scid;
 322
 323         __u16           imtu;
 324         __u16           omtu;
 325         __u16           flush_to;
 326         __u8            mode;
 327         __u8            num_conf_req;
 328         __u8            num_conf_rsp;
 329
 330         __u8            fcs;
 331         __u8            sec_level;
 332         __u8            role_switch;
 333         __u8            force_reliable;
 334         __u8            flushable;
 335
 336         __u8            conf_req[64];
 337         __u8            conf_len;
 338         __u8            conf_state;
 339         __u16           conn_state;
 340
 341         __u8            next_tx_seq;
 342         __u8            expected_ack_seq;
 343         __u8            expected_tx_seq;
 344         __u8            buffer_seq;
 345         __u8            buffer_seq_srej;
 346         __u8            srej_save_reqseq;
 347         __u8            frames_sent;
 348         __u8            unacked_frames;
 349         __u8            retry_count;
 350         __u8            num_acked;
 351         __u16           sdu_len;
 352         __u16           partial_sdu_len;
 353         struct sk_buff  *sdu;
 354
 355         __u8            ident;
 356
 357         __u8            tx_win;
 358         __u8            max_tx;
 359         __u8            remote_tx_win;
 360         __u8            remote_max_tx;
 361         __u16           retrans_timeout;
 362         __u16           monitor_timeout;
 363         __u16           remote_mps;
 364         __u16           mps;
 365
 366         __le16          sport;
 367
 368         struct timer_list       retrans_timer;
 369         struct timer_list       monitor_timer;
 370         struct timer_list       ack_timer;
 371         struct sk_buff_head     tx_queue;
 372         struct sk_buff_head     srej_queue;
 373         struct sk_buff_head     busy_queue;
 374         struct work_struct      busy_work;
 375         struct srej_list        srej_l;
 376         struct l2cap_conn       *conn;
 377         struct sock             *next_c;
 378         struct sock             *prev_c;
 379 };
 380
 381 #define L2CAP_CONF_REQ_SENT       0x01
 382 #define L2CAP_CONF_INPUT_DONE     0x02
 383 #define L2CAP_CONF_OUTPUT_DONE    0x04
 384 #define L2CAP_CONF_MTU_DONE       0x08
 385 #define L2CAP_CONF_MODE_DONE      0x10
 386 #define L2CAP_CONF_CONNECT_PEND   0x20
 387 #define L2CAP_CONF_NO_FCS_RECV    0x40
 388 #define L2CAP_CONF_STATE2_DEVICE  0x80
 389
 390 #define L2CAP_CONF_MAX_CONF_REQ 2
 391 #define L2CAP_CONF_MAX_CONF_RSP 2
 392
 393 #define L2CAP_CONN_SAR_SDU         0x0001
 394 #define L2CAP_CONN_SREJ_SENT       0x0002
 395 #define L2CAP_CONN_WAIT_F          0x0004
 396 #define L2CAP_CONN_SREJ_ACT        0x0008
 397 #define L2CAP_CONN_SEND_PBIT       0x0010
 398 #define L2CAP_CONN_REMOTE_BUSY     0x0020
 399 #define L2CAP_CONN_LOCAL_BUSY      0x0040
 400 #define L2CAP_CONN_REJ_ACT         0x0080
 401 #define L2CAP_CONN_SEND_FBIT       0x0100
 402 #define L2CAP_CONN_RNR_SENT        0x0200
 403 #define L2CAP_CONN_SAR_RETRY       0x0400
 404
 405 #define __mod_retrans_timer() mod_timer(&l2cap_pi(sk)->retrans_timer, \
 406                 jiffies +  msecs_to_jiffies(L2CAP_DEFAULT_RETRANS_TO));
 407 #define __mod_monitor_timer() mod_timer(&l2cap_pi(sk)->monitor_timer, \
 408                 jiffies + msecs_to_jiffies(L2CAP_DEFAULT_MONITOR_TO));
 409 #define __mod_ack_timer() mod_timer(&l2cap_pi(sk)->ack_timer, \
 410                 jiffies + msecs_to_jiffies(L2CAP_DEFAULT_ACK_TO));
 411
 412 static inline int l2cap_tx_window_full(struct sock *sk)
 413 {
 414         struct l2cap_pinfo *pi = l2cap_pi(sk);
 415         int sub;
 416
 417         sub = (pi->next_tx_seq - pi->expected_ack_seq) % 64;
 418
 419         if (sub < 0)
 420                 sub += 64;
 421
 422         return sub == pi->remote_tx_win;
 423 }
 424
 425 #define __get_txseq(ctrl)       (((ctrl) & L2CAP_CTRL_TXSEQ) >> 1)
 426 #define __get_reqseq(ctrl)      (((ctrl) & L2CAP_CTRL_REQSEQ) >> 8)
 427 #define __is_iframe(ctrl)       (!((ctrl) & L2CAP_CTRL_FRAME_TYPE))
 428 #define __is_sframe(ctrl)       ((ctrl) & L2CAP_CTRL_FRAME_TYPE)
 429 #define __is_sar_start(ctrl)    (((ctrl) & L2CAP_CTRL_SAR) == L2CAP_SDU_START)
 430
 431 extern int disable_ertm;
 432 extern const struct proto_ops l2cap_sock_ops;
 433 extern struct bt_sock_list l2cap_sk_list;
 434
 435 int l2cap_init_sockets(void);
 436 void l2cap_cleanup_sockets(void);
 437
 438 u8 l2cap_get_ident(struct l2cap_conn *conn);
 439 void l2cap_send_cmd(struct l2cap_conn *conn, u8 ident, u8 code, u16 len, void *data);
 440 int l2cap_build_conf_req(struct sock *sk, void *data);
 441 int __l2cap_wait_ack(struct sock *sk);
 442
 443 struct sk_buff *l2cap_create_connless_pdu(struct sock *sk, struct msghdr *msg, size_t len);
 444 struct sk_buff *l2cap_create_basic_pdu(struct sock *sk, struct msghdr *msg, size_t len);
 445 struct sk_buff *l2cap_create_iframe_pdu(struct sock *sk, struct msghdr *msg, size_t len, u16 control, u16 sdulen);
 446 int l2cap_sar_segment_sdu(struct sock *sk, struct msghdr *msg, size_t len);
 447 void l2cap_do_send(struct sock *sk, struct sk_buff *skb);
 448 void l2cap_streaming_send(struct sock *sk);
 449 int l2cap_ertm_send(struct sock *sk);
 450
 451 void l2cap_sock_set_timer(struct sock *sk, long timeout);
 452 void l2cap_sock_clear_timer(struct sock *sk);
 453 void __l2cap_sock_close(struct sock *sk, int reason);
 454 void l2cap_sock_kill(struct sock *sk);
 455 void l2cap_sock_init(struct sock *sk, struct sock *parent);
 456 struct sock *l2cap_sock_alloc(struct net *net, struct socket *sock,
 457                                                         int proto, gfp_t prio);
 458 void l2cap_send_disconn_req(struct l2cap_conn *conn, struct sock *sk, int err);
 459 void l2cap_chan_del(struct sock *sk, int err);
 460 int l2cap_do_connect(struct sock *sk);
 461
 462 #endif /* __L2CAP_H */