1 /*
2 RFCOMM implementation for Linux Bluetooth stack (BlueZ)
3 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
14 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
17 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18
19 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
20 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
21 SOFTWARE IS DISCLAIMED.
22 */
23
24 #include <linux/refcount.h>
25 #include <linux/android_kabi.h>
26
27 #ifndef __RFCOMM_H
28 #define __RFCOMM_H
29
30 #define RFCOMM_CONN_TIMEOUT (HZ * 30)
31 #define RFCOMM_DISC_TIMEOUT (HZ * 20)
32 #define RFCOMM_AUTH_TIMEOUT (HZ * 25)
33 #define RFCOMM_IDLE_TIMEOUT (HZ * 2)
34
35 #define RFCOMM_DEFAULT_MTU 127
36 #define RFCOMM_DEFAULT_CREDITS 7
37
38 #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
84 #define RFCOMM_RPN_PARITY_ODD 0x1
85 #define RFCOMM_RPN_PARITY_EVEN 0x3
86 #define RFCOMM_RPN_PARITY_MARK 0x5
87 #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
105 struct rfcomm_hdr {
106 u8 addr;
107 u8 ctrl;
108 u8 len; /* Actual size can be 2 bytes */
109 } __packed;
110
111 struct rfcomm_cmd {
112 u8 addr;
113 u8 ctrl;
114 u8 len;
115 u8 fcs;
116 } __packed;
117
118 struct rfcomm_mcc {
119 u8 type;
120 u8 len;
121 } __packed;
122
123 struct rfcomm_pn {
124 u8 dlci;
125 u8 flow_ctrl;
126 u8 priority;
127 u8 ack_timer;
128 __le16 mtu;
129 u8 max_retrans;
130 u8 credits;
131 } __packed;
132
133 struct 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;
140 __le16 param_mask;
141 } __packed;
142
143 struct rfcomm_rls {
144 u8 dlci;
145 u8 status;
146 } __packed;
147
148 struct rfcomm_msc {
149 u8 dlci;
150 u8 v24_sig;
151 } __packed;
152
153 /* ---- Core structures, flags etc ---- */
154
155 struct rfcomm_session {
156 struct list_head list;
157 struct socket *sock;
158 struct timer_list timer;
159 unsigned long state;
160 unsigned long flags;
161 int initiator;
162
163 /* Default DLC parameters */
164 int cfc;
165 uint mtu;
166
167 struct list_head dlcs;
168
169 ANDROID_KABI_RESERVE(1);
170 };
171
172 struct rfcomm_dlc {
173 struct list_head list;
174 struct rfcomm_session *session;
175 struct sk_buff_head tx_queue;
176 struct timer_list timer;
177
178 struct mutex lock;
179 unsigned long state;
180 unsigned long flags;
181 refcount_t refcnt;
182 u8 dlci;
183 u8 addr;
184 u8 priority;
185 u8 v24_sig;
186 u8 remote_v24_sig;
187 u8 mscex;
188 u8 out;
189 u8 sec_level;
190 u8 role_switch;
191 u32 defer_setup;
192
193 uint mtu;
194 uint cfc;
195 uint rx_credits;
196 uint tx_credits;
197
198 void *owner;
199
200 void (*data_ready)(struct rfcomm_dlc *d, struct sk_buff *skb);
201 void (*state_change)(struct rfcomm_dlc *d, int err);
202 void (*modem_status)(struct rfcomm_dlc *d, u8 v24_sig);
203
204 ANDROID_KABI_RESERVE(1);
205 ANDROID_KABI_RESERVE(2);
206 };
207
208 /* DLC and session flags */
209 #define RFCOMM_RX_THROTTLED 0
210 #define RFCOMM_TX_THROTTLED 1
211 #define RFCOMM_TIMED_OUT 2
212 #define RFCOMM_MSC_PENDING 3
213 #define RFCOMM_SEC_PENDING 4
214 #define RFCOMM_AUTH_PENDING 5
215 #define RFCOMM_AUTH_ACCEPT 6
216 #define RFCOMM_AUTH_REJECT 7
217 #define RFCOMM_DEFER_SETUP 8
218 #define RFCOMM_ENC_DROP 9
219
220 /* Scheduling flags and events */
221 #define RFCOMM_SCHED_WAKEUP 31
222
223 /* MSC exchange flags */
224 #define RFCOMM_MSCEX_TX 1
225 #define RFCOMM_MSCEX_RX 2
226 #define RFCOMM_MSCEX_OK (RFCOMM_MSCEX_TX + RFCOMM_MSCEX_RX)
227
228 /* CFC states */
229 #define RFCOMM_CFC_UNKNOWN -1
230 #define RFCOMM_CFC_DISABLED 0
231 #define RFCOMM_CFC_ENABLED RFCOMM_MAX_CREDITS
232
233 /* ---- RFCOMM SEND RPN ---- */
234 int rfcomm_send_rpn(struct rfcomm_session *s, int cr, u8 dlci,
235 u8 bit_rate, u8 data_bits, u8 stop_bits,
236 u8 parity, u8 flow_ctrl_settings,
237 u8 xon_char, u8 xoff_char, u16 param_mask);
238
239 /* ---- RFCOMM DLCs (channels) ---- */
240 struct rfcomm_dlc *rfcomm_dlc_alloc(gfp_t prio);
241 void rfcomm_dlc_free(struct rfcomm_dlc *d);
242 int rfcomm_dlc_open(struct rfcomm_dlc *d, bdaddr_t *src, bdaddr_t *dst,
243 u8 channel);
244 int rfcomm_dlc_close(struct rfcomm_dlc *d, int reason);
245 int rfcomm_dlc_send(struct rfcomm_dlc *d, struct sk_buff *skb);
246 void rfcomm_dlc_send_noerror(struct rfcomm_dlc *d, struct sk_buff *skb);
247 int rfcomm_dlc_set_modem_status(struct rfcomm_dlc *d, u8 v24_sig);
248 int rfcomm_dlc_get_modem_status(struct rfcomm_dlc *d, u8 *v24_sig);
249 void rfcomm_dlc_accept(struct rfcomm_dlc *d);
250 struct rfcomm_dlc *rfcomm_dlc_exists(bdaddr_t *src, bdaddr_t *dst, u8 channel);
251
252 #define rfcomm_dlc_lock(d) mutex_lock(&d->lock)
253 #define rfcomm_dlc_unlock(d) mutex_unlock(&d->lock)
254
rfcomm_dlc_hold(struct rfcomm_dlc * d)255 static inline void rfcomm_dlc_hold(struct rfcomm_dlc *d)
256 {
257 refcount_inc(&d->refcnt);
258 }
259
rfcomm_dlc_put(struct rfcomm_dlc * d)260 static inline void rfcomm_dlc_put(struct rfcomm_dlc *d)
261 {
262 if (refcount_dec_and_test(&d->refcnt))
263 rfcomm_dlc_free(d);
264 }
265
266 void __rfcomm_dlc_throttle(struct rfcomm_dlc *d);
267 void __rfcomm_dlc_unthrottle(struct rfcomm_dlc *d);
268
rfcomm_dlc_throttle(struct rfcomm_dlc * d)269 static inline void rfcomm_dlc_throttle(struct rfcomm_dlc *d)
270 {
271 if (!test_and_set_bit(RFCOMM_RX_THROTTLED, &d->flags))
272 __rfcomm_dlc_throttle(d);
273 }
274
rfcomm_dlc_unthrottle(struct rfcomm_dlc * d)275 static inline void rfcomm_dlc_unthrottle(struct rfcomm_dlc *d)
276 {
277 if (test_and_clear_bit(RFCOMM_RX_THROTTLED, &d->flags))
278 __rfcomm_dlc_unthrottle(d);
279 }
280
281 /* ---- RFCOMM sessions ---- */
282 void rfcomm_session_getaddr(struct rfcomm_session *s, bdaddr_t *src,
283 bdaddr_t *dst);
284
285 /* ---- RFCOMM sockets ---- */
286 struct sockaddr_rc {
287 sa_family_t rc_family;
288 bdaddr_t rc_bdaddr;
289 u8 rc_channel;
290 };
291
292 #define RFCOMM_CONNINFO 0x02
293 struct rfcomm_conninfo {
294 __u16 hci_handle;
295 __u8 dev_class[3];
296 };
297
298 #define RFCOMM_LM 0x03
299 #define RFCOMM_LM_MASTER 0x0001
300 #define RFCOMM_LM_AUTH 0x0002
301 #define RFCOMM_LM_ENCRYPT 0x0004
302 #define RFCOMM_LM_TRUSTED 0x0008
303 #define RFCOMM_LM_RELIABLE 0x0010
304 #define RFCOMM_LM_SECURE 0x0020
305 #define RFCOMM_LM_FIPS 0x0040
306
307 #define rfcomm_pi(sk) ((struct rfcomm_pinfo *) sk)
308
309 struct rfcomm_pinfo {
310 struct bt_sock bt;
311 bdaddr_t src;
312 bdaddr_t dst;
313 struct rfcomm_dlc *dlc;
314 u8 channel;
315 u8 sec_level;
316 u8 role_switch;
317 };
318
319 int rfcomm_init_sockets(void);
320 void rfcomm_cleanup_sockets(void);
321
322 int rfcomm_connect_ind(struct rfcomm_session *s, u8 channel,
323 struct rfcomm_dlc **d);
324
325 /* ---- RFCOMM TTY ---- */
326 #define RFCOMM_MAX_DEV 256
327
328 #define RFCOMMCREATEDEV _IOW('R', 200, int)
329 #define RFCOMMRELEASEDEV _IOW('R', 201, int)
330 #define RFCOMMGETDEVLIST _IOR('R', 210, int)
331 #define RFCOMMGETDEVINFO _IOR('R', 211, int)
332 #define RFCOMMSTEALDLC _IOW('R', 220, int)
333
334 /* rfcomm_dev.flags bit definitions */
335 #define RFCOMM_REUSE_DLC 0
336 #define RFCOMM_RELEASE_ONHUP 1
337 #define RFCOMM_HANGUP_NOW 2
338 #define RFCOMM_TTY_ATTACHED 3
339 #define RFCOMM_DEFUNCT_BIT4 4 /* don't reuse this bit - userspace visible */
340
341 /* rfcomm_dev.status bit definitions */
342 #define RFCOMM_DEV_RELEASED 0
343 #define RFCOMM_TTY_OWNED 1
344
345 struct rfcomm_dev_req {
346 s16 dev_id;
347 u32 flags;
348 bdaddr_t src;
349 bdaddr_t dst;
350 u8 channel;
351 };
352
353 struct rfcomm_dev_info {
354 s16 id;
355 u32 flags;
356 u16 state;
357 bdaddr_t src;
358 bdaddr_t dst;
359 u8 channel;
360 };
361
362 struct rfcomm_dev_list_req {
363 u16 dev_num;
364 struct rfcomm_dev_info dev_info[];
365 };
366
367 int rfcomm_dev_ioctl(struct sock *sk, unsigned int cmd, void __user *arg);
368
369 #ifdef CONFIG_BT_RFCOMM_TTY
370 int rfcomm_init_ttys(void);
371 void rfcomm_cleanup_ttys(void);
372 #else
rfcomm_init_ttys(void)373 static inline int rfcomm_init_ttys(void)
374 {
375 return 0;
376 }
rfcomm_cleanup_ttys(void)377 static inline void rfcomm_cleanup_ttys(void)
378 {
379 }
380 #endif
381 #endif /* __RFCOMM_H */
382