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