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