freebsd-nq/share/man/man4/ohci.4

.\" Copyright (c) 1999
.\"	Nick Hibma <n_hibma@FreeBSD.org>. 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 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$
.\"
.Dd April 24, 2018
.Dt OHCI 4
.Os
.Sh NAME
.Nm ohci
.Nd OHCI USB Host Controller driver
.Sh SYNOPSIS
.Cd "device ohci"
.Sh DESCRIPTION
The
.Nm
driver provides support for OHCI-type PCI based USB controllers.
.Sh HARDWARE
The
.Nm
driver supports all OHCI v1.0 compliant controllers including:
.Pp
.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 SYSCTL VARIABLES
The following variables are available as both
.Xr sysctl 8
variables and
.Xr loader 8
tunables:
.Bl -tag -width indent
.It Va hw.usb.ohci.debug
Debug output level, where 0 is debugging disabled and larger values increase
debug message verbosity.
Default is 0.
.Sh SEE ALSO
.Xr ehci 4 ,
.Xr uhci 4 ,
.Xr xhci 4
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 3.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An Lennart Augustsson Aq Mt augustss@carlstedt.se
for the
.Nx
project.
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.\" Copyright (c) 1999`
Update @freebsd.org email addresses to @FreeBSD.org as is the precedent. 2000-10-26 15:30:44 +00:00			`.\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.\"`
			`.\" 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.`
			`.\"`
Use our preferred license text (no more "voices in his head"). While here, also move to a 2-clause license. From n_hibma@: "The 3rd clause was originally there for a reason, but I guess that it is safe to assume that no one can assume endorsement by me or anyone else without prior consent on anything really, so we might as well remove that clause." Approved by: n_hibma 2010-03-04 22:06:57 +00:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
Use our preferred license text (no more "voices in his head"). While here, also move to a 2-clause license. From n_hibma@: "The 3rd clause was originally there for a reason, but I guess that it is safe to assume that no one can assume endorsement by me or anyone else without prior consent on anything really, so we might as well remove that clause." Approved by: n_hibma 2010-03-04 22:06:57 +00:00			`.\" 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.`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.\"`
Use more common format for sysctls/tunables descriptions in USB man pages. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation 2018-04-24 17:46:33 +00:00			`.Dd April 24, 2018`
* remove i386 specific mark * some style and syntax fixes * some duplicated $FreeBSD$ tags removed 1999-11-15 23:14:32 +00:00			`.Dt OHCI 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Sh NAME`
			`.Nm ohci`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd OHCI USB Host Controller driver`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Sh SYNOPSIS`
First round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 15:04:20 +00:00			`.Cd "device ohci"`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`driver provides support for OHCI-type PCI based USB controllers.`
- Add a HARDWARE section which lists supported devices. 2004-08-08 22:19:05 +00:00			`.Sh HARDWARE`
Reword/reorganize a bit to make it more clear that all OHCI v1.0 compliant controllers are supported. MFC after: 3 days 2004-09-05 22:31:03 +00:00			`The`
- Add a HARDWARE section which lists supported devices. 2004-08-08 22:19:05 +00:00			`.Nm`
Reword/reorganize a bit to make it more clear that all OHCI v1.0 compliant controllers are supported. MFC after: 3 days 2004-09-05 22:31:03 +00:00			`driver supports all OHCI v1.0 compliant controllers including:`
- Add a HARDWARE section which lists supported devices. 2004-08-08 22:19:05 +00:00			`.Pp`
			`.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`
Document supported Sun hardware. Submitted by: marius Approved by: re (blanket) 2005-06-23 14:12:19 +00:00			`.It`
			`Sun PCIO-2 (RIO USB)`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.El`
Use more common format for sysctls/tunables descriptions in USB man pages. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation 2018-04-24 17:46:33 +00:00			`.Sh SYSCTL VARIABLES`
			`The following variables are available as both`
			`.Xr sysctl 8`
			`variables and`
			`.Xr loader 8`
			`tunables:`
			`.Bl -tag -width indent`
			`.It Va hw.usb.ohci.debug`
Document usb verbosity levels Submitted by: Tom Jones <jones@sdf.org> Approved by: hselasky MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D11850 2017-08-04 08:56:31 +00:00			`Debug output level, where 0 is debugging disabled and larger values increase`
			`debug message verbosity.`
			`Default is 0.`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Sh SEE ALSO`
Cross reference ehci(4). Suggested by: Flemming Jacobsen MFC after: 3 days 2005-04-20 07:33:09 +00:00			`.Xr ehci 4 ,`
mdoc fix 2014-12-26 21:45:01 +00:00			`.Xr uhci 4 ,`
			`.Xr xhci 4`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`device driver first appeared in`
			`.Fx 3.0 .`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Sh AUTHORS`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`The`
			`.Nm`
			`driver was written by`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Lennart Augustsson Aq Mt augustss@carlstedt.se`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`for the`
Added man page usb uhci ohci 1999-02-21 16:56:33 +00:00			`.Nx`
			`project.`