share/man/man7d/ehci.7d

   1 '\" te
   2 .\" Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH EHCI 7D "Apr 13, 2006"
   7 .SH NAME
   8 ehci \- Enhanced host controller driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBusb@unit-address\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBehci\fR driver is a USBA (Solaris USB Architecture) compliant nexus
  19 driver that supports the Enhanced Host Controller Interface Specification 2.0,
  20 an industry standard developed by Intel.
  21 .sp
  22 .LP
  23 A USB 2.0 host controller includes one high-speed host controller and zero or
  24 more USB 1.1 host controllers. The high-speed host controller implements an
  25 EHCI (Enhanced Host Controller Interface) that is used for all high-speed
  26 communications to high-speed-mode devices.
  27 .sp
  28 .LP
  29 All USB 2.0 devices  connected to the root ports of the USB 2.0  host
  30 controller and all devices connected to a high- speed-mode hub should be routed
  31 to the EHCI host controller.
  32 .sp
  33 .LP
  34 All full- and low-speed devices connected to the root ports of the USB 2.0 host
  35 controller should be routed to the companion USB 1.1 host controllers. (OHCI or
  36 UHCI host controller).
  37 .sp
  38 .LP
  39 The \fBehci\fR supports bulk, interrupt, control  and  iso chronous transfers
  40 (on USB1.\fIx\fR devices behind a USB2.0 hub).
  41 .SH FILES
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB/kernel/drv/ehci\fR\fR
  46 .ad
  47 .RS 28n
  48 32-bit ELF 86 kernel module
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB/kernel/drv/sparcv9/ehci\fR\fR
  55 .ad
  56 .RS 28n
  57 64-bit SPARC ELF kernel module
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB/kernel/drv/amd64/ehci\fR\fR
  64 .ad
  65 .RS 28n
  66 64-bit x86 ELF kernel module
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB/kernel/drv/ehci.conf\fR\fR
  73 .ad
  74 .RS 28n
  75 Driver configuration file
  76 .RE
  77
  78 .SH ATTRIBUTES
  79 .sp
  80 .LP
  81 See \fBattributes\fR(5) for descriptions of the following attributes:
  82 .sp
  83
  84 .sp
  85 .TS
  86 box;
  87 c | c
  88 l | l .
  89 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  90 _
  91 Architecture    SPARC, x86, PCI-based systems
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBadd_drv\fR(1M), \fBprtconf\fR(1M), \fBrem_drv\fR(1M), \fBupdate_drv\fR(1M),
  98 \fBattributes\fR(5), \fBhubd\fR(7D), \fBuhci\fR(7D), \fBohci\fR(7D),
  99 \fBusba\fR(7D)
 100 .sp
 101 .LP
 102 \fIWriting Device Drivers\fR
 103 .sp
 104 .LP
 105 \fIUniversal Serial Bus Specification 2.0\fR
 106 .sp
 107 .LP
 108 \fIEnhanced Host Controller Interface Specification 1.0\fR
 109 .sp
 110 .LP
 111 \fISystem Administration Guide: Basic Administration\fR
 112 .sp
 113 .LP
 114 \fIhttp://www.usb.org\fR
 115 .sp
 116 .LP
 117 \fIhttp://www.sun.com/io\fR
 118 .sp
 119 .LP
 120 \fIhttp://www.sun.com/bigadmin/hcl\fR
 121 .sp
 122 .LP
 123 \fIhttp://www.intel.com/technology/usb/ehcispec.htm\fR
 124 .SH DIAGNOSTICS
 125 .sp
 126 .LP
 127 In addition to being logged, the following messages may appear on the system
 128 console. All messages are formatted in the following manner:
 129 .sp
 130 .in +2
 131 .nf
 132 WARNING: <device path> (ehci<instance number>): Message...
 133 .fi
 134 .in -2
 135 .sp
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fBUnrecoverable USB hardware error.\fR
 141 .ad
 142 .sp .6
 143 .RS 4n
 144 There was an unrecoverable USB hardware error reported by the \fBehci\fR
 145 controller. Reboot the system. If this problem persists, contact your system
 146 vendor.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fBNo SOF interrupts.\fR
 153 .ad
 154 .br
 155 .na
 156 \fB\fR
 157 .ad
 158 .sp .6
 159 .RS 4n
 160 No SOF interrupts have been received. This USB EHCI controller is unusable.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fBError recovery failure: Please hotplug the 2.0 hub at <device path>.\fR
 167 .ad
 168 .sp .6
 169 .RS 4n
 170 The driver failed to clear 2.0 hub's TT buffer. Remove and reinsert the
 171 external USB2.0 hub.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fBRevision<xx> is not supported.\fR
 178 .ad
 179 .sp .6
 180 .RS 4n
 181 High speed USB devices prior to revision 0.95 are not supported.
 182 .RE
 183
 184 .sp
 185 .LP
 186 The following messages may be entered into the system log. They are formatted
 187 in the following manner:
 188 .sp
 189 .in +2
 190 .nf
 191 <device path> (ehci<instance number>): Message...
 192 .fi
 193 .in -2
 194 .sp
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fBUnable to take control from BIOS. Failure is ignored.\fR
 200 .ad
 201 .sp .6
 202 .RS 4n
 203 The driver was unable to take control of the EHCI hardware from the system's
 204 BIOS. This failure is ignored. To abort the attach on this take-over failure,
 205 comment out a property in ehci.conf. (x86 only).
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fBUnable to take control from BIOS.\fR
 212 .ad
 213 .sp .6
 214 .RS 4n
 215 The driver is unable to take control of the EHCI hardware          from the
 216 system's BIOS and aborts the attach. High speed (USB 2.0) support is disabled.
 217 In this case, all USB devices run at full/low speed. Contact your system vendor
 218 or your system administror for possible changes in BIOS settings. You can
 219 disable a property in \fBehci.conf\fR to ignore this failure. (x86 only.)
 220 .RE
 221
 222 .sp
 223 .ne 2
 224 .na
 225 \fBLow speed device is not supported.\fR
 226 .ad
 227 .br
 228 .na
 229 \fBFull speed device is not supported.\fR
 230 .ad
 231 .sp .6
 232 .RS 4n
 233 The driver detected a low or full speed device on its root hub port. Per USB
 234 2.0 specification, the device should be routed to a companion host controller
 235 (OHCI or UHCI). However, no attached companion host controller appears to be
 236 available. Therefore, low and full speed devices are not supported.
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fBLow speed endpoint's poll interval of <n> ms is below threshold. Rounding up
 243 to 8 ms.\fR
 244 .ad
 245 .sp .6
 246 .RS 4n
 247 Low speed endpoints are limited to polling intervals between 8 ms and 255 ms.
 248 If a device reports a polling interval that is less than 8 ms, the driver uses
 249 8 ms instead.
 250 .RE
 251
 252 .sp
 253 .ne 2
 254 .na
 255 \fBLow speed endpoint's poll interval is greater than 255 ms.\fR
 256 .ad
 257 .sp .6
 258 .RS 4n
 259 The low speed device's polling interval is out of range. The host controller
 260 does not allocate bandwidth for this device. This device is not usable.
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fBFull speed endpoint's poll interval must be between 1 and 255 ms.\fR
 267 .ad
 268 .sp .6
 269 .RS 4n
 270 The full speed device's polling interval is out of range. The host controller
 271 does not allocate bandwidth for this device. This device is not usable.
 272 .RE
 273
 274 .sp
 275 .ne 2
 276 .na
 277 \fBHigh speed endpoint's poll interval must be between 1 and 16 units.\fR
 278 .ad
 279 .sp .6
 280 .RS 4n
 281 The high speed device's polling interval is out of range. The host controller
 282 will not allocate bandwidth for this device. This device will not be usable.
 283 Refer to the USB specification, revision 2.0 for the unit definition.
 284 .RE
 285
 286 .sp
 287 .ne 2
 288 .na
 289 \fBehci_modify_qh_status_bit: Failed to halt qh=<address>.\fR
 290 .ad
 291 .sp .6
 292 .RS 4n
 293 Error recovery failed. Please disconnect and reinsert all devices or reboot.
 294 .RE
 295
 296 .LP
 297 Note -
 298 .sp
 299 .RS 2
 300 Due to recently discovered incompatibilities with this USB controller,
 301 USB2.\fIx\fR transfer support has been disabled. However, this device continues
 302 to function as a USB1.\fIx\fR controller. Information on enabling USB2.x
 303 support is provided in this man page. Please refer to \fIwww.sun.com/io\fR for
 304 Solaris Ready products and to \fIwww.sun.com/bigadmin/hcl\fR for additional
 305 compatible USB products.
 306 .LP
 307 VIA chips may not be compatible with this driver. To bind \fBehci\fR
 308 specifically to the chip and eliminate the warnings, and to enable USB2.x
 309 suppport, a new, more specific driver alias  (refer to \fBadd_drv\fR(1M) and
 310 \fBupdate_drv\fR(1M)) must be specified for \fBehci\fR. By default, the
 311 \fBehci\fR alias is 'pciclass,0c0320.' The compatible names in the
 312 \fBprtconf\fR(1M) output provides additional aliases. For example:
 313 .RE
 314 .sp
 315 .in +2
 316 .nf
 317    # prtconf -vp | grep pciclass,0c0320
 318         compatible: 'pci1106,3104.1106.3104.2063' +
 319 \&'pci1106,3104.1106.3104' + 'pci1106,3104' +
 320  pci1106,3104.2063' + 'pci1106,3104' + 'pciclass,0c0320' +
 321 \&'pciclass,0c03'
 322          ....
 323
 324
 325        A more specific alias is 'pci1106,3104.' Perform the follow-
 326        ing step to add this alias, then reboot the system:
 327
 328
 329        # update_drv -a -i '"pci1106,3104"' ehci
 330
 331        # reboot
 332 .fi
 333 .in -2
 334
 335 .sp
 336 .LP
 337 After you apply the above workaround, the following message is displayed in
 338 your system log:
 339 .sp
 340 .LP
 341 Applying VIA workarounds.