Sync some USB serial driver manual pages with FreeBSD.
[dragonfly.git] / share / man / man4 / umct.4
1 .\"
2 .\" Copyright (c) 2004 Scott Long
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
15 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
16 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
18 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 .\" POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: head/share/man/man4/umct.4 227750 2011-11-20 12:18:21Z miwi $
27 .\"
28 .Dd November 20, 2011
29 .Dt UMCT 4
30 .Os
31 .Sh NAME
32 .Nm umct
33 .Nd Magic Control Technology USB-RS232 converter driver
34 .Sh SYNOPSIS
35 To compile this driver into the kernel,
36 place the following lines in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
39 .Cd "device usb"
40 .Cd "device ucom"
41 .Cd "device umct"
42 .Ed
43 .Pp
44 Alternatively, to load the driver as a
45 module at boot time, place the following line in
46 .Xr loader.conf 5 :
47 .Bd -literal -offset indent
48 umct_load="YES"
49 .Ed
50 .Sh DESCRIPTION
51 The
52 .Nm
53 driver provides support for USB to RS-232 converters based on the Magic
54 Control Technology USB-232 design.
55 These devices support most of the
56 standard RS-232 features including baud rates ranging from 300 to 115200
57 bits per second.
58 However, neither hardware nor software flow control
59 seems to be supported.
60 .Pp
61 Access to devices under this driver is via the
62 .Xr ucom 4
63 framework and device nodes.
64 .Sh HARDWARE
65 The
66 .Nm
67 driver supports the following adapters:
68 .Pp
69 .Bl -bullet -compact
70 .It
71 Belkin F5U109
72 .It
73 Belkin F5U409
74 .It
75 D-Link DU-H3SP USB BAY Hub
76 .It
77 Magic Control Technology USB-232
78 .It
79 Sitecom USB-232
80 .El
81 .Sh SEE ALSO
82 .Xr tty 4 ,
83 .Xr ucom 4 ,
84 .Xr usb 4
85 .Sh HISTORY
86 The
87 .Nm
88 driver
89 appeared in
90 .Fx 5.2 .
91 It is loosely based on the
92 .Xr ubsa 4
93 driver by
94 .An Alexander Kabaev Aq Mt kan@FreeBSD.org
95 with documentation from
96 .An Wolfgang Grandeggar Aq Mt wolfgang@cec.ch .
97 .Sh AUTHORS
98 The
99 .Nm
100 driver was written by
101 .An Scott Long Aq Mt scottl@FreeBSD.org .