blob: 6eac4a760c3be903d1f7feb7bad94b08d2a408e5 [file] [log] [blame]
Andrei Emeltchenkobe218712010-12-01 16:58:26 +02001/*
2 RFCOMM implementation for Linux Bluetooth stack (BlueZ)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 Copyright (C) 2002 Maxim Krasnyansky <maxk@qualcomm.com>
4 Copyright (C) 2002 Marcel Holtmann <marcel@holtmann.org>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License version 2 as
8 published by the Free Software Foundation;
9
10 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
11 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
12 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
13 IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
Andrei Emeltchenkobe218712010-12-01 16:58:26 +020014 CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
15 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18
Andrei Emeltchenkobe218712010-12-01 16:58:26 +020019 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
20 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 SOFTWARE IS DISCLAIMED.
22*/
23
24#ifndef __RFCOMM_H
25#define __RFCOMM_H
26
27#define RFCOMM_PSM 3
28
29#define RFCOMM_CONN_TIMEOUT (HZ * 30)
30#define RFCOMM_DISC_TIMEOUT (HZ * 20)
31#define RFCOMM_AUTH_TIMEOUT (HZ * 25)
Luiz Augusto von Dentz9e726b12009-07-15 13:50:58 -030032#define RFCOMM_IDLE_TIMEOUT (HZ * 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34#define RFCOMM_DEFAULT_MTU 127
35#define RFCOMM_DEFAULT_CREDITS 7
36
Marcel Holtmann56f3a402006-02-13 11:39:57 +010037#define RFCOMM_MAX_L2CAP_MTU 1013
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#define RFCOMM_MAX_CREDITS 40
39
40#define RFCOMM_SKB_HEAD_RESERVE 8
41#define RFCOMM_SKB_TAIL_RESERVE 2
42#define RFCOMM_SKB_RESERVE (RFCOMM_SKB_HEAD_RESERVE + RFCOMM_SKB_TAIL_RESERVE)
43
44#define RFCOMM_SABM 0x2f
45#define RFCOMM_DISC 0x43
46#define RFCOMM_UA 0x63
47#define RFCOMM_DM 0x0f
48#define RFCOMM_UIH 0xef
49
50#define RFCOMM_TEST 0x08
51#define RFCOMM_FCON 0x28
52#define RFCOMM_FCOFF 0x18
53#define RFCOMM_MSC 0x38
54#define RFCOMM_RPN 0x24
55#define RFCOMM_RLS 0x14
56#define RFCOMM_PN 0x20
57#define RFCOMM_NSC 0x04
58
59#define RFCOMM_V24_FC 0x02
60#define RFCOMM_V24_RTC 0x04
61#define RFCOMM_V24_RTR 0x08
62#define RFCOMM_V24_IC 0x40
63#define RFCOMM_V24_DV 0x80
64
65#define RFCOMM_RPN_BR_2400 0x0
66#define RFCOMM_RPN_BR_4800 0x1
67#define RFCOMM_RPN_BR_7200 0x2
68#define RFCOMM_RPN_BR_9600 0x3
69#define RFCOMM_RPN_BR_19200 0x4
70#define RFCOMM_RPN_BR_38400 0x5
71#define RFCOMM_RPN_BR_57600 0x6
72#define RFCOMM_RPN_BR_115200 0x7
73#define RFCOMM_RPN_BR_230400 0x8
74
75#define RFCOMM_RPN_DATA_5 0x0
76#define RFCOMM_RPN_DATA_6 0x1
77#define RFCOMM_RPN_DATA_7 0x2
78#define RFCOMM_RPN_DATA_8 0x3
79
80#define RFCOMM_RPN_STOP_1 0
81#define RFCOMM_RPN_STOP_15 1
82
83#define RFCOMM_RPN_PARITY_NONE 0x0
J. Suter3a5e9032005-08-09 20:28:46 -070084#define RFCOMM_RPN_PARITY_ODD 0x1
85#define RFCOMM_RPN_PARITY_EVEN 0x3
86#define RFCOMM_RPN_PARITY_MARK 0x5
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define RFCOMM_RPN_PARITY_SPACE 0x7
88
89#define RFCOMM_RPN_FLOW_NONE 0x00
90
91#define RFCOMM_RPN_XON_CHAR 0x11
92#define RFCOMM_RPN_XOFF_CHAR 0x13
93
94#define RFCOMM_RPN_PM_BITRATE 0x0001
95#define RFCOMM_RPN_PM_DATA 0x0002
96#define RFCOMM_RPN_PM_STOP 0x0004
97#define RFCOMM_RPN_PM_PARITY 0x0008
98#define RFCOMM_RPN_PM_PARITY_TYPE 0x0010
99#define RFCOMM_RPN_PM_XON 0x0020
100#define RFCOMM_RPN_PM_XOFF 0x0040
101#define RFCOMM_RPN_PM_FLOW 0x3F00
102
103#define RFCOMM_RPN_PM_ALL 0x3F7F
104
105struct rfcomm_hdr {
106 u8 addr;
107 u8 ctrl;
Andrei Emeltchenko285b4e92010-12-01 16:58:23 +0200108 u8 len; /* Actual size can be 2 bytes */
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300109} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111struct rfcomm_cmd {
112 u8 addr;
113 u8 ctrl;
114 u8 len;
115 u8 fcs;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300116} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118struct rfcomm_mcc {
119 u8 type;
120 u8 len;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300121} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123struct rfcomm_pn {
124 u8 dlci;
125 u8 flow_ctrl;
126 u8 priority;
127 u8 ack_timer;
Al Viro6ba9c752006-11-08 00:28:19 -0800128 __le16 mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 u8 max_retrans;
130 u8 credits;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300131} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133struct rfcomm_rpn {
134 u8 dlci;
135 u8 bit_rate;
136 u8 line_settings;
137 u8 flow_ctrl;
138 u8 xon_char;
139 u8 xoff_char;
Al Viro6ba9c752006-11-08 00:28:19 -0800140 __le16 param_mask;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300141} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143struct rfcomm_rls {
144 u8 dlci;
145 u8 status;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300146} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148struct rfcomm_msc {
149 u8 dlci;
150 u8 v24_sig;
Gustavo F. Padovan66c853c2010-07-19 02:00:13 -0300151} __packed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153/* ---- Core structures, flags etc ---- */
154
155struct rfcomm_session {
156 struct list_head list;
157 struct socket *sock;
Luiz Augusto von Dentz9e726b12009-07-15 13:50:58 -0300158 struct timer_list timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 unsigned long state;
160 unsigned long flags;
161 atomic_t refcnt;
162 int initiator;
163
164 /* Default DLC parameters */
165 int cfc;
166 uint mtu;
167
168 struct list_head dlcs;
169};
170
171struct rfcomm_dlc {
172 struct list_head list;
173 struct rfcomm_session *session;
174 struct sk_buff_head tx_queue;
175 struct timer_list timer;
176
177 spinlock_t lock;
178 unsigned long state;
179 unsigned long flags;
180 atomic_t refcnt;
181 u8 dlci;
182 u8 addr;
183 u8 priority;
184 u8 v24_sig;
Marcel Holtmann8b6b3da2008-07-14 20:13:52 +0200185 u8 remote_v24_sig;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 u8 mscex;
Marcel Holtmann77db1982008-07-14 20:13:45 +0200187 u8 out;
Marcel Holtmann9f2c8a02009-01-15 21:58:40 +0100188 u8 sec_level;
189 u8 role_switch;
Marcel Holtmannbb23c0a2009-01-15 21:56:48 +0100190 u32 defer_setup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 uint mtu;
193 uint cfc;
194 uint rx_credits;
195 uint tx_credits;
196
197 void *owner;
198
199 void (*data_ready)(struct rfcomm_dlc *d, struct sk_buff *skb);
200 void (*state_change)(struct rfcomm_dlc *d, int err);
201 void (*modem_status)(struct rfcomm_dlc *d, u8 v24_sig);
202};
203
204/* DLC and session flags */
205#define RFCOMM_RX_THROTTLED 0
206#define RFCOMM_TX_THROTTLED 1
207#define RFCOMM_TIMED_OUT 2
Marcel Holtmannbb23c0a2009-01-15 21:56:48 +0100208#define RFCOMM_MSC_PENDING 3
Marcel Holtmann8c84b832009-01-16 08:17:51 +0100209#define RFCOMM_SEC_PENDING 4
210#define RFCOMM_AUTH_PENDING 5
211#define RFCOMM_AUTH_ACCEPT 6
212#define RFCOMM_AUTH_REJECT 7
213#define RFCOMM_DEFER_SETUP 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
215/* Scheduling flags and events */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216#define RFCOMM_SCHED_WAKEUP 31
217
218/* MSC exchange flags */
219#define RFCOMM_MSCEX_TX 1
220#define RFCOMM_MSCEX_RX 2
221#define RFCOMM_MSCEX_OK (RFCOMM_MSCEX_TX + RFCOMM_MSCEX_RX)
222
223/* CFC states */
224#define RFCOMM_CFC_UNKNOWN -1
225#define RFCOMM_CFC_DISABLED 0
226#define RFCOMM_CFC_ENABLED RFCOMM_MAX_CREDITS
227
J. Suter3a5e9032005-08-09 20:28:46 -0700228/* ---- RFCOMM SEND RPN ---- */
229int rfcomm_send_rpn(struct rfcomm_session *s, int cr, u8 dlci,
230 u8 bit_rate, u8 data_bits, u8 stop_bits,
Andrei Emeltchenko285b4e92010-12-01 16:58:23 +0200231 u8 parity, u8 flow_ctrl_settings,
J. Suter3a5e9032005-08-09 20:28:46 -0700232 u8 xon_char, u8 xoff_char, u16 param_mask);
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234/* ---- RFCOMM DLCs (channels) ---- */
Al Virodd0fc662005-10-07 07:46:04 +0100235struct rfcomm_dlc *rfcomm_dlc_alloc(gfp_t prio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236void rfcomm_dlc_free(struct rfcomm_dlc *d);
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -0700237int rfcomm_dlc_open(struct rfcomm_dlc *d, bdaddr_t *src, bdaddr_t *dst, u8 channel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238int rfcomm_dlc_close(struct rfcomm_dlc *d, int reason);
239int rfcomm_dlc_send(struct rfcomm_dlc *d, struct sk_buff *skb);
240int rfcomm_dlc_set_modem_status(struct rfcomm_dlc *d, u8 v24_sig);
241int rfcomm_dlc_get_modem_status(struct rfcomm_dlc *d, u8 *v24_sig);
Marcel Holtmannbb23c0a2009-01-15 21:56:48 +0100242void rfcomm_dlc_accept(struct rfcomm_dlc *d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244#define rfcomm_dlc_lock(d) spin_lock(&d->lock)
245#define rfcomm_dlc_unlock(d) spin_unlock(&d->lock)
246
247static inline void rfcomm_dlc_hold(struct rfcomm_dlc *d)
248{
249 atomic_inc(&d->refcnt);
250}
251
252static inline void rfcomm_dlc_put(struct rfcomm_dlc *d)
253{
254 if (atomic_dec_and_test(&d->refcnt))
255 rfcomm_dlc_free(d);
256}
257
Harvey Harrison41380932007-12-12 10:46:51 -0800258extern void __rfcomm_dlc_throttle(struct rfcomm_dlc *d);
259extern void __rfcomm_dlc_unthrottle(struct rfcomm_dlc *d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261static inline void rfcomm_dlc_throttle(struct rfcomm_dlc *d)
262{
263 if (!test_and_set_bit(RFCOMM_RX_THROTTLED, &d->flags))
264 __rfcomm_dlc_throttle(d);
265}
266
267static inline void rfcomm_dlc_unthrottle(struct rfcomm_dlc *d)
268{
269 if (test_and_clear_bit(RFCOMM_RX_THROTTLED, &d->flags))
270 __rfcomm_dlc_unthrottle(d);
271}
272
273/* ---- RFCOMM sessions ---- */
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -0700274void rfcomm_session_getaddr(struct rfcomm_session *s, bdaddr_t *src, bdaddr_t *dst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276static inline void rfcomm_session_hold(struct rfcomm_session *s)
277{
278 atomic_inc(&s->refcnt);
279}
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281/* ---- RFCOMM sockets ---- */
282struct sockaddr_rc {
283 sa_family_t rc_family;
284 bdaddr_t rc_bdaddr;
285 u8 rc_channel;
286};
287
288#define RFCOMM_CONNINFO 0x02
289struct rfcomm_conninfo {
290 __u16 hci_handle;
291 __u8 dev_class[3];
292};
293
294#define RFCOMM_LM 0x03
295#define RFCOMM_LM_MASTER 0x0001
296#define RFCOMM_LM_AUTH 0x0002
297#define RFCOMM_LM_ENCRYPT 0x0004
298#define RFCOMM_LM_TRUSTED 0x0008
299#define RFCOMM_LM_RELIABLE 0x0010
300#define RFCOMM_LM_SECURE 0x0020
301
302#define rfcomm_pi(sk) ((struct rfcomm_pinfo *) sk)
303
304struct rfcomm_pinfo {
305 struct bt_sock bt;
306 struct rfcomm_dlc *dlc;
307 u8 channel;
Marcel Holtmann9f2c8a02009-01-15 21:58:40 +0100308 u8 sec_level;
309 u8 role_switch;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310};
311
312int rfcomm_init_sockets(void);
313void rfcomm_cleanup_sockets(void);
314
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -0700315int rfcomm_connect_ind(struct rfcomm_session *s, u8 channel, struct rfcomm_dlc **d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/* ---- RFCOMM TTY ---- */
318#define RFCOMM_MAX_DEV 256
319
320#define RFCOMMCREATEDEV _IOW('R', 200, int)
321#define RFCOMMRELEASEDEV _IOW('R', 201, int)
322#define RFCOMMGETDEVLIST _IOR('R', 210, int)
323#define RFCOMMGETDEVINFO _IOR('R', 211, int)
324#define RFCOMMSTEALDLC _IOW('R', 220, int)
325
326#define RFCOMM_REUSE_DLC 0
327#define RFCOMM_RELEASE_ONHUP 1
328#define RFCOMM_HANGUP_NOW 2
329#define RFCOMM_TTY_ATTACHED 3
Ville Tervo8de0a152007-07-11 09:23:41 +0200330#define RFCOMM_TTY_RELEASED 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332struct rfcomm_dev_req {
333 s16 dev_id;
334 u32 flags;
335 bdaddr_t src;
336 bdaddr_t dst;
337 u8 channel;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338};
339
340struct rfcomm_dev_info {
341 s16 id;
342 u32 flags;
343 u16 state;
344 bdaddr_t src;
345 bdaddr_t dst;
346 u8 channel;
347};
348
349struct rfcomm_dev_list_req {
350 u16 dev_num;
351 struct rfcomm_dev_info dev_info[0];
352};
353
354int rfcomm_dev_ioctl(struct sock *sk, unsigned int cmd, void __user *arg);
Dave Youngaf0d3b12009-08-03 04:26:16 +0000355
356#ifdef CONFIG_BT_RFCOMM_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357int rfcomm_init_ttys(void);
358void rfcomm_cleanup_ttys(void);
Dave Youngaf0d3b12009-08-03 04:26:16 +0000359#else
360static inline int rfcomm_init_ttys(void)
361{
362 return 0;
363}
364static inline void rfcomm_cleanup_ttys(void)
365{
366}
367#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368#endif /* __RFCOMM_H */