xref: /netbsd-src/share/man/man4/bthub.4 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\" $NetBSD: bthub.4,v 1.7 2007/08/21 10:56:11 kiyohara 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 August 21, 2007
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 bt3c?"
40.Cd "bthub* at btbc?"
41.Cd "bthub* at btuart?"
42.Cd "bthub* at ubt?"
43.Pp
44.Cd "bthidev* at bthub?"
45.Cd "btsco* at bthub?"
46.Sh DESCRIPTION
47The
48.Nm
49device is used to attach remote Bluetooth devices to the system, and
50will attach to Bluetooth controllers as they are enabled.
51.Sh CONFIGURATION
52Normally, Bluetooth Remote Devices will be configured on the
53.Nm
54using the
55.Xr btdevctl 8
56program, which passes a
57.Xr proplib 3
58dictionary to the control file
59.Pa /dev/bthub
60with the
61.Dv BTDEV_ATTACH
62and
63.Dv BTDEV_DETACH
64.Xr ioctl 2
65commands.
66.Pp
67The following properties are used by
68.Nm :
69.Pp
70.Bl -tag
71.It local-bdaddr
72Local
73.Dv BD_ADDR .
74This required property should be a six byte data blob.
75.It remote-bdaddr
76Remote
77.Dv BD_ADDR .
78This required property should be a six byte data blob.
79.It service-name
80Service name.
81This required property should be a string indicating the
82service to configure, and may be one of the following:
83.Pp
84.Bl -tag -compact
85.It HF
86Handsfree, see
87.Xr btsco 4 .
88.It HID
89Human Interface Device, see
90.Xr bthidev 4 .
91.It HSET
92Headset, see
93.Xr btsco 4 .
94.El
95.El
96.Pp
97Properties used by the configured device are listed in the appropriate
98device manual page.
99.Sh FILES
100.Bl -tag -compact
101.It Pa /dev/bthub
102.El
103.Sh SEE ALSO
104.Xr bluetooth 4 ,
105.Xr bthidev 4 ,
106.Xr btsco 4 ,
107.Xr btdevctl 8
108.Sh HISTORY
109The
110.Nm
111driver was written by
112.An Iain Hibbert
113under the sponsorship of Itronix, Inc. and first appeared in
114.Nx 4.0 .
115