xref: /onnv-gate/usr/src/uts/common/io/usb/scsa2usb/scsa2usb.conf (revision 8075:cdf583f80eae)
10Sstevel@tonic-gate#
20Sstevel@tonic-gate# CDDL HEADER START
30Sstevel@tonic-gate#
40Sstevel@tonic-gate# The contents of this file are subject to the terms of the
57425SGongtian.Zhao@Sun.COM# Common Development and Distribution License (the "License").
67425SGongtian.Zhao@Sun.COM# You may not use this file except in compliance with the License.
70Sstevel@tonic-gate#
80Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
90Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
100Sstevel@tonic-gate# See the License for the specific language governing permissions
110Sstevel@tonic-gate# and limitations under the License.
120Sstevel@tonic-gate#
130Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
140Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
150Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
160Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
170Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
180Sstevel@tonic-gate#
190Sstevel@tonic-gate# CDDL HEADER END
200Sstevel@tonic-gate#
217425SGongtian.Zhao@Sun.COM# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
220Sstevel@tonic-gate# Use is subject to license terms.
230Sstevel@tonic-gate#
240Sstevel@tonic-gate
250Sstevel@tonic-gate
260Sstevel@tonic-gate#
270Sstevel@tonic-gate# scsa2usb.conf file
280Sstevel@tonic-gate#
290Sstevel@tonic-gate#       WARNING: This is an UNSTABLE configuration file. Its contents
300Sstevel@tonic-gate#               may change at any time.
310Sstevel@tonic-gate#
320Sstevel@tonic-gate# Records in this file may be used to override the vendor-supplied subclass
330Sstevel@tonic-gate# and protocol values for USB mass storage devices. Note: only non-class-
340Sstevel@tonic-gate# compliant values for subclass and protocol (e.g. 0xff) will be overridden.
350Sstevel@tonic-gate# If a device supplies legal, class-compliant values for these fields, those
360Sstevel@tonic-gate# values will not be overridden.
370Sstevel@tonic-gate#
380Sstevel@tonic-gate# Records in this file may also be used to override the default power
390Sstevel@tonic-gate# management behavior of USB mass storage devices.
400Sstevel@tonic-gate#
410Sstevel@tonic-gate# A record in this file has the following format:-
420Sstevel@tonic-gate# "vid=vId pid=pId rev=revision subclass=override protocol=override pm=pmvalue
431415Scg149915#	removable=remvalue modesense=modesensevalue"
440Sstevel@tonic-gate#
450Sstevel@tonic-gate# where:
460Sstevel@tonic-gate#	vId/pId/revision: are obtained from
470Sstevel@tonic-gate#	'prtconf -v' output for the device
480Sstevel@tonic-gate#
490Sstevel@tonic-gate#	vendorId is the hardware property 'usb-vendor-id'
500Sstevel@tonic-gate#	productId is the hardware property 'usb-product-id'
510Sstevel@tonic-gate#	revision is the hardware property 'usb-revision-id'
520Sstevel@tonic-gate#
530Sstevel@tonic-gate#	subclass override - could be either "ufi", "scsi", or "atapi"
540Sstevel@tonic-gate#		where	"ufi" -> Device follows UFI transport
550Sstevel@tonic-gate#			"atapi" -> Device follows ATAPI transport
560Sstevel@tonic-gate#			"scsi" -> Device follows SCSI transport
570Sstevel@tonic-gate#
580Sstevel@tonic-gate#	These values are part of USB Interface descriptor for that device.
59*8075SGuoqing.Zhu@Sun.COM#		bInterfaceSubClass	type
600Sstevel@tonic-gate#		0x1			"scsi"
610Sstevel@tonic-gate#		0x2			"atapi"
620Sstevel@tonic-gate#		0x4			"ufi"
630Sstevel@tonic-gate#		0x5			"atapi"
640Sstevel@tonic-gate#		0x6			"scsi"
650Sstevel@tonic-gate#
660Sstevel@tonic-gate#	protocol override - could be either "cbi", "cb", or "bo"
670Sstevel@tonic-gate#		where	"cbi" -> Control/Bulk/Interrupt device
680Sstevel@tonic-gate#			"cb" -> Control/Bulk/Interrupt device with no
690Sstevel@tonic-gate#				interrupt pipe status
700Sstevel@tonic-gate#			"bo" -> Bulk Only device
710Sstevel@tonic-gate#
720Sstevel@tonic-gate#	These values are part of USB Interface descriptor for that device.
73*8075SGuoqing.Zhu@Sun.COM#		bInterfaceProtocol	type
740Sstevel@tonic-gate#		0x0			"cbi"
750Sstevel@tonic-gate#		0x1			"cb"
760Sstevel@tonic-gate#		0x2			"bo" - zip protocol
770Sstevel@tonic-gate#		0x50			"bo"
780Sstevel@tonic-gate#
790Sstevel@tonic-gate#	pmvalue - "off" if device is not to be power managed.
800Sstevel@tonic-gate#		This is the only legal value for this parameter.
810Sstevel@tonic-gate#		This parameter is included because some devices
820Sstevel@tonic-gate#		are not capable of being power-managed, i.e. they
830Sstevel@tonic-gate#		will not respond after having their power lowered.
840Sstevel@tonic-gate#		If this is the case, the device should have power
850Sstevel@tonic-gate#		management disabled by setting this to "off".
861415Scg149915#
871415Scg149915#	remvalue - "true" if the device's removable media information
881415Scg149915#		in its hardware inquiry data is to be overridden. This
891415Scg149915#		is the only legal value for this parameter.
901415Scg149915#
911415Scg149915#	NOTE: In previous releases, the removable media information
921415Scg149915#		was always overridden and the only legal value was "false".
931415Scg149915#
941415Scg149915#		There is a removable media status bit in the USB storage
951415Scg149915#		device's inquiry data to indicate if the device has a media
961415Scg149915#		that can be removed. Usually only devices like floppy drives
97918Sqz150045#		or CD/DVD drives that really have a removable media can
98918Sqz150045#		have this bit set and be called removable media devices.
991415Scg149915#		Solaris treats removable media devices and non-removable
1001415Scg149915#		media devices differently. Refer to "System	Administration
1011415Scg149915#		Guide: Devices and File Systems" - "Using USB Devices
1021415Scg149915#		(Tasks)" - "Using USB Mass Storage Devices" section for
1031415Scg149915#		the differences in system behavior of treating removable
1041415Scg149915#		media devices and non-removable	media devices.
105918Sqz150045#
1061415Scg149915#		By default, Solaris will treat USB storage devices as
1071415Scg149915#		removable media devices depending on the removable media
1081415Scg149915#		bit value. In some cases this may be undesirable and the
1091415Scg149915#		behavior of the previous releases should be preserved. In
1101415Scg149915#		this case the removable media bit value should be overridden.
1111415Scg149915#		By setting "remvalue" to "true", the information provided
1121415Scg149915#		by the device is ignored. Consequently a USB hard disk
1131415Scg149915#		is treated as a removable media disk and will not show in
1141415Scg149915#		format(1M) disk list.
115918Sqz150045#
1160Sstevel@tonic-gate#	modesensevalue - "false" if the device cannot handle mode sense
1170Sstevel@tonic-gate#		requests. This is the only legal value for this
1180Sstevel@tonic-gate#		parameter. Some devices choke on mode sense requests
1190Sstevel@tonic-gate#		and become unusable.
1200Sstevel@tonic-gate#
1210Sstevel@tonic-gate#	reduced-cmd-support	- "true" if the device cannot handle
1221101Ssl147100#		mode sense, or start/stop, or doorlock, or doesn not
1231101Ssl147100#		report correct residues on data transfers.
1241101Ssl147100#		This is the only legal value for this parameter. This
1251101Ssl147100#		setting is recommended for USB memory sticks and USB2.0
1261101Ssl147100#		enclosures which may not be USB Mass Storage spec
1271101Ssl147100#		compliant.
1280Sstevel@tonic-gate#
1290Sstevel@tonic-gate# NOTE: As a special case, "*" may be used as a wildcard which matches
1300Sstevel@tonic-gate#	any field. This is useful in situations where more than one
1310Sstevel@tonic-gate#	vendor produces a particular model of a product, one vendor
1320Sstevel@tonic-gate#	produces more than one product with the same characteristics,
1330Sstevel@tonic-gate#	or a product has more than one revision. The subclass and
1340Sstevel@tonic-gate#	protocol override values may also contain "*" if one or the
1350Sstevel@tonic-gate#	the other does not require an override value.
1360Sstevel@tonic-gate#
1370Sstevel@tonic-gate# For the properties to take effect, reboot the system.
1380Sstevel@tonic-gate#
1390Sstevel@tonic-gate# To create this list, first COPY the "attribute-override-list =" line
1400Sstevel@tonic-gate# to the end of the file and uncomment it.
1410Sstevel@tonic-gate#
1420Sstevel@tonic-gate# Then COPY sample records and uncomment them or create new records.
1430Sstevel@tonic-gate# The list consists of one or more records separated by commas and
1440Sstevel@tonic-gate# terminated by a semicolon.
1450Sstevel@tonic-gate#
1460Sstevel@tonic-gate# IMPORTANT: CREATE THE LIST BY ENTERING NEW RECORDS AFTER THE LAST LINE
1470Sstevel@tonic-gate# OF THE FILE. TO PREVENT CHANGES BEING LOST WHEN THIS FILE IS UPGRADED,
1480Sstevel@tonic-gate# DO NOT UNCOMMENT LINES "IN PLACE."
1490Sstevel@tonic-gate#
1500Sstevel@tonic-gate#attribute-override-list =
1510Sstevel@tonic-gate#
1520Sstevel@tonic-gate# for Sony DSC-S85 USB Digital camera:
1530Sstevel@tonic-gate# "vid=0x54c pid=0x10 rev=* subclass=ufi protocol=cb",
1540Sstevel@tonic-gate#
1550Sstevel@tonic-gate# for SanDisk SDDR-05a CF:
1560Sstevel@tonic-gate# "vid=0x781 pid=1 rev=* subclass=ufi protocol=cb";
1570Sstevel@tonic-gate#
1580Sstevel@tonic-gate# to apply to all USB Mass Storage devices:
1590Sstevel@tonic-gate# "vid=* reduced-cmd-support=true";
1600Sstevel@tonic-gate#
1610Sstevel@tonic-gate# (this is not recommended for CD and DVD reader/writers but may work
1620Sstevel@tonic-gate# well with USB memory sticks)
1630Sstevel@tonic-gate#
1640Sstevel@tonic-gate# ANYTHING CHANGED BEFORE THIS POINT MAY BE OVERWRITTEN IN UPGRADE
165