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