Print this page
11641 spelling mistakes in section 7d of the manual
   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.


 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 


   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.


 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