Improve and expand sesutil(8)

- Return an error if no matching device is found when the locate command is run
- Enhance the locate command to be able to address drive bays with no disk, or where the SES controller has not made the mapping to the device name
- Added the fault command, similar to locate, but a different SES property. On some of my controllers locate blinks the activity light, others the fault light. The fault command keeps the fault light on constant.
- Improve the usage() output and use it everywhere
- Added the map command, displays all elements connected to each (or the specified) ses(4) controller
- Added the status command, returns the overall status of the ses(4) controller

Reviewed by:	wblock (man page, earlier version)
Approved by:	bapt (mentor)
MFC after:	3 weeks
Relnotes:	yes
Sponsored by:	ScaleEngine Inc.
Differential Revision:	https://reviews.freebsd.org/D3580

1 files changed, 194 insertions, 0 deletions

diff --git a/usr.sbin/sesutil/eltsub.c b/usr.sbin/sesutil/eltsub.c
new file mode 100644
index 0000000..dae02fe
--- /dev/null
+++ b/usr.sbin/sesutil/eltsub.c
@@ -0,0 +1,194 @@
+/* $FreeBSD$ */
+/*
+ * Copyright (c) 2000 by Matthew Jacob
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions, and the following disclaimer,
+ *    without modification, immediately at the beginning of the file.
+ * 2. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * Alternatively, this software may be distributed under the terms of the
+ * the GNU Public License ("GPL").
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * 
+ * Matthew Jacob
+ * Feral Software
+ * mjacob@feral.com
+ */
+
+#include <unistd.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <sys/ioctl.h>
+#include <cam/scsi/scsi_all.h>
+#include <cam/scsi/scsi_enc.h>
+
+#include "eltsub.h"
+
+char *
+geteltnm(int type)
+{
+	static char rbuf[132];
+
+	switch (type) {
+	case ELMTYP_UNSPECIFIED:
+		sprintf(rbuf, "Unspecified");
+		break;
+	case ELMTYP_DEVICE:
+		sprintf(rbuf, "Device Slot");
+		break;
+	case ELMTYP_POWER:
+		sprintf(rbuf, "Power Supply");
+		break;
+	case ELMTYP_FAN:
+		sprintf(rbuf, "Cooling");
+		break;
+	case ELMTYP_THERM:
+		sprintf(rbuf, "Temperature Sensors");
+		break;
+	case ELMTYP_DOORLOCK:
+		sprintf(rbuf, "Door Lock");
+		break;
+	case ELMTYP_ALARM:
+		sprintf(rbuf, "Audible alarm");
+		break;
+	case ELMTYP_ESCC:
+		sprintf(rbuf, "Enclosure Services Controller Electronics");
+		break;
+	case ELMTYP_SCC:
+		sprintf(rbuf, "SCC Controller Electronics");
+		break;
+	case ELMTYP_NVRAM:
+		sprintf(rbuf, "Nonvolatile Cache");
+		break;
+	case ELMTYP_INV_OP_REASON:
+		sprintf(rbuf, "Invalid Operation Reason");
+		break;
+	case ELMTYP_UPS:
+		sprintf(rbuf, "Uninterruptible Power Supply");
+		break;
+	case ELMTYP_DISPLAY:
+		sprintf(rbuf, "Display");
+		break;
+	case ELMTYP_KEYPAD:
+		sprintf(rbuf, "Key Pad Entry");
+		break;
+	case ELMTYP_ENCLOSURE:
+		sprintf(rbuf, "Enclosure");
+		break;
+	case ELMTYP_SCSIXVR:
+		sprintf(rbuf, "SCSI Port/Transceiver");
+		break;
+	case ELMTYP_LANGUAGE:
+		sprintf(rbuf, "Language");
+		break;
+	case ELMTYP_COMPORT:
+		sprintf(rbuf, "Communication Port");
+		break;
+	case ELMTYP_VOM:
+		sprintf(rbuf, "Voltage Sensor");
+		break;
+	case ELMTYP_AMMETER:
+		sprintf(rbuf, "Current Sensor");
+		break;
+	case ELMTYP_SCSI_TGT:
+		sprintf(rbuf, "SCSI Target Port");
+		break;
+	case ELMTYP_SCSI_INI:
+		sprintf(rbuf, "SCSI Initiator Port");
+		break;
+	case ELMTYP_SUBENC:
+		sprintf(rbuf, "Simple Subenclosure");
+		break;
+	case ELMTYP_ARRAY_DEV:
+		sprintf(rbuf, "Array Device Slot");
+		break;
+	case ELMTYP_SAS_EXP:
+		sprintf(rbuf, "SAS Expander");
+		break;
+	case ELMTYP_SAS_CONN:
+		sprintf(rbuf, "SAS Connector");
+		break;
+	default:
+		(void) sprintf(rbuf, "<Type 0x%x>", type);
+		break;
+	}
+	return (rbuf);
+}
+
+static char *
+scode2ascii(u_char code)
+{
+	static char rbuf[32];
+	switch (code & 0xf) {
+	case SES_OBJSTAT_UNSUPPORTED:
+		sprintf(rbuf, "Unsupported");
+		break;
+	case SES_OBJSTAT_OK:
+		sprintf(rbuf, "OK");
+		break;
+	case SES_OBJSTAT_CRIT:
+		sprintf(rbuf, "Critical");
+		break;
+	case SES_OBJSTAT_NONCRIT:
+		sprintf(rbuf, "Noncritical");
+		break;
+	case SES_OBJSTAT_UNRECOV:
+		sprintf(rbuf, "Unrecoverable");
+		break;
+	case SES_OBJSTAT_NOTINSTALLED:
+		sprintf(rbuf, "Not Installed");
+		break;
+	case SES_OBJSTAT_UNKNOWN:
+		sprintf(rbuf, "Unknown");
+		break;
+	case SES_OBJSTAT_NOTAVAIL:
+		sprintf(rbuf, "Not Available");
+		break;
+	case SES_OBJSTAT_NOACCESS:
+		sprintf(rbuf, "No Access Allowed");
+		break;
+	default:
+		sprintf(rbuf, "<Status 0x%x>", code & 0xf);
+		break;
+	}
+	return (rbuf);
+}
+
+
+char *
+stat2ascii(int eletype, u_char *cstat)
+{
+	static char ebuf[256], *scode;
+
+	scode = scode2ascii(cstat[0]);
+	sprintf(ebuf, "%s%s%s%s%s%s (0x%02x 0x%02x 0x%02x 0x%02x)",
+	    scode,
+	    (cstat[0] & 0x40) ? ", Prd.Fail" : "",
+	    (cstat[0] & 0x20) ? ", Disabled" : "",
+	    (cstat[0] & 0x10) ? ", Swapped" : "",
+	    (eletype == ELMTYP_DEVICE && (cstat[2] & 0x02)) ?
+		", LED=Locate" : "",
+	    (eletype == ELMTYP_DEVICE && (cstat[3] & 0x20)) ?
+		", LED=Fault" : "",
+	    cstat[0], cstat[1], cstat[2], cstat[3]);
+	return (ebuf);
+}