[PATCH 2/3] Add EVPD page 0x83 entries to sysfs

[Hannes Reinecke <hare@suse.de>]

EVPD page 0x83 is used to uniquely identify the device.
So instead of having each and every program issue a separate
SG_IO call to retrieve this information it does make far more
sense to display it in sysfs.
The page is displayed in its entirety with the attribute
'vpd_pg83', and the individual designators are stored in
ident_<association>_<designator> attributes.
Duplicate designators are added as individual lines to
the corresponding attribute.

Cc: Jeremy Linton <jlinton@tributary.com>
Cc: Kay Sievers <kay@vrfy.org>
Cc: Doug Gilbert <dgilbert@interlog.com>
Cc: Kai Makisara <kai.makisara@kolumbus.fi>
Signed-off-by: Hannes Reinecke <hare@suse.de>
---
 drivers/scsi/scsi_scan.c   |   3 +
 drivers/scsi/scsi_sysfs.c  | 314 ++++++++++++++++++++++++++++++++++++++++++++-
 include/scsi/scsi.h        |   4 +-
 include/scsi/scsi_device.h |   3 +
 4 files changed, 322 insertions(+), 2 deletions(-)

diff --git a/drivers/scsi/scsi_scan.c b/drivers/scsi/scsi_scan.c
index 307a811..073fb84 100644
--- a/drivers/scsi/scsi_scan.c
+++ b/drivers/scsi/scsi_scan.c
@@ -929,6 +929,9 @@ static int scsi_add_lun(struct scsi_device *sdev, unsigned char *inq_result,
 	if (*bflags & BLIST_SKIP_VPD_PAGES)
 		sdev->skip_vpd_pages = 1;
 
+	if (sdev->scsi_level >= SCSI_3)
+		scsi_attach_vpd_ident(sdev);
+
 	transport_configure_device(&sdev->sdev_gendev);
 
 	if (sdev->host->hostt->slave_configure) {
diff --git a/drivers/scsi/scsi_sysfs.c b/drivers/scsi/scsi_sysfs.c
index 196e59a..ec8f037 100644
--- a/drivers/scsi/scsi_sysfs.c
+++ b/drivers/scsi/scsi_sysfs.c
@@ -80,6 +80,36 @@ const char *scsi_host_state_name(enum scsi_host_state state)
 	return name;
 }
 
+static const struct {
+	int	value;
+	char	*name;
+} scsi_protocol_list[] = {
+	{ SCSI_PROTOCOL_FCP, "fcp" },
+	{ SCSI_PROTOCOL_SPI, "spi" },
+	{ SCSI_PROTOCOL_SSA, "ssa" },
+	{ SCSI_PROTOCOL_SBP, "sbp" },
+	{ SCSI_PROTOCOL_SRP, "srp" },
+	{ SCSI_PROTOCOL_ISCSI, "iscsi" },
+	{ SCSI_PROTOCOL_SAS, "sas" },
+	{ SCSI_PROTOCOL_ADT, "adt" },
+	{ SCSI_PROTOCOL_ATA, "ata" },
+	{ SCSI_PROTOCOL_UAS, "usb" },
+	{ SCSI_PROTOCOL_SOP, "pcie" },
+};
+const char *scsi_protocol_name(int proto)
+{
+	int i;
+	char *name = NULL;
+
+	for (i = 0; i < ARRAY_SIZE(scsi_protocol_list); i++) {
+		if (scsi_protocol_list[i].value == proto) {
+			name = scsi_protocol_list[i].name;
+			break;
+		}
+	}
+	return name;
+}
+
 static int check_set(unsigned int *val, char *src)
 {
 	char *last;
@@ -415,6 +445,7 @@ static void scsi_device_dev_release_usercontext(struct work_struct *work)
 
 	scsi_target_reap(scsi_target(sdev));
 
+	kfree(sdev->vpd_ident);
 	kfree(sdev->inquiry);
 	kfree(sdev);
 
@@ -754,8 +785,241 @@ store_queue_type_field(struct device *dev, struct device_attribute *attr,
 static DEVICE_ATTR(queue_type, S_IRUGO | S_IWUSR, show_queue_type_field,
 		   store_queue_type_field);
 
+void scsi_attach_vpd_ident(struct scsi_device *sdev)
+{
+	int ret;
+	int vpd_len = 255;
+	unsigned char *buffer;
+retry:
+	buffer = kmalloc(vpd_len, GFP_KERNEL);
+	if (!buffer)
+		return;
+
+	ret = scsi_get_vpd_page(sdev, 0x83, buffer, vpd_len);
+	if (ret) {
+		kfree(buffer);
+		return;
+	}
+	if (buffer[1] != 0x83) {
+		kfree(buffer);
+		return;
+	}
+	if ((buffer[2] << 8) + buffer[3] + 4 > vpd_len) {
+		vpd_len = (buffer[2] << 8) + buffer[3] + 4;
+		kfree(buffer);
+		goto retry;
+	}
+	sdev->vpd_ident_len = (buffer[2] << 8) + buffer[3] + 4;
+	sdev->vpd_ident = buffer;
+}
+
 static ssize_t
-show_iostat_counterbits(struct device *dev, struct device_attribute *attr, 				char *buf)
+show_vpd_pg83(struct device *dev, struct device_attribute *attr,
+	      char *buf)
+{
+	struct scsi_device *sdev = to_scsi_device(dev);
+	int len = 0, i;
+
+	if (!sdev->vpd_ident)
+		return -EINVAL;
+
+	len = 0;
+	for (i = 0; i < sdev->vpd_ident_len; i += 16) {
+		hex_dump_to_buffer(sdev->vpd_ident + i, sdev->vpd_ident_len,
+				   16, 1, buf + len, PAGE_SIZE, false);
+		strcat(buf + len, "\n");
+		len += strlen(buf + len);
+	}
+	return len;
+}
+static DEVICE_ATTR(vpd_pg83, S_IRUGO, show_vpd_pg83, NULL);
+
+#define SCSI_VPD_ASSOC_lun 0x0
+#define SCSI_VPD_ASSOC_port 0x1
+#define SCSI_VPD_ASSOC_target 0x2
+
+#define SCSI_VPD_DESIG_vendor 0x0
+#define SCSI_VPD_DESIG_t10 0x1
+#define SCSI_VPD_DESIG_eui 0x2
+#define SCSI_VPD_DESIG_naa 0x3
+#define SCSI_VPD_DESIG_relport 0x4
+#define SCSI_VPD_DESIG_tpgrp 0x5
+#define SCSI_VPD_DESIG_lugrp 0x6
+#define SCSI_VPD_DESIG_md5 0x7
+#define SCSI_VPD_DESIG_scsi_name 0x8
+#define SCSI_VPD_DESIG_proto 0x9
+
+static bool
+scsi_test_vpd_ident(struct scsi_device *sdev, int assoc, int desig)
+{
+	unsigned char *d;
+
+	if (!sdev->vpd_ident || sdev->vpd_ident_len < 4)
+		return false;
+
+	d = sdev->vpd_ident + 4;
+	while (d < sdev->vpd_ident + sdev->vpd_ident_len) {
+		if (d[3] == 0)
+			break;
+		if (((d[1] >> 4) & 3) == assoc &&
+		    (d[1] & 0xf) == desig)
+			return true;
+		d += d[3] + 4;
+	}
+	return false;
+}
+
+static int
+scsi_parse_vpd_ident(struct scsi_device *sdev,
+		     int assoc, int desig, char *buf)
+{
+	unsigned char *d;
+	int len = 0, j;
+
+	if (!sdev->vpd_ident || sdev->vpd_ident_len < 4)
+		return -ENOENT;
+
+	d = sdev->vpd_ident + 4;
+	while (d < sdev->vpd_ident + sdev->vpd_ident_len) {
+		const char *proto = NULL;
+
+		if (d[3] == 0)
+			break;
+		if (d + d[3] + 4 > sdev->vpd_ident + sdev->vpd_ident_len)
+			return -EINVAL;
+		if (((d[1] >> 4) & 0x3) == assoc &&
+		    (d[1] & 0xf) == desig) {
+			if ((d[1] & 0x80) &&
+			    (proto = scsi_protocol_name(d[0] >> 4)))
+				len += sprintf(buf + len, "%s:", proto);
+
+			switch (d[1] & 0xf) {
+			case SCSI_VPD_DESIG_eui:
+			case SCSI_VPD_DESIG_naa:
+			case SCSI_VPD_DESIG_md5:
+				switch (d[3]) {
+				case 8:
+					len += sprintf(buf + len, "%8phN\n",
+						       d + 4);
+					break;
+				case 12:
+					len += sprintf(buf + len, "%12phN\n",
+						       d + 4);
+					break;
+				case 16:
+					len += sprintf(buf + len, "%16phN\n",
+						       d + 4);
+					break;
+				}
+				break;
+			case SCSI_VPD_DESIG_relport:
+			case SCSI_VPD_DESIG_tpgrp:
+			case SCSI_VPD_DESIG_lugrp:
+				len += sprintf(buf + len, "%d\n",
+					      (int)(d[6] << 8) + d[7]);
+				break;
+			case SCSI_VPD_DESIG_vendor:
+				if ((d[0] & 0xf) == 1) {
+					for (j = 0; j < d[3]; j++) {
+						len += sprintf(buf + len,
+							       "%02x",
+							       d[4 + j]);
+					}
+				} else {
+					snprintf(buf + len, d[3] + 1,
+						 "%s", d + 4);
+					len += d[3];
+				}
+				len += sprintf(buf + len, "\n");
+				break;
+			case SCSI_VPD_DESIG_t10:
+				/* T10 Vendor is always ASCII */
+				snprintf(buf + len, 9, "%s ", d + 4);
+				len += 8;
+				if ((d[0] & 0xf) == 1) {
+					for (j = 0; j < d[3] - 8; j++) {
+						len += sprintf(buf + len,
+							       "%02x",
+							       d[12 + j]);
+					}
+				} else {
+					snprintf(buf + len, d[3] - 7,
+						 "%s", d + 12);
+					len += d[3] - 8;
+				}
+				len += sprintf(buf + len, "\n");
+				break;
+			case SCSI_VPD_DESIG_scsi_name:
+				snprintf(buf + len, d[3] + 2, "%s\n", d + 4);
+				len += d[3] + 1;
+				break;
+			case SCSI_VPD_DESIG_proto:
+				if (d[1] & 80) {
+					if ((d[0] >> 4) == 0x9)
+						len += sprintf(buf + len,
+							       "%d-%d\n",
+							       d[4], d[6]);
+					else if ((d[0] >> 4) == 0xa) {
+						j = (d[4] << 8) + d[5];
+						len += sprintf(buf + len,
+							       "%d\n", j);
+					}
+				}
+				break;
+			}
+		}
+		d += d[3] + 4;
+	}
+
+	return len ? len : -EINVAL;
+}
+
+#define sdev_evpd_ident(assoc, desig)				\
+static ssize_t							\
+sdev_show_evpd_ident_##assoc##_##desig (struct device *dev,		\
+					struct device_attribute *attr,	\
+					char *buf)			\
+{									\
+	struct scsi_device *sdev = to_scsi_device(dev);			\
+	return scsi_parse_vpd_ident(sdev, SCSI_VPD_ASSOC_##assoc,	\
+				    SCSI_VPD_DESIG_##desig, buf);	\
+}
+
+#define sdev_evpd_attr(assoc, desig)					\
+	sdev_evpd_ident(assoc, desig)					\
+static DEVICE_ATTR(ident_##assoc##_##desig, S_IRUGO,			\
+		   sdev_show_evpd_ident_##assoc##_##desig, NULL);
+
+sdev_evpd_attr(lun, vendor);
+sdev_evpd_attr(lun, t10);
+sdev_evpd_attr(lun, eui);
+sdev_evpd_attr(lun, naa);
+sdev_evpd_attr(lun, lugrp);
+sdev_evpd_attr(lun, md5);
+sdev_evpd_attr(lun, scsi_name);
+sdev_evpd_attr(port, vendor);
+sdev_evpd_attr(port, t10);
+sdev_evpd_attr(port, relport);
+sdev_evpd_attr(port, tpgrp);
+sdev_evpd_attr(port, eui);
+sdev_evpd_attr(port, naa);
+sdev_evpd_attr(port, scsi_name);
+sdev_evpd_attr(port, proto);
+sdev_evpd_attr(target, vendor);
+sdev_evpd_attr(target, t10);
+sdev_evpd_attr(target, eui);
+sdev_evpd_attr(target, naa);
+sdev_evpd_attr(target, scsi_name);
+
+#define sdev_evpd_test_and_show_attr(sdev, attr, assoc, desig)		\
+	if (attr == &dev_attr_ident_##assoc##_##desig.attr &&		\
+	    !scsi_test_vpd_ident(sdev, SCSI_VPD_ASSOC_##assoc,		\
+				 SCSI_VPD_DESIG_##desig))		\
+		return 0
+
+static ssize_t
+show_iostat_counterbits(struct device *dev, struct device_attribute *attr,
+			char *buf)
 {
 	return snprintf(buf, 20, "%d\n", (int)sizeof(atomic_t) * 8);
 }
@@ -905,6 +1169,33 @@ static umode_t scsi_sdev_attr_is_visible(struct kobject *kobj,
 	    !sdev->host->hostt->change_queue_type)
 		return S_IRUGO;
 
+	if (attr == &dev_attr_vpd_pg83.attr &&
+	    !sdev->vpd_ident)
+		return 0;
+
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, vendor);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, t10);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, eui);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, naa);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, lugrp);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, md5);
+	sdev_evpd_test_and_show_attr(sdev, attr, lun, scsi_name);
+
+	sdev_evpd_test_and_show_attr(sdev, attr, port, vendor);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, t10);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, eui);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, naa);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, relport);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, tpgrp);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, scsi_name);
+	sdev_evpd_test_and_show_attr(sdev, attr, port, proto);
+
+	sdev_evpd_test_and_show_attr(sdev, attr, target, vendor);
+	sdev_evpd_test_and_show_attr(sdev, attr, target, t10);
+	sdev_evpd_test_and_show_attr(sdev, attr, target, eui);
+	sdev_evpd_test_and_show_attr(sdev, attr, target, naa);
+	sdev_evpd_test_and_show_attr(sdev, attr, target, scsi_name);
+
 	return attr->mode;
 }
 
