remove support for 'trademark files'
[unleashed/tickless.git] / share / man / man7d / ohci.7d
blobb2a60de881aa4329032d09e48ef19d80f776b961
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 OHCI 7D "Nov 23, 2006"
7 .SH NAME
8 ohci \- OpenHCI host controller driver
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBusb@unit-address\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBohci\fR driver is a USBA (Solaris USB Architecture) compliant nexus
19 driver that supports the \fIOpen Host Controller Interface Specification
20 1.1\fR, an industry standard developed by Compaq, Microsoft, and National
21 Semiconductor.
22 .sp
23 .LP
24 The \fBohci\fR driver supports bulk, interrupt, control and isochronous
25 transfers.
26 .SH FILES
27 .sp
28 .ne 2
29 .na
30 \fB\fB/kernel/drv/ohci\fR\fR
31 .ad
32 .RS 28n
33 32-bit x86 ELF kernel module
34 .RE
36 .sp
37 .ne 2
38 .na
39 \fB\fB/kernel/drv/amd64/ohci\fR\fR
40 .ad
41 .RS 28n
42 64-bit x86 ELF kernel module
43 .RE
45 .sp
46 .ne 2
47 .na
48 \fB\fB/kernel/drv/sparcv9/ohci\fR\fR
49 .ad
50 .RS 28n
51 64-bit SPARC ELF kernel module
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fB/kernel/drv/ohci.conf\fR\fR
58 .ad
59 .RS 28n
60 driver configuration file
61 .RE
63 .SH ATTRIBUTES
64 .sp
65 .LP
66 See \fBattributes\fR(5) for descriptions of the following attributes:
67 .sp
69 .sp
70 .TS
71 box;
72 c | c
73 l | l .
74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
76 Architecture    SPARC, x86, PCI-based systems
77 .TE
79 .SH SEE ALSO
80 .sp
81 .LP
82 \fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBuhci\fR(7D),
83 \fBusba\fR(7D)
84 .sp
85 .LP
86 \fIWriting Device Drivers\fR
87 .sp
88 .LP
89 \fIUniversal Serial Bus Specification 2.0\fR
90 .sp
91 .LP
92 \fIOpen Host Controller Interface Specification for USB 1.0a\fR
93 .sp
94 .LP
95 \fISystem Administration Guide: Basic Administration\fR
96 .sp
97 .LP
98 \fIhttp://www.sun.com/io\fR
99 .SH DIAGNOSTICS
102 All host controller errors are passed to the client drivers. Root hub errors
103 are documented in \fBhubd\fR(7D).
106 In addition to being logged, the following messages may appear on the system
107 console. All messages are formatted in the following manner:
109 .in +2
111 WARNING: <device path> <ohci><instance number>>: Error message...
113 .in -2
117 .ne 2
119 \fBUnrecoverable USB Hardware Error.\fR
121 .sp .6
122 .RS 4n
123 There was an unrecoverable USB hardware error reported by the OHCI Controller.
124 Please reboot the system. If this problem persists, contact your system vendor.
128 .ne 2
130 \fBNo SOF interrupts have been received. This OHCI USB controller is
131 unusable.\fR
133 .sp .6
134 .RS 4n
135 The USB hardware is not generating Start Of Frame interrupts. Please reboot the
136 system. If this problem persists, contact your system vendor.
141 The following messages may be entered into the  system  log. They are formatted
142 in the following manner:
144 .in +2
146 <device path> <ohci<instance number>): Message...
148 .in -2
152 .ne 2
154 \fBFailed to program frame interval register.\fR
156 .sp .6
157 .RS 4n
158 For an unspecified reason, the frame interval register has been nulled out by
159 the Uli M1575 chip. Please reboot the system. If this problem persists, contact
160 your system vendor.