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