d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
aea26bc05a
freebsd-dev/share/misc/scsi_modes
Kenneth D. Merry 1cc052e80f Add descriptor sense support to CAM, and honor sense residuals properly in 
CAM.

Desriptor sense is a new sense data format that originated in SPC-3.  Among
other things, it allows for an 8-byte info field, which is necessary to
pass back block numbers larger than 4 bytes.

This change adds a number of new functions to scsi_all.c (and therefore
libcam) that abstract out most access to sense data.

This includes a bump of CAM_VERSION, because the CCB ABI has changed.
Userland programs that use the CAM pass(4) driver will need to be
recompiled.

camcontrol.c:	Change uses of scsi_extract_sense() to use
		scsi_extract_sense_len().

		Use scsi_get_sks() instead of accessing sense key specific
		data directly.

scsi_modes:	Update the control mode page to the latest version (SPC-4).

scsi_cmds.c,
scsi_target.c:	Change references to struct scsi_sense_data to struct
		scsi_sense_data_fixed.  This should be changed to allow the
		user to specify fixed or descriptor sense, and then use
		scsi_set_sense_data() to build the sense data.

ps3cdrom.c:	Use scsi_set_sense_data() instead of setting sense data
		manually.

cam_periph.c:	Use scsi_extract_sense_len() instead of using
		scsi_extract_sense() or accessing sense data directly.

cam_ccb.h:	Bump the CAM_VERSION from 0x15 to 0x16.  The change of
		struct scsi_sense_data from 32 to 252 bytes changes the
		size of struct ccb_scsiio, but not the size of union ccb.
		So the version must be bumped to prevent structure
		mis-matches.

scsi_all.h:	Lots of updated SCSI sense data and other structures.

		Add function prototypes for the new sense data functions.

		Take out the inline implementation of scsi_extract_sense().
		It is now too large to put in a header file.

		Add macros to calculate whether fields are present and
		filled in fixed and descriptor sense data

scsi_all.c:	In scsi_op_desc(), allow the user to pass in NULL inquiry
		data, and we'll assume a direct access device in that case.

		Changed the SCSI RESERVED sense key name and description
		to COMPLETED, as it is now defined in the spec.

		Change the error recovery action for a number of read errors
		to prevent lots of retries when the drive has said that the
		block isn't accessible.  This speeds up reconstruction of
		the block by any RAID software running on top of the drive
		(e.g. ZFS).

		In scsi_sense_desc(), allow for invalid sense key numbers.
		This allows calling this routine without checking the input
		values first.

		Change scsi_error_action() to use scsi_extract_sense_len(),
		and handle things when invalid asc/ascq values are
		encountered.

		Add a new routine, scsi_desc_iterate(), that will call the
		supplied function for every descriptor in descriptor format
		sense data.

		Add scsi_set_sense_data(), and scsi_set_sense_data_va(),
		which build descriptor and fixed format sense data.  They
		currently default to fixed format sense data.

		Add a number of scsi_get_*() functions, which get different
		types of sense data fields from either fixed or descriptor
		format sense data, if the data is present.

		Add a number of scsi_*_sbuf() functions, which print
		formatted versions of various sense data fields.  These
		functions work for either fixed or descriptor sense.

		Add a number of scsi_sense_*_sbuf() functions, which have a
		standard calling interface and print the indicated field.
		These functions take descriptors only.

		Add scsi_sense_desc_sbuf(), which will print a formatted
		version of the given sense descriptor.

		Pull out a majority of the scsi_sense_sbuf() function and
		put it into scsi_sense_only_sbuf().  This allows callers
		that don't use struct ccb_scsiio to easily utilize the
		printing routines.  Revamp that function to handle
		descriptor sense and use the new sense fetching and
		printing routines.

		Move scsi_extract_sense() into scsi_all.c, and implement it
		in terms of the new function, scsi_extract_sense_len().
		The _len() version takes a length (which should be the
		sense length - residual) and can indicate which fields are
		present and valid in the sense data.

		Add a couple of new scsi_get_*() routines to get the sense
		key, asc, and ascq only.

mly.c:		Rename struct scsi_sense_data to struct
		scsi_sense_data_fixed.

sbp_targ.c:	Use the new sense fetching routines to get sense data
		instead of accessing it directly.

sbp.c:		Change the firewire/SCSI sense data transformation code to
		use struct scsi_sense_data_fixed instead of struct
		scsi_sense_data.  This should be changed later to use
		scsi_set_sense_data().

ciss.c:		Calculate the sense residual properly.  Use
		scsi_get_sense_key() to fetch the sense key.

mps_sas.c,
mpt_cam.c:	Set the sense residual properly.

iir.c:		Use scsi_set_sense_data() instead of building sense data by
		hand.

iscsi_subr.c:	Use scsi_extract_sense_len() instead of grabbing sense data
		directly.

umass.c:	Use scsi_set_sense_data() to build sense data.

		Grab the sense key using scsi_get_sense_key().

		Calculate the sense residual properly.

