xref: /freebsd/share/man/man4/uchcom.4 (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
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.Dd April 26, 2017
31.Dt UCHCOM 4
32.Os
33.Sh NAME
34.Nm uchcom
35.Nd WinChipHead CH341/CH340 serial adapter driver
36.Sh SYNOPSIS
37To compile this driver into the kernel,
38place the following lines in your
39kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device usb"
42.Cd "device ucom"
43.Cd "device uchcom"
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
50uchcom_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for the WinChipHead CH341/CH340 USB-to-RS-232
56Bridge chip.
57.Pp
58The device is accessed through the
59.Xr ucom 4
60driver which makes it behave like a
61.Xr tty 4 .
62.Sh HARDWARE
63The
64.Nm
65driver supports the following adapters:
66.Pp
67.Bl -bullet -compact
68.It
69HL USB-RS232
70.El
71.Sh FILES
72.Bl -tag -width "/dev/ttyU*.init" -compact
73.It Pa /dev/ttyU*
74for callin ports
75.It Pa /dev/ttyU*.init
76.It Pa /dev/ttyU*.lock
77corresponding callin initial-state and lock-state devices
78.Pp
79.It Pa /dev/cuaU*
80for callout ports
81.It Pa /dev/cuaU*.init
82.It Pa /dev/cuaU*.lock
83corresponding callout initial-state and lock-state devices
84.El
85.Sh SEE ALSO
86.Xr tty 4 ,
87.Xr ucom 4 ,
88.Xr usb 4
89.Sh HISTORY
90The
91.Nm
92driver first appeared in
93.Nx .
94The first
95.Fx
96release to include it was
97.Fx 8.0 .
98.Sh BUGS
99Actually, this chip seems unable to drive other than 8 data bits and
1001 stop bit line.
101