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