Add the long overdue ehci(4) manual page.
authorJeroen Ruigrok/asmodai <asmodai@dragonflybsd.org>
Thu, 19 Aug 2004 09:34:55 +0000 (09:34 +0000)
committerJeroen Ruigrok/asmodai <asmodai@dragonflybsd.org>
Thu, 19 Aug 2004 09:34:55 +0000 (09:34 +0000)
Obtained from: NetBSD's v1.11

share/man/man4/Makefile
share/man/man4/ehci.4 [new file with mode: 0644]

index 1070d5f..47fdbcf 100644 (file)
@@ -1,6 +1,6 @@
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $
-# $DragonFly: src/share/man/man4/Makefile,v 1.7 2004/07/07 11:38:59 joerg Exp $
+# $DragonFly: src/share/man/man4/Makefile,v 1.8 2004/08/19 09:34:55 asmodai Exp $
 
 MAN=   aac.4 \
        adv.4 \
@@ -42,6 +42,7 @@ MAN=  aac.4 \
        dpt.4 \
        dummynet.4 \
        ed.4 \
+       ehci.4 \
        em.4 \
        faith.4 \
        fast_ipsec.4 \
diff --git a/share/man/man4/ehci.4 b/share/man/man4/ehci.4
new file mode 100644 (file)
index 0000000..e4d3024
--- /dev/null
@@ -0,0 +1,83 @@
+.\" $NetBSD: ehci.4,v 1.11 2004/06/22 09:12:48 wiz Exp $
+.\"
+.\" Copyright (c) 2001 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.
+.\" 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.
+.\"
+.\" $DragonFly: src/share/man/man4/ehci.4,v 1.1 2004/08/19 09:34:55 asmodai Exp $
+.\"
+.Dd June 22, 2004
+.Dt EHCI 4
+.Os
+.Sh NAME
+.Nm ehci
+.Nd USB Enhanced Host Controller driver
+.Sh SYNOPSIS
+.Cd "ehci* at cardbus? dev ? function ?"
+.Cd "ehci* at pci? dev ? function ?"
+.Cd "usb*  at ehci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the USB Enhanced Host Controller Interface,
+which is used by USB 2.0 controllers.
+.Pp
+EHCI controllers are peculiar in that they can only handle the 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 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
+.Sh HISTORY
+The
+.Nm
+driver appeared in
+.Nx 1.6 .
+.Sh BUGS
+There is no support (yet) for hubs that are connected with high speed upstream
+and low or full speed downstream (i.e., for transaction translators).
+.Pp
+There is no support (yet) for interrupt or isochronous transfers.