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