share/man/man7d/usb_mid.7d

   1 '\" te
   2 .\" Copyright 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 USB_MID 7D "Dec 22, 2006"
   7 .SH NAME
   8 usb_mid \- USB Multi Interface Driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBdevice@\fR\fIunit-address\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBusb_mid\fR driver is a \fBUSBA\fR (Solaris Universal Serial Bus
  19 Architecture)-compliant  nexus  driver that binds to device level nodes of a
  20 composite (multi interface) device if no vendor or class-specific driver is
  21 available. The \fBusb_mid\fR driver creates interface nodes or interface
  22 association nodes and attempts to bind drivers to them. If no driver is found
  23 for interface association nodes, \fBusb_ia\fR(7D) is bound by default.
  24 .SS "UGEN (Generic USB)"
  25 .sp
  26 .LP
  27 The \fBusb_mid\fR driver also supports a \fBugen\fR(7D) interface allowing raw
  28 access to the device, for example by \fBlibusb\fR(3LIB) applications, by
  29 passing the drivers bound to each interface. Since a libusb application might
  30 change the state of the device, you should not access the device through the
  31 child interface drivers. Note that the \fBusb_mid\fR driver creates a ugen
  32 interface only if none of its children are explicitly bound to the
  33 \fBugen\fR(7D) driver. Additionally, \fBusb_mid\fR does not create children.
  34 .SH FILES
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB/kernel/drv/usb_mid\fR \fR
  39 .ad
  40 .sp .6
  41 .RS 4n
  42 32-bit x86 ELF kernel module
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fB/kernel/drv/amd64/usb_mid\fR \fR
  49 .ad
  50 .sp .6
  51 .RS 4n
  52 64-bit x86 ELF kernel module
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB/kernel/drv/sparcv9/usb_mid\fR \fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 64-bit SPARC ELF kernel module
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB/dev/usb/*/*/* \fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 ugen(7D) nodes.
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  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 .sp
  93 .LP
  94 \fBcfgadm_usb\fR(1M), \fBlibusb\fR(3LIB), \fBattributes\fR(5), \fBusba\fR(7D),
  95 \fBusb_ia\fR(7D)
  96 .sp
  97 .LP
  98 \fIWriting Device Drivers\fR
  99 .sp
 100 .LP
 101 \fIUniversal Serial Bus Specification 2.0\fR\(em2000
 102 .sp
 103 .LP
 104 \fIInterface Association Descriptor Engineering Change Notice (ECN)\fR\(em2003
 105 .sp
 106 .LP
 107 \fISystem Administration Guide: Basic Administration\fR
 108 .sp
 109 .LP
 110 http://\fIwww.sun.com/io\fR
 111 .SH DIAGNOSTICS
 112 .sp
 113 .LP
 114 In addition to being logged, the following messages may appear on the system
 115 console. All messages are formatted in the following manner:
 116 .sp
 117 .in +2
 118 .nf
 119 Warning: <device path> (usb_mid<instance number>): Error Message...
 120 .fi
 121 .in -2
 122 .sp
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fBCannot access <device>. Please reconnect.\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 This device has been disconnected because a device other than the original one
 132 has been inserted. The driver informs you of this fact by displaying the name
 133 of the original device.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fBDevice not identical to the previous one on this port. Please disconnect and
 140 reconnect.\fR
 141 .ad
 142 .sp .6
 143 .RS 4n
 144 Same condition as described above; however in this case, the driver is unable
 145 to identify the original device with a name string.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fBPlease disconnect and reconnect this device.\fR
 152 .ad
 153 .sp .6
 154 .RS 4n
 155 A hotplug of the device is needed before it can be restored.
 156 .RE
 157
 158 .sp
 159 .LP
 160 The following messages may be logged into the system log. They are formatted in
 161 the following manner:
 162 .sp
 163 .in +2
 164 .nf
 165 <device path><usb_mid<instance number>): message...
 166 .fi
 167 .in -2
 168 .sp
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fBNo driver found for interface <n> (nodename: <string>) of <device>. \fR
 174 .ad
 175 .sp .6
 176 .RS 4n
 177 No driver is available for this interface.
 178 .RE
 179
 180 .sp
 181 .ne 2
 182 .na
 183 \fBNo driver found for device <device>. \fR
 184 .ad
 185 .sp .6
 186 .RS 4n
 187 No driver is available for this interface.
 188 .RE
 189
 190 .sp
 191 .ne 2
 192 .na
 193 \fBCan't support ugen for multiple configuration devices that have attached
 194 child interface drivers.\fR
 195 .ad
 196 .sp .6
 197 .RS 4n
 198 No ugen interface is available and \fBlibusb\fR(3LIB) cannot work with this
 199 device.
 200 .RE
 201