xref: /netbsd-src/share/man/man4/bthub.4 (revision 8091a14e540bc4d13a912f38df697587242c8c0e)
1.\" $NetBSD: bthub.4,v 1.8 2010/10/17 11:45:36 plunky Exp $
2.\"
3.\" Copyright (c) 2006 Itronix Inc.
4.\" All rights reserved.
5.\"
6.\" Written by Iain Hibbert for Itronix Inc.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of Itronix Inc. may not be used to endorse
17.\"    or promote products derived from this software without specific
18.\"    prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
24.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27.\" ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30.\" POSSIBILITY OF SUCH DAMAGE.
31.\"
32.Dd October 17, 2010
33.Dt BTHUB 4
34.Os
35.Sh NAME
36.Nm bthub
37.Nd Bluetooth Remote Device Hub
38.Sh SYNOPSIS
39.Cd "bthub* at bcsp?"
40.Cd "bthub* at bt3c?"
41.Cd "bthub* at btbc?"
42.Cd "bthub* at btuart?"
43.Cd "bthub* at sbt?"
44.Cd "bthub* at ubt?"
45.Pp
46.Cd "bthidev* at bthub?"
47.Cd "btmagic* at bthub?"
48.Cd "btsco* at bthub?"
49.Sh DESCRIPTION
50The
51.Nm
52device is used to attach remote Bluetooth devices to the system, and
53will attach to Bluetooth controllers as they are enabled.
54.Sh CONFIGURATION
55Normally, Bluetooth Remote Devices will be configured on the
56.Nm
57using the
58.Xr btdevctl 8
59program, which passes a
60.Xr proplib 3
61dictionary to the control file
62.Pa /dev/bthub
63with the
64.Dv BTDEV_ATTACH
65and
66.Dv BTDEV_DETACH
67.Xr ioctl 2
68commands.
69.Pp
70The following properties are used by
71.Nm :
72.Pp
73.Bl -tag
74.It local-bdaddr
75Local
76.Dv BD_ADDR .
77This required property should be a six byte data blob.
78.It remote-bdaddr
79Remote
80.Dv BD_ADDR .
81This required property should be a six byte data blob.
82.It service-name
83Service name.
84This required property should be a string indicating the
85service to configure, and may be one of the following:
86.Pp
87.Bl -tag -compact
88.It HF
89Handsfree, see
90.Xr btsco 4 .
91.It HID
92Human Interface Device, see
93.Xr bthidev 4 .
94.It HSET
95Headset, see
96.Xr btsco 4 .
97.El
98.El
99.Pp
100Properties used by the configured device are listed in the appropriate
101device manual page.
102.Sh FILES
103.Bl -tag -compact
104.It Pa /dev/bthub
105.El
106.Sh SEE ALSO
107.Xr bluetooth 4 ,
108.Xr bthidev 4 ,
109.Xr btmagic 4 ,
110.Xr btsco 4 ,
111.Xr btdevctl 8
112.Sh HISTORY
113The
114.Nm
115driver was written by
116.An Iain Hibbert
117under the sponsorship of Itronix, Inc. and first appeared in
118.Nx 4.0 .
119