xref: /netbsd-src/usr.sbin/btattach/btattach.8 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\" $NetBSD: btattach.8,v 1.8 2014/03/18 18:20:46 riastradh Exp $
2.\"
3.\" Copyright (c) 2007 KIYOHARA Takashi
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
19.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
24.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd March 9, 2010
28.Dt BTATTACH 8
29.Os
30.Sh NAME
31.Nm btattach
32.Nd attach serial lines as Bluetooth HCI interfaces
33.Sh SYNOPSIS
34.Nm
35.Op Fl dFfoPp
36.Op Fl i Ar speed
37.Op Ar type
38.Ar tty
39.Ar speed
40.Nm
41.Fl t
42.Op Fl dFfoPp
43.Ar tty
44.Sh DESCRIPTION
45.Nm
46is used to assign a
47.Ar tty
48line to a Bluetooth Host Controller Interface using the
49.Xr btuart 4
50or
51.Xr bcsp 4
52line disciplines, and can optionally initialize the line for a
53given device
54.Ar type
55before activating the line discipline.
56.Pp
57Supported types are:
58.Bl -tag -compact -width ericssonxx -offset indent
59.It Cm bcm2035
60Broadcom BCM2035
61.It Cm bcsp
62Generic BCSP (BlueCore Serial Protocol)
63.It Cm bgb2xx
64Philips BGB2xx module
65.It Cm btuart
66Generic UART (this is the default)
67.It Cm csr
68Cambridge Silicon Radio Casira serial adapter, or
69Brainboxes serial dongle (BL642)
70.It Cm ericsson
71Ericsson based modules
72.It Cm digi
73Digianswer based cards
74.It Cm st
75ST Microelectronics minikits based on STLC2410/STLC2415
76.It Cm stlc2500
77ST Microelectronics minikits based on STLC2500
78.It Cm swave
79Silicon Wave kits
80.It Cm texas
81Texas Instruments modules
82.It Cm unistone
83Infineon UniStone (PBA31308) modules
84.El
85.Pp
86When the line discipline is activated,
87.Nm
88detaches and sleeps until it receives a
89.Dv SIGHUP .
90.Pp
91The command line options are as follows:
92.Bl -tag -width ".Fl i Ar speed"
93.It Fl d
94debug mode.
95print initialization IO and do not detach.
96.It Fl F
97Disable flow control.
98.It Fl f
99Enable flow control.
100.It Fl i Ar speed
101Specify an alternate
102.Ar speed
103for the Bluetooth module to use during the initialization phase.
104.It Fl o
105Enable odd parity.
106.It Fl P
107Disable parity.
108.It Fl p
109Enable parity (even parity).
110.It Fl t
111Test mode.
112.El
113.Pp
114Only the super-user may attach a Bluetooth HCI interface.
115.Pp
116Test mode tries to guess the speed using the received link-establish
117packet from HCI, or
118.Xr btuart 4 ,
119if there is no response.
120.Sh FILES
121.Bl -tag -compact
122.It Pa /var/run/btattach- Ns Bro tty Brc Ns .pid
123.El
124.Sh SEE ALSO
125.Xr bcsp 4 ,
126.Xr bluetooth 4 ,
127.Xr btuart 4 ,
128.Xr btconfig 8
129.Sh HISTORY
130The
131.Nm
132program was written with reference to
133.Xr hciattach 8
134as provided with the BlueZ tools for Linux and first appeared in
135.Nx 5.0 .
136.Sh AUTHORS
137.An KIYOHARA Takashi Aq Mt kiyohara@kk.iij4u.or.jp
138.An Iain Hibbert
139.Sh BUGS
140Not all
141.Ar type
142initializations have been tested.
143