xref: /freebsd/share/man/man4/ucycom.4 (revision b9f654b163bce26de79705e77b872427c9f2afa1)
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.\" $FreeBSD$
29.\"
30.Dd April 26, 2017
31.Dt UCYCOM 4
32.Os
33.Sh NAME
34.Nm ucycom
35.Nd device driver for Cypress CY7C63743 and CY7C64013 USB to RS232 bridges
36.Sh SYNOPSIS
37To compile this driver into the kernel,
38place the following line in your
39kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device usb"
42.Cd "device ucom"
43.Cd "device ucycom"
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
50ucycom_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for the Cypress CY7C63743 and CY7C64013 bridge
56chips.
57These chips were designed to provide a low-cost transition path to USB
58for existing RS232 devices, and have fairly limited capabilities.
59.Pp
60The
61.Nm
62driver behaves like a
63.Xr tty 4 .
64.Sh HARDWARE
65The
66.Nm
67driver currently supports the following devices which incorporate
68Cypress USB to RS232 bridge chips:
69.Pp
70.Bl -bullet -compact
71.It
72DeLorme Earthmate USB GPS receiver
73.El
74.Sh FILES
75.Bl -tag -width "/dev/ttyU*.init" -compact
76.It Pa /dev/ttyU*
77for callin ports
78.It Pa /dev/ttyU*.init
79.It Pa /dev/ttyU*.lock
80corresponding callin initial-state and lock-state devices
81.Pp
82.It Pa /dev/cuaU*
83for callout ports
84.It Pa /dev/cuaU*.init
85.It Pa /dev/cuaU*.lock
86corresponding callout initial-state and lock-state devices
87.El
88.Sh SEE ALSO
89.Xr tty 4 ,
90.Xr ucom 4 ,
91.Xr usb 4
92.Sh HISTORY
93The
94.Nm
95driver first appeared in
96.Fx 5.3 .
97.Sh AUTHORS
98.An -nosplit
99The
100.Nm
101driver and this manual page were written by
102.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
103