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 July 11, 2020 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 SYSCTL VARIABLES 67The following variables are available as both 68.Xr sysctl 8 69variables and 70.Xr loader 8 71tunables: 72.Bl -tag -width indent 73.It Va hw.usb.ucom.debug 74Debug output level, where 0 is debugging disabled and larger values increase 75debug message verbosity. 76Default is 0. 77.It Va hw.usb.ucom.device_mode_console 78When set to 1, the 79.Nm 80driver will mark terminals as console devices when operating in device mode. 81Default is 1. 82.It Va hw.usb.ucom.pps_mode 83Enables and configure PPS capture mode as described below. 84.El 85.Sh Pulse Per Second (PPS) Timing Interface 86The 87.Nm 88driver can capture PPS timing information as defined in RFC 2783. 89The API, accessed via 90.Xr ioctl 2 , 91is available on the tty device. 92To use the PPS capture feature with 93.Xr ntpd 8 , 94symlink the tty device to 95.Va /dev/pps0. 96.Pp 97The 98.Va hw.usb.ucom.pps_mode 99sysctl configures the PPS capture mode. 100It can be set in 101.Xr loader.conf 5 102or 103.Xr sysctl.conf 5 . 104The following capture modes are available: 105.Bl -tag -compact -offset "mmmm" -width "mmmm" 106.It 0 107Capture disabled (default). 108.It 1 109Capture pulses on the CTS line. 110.It 2 111Capture pulses on the DCD line. 112.El 113.Sh FILES 114.Bl -tag -width "/dev/ttyU*.init" -compact 115.It Pa /dev/ttyU* 116for callin ports 117.It Pa /dev/ttyU*.init 118.It Pa /dev/ttyU*.lock 119corresponding callin initial-state and lock-state devices 120.Pp 121.It Pa /dev/cuaU* 122for callout ports 123.It Pa /dev/cuaU*.init 124.It Pa /dev/cuaU*.lock 125corresponding callout initial-state and lock-state devices 126.El 127.Sh SEE ALSO 128.Xr cu 1 , 129.Xr tty 4 , 130.Xr uark 4 , 131.Xr ubsa 4 , 132.Xr ubser 4 , 133.Xr uchcom 4 , 134.Xr ucycom 4 , 135.Xr ufoma 4 , 136.Xr uftdi 4 , 137.Xr uhso 4 , 138.\".Xr ugensa 4 , 139.Xr uipaq 4 , 140.Xr umcs 4 , 141.Xr umct 4 , 142.Xr umodem 4 , 143.Xr umoscom 4 , 144.Xr uplcom 4 , 145.Xr usb 4 , 146.Xr uslcom 4 , 147.Xr uvisor 4 , 148.Xr uvscom 4 , 149.Xr ttys 5 150.Sh HISTORY 151The 152.Nm 153driver was adopted from 154.Nx 155in March of 2002. 156This manual page was adopted from 157.Nx 158by 159.An Tom Rhodes Aq Mt trhodes@FreeBSD.org 160in April 2002. 161.Sh BUGS 162Prior to 163.Fx 6.0 164.Nm 165created 166.Pa /dev/ucom? 167rather than the uniform device names created today. 168Old scripts must be adjusted accordingly. 169