1f2507
From 4a86034f138e1a96e54047b8036b0a4425e99944 Mon Sep 17 00:00:00 2001
1f2507
From: Ido Schimmel <idosch@nvidia.com>
1f2507
Date: Tue, 23 Nov 2021 19:41:00 +0200
1f2507
Subject: [PATCH 32/35] cmis: Print Module State and Fault Cause
1f2507
1f2507
Print the CMIS Module State when dumping EEPROM contents via the '-m'
1f2507
option. It can be used, for example, to test module power mode settings.
1f2507
1f2507
Example output:
1f2507
1f2507
 # ethtool -m swp11
1f2507
 Identifier                                : 0x18 (QSFP-DD Double Density 8X Pluggable Transceiver (INF-8628))
1f2507
 ...
1f2507
 Module State                              : 0x03 (ModuleReady)
1f2507
1f2507
 # ethtool --set-module swp11 power-mode-policy auto
1f2507
1f2507
 # ethtool -m swp11
1f2507
 Identifier                                : 0x18 (QSFP-DD Double Density 8X Pluggable Transceiver (INF-8628))
1f2507
 ...
1f2507
 Module State                              : 0x01 (ModuleLowPwr)
1f2507
1f2507
In case the module is in fault state, print the CMIS Module Fault Cause.
1f2507
1f2507
Signed-off-by: Ido Schimmel <idosch@nvidia.com>
1f2507
---
1f2507
 cmis.c | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1f2507
 cmis.h | 16 ++++++++++++++
1f2507
 2 files changed, 86 insertions(+)
1f2507
1f2507
diff --git a/cmis.c b/cmis.c
1f2507
index d7b7097139b3..a32cc9f8b1f6 100644
1f2507
--- a/cmis.c
1f2507
+++ b/cmis.c
1f2507
@@ -402,6 +402,74 @@ static void cmis_show_vendor_info(const struct cmis_memory_map *map)
1f2507
 			       CMIS_CLEI_END_OFFSET, "CLEI code");
1f2507
 }
1f2507
 
