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