File: rfcomm.7

package info (click to toggle)
bluez 5.85-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 20,016 kB
  • sloc: ansic: 423,507; python: 4,751; sh: 4,580; makefile: 750; xml: 126
file content (421 lines) | stat: -rw-r--r-- 6,074 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
'\" t
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "RFCOMM" "7" "May 2024" "BlueZ" "Linux System Administration"
.SH NAME
rfcomm \- RFCOMM protocol
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <sys/socket.h>
#include <bluetooth/bluetooth.h>
#include <bluetooth/rfcomm.h>

rfcomm_socket = socket(PF_BLUETOOTH, SOCK_STREAM, BTPROTO_RFCOMM);
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The RFCOMM protocol provides emulation of serial ports over the L2CAP(7)
protocol. The protocol is based on the ETSI standard TS 07.10.
.sp
RFCOMM is a simple transport protocol, with additional provisions for emulating
the 9 circuits of RS\-232 (EIATIA\-232\-E) serial ports.
.SH SOCKET ADDRESS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
struct sockaddr_rc {
    sa_family_t rc_family;
    unsigned short rc_bdaddr;
    unsigned char rc_channel;
};
.EE
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
struct sockaddr_rc addr;

memset(&addr, 0, sizeof(addr));
addr.rc_family = AF_BLUETOOTH;
bacpy(&addr.rc_bdaddr, bdaddr);
addr.rc_channel = channel;
.EE
.UNINDENT
.UNINDENT
.SH SOCKET OPTIONS
.sp
The socket options listed below can be set by using \fBsetsockopt(2)\fP and read
with \fBgetsockopt(2)\fP with the socket level set to SOL_BLUETOOTH.
.SS BT_SECURITY (since Linux 2.6.30)
.sp
Channel security level, possible values:
.TS
box center;
l|l|l|l.
T{
Value
T}	T{
Security Level
T}	T{
Link Key Type
T}	T{
Encryption
T}
_
T{
\fBBT_SECURITY_SDP\fP
T}	T{
0 (SDP Only)
T}	T{
None
T}	T{
Not required
T}
_
T{
\fBBT_SECURITY_LOW\fP
T}	T{
1 (Low)
T}	T{
Unauthenticated
T}	T{
Not required
T}
_
T{
\fBBT_SECURITY_MEDIUM\fP
T}	T{
2 (Medium \- default)
T}	T{
Unauthenticated
T}	T{
Desired
T}
_
T{
\fBBT_SECURITY_HIGH\fP
T}	T{
3 (High)
T}	T{
Authenticated
T}	T{
Required
T}
_
T{
\fBBT_SECURITY_FIPS\fP (since Linux 3.15)
T}	T{
4 (Secure Only)
T}	T{
Authenticated (P\-256 based Secure Simple Pairing and Secure Authentication)
T}	T{
Required
T}
.TE
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
int level = BT_SECURITY_HIGH;
int err = setsockopt(rfcomm_socket, SOL_BLUETOOTH, BT_SECURITY, &level,
                     sizeof(level));
