Update the uftdi(4) manpage.
[dragonfly.git] / share / man / man4 / uftdi.4
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 $
38 .\" $DragonFly: src/share/man/man4/uftdi.4,v 1.5 2007/11/07 09:57:07 hasso Exp $
39 .\"
40 .Dd November 11, 2007
41 .Dt UFTDI 4
42 .Os
43 .Sh NAME
44 .Nm uftdi
45 .Nd USB support for serial devices based on the FTDI chips
46 .Sh SYNOPSIS
47 To compile this driver into the kernel,
48 place the following lines in your
49 kernel configuration file:
50 .Bd -ragged -offset indent
51 .Cd "device uftdi"
52 .Cd "device ucom"
53 .Ed
54 .Pp
55 Alternatively, to load the driver as a
56 module at boot time, place the following line in
57 .Xr loader.conf 5 :
58 .Bd -literal -offset indent
59 uftdi_load="YES"
60 .Ed
61 .Sh DESCRIPTION
62 The
63 .Nm
64 driver provides support for RS-232 (and possibly RS-485) virtual COM
65 port functionality in various FTDI chips:
66 .Pp
67 .Bl -dash -compact -offset indent
68 .It
69 FT8U100AX multi-function hub controller chip
70 .It
71 FT8U232AM USB UART chip
72 .It
73 FT232 series USB UART chips
74 .It
75 FT2232 series dual USB UART/FIFO chips
76 .El
77 .Pp
78 The
79 .Nm
80 driver doesn't support any other serial protocol supported by these chips.
81 These protocols might be supported by libftdi userspace library.
82 .Pp
83 The device is accessed through the
84 .Xr ucom 4
85 driver which makes it behave like a
86 .Xr tty 4 .
87 .Sh SEE ALSO
88 .Xr tty 4 ,
89 .Xr ucom 4 ,
90 .Xr usb 4
91 .Rs
92 .%T libftdi
93 .%O http://www.intra2net.com/de/produkte/opensource/ftdi/
94 .Re
95 .Sh HISTORY
96 The
97 .Nm
98 driver
99 appeared in
100 .Nx 1.5 .