xref: /netbsd-src/usr.sbin/btattach/btattach.8 (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1.\" $NetBSD: btattach.8,v 1.2 2009/03/15 10:04:27 joerg 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 27, 2008
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 dfop
36.Op Fl i Ar speed
37.Op Ar type
38.Ar tty
39.Ar speed
40.Sh DESCRIPTION
41.Nm
42is used to assign a
43.Ar tty
44line to a Bluetooth Host Controller Interface using the
45.Xr btuart 4
46or
47.Xr bcsp 4
48line disciplines, and can optionally initialize the line for a
49given device
50.Ar type
51before activating the line discipline.
52.Pp
53Supported types are:
54.Bl -tag -compact -width ericssonxx -offset indent
55.It Cm bcm2035
56Broadcom BCM2035
57.It Cm bcsp
58Generic BCSP (BlueCore Serial Protocol)
59.It Cm bgb2xx
60Philips BGB2xx module
61.It Cm btuart
62Generic UART (this is the default)
63.It Cm csr
64Cambridge Silicon Radio Casira serial adaptor, or
65Brainboxes serial dongle (BL642)
66.It Cm ericsson
67Ericsson based modules
68.It Cm digi
69Digianswer based cards
70.It Cm st
71ST Microelectronics minikits based on STLC2410/STLC2415
72.It Cm stlc2500
73ST Microelectronics minikits based on STLC2500
74.It Cm swave
75Silicon Wave kits
76.It Cm texas
77Texas Instruments modules
78.El
79.Pp
80When the line discipline is activated,
81.Nm
82detaches and sleeps until it receives a
83.Dv SIGHUP .
84.Pp
85The command line options are as follows:
86.Bl -tag -width ".Fl i Ar speed"
87.It Fl d
88debug mode.
89print initialization IO and do not detach.
90.It Fl f
91Enable flow control.
92.It Fl i Ar speed
93Specify an alternate
94.Ar speed
95for the Bluetooth module to use during the initialization phase.
96.It Fl o
97Enable odd parity.
98.It Fl p
99Enable parity (even parity).
100.El
101.Pp
102Only the super-user may attach a Bluetooth HCI interface.
103.Sh FILES
104.Bl -tag -compact
105.It Pa /var/run/btattach- Ns Bro tty Brc Ns .pid
106.El
107.Sh SEE ALSO
108.Xr bcsp 4 ,
109.Xr bluetooth 4 ,
110.Xr btuart 4 ,
111.Xr btconfig 8
112.Sh BUGS
113Not all
114.Ar type
115initializations have been tested.
116.Sh HISTORY
117The
118.Nm
119program was written with reference to
120.Xr hciattach 8
121as provided with the BlueZ tools for Linux and first appeared in
122.Nx 5.0 .
123.Sh AUTHORS
124.An KIYOHARA Takashi Aq kiyohara@kk.iij4u.or.jp
125.An Iain Hibbert
126