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