isp_freebsd.h:	Use scsi_get_*() routines to grab asc, ascq, and sense key
		values.

		Calculate and set the sense residual.

MFC after:	3 days
Sponsored by:	Spectra Logic Corporation
2011-10-03 20:32:55 +00:00

372 lines
8.5 KiB
Plaintext
Raw Blame History

# SCSI mode page data base.
# Copyright (c) 1995 HD Associates
# Copyright (c) 2001 The FreeBSD Project
# (contact: dufault@hda.com)
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. The name of HD Associates
# may not be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$
#
# The ordering is alphabetical by page name, as it appears in the SCSI spec.
# 'i' is a byte-sized integral types, followed by a field width of
# 1 through 4 (1 to 4 bytes).
#
# 'b' is a bit-sized integral type
# 't' is a bitfield type- followed by a bit field width
#
# 'c' values are character arrays
# 'z' values are null-padded strings
#
#
# '*' suppresses assignment (for 'seeking').
# Bitfields are MSB to LSB.
# ALL DEVICE TYPES
0x0a "Control Mode Page" {
{TST} t3
{TMF_ONLY} t1
{DPICZ} t1
{D_SENSE} t1
{GLTSD} t1
{RLEC} t1
{Queue Algorithm Modifier} t4
{NUAR} t1
{QErr} t2
{DQue} t1
{EECA} t1
{RAC} t1
{UA_INTLCK_CTRL} t2
{SWP} t1
{RAENP} t1
{UAAENP} t1
{EAENP} t1
{ATO} t1
{TAS} t1
{ATMPE} t1
{RWWP} t1
{Reserved} *t1
{Autoload Mode} t3
{Ready AEN Holdoff Period} i2
{Busy Timeout Period} i2
{Extended Self-Test Completion Time} i2
}
0x02 "Disconnect-Reconnect Page" {
{Buffer Full Ratio} i1
{Buffer Empty Ratio} i1
{Bus Inactivity Limit} i2
{Disconnect Time Limit} i2
{Connect Time Limit} i2
{Maximum Burst Size} i2
{Reserved} *t6
{DTDC} t2
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
}
0x09 "Peripheral Device Page" {
{Interface Identifier} i2
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
}
0x1a "Power Control" {
{Reserved} *i1
{Reserved} *t6
{Idle} t1
{Standby} t1
{Idle Condition Timer} i4
{Standby Condition Timer} i4
}
# DIRECT ACCESS DEVICES
0x08 "Caching Page" {
{IC} t1
{ABPF} t1
{CAP} t1
{DISC} t1
{SIZE} t1
{WCE} t1
{MF} t1
{RCD} t1
{Demand Retention Priority} t4
{Write Retention Priority} t4
{Disable Pre-fetch Transfer Length} i2
{Minimum Pre-fetch} i2
{Maximum Pre-fetch} i2
{Maximum Pre-fetch Ceiling} i2
}
0x05 "Flexible Disk Page" {
{Transfer rate} i2
{Number of heads} i1
{Sectors per track} i1
{Data bytes per sector} i2
{Number of cylinders} i2
{Starting cylinder-write precompensation} i2
{Starting cylinder-reduced write current} i2
{Drive step rate} i2
{Drive step pulse width} i1
{Head settle delay} i2
{Motor on delay} i1
{Motor off delay} i1
{TRDY} t1
{SSN} t1
{MO} t1
{Reserved} *t5
{Reserved} *t4
{SPC} t4
{Write Compensation} i1
{Head load delay} i1
{Head unload delay} i1
{Pin 34} t4
{Pin 2} t4
{Pin 4} t4
{Pin 1} t4
{Medium rotation rate} i2
{Reserved} *i1
{Reserved} *i1
}
0x03 "Format Device Page" {
{Tracks per Zone} i2
{Alternate Sectors per Zone} i2
{Alternate Tracks per Zone} i2
{Alternate Tracks per Logical Unit} i2
{Sectors per Track} i2
{Data Bytes per Physical Sector} i2
{Interleave} i2
{Track Skew Factor} i2
{Cylinder Skew Factor} i2
{SSEC} t1
{HSEC} t1
{RMB} t1
{SURF} t1
{Reserved} *t4
}
0x0b "Medium Types Supported Page" {
{Reserved} *i1
{Reserved} *i1
{Medium type one supported} i1
{Medium type two supported} i1
{Medium type three supported} i1
{Medium type four supported} i1
}
# Notch page (0x0c)
0x0c "Notch and Partition Page";
0x01 "Read-Write Error Recovery Page" {
{AWRE (Auto Write Reallocation Enbld)} t1
{ARRE (Auto Read Reallocation Enbld)} t1
{TB (Transfer Block)} t1
{RC (Read Continuous)} t1
{EER (Enable Early Recovery)} t1
{PER (Post Error)} t1
{DTE (Disable Transfer on Error)} t1
{DCR (Disable Correction)} t1
{Read Retry Count} i1
{Correction Span} i1
{Head Offset Count} i1
{Data Strobe Offset Count} i1
{Reserved} *i1
{Write Retry Count} i1
{Reserved} *i1
{Recovery Time Limit} i2
}
0x04 "Rigid Disk Drive Geometry Page" {
{Number of Cylinders} i3
{Number of Heads} i1
{Starting Cylinder-Write Precompensation} i3
{Starting Cylinder-Reduced Write Current} i3
{Drive Step Rate} i2
{Landing Zone Cylinder} i3
{Reserved} *t6
{RPL} t2
{Rotational Offset} i1
{Reserved} *i1
{Medium Rotation Rate} i2
{Reserved} *i1
{Reserved} *i1
}
0x07 "Verify Error Recovery Page" {
{Reserved} *t4
{EER} t1
{PER} t1
{DTE} t1
{DCR} t1
{Verify Retry Count} i1
{Verify Correction Span} i1
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
{Reserved} *i1
{Verify Recovery Time Limit} i2
}
0x0E "CD-ROM Audio Control Parameters Page" {
{Reserved} *t5
{Immed} t1
{SOTC} t1
{Reserved} *t1
{Reserved} *i2
{APRVal} t1
{Reserved} *t3
{Format of LBAs / sec.} t4
{Logical Blocks per Second of Audio Playback} i2
{Reserved} *t4
{Output Port 0 Channel Selection} t4
{Output Port 0 Volume} i1
{Reserved} *t4
{Output Port 1 Channel Selection} t4
{Output Port 1 Volume} i1
{Reserved} *t4
{Output Port 2 Channel Selection} t4
{Output Port 2 Volume} i1
{Reserved} *t4
{Output Port 3 Channel Selection} t4
{Output Port 3 Volume} i1
}
# SEQUENTIAL ACCESS DEVICES
0x10 "Device Configuration Page" {
{Reserved} *t1
{Change Active Partition} t1
{Change Active Format} t1
{Active Format} t5
{Active Partition} i1
{Write Buffer Full Ratio} i1
{Write Buffer Empty Ratio} i1
{Write Delay Time} i2
{Data Buffer Recovery} t1
{Block Identifiers Support} t1
{Report Setmarks} t1
{Automatic Velocity Control} t1
{Stop on Consecutive Filemarks} t2
{Recover Buffer Order} t1
{Report Early-Warning} t1
{Gap Size} i1
{EOD Defined} t3
{Enable EOD Generation} t1
{Synchronize at Early-Warning} t1
{Reserved} *t3
{Buffer Size at Early-Warning} i3
{Select Data Compression Algorithm} i1
{Reserved} *t5
{SCSI-3 Associated Write Protect} t1
{SCSI-3 Persistent Write Protect} t1
{SCSI-3 Permanent Write Protect} t1
}
0x0f "Data Compression Page" {
{Data Compression Enabled} t1
{Date Compression Capable} t1
{Reserved} *t6
{Data Decompression Capable} t1
{Data Decompression Report on Exception} t2
{Reserved} *t5
{Compression Algorithm} i4
{Decompression Algorithm} i4
{Reserved} *i4
}
# Removable devices
0x1b "Removable Block Access Capacities Page" {
{System Floppy Type Device} t1
{Supports Reporting Format Progress} t1
{Reserved} *t6
{Non CD Optical Device} t1
{Single or Multiple LUN Supported} t1
{Reserved} *t3
{Total Logical Units Supported} t3
{Reserved} *i8
}
# CD-ROM (and CD-R[W]) devices
0x2a "CD capabilities and mechanical status page" {
{Reserved} *t4
{Method 2} t1
{CD-RW Read} t1
{CD-R Read} t1
{Reserved} *t4
{Test Write} t1
{CD-RW Write} t1
{CD-R Write} t1
{Reserved} *t1
{Multi Session} t1
{Mode 2 Form 2} t1
{Mode 2 Form 1} t1
{Digital Port (2)} t1
{Digital Port (1)} t1
{Composite} t1
{Audio Play} t1
{Read Bar Code} t1
{UPC} t1
{ISRC} t1
{C2 Pointers are supported} t1
{R-W De-interleaved & corrected} t1
{R-W Supported} t1
{CD-DA Stream is Accurate} t1
{CD-DA Commands Supported} t1
{Loading Mechanism Type} t3
{Reserved} *t1
{Eject} t1
{Prevent Jumper} t1
{Lock State} t1
{Lock} t1
{Reserved} *t4
{S/W Slot Selection} t1
{Changer Supports Disc Present reporting} t1
{Separate Channel Mute Supported} t1
{Separate volume levels per channel} t1
{Maximum Read Speed Supported (kBps)} i2
{Number of Volume Leves Supported} i2
{Buffer Size supported by Drive (KB)} i2
{Current Read Speed Selected (kBps)} i2
{Reserved} *i1
{Reserved} *t2
{Length} t2
{LSBF} t1
{RCK} t1
{BCK} t1
{Reserved} *t1
{Maximum Write Speed Supported (kBps)} i2
{Current Write Speed Supported (kBps)} i2
};
0x00 "Vendor-Specific";
Reference in New Issue View Git Blame Copy Permalink