From b32d5fae5fbd0fad29ef1840d63da557c2df10b3 Mon Sep 17 00:00:00 2001 From: Christian Brueffer Date: Sat, 1 Mar 2008 13:05:03 +0000 Subject: [PATCH] Manpage for the uchcom(4) driver, adapted from the one in NetBSD. --- share/man/man4/Makefile | 1 + share/man/man4/uchcom.4 | 94 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+) create mode 100644 share/man/man4/uchcom.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 6ebbfafe6cfe..9546bfceaf73 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -372,6 +372,7 @@ MAN= aac.4 \ ubsec.4 \ ubser.4 \ ubtbcmfw.4 \ + uchcom.4 \ ucom.4 \ ucycom.4 \ udav.4 \ diff --git a/share/man/man4/uchcom.4 b/share/man/man4/uchcom.4 new file mode 100644 index 000000000000..6b127ae3a2a2 --- /dev/null +++ b/share/man/man4/uchcom.4 @@ -0,0 +1,94 @@ +.\" $NetBSD: uchcom.4,v 1.1 2007/09/03 18:02:17 tshiozak Exp $ +.\" +.\" Copyright (c) 2007 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Takuya SHIOZAKI (tshiozak@netbsd.org). +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. Neither the name of The NetBSD Foundation nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd March 1, 2008 +.Dt UCHCOM 4 +.Os +.Sh NAME +.Nm uchcom +.Nd WinChipHead CH341/CH340 serial adapter driver +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device uchcom" +.Cd "device ucom" +.Ed +.\".Pp +.\"Alternatively, to load the driver as a +.\"module at boot time, place the following line in +.\".Xr loader.conf 5 : +.\".Bd -literal -offset indent +.\"uchcom_load="YES" +.\".Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for the WinChipHead CH341/CH340 USB-to-RS-232 +Bridge chip. +.Pp +The device is accessed through the +.Xr ucom 4 +driver which makes it behave like a +.Xr tty 4 . +.Sh HARDWARE +The +.Nm +driver supports the following adapters: +.Pp +.Bl -bullet -compact +.It +HL USB-RS232 +.El +.Sh SEE ALSO +.Xr tty 4 , +.Xr ucom 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Nx . +The first +.Fx +release to include it was +.Fx 7.0 . +.Sh BUGS +Actually, this chip seems unable to drive other than 8 data bits and +1 stop bit line.