Update the uftdi(4) manpage.
[dragonfly.git] / share / man / man4 / uftdi.4
CommitLineData
984263bc
MD
1.\" $NetBSD: uftdi.4,v 1.5 2002/02/07 03:15:08 ross Exp $
2.\"
3.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Lennart Augustsson.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in the
16.\" documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\" must display the following acknowledgement:
19.\" This product includes software developed by the NetBSD
20.\" Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\" contributors may be used to endorse or promote products derived
23.\" from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\" $FreeBSD: src/share/man/man4/uftdi.4,v 1.1.2.1 2002/11/21 01:28:16 ticso Exp $
84115e04 38.\" $DragonFly: src/share/man/man4/uftdi.4,v 1.5 2007/11/07 09:57:07 hasso Exp $
984263bc 39.\"
84115e04 40.Dd November 11, 2007
984263bc
MD
41.Dt UFTDI 4
42.Os
43.Sh NAME
44.Nm uftdi
84115e04 45.Nd USB support for serial devices based on the FTDI chips
984263bc 46.Sh SYNOPSIS
f5fc7b9c
HT
47To compile this driver into the kernel,
48place the following lines in your
49kernel configuration file:
50.Bd -ragged -offset indent
51.Cd "device uftdi"
52.Cd "device ucom"
53.Ed
54.Pp
55Alternatively, to load the driver as a
56module at boot time, place the following line in
57.Xr loader.conf 5 :
58.Bd -literal -offset indent
59uftdi_load="YES"
60.Ed
43be8dac
SW
61.Sh DESCRIPTION
62The
63.Nm
84115e04
HT
64driver provides support for RS-232 (and possibly RS-485) virtual COM
65port functionality in various FTDI chips:
43be8dac 66.Pp
84115e04
HT
67.Bl -dash -compact -offset indent
68.It
69FT8U100AX multi-function hub controller chip
984263bc 70.It
84115e04 71FT8U232AM USB UART chip
984263bc 72.It
84115e04 73FT232 series USB UART chips
984263bc 74.It
84115e04 75FT2232 series dual USB UART/FIFO chips
984263bc 76.El
84115e04
HT
77.Pp
78The
79.Nm
80driver doesn't support any other serial protocol supported by these chips.
81These protocols might be supported by libftdi userspace library.
82.Pp
83The device is accessed through the
84.Xr ucom 4
85driver which makes it behave like a
86.Xr tty 4 .
984263bc
MD
87.Sh SEE ALSO
88.Xr tty 4 ,
89.Xr ucom 4 ,
90.Xr usb 4
84115e04
HT
91.Rs
92.%T libftdi
93.%O http://www.intra2net.com/de/produkte/opensource/ftdi/
94.Re
984263bc
MD
95.Sh HISTORY
96The
97.Nm
98driver
99appeared in
100.Nx 1.5 .