--- sg3utils-fasttrack-1.25.txt Wed Dec 17 19:02:51 2008 +++ sg3utils-fasttrack-1.26.txt Tue Jan 13 13:26:21 2009 @@ -2,16 +2,16 @@ This information is Copyright 2008 Sun Microsystems 1. Introduction 1.1. Project/Component Working Name: - Sg3 utilities 1.25 + Sg3 utilities 1.26 1.2. Name of Document Author/Supplier: Author: Xiao Li 1.3 Date of This Document: - 7 Nov, 2008 + 13 Jan, 2009 2. Project Summary 2.1. Project Description - This project introduces the package of Sg3 utilites 1.25 into the + This project introduces the package of Sg3 utilites 1.26 into the SFW consolidation. 4. Technical Description @@ -23,7 +23,7 @@ command sets. ATAPI cd/dvd drives and SATA disks that connect via a translation layer or a bridge device are examples of devices that use SCSI command sets. - There are about 32 command line utilities inside this package. + There are about 33 command line utilities inside this package. Command name Notes ============ =================================================== sg_get_config fetch features and profiles of a cd/dvd drive and/or @@ -70,6 +70,8 @@ sg_sat_identify Send ATA IDENTIFY DEVICE or IDENTIFY PACKET DEVICE commands via the SAT ATA PASS-THROUGH (16 or 12) SCSI command. + sg_sat_phy_event Sends an ATA READ LOG EXT command via a SAT to + fetch log page 11h which contains SATA phy event counters. sg_sat_set_features Sends ATA SET FEATURES command via SAT. sg_senddiag Issues either a default self test or a short/extended foreground/background self test. With no arguments it @@ -125,6 +127,7 @@ /usr/sbin/sg_rtpg Uncommitted Command /usr/sbin/sg_safte Uncommitted Command /usr/sbin/sg_sat_identify Uncommitted Command + /usr/sbin/sg_sat_phy_event Uncommitted Command /usr/sbin/sg_sat_set_features Uncommitted Command /usr/sbin/sg_senddiag Uncommitted Command /usr/sbin/sg_ses Uncommitted Command @@ -137,9 +140,9 @@ /usr/sbin/sg_wr_mode Uncommitted Command /usr/sbin/sg_write_buffer Uncommitted Command /usr/sbin/sg_write_long Uncommitted Command - /usr/lib/libsgutils.so Private Symbolic link - /usr/lib/libsgutils.so.1 Private Symbolic link - /usr/lib/libsgutils.so.1.0.0 Private Shared library file + /usr/lib/libsgutils2.so Private Symbolic link + /usr/lib/libsgutils2.so.2 Private Symbolic link + /usr/lib/libsgutils2.so.2.0.0 Private Shared library file /usr/share/man/man1m/sg_read_long.1m Uncommitted Manpage /usr/share/man/man1m/sg_safte.1m Uncommitted Manpage /usr/share/man/man1m/sg_senddiag.1m Uncommitted Manpage @@ -156,6 +159,7 @@ /usr/share/man/man1m/sg_rdac.1m Uncommitted Manpage /usr/share/man/man1m/sg_rtpg.1m Uncommitted Manpage /usr/share/man/man1m/sg_sat_identify.1m Uncommitted Manpage + /usr/share/man/man1m/sg_sat_phy_event.1m Uncommitted Manpage /usr/share/man/man1m/sg_start.1m Uncommitted Manpage /usr/share/man/man1m/sg_verify.1m Uncommitted Manpage /usr/share/man/man1m/sg_modes.1m Uncommitted Manpage --- sg3utils-indiana-checklist-1.25.txt Wed Dec 17 15:25:09 2008 +++ sg3utils-indiana-checklist-1.26.txt Tue Jan 13 15:16:39 2009 @@ -354,6 +354,7 @@ /usr/sbin/sg_rtpg Uncommitted Command /usr/sbin/sg_safte Uncommitted Command /usr/sbin/sg_sat_identify Uncommitted Command + /usr/sbin/sg_sat_phy_event Uncommitted Command /usr/sbin/sg_sat_set_features Uncommitted Command /usr/sbin/sg_senddiag Uncommitted Command /usr/sbin/sg_ses Uncommitted Command @@ -366,9 +367,9 @@ /usr/sbin/sg_wr_mode Uncommitted Command /usr/sbin/sg_write_buffer Uncommitted Command /usr/sbin/sg_write_long Uncommitted Command - /usr/lib/libsgutils.so Private Symbolic link - /usr/lib/libsgutils.so.1 Private Symbolic link - /usr/lib/libsgutils.so.1.0.0 Private Shared library file + /usr/lib/libsgutils2.so Private Symbolic link + /usr/lib/libsgutils2.so.2 Private Symbolic link + /usr/lib/libsgutils2.so.2.0.0 Private Shared library file /usr/share/man/man1m/sg_read_long.1m Uncommitted Manpage /usr/share/man/man1m/sg_safte.1m Uncommitted Manpage /usr/share/man/man1m/sg_senddiag.1m Uncommitted Manpage @@ -385,6 +386,7 @@ /usr/share/man/man1m/sg_rdac.1m Uncommitted Manpage /usr/share/man/man1m/sg_rtpg.1m Uncommitted Manpage /usr/share/man/man1m/sg_sat_identify.1m Uncommitted Manpage + /usr/share/man/man1m/sg_sat_phy_event.1m Uncommitted Manpage /usr/share/man/man1m/sg_start.1m Uncommitted Manpage /usr/share/man/man1m/sg_verify.1m Uncommitted Manpage /usr/share/man/man1m/sg_modes.1m Uncommitted Manpage @@ -412,7 +414,7 @@ Appendix B - Suggested case materials 1. man pages -SG3_UTILS SG_GET_CONFIG(8) +SG3_UTILS SG_GET_CONFIG(1M) NAME sg_get_config - sends a SCSI GET CONFIGURATION command @@ -419,19 +421,20 @@ SYNOPSIS sg_get_config [--brief] [--current] [--help] [--hex] - [--inner-hex] [--list] [--rt=RT] [--starting=FC] [--verbose] - [--version] DEVICE + [--inner-hex] [--list] [--raw] [--rt=RT] [--starting=FC] + [--verbose] [--version] DEVICE DESCRIPTION Sends a SCSI GET CONFIGURATION command to DEVICE and decodes the response. The response includes the features and pro- - files of the device. Typically these devices are CD and DVD - players that may (but not necessarily) have media in them. - These devices may well be connected via ATAPI, USB or IEEE - 1394 transports. In such cases they are "SCSI" devices only - in the sense that they use the "Multi-Media command" set - (MMC). MMC is a specialized SCSI command set whose defini- - tion can be found at http://www.t10.org . + files of the device. Typically these devices are CD, DVD, + HD-DVD and BD players that may (but not necessarily) have + media in them. These devices may well be connected via + ATAPI, USB or IEEE 1394 transports. In such cases they are + "SCSI" devices only in the sense that they use the + "Multi-Media command" set (MMC). MMC is a specialized SCSI + command set whose definition can be found at + http://www.t10.org . This utility is based on the MMC-4 and MMC-5 draft stan- dards. See section 5 on "Features and Profile for @@ -439,15 +442,16 @@ feature parameters and profiles. The manufacturer's product manual may also be useful. - Since modern DVD writers support many features and profiles, - the decoded output from this utility can be large. There are - various ways to cut down the output. If the --brief option - is used only the feature names are shown and the feature - parameters are not decoded. Alternatively if only one - feature is of interest then this combination of options is - appropriate: "--rt=2 --starting=FC". Another possibility is - to show only the features that are relevant to the media in - the drive (i.e. "current") with the "--rt=1" option. + Since modern DVD and BD writers support many features and + profiles, the decoded output from this utility can be large. + There are various ways to cut down the output. If the + --brief option is used only the feature names are shown and + the feature parameters are not decoded. Alternatively if + only one feature is of interest then this combination of + options is appropriate: "--rt=2 --starting=FC". Another pos- + sibility is to show only the features that are relevant to + the media in the drive (i.e. "current") with the "--rt=1" + option. OPTIONS Arguments to long options are mandatory for short options as @@ -465,12 +469,11 @@ -h, --help output the usage message then exit. - -H, --hex +sg3_utils-1.26 Last change: May 2008 1 -sg3_utils-1.24 Last change: February 2007 1 +SG3_UTILS SG_GET_CONFIG(1M) -SG3_UTILS SG_GET_CONFIG(8) - + -H, --hex output the response in hex (don't decode response). -i, --inner-hex @@ -503,6 +506,11 @@ 2 : only feature whose code is FC 3 : reserved + -R, --raw + output response in binary (to stdout). Note that the + short form is -R unlike most other utilities in this + package that use -r for this action. + -s, --starting=FC where FC is the feature code value. This option works closely with the --rt=RT option. The FC value is in the @@ -516,6 +524,10 @@ -V, --version print the version string and then exit. +sg3_utils-1.26 Last change: May 2008 2 + +SG3_UTILS SG_GET_CONFIG(1M) + NOTES There are multiple versions of the MMC (draft) standards: MMC [1997], MMC-2 [2000], MMC-3 [2002], MMC-4 and MMC-5. @@ -523,11 +535,6 @@ they became standards shown in brackets. The draft immedi- ately prior to standardization can be found at http://www.t10.org . In the initial MMC standard there was - -sg3_utils-1.24 Last change: February 2007 2 - -SG3_UTILS SG_GET_CONFIG(8) - no GET CONFIGURATION command and the relevant information was obtained from the "CD capabilities and mechanical status mode page" (mode page 0x2a). It was later renamed the "MM @@ -538,8 +545,8 @@ (blue ray) media type can only be found by using the GET CONFIGURATION command. Hence older CD players may not sup- port the GET CONFIGURATION command in which case the "MM - capabilities ..." mode page can be checked with sdparm(8), - sginfo(8) or sg_modes(8). + capabilities ..." mode page can be checked with sdparm(1M), + sginfo(1M) or sg_modes(1M). In the 2.4 series of Linux kernels the DEVICE must be a SCSI generic (sg) device. In the 2.6 series block devices can @@ -551,7 +558,7 @@ EXIT STATUS The exit status of sg_get_config is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -560,19 +567,38 @@ Report bugs to . COPYRIGHT - Copyright O 2004-2007 Douglas Gilbert + Copyright O 2004-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. SEE ALSO - sginfo(8), sg_modes(8), sg_inq(8), sg_prevent(8), - sg_start(8) [all in sg3_utils], sdparm(8) + sginfo(1M), sg_modes(1M), sg_inq(1M), sg_prevent(1M), + sg_start(1M) [all in sg3_utils], sdparm(1M) -sg3_utils-1.24 Last change: February 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_IDENT(8) +sg3_utils-1.26 Last change: May 2008 3 +SG3_UTILS SG_GET_CONFIG(1M) + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: May 2008 4 + +SG3_UTILS SG_IDENT(1M) + NAME sg_ident - sends a SCSI REPORT or SET IDENTIFYING INFORMA- TION command @@ -627,7 +653,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_IDENT(8) +SG3_UTILS SG_IDENT(1M) -i, --itype=IT where IT is the information type. Defaults to zero. The @@ -683,7 +709,7 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_IDENT(8) +SG3_UTILS SG_IDENT(1M) # sg_ident --ascii /dev/sdb 1234567890 @@ -697,7 +723,7 @@ EXIT STATUS The exit status of sg_ident is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -715,9 +741,24 @@ sg_vpd(sg3_utils), sg_rmsn(sg3_utils), sg_get_config(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_INQ(8) +SG3_UTILS SG_INQ(1M) NAME sg_inq - sends a SCSI INQUIRY or ATA IDENTIFY (PACKET) DEV- @@ -725,8 +766,8 @@ SYNOPSIS sg_inq [--ata] [--cmddt] [--descriptors] [--extended] - [--help] [--hex] [--id] [--len=LEN] [--page=PG] [--raw] - [--verbose] [--version] [--vpd] DEVICE + [--help] [--hex] [--id] [--len=LEN] [--maxlen=LEN] + [--page=PG] [--raw] [--verbose] [--version] [--vpd] DEVICE sg_inq [-36] [-a] [-A] [-b] [-c] [-cl] [-d] [-e] [-h] [-H] [-i] [-l=LEN] [-m] [-M] [-o=OPCODE_PG] [-p=VPD_PG] [-P] [-r] @@ -750,7 +791,7 @@ SPC-3, support for this page has been flagged as mandatory. The --id option decodes this page. To get fine grained decoding of this VPD page and others, including some vendor - specific VPD pages, see the sg_vpd(8) utility. + specific VPD pages, see the sg_vpd(1M) utility. If the DEVICE exists and the SCSI INQUIRY fails (because the SG_IO ioctl is not supported) then an ATA IDENTIFY (PACKET) @@ -772,9 +813,9 @@ well. The options are arranged in alphabetical order based on the long option name. -sg3_utils-1.25 Last change: August 2007 1 +sg3_utils-1.26 Last change: February 2008 1 -SG3_UTILS SG_INQ(8) +SG3_UTILS SG_INQ(1M) -a, --ata Assume given DEVICE is an ATA or ATAPI device which can @@ -794,7 +835,7 @@ inclusive) only outputting a line for found commands. The CmdDt bit is now obsolete. It has been replaced by the REPORT SUPPORTED OPERATION CODES command, see the - sg_opcodes(8) utility. + sg_opcodes(1M) utility. -d, --descriptors decodes and prints the version descriptors found in a @@ -829,9 +870,9 @@ ATA IDENTIFY (PACKET) DEVICE response in hexadecimal words suitable for input to 'hdparm --Istdin'. See -sg3_utils-1.25 Last change: August 2007 2 +sg3_utils-1.26 Last change: February 2008 2 -SG3_UTILS SG_INQ(8) +SG3_UTILS SG_INQ(1M) note below. @@ -849,6 +890,11 @@ greater than 0 then only one INQUIRY command is per- formed. See paragraph below about "36 byte INQUIRYs". + -m, --maxlen=LEN + this option has the same action as the --len=LEN + option. It has been added for compatibility with the + sg_vpd, sg_modes and sg_logs utilities. + -O, --old switch to older style options. @@ -880,16 +926,16 @@ NOTES Some devices with weak SCSI command set implementations lock + +sg3_utils-1.26 Last change: February 2008 3 + +SG3_UTILS SG_INQ(1M) + up when they receive commands they don't understand (or even response lengths that they don't expect). Such devices need to be treated carefully, use the '--len=36' option. Without this option this utility will issue an initial standard INQUIRY requesting 36 bytes of response data. If the device - -sg3_utils-1.25 Last change: August 2007 3 - -SG3_UTILS SG_INQ(8) - indicates it could have supplied more data then a second INQUIRY is issued to fetch the longer response. That second command may lock up faulty devices. @@ -921,13 +967,13 @@ ATA DEVICES There are two major types of ATA devices: non-packet devices (e.g. ATA disks) and packet devices (ATAPI). The majority of - ATAPI devices are CD/DVD drives in which the ATAPI transport - carries the MMC set (i.e. a SCSI command set). Further, - both types of ATA devices can be connected to a host com- - puter via a "SCSI" (or some other) transport. When an ATA - disk is controlled via a SCSI (or non-ATA) transport then - two approaches are commonly used: tunnelling (e.g. STP in - Serial Attached SCSI (SAS)) or by emulating a SCSI device + ATAPI devices are CD/DVD/BD drives in which the ATAPI tran- + sport carries the MMC set (i.e. a SCSI command set). + Further, both types of ATA devices can be connected to a + host computer via a "SCSI" (or some other) transport. When + an ATA disk is controlled via a SCSI (or non-ATA) transport + then two approaches are commonly used: tunnelling (e.g. STP + in Serial Attached SCSI (SAS)) or by emulating a SCSI device (e.g. with a SCSI to ATA translation layer, see SAT at www.t10.org ). Even when the physical transport to the host computer is ATA (especially in the case of SATA) the operat- @@ -937,17 +983,17 @@ The main identifying command for any SCSI device is an INQUIRY. The corresponding command for an ATA non-packet device is IDENTIFY DEVICE while for an ATA packet device it - is IDENTIFY PACKET DEVICE. - When this utility is invoked for an ATAPI device (e.g. a - CD/DVD drive with "sg_inq /dev/hdc") then a SCSI INQUIRY is - sent to the device and if it responds then the response to +sg3_utils-1.26 Last change: February 2008 4 -sg3_utils-1.25 Last change: August 2007 4 +SG3_UTILS SG_INQ(1M) -SG3_UTILS SG_INQ(8) + is IDENTIFY PACKET DEVICE. - decoded and output and this utility exits. To see the + When this utility is invoked for an ATAPI device (e.g. a + CD/DVD/BD drive with "sg_inq /dev/hdc") then a SCSI INQUIRY + is sent to the device and if it responds then the response + to decoded and output and this utility exits. To see the response for an ATA IDENTIFY PACKET DEVICE command add the --ata option (e.g. "sg_inq --ata /dev/hdc). @@ -955,12 +1001,12 @@ (PACKET) DEVICE command, hdparm does a good job at that. The '-HHH' option has been added for use with either the '--ata' or '--page=ai' option to produce a format acceptable to - "hdparm --Istdin". An example: 'sg_inq --ata -HHH /dev/hdc | - hdparm --Istdin'. See hdparm. + "hdparm --Istdin". An example: 'sg_inq --ata -HHH /dev/hdc + | hdparm --Istdin'. See hdparm. EXIT STATUS The exit status of sg_inq is 0 when it is successful. Other- - wise see the sg3_utils(8) man page. + wise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -994,16 +1040,16 @@ -cl lists the command data for all supported commands (fol- lowed by the command name) by looping through all 256 - opcodes. This option uses the CmdDt bit which is now - obsolete. See the sg_opcodes(8) utility. Equivalent to - '--cmddt --cmddt' in the main description. - -d decodes depending on context. If -e option is given, or +sg3_utils-1.26 Last change: February 2008 5 -sg3_utils-1.25 Last change: August 2007 5 +SG3_UTILS SG_INQ(1M) -SG3_UTILS SG_INQ(8) + opcodes. This option uses the CmdDt bit which is now + obsolete. See the sg_opcodes(1M) utility. Equivalent + to '--cmddt --cmddt' in the main description. + -d decodes depending on context. If -e option is given, or any option that implies -e (e.g. '-i' or '-p=80'), then this utility attempts to decode the indicated VPD page. Otherwise the version descriptors (if any) are listed @@ -1051,16 +1097,17 @@ known). To decode the mandatory device identification page (0x83) use the -i option. A now obsolete usage is when the -c option is given in which case the argument + +sg3_utils-1.26 Last change: February 2008 6 + +SG3_UTILS SG_INQ(1M) + to this option is assumed to be a command opcode number. Recent SCSI draft standards have moved this - facility to a separate command (see sg_opcodes(8)). + facility to a separate command (see sg_opcodes(1M)). Defaults to 0 so if -e is given without this option then VPD page 0 is output. -sg3_utils-1.25 Last change: August 2007 6 - -SG3_UTILS SG_INQ(8) - -p=VPD_PG same action as -o=OPCODE_PG option described in the previous entry. Since the opcode value with the CmdDt @@ -1102,18 +1149,37 @@ Report bugs to . COPYRIGHT - Copyright O 2001-2007 Douglas Gilbert + Copyright O 2001-2008 Douglas Gilbert This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +sg3_utils-1.26 Last change: February 2008 7 + +SG3_UTILS SG_INQ(1M) + SEE ALSO - sg_opcodes(8), sg_vpd(8), hdparm(8), sgdiag(scsirastools) + sg_opcodes(1M), sg_vpd(1M), hdparm(1M), sgdiag(scsirastools) -sg3_utils-1.25 Last change: August 2007 7 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_LOGS(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: February 2008 8 + +SG3_UTILS SG_LOGS(1M) + NAME sg_logs - access log pages with SCSI LOG SENSE command @@ -1169,7 +1235,7 @@ sg3_utils-1.24 Last change: April 2007 1 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) 0 : current threshold values 1 : current cumulative values @@ -1226,7 +1292,7 @@ sg3_utils-1.24 Last change: April 2007 2 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) -P, --paramp=PP PP is the parameter pointer value to place in a field @@ -1283,7 +1349,7 @@ sg3_utils-1.24 Last change: April 2007 3 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) cycles. This option is typically not needed, especially if the GLTSD flag is clear in the control mode page as @@ -1321,7 +1387,7 @@ Various log pages hold information error rates, device tem- perature, start stop cycles since device produced and the results of the last 20 self tests. Self tests can be ini- - tiated by the sg_senddiag(8) utility. The smartmontools + tiated by the sg_senddiag(1M) utility. The smartmontools package provides much of the information found with sg_logs in a form suitable for monitoring the health of SCSI disks and tape drives. @@ -1340,7 +1406,7 @@ sg3_utils-1.24 Last change: April 2007 4 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) 0x5 Verify error counter 0x6 Non-medium error @@ -1367,7 +1433,7 @@ EXIT STATUS The exit status of sg_logs is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -1397,7 +1463,7 @@ sg3_utils-1.24 Last change: April 2007 5 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) --hex in the main description. @@ -1453,7 +1519,7 @@ sg3_utils-1.24 Last change: April 2007 6 -SG3_UTILS SG_LOGS(8) +SG3_UTILS SG_LOGS(1M) -T outputs the transport ('Protocol specific port') log page. Equivalent to --transport in the main descrip- @@ -1478,18 +1544,33 @@ A PARTICULAR PURPOSE. SEE ALSO - smartctl(smartmontools), sg_senddiag(8) + smartctl(smartmontools), sg_senddiag(1M) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.24 Last change: April 2007 7 -SG3_UTILS SG_LUNS(8) +SG3_UTILS SG_LUNS(1M) NAME sg_luns - send the SCSI REPORT LUNS command SYNOPSIS - sg_luns [--decode] [--help] [--hex] [--quiet] [--raw] - [--select=SR] [--verbose] [--version] DEVICE + sg_luns [--decode] [--help] [--hex] [--maxlen=LEN] [--quiet] + [--raw] [--select=SR] [--verbose] [--version] DEVICE DESCRIPTION Send the SCSI REPORT LUNS command to the DEVICE and outputs @@ -1511,6 +1592,12 @@ -H, --hex output response to this command in ASCII hex. + -m, --maxlen=LEN + where LEN is the (maximum) response length in bytes. It + is placed in the cdb's "allocation length" field. If + not given (or LEN is zero) then 65536 is used. The max- + imum value of LEN is 65536. + -q, --quiet output ASCII hex rendering of each report lun, one per line. @@ -1530,6 +1617,11 @@ logical units addressable via this "I_T" nexus. When 2 is given the DEVICE should yield all luns addressable via this "I_T" nexus. To simplify, for the I_T nexus + +sg3_utils-1.26 Last change: April 2008 1 + +SG3_UTILS SG_LUNS(1M) + associated with the DEVICE, the meanings of the SR values are: 0 : all luns excluding well known logical units @@ -1537,10 +1629,6 @@ 2 : all luns Values greater than 2 are reserved (at SPC-4 (rev 8)). -sg3_utils-1.24 Last change: March 2007 1 - -SG3_UTILS SG_LUNS(8) - -v, --verbose increase the level of verbosity, (i.e. debug output). @@ -1549,7 +1637,7 @@ EXIT STATUS The exit status of sg_luns is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -1558,18 +1646,33 @@ Report bugs to . COPYRIGHT - Copyright O 2004-2007 Douglas Gilbert + Copyright O 2004-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. SEE ALSO - sg_inq(8) + sg_inq(1M) -sg3_utils-1.24 Last change: March 2007 2 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_MODES(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: April 2008 2 + +SG3_UTILS SG_MODES(1M) + NAME sg_modes - reads mode pages with SCSI MODE SENSE command @@ -1576,12 +1679,12 @@ SYNOPSIS sg_modes [--all] [--control=PC] [--dbd] [--dbout] [--exam- ine] [--flexible] [--help] [--hex] [--list] [--llbaa] - [--page=PG[,SPG]] [--raw] [-R] [--six] [--verbose] [--ver- - sion] [DEVICE] + [--maxlen=LEN] [--page=PG[,SPG]] [--raw] [-R] [--six] + [--verbose] [--version] [DEVICE] sg_modes [-6] [-a] [-A] [-c=PC] [-d] [-D] [-e] [-f] [-h] - [-H] [-l] [-L] [-p=PG[,SPG]] [-r] [-subp=SPG] [-v] [-V] [-?] - [DEVICE] + [-H] [-l] [-L] [-m=LEN] [-p=PG[,SPG]] [-r] [-subp=SPG] [-v] + [-V] [-?] [DEVICE] DESCRIPTION This utility sends a MODE SENSE SCSI command to the DEVICE @@ -1623,9 +1726,9 @@ 2 : default values (i.e. the manufacturer's settings) 3 : saved values -sg3_utils-1.24 Last change: February 2007 1 +sg3_utils-1.26 Last change: January 2008 1 -SG3_UTILS SG_MODES(8) +SG3_UTILS SG_MODES(1M) The changeable values are bit masks showing which fields could be changed with a MODE SELECT. The saved @@ -1680,9 +1783,9 @@ that are found in the command set that matches the peripheral type of the given DEVICE. If no DEVICE and -sg3_utils-1.24 Last change: February 2007 2 +sg3_utils-1.26 Last change: January 2008 2 -SG3_UTILS SG_MODES(8) +SG3_UTILS SG_MODES(1M) no --page=PG is given then the common page and subpage codes and their names are listed for SBC (e.g. a disk). @@ -1706,6 +1809,15 @@ field in the response. In most cases setting this option is not needed. + -m, --maxlen=LEN + The LEN argument is the maximum response length in + bytes. It is the 'allocation length' field in the cdb. + When not given (or LEN is zero) then the allocation + length field is set to 4096 for MODE SENSE (10) or 252 + for MODE SENSE (6). The LEN argument must be non- + negative and no greater than 65535 for MODE SENSE (10) + and not greater than 255 for MODE SENSE (6). + -O, --old switch to older style options. @@ -1727,22 +1839,22 @@ output the response in binary to stdout. Error messages and warnings, if any, are sent to stderr. When this option is used twice (e.g. '-rr') then has the same + +sg3_utils-1.26 Last change: January 2008 3 + +SG3_UTILS SG_MODES(1M) + action as '-R' -R output the selected mode page to stdout a byte per line. Each line contains two hexadecimal digits (e.g. "3e"). Useful as input (after editing) to the - sg_wr_mode(8) utility. + sg_wr_mode(1M) utility. -6, --six - by default this utility sends a 10 byte MODE SENSE - -sg3_utils-1.24 Last change: February 2007 3 - -SG3_UTILS SG_MODES(8) - - command to the DEVICE. However some SCSI devices only - support 6 byte MODE SENSE commands (e.g. SCSI-2 tape + by default this utility sends a 10 byte MODE SENSE com- + mand to the DEVICE. However some SCSI devices only sup- + port 6 byte MODE SENSE commands (e.g. SCSI-2 tape drives). This parameter forces the use of 6 byte MODE SENSE commands. @@ -1770,7 +1882,7 @@ EXIT STATUS The exit status of sg_modes is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -1784,6 +1896,10 @@ byte MODE SENSE commands. See --six in the main description. +sg3_utils-1.26 Last change: January 2008 4 + +SG3_UTILS SG_MODES(1M) + -a see --all in the main description. -A output all the mode pages and subpages supported by the @@ -1793,10 +1909,6 @@ PC is the page control value. See --control=PC in the main description. -sg3_utils-1.24 Last change: February 2007 4 - -SG3_UTILS SG_MODES(8) - -d see --dbd in the main description. -D see --dbout in the main description. @@ -1818,6 +1930,9 @@ -N switch to the newer style options. + -m=LEN + see --maxlen=LEN in the main description. + -p=PG PG is page code to fetch. Should be a hexadecimal number between 0 and 3f inclusive (0 to 63 decimal). @@ -1834,9 +1949,14 @@ -r output the selected mode page to stdout a byte per line. Each line contains two hexadecimal digits (e.g. "3e"). Useful as input (after editing) to the - sg_wr_mode(8) utility. + sg_wr_mode(1M) utility. -subp=SPG + +sg3_utils-1.26 Last change: January 2008 5 + +SG3_UTILS SG_MODES(1M) + sub page code to fetch. Should be a hexadecimal number between 0 and 0xff inclusive. The default value is 0. @@ -1850,30 +1970,42 @@ AUTHOR Written by Doug Gilbert -sg3_utils-1.24 Last change: February 2007 5 - -SG3_UTILS SG_MODES(8) - REPORTING BUGS Report bugs to . COPYRIGHT - Copyright O 2000-2007 Douglas Gilbert + Copyright O 2000-2008 Douglas Gilbert This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. SEE ALSO - sdparm(8), sg_wr_mode(8), sginfo(8), sgmode(scsirastools), - scsiinfo(net), scu(net), seatools(seagate) + sdparm(1M), sg_wr_mode(1M), sginfo(1M), + sgmode(scsirastools), scsiinfo(net), scu(net), + seatools(seagate) All these utilities offer some facility to change mode page (or block descriptor) parameters. -sg3_utils-1.24 Last change: February 2007 6 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_OPCODES(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: January 2008 6 + +SG3_UTILS SG_OPCODES(1M) + NAME sg_opcodes - reports information on supported SCSI commands or task management functions @@ -1906,7 +2038,7 @@ A similar facility to query supported operation codes previ- ously was available via the CmdDt bit in the SCSI INQUIRY - command (see sg_inq(8)). However that facility was made + command (see sg_inq(1M)). However that facility was made obsolete and replaced by the REPORT SUPPORTED OPERATION CODES command in SPC-3 (revision 4) during February 2002. @@ -1929,7 +2061,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_OPCODES(8) +SG3_UTILS SG_OPCODES(1M) commands is sorted numerically (first by operation code and then by service action). @@ -1985,7 +2117,7 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_OPCODES(8) +SG3_UTILS SG_OPCODES(1M) -u, --unsorted when all supported commands are being listed there is @@ -2017,7 +2149,7 @@ EXIT STATUS The exit status of sg_opcodes is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -2041,7 +2173,7 @@ sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_OPCODES(8) +SG3_UTILS SG_OPCODES(1M) -R set the report command timeout descriptor (RCTD) bit in cdb. Equivalent to --rctd in main description. @@ -2083,10 +2215,29 @@ SEE ALSO sg_inq(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + sg3_utils-1.23 Last change: January 2007 4 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_OPCODES(1M) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.23 Last change: January 2007 5 + +SG3_UTILS SG_PERSIST(1M) + NAME sg_persist - sends a SCSI PERSISTENT RESERVE (IN or OUT) command to manipulate registrations and reservations @@ -2138,9 +2289,9 @@ sistent reservation commands. See a utility called 'scsires' for support of the SCSI RESERVE and RELEASE commands. -sg3_utils-1.25 Last change: October 2007 1 +sg3_utils-1.26 Last change: March 2008 1 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) The DEVICE is required by all variants of this utility apart from --help. The DEVICE can be given either as an argument @@ -2195,9 +2346,9 @@ -o, --out specify that a SCSI PERSISTENT RESERVE OUT command is -sg3_utils-1.25 Last change: October 2007 2 +sg3_utils-1.26 Last change: March 2008 2 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) required. @@ -2252,9 +2403,9 @@ trants, 8-> exclusive access - all registrants. Default value is 0 (which is an invalid type). Each "persistent -sg3_utils-1.25 Last change: October 2007 3 +sg3_utils-1.26 Last change: March 2008 3 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) reservation type" is explained in more detail in a sub- section of that name in the read reservation section of @@ -2298,7 +2449,7 @@ Register and Ignore Existing Key is a sub-command of the PROUT command. Similar to --register except that when changing a reservation key the old key is not - specified. The '--prout-sark=' option should + specified. The '--param-sark=' option should also be given. -M, --register-move @@ -2309,9 +2460,9 @@ the term I_T nexus but the point to stress is that there are two initiators (the one sending this command -sg3_utils-1.25 Last change: October 2007 4 +sg3_utils-1.26 Last change: March 2008 4 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) and another one) but only one logical unit.] The --prout-type=TYPE and --param-rk=RK options need to @@ -2366,9 +2517,9 @@ indicates stdin should be read for the transportID(s). Empty lines are ignored. Everything from and including -sg3_utils-1.25 Last change: October 2007 5 +sg3_utils-1.26 Last change: March 2008 5 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) a "#" on a line is ignored. Leading spaces and tabs are ignored. All numbers are assumed to be hexadecimal @@ -2403,9 +2554,9 @@ NOTES In the 2.4 series of Linux kernels the DEVICE must be a SCSI generic (sg) device. In the 2.6 series any SCSI device name - (e.g. /dev/sdc, /dev/st1m or /dev/sg3) can be specified. For - example "sg_persist --read-keys /dev/sda" will work in the - 2.6 series kernels. + (e.g. /dev/sdc, /dev/st1m or /dev/sg3) can be specified. + For example "sg_persist --read-keys /dev/sda" will work in + the 2.6 series kernels. The only scope for PROUT commands supported in the current draft of SPC-4 is "LU_SCOPE". Hence there seems to be no @@ -2422,9 +2573,9 @@ EXAMPLES -sg3_utils-1.25 Last change: October 2007 6 +sg3_utils-1.26 Last change: March 2008 6 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) Due to defaults the simplest example executes the 'read keys' sub-command of the PRIN command: @@ -2474,20 +2625,20 @@ EXIT STATUS The exit status of sg_persist is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHOR Written by Doug Gilbert -sg3_utils-1.25 Last change: October 2007 7 +sg3_utils-1.26 Last change: March 2008 7 -SG3_UTILS SG_PERSIST(8) +SG3_UTILS SG_PERSIST(1M) REPORTING BUGS Report bugs to . COPYRIGHT - Copyright O 2004-2007 Douglas Gilbert + Copyright O 2004-2008 Douglas Gilbert This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -2496,10 +2647,25 @@ scsires(internet), examples/sg_persist_tst.sh(sg3_utils tar- ball) -sg3_utils-1.25 Last change: October 2007 8 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_PREVENT(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: March 2008 8 + +SG3_UTILS SG_PREVENT(1M) + NAME sg_prevent - sends a SCSI PREVENT ALLOW MEDIUM REMOVAL com- mand @@ -2555,11 +2721,11 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_PREVENT(8) +SG3_UTILS SG_PREVENT(1M) EXIT STATUS The exit status of sg_prevent is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -2576,9 +2742,24 @@ SEE ALSO sg_start(sg3_utils), sg_persist(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_RAW(8) +SG3_UTILS SG_RAW(1M) NAME sg_raw - sends an arbitrary SCSI command (with an optional @@ -2624,19 +2805,21 @@ Don't display SCSI Sense information. -o, --outfile=OFILE - Write data received from the DEVICE to OFILE. By - default, data is dumped in hex format to stdout. This - option is ignored if --request is not specified. + Write data received from the DEVICE to OFILE. The data + is written in binary. By default, data is dumped in hex + format to stdout. If OFILE is '-' then data is dumped + in binary to stdout. This option is ignored if + --request is not specified. -r, --request=RLEN Expect to receive up to RLEN bytes of data from the - DEVICE. RLEN may be suffixed with 'k' to use kilobytes - (1024 bytes) instead of bytes. This option and --send -sg3_utils-1.24 Last change: April 2007 1 +sg3_utils-1.26 Last change: May 2008 1 -SG3_UTILS SG_RAW(8) +SG3_UTILS SG_RAW(1M) + DEVICE. RLEN may be suffixed with 'k' to use kilobytes + (1024 bytes) instead of bytes. This option and --send are mutually exclusive. -s, --send=SLEN @@ -2681,20 +2864,20 @@ EXIT STATUS The exit status of sg_raw is 0 when it is successful. Other- - wise see the sg3_utils(8) man page. + wise see the sg3_utils(1M) man page. AUTHOR Written by Ingo van Lil +sg3_utils-1.26 Last change: May 2008 2 + +SG3_UTILS SG_RAW(1M) + REPORTING BUGS Report bugs to . -sg3_utils-1.24 Last change: April 2007 2 - -SG3_UTILS SG_RAW(8) - COPYRIGHT - Copyright O 2001-2007 Ingo van Lil + Copyright O 2001-2008 Ingo van Lil This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -2703,10 +2886,25 @@ sg_opcodes sg_vpd(sg3_utils), hdparm(hdparm), sgdiag(scsirastools) -sg3_utils-1.24 Last change: April 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_RDAC(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: May 2008 3 + +SG3_UTILS SG_RDAC(1M) + NAME sg_rdac - Display or Modify RDAC Redundant Controller Page @@ -2733,7 +2931,7 @@ EXIT STATUS The exit status of sg_rdac is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHOR Written by Hannes Reinecke , based on @@ -2748,10 +2946,29 @@ is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_READ_BUFFER(8) +SG3_UTILS SG_RDAC(1M) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.23 Last change: January 2007 2 + +SG3_UTILS SG_READ_BUFFER(1M) + NAME sg_read_buffer - send a SCSI READ BUFFER command @@ -2807,7 +3024,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_READ_BUFFER(8) +SG3_UTILS SG_READ_BUFFER(1M) -v, --verbose increase the level of verbosity, (i.e. debug output). @@ -2823,7 +3040,7 @@ EXIT STATUS The exit status of sg_read_buffer is 0 when it is success- - ful. Otherwise see the sg3_utils(8) man page. + ful. Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Luben Tuikov and Douglas Gilbert. @@ -2840,9 +3057,24 @@ SEE ALSO sg_write_buffer(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_READCAP(8) +SG3_UTILS SG_READCAP(1M) NAME sg_readcap - sends a SCSI READ CAPACITY command @@ -2899,7 +3131,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_READCAP(8) +SG3_UTILS SG_READCAP(1M) used in conjunction with --pmi option. This variant of READ CAPACITY will yield the last block address after @@ -2955,7 +3187,7 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_READCAP(8) +SG3_UTILS SG_READCAP(1M) In the 2.4 series of Linux kernels the DEVICE must be a SCSI generic (sg) device. In the 2.6 series block devices (e.g. @@ -2966,7 +3198,7 @@ EXIT STATUS The exit status of sg_readcap is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -3011,7 +3243,7 @@ sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_READCAP(8) +SG3_UTILS SG_READCAP(1M) -v verbose: print out cdb of issued commands prior to exe- cution. '-vv' and '-vvv' are also accepted yielding @@ -3031,9 +3263,24 @@ SEE ALSO sg_inq(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 4 -SG3_UTILS SG_READ_LONG(8) +SG3_UTILS SG_READ_LONG(1M) NAME sg_read_long - send a SCSI READ LONG command @@ -3090,7 +3337,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_READ_LONG(8) +SG3_UTILS SG_READ_LONG(1M) the requested logical block address is read. The default is to leave the 'PBLOCK' bit clear in which @@ -3137,7 +3384,7 @@ EXIT STATUS The exit status of sg_read_long is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -3147,7 +3394,7 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_READ_LONG(8) +SG3_UTILS SG_READ_LONG(1M) COPYRIGHT Copyright O 2004-2007 Douglas Gilbert @@ -3158,9 +3405,24 @@ SEE ALSO sg_reassign, sg_write_long, sg_dd +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_REASSIGN(8) +SG3_UTILS SG_REASSIGN(1M) NAME sg_reassign - sends a SCSI REASSIGN BLOCKS command @@ -3217,7 +3479,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_REASSIGN(8) +SG3_UTILS SG_REASSIGN(1M) command. Since the REASSIGN BLOCKS command is essen- tially irreversible, paranoid users may wish to check @@ -3274,7 +3536,7 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_REASSIGN(8) +SG3_UTILS SG_REASSIGN(1M) NOTES Note that if the ARRE field (for reads) and/or the AWRE @@ -3326,11 +3588,11 @@ EXIT STATUS The exit status of sg_reassign is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_REASSIGN(8) +SG3_UTILS SG_REASSIGN(1M) AUTHORS Written by Douglas Gilbert. @@ -3348,22 +3610,43 @@ sg_format,sginfo,sg_senddiag(all in sg3_utils), sdparm(sdparm), smartmontools(internet, sourceforge) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 4 -SG3_UTILS SG_REQUESTS(8) +SG3_UTILS SG_REQUESTS(1M) NAME sg_requests - send one or more SCSI REQUEST SENSE commands SYNOPSIS - sg_requests [--desc] [--help] [--hex] [--num=NUM] [--raw] - [--status] [--time] [--verbose] [--version] DEVICE + sg_requests [--desc] [--help] [--hex] [--maxlen=LEN] + [--num=NUM] [--progress] [--raw] [--status] [--time] [--ver- + bose] [--version] DEVICE DESCRIPTION - Send REQUEST SENSE command to DEVICE and output the response - which is expected to be in sense data format. Both fixed and - descriptor format are supported. + Send SCSI REQUEST SENSE command to DEVICE and output the + parameter data response which is expected to be in sense + data format. Both fixed and descriptor sense data formats + are supported. + Multiple REQUEST SENSE commands can be sent with the + --num=NUM option. This can be used for timing purposes or + monitoring the progress indication. + OPTIONS Arguments to long options are mandatory for short options as well. @@ -3375,7 +3658,7 @@ recognizes descriptor format (SPC-3 and later). If the device is pre SPC-3 then setting a bit in a reserved field may cause a check condition status with an ille- - gal request sense key. + gal request sense key, but will most likely be ignored. -h, --help output the usage message then exit. @@ -3383,33 +3666,48 @@ -H, --hex output response in ASCII hexadecimal. + -m, --maxlen=LEN + where LEN is the (maximum) response length in bytes. It + is placed in the cdb's "allocation length" field. If + not given (or LEN is zero) then 252 is used. The max- + imum value of LEN is 255 (but SPC-4 recommends 252). + -n, --num=NUM perform NUM SCSI REQUEST SENSE commands, stopping when either NUM is reached or an error occurs. The default value for NUM is 1 . + -p, --progress + show progress indication (a percentage) if available. + If --number=NUM is given, NUM is greater than 1 and an + initial progress indication was detected then this + +sg3_utils-1.26 Last change: April 2008 1 + +SG3_UTILS SG_REQUESTS(1M) + + utility waits 30 seconds before subsequent checks. + Exits when NUM is reached or there are no more progress + indications. Ignores --hex, --raw and --time options. + See NOTES section below. + -r, --raw output response in binary (to stdout). -s, --status - if the last REQUEST SENSE finished without error (from - SCSI status or autosense) then the contents of the + if the REQUEST SENSE command finished without error (as + indicated by its SCSI status) then the contents of the parameter data are analysed as sense data and the exit - status is set accordingly. The default action (when - this option is not given) is to ignore the contents of - the parameter data for the purposes of setting the exit - status. Some types of error set a sense key of "NO - SENSE" with non-zero information in the additional - sense code (e.g. the FAILURE PREDICTION THRESHOLD - EXCEEDED group of codes); this results in an exit + status is set accordingly. The default action (i.e. + when this option is not given) is to ignore the con- + tents of the parameter data for the purposes of setting + the exit status. Some types of error set a sense key + of "NO SENSE" with non-zero information in the addi- + tional sense code (e.g. the FAILURE PREDICTION THRES- + HOLD EXCEEDED group of codes); this results in an exit status value of 10. If the sense key is "NO SENSE" and both asc and ascq are zero then the exit status is set - -sg3_utils-1.23 Last change: January 2007 1 - -SG3_UTILS SG_REQUESTS(8) - - to 0 . See the sg3_utils(8) man page for exit status + to 0 . See the sg3_utils(1M) man page for exit status values. -t, --time @@ -3430,24 +3728,44 @@ for error and warning processing in SCSI. The autosense capability rendered this command almost superfluous. - However recent SCSI drafts (e.g. SPC-3 rev 23 and SBC-2 rev - 16) increase the utility of the REQUEST SENSE command. Idle - and standby power conditions can now be detected with this - command; a progress indication is given during FORMAT (when - that command was started with with IMMED=1 in its parameter - header); and the Filemark, ILI and EOM bits may be set (e.g. - by a tape drive). Interestingly the sense key is set to "no - sense" while the asc/ascq code convey the information (e.g. - 0x5e/0x4 "Standby condition activated by command"). + However recent SCSI drafts (e.g. SPC-4 rev 14 and SBC-3 rev + 14) increase the utility of the REQUEST SENSE command. Idle + and standby (low) power conditions can be detected with this + command. The REQUEST SENSE command is not marked as mandatory in SPC-3 (i.e. for all SCSI devices) but is marked as mandatory in SBC-2 (i.e. for disks), SSC-3 (i.e. for tapes) and MMC-4 - (i.e. for CD/DVD drives). + (i.e. for CD/DVD/HD-DVD/BD drives). +sg3_utils-1.26 Last change: April 2008 2 + +SG3_UTILS SG_REQUESTS(1M) + + The progress indication is optionally part of the sense + data. When a prior command that takes a long time to com- + plete (and typically precludes other media access commands) + is still underway, the progress indication can be used to + determine how long before the device returns to its normal + state. + + The SCSI FORMAT command for disks used with the IMMED bit + set is an example of an operation that takes a significant + amount of time and precludes other media access during that + time. The IMMED bit set instructs the FORMAT command to + return control to the application client once the format has + commenced (see SBC-3). Several long duration SCSI commands + associated with tape drives also use the progress indication + (see SSC-3). + + Early standards suggested that the SCSI TEST UNIT READY com- + mand be used for polling the progress indication. More + recent standards seem to suggest the SCSI REQUEST SENSE com- + mand should be used instead. + EXIT STATUS The exit status of sg_requests is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -3456,22 +3774,37 @@ Report bugs to . COPYRIGHT - Copyright O 2004-2007 Douglas Gilbert + Copyright O 2004-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -sg3_utils-1.23 Last change: January 2007 2 - -SG3_UTILS SG_REQUESTS(8) - SEE ALSO sg3_utils -sg3_utils-1.23 Last change: January 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_RMSN(8) +sg3_utils-1.26 Last change: April 2008 3 +SG3_UTILS SG_REQUESTS(1M) + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: April 2008 4 + +SG3_UTILS SG_RMSN(1M) + NAME sg_rmsn - sends a SCSI READ MEDIA SERIAL NUMBER command @@ -3516,17 +3849,18 @@ page 0x83) and the "unit serial number" page (VPD page 0x80). - The MMC-4 command set for CDs and DVDs has a "media serial - number" feature (0x109) [and a "logical unit serial number" - feature]. These can be viewed with sg_get_config. + The MMC-4 command set for CD/DVD/HD-DVD/BD drives has a + "media serial number" feature (0x109) [and a "logical unit + serial number" feature]. These can be viewed with + sg_get_config. EXIT STATUS The exit status of sg_rmsn is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. -sg3_utils-1.23 Last change: January 2007 1 +sg3_utils-1.26 Last change: April 2008 1 -SG3_UTILS SG_RMSN(8) +SG3_UTILS SG_RMSN(1M) AUTHORS Written by Douglas Gilbert. @@ -3535,7 +3869,7 @@ Report bugs to . COPYRIGHT - Copyright O 2005-2007 Douglas Gilbert + Copyright O 2005-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -3543,10 +3877,25 @@ SEE ALSO sg_vpd(sg3_utils), sg_get_config(sg3_utils) -sg3_utils-1.23 Last change: January 2007 2 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_RTPG(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: April 2008 2 + +SG3_UTILS SG_RTPG(1M) + NAME sg_rtpg - sends a SCSI REPORT TARGET PORT GROUPS command @@ -3595,7 +3944,7 @@ EXIT STATUS The exit status of sg_rtpg is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -3602,7 +3951,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_RTPG(8) +SG3_UTILS SG_RTPG(1M) REPORTING BUGS Report bugs to . @@ -3616,9 +3965,24 @@ SEE ALSO sg_inq(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_SAFTE(8) +SG3_UTILS SG_SAFTE(1M) NAME sg_safte - Fetch status from a SCSI Accessed Fault-Tolerant @@ -3675,7 +4039,7 @@ sg3_utils-1.25 Last change: September 2007 1 -SG3_UTILS SG_SAFTE(8) +SG3_UTILS SG_SAFTE(1M) should be the enclosure configuration. If used twice (or more often), the response to subsequent READ BUFFER @@ -3731,11 +4095,11 @@ sg3_utils-1.25 Last change: September 2007 2 -SG3_UTILS SG_SAFTE(8) +SG3_UTILS SG_SAFTE(1M) EXIT STATUS The exit status of sg_safte is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Hannes Reinecke and Douglas Gilbert. @@ -3752,9 +4116,24 @@ SEE ALSO sg_inq, sg_ses (in sg3_utils package); safte-monitor +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.25 Last change: September 2007 3 -SG3_UTILS SG_SAT_IDENTIFY(8) +SG3_UTILS SG_SAT_IDENTIFY(1M) NAME sg_sat_identify - sends a ATA IDENTIFY (PACKET) DEVICE com- @@ -3761,8 +4140,9 @@ mand via a SCSI to ATA Translation (SAT) layer SYNOPSIS - sg_sat_identify [--chk_cond] [--help] [--hex] [--len=12|16] - [--packet] [--raw] [--verbose] [--version] DEVICE + sg_sat_identify [--ck_cond] [--extend] [--help] [--hex] + [--len=16|12] [--packet] [--raw] [--verbose] [--version] + DEVICE DESCRIPTION This utility sends either an ATA IDENTIFY DEVICE command or @@ -3784,7 +4164,7 @@ Arguments to long options are mandatory for short options as well. - -c, --chk_cond + -c, --ck_cond sets the CK_COND bit in the ATA PASS-THROUGH SCSI cdb. The default setting is clear (i.e. 0). When set the SATL should yield a sense buffer containing a ATA @@ -3793,6 +4173,12 @@ yield a sense buffer containing a ATA Result descriptor if the command failed. + -e, --extend + sets the EXTEND bit in the ATA PASS-THROUGH SCSI cdb. + The default setting is clear (i.e. 0). When set a 48 + bit LBA command is sent to the device. This option has + no effect when --len=12. + -h, --help outputs the usage message summarizing command line options then exits. Ignores DEVICE if given. @@ -3801,6 +4187,11 @@ outputs the ATA IDENTIFY (PACKET) DEVICE response in hex. The default action (i.e. without any '-H' options) is to output the response in hex, grouped in 16 bit + +sg3_utils-1.26 Last change: December 2007 1 + +SG3_UTILS SG_SAT_IDENTIFY(1M) + words (i.e. the ATA standard's preference). When given once, the response is output in ASCII hex bytes (i.e. the SCSI standard's preference). When given twice (i.e. @@ -3808,17 +4199,12 @@ the same as the default but without a header. When given thrice (i.e. '-HHH') the output is in hex, grouped in 16 bit words, in a format that is acceptable - -sg3_utils-1.24 Last change: May 2007 1 - -SG3_UTILS SG_SAT_IDENTIFY(8) - for 'hdparm --Istdin' to process. - -l, --len=12 | 16 + -l, --len=16 | 12 this is the length of the SCSI cdb used for the ATA - PASS-THROUGH commands. The argument can either be 12 - or 16. The default is 16. The larger cdb size is needed + PASS-THROUGH commands. The argument can either be 16 + or 12. The default is 16. The larger cdb size is needed for 48 bit LBA addressing of ATA devices. On the other hand some SCSI transports cannot convey SCSI commands longer than 12 bytes. @@ -3858,6 +4244,11 @@ In the 2.4 series of Linux kernels the DEVICE must be a SCSI generic (sg) device. In the 2.6 series block devices (e.g. + +sg3_utils-1.26 Last change: December 2007 2 + +SG3_UTILS SG_SAT_IDENTIFY(1M) + disks and ATAPI DVDs) can also be specified. For example "sg_inq /dev/sda" will work in the 2.6 series kernels. From lk 2.6.6 other SCSI "char" device names may be used as well @@ -3864,14 +4255,164 @@ (e.g. "/dev/st0m"). EXIT STATUS - The exit status of sg_sat_identify is 0 when it is + The exit status of sg_sat_identify is 0 when it is success- + ful. Otherwise see the sg3_utils(1M) man page. -sg3_utils-1.24 Last change: May 2007 2 +AUTHOR + Written by Doug Gilbert -SG3_UTILS SG_SAT_IDENTIFY(8) +REPORTING BUGS + Report bugs to . - successful. Otherwise see the sg3_utils(8) man page. +COPYRIGHT + Copyright O 2006-2007 Douglas Gilbert + This software is distributed under a FreeBSD license. There + is NO warranty; not even for MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. +SEE ALSO + sg_vpd(sg3_utils), sg_inq(sg3_utils), sdparm(sdparm), + hdparm(hdparm) + +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: December 2007 3 + +SG3_UTILS SG_SAT_PHY_EVENT(1M) + +NAME + sg_sat_phy_event - Sends an ATA READ LOG EXT command via a + SAT pass through to fetch log page 11h which contains SATA + phy event counters + +SYNOPSIS + sg_sat_phy_event [--ck_cond] [--extend] [--help] [--hex] + [--ignore] [--len=16|12] [--raw] [--reset] --verbose] + [--version] DEVICE + +DESCRIPTION + This utility sends an ATA READ LOG EXT with the log page + ("address") set to 11h to DEVICE and outputs the response. + Log page 11h is defined in the SATA 2.5 standard and con- + tains phy event counters. Rather than send this command + directly to the DEVICE, are sent via a SCSI transport which + is assumed to contain a SCSI to ATA Translation (SAT) Layer + (SATL). The SAT standard (SAT ANSI INCITS 431-2007, prior + draft: sat-r09.pdf at www.t10.org) defines two SCSI "ATA + PASS-THROUGH" commands: one using a 16 byte "cdb" and the + other with a 12 byte cdb. This utility defaults to using the + 16 byte cdb variant. + + The SATL may be in an operating system driver, in host bus + adapter firmware or in some external enclosure. + +OPTIONS + Arguments to long options are mandatory for short options as + well. + + -c, --ck_cond + sets the CK_COND bit in the ATA PASS-THROUGH SCSI cdb. + The default setting is clear (i.e. 0). When set the + SATL should yield a sense buffer containing a ATA + Result descriptor irrespective of whether the command + succeeded or failed. When clear the SATL should only + yield a sense buffer containing a ATA Result descriptor + if the command failed. + + -e, --extend + sets the EXTEND bit in the ATA PASS-THROUGH SCSI cdb. + The default setting is clear (i.e. 0). When set a 48 + bit LBA command is sent to the device. This option has + no effect when --len=12. + + -h, --help + outputs the usage message summarizing command line + options then exits. Ignores DEVICE if given. + + -H, --hex + outputs the ATA READ LOG EXT response in hex. The + default action (i.e. without any '-H' options) is to + +sg3_utils-1.26 Last change: December 2007 1 + +SG3_UTILS SG_SAT_PHY_EVENT(1M) + + output the response in hex, grouped in 16 bit words + (i.e. the ATA standard's preference). When given once, + the response is output in ASCII hex bytes (i.e. the + SCSI standard's preference). When given twice (i.e. + '-HH') the output is in hex, grouped in 16 bit words, + the same as the default but without a header. + + -i, --ignore + usually the phy counter identifier names are decoded. + When this option is given, the numeric value of the + identifier is output, the vendor flag, the data length + (in bytes) and the corresponding value. + + -l, --len=16 | 12 + this is the length of the SCSI cdb used for the ATA + PASS-THROUGH commands. The argument can either be 16 + or 12. The default is 16. The larger cdb size is needed + for 48 bit LBA addressing of ATA devices. On the other + hand some SCSI transports cannot convey SCSI commands + longer than 12 bytes. + + -r, --raw + output the ATA READ LOG EXT response in binary. The + output should be piped to a file or another utility + when this option is used. The binary is sent to + stdout, and errors are sent to stderr. + + -R, --reset + reset the counters after the current values are + returned, decoded and displayed. + + -v, --verbose + increases the level or verbosity. + + -V, --version + print out version string + +NOTES + The SCSI ATA PASS-THROUGH (12) command's opcode is 0xa1 and + it clashes with the MMC set's BLANK command used by cd/dvd + writers. So a SATL in front of an ATAPI device that uses MMC + (i.e. has peripheral device type 5) probably should treat + opcode 0xa1 as a BLANK command and send it through to the + cd/dvd drive. The ATA PASS-THROUGH (16) command's opcode + (0x85) does not clash with anything so it is a better + choice. + + In the 2.4 series of Linux kernels the DEVICE must be a SCSI + generic (sg) device. In the 2.6 series block devices (e.g. + disks and ATAPI DVDs) can also be specified. For example + "sg_inq /dev/sda" will work in the 2.6 series kernels. From + lk 2.6.6 other SCSI "char" device names may be used as well + +sg3_utils-1.26 Last change: December 2007 2 + +SG3_UTILS SG_SAT_PHY_EVENT(1M) + + (e.g. "/dev/st0m"). + +EXIT STATUS + The exit status of sg_sat_identify is 0 when it is success- + ful. Otherwise see the sg3_utils(1M) man page. + AUTHOR Written by Doug Gilbert @@ -3885,13 +4426,28 @@ A PARTICULAR PURPOSE. SEE ALSO - sg_vpd(sg3_utils), sg_inq(sg3_utils), sdparm(sdparm), - hdparm(hdparm) + sg_sat_identify(sg3_utils), smp_rep_phy_err_log(smp_utils), + sdparm(sdparm), hdparm(hdparm) -sg3_utils-1.24 Last change: May 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_SAT_SET_FEATURES(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: December 2007 3 + +SG3_UTILS SG_SAT_SET_FEATURES(1M) + NAME sg_sat_set_featutes - sends a ATA SET FEATURES command via a SCSI to ATA Translation (SAT) layer @@ -3947,7 +4503,7 @@ sg3_utils-1.25 Last change: August 2007 1 -SG3_UTILS SG_SAT_SET_FEATURES(8) +SG3_UTILS SG_SAT_SET_FEATURES(1M) ATA SET FEATURES command. The term "subcommand" is sometimes used for this value. The default value placed @@ -3989,7 +4545,7 @@ EXIT STATUS The exit status of sg_sat_set_features is 0 when it is suc- - cessful. Otherwise see the sg3_utils(8) man page. + cessful. Otherwise see the sg3_utils(1M) man page. AUTHOR Written by Doug Gilbert @@ -4004,7 +4560,7 @@ sg3_utils-1.25 Last change: August 2007 2 -SG3_UTILS SG_SAT_SET_FEATURES(8) +SG3_UTILS SG_SAT_SET_FEATURES(1M) A PARTICULAR PURPOSE. @@ -4012,9 +4568,24 @@ sg_sat_identify(sg3_utils), sg_inq(sg3_utils), sdparm(sdparm), hdparm(hdparm) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.25 Last change: August 2007 3 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) NAME sg_senddiag - performs a SCSI SEND DIAGNOSTIC command @@ -4071,7 +4642,7 @@ sg3_utils-1.25 Last change: October 2007 1 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) outputs response from RECEIVE DIAGNOSTIC RESULTS in hex rather than decode it. @@ -4120,7 +4691,7 @@ 5 : foreground short self-test 6 : foreground extended self-test This option is mutually exclusive with default - self-test (i.e. can't have (ST > 0) and --test). + self-test (i.e. can't have (ST > 0) and --test). -t, --test sets the _default_ Self Test (SelfTest) bit. By default @@ -4128,7 +4699,7 @@ sg3_utils-1.25 Last change: October 2007 2 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) be active together with this option. Both the --doff and/or --uoff options can be used with this option. @@ -4157,9 +4728,9 @@ they are completed while the background self-test codes return immediately. The results of both foreground and back- ground self-test codes are placed in the 'self-test results' - log page (see sg_logs(8)). The SCSI command timeout for this - utility is set to 60 minutes to allow for slow foreground - extended self-tests. + log page (see sg_logs(1M)). The SCSI command timeout for + this utility is set to 60 minutes to allow for slow fore- + ground extended self-tests. If the DEVICE is a disk then no file systems residing on that disk should be mounted during a foreground self-test. @@ -4181,11 +4752,11 @@ .../sdiag_sas_p1_cjtpat.txt' Arbitrary diagnostic pages can be read (in hex) with the - sg_ses(8) utility (not only those defined in SES-2). + sg_ses(1M) utility (not only those defined in SES-2). sg3_utils-1.25 Last change: October 2007 3 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) If the utility is used with no options (e.g. "sg_senddiag /dev/sg1") Then a degenerate SCSI SEND DIAGNOSTIC command is @@ -4200,13 +4771,13 @@ ple 'sg_senddiag -t /dev/sda' will work in the 2.6 series kernels. - To access SCSI enclosures see the sg_ses(8) utility. sg_ses + To access SCSI enclosures see the sg_ses(1M) utility. sg_ses uses the SCSI SEND DIAGNOSTIC and RECEIVE DIAGNOSTIC RESULTS commands as outlined in the SES-2 (draft) standard. EXIT STATUS The exit status of sg_senddiag is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -4242,7 +4813,7 @@ sg3_utils-1.25 Last change: October 2007 4 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) -pf set Page Format (PF) bit. By default it is clear (i.e. 0) unless the -l option is given in which case the Page @@ -4299,7 +4870,7 @@ sg3_utils-1.25 Last change: October 2007 5 -SG3_UTILS SG_SENDDIAG(8) +SG3_UTILS SG_SENDDIAG(1M) COPYRIGHT Copyright O 2003-2007 Douglas Gilbert @@ -4308,11 +4879,26 @@ A PARTICULAR PURPOSE. SEE ALSO - sg_ses(8), sg_logs(8), smartmontools(see net) + sg_ses(1M), sg_logs(1M), smartmontools(see net) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.25 Last change: October 2007 6 -SG3_UTILS SG_SES(8) +SG3_UTILS SG_SES(1M) NAME sg_ses - send controls and fetch status from a SCSI Enclo- @@ -4341,7 +4927,7 @@ well. The options are arranged in alphabetical order based on the long option name. - -b, --byte=B1 + -b, --byte1=B1 some control pages need byte 1 (i.e. the second byte) of the cdb set. Only required in rare cases when the --control option is also set. Default is 0; B1 is in @@ -4367,9 +4953,9 @@ reads a data string from stdin. Spaces, tabs and line feeds additionally are permitted as separators. -sg3_utils-1.25 Last change: October 2007 1 +sg3_utils-1.26 Last change: March 2008 1 -SG3_UTILS SG_SES(8) +SG3_UTILS SG_SES(1M) -f, --filter cuts down on the amount of output from the enclosure @@ -4424,9 +5010,9 @@ Currently all status pages, control pages and element types defined in SES-2 revision 17 (14th May 2007) are decoded. -sg3_utils-1.25 Last change: October 2007 2 +sg3_utils-1.26 Last change: March 2008 2 -SG3_UTILS SG_SES(8) +SG3_UTILS SG_SES(1M) This utility can be used to fetch arbitrary (i.e. non SES) diagnostic pages (using the SCSI READ DIAGNOSTIC command). @@ -4479,11 +5065,11 @@ EXIT STATUS The exit status of sg_ses is 0 when it is successful. Other- - wise see the sg3_utils(8) man page. + wise see the sg3_utils(1M) man page. -sg3_utils-1.25 Last change: October 2007 3 +sg3_utils-1.26 Last change: March 2008 3 -SG3_UTILS SG_SES(8) +SG3_UTILS SG_SES(1M) AUTHORS Written by Douglas Gilbert. @@ -4501,10 +5087,25 @@ sg_inq, sg_safte, sg_senddiag (in sg3_utils package); safte-monitor (internet) -sg3_utils-1.25 Last change: October 2007 4 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_START(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: March 2008 4 + +SG3_UTILS SG_START(1M) + NAME sg_start - send SCSI START STOP UNIT command to start, stop, load or eject medium @@ -4511,11 +5112,12 @@ SYNOPSIS sg_start [0] [1] [--eject] [--help] [--fl=FL] [--immed] - [--load] [--loej] [--pc=PC] [--start] [--stop] [--verbose] - [--version] DEVICE + [--load] [--loej] [--mod=PC_MOD] [--noflush] [--pc=PC] + [--start] [--stop] [--verbose] [--version] DEVICE sg_start [--eject] [--fl=FL] [-i] [--imm=0|1] [--load] - [--loej] [--pc=PC] [--start] [--stop] [-v] [-V] [0|1] DEVICE + [--loej] [--mod=PC_MOD] [--noflush] [--pc=PC] [--start] + [--stop] [-v] [-V] [0|1] DEVICE DESCRIPTION sg_start sends a SCSI START STOP UNIT command to the DEVICE @@ -4522,8 +5124,8 @@ with the selected options. The most used options are --stop to spin down a disk and --start to spin up a disk. Using --start on a disk that is already spinning is harmless. - There is also finer grain control with "power conditions": - active, idle and standby. This is set with the --pc=PC + There is also finer grain control with "power condition": + active, idle or standby. This is set with the --pc=PC option. In some contexts the "stop" state can be considered an additional power condition. @@ -4556,12 +5158,11 @@ appropriate for a device with removable medium. Might be ignored (prevented), see below. - -h, --help +sg3_utils-1.26 Last change: March 2008 1 -sg3_utils-1.25 Last change: October 2007 1 +SG3_UTILS SG_START(1M) -SG3_UTILS SG_START(8) - + -h, --help print out the usage message then exit. -f, --fl=FL @@ -4592,6 +5193,20 @@ (i.e. neither --start nor --stop) and this option is given then a load and start action is assumed. + -m, --mod=PC_MOD + where PC_MOD is the 'power condition modifier' value. 0 + to 15 (inclusive) are valid and 0 is the default. This + 'power condition modifier' field in the cdb was added + after sbc3r13. + + -n, --noflush + do not perform a flush to media (e.g. like SYNCHRONIZE + CACHE does) before a variant of this utility that lim- + its access to the media. Using the --stop option is an + example of something that limits access to the media. + This 'noflush' field in the cdb was added after + sbc3r13. + -O, --old switch to older style options. @@ -4599,6 +5214,11 @@ where PC is the 'power conditions' value. 0 to 15 (inclusive) are valid. Default value is 0. When '--pc=0' then --eject, --load, --loej, --start and + +sg3_utils-1.26 Last change: March 2008 2 + +SG3_UTILS SG_START(1M) + --stop are active. Some common values are 1 for the "active" power condition (SBC); 2 for the idle power condition; 3 for the standby power condition; 5 for @@ -4614,10 +5234,6 @@ is harmless. In the absence of other options, this option defaults (i.e. set the START cdb bit). -sg3_utils-1.25 Last change: October 2007 2 - -SG3_UTILS SG_START(8) - -S, --stop stop (spin-down) the device. This clears the START bit in the cdb. @@ -4655,6 +5271,11 @@ The SCSI TEST UNIT READY command can be used to find out whether a device is ready to transfer data. If rotating media is stopped or still coming up to speed, then the TEST + +sg3_utils-1.26 Last change: March 2008 3 + +SG3_UTILS SG_START(1M) + UNIT READY command will yield a "not ready" sense key and an more informative additional sense code. See the sg_turs utility. @@ -4667,12 +5288,8 @@ EXIT STATUS The exit status of sg_start is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. -sg3_utils-1.25 Last change: October 2007 3 - -SG3_UTILS SG_START(8) - OLDER COMMAND LINE OPTIONS The options in this section were the only ones available prior to sg3_utils version 1.23 . In sg3_utils version 1.23 @@ -4711,6 +5328,11 @@ -i sets the IMM bit on the START STOP UNIT command so this utility will return immediately and not wait for the media to spin down. Same effect as '--imm=1'. The + +sg3_utils-1.26 Last change: March 2008 4 + +SG3_UTILS SG_START(1M) + default action (without this option or a '--imm=1' option) is to wait until the media spins down before returning. @@ -4725,10 +5347,6 @@ --load load the medium in the drive and start it. -sg3_utils-1.25 Last change: October 2007 4 - -SG3_UTILS SG_START(8) - --loej sets the LOEJ bit in the START STOP UNIT cdb. When a "start" operation is indicated, then a load and start @@ -4741,8 +5359,20 @@ -N switch to the newer style options. + --mod=PC_MOD + where PC_MOD is the 'power condition modifier' value. 0 + to 15 (inclusive) are valid and 0 is the default. This + field was added after sbc3r13. + + --noflush + do not perform a flush to media (e.g. like SYNCHRONIZE + CACHE does) before a variant of this utility that lim- + its access to the media. Using the --stop option is an + example of something that limits access to the media. + This field was added after sbc3r13. + --pc=PC - where PC is the 'power conditions' value (in hex). 0 to + where PC is the 'power condition' value (in hex). 0 to f (inclusive) are valid. Default value is 0. --start @@ -4755,6 +5385,10 @@ with executing it. '-vv' and '-vvv' are also accepted yielding greater verbosity. +sg3_utils-1.26 Last change: March 2008 5 + +SG3_UTILS SG_START(1M) + -V print out version string then exit. AUTHOR @@ -4764,7 +5398,7 @@ Report bugs to . COPYRIGHT - Copyright O 2002-2007 Kurt Garloff, Douglas Gilbert + Copyright O 2002-2008 Kurt Garloff, Douglas Gilbert This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -4773,10 +5407,25 @@ sg_prevent(sg3_utils), sg_requests(sg3_utils), sg_turs(sg3_utils) sdparm(sdparm) -sg3_utils-1.25 Last change: October 2007 5 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_STPG(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: March 2008 6 + +SG3_UTILS SG_STPG(1M) + NAME sg_stpg - sends a SCSI SET TARGET PORT GROUPS command @@ -4832,7 +5481,7 @@ sg3_utils-1.25 Last change: September 2007 1 -SG3_UTILS SG_STPG(8) +SG3_UTILS SG_STPG(1M) that a relative target port identifier should be given with this state (rather than a target port group iden- @@ -4888,7 +5537,7 @@ sg3_utils-1.25 Last change: September 2007 2 -SG3_UTILS SG_STPG(8) +SG3_UTILS SG_STPG(1M) NOTES The SET TARGET PORT GROUPS command should be supported when- @@ -4910,7 +5559,7 @@ EXIT STATUS The exit status of sg_stpg is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -4928,10 +5577,29 @@ SEE ALSO sg_inq, sg_rtpg (sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + sg3_utils-1.25 Last change: September 2007 3 -SG3_UTILS SG_SYNC(8) +SG3_UTILS SG_STPG(1M) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.25 Last change: September 2007 4 + +SG3_UTILS SG_SYNC(1M) + NAME sg_sync - send the scsi command synchronize cache @@ -4987,7 +5655,7 @@ sg3_utils-1.22 Last change: December 2006 1 -SG3_UTILS SG_SYNC(8) +SG3_UTILS SG_SYNC(1M) (or the non-volatile cache). @@ -5023,7 +5691,7 @@ EXIT STATUS The exit status of sg_sync is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -5042,8 +5710,27 @@ sg3_utils-1.22 Last change: December 2006 2 -SG3_UTILS SG_TURS(8) +SG3_UTILS SG_SYNC(1M) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.22 Last change: December 2006 3 + +SG3_UTILS SG_TURS(1M) + NAME sg_turs - send one or more SCSI TEST UNIT READY commands @@ -5057,10 +5744,7 @@ This utility sends one or more SCSI TEST UNIT READY commands to the DEVICE. This may be useful for timing the per command overhead. Note that TEST UNIT READY has no associated data, - just a 6 byte command and a returned SCSI status value. If - the SCSI status value is CHECK CONDITION then most modern - initiators fetch sense data from the device (i.e. - autosense). + just a 6 byte command and a returned SCSI status value. This utility supports two command line syntaxes, the pre- ferred one is shown first in the synopsis and explained in @@ -5089,19 +5773,21 @@ -p, --progress show progress indication (a percentage) if available. - If --number=NUM is given and NUM is greater than 1 then - waits 30 seconds before subsequent checks. Exits when - NUM is reached or there is no more progress indication. - Ignores --time option. + If --number=NUM is given, NUM is greater than 1 and an + initial progress indication was detected then this + utility waits 30 seconds before subsequent checks. + Exits when NUM is reached or there are no more progress + indications. Ignores --time option. See NOTES section + below. -t, --time after completing the requested number of TEST UNIT + READY commands, outputs the total duration and the -sg3_utils-1.23 Last change: December 2006 1 +sg3_utils-1.26 Last change: March 2008 1 -SG3_UTILS SG_TURS(8) +SG3_UTILS SG_TURS(1M) - READY commands, outputs the total duration and the average number of commands executed per second. -v, --verbose @@ -5110,9 +5796,31 @@ -V, --version print version string then exit. +NOTES + The progress indication is optionally part of the sense + data. When a prior command that takes a long time to com- + plete (and typically precludes other media access commands) + is still underway, the progress indication can be used to + determine how long before the device returns to its normal + state. + + The SCSI FORMAT command for disks used with the IMMED bit + set is an example of an operation that takes a significant + amount of time and precludes other media access during that + time. The IMMED bit set instructs the FORMAT command to + return control to the application client once the format has + commenced (see SBC-3). Several long duration SCSI commands + associated with tape drives also use the progress indication + (see SSC-3). + + Early standards suggested that the SCSI TEST UNIT READY com- + mand be used for polling the progress indication. More + recent standards seem to suggest the SCSI REQUEST SENSE com- + mand should be used instead. + EXIT STATUS The exit status of sg_turs is 0 when it is successful. Oth- - erwise see the sg3_utils(8) man page. + erwise see the sg3_utils(1M) man page. OLDER COMMAND LINE OPTIONS The options in this section were the only ones available @@ -5132,6 +5840,11 @@ Equivalent to --progress in the main description. -t after completing the requested number of TEST UNIT + +sg3_utils-1.26 Last change: March 2008 2 + +SG3_UTILS SG_TURS(1M) + READY commands, outputs the total duration and the average number of commands executed per second. Equivalent to --time in the main description. @@ -5144,24 +5857,39 @@ Written by D. Gilbert COPYRIGHT - Copyright O 2000-2006 Douglas Gilbert + Copyright O 2000-2008 Douglas Gilbert This software is distributed under the GPL version 2. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. SEE ALSO - sg_inq(sg3_utils) + sg_inq, sg_request (sg3_utils) -sg3_utils-1.23 Last change: December 2006 2 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_VERIFY(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: March 2008 3 + +SG3_UTILS SG_VERIFY(1M) + NAME sg_verify - invoke SCSI VERIFY command(s) on a block device SYNOPSIS sg_verify [--bpc=BPC] [--count=COUNT] [--dpo] [--help] - [--lba=LBA] [--verbose] [--version] DEVICE + [--lba=LBA] [--verbose] [--version] [--vrprotect=VRP] DEVICE DESCRIPTION Sends one or more SCSI VERIFY commands to DEVICE. It is the @@ -5176,7 +5904,8 @@ OPTIONS Arguments to long options are mandatory for short options as - well. + well. The options are arranged in alphabetical order based + on the long option name. -b, --bpc=BPC where BPC specifies the maximum number of blocks that @@ -5207,12 +5936,12 @@ -l, --lba=LBA where LBA specifies the logical block address of the - first block to start the verify operation. LBA is -sg3_utils-1.23 Last change: January 2007 1 +sg3_utils-1.26 Last change: November 2007 1 -SG3_UTILS SG_VERIFY(8) +SG3_UTILS SG_VERIFY(1M) + first block to start the verify operation. LBA is assumed to be decimal unless prefixed by '0x' or a trailing 'h' (see below). The default value is 0 (i.e. the start of the device). @@ -5223,6 +5952,11 @@ -V, --version print the version string and then exit. + -P, --vrprotect=VRP + where VRP is the value in the vrprotect field in the + VERIFY command cdb. It must be a value between 0 and 7 + inclusive. The default value is zero. + NOTES The BPC, COUNT and LBA arguments may be followed by one of these multiplicative suffixes: c C *1; w W *2; b B *512; k @@ -5251,7 +5985,7 @@ EXIT STATUS The exit status of sg_verify is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -5259,6 +5993,10 @@ REPORTING BUGS Report bugs to . +sg3_utils-1.26 Last change: November 2007 2 + +SG3_UTILS SG_VERIFY(1M) + COPYRIGHT Copyright O 2004-2007 Douglas Gilbert This software is distributed under a FreeBSD license. There @@ -5265,18 +6003,29 @@ is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -sg3_utils-1.23 Last change: January 2007 2 - -SG3_UTILS SG_VERIFY(8) - SEE ALSO sginfo(sg3_utils), sg_modes(sg3_utils), sg_readcap(sg3_utils), sg_inq(sg3_utils) -sg3_utils-1.23 Last change: January 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_VPD(8) + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: November 2007 3 + +SG3_UTILS SG_VPD(1M) + NAME sg_vpd - fetches Vital Product Data (VPD) pages using a SCSI INQUIRY command @@ -5283,7 +6032,8 @@ SYNOPSIS sg_vpd [--enumerate] [--help] [--hex] [--ident] [--long] - [--page=PG] [--quiet] [--raw] [--verbose] [--version] DEVICE + [--maxlen=LEN] [--page=PG] [--quiet] [--raw] [--verbose] + [--version] DEVICE DESCRIPTION This utility fetches a Vital Product Data page and decodes @@ -5328,16 +6078,30 @@ same effect as '--quiet --page=di_lu'. -l, --long - when decoding some VPD pages, give a little more -sg3_utils-1.24 Last change: April 2007 1 +sg3_utils-1.26 Last change: February 2008 1 -SG3_UTILS SG_VPD(8) +SG3_UTILS SG_VPD(1M) - output. For example the ATA Information VPD page only + when decoding some VPD pages, give a little more out- + put. For example the ATA Information VPD page only shows the signature (in hex) and the IDENTIFY (PACKET) DEVICE (in hex) when this option is given. + -m, --maxlen=LEN + where LEN is the (maximum) response length in bytes. It + is placed in the cdb's "allocation length" field. If + not given (or LEN is zero) then 252 is used (apart from + the ATA Information VPD page which defaults to 572) + and, if the response indicates this value is insuffi- + cient, another INQUIRY command is sent with a larger + value in the cdb's "allocation length" field. If this + option is given and LEN is greater than 0 then only one + INQUIRY command is sent. Since many simple devices + implement the INQUIRY command badly (and do not support + VPD pages) then the safest value to use for LEN is 36. + See the sg_inq man page for the more information. + -p, --page=PG where PG is the VPD page to be decoded or output. The PG argument can either be an abbreviation, a number or @@ -5371,6 +6135,11 @@ ATA INFORMATION VPD PAGE This VPD page (0x89 or 'ai') is defined by the SCSI to ATA Translation standard. It contains information about the SAT + +sg3_utils-1.26 Last change: February 2008 2 + +SG3_UTILS SG_VPD(1M) + layer, the "signature" of the ATA device and the response to the ATA IDENTIFY (PACKET) DEVICE command. The latter part has 512 bytes of identity, capability and settings data @@ -5385,15 +6154,10 @@ ices. To see that response as a string of bytes use the '-HH' option. To format the output suitable for hdparm to decode use either the '-HHH' or '-rr' option. For example if - 'dev/sdb' is a SATA disk behind a SAT layer then this + 'dev/sdb' is a SATA disk behind a SAT layer then this com- + mand: 'sg_vpd -p ai -HHH /dev/sdb | hdparm --Istdin' should + decode the ATA IDENTIFY (PACKET) DEVICE response. -sg3_utils-1.24 Last change: April 2007 2 - -SG3_UTILS SG_VPD(8) - - command: 'sg_vpd -p ai -HHH /dev/sdb | hdparm --Istdin' - should decode the ATA IDENTIFY (PACKET) DEVICE response. - NOTES In the 2.4 series of Linux kernels the DEVICE must be a SCSI generic (sg) device. In the 2.6 series block devices (e.g. @@ -5404,7 +6168,7 @@ EXIT STATUS The exit status of sg_vpd is 0 when it is successful. Other- - wise see the sg3_utils(8) man page. + wise see the sg3_utils(1M) man page. AUTHOR Written by Doug Gilbert @@ -5413,7 +6177,7 @@ Report bugs to . COPYRIGHT - Copyright O 2006-2007 Douglas Gilbert + Copyright O 2006-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -5421,10 +6185,29 @@ SEE ALSO sg_inq(sg3_utils), sdparm(sdparm), hdparm(hdparm) -sg3_utils-1.24 Last change: April 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_WRITE_BUFFER(8) +sg3_utils-1.26 Last change: February 2008 3 +SG3_UTILS SG_VPD(1M) + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: February 2008 4 + +SG3_UTILS SG_WRITE_BUFFER(1M) + NAME sg_write_buffer - send a SCSI WRITE BUFFER command @@ -5479,7 +6262,7 @@ sg3_utils-1.23 Last change: January 2007 1 -SG3_UTILS SG_WRITE_BUFFER(8) +SG3_UTILS SG_WRITE_BUFFER(1M) -o, --offset=OFF this option sets the buffer offset field in the cdb. @@ -5535,11 +6318,11 @@ sg3_utils-1.23 Last change: January 2007 2 -SG3_UTILS SG_WRITE_BUFFER(8) +SG3_UTILS SG_WRITE_BUFFER(1M) EXIT STATUS The exit status of sg_write_buffer is 0 when it is success- - ful. Otherwise see the sg3_utils(8) man page. + ful. Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Luben Tuikov and Douglas Gilbert. @@ -5556,9 +6339,24 @@ SEE ALSO sg_read_buffer(sg3_utils) +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + sg3_utils-1.23 Last change: January 2007 3 -SG3_UTILS SG_WRITE_LONG(8) +SG3_UTILS SG_WRITE_LONG(1M) NAME sg_write_long - send the SCSI WRITE LONG command @@ -5592,12 +6390,13 @@ ically if the ARRE (for reads) and/or AWRE (for writes) are set then recovered errors will cause the lba to be reas- signed (and the old location to be added to the grown defect - list (PLIST)). This is not easily reversed and uses the - (finite number) of spare sectors set aside for this purpose. - If in doubt it is probably safest to clear the ARRE and AWRE - bits. These bits can be checked and modified with the sdparm - utility. For example: "sdparm -c AWRE,ARRE /dev/sda" will - clear the bits until the disk is rebooted. + list (PLIST)). This is not easily reversed and uses (one of + the finite number of) the spare sectors set aside for this + purpose. If in doubt it is probably safest to clear the ARRE + and AWRE bits. These bits can be checked and modified with + the sdparm utility. For example: "sdparm -c AWRE,ARRE + /dev/sda" will clear the bits until the disk is power + cycled. OPTIONS Arguments to long options are mandatory for short options as @@ -5611,14 +6410,14 @@ -c, --cor_dis sets the correction disabled (i.e 'COR_DIS') bit. This inhibits various other mechanisms such as automatic - block reallocation, error recovery and various -sg3_utils-1.23 Last change: January 2007 1 +sg3_utils-1.26 Last change: December 2007 1 -SG3_UTILS SG_WRITE_LONG(8) +SG3_UTILS SG_WRITE_LONG(1M) - informational exception conditions being triggered. - This bit is new in SBC-3 . + block reallocation, error recovery and various informa- + tional exception conditions being triggered. This bit + is relatively new in SBC-3 . -h, --help output the usage message then exit. @@ -5643,7 +6442,7 @@ --wr_uncor is also given) to write to the physical block specified by LBA. The default action is to write to the logical block corresponding to the given lba. - This bit is new in SBC-3 . + This bit is relatively new in SBC-3 . -v, --verbose increase the degree of verbosity (debug messages). @@ -5657,9 +6456,10 @@ sical block that contains it if --pblock is also given) as having an unrecoverable error associated with it. Note: no data is transferred to DEVICE, other than the - command (i.e. the cdb). The default action is to use - the provided data (--xfer_len=BTL in length) and write - it to DEVICE. This bit is new in SBC-3 . + command (i.e. the cdb). In the absence of this option, + the default action is to use the provided data or 0xff + bytes (--xfer_len=BTL in length) and write it to DEV- + ICE. This bit is relatively new in SBC-3 . -x, --xfer_len=BTL where BTL is the byte transfer length (default to 520). @@ -5667,12 +6467,13 @@ "long" block size of the device, nothing is written to DEVICE and the appropriate xfer_len value may be deduced from the error response which is printed (to - stderr). -sg3_utils-1.23 Last change: January 2007 2 +sg3_utils-1.26 Last change: December 2007 2 -SG3_UTILS SG_WRITE_LONG(8) +SG3_UTILS SG_WRITE_LONG(1M) + stderr). + NOTES The LBA and BTL (transfer length) arguments may be followed by the following multiplicative suffixes: c C *1; w W *2; b @@ -5686,26 +6487,78 @@ "H"). When hex numbers are given, multipliers cannot be used. - To read from a defective sector (that, for example, has been - filled with 0xff bytes by this utility) use: + The 10 byte SCSI WRITE LONG command limits the logical block + address to a 32 bit quantity. For larger LBAs use the --16 + option for the SCSI WRITE LONG (16) command. - sg_dd if=DEVICE skip=LBA of=/dev/null bs=512 count=1 +EXAMPLES + This section outlines setting up a block with corrupted + data, checking the error condition, then restoring useful + contents to that sector. - To overwrite to a defective sector use: + First, if the data in a sector is important, save it with + the sg_read_long utility: - sg_dd of=DEVICE seek=LBA if=/dev/zero bs=512 count=1 + sg_read_long --lba=0x1234 --out=0x1234_1.img -x BTL + /dev/sda + This utility may need to be executed several time in order + to determine what the correct value for BTL is. Next use + this utility to "corrupt" that sector. That might be done + with: + + sg_write_long --lba=0x1234 -x BTL /dev/sda + + This will write a sector (and ECC data) of 0xff bytes. Some + disks may reject this (at least one of the author's does). + Another approach is to copy the 0x1234_1.img file (to + 0x1234_2.img in this example) and change some values with a + hex editor. Then write the changed image with: + + sg_write_long --lba=0x1234 --in=0x1234_2.img -x BTL + /dev/sda + + Yet another approach is to use the --wr_uncor option, if + supported: + + sg_write_long --lba=0x1234 --wr_uncor /dev/sda + +sg3_utils-1.26 Last change: December 2007 3 + +SG3_UTILS SG_WRITE_LONG(1M) + + Next we use the sg_dd utility to check that the sector is + corrupted. Here is an example: + + sg_dd if=/dev/sda blk_sgio=1 skip=0x1234 of=. bs=512 + count=1 verbose=4 + + Notice that the "blk_sgio=1" option is given. This is to + make sure that the sector is read (and no others) and the + error is fully reported. The "blk_sgio=1" option causes the + SG_IO ioctl to be used by sg_dd rather than the block sub- + system. + + Finally we should restore sector 0x1234 to a non-corrupted + state. A sector full of zeroes could be written with: + + sg_dd if=/dev/zero of=/dev/sda blk_sgio=1 seek=0x1234 + bs=512 count=1 + This will result in a sector (block) with 512 bytes of 0x0 without a MEDIUM ERROR since the ECC and associated data - will be well formed. + will be regenerated and thus well formed. The 'blk_sgio=1' + option is even more important in this case as it may stop + the block subsystem doing a read before write (since the + read will most likely fail). Another approach is to write + back the original contents: - The 10 byte SCSI WRITE LONG command limits the logical block - address to a 32 bit quantity. For larger lbas use the --16 - option for the SCSI WRITE LONG (16) command. + sg_write_long --lba=0x1234 --in=0x1234_1.img -x BTL + /dev/sda EXIT STATUS The exit status of sg_write_long is 0 when it is successful. - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Saeed Bishara. Further work by Douglas Gilbert. @@ -5722,10 +6575,29 @@ SEE ALSO sg_read_long, sg_dd (both in sg3_utils), sdparm(sdparm) -sg3_utils-1.23 Last change: January 2007 3 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: -SG3_UTILS SG_WR_MODE(8) +sg3_utils-1.26 Last change: December 2007 4 +SG3_UTILS SG_WRITE_LONG(1M) + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: December 2007 5 + +SG3_UTILS SG_WR_MODE(1M) + NAME sg_wr_mode - write mode page @@ -5779,9 +6651,9 @@ Changing individual fields in a mode page is probably more easily done with the sdparm utility. Fields can be -sg3_utils-1.23 Last change: January 2007 1 +sg3_utils-1.26 Last change: March 2008 1 -SG3_UTILS SG_WR_MODE(8) +SG3_UTILS SG_WR_MODE(1M) identified by acronym or by a numerical descriptor. @@ -5823,7 +6695,7 @@ contents for the mode page. Cannot be given with the --mask=M,M... option. - -h, --hex + -h, --help output the usage message then exit. -l, --len=10 | 6 @@ -5836,9 +6708,9 @@ where M,M... is a string of comma separated hex numbers each of which should resolve to a byte value (i.e. 0 to -sg3_utils-1.23 Last change: January 2007 2 +sg3_utils-1.26 Last change: March 2008 2 -SG3_UTILS SG_WR_MODE(8) +SG3_UTILS SG_WR_MODE(1M) ff inclusive). The mask chooses (bit by bit) whether the new mode page comes from the contents (mask bit @@ -5891,9 +6763,9 @@ --save option should cause an error to be reported from the device: "Illegal field in cdb". -sg3_utils-1.23 Last change: January 2007 3 +sg3_utils-1.26 Last change: March 2008 3 -SG3_UTILS SG_WR_MODE(8) +SG3_UTILS SG_WR_MODE(1M) The device is required to do various checks before it accepts a new mode page. If these checks fail then the mode @@ -5925,7 +6797,7 @@ both the current and saved mode page values the following sequence could be used: - $ sg_modes -c=2 -p=1a -r /dev/sda > t + $ sg_modes --control=2 --page=1a -r /dev/sda > t $ sg_wr_mode --page=1a --contents=- --save /dev/sda < t Next is an example of using a mask to modify the "idle con- @@ -5934,7 +6806,7 @@ "idle condition counter" will revert to 0x28 after the next power cycle. The output from sg_modes is abridged. - $ sg_modes -p=1a /dev/hdc + $ sg_modes --page=1a /dev/hdc >> Power condition (mmc), page_control: current 00 1a 0a 00 03 00 00 00 28 00 00 01 2c @@ -5941,7 +6813,7 @@ $ sg_wr_mode -p 1a -c 0,0,0,0,0,0,0,37 -m 0,0,0,0,0,0,0,ff /dev/hdc - $ sg_modes -p=1a /dev/hdc + $ sg_modes -p 1a /dev/hdc >> Power condition (mmc), page_control: current 00 1a 0a 00 03 00 00 00 37 00 00 01 2c @@ -5948,11 +6820,11 @@ EXIT STATUS The exit status of sg_wr_mode is 0 when it is successful. -sg3_utils-1.23 Last change: January 2007 4 +sg3_utils-1.26 Last change: March 2008 4 -SG3_UTILS SG_WR_MODE(8) +SG3_UTILS SG_WR_MODE(1M) - Otherwise see the sg3_utils(8) man page. + Otherwise see the sg3_utils(1M) man page. AUTHORS Written by Douglas Gilbert. @@ -5961,7 +6833,7 @@ Report bugs to . COPYRIGHT - Copyright O 2004-2007 Douglas Gilbert + Copyright O 2004-2008 Douglas Gilbert This software is distributed under a FreeBSD license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. @@ -5969,4 +6841,20 @@ SEE ALSO sdparm(sdparm), sg_modes(sg3_utils), sginfo(sg3_utils) -sg3_utils-1.23 Last change: January 2007 5 +ATTRIBUTES + See attributes(5) for descriptions of the following attri- + butes: + + _______________________________________ + | ATTRIBUTE TYPE | ATTRIBUTE VALUE| + |_______________________________________ + | Availability | SUNWsg3utilsu | + |_______________________________________ + | Interface Stability| Committed | + |____________________|_________________| + +NOTES + Source for sg3_utils is available on http://opensolaris.org. + +sg3_utils-1.26 Last change: March 2008 5 + --- sg3utils-opinion-1.25.txt Tue Jan 13 15:32:37 2009 +++ sg3utils-opinion-1.26.txt Tue Jan 13 15:31:21 2009 @@ -88,6 +88,8 @@ |__________________________________________|______________|_____________| |/usr/sbin/sg_sat_identify |Uncommitted |Command | |__________________________________________|______________|_____________| +|/usr/sbin/sg_sat_phy_event |Uncommitted |Command | +|__________________________________________|______________|_____________| |/usr/sbin/sg_sat_set_features |Uncommitted |Command | |__________________________________________|______________|_____________| |/usr/sbin/sg_senddiag |Uncommitted |Command | @@ -112,11 +114,11 @@ |__________________________________________|______________|_____________| |/usr/sbin/sg_write_long |Uncommitted |Command | |__________________________________________|______________|_____________| -|/usr/lib/libsgutils.so |Private |Symbolic Link| +|/usr/lib/libsgutils2.so |Private |Symbolic Link| |__________________________________________|______________|_____________| -|/usr/lib/libsgutils.so.1 |Private |Symbolic Link| +|/usr/lib/libsgutils2.so.2 |Private |Symbolic Link| |__________________________________________|______________|_____________| -|/usr/lib/libsgutils.so.1.0.0 |Private |Shared | +|/usr/lib/libsgutils2.so.2.0.0 |Private |Shared | | | |Library File | |__________________________________________|______________|_____________| |/usr/share/man/man1m/sg_read_long.1m |Uncommitted |Manpage | @@ -151,6 +153,8 @@ |__________________________________________|______________|_____________| |/usr/share/man/man1m/sg_sat_identify.1m |Uncommitted |Manpage | |__________________________________________|______________|_____________| +|/usr/share/man/man1m/sg_sat_phy_event.1m |Uncommitted |Manpage | +|__________________________________________|______________|_____________| |/usr/share/man/man1m/sg_start.1m |Uncommitted |Manpage | |__________________________________________|______________|_____________| |/usr/share/man/man1m/sg_verify.1m |Uncommitted |Manpage | @@ -264,6 +268,7 @@ SCSI Device Info:solaris:cmd:::/usr/sbin/sg_rtpg:euid=0;privs=file_dac_read,file_dac_write,sys_devices SCSI Device Info:solaris:cmd:::/usr/sbin/sg_safte:euid=0;privs=file_dac_read,file_dac_write,sys_devices SCSI Device Info:solaris:cmd:::/usr/sbin/sg_sat_identify:euid=0;privs=file_dac_read,file_dac_write,sys_devices +SCSI Device Info:solaris:cmd:::/usr/sbin/sg_sat_phy_event:euid=0;privs=file_dac_read,file_dac_write,sys_devices SCSI Device Info:solaris:cmd:::/usr/sbin/sg_vpd:euid=0;privs=file_dac_read,file_dac_write,sys_devices SCSI Device Management:solaris:cmd:::/usr/sbin/sg_sync:euid=0;privs=file_dac_read,file_dac_write,sys_devices