d88a1c75981186389ed3209dde1c0637f00216ed
[dragonfly.git] / share / man / man4 / ehci.4
1 .\" $NetBSD: ehci.4,v 1.11 2004/06/22 09:12:48 wiz Exp $
2 .\"
3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Lennart Augustsson.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. All advertising materials mentioning features or use of this software
18 .\"    must display the following acknowledgement:
19 .\"        This product includes software developed by the NetBSD
20 .\"        Foundation, Inc. and its contributors.
21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
22 .\"    contributors may be used to endorse or promote products derived
23 .\"    from this software without specific prior written permission.
24 .\"
25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 .\" POSSIBILITY OF SUCH DAMAGE.
36 .\"
37 .Dd July 4, 2010
38 .Dt EHCI 4
39 .Os
40 .Sh NAME
41 .Nm ehci
42 .Nd USB Enhanced Host Controller driver
43 .Sh SYNOPSIS
44 .Cd "device ehci"
45 .Sh DESCRIPTION
46 The
47 .Nm
48 driver provides support for the USB Enhanced Host Controller Interface,
49 which is used by USB 2.0 controllers.
50 .Pp
51 EHCI controllers are peculiar in that they can only handle the USB 2.0
52 protocol.
53 This means that they normally have one or more companion controllers
54 (i.e.,
55 .Xr ohci 4
56 or
57 .Xr uhci 4 )
58 handling USB 1.x devices.
59 Consequently each USB connector is electrically connected to two
60 USB controllers.
61 The handling of this is totally automatic, but can be noticed since
62 USB 1.x and USB 2.0 devices plugged in to the same connector appear
63 to connect to different USB busses.
64 .Pp
65 The
66 .Nm
67 driver is automatically loaded upon boot.
68 To disable this behavior temporarily, the
69 .Va ehci_load
70 variable can be unset at the loader prompt (see
71 .Xr loader 8 ) .
72 To disable it permanently, the
73 .Va hint.ehci.0.disabled
74 tunable can be set to 1 in
75 .Pa /boot/loader.conf .
76 .Sh SEE ALSO
77 .Xr cardbus 4 ,
78 .Xr ohci 4 ,
79 .Xr pci 4 ,
80 .Xr uhci 4 ,
81 .Xr usb 4
82 .Sh HISTORY
83 The
84 .Nm
85 driver appeared in
86 .Dx 1.0 .
87 .Sh BUGS
88 There is no support (yet) for interrupt or isochronous transfers.