FWIW, port and hook in the urio(4) storage driver.
[dragonfly.git] / share / man / man4 / uticom.4
1 .\" Copyright (c) 2007
2 .\"     The DragonFly Project.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\"
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
12 .\"    the documentation and/or other materials provided with the
13 .\"    distribution.
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\"    contributors may be used to endorse or promote products derived
16 .\"    from this software without specific, prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .Dd November 11, 2007
32 .Dt UTICOM 4
33 .Os
34 .Sh NAME
35 .Nm uticom
36 .Nd Texas Instruments TUSB3410 RS232 to USB converter
37 .Sh SYNOPSIS
38 To compile this driver into the kernel,
39 place the following lines in your
40 kernel configuration file:
41 .Bd -ragged -offset indent
42 .Cd "device uticom"
43 .Cd "device ucom"
44 .Ed
45 .Pp
46 Alternatively, to load the driver as a
47 module at boot time, place the following line in
48 .Xr loader.conf 5 :
49 .Bd -literal -offset indent
50 uticom_load="YES"
51 .Ed
52 .Sh DESCRIPTION
53 The
54 .Nm
55 driver supports virtual serial port functionality on devices based on Texas
56 Instruments TUSB3410 serial to USB converter chip. Note that the driver
57 doesn't support devices which have internal EEPROM with firmware.
58 .Pp
59 The device is accessed through the
60 .Xr ucom 4
61 driver which makes it behave like a
62 .Xr tty 4 .
63 .Sh SYSCTL
64 .Bl -tag -width indent
65 .It Va hw.usb.uticom.stickdsr
66 If set to non-zero, DSR (Data Set Ready) signal from DCE is ignored and the
67 TIOCM_DSR state flag is set unconditionally.  It can be used if DSR signal
68 from DCE is unreliable.  Default is 0.
69 .El
70 .Sh SEE ALSO
71 .Xr tty 4 ,
72 .Xr ucom 4 ,
73 .Xr usb 4
74 .Sh HISTORY
75 The
76 .Nm
77 device driver first appeared in
78 .Dx 1.11 .
79 .Sh AUTHORS
80 .An -nosplit
81 The
82 .Nm
83 driver was written by
84 .An Dmitry Komissaroff Aq Mt dxi@mail.ru
85 and
86 .An Hasso Tepper Aq Mt hasso@estpak.ee .