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