Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
l2cap.h
Go to the documentation of this file.
1 /*
2  BlueZ - Bluetooth protocol stack for Linux
3  Copyright (C) 2000-2001 Qualcomm Incorporated
4  Copyright (C) 2009-2010 Gustavo F. Padovan <[email protected]>
5  Copyright (C) 2010 Google Inc.
6 
7  Written 2000,2001 by Maxim Krasnyansky <[email protected]>
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 #include <asm/unaligned.h>
31 
32 /* L2CAP defaults */
33 #define L2CAP_DEFAULT_MTU 672
34 #define L2CAP_DEFAULT_MIN_MTU 48
35 #define L2CAP_DEFAULT_FLUSH_TO 0xffff
36 #define L2CAP_DEFAULT_TX_WINDOW 63
37 #define L2CAP_DEFAULT_EXT_WINDOW 0x3FFF
38 #define L2CAP_DEFAULT_MAX_TX 3
39 #define L2CAP_DEFAULT_RETRANS_TO 2000 /* 2 seconds */
40 #define L2CAP_DEFAULT_MONITOR_TO 12000 /* 12 seconds */
41 #define L2CAP_DEFAULT_MAX_PDU_SIZE 1009 /* Sized for 3-DH5 packet */
42 #define L2CAP_DEFAULT_ACK_TO 200
43 #define L2CAP_DEFAULT_MAX_SDU_SIZE 0xFFFF
44 #define L2CAP_DEFAULT_SDU_ITIME 0xFFFFFFFF
45 #define L2CAP_DEFAULT_ACC_LAT 0xFFFFFFFF
46 #define L2CAP_BREDR_MAX_PAYLOAD 1019 /* 3-DH5 packet */
47 #define L2CAP_LE_MIN_MTU 23
48 
49 #define L2CAP_DISC_TIMEOUT msecs_to_jiffies(100)
50 #define L2CAP_DISC_REJ_TIMEOUT msecs_to_jiffies(5000)
51 #define L2CAP_ENC_TIMEOUT msecs_to_jiffies(5000)
52 #define L2CAP_CONN_TIMEOUT msecs_to_jiffies(40000)
53 #define L2CAP_INFO_TIMEOUT msecs_to_jiffies(4000)
54 
55 #define L2CAP_A2MP_DEFAULT_MTU 670
56 
57 /* L2CAP socket address */
58 struct sockaddr_l2 {
61  bdaddr_t l2_bdaddr;
64 };
65 
66 /* L2CAP socket options */
67 #define L2CAP_OPTIONS 0x01
68 struct l2cap_options {
76 };
77 
78 #define L2CAP_CONNINFO 0x02
82 };
83 
84 #define L2CAP_LM 0x03
85 #define L2CAP_LM_MASTER 0x0001
86 #define L2CAP_LM_AUTH 0x0002
87 #define L2CAP_LM_ENCRYPT 0x0004
88 #define L2CAP_LM_TRUSTED 0x0008
89 #define L2CAP_LM_RELIABLE 0x0010
90 #define L2CAP_LM_SECURE 0x0020
91 
92 /* L2CAP command codes */
93 #define L2CAP_COMMAND_REJ 0x01
94 #define L2CAP_CONN_REQ 0x02
95 #define L2CAP_CONN_RSP 0x03
96 #define L2CAP_CONF_REQ 0x04
97 #define L2CAP_CONF_RSP 0x05
98 #define L2CAP_DISCONN_REQ 0x06
99 #define L2CAP_DISCONN_RSP 0x07
100 #define L2CAP_ECHO_REQ 0x08
101 #define L2CAP_ECHO_RSP 0x09
102 #define L2CAP_INFO_REQ 0x0a
103 #define L2CAP_INFO_RSP 0x0b
104 #define L2CAP_CREATE_CHAN_REQ 0x0c
105 #define L2CAP_CREATE_CHAN_RSP 0x0d
106 #define L2CAP_MOVE_CHAN_REQ 0x0e
107 #define L2CAP_MOVE_CHAN_RSP 0x0f
108 #define L2CAP_MOVE_CHAN_CFM 0x10
109 #define L2CAP_MOVE_CHAN_CFM_RSP 0x11
110 #define L2CAP_CONN_PARAM_UPDATE_REQ 0x12
111 #define L2CAP_CONN_PARAM_UPDATE_RSP 0x13
112 
113 /* L2CAP extended feature mask */
114 #define L2CAP_FEAT_FLOWCTL 0x00000001
115 #define L2CAP_FEAT_RETRANS 0x00000002
116 #define L2CAP_FEAT_BIDIR_QOS 0x00000004
117 #define L2CAP_FEAT_ERTM 0x00000008
118 #define L2CAP_FEAT_STREAMING 0x00000010
119 #define L2CAP_FEAT_FCS 0x00000020
120 #define L2CAP_FEAT_EXT_FLOW 0x00000040
121 #define L2CAP_FEAT_FIXED_CHAN 0x00000080
122 #define L2CAP_FEAT_EXT_WINDOW 0x00000100
123 #define L2CAP_FEAT_UCD 0x00000200
124 
125 /* L2CAP checksum option */
126 #define L2CAP_FCS_NONE 0x00
127 #define L2CAP_FCS_CRC16 0x01
128 
129 /* L2CAP fixed channels */
130 #define L2CAP_FC_L2CAP 0x02
131 #define L2CAP_FC_A2MP 0x08
132 
133 /* L2CAP Control Field bit masks */
134 #define L2CAP_CTRL_SAR 0xC000
135 #define L2CAP_CTRL_REQSEQ 0x3F00
136 #define L2CAP_CTRL_TXSEQ 0x007E
137 #define L2CAP_CTRL_SUPERVISE 0x000C
138 
139 #define L2CAP_CTRL_RETRANS 0x0080
140 #define L2CAP_CTRL_FINAL 0x0080
141 #define L2CAP_CTRL_POLL 0x0010
142 #define L2CAP_CTRL_FRAME_TYPE 0x0001 /* I- or S-Frame */
143 
144 #define L2CAP_CTRL_TXSEQ_SHIFT 1
145 #define L2CAP_CTRL_SUPER_SHIFT 2
146 #define L2CAP_CTRL_POLL_SHIFT 4
147 #define L2CAP_CTRL_FINAL_SHIFT 7
148 #define L2CAP_CTRL_REQSEQ_SHIFT 8
149 #define L2CAP_CTRL_SAR_SHIFT 14
150 
151 /* L2CAP Extended Control Field bit mask */
152 #define L2CAP_EXT_CTRL_TXSEQ 0xFFFC0000
153 #define L2CAP_EXT_CTRL_SAR 0x00030000
154 #define L2CAP_EXT_CTRL_SUPERVISE 0x00030000
155 #define L2CAP_EXT_CTRL_REQSEQ 0x0000FFFC
156 
157 #define L2CAP_EXT_CTRL_POLL 0x00040000
158 #define L2CAP_EXT_CTRL_FINAL 0x00000002
159 #define L2CAP_EXT_CTRL_FRAME_TYPE 0x00000001 /* I- or S-Frame */
160 
161 #define L2CAP_EXT_CTRL_FINAL_SHIFT 1
162 #define L2CAP_EXT_CTRL_REQSEQ_SHIFT 2
163 #define L2CAP_EXT_CTRL_SAR_SHIFT 16
164 #define L2CAP_EXT_CTRL_SUPER_SHIFT 16
165 #define L2CAP_EXT_CTRL_POLL_SHIFT 18
166 #define L2CAP_EXT_CTRL_TXSEQ_SHIFT 18
167 
168 /* L2CAP Supervisory Function */
169 #define L2CAP_SUPER_RR 0x00
170 #define L2CAP_SUPER_REJ 0x01
171 #define L2CAP_SUPER_RNR 0x02
172 #define L2CAP_SUPER_SREJ 0x03
173 
174 /* L2CAP Segmentation and Reassembly */
175 #define L2CAP_SAR_UNSEGMENTED 0x00
176 #define L2CAP_SAR_START 0x01
177 #define L2CAP_SAR_END 0x02
178 #define L2CAP_SAR_CONTINUE 0x03
179 
180 /* L2CAP Command rej. reasons */
181 #define L2CAP_REJ_NOT_UNDERSTOOD 0x0000
182 #define L2CAP_REJ_MTU_EXCEEDED 0x0001
183 #define L2CAP_REJ_INVALID_CID 0x0002
184 
185 /* L2CAP structures */
186 struct l2cap_hdr {
189 } __packed;
190 #define L2CAP_HDR_SIZE 4
191 #define L2CAP_ENH_HDR_SIZE 6
192 #define L2CAP_EXT_HDR_SIZE 8
193 
194 #define L2CAP_FCS_SIZE 2
195 #define L2CAP_SDULEN_SIZE 2
196 #define L2CAP_PSMLEN_SIZE 2
197 #define L2CAP_ENH_CTRL_SIZE 2
198 #define L2CAP_EXT_CTRL_SIZE 4
199 
204 } __packed;
205 #define L2CAP_CMD_HDR_SIZE 4
206 
209 } __packed;
210 
214 } __packed;
215 
220 } __packed;
221 
225 } __packed;
226 
232 } __packed;
233 
234 /* protocol/service multiplexer (PSM) */
235 #define L2CAP_PSM_SDP 0x0001
236 #define L2CAP_PSM_RFCOMM 0x0003
237 
238 /* channel indentifier */
239 #define L2CAP_CID_SIGNALING 0x0001
240 #define L2CAP_CID_CONN_LESS 0x0002
241 #define L2CAP_CID_A2MP 0x0003
242 #define L2CAP_CID_LE_DATA 0x0004
243 #define L2CAP_CID_LE_SIGNALING 0x0005
244 #define L2CAP_CID_SMP 0x0006
245 #define L2CAP_CID_DYN_START 0x0040
246 #define L2CAP_CID_DYN_END 0xffff
247 
248 /* connect/create channel results */
249 #define L2CAP_CR_SUCCESS 0x0000
250 #define L2CAP_CR_PEND 0x0001
251 #define L2CAP_CR_BAD_PSM 0x0002
252 #define L2CAP_CR_SEC_BLOCK 0x0003
253 #define L2CAP_CR_NO_MEM 0x0004
254 #define L2CAP_CR_BAD_AMP 0x0005
255 
256 /* connect/create channel status */
257 #define L2CAP_CS_NO_INFO 0x0000
258 #define L2CAP_CS_AUTHEN_PEND 0x0001
259 #define L2CAP_CS_AUTHOR_PEND 0x0002
260 
264  __u8 data[0];
265 } __packed;
266 
271  __u8 data[0];
272 } __packed;
273 
274 #define L2CAP_CONF_SUCCESS 0x0000
275 #define L2CAP_CONF_UNACCEPT 0x0001
276 #define L2CAP_CONF_REJECT 0x0002
277 #define L2CAP_CONF_UNKNOWN 0x0003
278 #define L2CAP_CONF_PENDING 0x0004
279 #define L2CAP_CONF_EFS_REJECT 0x0005
280 
281 /* configuration req/rsp continuation flag */
282 #define L2CAP_CONF_FLAG_CONTINUATION 0x0001
283 
287  __u8 val[0];
288 } __packed;
289 #define L2CAP_CONF_OPT_SIZE 2
290 
291 #define L2CAP_CONF_HINT 0x80
292 #define L2CAP_CONF_MASK 0x7f
293 
294 #define L2CAP_CONF_MTU 0x01
295 #define L2CAP_CONF_FLUSH_TO 0x02
296 #define L2CAP_CONF_QOS 0x03
297 #define L2CAP_CONF_RFC 0x04
298 #define L2CAP_CONF_FCS 0x05
299 #define L2CAP_CONF_EFS 0x06
300 #define L2CAP_CONF_EWS 0x07
301 
302 #define L2CAP_CONF_MAX_SIZE 22
303 
311 } __packed;
312 
313 #define L2CAP_MODE_BASIC 0x00
314 #define L2CAP_MODE_RETRANS 0x01
315 #define L2CAP_MODE_FLOWCTL 0x02
316 #define L2CAP_MODE_ERTM 0x03
317 #define L2CAP_MODE_STREAMING 0x04
318 
326 } __packed;
327 
328 #define L2CAP_SERV_NOTRAFIC 0x00
329 #define L2CAP_SERV_BESTEFFORT 0x01
330 #define L2CAP_SERV_GUARANTEED 0x02
331 
332 #define L2CAP_BESTEFFORT_ID 0x01
333 
337 } __packed;
338 
342 } __packed;
343 
346 } __packed;
347 
351  __u8 data[0];
352 } __packed;
353 
358 } __packed;
359 
365 } __packed;
366 
370 } __packed;
371 
375 } __packed;
376 
377 #define L2CAP_MR_SUCCESS 0x0000
378 #define L2CAP_MR_PEND 0x0001
379 #define L2CAP_MR_BAD_ID 0x0002
380 #define L2CAP_MR_SAME_ID 0x0003
381 #define L2CAP_MR_NOT_SUPP 0x0004
382 #define L2CAP_MR_COLLISION 0x0005
383 #define L2CAP_MR_NOT_ALLOWED 0x0006
384 
388 } __packed;
389 
390 #define L2CAP_MC_CONFIRMED 0x0000
391 #define L2CAP_MC_UNCONFIRMED 0x0001
392 
395 } __packed;
396 
397 /* info type */
398 #define L2CAP_IT_CL_MTU 0x0001
399 #define L2CAP_IT_FEAT_MASK 0x0002
400 #define L2CAP_IT_FIXED_CHAN 0x0003
401 
402 /* info result */
403 #define L2CAP_IR_SUCCESS 0x0000
404 #define L2CAP_IR_NOTSUPP 0x0001
405 
411 } __packed;
412 
415 } __packed;
416 
417 /* Connection Parameters result */
418 #define L2CAP_CONN_PARAM_ACCEPTED 0x0000
419 #define L2CAP_CONN_PARAM_REJECTED 0x0001
420 
421 /* ----- L2CAP channels and connections ----- */
427 };
428 
429 #define L2CAP_SEQ_LIST_CLEAR 0xFFFF
430 #define L2CAP_SEQ_LIST_TAIL 0x8000
431 
432 struct l2cap_chan {
433  struct sock *sk;
434 
435  struct l2cap_conn *conn;
436  struct kref kref;
437 
439 
443 
450 
452 
454 
456 
461 
463 
471 
474 
475  unsigned long conf_state;
476  unsigned long conn_state;
477  unsigned long flags;
478 
490  struct sk_buff *sdu;
492 
496 
503 
510 
515 
521 
522  struct list_head list;
524 
525  void *data;
526  struct l2cap_ops *ops;
527  struct mutex lock;
528 };
529 
530 struct l2cap_ops {
531  char *name;
532 
533  struct l2cap_chan *(*new_connection) (struct l2cap_chan *chan);
534  int (*recv) (struct l2cap_chan * chan,
535  struct sk_buff *skb);
536  void (*teardown) (struct l2cap_chan *chan, int err);
537  void (*close) (struct l2cap_chan *chan);
539  int state);
540  void (*ready) (struct l2cap_chan *chan);
541  struct sk_buff *(*alloc_skb) (struct l2cap_chan *chan,
542  unsigned long len, int nb);
543 };
544 
545 struct l2cap_conn {
546  struct hci_conn *hcon;
547  struct hci_chan *hchan;
548 
549  bdaddr_t *dst;
550  bdaddr_t *src;
551 
552  unsigned int mtu;
553 
556 
559 
561 
563 
564  struct sk_buff *rx_skb;
567 
569 
572 
574  struct mutex chan_lock;
575 };
576 
577 #define L2CAP_INFO_CL_MTU_REQ_SENT 0x01
578 #define L2CAP_INFO_FEAT_MASK_REQ_SENT 0x04
579 #define L2CAP_INFO_FEAT_MASK_REQ_DONE 0x08
580 
581 #define L2CAP_CHAN_RAW 1
582 #define L2CAP_CHAN_CONN_LESS 2
583 #define L2CAP_CHAN_CONN_ORIENTED 3
584 #define L2CAP_CHAN_CONN_FIX_A2MP 4
585 
586 /* ----- L2CAP socket info ----- */
587 #define l2cap_pi(sk) ((struct l2cap_pinfo *) sk)
588 
589 struct l2cap_pinfo {
590  struct bt_sock bt;
591  struct l2cap_chan *chan;
593 };
594 
595 enum {
608 };
609 
610 #define L2CAP_CONF_MAX_CONF_REQ 2
611 #define L2CAP_CONF_MAX_CONF_RSP 2
612 
613 enum {
623 };
624 
625 /* Definitions for flags in l2cap_chan */
626 enum {
633 };
634 
635 enum {
638 };
639 
640 enum {
643 };
644 
645 enum {
654 };
655 
656 enum {
671 };
672 
673 void l2cap_chan_hold(struct l2cap_chan *c);
674 void l2cap_chan_put(struct l2cap_chan *c);
675 
676 static inline void l2cap_chan_lock(struct l2cap_chan *chan)
677 {
678  mutex_lock(&chan->lock);
679 }
680 
681 static inline void l2cap_chan_unlock(struct l2cap_chan *chan)
682 {
683  mutex_unlock(&chan->lock);
684 }
685 
686 static inline void l2cap_set_timer(struct l2cap_chan *chan,
687  struct delayed_work *work, long timeout)
688 {
689  BT_DBG("chan %p state %s timeout %ld", chan,
690  state_to_string(chan->state), timeout);
691 
692  /* If delayed work cancelled do not hold(chan)
693  since it is already done with previous set_timer */
694  if (!cancel_delayed_work(work))
695  l2cap_chan_hold(chan);
696 
697  schedule_delayed_work(work, timeout);
698 }
699 
700 static inline bool l2cap_clear_timer(struct l2cap_chan *chan,
701  struct delayed_work *work)
702 {
703  bool ret;
704 
705  /* put(chan) if delayed work cancelled otherwise it
706  is done in delayed work function */
707  ret = cancel_delayed_work(work);
708  if (ret)
709  l2cap_chan_put(chan);
710 
711  return ret;
712 }
713 
714 #define __set_chan_timer(c, t) l2cap_set_timer(c, &c->chan_timer, (t))
715 #define __clear_chan_timer(c) l2cap_clear_timer(c, &c->chan_timer)
716 #define __clear_retrans_timer(c) l2cap_clear_timer(c, &c->retrans_timer)
717 #define __clear_monitor_timer(c) l2cap_clear_timer(c, &c->monitor_timer)
718 #define __set_ack_timer(c) l2cap_set_timer(c, &chan->ack_timer, \
719  msecs_to_jiffies(L2CAP_DEFAULT_ACK_TO));
720 #define __clear_ack_timer(c) l2cap_clear_timer(c, &c->ack_timer)
721 
722 static inline int __seq_offset(struct l2cap_chan *chan, __u16 seq1, __u16 seq2)
723 {
724  if (seq1 >= seq2)
725  return seq1 - seq2;
726  else
727  return chan->tx_win_max + 1 - seq2 + seq1;
728 }
729 
730 static inline __u16 __next_seq(struct l2cap_chan *chan, __u16 seq)
731 {
732  return (seq + 1) % (chan->tx_win_max + 1);
733 }
734 
735 static inline struct l2cap_chan *l2cap_chan_no_new_connection(struct l2cap_chan *chan)
736 {
737  return NULL;
738 }
739 
740 static inline void l2cap_chan_no_teardown(struct l2cap_chan *chan, int err)
741 {
742 }
743 
744 static inline void l2cap_chan_no_ready(struct l2cap_chan *chan)
745 {
746 }
747 
748 extern bool disable_ertm;
749 
750 int l2cap_init_sockets(void);
751 void l2cap_cleanup_sockets(void);
752 
753 void __l2cap_connect_rsp_defer(struct l2cap_chan *chan);
754 int __l2cap_wait_ack(struct sock *sk);
755 
756 int l2cap_add_psm(struct l2cap_chan *chan, bdaddr_t *src, __le16 psm);
757 int l2cap_add_scid(struct l2cap_chan *chan, __u16 scid);
758 
759 struct l2cap_chan *l2cap_chan_create(void);
760 void l2cap_chan_close(struct l2cap_chan *chan, int reason);
761 int l2cap_chan_connect(struct l2cap_chan *chan, __le16 psm, u16 cid,
762  bdaddr_t *dst, u8 dst_type);
763 int l2cap_chan_send(struct l2cap_chan *chan, struct msghdr *msg, size_t len,
764  u32 priority);
765 void l2cap_chan_busy(struct l2cap_chan *chan, int busy);
766 int l2cap_chan_check_security(struct l2cap_chan *chan);
767 void l2cap_chan_set_defaults(struct l2cap_chan *chan);
768 int l2cap_ertm_init(struct l2cap_chan *chan);
769 void l2cap_chan_add(struct l2cap_conn *conn, struct l2cap_chan *chan);
770 void l2cap_chan_del(struct l2cap_chan *chan, int err);
771 
772 #endif /* __L2CAP_H */