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