xref: /netbsd-src/share/man/man4/btuart.4 (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1.\" $NetBSD: btuart.4,v 1.5 2007/12/02 02:23:43 kiyohara 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 November 2, 2007
28.Dt BTUART 4
29.Os
30.Sh NAME
31.Nm btuart
32.Nd Bluetooth HCI UART (H4) driver
33.Sh SYNOPSIS
34.Cd pseudo-device btuart
35.Sh DESCRIPTION
36The
37.Nm
38driver provides a
39.Xr tty 4
40line discipline to send and receive Bluetooth packets over a serial line,
41as described in the
42.Qo
43Bluetooth Host Controller Interface
44.Bq Transport Layer
45specification, Vol 4 part A.
46.Qc
47.Pp
48The
49.Nm
50sets the baud rate for that by a vendor specific or other command.
51.Pp
52Different modules require different handling.
53The connected modules type can be set with
54.Xr ioctl 2
55calls:
56.Bl -tag -width xxxxxx
57.It Dv BTUART_HCITYPE Fa (int)
58Set the module type.
59The
60.Nm
61supports:
62.Bl -tag -width XXXXXX -offset indent
63.It Dv BTUART_HCITYPE_ERICSSON
64Ericsson based modules
65.It Dv BTUART_HCITYPE_DIGI
66Digianswer based cards
67.It Dv BTUART_HCITYPE_TEXAS
68Texas Instruments
69.It Dv BTUART_HCITYPE_CSR
70Cambridge Silicon Radio Casira serial adapter or BrainBoxes serial dongle
71(BL642)
72.Pp
73AmbiCom BT2000C Bluetooth PC/CF Card
74.It Dv BTUART_HCITYPE_SWAVE
75Silicon Wave kits
76.It Dv BTUART_HCITYPE_ST
77ST Microelectronics minikits based on STLC2410/STLC2415
78.It Dv BTUART_HCITYPE_STLC2500
79ST Microelectronics minikits based on STLC2500
80.It Dv BTUART_HCITYPE_BT2000C
81This macro obsolated. Can use BTUART_HCITYPE_CSR.
82.It Dv BTUART_HCITYPE_BCM2035
83Broadcom BCM2035
84.It Dv BTUART_HCITYPE_BGB2XX
85Philips BGB2xx Module
86.It Dv BTUART_HCITYPE_ANY
87Unspecified HCI UART interface
88.El
89.It Dv BTUART_INITSPEED Fa (int)
90Set initial speed of module, send initial command to module.
91.It Dv BTUART_START Fa (void)
92Start
93.Nm
94driver.
95.El
96.Sh SEE ALSO
97.Xr bcsp 4
98.Xr bluetooth 4 ,
99.Xr btuartd 8
100.Sh HISTORY
101The
102.Nm
103device appeared in
104.Nx 4.0 .
105.Sh BUGS
106The
107.Nm
108driver was written to refer for bluez and Linux drivers.
109Some module types not tests.
110.Pp
111Also can't set baud rate on texas and bgb2xx.
112.Sh AUTHORS
113.An KIYOHARA Takashi Aq kiyohara@kk.iij4u.or.jp
114