share/man/man4/ucycom.4

   1 .\"-
   2 .\" Copyright (c) 2004 Dag-Erling Coïdan Smørgrav
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd April 26, 2017
  29 .Dt UCYCOM 4
  30 .Os
  31 .Sh NAME
  32 .Nm ucycom
  33 .Nd device driver for Cypress CY7C63743 and CY7C64013 USB to RS232 bridges
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device usb"
  40 .Cd "device hid"
  41 .Cd "device ucom"
  42 .Cd "device ucycom"
  43 .Ed
  44 .Pp
  45 Alternatively, to load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 ucycom_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver provides support for the Cypress CY7C63743 and CY7C64013 bridge
  55 chips.
  56 These chips were designed to provide a low-cost transition path to USB
  57 for existing RS232 devices, and have fairly limited capabilities.
  58 .Pp
  59 The
  60 .Nm
  61 driver behaves like a
  62 .Xr tty 4 .
  63 .Sh HARDWARE
  64 The
  65 .Nm
  66 driver currently supports the following devices which incorporate
  67 Cypress USB to RS232 bridge chips:
  68 .Pp
  69 .Bl -bullet -compact
  70 .It
  71 DeLorme Earthmate USB GPS receiver
  72 .El
  73 .Sh FILES
  74 .Bl -tag -width "/dev/ttyU*.init" -compact
  75 .It Pa /dev/ttyU*
  76 for callin ports
  77 .It Pa /dev/ttyU*.init
  78 .It Pa /dev/ttyU*.lock
  79 corresponding callin initial-state and lock-state devices
  80 .Pp
  81 .It Pa /dev/cuaU*
  82 for callout ports
  83 .It Pa /dev/cuaU*.init
  84 .It Pa /dev/cuaU*.lock
  85 corresponding callout initial-state and lock-state devices
  86 .El
  87 .Sh SEE ALSO
  88 .Xr tty 4 ,
  89 .Xr ucom 4 ,
  90 .Xr usb 4
  91 .Sh HISTORY
  92 The
  93 .Nm
  94 driver first appeared in
  95 .Fx 5.3 .
  96 .Sh AUTHORS
  97 .An -nosplit
  98 The
  99 .Nm
 100 driver and this manual page were written by
 101 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .