]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/net/bluetooth/l2cap.h
Bluetooth: Add state tracking to struct l2cap_chan
[mirror_ubuntu-jammy-kernel.git] / include / net / bluetooth / l2cap.h
CommitLineData
be21871f 1/*
1da177e4
LT
2 BlueZ - Bluetooth protocol stack for Linux
3 Copyright (C) 2000-2001 Qualcomm Incorporated
ce5706bd 4 Copyright (C) 2009-2010 Gustavo F. Padovan <gustavo@padovan.org>
5d8868ff 5 Copyright (C) 2010 Google Inc.
1da177e4
LT
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
be21871f
AE
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
1da177e4
LT
20 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21
be21871f
AE
22 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
23 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
1da177e4
LT
24 SOFTWARE IS DISCLAIMED.
25*/
26
27#ifndef __L2CAP_H
28#define __L2CAP_H
29
30/* L2CAP defaults */
47ec1dcd 31#define L2CAP_DEFAULT_MTU 672
f2fcfcd6 32#define L2CAP_DEFAULT_MIN_MTU 48
47ec1dcd 33#define L2CAP_DEFAULT_FLUSH_TO 0xffff
1c2acffb 34#define L2CAP_DEFAULT_TX_WINDOW 63
e90bac06 35#define L2CAP_DEFAULT_MAX_TX 3
fa235562 36#define L2CAP_DEFAULT_RETRANS_TO 2000 /* 2 seconds */
e90bac06 37#define L2CAP_DEFAULT_MONITOR_TO 12000 /* 12 seconds */
db12d647 38#define L2CAP_DEFAULT_MAX_PDU_SIZE 1009 /* Sized for 3-DH5 packet */
c1b4f43b 39#define L2CAP_DEFAULT_ACK_TO 200
1890d36b 40#define L2CAP_LOCAL_BUSY_TRIES 12
b62f328b 41#define L2CAP_LE_DEFAULT_MTU 23
1da177e4 42
4e8402a3
MH
43#define L2CAP_CONN_TIMEOUT (40000) /* 40 seconds */
44#define L2CAP_INFO_TIMEOUT (4000) /* 4 seconds */
1da177e4
LT
45
46/* L2CAP socket address */
47struct sockaddr_l2 {
48 sa_family_t l2_family;
8e036fc3 49 __le16 l2_psm;
1da177e4 50 bdaddr_t l2_bdaddr;
f29972de 51 __le16 l2_cid;
1da177e4
LT
52};
53
54/* L2CAP socket options */
55#define L2CAP_OPTIONS 0x01
56struct l2cap_options {
57 __u16 omtu;
58 __u16 imtu;
59 __u16 flush_to;
60 __u8 mode;
fcc203c3 61 __u8 fcs;
68d7f0ce 62 __u8 max_tx;
14b5aa71 63 __u16 txwin_size;
1da177e4
LT
64};
65
66#define L2CAP_CONNINFO 0x02
67struct l2cap_conninfo {
68 __u16 hci_handle;
69 __u8 dev_class[3];
70};
71
72#define L2CAP_LM 0x03
73#define L2CAP_LM_MASTER 0x0001
74#define L2CAP_LM_AUTH 0x0002
75#define L2CAP_LM_ENCRYPT 0x0004
76#define L2CAP_LM_TRUSTED 0x0008
77#define L2CAP_LM_RELIABLE 0x0010
78#define L2CAP_LM_SECURE 0x0020
79
80/* L2CAP command codes */
47ec1dcd
MH
81#define L2CAP_COMMAND_REJ 0x01
82#define L2CAP_CONN_REQ 0x02
83#define L2CAP_CONN_RSP 0x03
84#define L2CAP_CONF_REQ 0x04
85#define L2CAP_CONF_RSP 0x05
86#define L2CAP_DISCONN_REQ 0x06
87#define L2CAP_DISCONN_RSP 0x07
88#define L2CAP_ECHO_REQ 0x08
89#define L2CAP_ECHO_RSP 0x09
90#define L2CAP_INFO_REQ 0x0a
91#define L2CAP_INFO_RSP 0x0b
3300d9a9
CT
92#define L2CAP_CONN_PARAM_UPDATE_REQ 0x12
93#define L2CAP_CONN_PARAM_UPDATE_RSP 0x13
47ec1dcd
MH
94
95/* L2CAP feature mask */
96#define L2CAP_FEAT_FLOWCTL 0x00000001
97#define L2CAP_FEAT_RETRANS 0x00000002
98#define L2CAP_FEAT_ERTM 0x00000008
99#define L2CAP_FEAT_STREAMING 0x00000010
100#define L2CAP_FEAT_FCS 0x00000020
101#define L2CAP_FEAT_FIXED_CHAN 0x00000080
102
103/* L2CAP checksum option */
104#define L2CAP_FCS_NONE 0x00
105#define L2CAP_FCS_CRC16 0x01
1da177e4 106
1c2acffb
GP
107/* L2CAP Control Field bit masks */
108#define L2CAP_CTRL_SAR 0xC000
109#define L2CAP_CTRL_REQSEQ 0x3F00
110#define L2CAP_CTRL_TXSEQ 0x007E
111#define L2CAP_CTRL_RETRANS 0x0080
112#define L2CAP_CTRL_FINAL 0x0080
113#define L2CAP_CTRL_POLL 0x0010
114#define L2CAP_CTRL_SUPERVISE 0x000C
115#define L2CAP_CTRL_FRAME_TYPE 0x0001 /* I- or S-Frame */
116
117#define L2CAP_CTRL_TXSEQ_SHIFT 1
118#define L2CAP_CTRL_REQSEQ_SHIFT 8
8f17154f 119#define L2CAP_CTRL_SAR_SHIFT 14
1c2acffb
GP
120
121/* L2CAP Supervisory Function */
122#define L2CAP_SUPER_RCV_READY 0x0000
123#define L2CAP_SUPER_REJECT 0x0004
124#define L2CAP_SUPER_RCV_NOT_READY 0x0008
125#define L2CAP_SUPER_SELECT_REJECT 0x000C
126
127/* L2CAP Segmentation and Reassembly */
128#define L2CAP_SDU_UNSEGMENTED 0x0000
129#define L2CAP_SDU_START 0x4000
130#define L2CAP_SDU_END 0x8000
131#define L2CAP_SDU_CONTINUE 0xC000
132
1da177e4
LT
133/* L2CAP structures */
134struct l2cap_hdr {
8e036fc3
AV
135 __le16 len;
136 __le16 cid;
66c853cc 137} __packed;
1da177e4
LT
138#define L2CAP_HDR_SIZE 4
139
140struct l2cap_cmd_hdr {
141 __u8 code;
142 __u8 ident;
8e036fc3 143 __le16 len;
66c853cc 144} __packed;
1da177e4
LT
145#define L2CAP_CMD_HDR_SIZE 4
146
147struct l2cap_cmd_rej {
8e036fc3 148 __le16 reason;
66c853cc 149} __packed;
1da177e4
LT
150
151struct l2cap_conn_req {
8e036fc3
AV
152 __le16 psm;
153 __le16 scid;
66c853cc 154} __packed;
1da177e4
LT
155
156struct l2cap_conn_rsp {
8e036fc3
AV
157 __le16 dcid;
158 __le16 scid;
159 __le16 result;
160 __le16 status;
66c853cc 161} __packed;
1da177e4 162
8db4dc46
GP
163/* channel indentifier */
164#define L2CAP_CID_SIGNALING 0x0001
165#define L2CAP_CID_CONN_LESS 0x0002
acd7d370
VT
166#define L2CAP_CID_LE_DATA 0x0004
167#define L2CAP_CID_LE_SIGNALING 0x0005
168#define L2CAP_CID_SMP 0x0006
8db4dc46
GP
169#define L2CAP_CID_DYN_START 0x0040
170#define L2CAP_CID_DYN_END 0xffff
171
1da177e4 172/* connect result */
47ec1dcd
MH
173#define L2CAP_CR_SUCCESS 0x0000
174#define L2CAP_CR_PEND 0x0001
175#define L2CAP_CR_BAD_PSM 0x0002
176#define L2CAP_CR_SEC_BLOCK 0x0003
177#define L2CAP_CR_NO_MEM 0x0004
1da177e4
LT
178
179/* connect status */
47ec1dcd
MH
180#define L2CAP_CS_NO_INFO 0x0000
181#define L2CAP_CS_AUTHEN_PEND 0x0001
182#define L2CAP_CS_AUTHOR_PEND 0x0002
1da177e4
LT
183
184struct l2cap_conf_req {
8e036fc3
AV
185 __le16 dcid;
186 __le16 flags;
1da177e4 187 __u8 data[0];
66c853cc 188} __packed;
1da177e4
LT
189
190struct l2cap_conf_rsp {
8e036fc3
AV
191 __le16 scid;
192 __le16 flags;
193 __le16 result;
1da177e4 194 __u8 data[0];
66c853cc 195} __packed;
1da177e4 196
5dee9e7c
MH
197#define L2CAP_CONF_SUCCESS 0x0000
198#define L2CAP_CONF_UNACCEPT 0x0001
199#define L2CAP_CONF_REJECT 0x0002
200#define L2CAP_CONF_UNKNOWN 0x0003
1da177e4
LT
201
202struct l2cap_conf_opt {
203 __u8 type;
204 __u8 len;
205 __u8 val[0];
66c853cc 206} __packed;
1da177e4
LT
207#define L2CAP_CONF_OPT_SIZE 2
208
589d2746 209#define L2CAP_CONF_HINT 0x80
47ec1dcd 210#define L2CAP_CONF_MASK 0x7f
589d2746 211
1da177e4
LT
212#define L2CAP_CONF_MTU 0x01
213#define L2CAP_CONF_FLUSH_TO 0x02
214#define L2CAP_CONF_QOS 0x03
215#define L2CAP_CONF_RFC 0x04
47ec1dcd 216#define L2CAP_CONF_FCS 0x05
1da177e4
LT
217
218#define L2CAP_CONF_MAX_SIZE 22
219
6464f35f
MH
220struct l2cap_conf_rfc {
221 __u8 mode;
222 __u8 txwin_size;
223 __u8 max_transmit;
224 __le16 retrans_timeout;
225 __le16 monitor_timeout;
226 __le16 max_pdu_size;
66c853cc 227} __packed;
6464f35f
MH
228
229#define L2CAP_MODE_BASIC 0x00
230#define L2CAP_MODE_RETRANS 0x01
231#define L2CAP_MODE_FLOWCTL 0x02
47ec1dcd 232#define L2CAP_MODE_ERTM 0x03
c6b03cf9 233#define L2CAP_MODE_STREAMING 0x04
6464f35f 234
1da177e4 235struct l2cap_disconn_req {
8e036fc3
AV
236 __le16 dcid;
237 __le16 scid;
66c853cc 238} __packed;
1da177e4
LT
239
240struct l2cap_disconn_rsp {
8e036fc3
AV
241 __le16 dcid;
242 __le16 scid;
66c853cc 243} __packed;
1da177e4
LT
244
245struct l2cap_info_req {
8e036fc3 246 __le16 type;
66c853cc 247} __packed;
1da177e4
LT
248
249struct l2cap_info_rsp {
8e036fc3
AV
250 __le16 type;
251 __le16 result;
1da177e4 252 __u8 data[0];
66c853cc 253} __packed;
1da177e4
LT
254
255/* info type */
256#define L2CAP_IT_CL_MTU 0x0001
257#define L2CAP_IT_FEAT_MASK 0x0002
e1027a7c 258#define L2CAP_IT_FIXED_CHAN 0x0003
1da177e4
LT
259
260/* info result */
261#define L2CAP_IR_SUCCESS 0x0000
262#define L2CAP_IR_NOTSUPP 0x0001
263
de73115a
CT
264struct l2cap_conn_param_update_req {
265 __le16 min;
266 __le16 max;
267 __le16 latency;
268 __le16 to_multiplier;
269} __packed;
270
271struct l2cap_conn_param_update_rsp {
272 __le16 result;
273} __packed;
274
275/* Connection Parameters result */
276#define L2CAP_CONN_PARAM_ACCEPTED 0x0000
277#define L2CAP_CONN_PARAM_REJECTED 0x0001
278
48454079 279/* ----- L2CAP channels and connections ----- */
39d5a3ee
GP
280struct srej_list {
281 __u8 tx_seq;
282 struct list_head list;
283};
284
48454079
GP
285struct l2cap_chan {
286 struct sock *sk;
8c1d787b
GP
287
288 struct l2cap_conn *conn;
289
89bc500e
GP
290 __u8 state;
291
fe4128e0
GP
292 __le16 psm;
293 __u16 dcid;
294 __u16 scid;
4343478f 295
0c1bc5c6
GP
296 __u16 imtu;
297 __u16 omtu;
298 __u16 flush_to;
299 __u8 mode;
715ec005 300 __u8 chan_type;
0c1bc5c6
GP
301
302 __le16 sport;
303
4343478f
GP
304 __u8 sec_level;
305 __u8 role_switch;
306 __u8 force_reliable;
307 __u8 flushable;
14b12d0b 308 __u8 force_active;
4343478f 309
fc7f8a7e
GP
310 __u8 ident;
311
73ffa904
GP
312 __u8 conf_req[64];
313 __u8 conf_len;
314 __u8 num_conf_req;
315 __u8 num_conf_rsp;
316
47d1ec61
GP
317 __u8 fcs;
318
319 __u8 tx_win;
320 __u8 max_tx;
321 __u16 retrans_timeout;
322 __u16 monitor_timeout;
323 __u16 mps;
324
b4450035 325 __u8 conf_state;
525cd185
GP
326 __u16 conn_state;
327
42e5c802
GP
328 __u8 next_tx_seq;
329 __u8 expected_ack_seq;
330 __u8 expected_tx_seq;
331 __u8 buffer_seq;
332 __u8 buffer_seq_srej;
6a026610
GP
333 __u8 srej_save_reqseq;
334 __u8 frames_sent;
335 __u8 unacked_frames;
336 __u8 retry_count;
337 __u8 num_acked;
6f61fd47
GP
338 __u16 sdu_len;
339 __u16 partial_sdu_len;
340 struct sk_buff *sdu;
341
2c03a7a4
GP
342 __u8 remote_tx_win;
343 __u8 remote_max_tx;
344 __u16 remote_mps;
42e5c802 345
ab07801d 346 struct timer_list chan_timer;
e92c8e70
GP
347 struct timer_list retrans_timer;
348 struct timer_list monitor_timer;
349 struct timer_list ack_timer;
58d35f87
GP
350 struct sk_buff *tx_send_head;
351 struct sk_buff_head tx_q;
f1c6775b
GP
352 struct sk_buff_head srej_q;
353 struct sk_buff_head busy_q;
311bb895 354 struct work_struct busy_work;
39d5a3ee 355 struct list_head srej_l;
e92c8e70 356
baa7e1fa 357 struct list_head list;
23691d75 358 struct list_head global_l;
80808e43
GP
359
360 void *data;
361 struct l2cap_ops *ops;
362};
363
364struct l2cap_ops {
365 char *name;
366
367 struct l2cap_chan *(*new_connection) (void *data);
23070494 368 int (*recv) (void *data, struct sk_buff *skb);
ba3bd0ee 369 void (*close) (void *data);
89bc500e 370 void (*state_change) (void *data, int state);
1da177e4
LT
371};
372
373struct l2cap_conn {
374 struct hci_conn *hcon;
375
376 bdaddr_t *dst;
377 bdaddr_t *src;
378
379 unsigned int mtu;
380
4e8402a3
MH
381 __u32 feat_mask;
382
383 __u8 info_state;
384 __u8 info_ident;
385
386 struct timer_list info_timer;
387
1da177e4
LT
388 spinlock_t lock;
389
390 struct sk_buff *rx_skb;
391 __u32 rx_len;
1da177e4
LT
392 __u8 tx_ident;
393
2950f21a
MH
394 __u8 disc_reason;
395
baa7e1fa
GP
396 struct list_head chan_l;
397 rwlock_t chan_lock;
1da177e4
LT
398};
399
4e8402a3 400#define L2CAP_INFO_CL_MTU_REQ_SENT 0x01
984947dc
MH
401#define L2CAP_INFO_FEAT_MASK_REQ_SENT 0x04
402#define L2CAP_INFO_FEAT_MASK_REQ_DONE 0x08
4e8402a3 403
715ec005
GP
404#define L2CAP_CHAN_RAW 1
405#define L2CAP_CHAN_CONN_LESS 2
406#define L2CAP_CHAN_CONN_ORIENTED 3
407
48454079 408/* ----- L2CAP socket info ----- */
1da177e4
LT
409#define l2cap_pi(sk) ((struct l2cap_pinfo *) sk)
410
411struct l2cap_pinfo {
412 struct bt_sock bt;
48454079 413 struct l2cap_chan *chan;
1da177e4
LT
414};
415
f2fcfcd6
GP
416#define L2CAP_CONF_REQ_SENT 0x01
417#define L2CAP_CONF_INPUT_DONE 0x02
418#define L2CAP_CONF_OUTPUT_DONE 0x04
419#define L2CAP_CONF_MTU_DONE 0x08
420#define L2CAP_CONF_MODE_DONE 0x10
421#define L2CAP_CONF_CONNECT_PEND 0x20
fcc203c3 422#define L2CAP_CONF_NO_FCS_RECV 0x40
f2fcfcd6
GP
423#define L2CAP_CONF_STATE2_DEVICE 0x80
424
425#define L2CAP_CONF_MAX_CONF_REQ 2
426#define L2CAP_CONF_MAX_CONF_RSP 2
861d6882 427
d5392c8f
GP
428#define L2CAP_CONN_SAR_SDU 0x0001
429#define L2CAP_CONN_SREJ_SENT 0x0002
430#define L2CAP_CONN_WAIT_F 0x0004
431#define L2CAP_CONN_SREJ_ACT 0x0008
432#define L2CAP_CONN_SEND_PBIT 0x0010
433#define L2CAP_CONN_REMOTE_BUSY 0x0020
434#define L2CAP_CONN_LOCAL_BUSY 0x0040
435#define L2CAP_CONN_REJ_ACT 0x0080
436#define L2CAP_CONN_SEND_FBIT 0x0100
1890d36b
GP
437#define L2CAP_CONN_RNR_SENT 0x0200
438#define L2CAP_CONN_SAR_RETRY 0x0400
e90bac06 439
e92c8e70 440#define __mod_retrans_timer() mod_timer(&chan->retrans_timer, \
e90bac06 441 jiffies + msecs_to_jiffies(L2CAP_DEFAULT_RETRANS_TO));
e92c8e70 442#define __mod_monitor_timer() mod_timer(&chan->monitor_timer, \
e90bac06 443 jiffies + msecs_to_jiffies(L2CAP_DEFAULT_MONITOR_TO));
e92c8e70 444#define __mod_ack_timer() mod_timer(&chan->ack_timer, \
c1b4f43b 445 jiffies + msecs_to_jiffies(L2CAP_DEFAULT_ACK_TO));
c74e560c 446
42e5c802 447static inline int l2cap_tx_window_full(struct l2cap_chan *ch)
1c2acffb 448{
1c2acffb
GP
449 int sub;
450
42e5c802 451 sub = (ch->next_tx_seq - ch->expected_ack_seq) % 64;
1c2acffb
GP
452
453 if (sub < 0)
454 sub += 64;
455
2c03a7a4 456 return sub == ch->remote_tx_win;
1c2acffb
GP
457}
458
894718a6
AE
459#define __get_txseq(ctrl) (((ctrl) & L2CAP_CTRL_TXSEQ) >> 1)
460#define __get_reqseq(ctrl) (((ctrl) & L2CAP_CTRL_REQSEQ) >> 8)
461#define __is_iframe(ctrl) (!((ctrl) & L2CAP_CTRL_FRAME_TYPE))
462#define __is_sframe(ctrl) ((ctrl) & L2CAP_CTRL_FRAME_TYPE)
463#define __is_sar_start(ctrl) (((ctrl) & L2CAP_CTRL_SAR) == L2CAP_SDU_START)
1da177e4 464
bb58f747 465extern int disable_ertm;
bb58f747
GP
466
467int l2cap_init_sockets(void);
468void l2cap_cleanup_sockets(void);
469
8c1d787b 470void __l2cap_connect_rsp_defer(struct l2cap_chan *chan);
dcba0dba 471int __l2cap_wait_ack(struct sock *sk);
68983259 472
9e4425ff
GP
473int l2cap_add_psm(struct l2cap_chan *chan, bdaddr_t *src, __le16 psm);
474int l2cap_add_scid(struct l2cap_chan *chan, __u16 scid);
475
23691d75 476struct l2cap_chan *l2cap_chan_create(struct sock *sk);
0f852724 477void l2cap_chan_close(struct l2cap_chan *chan, int reason);
23691d75 478void l2cap_chan_destroy(struct l2cap_chan *chan);
77a74c7e 479int l2cap_chan_connect(struct l2cap_chan *chan);
9a91a04a 480int l2cap_chan_send(struct l2cap_chan *chan, struct msghdr *msg, size_t len);
bb58f747 481
1da177e4 482#endif /* __L2CAP_H */