From: Sascha Wildner Date: Thu, 13 Mar 2014 09:21:30 +0000 (+0100) Subject: Sync ehci.4, ohci.4 and uhci.4 with FreeBSD. Bring in xhci.4. X-Git-Tag: v3.9.0~342 X-Git-Url: https://gitweb.dragonflybsd.org/~tuxillo/dragonfly.git/commitdiff_plain/7cc2100a55b362fea9bbf5143bb80ad40f24c11b Sync ehci.4, ohci.4 and uhci.4 with FreeBSD. Bring in xhci.4. --- diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 52af459db3..81b3e2c57d 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -373,6 +373,7 @@ MAN= aac.4 \ wlan_xauth.4 \ wpi.4 \ xe.4 \ + xhci.4 \ xl.4 \ xpt.4 \ zero.4 diff --git a/share/man/man4/ehci.4 b/share/man/man4/ehci.4 index 5e666e9c40..cdbdf7617c 100644 --- a/share/man/man4/ehci.4 +++ b/share/man/man4/ehci.4 @@ -1,4 +1,4 @@ -.\" $NetBSD: ehci.4,v 1.11 2004/06/22 09:12:48 wiz Exp $ +.\" $NetBSD: ehci.4,v 1.8 2001/11/21 17:22:56 augustss Exp $ .\" .\" Copyright (c) 2001 The NetBSD Foundation, Inc. .\" All rights reserved. @@ -14,13 +14,6 @@ .\" 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 @@ -34,7 +27,9 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd July 4, 2010 +.\" $FreeBSD: head/share/man/man4/ehci.4 232507 2012-03-04 16:59:45Z eadler $ +.\" +.Dd March 13, 2014 .Dt EHCI 4 .Os .Sh NAME @@ -45,44 +40,62 @@ .Sh DESCRIPTION The .Nm -driver provides support for the USB Enhanced Host Controller Interface, -which is used by USB 2.0 controllers. +driver provides support for the +.Tn USB +Enhanced Host Controller Interface, +which is used by +.Tn USB +2.0 controllers. .Pp -EHCI controllers are peculiar in that they can only handle the USB 2.0 -protocol. +.Tn EHCI +controllers are peculiar in that they can only handle the +.Tn USB +2.0 protocol. This means that they normally have one or more companion controllers (i.e., .Xr ohci 4 or .Xr uhci 4 ) handling USB 1.x devices. -Consequently each USB connector is electrically connected to two -USB controllers. -The handling of this is totally automatic, but can be noticed since -USB 1.x and USB 2.0 devices plugged into the same connector appear -to connect to different USB busses. -.Pp -The -.Nm -driver is automatically loaded upon boot. -To disable this behavior temporarily, the -.Va ehci_load -variable can be unset at the loader prompt (see -.Xr loader 8 ) . -To disable it permanently, the -.Va hint.ehci.0.disabled -tunable can be set to 1 in -.Pa /boot/loader.conf . +Consequently each +.Tn USB +connector is electrically connected to two +.Tn USB +controllers. +The handling of this is totally automatic, +but can be noticed since +.Tn USB +1.x and +.Tn USB +2.0 devices plugged in to the same +connector appear to connect to different USB busses. .Sh SEE ALSO -.Xr cardbus 4 , .Xr ohci 4 , -.Xr pci 4 , .Xr uhci 4 , -.Xr usb 4 +.Xr usb 4 , +.Xr xhci 4 .Sh HISTORY The .Nm -driver appeared in -.Dx 1.0 . -.Sh BUGS -There is no support (yet) for interrupt or isochronous transfers. +device driver first appeared in +.Fx 5.1 . +.Sh LOADER TUNABLES +When the kernel has been compiled with +.Cd options USB_DEBUG , +some tunables become available that affect the behavior of +.Nm . +These tunables can be set at the +.Xr loader 8 +prompt before booting the kernel or stored in +.Xr loader.conf 5 . +.Bl -tag -width "xxxxxx" +.It Va hw.usb.ehci.lostintrbug +This tunable enables the lost interrupt quirk. +The default value is 0 (off). +.It Va hw.usb.ehci.iaadbug +This tunable enables the EHCI doorbell quirk. +The default value is 0 (off). +.It Va hw.usb.ehci.no_hs +This tunable disables USB devices to attach like HIGH-speed ones and will force all attached devices to attach to the FULL- or LOW-speed companion controller. +The default value is 0 (off). +.El diff --git a/share/man/man4/ohci.4 b/share/man/man4/ohci.4 index aec843381f..06d18f9cfc 100644 --- a/share/man/man4/ohci.4 +++ b/share/man/man4/ohci.4 @@ -9,28 +9,22 @@ .\" 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 Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. .\" -.\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND +.\" 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 NICK HIBMA OR THE VOICES IN HIS HEAD -.\" 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. +.\" 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: src/share/man/man4/ohci.4,v 1.8.2.4 2001/08/17 13:08:39 ru Exp $ +.\" $FreeBSD: head/share/man/man4/ohci.4 219004 2011-02-24 18:08:23Z hselasky $ .\" -.Dd November 26, 2006 +.Dd March 13, 2014 .Dt OHCI 4 .Os .Sh NAME @@ -42,28 +36,33 @@ The .Nm driver provides support for OHCI-type PCI based USB controllers. -This -includes -.Bl -tag -width xxxxx -.It AcerLabs M5237 (Aladdin-V) -.It AMD-756 -.It AMD-766 -.It Apple KeyLargo -.It ATI SB400 -.It CMD Tech 670 (USB0670) -.It CMD Tech 673 (USB0673) -.It NEC uPD 9210 -.It NVIDIA nForce2 -.It NVIDIA nForce3 -.It OPTi 82C861 (FireLink) -.It SiS 5571 -.It Sun PCIO-2 -.El +.Sh HARDWARE +The +.Nm +driver supports all OHCI v1.0 compliant controllers including: .Pp -or any other OHCI v1.0 compliant controller. +.Bl -bullet -compact +.It +AcerLabs M5237 (Aladdin-V) +.It +AMD-756 +.It +OPTi 82C861 (FireLink) +.It +NEC uPD 9210 +.It +CMD Tech 670 (USB0670) +.It +CMD Tech 673 (USB0673) +.It +NVIDIA nForce3 +.It +Sun PCIO-2 (RIO USB) +.El .Sh SEE ALSO .Xr ehci 4 , -.Xr uhci 4 +.Xr uhci 4 , +.Xr xhci 4 .Sh HISTORY The .Nm diff --git a/share/man/man4/uhci.4 b/share/man/man4/uhci.4 index 1e2dbb50cf..7fef301adb 100644 --- a/share/man/man4/uhci.4 +++ b/share/man/man4/uhci.4 @@ -1,7 +1,6 @@ .\" Copyright (c) 1999 .\" Nick Hibma . All rights reserved. .\" -.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -10,28 +9,22 @@ .\" 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 Bill Paul. -.\" 4. Neither the name of the author nor the names of any co-contributors -.\" may be used to endorse or promote products derived from this software -.\" without specific prior written permission. .\" -.\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND +.\" 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 NICK HIBMA OR THE VOICES IN HIS HEAD -.\" 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. +.\" 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: src/share/man/man4/uhci.4,v 1.8.2.4 2001/08/17 13:08:39 ru Exp $ +.\" $FreeBSD: head/share/man/man4/uhci.4 219004 2011-02-24 18:08:23Z hselasky $ .\" -.Dd November 26, 2006 +.Dd March 13, 2014 .Dt UHCI 4 .Os .Sh NAME @@ -43,27 +36,23 @@ The .Nm driver provides support for UHCI-type PCI based USB controllers. -This -includes -.Bl -tag -width xxxxx -.It Intel 82371AB/EB (PIIX4) -.It Intel 82371SB (PIIX3) -.It Intel 82372FB/82468GX (460GX) -.It Intel 82443MX (440MX) -.It Intel 82801AA (ICH) -.It Intel 82801AB (ICH0) -.It Intel 82801BA/BAM (ICH2) -.It Intel 82801CA/CAM (ICH3) -.It Intel 82801DB (ICH4) -.It Intel 82801EB (ICH5) -.It Intel 82801FB (ICH6) -.It VIA 83C572 -.El +.Sh HARDWARE +The +.Nm +driver supports all UHCI v1.1 compliant controllers including: .Pp -or any other UHCI v1.1 compliant controller. +.Bl -bullet -compact +.It +Intel 82371AB/EB (PIIX4) +.It +Intel 82371SB (PIIX3) +.It +VIA 83C572 +.El .Sh SEE ALSO .Xr ehci 4 , -.Xr ohci 4 +.Xr ohci 4 , +.Xr xhci 4 .Sh HISTORY The .Nm diff --git a/share/man/man4/xhci.4 b/share/man/man4/xhci.4 new file mode 100644 index 0000000000..01d02d6a51 --- /dev/null +++ b/share/man/man4/xhci.4 @@ -0,0 +1,68 @@ +.\" +.\" Copyright (c) 2011 Hans Petter Selasky. 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. +.\" +.\" 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/xhci.4 222019 2011-05-17 11:26:59Z ru $ +.\" +.Dd March 13, 2014 +.Dt XHCI 4 +.Os +.Sh NAME +.Nm xhci +.Nd USB eXtensible Host Controller driver +.Sh SYNOPSIS +.Cd "device xhci" +.Sh DESCRIPTION +The +.Nm +driver provides support for the +.Tn USB +eXtensible Host Controller Interface, +which allows use of +.Tn USB +1.0, 2.0 and 3.0 devices on the same +.Tn USB +port. +.Pp +The +.Tn XHCI +controller supports +.Tn USB +connection speeds up to 5.0Gbps when using a USB 3.0 compliant device. +.Sh HARDWARE +The +.Nm +driver supports +.Tn XHCI +compatible controllers having PCI class 12 (serial bus), +subclass 3 (USB) and programming interface 48 (XHCI). +.Sh SEE ALSO +.Xr ehci 4 , +.Xr ohci 4 , +.Xr uhci 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 8.2 .