xref: /freebsd/share/man/man4/ucycom.4 (revision d7d962ead0b6e5e8a39202d0590022082bf5bfb6)
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 hid"
43.Cd "device ucom"
44.Cd "device ucycom"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51ucycom_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for the Cypress CY7C63743 and CY7C64013 bridge
57chips.
58These chips were designed to provide a low-cost transition path to USB
59for existing RS232 devices, and have fairly limited capabilities.
60.Pp
61The
62.Nm
63driver behaves like a
64.Xr tty 4 .
65.Sh HARDWARE
66The
67.Nm
68driver currently supports the following devices which incorporate
69Cypress USB to RS232 bridge chips:
70.Pp
71.Bl -bullet -compact
72.It
73DeLorme Earthmate USB GPS receiver
74.El
75.Sh FILES
76.Bl -tag -width "/dev/ttyU*.init" -compact
77.It Pa /dev/ttyU*
78for callin ports
79.It Pa /dev/ttyU*.init
80.It Pa /dev/ttyU*.lock
81corresponding callin initial-state and lock-state devices
82.Pp
83.It Pa /dev/cuaU*
84for callout ports
85.It Pa /dev/cuaU*.init
86.It Pa /dev/cuaU*.lock
87corresponding callout initial-state and lock-state devices
88.El
89.Sh SEE ALSO
90.Xr tty 4 ,
91.Xr ucom 4 ,
92.Xr usb 4
93.Sh HISTORY
94The
95.Nm
96driver first appeared in
97.Fx 5.3 .
98.Sh AUTHORS
99.An -nosplit
100The
101.Nm
102driver and this manual page were written by
103.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
104