1.\" $NetBSD: ucom.4,v 1.9 2002/03/22 00:39:40 augustss 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.\" $FreeBSD$ 31.\" 32.Dd March 11, 2015 33.Dt UCOM 4 34.Os 35.Sh NAME 36.Nm ucom 37.Nd USB tty support 38.Sh SYNOPSIS 39To compile this driver into the kernel, 40place the following line in your 41kernel configuration file: 42.Bd -ragged -offset indent 43.Cd "device ucom" 44.Ed 45.Pp 46Alternatively, to load the driver as a 47module at boot time, place the following line in 48.Xr loader.conf 5 : 49.Bd -literal -offset indent 50ucom_load="YES" 51.Ed 52.Sh DESCRIPTION 53The 54.Nm 55driver attaches to USB modems, serial ports, and other devices that need 56to look like a tty. 57The 58.Nm 59driver shows a behavior like a 60.Xr tty 4 . 61This means that normal programs such as 62.Xr tip 1 63or 64.Xr ppp 8 65can be used to access the device. 66.Sh Pulse Per Second (PPS) Timing Interface 67The 68.Nm 69driver can capture PPS timing information as defined in RFC 2783. 70The API, accessed via 71.Xr ioctl 2 , 72is available on the tty device. 73To use the PPS capture feature with 74.Xr ntpd 8 , 75symlink the tty device to 76.Va /dev/pps0. 77.Pp 78The 79.Va hw.usb.ucom.pps_mode 80sysctl configures the PPS capture mode. 81It can be set in 82.Xr loader.conf 5 83or 84.Xr sysctl.conf 5 . 85The following capture modes are available: 86.Bl -tag -compact -offset "mmmm" -width "mmmm" 87.It 0 88Capture disabled (default). 89.It 1 90Capture pulses on the CTS line. 91.It 2 92Capture pulses on the DCD line. 93.El 94.Sh FILES 95.Bl -tag -width ".Pa /dev/cuaU?" 96.It Pa /dev/cuaU? 97.It Pa /dev/ttyU? 98.El 99.Sh SEE ALSO 100.Xr tty 4 , 101.Xr uark 4 , 102.Xr uchcom 4 , 103.Xr uftdi 4 , 104.Xr umcs 4 , 105.Xr umct 4 , 106.Xr umodem 4 , 107.Xr umoscom 4 , 108.Xr uplcom 4 , 109.Xr usb 4 , 110.Xr uslcom 4 , 111.Xr uvisor 4 , 112.Xr uvscom 4 113.Sh HISTORY 114The 115.Nm 116driver was adopted from 117.Nx 118in March of 2002. 119This manual page was adopted from 120.Nx 121by 122.An Tom Rhodes Aq Mt trhodes@FreeBSD.org 123in April 2002. 124.Sh BUGS 125Prior to 126.Fx 6.0 127.Nm 128created 129.Pa /dev/ucom? 130rather than the uniform device names created today. 131Old scripts must be adjusted accordingly. 132