1f2507
+/* Print the current Module State. Relevant documents:
1f2507
+ * [1] CMIS Rev. 5, pag. 57, section 6.3.2.2, Figure 6-3
1f2507
+ * [2] CMIS Rev. 5, pag. 60, section 6.3.2.3, Figure 6-4
1f2507
+ * [3] CMIS Rev. 5, pag. 107, section 8.2.2, Table 8-6
1f2507
+ */
1f2507
+static void cmis_show_mod_state(const struct cmis_memory_map *map)
1f2507
+{
1f2507
+	__u8 mod_state;
1f2507
+
1f2507
+	mod_state = (map->lower_memory[CMIS_MODULE_STATE_OFFSET] &
1f2507
+		     CMIS_MODULE_STATE_MASK) >> 1;
1f2507
+	printf("\t%-41s : 0x%02x", "Module State", mod_state);
1f2507
+	switch (mod_state) {
1f2507
+	case CMIS_MODULE_STATE_MODULE_LOW_PWR:
1f2507
+		printf(" (ModuleLowPwr)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_STATE_MODULE_PWR_UP:
1f2507
+		printf(" (ModulePwrUp)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_STATE_MODULE_READY:
1f2507
+		printf(" (ModuleReady)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_STATE_MODULE_PWR_DN:
1f2507
+		printf(" (ModulePwrDn)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_STATE_MODULE_FAULT:
1f2507
+		printf(" (ModuleFault)\n");
1f2507
+		break;
1f2507
+	default:
1f2507
+		printf(" (reserved or unknown)\n");
1f2507
+		break;
1f2507
+	}
1f2507
+}
1f2507
+
1f2507
+/* Print the Module Fault Information. Relevant documents:
1f2507
+ * [1] CMIS Rev. 5, pag. 64, section 6.3.2.12
1f2507
+ * [2] CMIS Rev. 5, pag. 115, section 8.2.10, Table 8-15
1f2507
+ */
1f2507
+static void cmis_show_mod_fault_cause(const struct cmis_memory_map *map)
1f2507
+{
1f2507
+	__u8 mod_state, fault_cause;
1f2507
+
1f2507
+	mod_state = (map->lower_memory[CMIS_MODULE_STATE_OFFSET] &
1f2507
+		     CMIS_MODULE_STATE_MASK) >> 1;
1f2507
+	if (mod_state != CMIS_MODULE_STATE_MODULE_FAULT)
1f2507
+		return;
1f2507
+
1f2507
+	fault_cause = map->lower_memory[CMIS_MODULE_FAULT_OFFSET];
1f2507
+	printf("\t%-41s : 0x%02x", "Module Fault Cause", fault_cause);
1f2507
+	switch (fault_cause) {
1f2507
+	case CMIS_MODULE_FAULT_NO_FAULT:
1f2507
+		printf(" (No fault detected / not supported)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_FAULT_TEC_RUNAWAY:
1f2507
+		printf(" (TEC runaway)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_FAULT_DATA_MEM_CORRUPTED:
1f2507
+		printf(" (Data memory corrupted)\n");
1f2507
+		break;
1f2507
+	case CMIS_MODULE_FAULT_PROG_MEM_CORRUPTED:
1f2507
+		printf(" (Program memory corrupted)\n");
1f2507
+		break;
1f2507
+	default:
1f2507
+		printf(" (reserved or unknown)\n");
1f2507
+		break;
1f2507
+	}
1f2507
+}
1f2507
+
1f2507
 static void cmis_parse_dom_power_type(const struct cmis_memory_map *map,
1f2507
 				      struct sff_diags *sd)
1f2507
 {
1f2507
@@ -775,6 +843,8 @@ static void cmis_show_all_common(const struct cmis_memory_map *map)
1f2507
 	cmis_show_link_len(map);
1f2507
 	cmis_show_vendor_info(map);
1f2507
 	cmis_show_rev_compliance(map);
1f2507
+	cmis_show_mod_state(map);
1f2507
+	cmis_show_mod_fault_cause(map);
1f2507
 	cmis_show_dom(map);
1f2507
 }
1f2507
 
1f2507
diff --git a/cmis.h b/cmis.h
1f2507
index 310697b0ef32..2c67ad5640ab 100644
1f2507
--- a/cmis.h
1f2507
+++ b/cmis.h
1f2507
@@ -7,6 +7,15 @@
1f2507
 #define CMIS_MEMORY_MODEL_OFFSET		0x02
1f2507
 #define CMIS_MEMORY_MODEL_MASK			0x80
1f2507
 
1f2507
+/* Global Status Information (Page 0) */
1f2507
+#define CMIS_MODULE_STATE_OFFSET		0x03
1f2507
+#define CMIS_MODULE_STATE_MASK			0x0E
1f2507
+#define CMIS_MODULE_STATE_MODULE_LOW_PWR	0x01
1f2507
+#define CMIS_MODULE_STATE_MODULE_PWR_UP		0x02
1f2507
+#define CMIS_MODULE_STATE_MODULE_READY		0x03
1f2507
+#define CMIS_MODULE_STATE_MODULE_PWR_DN		0x04
1f2507
+#define CMIS_MODULE_STATE_MODULE_FAULT		0x05
1f2507
+
1f2507
 /* Module Flags (Page 0) */
1f2507
 #define CMIS_VCC_AW_OFFSET			0x09
1f2507
 #define CMIS_VCC_LWARN_STATUS			0x80
1f2507
@@ -27,6 +36,13 @@
1f2507
 #define CMIS_CURR_TEMP_OFFSET			0x0E
1f2507
 #define CMIS_CURR_VCC_OFFSET			0x10
1f2507
 
1f2507
+/* Module Fault Information (Page 0) */
1f2507
+#define CMIS_MODULE_FAULT_OFFSET		0x29
1f2507
+#define CMIS_MODULE_FAULT_NO_FAULT		0x00
1f2507
+#define CMIS_MODULE_FAULT_TEC_RUNAWAY		0x01
1f2507
+#define CMIS_MODULE_FAULT_DATA_MEM_CORRUPTED	0x02
1f2507
+#define CMIS_MODULE_FAULT_PROG_MEM_CORRUPTED	0x03
1f2507
+
1f2507
 #define CMIS_CTOR_OFFSET			0xCB
1f2507
 
1f2507
 /* Vendor related information (Page 0) */
1f2507
-- 
1f2507
2.35.1
1f2507