xref: /netbsd-src/share/man/man4/ucom.4 (revision 0e961a0fbeacb8bbf09714368f5bbdf1fae31a7e)
1.\" $NetBSD: ucom.4,v 1.29 2020/04/13 08:45:11 wiz Exp $
2.\"
3.\" Copyright (c) 1999 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.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd April 12, 2020
31.Dt UCOM 4
32.Os
33.Sh NAME
34.Nm ucom
35.Nd USB tty support
36.Sh SYNOPSIS
37.Cd "ucom* at u3g?"
38.Cd "ucom* at uark?"
39.Cd "ucom* at ubsa?"
40.Cd "ucom* at uchcom?"
41.Cd "ucom* at uftdi?"
42.Cd "ucom* at ugensa?"
43.Cd "ucom* at uhmodem?"
44.Cd "ucom* at uipaq?"
45.Cd "ucom* at ukyopon?"
46.Cd "ucom* at umcs? portno ?"
47.Cd "ucom* at umct?"
48.Cd "ucom* at umodem?"
49.Cd "ucom* at uplcom?"
50.Cd "ucom* at uslsa?"
51.Cd "ucom* at uvisor? portno ?"
52.Cd "ucom* at uvscom?"
53.Cd "ucom* at uxrcom?"
54.Sh DESCRIPTION
55The
56.Nm
57driver attaches to USB modems, serial ports, and other devices that need
58to look like a tty.
59The
60.Nm
61driver shows a behaviour like a
62.Xr tty 4 .
63This means that normal programs such as
64.Xr tip 1
65or
66.Xr pppd 8
67can be used to access the device.
68.Pp
69The
70.Va portno
71locator can be used to decide which port to use for device that have
72multiple external ports.
73.Pp
74Note that while
75.Nm
76supports the (undocumented) pulse-per-second API normally used on
77conventional serial ports, USB serial devices typically have a varying
78latency around 1 ms due to the USB frame structure.
79.Pp
80The ttyXX devices are traditional dial-in devices; the dtyXX devices
81are used for dial-out.
82(See
83.Xr tty 4 . )
84.Sh FILES
85.Bl -tag -width Pa
86.It Pa /dev/dtyU?
87.It Pa /dev/ttyU?
88.El
89.Sh SEE ALSO
90.Xr tty 4 ,
91.Xr u3g 4 ,
92.Xr uark 4 ,
93.Xr ubsa 4 ,
94.Xr uchcom 4 ,
95.Xr uftdi 4 ,
96.Xr ugensa 4 ,
97.Xr uhmodem 4 ,
98.Xr uipaq 4 ,
99.Xr ukyopon 4 ,
100.Xr umcs 4 ,
101.Xr umct 4 ,
102.Xr umodem 4 ,
103.Xr uplcom 4 ,
104.Xr usb 4 ,
105.Xr uslsa 4 ,
106.Xr uvisor 4 ,
107.Xr uvscom 4 ,
108.Xr uxrcom 4
109.Sh HISTORY
110The
111.Nm
112driver
113appeared in
114.Nx 1.5 .
115