From 520f87eb1181ea337d89730c17815c5ed55a8776 Mon Sep 17 00:00:00 2001 From: hselasky Date: Thu, 24 Feb 2011 18:08:23 +0000 Subject: - Add missing xhci(4) manual page. - Minor update in some USB manual pages. MFC after: 3 days Approved by: thompsa (mentor) --- share/man/man4/Makefile | 1 + share/man/man4/ehci.4 | 23 +++++++++++++---- share/man/man4/ohci.4 | 1 + share/man/man4/snd_uaudio.4 | 17 +++++++------ share/man/man4/uhci.4 | 1 + share/man/man4/usb.4 | 3 ++- share/man/man4/xhci.4 | 61 +++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 93 insertions(+), 14 deletions(-) create mode 100644 share/man/man4/xhci.4 (limited to 'share') diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index ae26fa4..8cdccc8 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -509,6 +509,7 @@ MAN= aac.4 \ ${_wpi.4} \ xe.4 \ ${_xen.4} \ + xhci.4 \ xl.4 \ xpt.4 \ zero.4 \ diff --git a/share/man/man4/ehci.4 b/share/man/man4/ehci.4 index f849ed3..ea99a9d 100644 --- a/share/man/man4/ehci.4 +++ b/share/man/man4/ehci.4 @@ -29,7 +29,7 @@ .\" .\" $FreeBSD$ .\" -.Dd March 20, 2005 +.Dd February 24, 2011 .Dt EHCI 4 .Os .Sh NAME @@ -70,6 +70,7 @@ but can be noticed since 2.0 devices plugged in to the same connector appear to connect to different USB busses. .Sh SEE ALSO +.Xr xhci 4 , .Xr ohci 4 , .Xr uhci 4 , .Xr usb 4 @@ -78,7 +79,19 @@ The .Nm device driver first appeared in .Fx 5.1 . -.Sh BUGS -The driver is not finished and is quite buggy. -.Pp -There is currently no support for isochronous transfers. +.Sh LOADER TUNABLES +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 7f92617..4a60c8b 100644 --- a/share/man/man4/ohci.4 +++ b/share/man/man4/ohci.4 @@ -60,6 +60,7 @@ NVIDIA nForce3 Sun PCIO-2 (RIO USB) .El .Sh SEE ALSO +.Xr xhci 4 , .Xr ehci 4 , .Xr uhci 4 .Sh HISTORY diff --git a/share/man/man4/snd_uaudio.4 b/share/man/man4/snd_uaudio.4 index e620777..b045851 100644 --- a/share/man/man4/snd_uaudio.4 +++ b/share/man/man4/snd_uaudio.4 @@ -29,12 +29,12 @@ .\" .\" $FreeBSD$ .\" -.Dd December 15, 2005 +.Dd February 24, 2011 .Dt SND_UAUDIO 4 .Os .Sh NAME .Nm snd_uaudio -.Nd USB audio device driver +.Nd USB audio and MIDI device driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: @@ -55,7 +55,9 @@ The .Nm driver provides support for .Tn USB -audio class devices. +audio class devices and +.Tn USB +MIDI class devices. .Pp A .Tn USB @@ -94,8 +96,7 @@ as of this writing, does not handle device un-registrations in a properly abstracted manner, i.e., a detach request is refused by the .Tn PCM framework if the device is in use. -For -.Tn USB -and supposedly other detach-able busses, it is necessary to allow the -device un-registration to complete successfully, otherwise the driver -leaves wild pointers to invalid data structures and thus leading to a panic. +It is necessary to allow the device un-registration to complete +successfully, otherwise the +.Tn PCM +layer will panic. diff --git a/share/man/man4/uhci.4 b/share/man/man4/uhci.4 index 584176a..6c8b659 100644 --- a/share/man/man4/uhci.4 +++ b/share/man/man4/uhci.4 @@ -50,6 +50,7 @@ Intel 82371SB (PIIX3) VIA 83C572 .El .Sh SEE ALSO +.Xr xhci 4 , .Xr ehci 4 , .Xr ohci 4 .Sh HISTORY diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index 05a4d02..eb65fba8 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -164,7 +164,8 @@ specifications can be found at: .Xr uplcom 4 , .Xr urio 4 , .Xr uvscom 4 , -.Xr usbconfig 8 +.Xr usbconfig 8 , +.Xr xhci 4 .Sh STANDARDS The .Nm diff --git a/share/man/man4/xhci.4 b/share/man/man4/xhci.4 new file mode 100644 index 0000000..983372f --- /dev/null +++ b/share/man/man4/xhci.4 @@ -0,0 +1,61 @@ +.\" +.\" 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$ +.\" +.Dd February 24, 2011 +.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 4.8Gbps when using a USB 3.0 compliant device. +.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 . -- cgit v1.1