share/man/man4/ucom.4

   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
  39 To compile this driver into the kernel,
  40 place the following line in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  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 ucom_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver attaches to USB modems, serial ports, and other devices that need
  56 to look like a tty.
  57 The
  58 .Nm
  59 driver shows a behavior like a
  60 .Xr tty 4 .
  61 This means that normal programs such as
  62 .Xr tip 1
  63 or
  64 .Xr ppp 8
  65 can be used to access the device.
  66 .Sh Pulse Per Second (PPS) Timing Interface
  67 The
  68 .Nm
  69 driver can capture PPS timing information as defined in RFC 2783.
  70 The API, accessed via
  71 .Xr ioctl 8 ,
  72 is available on the tty device.
  73 To use the PPS capture feature with
  74 .Xr ntpd 8 ,
  75 symlink the tty device to
  76 .Va /dev/pps0.
  77 .Pp
  78 The
  79 .Va hw.usb.ucom.pps_mode
  80 sysctl configures the PPS capture mode.
  81 It can be set in
  82 .Xr loader.conf 5
  83 or
  84 .Xr sysctl.conf 5 .
  85 The following capture modes are available:
  86 .Bl -tag -compact -offset "mmmm" -width "mmmm"
  87 .It 0
  88 Capture disabled (default).
  89 .It 1
  90 Capture pulses on the CTS line.
  91 .It 2
  92 Capture 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 uplcom 4 ,
 108 .Xr usb 4 ,
 109 .Xr uvisor 4 ,
 110 .Xr uvscom 4
 111 .Sh HISTORY
 112 The
 113 .Nm
 114 driver was adopted from
 115 .Nx
 116 in March of 2002.
 117 This manual page was adopted from
 118 .Nx
 119 by
 120 .An Tom Rhodes Aq trhodes@FreeBSD.org
 121 in April 2002.
 122 .Sh BUGS
 123 Prior to
 124 .Fx 6.0
 125 .Nm
 126 created
 127 .Pa /dev/ucom?
 128 rather than the uniform device names created today.
 129 Old scripts must be adjusted accordingly.