1 .\" $NetBSD: ucom.4,v 1.9 2002/03/22 00:39:40 augustss Exp $
3 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Lennart Augustsson.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
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.
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.
39 To compile this driver into the kernel,
40 place the following line in your
41 kernel configuration file:
42 .Bd -ragged -offset indent
46 Alternatively, to load the driver as a
47 module at boot time, place the following line in
49 .Bd -literal -offset indent
55 driver attaches to USB modems, serial ports, and other devices that need
59 driver shows a behavior like a
61 This means that normal programs such as
65 can be used to access the device.
67 The following variables are available as both
72 .Bl -tag -width indent
73 .It Va hw.usb.ucom.debug
74 Debug output level, where 0 is debugging disabled and larger values increase
75 debug message verbosity.
77 .It Va hw.usb.ucom.device_mode_console
80 driver will mark terminals as console devices when operating in device mode.
82 .It Va hw.usb.ucom.pps_mode
83 Enables and configure PPS capture mode as described below.
84 .Sh Pulse Per Second (PPS) Timing Interface
87 driver can capture PPS timing information as defined in RFC 2783.
90 is available on the tty device.
91 To use the PPS capture feature with
93 symlink the tty device to
97 .Va hw.usb.ucom.pps_mode
98 sysctl configures the PPS capture mode.
103 The following capture modes are available:
104 .Bl -tag -compact -offset "mmmm" -width "mmmm"
106 Capture disabled (default).
108 Capture pulses on the CTS line.
110 Capture pulses on the DCD line.
113 .Bl -tag -width "/dev/ttyU*.init" -compact
116 .It Pa /dev/ttyU*.init
117 .It Pa /dev/ttyU*.lock
118 corresponding callin initial-state and lock-state devices
122 .It Pa /dev/cuaU*.init
123 .It Pa /dev/cuaU*.lock
124 corresponding callout initial-state and lock-state devices
150 driver was adopted from
153 This manual page was adopted from
156 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org
164 rather than the uniform device names created today.
165 Old scripts must be adjusted accordingly.