@@ -930,6 +1221,27 @@ static struct attribute *scsi_sdev_attrs[] = {
 	&dev_attr_queue_depth.attr,
 	&dev_attr_queue_type.attr,
 	&dev_attr_queue_ramp_up_period.attr,
+	&dev_attr_vpd_pg83.attr,
+	&dev_attr_ident_lun_vendor.attr,
+	&dev_attr_ident_lun_t10.attr,
+	&dev_attr_ident_lun_eui.attr,
+	&dev_attr_ident_lun_naa.attr,
+	&dev_attr_ident_lun_lugrp.attr,
+	&dev_attr_ident_lun_md5.attr,
+	&dev_attr_ident_lun_scsi_name.attr,
+	&dev_attr_ident_port_vendor.attr,
+	&dev_attr_ident_port_t10.attr,
+	&dev_attr_ident_port_relport.attr,
+	&dev_attr_ident_port_tpgrp.attr,
+	&dev_attr_ident_port_eui.attr,
+	&dev_attr_ident_port_naa.attr,
+	&dev_attr_ident_port_scsi_name.attr,
+	&dev_attr_ident_port_proto.attr,
+	&dev_attr_ident_target_vendor.attr,
+	&dev_attr_ident_target_t10.attr,
+	&dev_attr_ident_target_eui.attr,
+	&dev_attr_ident_target_naa.attr,
+	&dev_attr_ident_target_scsi_name.attr,
 	REF_EVT(media_change),
 	REF_EVT(inquiry_change_reported),
 	REF_EVT(capacity_change_reported),
diff --git a/include/scsi/scsi.h b/include/scsi/scsi.h
index 0a4edfe..8fd13bb 100644
--- a/include/scsi/scsi.h
+++ b/include/scsi/scsi.h
@@ -334,7 +334,7 @@ static inline int scsi_status_is_good(int status)
 #define TYPE_OSD            0x11
 #define TYPE_NO_LUN         0x7f
 
-/* SCSI protocols; these are taken from SPC-3 section 7.5 */
+/* SCSI protocols; these are taken from SPC-4 section 7.6 */
 enum scsi_protocol {
 	SCSI_PROTOCOL_FCP = 0,	/* Fibre Channel */
 	SCSI_PROTOCOL_SPI = 1,	/* parallel SCSI */
@@ -345,6 +345,8 @@ enum scsi_protocol {
 	SCSI_PROTOCOL_SAS = 6,
 	SCSI_PROTOCOL_ADT = 7,	/* Media Changers */
 	SCSI_PROTOCOL_ATA = 8,
+	SCSI_PROTOCOL_UAS = 9,
+	SCSI_PROTOCOL_SOP = 0xa,
 	SCSI_PROTOCOL_UNSPEC = 0xf, /* No specific protocol */
 };
 
diff --git a/include/scsi/scsi_device.h b/include/scsi/scsi_device.h
index dcb2b73..81c7900 100644
--- a/include/scsi/scsi_device.h
+++ b/include/scsi/scsi_device.h
@@ -113,6 +113,8 @@ struct scsi_device {
 	const char * vendor;		/* [back_compat] point into 'inquiry' ... */
 	const char * model;		/* ... after scan; point to static string */
 	const char * rev;		/* ... "nullnullnullnull" before scan */
+	unsigned char vpd_ident_len;
+	unsigned char *vpd_ident;
 	struct scsi_target      *sdev_target;   /* used only for single_lun */
 
 	unsigned int	sdev_bflags; /* black/white flags as also found in
@@ -308,6 +310,7 @@ extern int scsi_add_device(struct Scsi_Host *host, uint channel,
 extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
 extern void scsi_remove_device(struct scsi_device *);
 extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
+void scsi_attach_vpd_ident(struct scsi_device *sdev);
 
 extern int scsi_device_get(struct scsi_device *);
 extern void scsi_device_put(struct scsi_device *);
-- 
1.7.12.4