| blob | 9200761cb0e418a6c938ecaa6f5f3f5b84981ee9 |
1 '\" te
2 .\" Copyright (c) 2008, 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 SCSA2USB 7D "May 13, 2017"
7 .SH NAME
8 scsa2usb \- SCSI to USB bridge driver
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBstorage@unit-address\fR
13 .fi
15 .SH DESCRIPTION
16 .LP
17 The \fBscsa2usb\fR driver is a \fBUSBA\fR (Solaris USB architecture) compliant
18 nexus driver that supports the \fIUSB Mass Storage Bulk Only Transport
19 Specification 1.0\fR and \fIUSB Control/Bulk/Interrupt (CBI) Transport
20 Specification 1.0\fR. The \fBscsa2usb\fR driver also supports USB storage
21 devices that implement CBI Transport without the interrupt completion for
22 status (that is, Control/Bulk (CB) devices.) It supports bus-powered and
23 self-powered USB mass storage devices. This nexus driver is both a USB client
24 driver and a \fBSCSA\fR HBA driver. As such, the \fBscsa2usb\fR driver only
25 supports storage devices that utilize the above two transports.
26 .sp
27 .LP
28 The \fBscsa2usb\fR driver also supports a \fBugen\fR(7D) interface allowing raw
29 access to the device, for example by libusb applications, bypassing
30 the child \fBsd\fR(7D) or \fBst\fR(7D) driver. Because a libusb application
31 might change the state of the device, you should not access the disk or tape
32 concurrently.
33 .sp
34 .LP
35 The \fBscsa2usb\fR nexus driver maps \fBSCSA\fR target driver requests to
36 \fBUSBA\fR client driver requests.
37 .sp
38 .LP
39 The \fBscsa2usb\fR driver creates a child device info node for each logical
40 unit (LUN) on the mass storage device. The standard Solaris \fBSCSI\fR disk
41 driver or tape driver is attached to those nodes. Refer to \fBsd\fR(7D) or
42 \fBst\fR(7D).
43 .sp
44 .LP
45 This driver supports multiple LUN devices and creates a separate child device
46 info node for each LUN. All child LUN nodes attach to \fBsd\fR(7D) for disks or
47 \fBst\fR(7D) for tapes.
48 .sp
49 .LP
50 In previous releases, all USB disk storage devices were treated as removable
51 media devices and managed by \fBrmformat\fR(1) and volume management software.
52 In the current release, however, only disk storage devices with a removable bit
53 (RMB) value of \fB1\fR are removable. (The RMB is part of the device's SCSI
54 INQUIRY data.) See SCSI specifications T10/995D Revision 11a, T10/1236-D
55 Revision 20 or T10/1416-D Revision 23 for more information. However, for
56 backward compatibility, all USB disk storage devices can still be managed by
57 \fBrmformat\fR(1). With or without a volume manager, you can mount, eject,
58 hot remove and hot insert a 1394 mass storage device as the following sections
59 explain.
60 .sp
61 .LP
62 Some devices may be supported by the USB mass storage driver even though they
63 do not identify themselves as compliant with the USB mass storage class.
64 .sp
65 .LP
66 The \fBscsa2usb.conf\fR file contains an \fBattribute-override-list\fR that
67 lists the vendor ID, product ID, and revision for matching mass storage
68 devices, as well as fields for overriding the default device attributes. The
69 entries in this list are commented out by default and may be uncommented to
70 enable support of particular devices.
71 .sp
72 .LP
73 Follow the information given in the \fBscsa2usb.conf\fR file to see if a
74 particular device can be supported using the override information.
75 For example, by adding the following to the
76 \fBscsa2usb.conf\fR file, many USB memory sticks and card readers might operate
77 more reliably:
78 .sp
79 .in +2
80 .nf
81 attribute-override-list = "vid=* reduced-cmd-support=true";
82 .fi
83 .in -2
85 .sp
86 .LP
87 Note that this override applies to all USB mass storage devices and might be
88 inappropriate for a USB CD writer. If so, you can add an entry for each device
89 to the attribute override list.
90 .sp
91 .LP
92 If USB mass storage support is considered a security risk, this driver can be
93 disabled in \fB/etc/system\fR as follows:
94 .sp
95 .in +2
96 .nf
97 exclude: scsa2usb
98 .fi
99 .in -2
101 .sp
102 .LP
103 Alternatively, you can disable automatic handling of a device as described in
104 the following subsection.
105 .SS "Using Volume Management"
106 .LP
107 Disk storage devices are managed by Volume Manager. Software that manages
108 removable media creates a device nickname that can be listed with
109 \fBeject\fR(1) or \fBrmmount\fR(1). A device that is not mounted automatically
110 can be mounted using \fBrmmount\fR(1) under \fB/rmdisk/\fIlabel\fR\fR. Note
111 that the \fBmount\fR(8) and \fBmount\fR(8) commands do not accept nicknames;
112 you must use explicit device names with these commands.
113 .sp
114 .LP
115 See \fBrmmount\fR(1) to unmount the device and \fBeject\fR(1) to eject the
116 media. If the device is ejected while it is mounted, volume management software
117 unmounts the device before ejecting it. It also might kill any active
118 applications that are accessing the device.
119 .sp
120 .LP
121 Volume management software is hotplug-aware and normally mounts file systems on
122 USB mass storage devices if the file system is recognized. Before hot removing
123 the USB device, use \fBeject\fR(1) to unmount the file system. After the device
124 is removed, a console warning, such as "The disconnected device was busy,
125 please reconnect," might display. The warning is harmless and you can ignore
126 it.
127 .sp
128 .LP
129 You can disable the automatic mounting and unmounting of removable devices by
130 inserting a entry for a removable device in \fB/etc/vfstab\fR. In this entry,
131 you must set the \fBmount at boot\fR field to \fBno\fR. See \fBvfstab\fR(4).
132 .SS "Using \fBmount\fR and \fBumount\fR"
133 .LP
134 Use \fBmount\fR(8) to explicitly mount the device and \fBumount\fR(8) to
135 unmount the device. Use \fBeject\fR(1) to eject the media. After you have
136 explicitly mounted a removable device, you cannot use a nickname as an argument
137 to \fBeject\fR.
138 .sp
139 .LP
140 Removing the disk device while it is being accessed or mounted fails with a
141 console warning. To hot remove the disk device from the system, unmount the
142 file system, then kill all applications accessing the device. Next, hot remove
143 the device. A storage device can be hot inserted at any time.
144 .SH DEVICE SPECIAL FILES
145 .LP
146 Disk block special file names are located in \fB/dev/dsk\fR, while raw file
147 names are located in \fB/dev/rdsk\fR. Tape raw file names are located in
148 \fB/dev/rmt\fR. Input/output requests to the devices must follow the same
149 restrictions as those for SCSI disks or tapes. Refer to \fBsd\fR(7D) or
150 \fBst\fR(7D).
151 .SH IOCTLS
152 .LP
153 Refer to \fBdkio\fR(7I) and \fBcdio\fR(7I).
154 .SH ERRORS
155 .LP
156 Refer to \fBsd\fR(7D) for disks or \fBst\fR(7D) for tapes.
157 .SH FILES
158 .LP
159 The device special files for the USB mass storage device are created like those
160 for a \fBSCSI\fR disk or SCSI tape. Refer to \fBsd\fR(7D) or \fBst\fR(7D).
161 .sp
162 .ne 2
163 .na
164 \fB\fB/dev/dsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR
165 .ad
166 .sp .6
167 .RS 4n
168 Block files for disks.
169 .RE
171 .sp
172 .ne 2
173 .na
174 \fB\fB/dev/rdsk/c\fIn\fRt\fIn\fRd\fIn\fRs\fIn\fR\fR\fR
175 .ad
176 .sp .6
177 .RS 4n
178 Raw files for disks.
179 .RE
181 .sp
182 .ne 2
183 .na
184 \fB/dev/usb/*/*/*\fR
185 .ad
186 .sp .6
187 .RS 4n
188 ugen(7D) nodes
189 .RE
191 .sp
192 .ne 2
193 .na
194 \fB\fB/dev/rmt/[0- 127][l,m,h,u,c][b][n]\fR\fR
195 .ad
196 .sp .6
197 .RS 4n
198 Raw files for tapes.
199 .RE
201 .sp
202 .ne 2
203 .na
204 \fB\fB/vol/dev/aliases/zip0\fR\fR
205 .ad
206 .sp .6
207 .RS 4n
208 Symbolic link to the character device for the media in Zip drive 0
209 .RE
211 .sp
212 .ne 2
213 .na
214 \fB\fB/vol/dev/aliases/jaz0\fR\fR
215 .ad
216 .sp .6
217 .RS 4n
218 Symbolic link to the character device for the media in Jaz drive 0.
219 .RE
221 .sp
222 .ne 2
223 .na
224 \fB\fB/vol/dev/aliases/rmdisk0\fR\fR
225 .ad
226 .sp .6
227 .RS 4n
228 Symbolic link to the character device for the media in removable drive 0. This
229 is a generic removable media device.
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fB/kernel/drv/scsa2usb\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 32-bit x86 ELF kernel module
240 .RE
242 .sp
243 .ne 2
244 .na
245 \fB\fB/kernel/drv/amd64/scsa2usb\fR\fR
246 .ad
247 .sp .6
248 .RS 4n
249 64-bit x86 ELF kernel module
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fB/kernel/drv/sparcv9/scsa2usb\fR\fR
256 .ad
257 .sp .6
258 .RS 4n
259 64-bit SPARC ELF kernel module
260 .RE
262 .sp
263 .ne 2
264 .na
265 \fB\fB/kernel/drv/scsa2usb.conf\fR\fR
266 .ad
267 .sp .6
268 .RS 4n
269 Can be used to override specific characteristics.
270 .RE
272 .SH ATTRIBUTES
273 .LP
274 See \fBattributes\fR(5) for descriptions of the following attributes:
275 .sp
277 .sp
278 .TS
279 box;
280 c | c
281 l | l .
282 ATTRIBUTE TYPE ATTRIBUTE VALUE
283 _
284 Architecture SPARC, x86, PCI-based systems
285 .TE
287 .SH SEE ALSO
288 .LP
289 \fBcdrw\fR(1), \fBeject\fR(1), \fBrmformat\fR(1), \fBrmmount\fR(1),
290 \fBcfgadm_scsi\fR(8), \fBcfgadm_usb\fR(8), \fBfdisk\fR(8), \fBmount\fR(8),
291 \fBumount\fR(8),
292 \fBscsi\fR(4), \fBvfstab\fR(4), \fBattributes\fR(5),
293 \fBieee1394\fR(7D), \fBsd\fR(7D), \fBst\fR(7D), \fBugen\fR(7D), \fBusba\fR(7D),
294 \fBpcfs\fR(7FS), \fBcdio\fR(7I), \fBdkio\fR(7I)
295 .sp
296 .LP
297 \fIWriting Device Drivers\fR
298 .sp
299 .LP
300 \fISystem Administration Guide, Volume I\fR
301 .sp
302 .LP
303 \fIUniversal Serial Bus Specification 2.0\fR
304 .sp
305 .LP
306 \fIUniversal Serial Bus Mass Storage Class Specification Overview 1.0\fR
307 .sp
308 .LP
309 \fIUniversal Serial Bus Mass Storage Class Bulk-Only Transport Specification
310 1.0\fR
311 .sp
312 .LP
313 \fIUniversal Serial Bus Mass Storage Class Control/Bulk/Interrupt (CBI)
314 Transport Specification 1.0\fR
315 .sp
316 .LP
317 \fISystem Administration Guide: Basic Administration\fR
318 .sp
319 .LP
320 SCSI Specification \fIT10/995D Revision 11a\fR \(em March 1997
321 .sp
322 .LP
323 SCSI Specification\fIT10/1236-D Revision 20\fR \(em July 2001
324 .sp
325 .LP
326 SCSI Specification\fIT10/1416-D Revision 23\fR \(em May 2005
327 .SH DIAGNOSTICS
328 .LP
329 Refer to \fBsd\fR(7D) and \fBst\fR(7D).
330 .sp
331 .LP
332 In addition to being logged, the following messages may appear on the system
333 console. All messages are formatted in the following manner:
334 .sp
335 .in +2
336 .nf
337 Warning: <device path> (scsa2usb<instance number>): Error Message...
338 .fi
339 .in -2
340 .sp
342 .sp
343 .ne 2
344 .na
345 \fBCannot access <device>. Please reconnect.\fR
346 .ad
347 .sp .6
348 .RS 4n
349 There was an error in accessing the mass-storage device during reconnect.
350 Please reconnect the device.
351 .RE
353 .sp
354 .ne 2
355 .na
356 \fBDevice is not identical to the previous one on this port. Please disconnect
357 and reconnect.\fR
358 .ad
359 .sp .6
360 .RS 4n
361 Another USB device has been inserted on a port that was connected to a
362 mass-storage device. Please disconnect the USB device and reconnect the
363 mass-storage device back into that port.
364 .RE
366 .sp
367 .ne 2
368 .na
369 \fBReinserted device is accessible again.\fR
370 .ad
371 .sp .6
372 .RS 4n
373 The mass-storage device that was hot-removed from its USB slot has been
374 re-inserted to the same slot and is available for access.
375 .RE
377 .sp
378 .ne 2
379 .na
380 \fBPlease disconnect and reconnect this device.\fR
381 .ad
382 .sp .6
383 .RS 4n
384 A hotplug of the device is needed before it can be restored.
385 .RE
387 .sp
388 .LP
389 The following messages may be logged into the system log. They are formatted in
390 the following manner:
391 .sp
392 .in +2
393 .nf
394 <device path><scsa2usb<instance number>): message...
395 .fi
396 .in -2
397 .sp
399 .sp
400 .ne 2
401 .na
402 \fBInvalid <record> in scsa2usb.conf file entry.\fR
403 .ad
404 .sp .6
405 .RS 4n
406 An unrecognized record was specified in the \fBscsa2usb.conf\fR file.
407 .RE
409 .sp
410 .ne 2
411 .na
412 \fBPkt submitted with 0 timeout which may cause indefinite hangs.\fR
413 .ad
414 .sp .6
415 .RS 4n
416 An application submitted a request but did not specify a timeout.
417 .RE
419 .sp
420 .ne 2
421 .na
422 \fBSyncing not supported.\fR
423 .ad
424 .sp .6
425 .RS 4n
426 Syncing after a panic is not supported. The filesystem may be corrupted.
427 .RE
429 .sp
430 .ne 2
431 .na
432 \fBscsa2usb.conf override: <record>.\fR
433 .ad
434 .sp .6
435 .RS 4n
436 An override record specified in \fBscsa2usb.conf\fR was applied. Examples of an
437 override record applied to a device with vendor ID 123 and product ID 456 are:
438 .sp
439 .in +2
440 .nf
441 vid=0x123 pid=0x456 reduced-cmd-support=true
443 or
445 vid=* reduced-cmd-support=true
446 .fi
447 .in -2
449 \&...meaning that the override record is applied to this device and all other
450 USB mass storage devices.
451 .RE
453 .SH NOTES
454 .LP
455 The Zip 100 drive does not comply with \fIUniversal Serial Bus Specification
456 1.0\fR and cannot be power managed. Power Management support for Zip 100 has
457 been disabled.
458 .sp
459 .LP
460 If the system panics while a UFS file system is mounted on the mass storage
461 media, no syncing will take place for the disk mass-storage device. (Syncing is
462 not supported by the \fBscsa2usb\fR driver.) As a result, the file system on
463 the media will not be consistent on reboot.
464 .sp
465 .LP
466 If a PCFS file system is mounted, no syncing is needed and the filesystem will
467 be consistent on reboot.
468 .sp
469 .LP
470 If a mass-storage device is busy, system suspend cannot proceed and the system
471 will immediately resume again.
472 .sp
473 .LP
474 Attempts to remove a mass-storage device from the system will fail. The failure
475 will be logged to the console. An attempt to replace the removed device with
476 some other USB device will also fail. To successfully remove a USB mass-storage
477 device you must "close" all references to it.
478 .sp
479 .LP
480 Concurrent I/O to devices with multiple LUNs on the same device is not
481 supported.
482 .sp
483 .LP
484 Some USB CD-RW devices may perform inadequately at their advertised speeds. To
485 compensate, use USB CD-RW devices at lower speeds (2X versus 4X). See
486 \fBcdrw\fR(1) for details.
487 .sp
488 .LP
489 This driver also supports CBI devices that do not use USB interrupt pipe for
490 status completion.