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