if (err == \-1) {
    perror(\(dqsetsockopt\(dq);
    return 1;
}
.EE
.UNINDENT
.UNINDENT
.SS BT_DEFER_SETUP (since Linux 2.6.30)
.sp
Channel defer connection setup, this control if the connection procedure
needs to be authorized by userspace before responding which allows
authorization at profile level, possible values:
.TS
box center;
l|l|l.
T{
Value
T}	T{
Description
T}	T{
Authorization
T}
_
T{
\fB0\fP
T}	T{
Disable (default)
T}	T{
Not required
T}
_
T{
\fB1\fP
T}	T{
Enable
T}	T{
Required
T}
.TE
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
int defer_setup = 1;
int err = setsockopt(rfcomm_socket, SOL_BLUETOOTH, BT_DEFER_SETUP,
                     &defer_setup, sizeof(defer_setup));
if (err == \-1) {
    perror(\(dqsetsockopt\(dq);
    return err;
}

err = listen(rfcomm_socket, 5);
if (err) {
    perror(\(dqlisten\(dq);
    return err;
}

struct sockaddr_rc remote_addr = {0};
socklen_t addr_len = sizeof(remote_addr);
int new_socket = accept(rfcomm_socket, (struct sockaddr*)&remote_addr,
                        &addr_len);
if (new_socket < 0) {
    perror(\(dqaccept\(dq);
    return new_socket;
}

/* To complete the connection setup of new_socket read 1 byte */
char c;
struct pollfd pfd;

memset(&pfd, 0, sizeof(pfd));
pfd.fd = new_socket;
pfd.events = POLLOUT;

err = poll(&pfd, 1, 0);
if (err) {
    perror(\(dqpoll\(dq);
    return err;
}

if (!(pfd.revents & POLLOUT)) {
    err = read(sk, &c, 1);
    if (err < 0) {
        perror(\(dqread\(dq);
        return err;
    }
}
.EE
.UNINDENT
.UNINDENT
.SS BT_FLUSHABLE (since Linux 2.6.39)
.sp
Channel flushable flag, this control if the channel data can be flushed or
not, possible values:
.TS
box center;
l|l|l.
T{
Define
T}	T{
Value
T}	T{
Description
T}
_
T{
\fBBT_FLUSHABLE_OFF\fP
T}	T{
0x00 (default)
T}	T{
Do not flush data
T}
_
T{
\fBBT_FLUSHABLE_ON\fP
T}	T{
0x01
T}	T{
Flush data
T}
.TE
.SS BT_CHANNEL_POLICY (since Linux 3.10)
.sp
High\-speed (AMP) channel policy, possible values:
.TS
box center;
l|l|l.
T{
Define
T}	T{
Value
T}	T{
Description
T}
_
T{
\fBBT_CHANNEL_POLICY_BREDR_ONLY\fP
T}	T{
0 (default)
T}	T{
BR/EDR only
T}
_
T{
\fBBT_CHANNEL_POLICY_BREDR_PREFERRED\fP
T}	T{
1
T}	T{
BR/EDR Preferred
T}
_
T{
\fBBT_CHANNEL_POLICY_BREDR_PREFERRED\fP
T}	T{
2
T}	T{
AMP Preferred
T}
.TE
.SS BT_PHY (since Linux 5.10)
.sp
Channel supported PHY(s), possible values:
.TS
box center;
l|l|l.
T{
Define
T}	T{
Value
T}	T{
Description
T}
_
T{
\fBBT_PHY_BR_1M_1SLOT\fP
T}	T{
BIT 0
T}	T{
BR 1Mbps 1SLOT
T}
_
T{
\fBBT_PHY_BR_1M_3SLOT\fP
T}	T{
BIT 1
T}	T{
BR 1Mbps 3SLOT
T}
_
T{
\fBBT_PHY_BR_1M_5SLOT\fP
T}	T{
BIT 2
T}	T{
BR 1Mbps 5SLOT
T}
_
T{
\fBBT_PHY_BR_2M_1SLOT\fP
T}	T{
BIT 3
T}	T{
EDR 2Mbps 1SLOT
T}
_
T{
\fBBT_PHY_BR_2M_3SLOT\fP
T}	T{
BIT 4
T}	T{
EDR 2Mbps 3SLOT
T}
_
T{
\fBBT_PHY_BR_2M_5SLOT\fP
T}	T{
BIT 5
T}	T{
EDR 2Mbps 5SLOT
T}
_
T{
\fBBT_PHY_BR_3M_1SLOT\fP
T}	T{
BIT 6
T}	T{
EDR 3Mbps 1SLOT
T}
_
T{
\fBBT_PHY_BR_3M_3SLOT\fP
T}	T{
BIT 7
T}	T{
EDR 3Mbps 3SLOT
T}
_
T{
\fBBT_PHY_BR_3M_5SLOT\fP
T}	T{
BIT 8
T}	T{
EDR 3Mbps 5SLOT
T}
.TE
.SH RESOURCES
.sp
 <http://www.bluez.org> 
.SH REPORTING BUGS
.sp
 <linux\-bluetooth@vger.kernel.org> 
.SH SEE ALSO
.sp
socket(7), rctest(1)
.SH COPYRIGHT
Free use of this software is granted under the terms of the GNU
Lesser General Public Licenses (LGPL).
.\" Generated by docutils manpage writer.
.