add sg_safte utility

git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@108 6180dd3e-e324-4e3e-922d-17de1ae2f315

3 files changed, 134 insertions, 16 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 91f67d45..284ec50b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -14,7 +14,7 @@ man_MANS = \
 	sgm_dd.8 sg_modes.8 sg_opcodes.8 sgp_dd.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rbuf.8 sg_rdac.8 sg_read.8 sg_readcap.8 \
 	sg_read_buffer.8 sg_read_long.8 sg_reassign.8 sg_requests.8 \
-	sg_reset.8 sg_rmsn.8 sg_rtpg.8 sg_sat_identify.8 \
+	sg_reset.8 sg_rmsn.8 sg_rtpg.8 sg_safte.8 sg_sat_identify.8 \
 	sg_sat_set_features.8 sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 \
 	sg_stpg.8 sg_sync.8 sg_test_rwbuf.8 sg_turs.8 sg_verify.8 sg_vpd.8 \
 	sg_write_buffer.8 sg_write_long.8 sg_wr_mode.8
@@ -31,8 +31,8 @@ man_MANS = \
 	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 sg_scan.8 \
-	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
+	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
+	sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 	sg_wr_mode.8
 
@@ -48,8 +48,8 @@ man_MANS = \
 	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 sg_scan.8 \
-	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
+	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
+	sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 	sg_wr_mode.8
 
@@ -65,7 +65,7 @@ man_MANS = \
 	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 	sg_wr_mode.8
@@ -82,7 +82,7 @@ man_MANS = \
 	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 	sg_wr_mode.8
@@ -99,7 +99,7 @@ man_MANS = \
 	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 	sg_wr_mode.8
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 75786cbf..3b424b63 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -162,7 +162,7 @@ top_srcdir = @top_srcdir@
 @OS_FREEBSD_TRUE@	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 @OS_FREEBSD_TRUE@	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 @OS_FREEBSD_TRUE@	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-@OS_FREEBSD_TRUE@	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+@OS_FREEBSD_TRUE@	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 @OS_FREEBSD_TRUE@	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 @OS_FREEBSD_TRUE@	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 @OS_FREEBSD_TRUE@	sg_wr_mode.8
@@ -180,7 +180,7 @@ top_srcdir = @top_srcdir@
 @OS_LINUX_TRUE@	sgm_dd.8 sg_modes.8 sg_opcodes.8 sgp_dd.8 sg_persist.8 \
 @OS_LINUX_TRUE@	sg_prevent.8 sg_raw.8 sg_rbuf.8 sg_rdac.8 sg_read.8 sg_readcap.8 \
 @OS_LINUX_TRUE@	sg_read_buffer.8 sg_read_long.8 sg_reassign.8 sg_requests.8 \
-@OS_LINUX_TRUE@	sg_reset.8 sg_rmsn.8 sg_rtpg.8 sg_sat_identify.8 \
+@OS_LINUX_TRUE@	sg_reset.8 sg_rmsn.8 sg_rtpg.8 sg_safte.8 sg_sat_identify.8 \
 @OS_LINUX_TRUE@	sg_sat_set_features.8 sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 \
 @OS_LINUX_TRUE@	sg_stpg.8 sg_sync.8 sg_test_rwbuf.8 sg_turs.8 sg_verify.8 sg_vpd.8 \
 @OS_LINUX_TRUE@	sg_write_buffer.8 sg_write_long.8 sg_wr_mode.8
@@ -192,7 +192,7 @@ top_srcdir = @top_srcdir@
 @OS_OSF_TRUE@	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 @OS_OSF_TRUE@	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 @OS_OSF_TRUE@	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-@OS_OSF_TRUE@	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+@OS_OSF_TRUE@	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 @OS_OSF_TRUE@	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 @OS_OSF_TRUE@	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 @OS_OSF_TRUE@	sg_wr_mode.8
@@ -204,7 +204,7 @@ top_srcdir = @top_srcdir@
 @OS_SOLARIS_TRUE@	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 @OS_SOLARIS_TRUE@	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 @OS_SOLARIS_TRUE@	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-@OS_SOLARIS_TRUE@	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 \
+@OS_SOLARIS_TRUE@	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
 @OS_SOLARIS_TRUE@	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 @OS_SOLARIS_TRUE@	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 @OS_SOLARIS_TRUE@	sg_wr_mode.8
@@ -216,8 +216,8 @@ top_srcdir = @top_srcdir@
 @OS_WIN32_CYGWIN_TRUE@	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 @OS_WIN32_CYGWIN_TRUE@	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 @OS_WIN32_CYGWIN_TRUE@	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-@OS_WIN32_CYGWIN_TRUE@	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 sg_scan.8 \
-@OS_WIN32_CYGWIN_TRUE@	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
+@OS_WIN32_CYGWIN_TRUE@	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
+@OS_WIN32_CYGWIN_TRUE@	sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 @OS_WIN32_CYGWIN_TRUE@	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 @OS_WIN32_CYGWIN_TRUE@	sg_wr_mode.8
 
@@ -228,8 +228,8 @@ top_srcdir = @top_srcdir@
 @OS_WIN32_MINGW_TRUE@	sg_modes.8 sg_opcodes.8 sg_persist.8 \
 @OS_WIN32_MINGW_TRUE@	sg_prevent.8 sg_raw.8 sg_rdac.8 sg_readcap.8 sg_read_buffer.8 \
 @OS_WIN32_MINGW_TRUE@	sg_read_long.8 sg_reassign.8 sg_requests.8 sg_rmsn.8 \
