From: Sascha Wildner Date: Tue, 11 Mar 2014 10:57:13 +0000 (+0100) Subject: Add some USB serial driver manpages from FreeBSD. X-Git-Tag: v3.9.0~368 X-Git-Url: https://gitweb.dragonflybsd.org/~tuxillo/dragonfly.git/commitdiff_plain/4d6d0d0dfb28befba604c08220058df8e63579bc Add some USB serial driver manpages from FreeBSD. u3g(4) ubser(4) ucycom(4) uipaq(4) umcs(4) --- diff --git a/Makefile_upgrade.inc b/Makefile_upgrade.inc index 4338672730..d921807ce7 100644 --- a/Makefile_upgrade.inc +++ b/Makefile_upgrade.inc @@ -2474,15 +2474,25 @@ TO_REMOVE+=/usr/share/man/man8/usbdevs.8.gz TO_REMOVE+=/boot/kernel/if_udav.ko TO_REMOVE+=/boot/kernel/ohci.ko TO_REMOVE+=/boot/kernel/u3g.ko +TO_REMOVE+=/usr/share/man/cat4/u3g.4.gz +TO_REMOVE+=/usr/share/man/man4/u3g.4.gz TO_REMOVE+=/boot/kernel/uaudio.ko TO_REMOVE+=/boot/kernel/ubser.ko +TO_REMOVE+=/usr/share/man/cat4/ubser.4.gz +TO_REMOVE+=/usr/share/man/man4/ubser.4.gz TO_REMOVE+=/boot/kernel/ucycom.ko +TO_REMOVE+=/usr/share/man/cat4/ucycom.4.gz +TO_REMOVE+=/usr/share/man/man4/ucycom.4.gz TO_REMOVE+=/boot/kernel/uep.ko TO_REMOVE+=/boot/kernel/uether.ko TO_REMOVE+=/boot/kernel/ufoma.ko TO_REMOVE+=/boot/kernel/uhci.ko TO_REMOVE+=/boot/kernel/uipaq.ko +TO_REMOVE+=/usr/share/man/cat4/uipaq.4.gz +TO_REMOVE+=/usr/share/man/man4/uipaq.4.gz TO_REMOVE+=/boot/kernel/umcs.ko +TO_REMOVE+=/usr/share/man/cat4/umcs.4.gz +TO_REMOVE+=/usr/share/man/man4/umcs.4.gz TO_REMOVE+=/boot/kernel/umoscom.ko TO_REMOVE+=/boot/kernel/usb_quirk.ko TO_REMOVE+=/boot/kernel/usfs.ko diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 62f10d63e7..52af459db3 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -520,9 +520,14 @@ MLINKS+=xl.4 if_xl.4 MAN+= rum.4 \ run.4 \ runfw.4 \ + ubser.4 \ + ucycom.4 \ + uipaq.4 \ + umcs.4 \ urtwn.4 \ urtwnfw.4 \ - usb_quirk.4 + usb_quirk.4 \ + u3g.4 MLINKS+=rum.4 if_rum.4 MLINKS+=run.4 if_run.4 MLINKS+=urtwn.4 if_urtwn.4 diff --git a/share/man/man4/u3g.4 b/share/man/man4/u3g.4 new file mode 100644 index 0000000000..be563e6892 --- /dev/null +++ b/share/man/man4/u3g.4 @@ -0,0 +1,127 @@ +.\" +.\" Copyright (c) 2008 AnyWi Technologies +.\" All rights reserved. +.\" +.\" This code is derived from uark.c +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" $FreeBSD: head/share/man/man4/u3g.4 258662 2013-11-26 19:51:53Z joel $ +.\" +.Dd November 26, 2013 +.Dt U3G 4 +.Os +.Sh NAME +.Nm u3g +.Nd USB support for 3G datacards +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device usb" +.Cd "device ucom" +.Cd "device u3g" +.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 +u3g_load="YES" +.Ed +.Pp +If neither of the above is done, the driver will automatically be loaded +by devd(8) when the device is connected. +.Sh DESCRIPTION +The +.Nm +driver provides support for the multiple USB-to-serial interfaces exposed by +many 3G USB/PCCard modems. +.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 +Option GT 3G Fusion, GT Fusion Quad, etc. (only 3G part, not WLAN) +.It +Option GT 3G, GT 3G Quad, etc. +.It +Vodafone Mobile Connect Card 3G +.It +Vodafone Mobile Broadband K3772-Z +.It +Qualcomm Inc. CDMA MSM +.It +Huawei B190, E180v, E220 ('') +.It +Novatel U740, MC950D, X950D, etc. +.It +Sierra MC875U, MC8775U, etc. +.El +.Pp +(See +.Pa /sys/bus/u4b/serial/u3g.c +for the complete list of supported cards for each vendor +mentioned above.) +.Pp +The supported 3G cards provide the necessary modem port for ppp, or mpd +connections as well as extra ports (depending on the specific device) to +provide other functions (additional command port, diagnostic port, SIM toolkit +port). +.Pp +In some of these devices a mass storage device supported by the +.Xr umass 4 +driver is present which contains Windows and Mac OS X drivers. +The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires +additional commands to switch it to modem mode. If your device is not +switching automatically, please try to add quirks. See +.Xr usbconfig 8 +and +.Xr usb_quirk 4 . +.Sh SEE ALSO +.Xr tty 4 , +.Xr ucom 4 , +.Xr usb 4 , +.Xr usb_quirk 4 , +.Xr devd 8 , +.Xr usbconfig 8 +.Sh HISTORY +The +.Nm +driver appeared in +.Fx 7.2 , +is based on the +.Xr uark 4 +driver, and written by +.An Andrea Guzzo Aq Mt aguzzo@anywi.com +in September 2008. +.Sh AUTHORS +The +.Nm +driver was written by +.An Andrea Guzzo Aq Mt aguzzo@anywi.com +and +.An Nick Hibma Aq Mt n_hibma@FreeBSD.org . +Hardware for testing was provided by AnyWi Technologies, Leiden, NL. +.Sh BUGS +The automatic mode switch from disk mode to modem mode does not work unless +the driver is either built into the kernel or loaded before the device is +connected. diff --git a/share/man/man4/ubser.4 b/share/man/man4/ubser.4 new file mode 100644 index 0000000000..f1d29e014b --- /dev/null +++ b/share/man/man4/ubser.4 @@ -0,0 +1,69 @@ +.\" Copyright (c) 2004 Bernd Walter +.\" +.\" $URL: https://devel.bwct.de/svn/projects/ubser/ubser.4 $ +.\" $Date: 2004-02-29 21:54:17 +0100 (Sun, 29 Feb 2004) $ +.\" $Author: ticso $ +.\" $Rev: 1130 $ +.\" +.\" 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. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: head/share/man/man4/ubser.4 227750 2011-11-20 12:18:21Z miwi $ +.\" +.Dd November 20, 2011 +.Dt UBSER 4 +.Os +.Sh NAME +.Nm ubser +.Nd USB support for BWCT console serial adapters +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device usb" +.Cd "device ucom" +.Cd "device ubser" +.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 +ubser_load="YES" +.Ed +.Sh HARDWARE +The +.Nm +driver provides support for the BWCT console management serial adapters. +.Sh FILES +.Bl -tag -width ".Pa /dev/ttyy??" -compact +.It Pa /dev/ttyy?? +.El +.Sh SEE ALSO +.Xr tty 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +driver +appeared in +.Fx 5.2 . diff --git a/share/man/man4/ucycom.4 b/share/man/man4/ucycom.4 new file mode 100644 index 0000000000..31695face1 --- /dev/null +++ b/share/man/man4/ucycom.4 @@ -0,0 +1,87 @@ +.\"- +.\" Copyright (c) 2004 Dag-Erling Coïdan Smørgrav +.\" All rights reserved. +.\" +.\" 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. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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: head/share/man/man4/ucycom.4 227750 2011-11-20 12:18:21Z miwi $ +.\" +.Dd November 20, 2011 +.Dt UCYCOM 4 +.Os +.Sh NAME +.Nm ucycom +.Nd device driver for Cypress CY7C63743 and CY7C64013 USB to RS232 bridges +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following line in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device usb" +.Cd "device ucom" +.Cd "device ucycom" +.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 +ucycom_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for the Cypress CY7C63743 and CY7C64013 bridge +chips. +These chips were designed to provide a low-cost transition path to USB +for existing RS232 devices, and have fairly limited capabilities. +.Pp +The +.Nm +driver behaves like a +.Xr tty 4 . +.Sh HARDWARE +The +.Nm +driver currently supports the following devices which incorporate +Cypress USB to RS232 bridge chips: +.Pp +.Bl -bullet -compact +.It +DeLorme Earthmate USB GPS receiver +.El +.Sh SEE ALSO +.Xr tty 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 5.3 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver and this manual page were written by +.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org . diff --git a/share/man/man4/uipaq.4 b/share/man/man4/uipaq.4 new file mode 100644 index 0000000000..e869b0b932 --- /dev/null +++ b/share/man/man4/uipaq.4 @@ -0,0 +1,98 @@ +.\" $OpenBSD: uipaq.4,v 1.1 2005/06/17 23:50:35 deraadt Exp $ +.\" $NetBSD: uipaq.4,v 1.3 2008/04/30 13:10:54 martin Exp $ +.\" +.\" Copyright (c) 2001-2005 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Lennart Augustsson. +.\" +.\" 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. +.\" +.\" 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: head/share/man/man4/uipaq.4 233648 2012-03-29 05:02:12Z eadler $ +.\" +.Dd November 20, 2011 +.Dt UIPAQ 4 +.Os +.Sh NAME +.Nm uipaq +.Nd USB support for iPAQ units +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device usb" +.Cd "device ucom" +.Cd "device uipaq" +.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 +uipaq_load="YES" +.Ed +.Sh HARDWARE +The +.Nm +driver supports the following adapters: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It ASUS P535 PDA +.It Casio BE300 PDA +.It Compaq IPaq PocketPC +.It HP Jornada 568 +.It HP iPAQ 22xx/Jornada 548 +.It HTC PPC6700 Modem +.It HTC Smart Phone +.It HTC Winmobile +.It Sharp W-ZERO3 ES Spart Phone +.It Most Windows CE based phones +.El +.Sh DESCRIPTION +The +.Nm +driver provides support for the USB serial emulation provided +by the iPAQ devices. +.Pp +The device is accessed through the +.Xr ucom 4 +driver which makes it behave like a +.Xr tty 4 . +.Sh SEE ALSO +.Xr tty 4 , +.Xr ucom 4 , +.Xr uhub 4 , +.Xr usb 4 +.Sh HISTORY +The +.Fx +support was imported from +.Nx +for +.Fx 7.0 . +.Nx +added support in +.Nx 4.0 +and it was imported from +.Ox 3.8 . diff --git a/share/man/man4/umcs.4 b/share/man/man4/umcs.4 new file mode 100644 index 0000000000..111f253e27 --- /dev/null +++ b/share/man/man4/umcs.4 @@ -0,0 +1,101 @@ +.\" +.\" Copyright (c) 2010 Lev Serebryakov . +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Lennart Augustsson. +.\" +.\" 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. +.\" +.\" 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: head/share/man/man4/umcs.4 235317 2012-05-12 03:25:46Z gjb $ +.\" +.Dd February 25, 2012 +.Dt UMCS 4 +.Os +.Sh NAME +.Nm umcs +.Nd USB support for serial adapters based on the MCS7820 and MCS7840 chips +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device usb" +.Cd "device ucom" +.Cd "device umcs" +.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 +umcs_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for various multiport serial adapters based on the MosCom +MCS7820 and MCS7840 chips. +They are 2- or 4-port adapters with full-featured +16550-compatible UARTs and very flexible baud generators. +Also, these chips +support RS422/RS485 and IrDA operations. +.Pp +The device is accessed through the +.Xr ucom 4 +driver which makes it behave like a +.Xr tty 4 . +.Pp +Different ports on device are presented as sub-units, like +.Pa /dev/ttyU0.1 +and +.Pa /dev/ttyU0.2 . +.Sh HARDWARE +The +.Nm +driver was tested on the following adapters: +.Pp +.Bl -bullet -compact +.It +ST Lab U-360 two-port serial USB adapter +.It +ST Lab U-400 four-port serial USB adapter +.El +.Sh SEE ALSO +.Xr tty 4 , +.Xr ucom 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +driver +appeared in ports since December of 2010. +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Lev Serebryakov +.Aq Mt lev@FreeBSD.org . +.Sh BUGS +This driver doesn't support access to any fine tunes of +chip, like RS522/RS485 mode, non-standard baudrates, etc.