xref: /freebsd/share/man/man4/uchcom.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1314a700eSChristian Brueffer.\" $NetBSD: uchcom.4,v 1.2 2008/04/30 13:10:54 martin Exp $
2b32d5faeSChristian Brueffer.\"
3b32d5faeSChristian Brueffer.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
4b32d5faeSChristian Brueffer.\" All rights reserved.
5b32d5faeSChristian Brueffer.\"
6b32d5faeSChristian Brueffer.\" This code is derived from software contributed to The NetBSD Foundation
7b32d5faeSChristian Brueffer.\" by Takuya SHIOZAKI (tshiozak@netbsd.org).
8b32d5faeSChristian Brueffer.\"
9b32d5faeSChristian Brueffer.\" Redistribution and use in source and binary forms, with or without
10b32d5faeSChristian Brueffer.\" modification, are permitted provided that the following conditions
11b32d5faeSChristian Brueffer.\" are met:
12b32d5faeSChristian Brueffer.\" 1. Redistributions of source code must retain the above copyright
13b32d5faeSChristian Brueffer.\"    notice, this list of conditions and the following disclaimer.
14b32d5faeSChristian Brueffer.\" 2. Redistributions in binary form must reproduce the above copyright
15b32d5faeSChristian Brueffer.\"    notice, this list of conditions and the following disclaimer in the
16b32d5faeSChristian Brueffer.\"    documentation and/or other materials provided with the distribution.
17b32d5faeSChristian Brueffer.\"
18b32d5faeSChristian Brueffer.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19b32d5faeSChristian Brueffer.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20b32d5faeSChristian Brueffer.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21b32d5faeSChristian Brueffer.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22b32d5faeSChristian Brueffer.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23b32d5faeSChristian Brueffer.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24b32d5faeSChristian Brueffer.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25b32d5faeSChristian Brueffer.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26b32d5faeSChristian Brueffer.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27b32d5faeSChristian Brueffer.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28b32d5faeSChristian Brueffer.\" POSSIBILITY OF SUCH DAMAGE.
29b32d5faeSChristian Brueffer.\"
304f4acb65SEdward Tomasz Napierala.Dd April 26, 2017
31b32d5faeSChristian Brueffer.Dt UCHCOM 4
32b32d5faeSChristian Brueffer.Os
33b32d5faeSChristian Brueffer.Sh NAME
34b32d5faeSChristian Brueffer.Nm uchcom
35b32d5faeSChristian Brueffer.Nd WinChipHead CH341/CH340 serial adapter driver
36b32d5faeSChristian Brueffer.Sh SYNOPSIS
37b32d5faeSChristian BruefferTo compile this driver into the kernel,
38b32d5faeSChristian Bruefferplace the following lines in your
39b32d5faeSChristian Bruefferkernel configuration file:
40b32d5faeSChristian Brueffer.Bd -ragged -offset indent
4199fc5899SMartin Wilke.Cd "device usb"
4299fc5899SMartin Wilke.Cd "device ucom"
43b32d5faeSChristian Brueffer.Cd "device uchcom"
44b32d5faeSChristian Brueffer.Ed
45a9754a75SChristian Brueffer.Pp
46a9754a75SChristian BruefferAlternatively, to load the driver as a
47a9754a75SChristian Brueffermodule at boot time, place the following line in
48a9754a75SChristian Brueffer.Xr loader.conf 5 :
49a9754a75SChristian Brueffer.Bd -literal -offset indent
50a9754a75SChristian Bruefferuchcom_load="YES"
51a9754a75SChristian Brueffer.Ed
52b32d5faeSChristian Brueffer.Sh DESCRIPTION
53b32d5faeSChristian BruefferThe
54b32d5faeSChristian Brueffer.Nm
55b32d5faeSChristian Bruefferdriver provides support for the WinChipHead CH341/CH340 USB-to-RS-232
56b32d5faeSChristian BruefferBridge chip.
57b32d5faeSChristian Brueffer.Pp
58b32d5faeSChristian BruefferThe device is accessed through the
59b32d5faeSChristian Brueffer.Xr ucom 4
60b32d5faeSChristian Bruefferdriver which makes it behave like a
61b32d5faeSChristian Brueffer.Xr tty 4 .
62b32d5faeSChristian Brueffer.Sh HARDWARE
63b32d5faeSChristian BruefferThe
64b32d5faeSChristian Brueffer.Nm
65b32d5faeSChristian Bruefferdriver supports the following adapters:
66b32d5faeSChristian Brueffer.Pp
67b32d5faeSChristian Brueffer.Bl -bullet -compact
68b32d5faeSChristian Brueffer.It
69b32d5faeSChristian BruefferHL USB-RS232
70b32d5faeSChristian Brueffer.El
714f4acb65SEdward Tomasz Napierala.Sh FILES
72*fa196deaSEdward Tomasz Napierala.Bl -tag -width "/dev/ttyU*.init" -compact
73*fa196deaSEdward Tomasz Napierala.It Pa /dev/ttyU*
744f4acb65SEdward Tomasz Napieralafor callin ports
75*fa196deaSEdward Tomasz Napierala.It Pa /dev/ttyU*.init
76*fa196deaSEdward Tomasz Napierala.It Pa /dev/ttyU*.lock
774f4acb65SEdward Tomasz Napieralacorresponding callin initial-state and lock-state devices
784f4acb65SEdward Tomasz Napierala.Pp
79*fa196deaSEdward Tomasz Napierala.It Pa /dev/cuaU*
804f4acb65SEdward Tomasz Napieralafor callout ports
81*fa196deaSEdward Tomasz Napierala.It Pa /dev/cuaU*.init
82*fa196deaSEdward Tomasz Napierala.It Pa /dev/cuaU*.lock
834f4acb65SEdward Tomasz Napieralacorresponding callout initial-state and lock-state devices
844f4acb65SEdward Tomasz Napierala.El
85b32d5faeSChristian Brueffer.Sh SEE ALSO
86b32d5faeSChristian Brueffer.Xr tty 4 ,
87b32d5faeSChristian Brueffer.Xr ucom 4 ,
88b32d5faeSChristian Brueffer.Xr usb 4
89b32d5faeSChristian Brueffer.Sh HISTORY
90b32d5faeSChristian BruefferThe
91b32d5faeSChristian Brueffer.Nm
92b32d5faeSChristian Bruefferdriver first appeared in
93b32d5faeSChristian Brueffer.Nx .
94b32d5faeSChristian BruefferThe first
95b32d5faeSChristian Brueffer.Fx
96b32d5faeSChristian Bruefferrelease to include it was
97314a700eSChristian Brueffer.Fx 8.0 .
98b32d5faeSChristian Brueffer.Sh BUGS
99b32d5faeSChristian BruefferActually, this chip seems unable to drive other than 8 data bits and
100b32d5faeSChristian Brueffer1 stop bit line.
101