-@OS_WIN32_MINGW_TRUE@	sg_rtpg.8 sg_sat_identify.8 sg_sat_set_features.8 sg_scan.8 \
-@OS_WIN32_MINGW_TRUE@	sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
+@OS_WIN32_MINGW_TRUE@	sg_rtpg.8 sg_safte.8 sg_sat_identify.8 sg_sat_set_features.8 \
+@OS_WIN32_MINGW_TRUE@	sg_scan.8 sg_senddiag.8 sg_ses.8 sg_start.8 sg_stpg.8 sg_sync.8 \
 @OS_WIN32_MINGW_TRUE@	sg_turs.8 sg_verify.8 sg_vpd.8 sg_write_buffer.8 sg_write_long.8 \
 @OS_WIN32_MINGW_TRUE@	sg_wr_mode.8
 
diff --git a/doc/sg_safte.8 b/doc/sg_safte.8
new file mode 100644
index 00000000..f71f0e06
--- /dev/null
+++ b/doc/sg_safte.8
@@ -0,0 +1,118 @@
+.TH SG_SAFTE "8" "September 2007" "sg3_utils\-1.25" SG3_UTILS
+.SH NAME
+sg_safte \- Fetch status from a SCSI Accessed Fault\-Tolerant Enclosure
+(SAF\-TE) device
+.SH SYNOPSIS
+.B sg_safte
+[\fI\-\-config\fR] [\fI\-\-devstatus\fR] [\fI\-\-encstatus\fR]
+[\fI\-\-flags\fR] [\fI\-\-help\fR] [\fI\-\-insertions\fR]
+[\fI\-\-usage\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
+.SH DESCRIPTION
+.\" Add any additional description here
+.PP
+Fetches enclosure status (via a SCSI READ BUFFER command).
+The \fIDEVICE\fR should be a SAF\-TE device which may be a storage
+array controller (INQUIRY peripheral device type 0xc) or a generic
+processor device (INQUIRY peripheral device type 0x3).
+.PP
+If no options are given (only the \fIDEVICE\fR argument) then the
+overall enclosure status as reported by the option
+.I
+\-\-config
+.R
+is reported.
+.SH OPTIONS
+Arguments to long options are mandatory for short options as well.
+.TP
+\fB\-c\fR, \fB\-\-config\fR
+will issues a 
+.I
+Read Enclosure Configuration
+.R
+(READ BUFFER ID 0) cdb to the device, which returns a list of the
+enclosure hardware resources.
+.TP
+\fB\-d\fR, \fB\-\-devstatus\fR
+will issue a
+.I
+Read Device Slot Status
+.R
+(READ BUFFER ID 4) cdb to the device, which returns information about
+the current state of each drive or slot.
+.TP
+\fB\-s\fR, \fB\-\-encstatus\fR
+will issue a
+.I
+Read Enclosure Status
+.R
+(READ BUFFER ID 1) cdb to the device, which returns the operational
+state of the components.
+.TP
+\fB\-f\fR, \fB\-\-flags\fR
+will issue a
+.I
+Read Global Flags
+.R
+(READ BUFFER ID 5) cdb to the device, which read the most recent state
+of the global flags of the RAID processor device.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+output the usage message then exit.
+.TP
+\fB\-i\fR, \fB\-\-insertions\fR
+will issue a
+.I
+Read Device Insertions
+.R
+(READ BUFFER ID 3) cdb to the device, which returns information about
+the number of times devices have been inserted whilst the RAID system
+was powered on.
+.TP
+\fB\-u\fR, \fB\-\-usage\fR
+will issue a
+.I
+Read Usage Statistics
+.R
+(READ BUFFER ID 2) cdb to the device, which returns the information on
+total usage time and number of power\-on cycles of the RAID device.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+increase the level of verbosity, (i.e. debug output).
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print the version string and then exit.
+.SH NOTES
+The implementation is based on the intermediate review document eg as
+found at
+.PP
+http://www.intel.com/design/servers/ipmi/saf\-te.htm
+.PP
+As the specification was never finalized this document serves as the
+de\-facto standard.
+.PP
+A similar functionality is provided by the SPC\-4 SCSI Enclosure
+Services devices (Peripheral device type 0xd), which can be queried
+with the sg_ses utility.
+.SH EXAMPLES
+To view the configuration:
+.PP
+   sg_safte /dev/sg1
+.PP
+To view the device slot status:
+.PP
+   sg_safte \-\-devstatus /dev/sg1
+.PP
+.SH EXIT STATUS
+The exit status of sg_ses is 0 when it is successful. Otherwise see
+the sg3_utils(8) man page.
+.SH AUTHORS
+Written by Hannes Reinecke and Douglas Gilbert.
+.SH "REPORTING BUGS"
+Report bugs to <dgilbert at interlog dot com>.
+.SH COPYRIGHT
+Copyright \(co 2004\-2007 Hannes Reinecke and Douglas Gilbert
+.br
+This software is distributed under a FreeBSD license. There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.SH "SEE ALSO"
+.B sg_inq, sg_ses (in sg3_utils package)