xref: /freebsd/share/man/man4/uchcom.4 (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1.\" $NetBSD: uchcom.4,v 1.2 2008/04/30 13:10:54 martin Exp $
2.\"
3.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Takuya SHIOZAKI (tshiozak@netbsd.org).
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 April 26, 2017
33.Dt UCHCOM 4
34.Os
35.Sh NAME
36.Nm uchcom
37.Nd WinChipHead CH341/CH340 serial adapter driver
38.Sh SYNOPSIS
39To compile this driver into the kernel,
40place the following lines in your
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device usb"
44.Cd "device ucom"
45.Cd "device uchcom"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52uchcom_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for the WinChipHead CH341/CH340 USB-to-RS-232
58Bridge chip.
59.Pp
60The device is accessed through the
61.Xr ucom 4
62driver which makes it behave like a
63.Xr tty 4 .
64.Sh HARDWARE
65The
66.Nm
67driver supports the following adapters:
68.Pp
69.Bl -bullet -compact
70.It
71HL USB-RS232
72.El
73.Sh FILES
74.Bl -tag -width "/dev/ttyU*.init" -compact
75.It Pa /dev/ttyU*
76for callin ports
77.It Pa /dev/ttyU*.init
78.It Pa /dev/ttyU*.lock
79corresponding callin initial-state and lock-state devices
80.Pp
81.It Pa /dev/cuaU*
82for callout ports
83.It Pa /dev/cuaU*.init
84.It Pa /dev/cuaU*.lock
85corresponding 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
92The
93.Nm
94driver first appeared in
95.Nx .
96The first
97.Fx
98release to include it was
99.Fx 8.0 .
100.Sh BUGS
101Actually, this chip seems unable to drive other than 8 data bits and
1021 stop bit line.
103