8212 manpages contain obsolete references
[unleashed.git] / usr / src / man / man7d / ohci.7d
blob922cd18bfd6017ceddb247a36469b98f0753a3d2
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 "May 13, 2017"
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 .LP
17 The \fBohci\fR driver is a USBA (Solaris USB Architecture) compliant nexus
18 driver that supports the \fIOpen Host Controller Interface Specification
19 1.1\fR, an industry standard developed by Compaq, Microsoft, and National
20 Semiconductor.
21 .sp
22 .LP
23 The \fBohci\fR driver supports bulk, interrupt, control and isochronous
24 transfers.
25 .SH FILES
26 .ne 2
27 .na
28 \fB\fB/kernel/drv/ohci\fR\fR
29 .ad
30 .RS 28n
31 32-bit x86 ELF kernel module
32 .RE
34 .sp
35 .ne 2
36 .na
37 \fB\fB/kernel/drv/amd64/ohci\fR\fR
38 .ad
39 .RS 28n
40 64-bit x86 ELF kernel module
41 .RE
43 .sp
44 .ne 2
45 .na
46 \fB\fB/kernel/drv/sparcv9/ohci\fR\fR
47 .ad
48 .RS 28n
49 64-bit SPARC ELF kernel module
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB\fB/kernel/drv/ohci.conf\fR\fR
56 .ad
57 .RS 28n
58 driver configuration file
59 .RE
61 .SH ATTRIBUTES
62 .LP
63 See \fBattributes\fR(5) for descriptions of the following attributes:
64 .sp
66 .sp
67 .TS
68 box;
69 c | c
70 l | l .
71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
73 Architecture    SPARC, x86, PCI-based systems
74 .TE
76 .SH SEE ALSO
77 .LP
78 \fBattributes\fR(5), \fBehci\fR(7D), \fBhubd\fR(7D), \fBuhci\fR(7D),
79 \fBusba\fR(7D)
80 .sp
81 .LP
82 \fIWriting Device Drivers\fR
83 .sp
84 .LP
85 \fIUniversal Serial Bus Specification 2.0\fR
86 .sp
87 .LP
88 \fIOpen Host Controller Interface Specification for USB 1.0a\fR
89 .sp
90 .LP
91 \fISystem Administration Guide: Basic Administration\fR
92 .SH DIAGNOSTICS
93 .LP
94 All host controller errors are passed to the client drivers. Root hub errors
95 are documented in \fBhubd\fR(7D).
96 .sp
97 .LP
98 In addition to being logged, the following messages may appear on the system
99 console. All messages are formatted in the following manner:
101 .in +2
103 WARNING: <device path> <ohci><instance number>>: Error message...
105 .in -2
109 .ne 2
111 \fBUnrecoverable USB Hardware Error.\fR
113 .sp .6
114 .RS 4n
115 There was an unrecoverable USB hardware error reported by the OHCI Controller.
116 Please reboot the system. If this problem persists, contact your system vendor.
120 .ne 2
122 \fBNo SOF interrupts have been received. This OHCI USB controller is
123 unusable.\fR
125 .sp .6
126 .RS 4n
127 The USB hardware is not generating Start Of Frame interrupts. Please reboot the
128 system. If this problem persists, contact your system vendor.
133 The following messages may be entered into the system log. They are formatted
134 in the following manner:
136 .in +2
138 <device path> <ohci<instance number>): Message...
140 .in -2
144 .ne 2
146 \fBFailed to program frame interval register.\fR
148 .sp .6
149 .RS 4n
150 For an unspecified reason, the frame interval register has been nulled out by
151 the Uli M1575 chip. Please reboot the system. If this problem persists, contact
152 your system vendor.