Merge pull request #357 from BenReed161/add-image-redundancy-subcmd

Add redundant image partition code

Author: Chetana2791

cli/main.c

@@ -1906,11 +1906,12 @@ static void print_fw_part_line(const char *tag,
 	if (!inf)
 		return;
 
-	printf("  %-4s\tVersion: %-8s\tCRC: %08lx\t%4s%11s%s\n",
+	printf("  %-4s\tVersion: %-8s\tCRC: %08lx\t%4s%11s%s%s\n",
 	       tag, inf->version, inf->image_crc,
 	       inf->read_only ? "(RO)" : "",
 	       inf->running ? "  (Running)" : "",
-	       inf->valid ? "" : "  (Invalid)");
+	       inf->valid ? "" : "  (Invalid)",
+	       inf->redundant ? "  (Redundant)" : "");
 }
 
 static int print_fw_part_info(struct switchtec_dev *dev)
@@ -2177,7 +2178,7 @@ static int fw_toggle(int argc, char **argv)
 			"are not supported by Gen3 switches\n");
 		return 1;
 	} else if (cfg.riotcore && switchtec_is_gen4(cfg.dev)){
-		fprintf(stderr, "Firmware type RIOTCORE is not supported by Gen4 switchtes\n");
+		fprintf(stderr, "Firmware type RIOTCORE is not supported by Gen4 switches\n");
 		return 1;
 	} else {
 		ret = switchtec_fw_toggle_active_partition(cfg.dev,
@@ -2205,6 +2206,69 @@ static int fw_toggle(int argc, char **argv)
 	return ret;
 }
 
+#define CMD_DESC_FW_REDUNDANT "Set an image partition to redundant"
+static int fw_redundant(int argc, char **argv)
+{
+
+	int ret = 0;
+
+	static struct {
+		struct switchtec_dev *dev;
+		int bl2;
+		int key;
+		int firmware;
+		int config;
+		int riotcore;
+		int redundant;
+	} cfg = {
+		.redundant = 1,
+	};
+	const struct argconfig_options opts[] = {
+		DEVICE_OPTION,
+		{"bl2", 'b', "", CFG_NONE, &cfg.bl2, no_argument,
+		 "Set redundancy flag for bl2 partition"},
+		{"key", 'k', "", CFG_NONE, &cfg.key, no_argument,
+		 "Set redundancy flag for Key manifest partition"},
+		{"firmware", 'f', "", CFG_NONE, &cfg.firmware, no_argument,
+		 "Set redundancy flag for main FW image partition"},
+		{"config", 'c', "", CFG_NONE, &cfg.config, no_argument,
+		 "Set redundancy flag for data CFG partition"},
+		{"riotcore", 'r', "", CFG_NONE, &cfg.riotcore, no_argument,
+		 "Set redundancy flag for RIOTCORE partition"},
+		{"redundant", 'R', "unset - 0 / set - 1", CFG_INT, &cfg.redundant, required_argument, 
+		 "Set the redundant flag for the selected image type(s). If left blank will set (1)"},
+		{NULL}};
+
+	argconfig_parse(argc, argv, CMD_DESC_FW_REDUNDANT, opts, &cfg, sizeof(cfg));
+
+	if (!switchtec_is_gen5(cfg.dev)) {
+		fprintf(stderr, "Setting the redundant flag is only supported on Gen5 switches\n");
+		return 1;
+	}
+	if (!cfg.bl2 && !cfg.key && !cfg.firmware && !cfg.config && !cfg.riotcore) {
+		fprintf(stderr, "Not setting image partition(s) as redundant since no partition type was specified\n");
+		return 1;
+	}
+	if (cfg.redundant > 1) {
+		fprintf(stderr, "Set redundant flag to either set - 1 or unset - 0\n");
+		return 1;
+	}
+
+	ret = switchtec_fw_set_redundant_flag(cfg.dev, cfg.key, 
+					      cfg.riotcore, cfg.bl2, 
+					      cfg.config, cfg.firmware, 
+					      cfg.redundant);
+	if (ret)
+		switchtec_perror("set redundant flag");
+	
+	ret = print_fw_part_info(cfg.dev);
+	if (ret)
+		switchtec_perror("print fw info");
+
+	printf("\n");
+	return ret;
+}
+
 #define CMD_DESC_FW_READ "read a firmware image from flash"
 
 static int fw_read(int argc, char **argv)
@@ -2781,6 +2845,7 @@ static const struct cmd commands[] = {
 	CMD(fw_update, CMD_DESC_FW_UPDATE),
 	CMD(fw_info, CMD_DESC_FW_INFO),
 	CMD(fw_toggle, CMD_DESC_FW_TOGGLE),
+	CMD(fw_redundant, CMD_DESC_FW_REDUNDANT),
 	CMD(fw_read, CMD_DESC_FW_READ),
 	CMD(fw_img_info, CMD_DESC_FW_IMG_INFO),
 	CMD(evcntr, CMD_DESC_EVCNTR),

inc/switchtec/mrpc.h

@@ -143,6 +143,7 @@ enum mrpc_sub_cmd {
 	MRPC_FWDNLD_DOWNLOAD = 1,
 	MRPC_FWDNLD_TOGGLE = 2,
 	MRPC_FWDNLD_BOOT_RO = 4,
+	MRPC_FWDNLD_SET_RDNDNT = 5,
 
 	MRPC_VGPIO_GET_DIR = 0,
 	MRPC_VGPIO_GET_POL = 1,

inc/switchtec/switchtec.h

@@ -115,6 +115,17 @@ enum switchtec_boot_phase {
 	SWITCHTEC_BOOT_PHASE_UNKNOWN
 };
 
+/**
+ * @brief Device parition types GEN5
+ */
+enum switchtec_parition_types {
+	SWITCHTEC_PART_TYPE_KEYMAN = 1,
+	SWITCHTEC_PART_TYPE_RC = 2,
+	SWITCHTEC_PART_TYPE_BL2 = 3,
+	SWITCHTEC_PART_TYPE_CFG = 4,
+	SWITCHTEC_PART_TYPE_FW = 5
+};
+
 /**
  * @brief The variant types of Switchtec device
  */
@@ -277,6 +288,7 @@ struct switchtec_fw_image_info {
 
 	unsigned long secure_version;
 	bool signed_image;
+	uint8_t redundant;
 };
 
 struct switchtec_fw_part_summary {
@@ -971,6 +983,10 @@ enum switchtec_fw_ro {
 	SWITCHTEC_FW_RO = 1,
 };
 
+int switchtec_fw_set_redundant_flag(struct switchtec_dev *dev, 
+				    int keyman, int riot, 
+				    int bl2, int cfg, int fw, 
+				    int set);
 int switchtec_fw_toggle_active_partition(struct switchtec_dev *dev,
 					 int toggle_bl2, int toggle_key,
 					 int toggle_fw, int toggle_cfg,

lib/fw.c

@@ -235,6 +235,68 @@ static int switchtec_fw_wait(struct switchtec_dev *dev,
 	return 0;
 }
 
+static int set_redundant(struct switchtec_dev *dev, int type, int set)
+{
+	int ret;
+	char *part_types[] = {
+		"KEYMAN",
+		"RIOT",
+		"BL2",
+		"CFG",
+		"MAIN-FW"
+	};
+
+	struct {
+		uint8_t subcmd;
+		uint8_t part_type;
+		uint8_t redundant_val;
+		uint8_t reserved;
+	} cmd;
+
+	cmd.subcmd = MRPC_FWDNLD_SET_RDNDNT;
+	cmd.redundant_val = set;
+	cmd.part_type = type;
+
+	printf("%s redundant flag \t(%s)\n", set ? "Checking" : "Un-checking", 
+	       part_types[type-1]);
+	ret = switchtec_cmd(dev, MRPC_FWDNLD, &cmd, sizeof(cmd), NULL, 0);
+	if (ret) {
+		fprintf(stderr, "Error: setting redudant flag \t(%s)\n", 
+			part_types[type-1]);
+		return 1;
+	}
+	else {
+		printf("Success: set redundant flag \t(%s)\n", 
+		       part_types[type-1]);
+	}
+	return 0;
+}
+
+/**
+ * @brief Set the redundant image flag for the specified image types
+ * @param[in] dev        Switchtec device handle
+ * @param[in] toggle_arr Pointer to the array of togglable image types
+ * @return 0 on success, error code on failure
+ */
+int switchtec_fw_set_redundant_flag (struct switchtec_dev *dev, int keyman, 
+				     int riot, int bl2, int cfg, int fw, 
+				     int set)
+{
+	int ret = 0;
+	if(keyman)
+		ret += set_redundant(dev, SWITCHTEC_PART_TYPE_KEYMAN, set);
+	if (riot)
+		ret += set_redundant(dev, SWITCHTEC_PART_TYPE_RC, set);
+	if (bl2)
+		ret += set_redundant(dev, SWITCHTEC_PART_TYPE_BL2, set);
+	if (cfg)
+		ret += set_redundant(dev, SWITCHTEC_PART_TYPE_CFG, set);
+	if (fw)
+		ret += set_redundant(dev, SWITCHTEC_PART_TYPE_FW, set);
+
+	return ret;
+}
+
 /**
  * @brief Toggle the active firmware partition for the main or configuration
  *	images.
@@ -1252,33 +1314,43 @@ static int switchtec_fw_part_info_gen5(struct switchtec_dev *dev,
 		part_info = &all->map1;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_RIOT0:
+		inf->redundant = all->riot_redundant_flag;
 		part_info = &all->riot0;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_RIOT1:
+		inf->redundant = all->riot_redundant_flag;
 		part_info = &all->riot1;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_KEY0:
+		inf->redundant = all->key_redundant_flag;
 		part_info = &all->keyman0;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_KEY1:
+		inf->redundant = all->key_redundant_flag;
 		part_info = &all->keyman1;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_BL20:
+		inf->redundant = all->bl2_redundant_flag;
 		part_info = &all->bl20;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_BL21:
+		inf->redundant = all->bl2_redundant_flag;
 		part_info = &all->bl21;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_IMG0:
+		inf->redundant = all->img_redundant_flag;
 		part_info = &all->img0;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_IMG1:
+		inf->redundant = all->img_redundant_flag;
 		part_info = &all->img1;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_CFG0:
+		inf->redundant = all->cfg_redundant_flag;
 		part_info = &all->cfg0;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_CFG1:
+		inf->redundant = all->cfg_redundant_flag;
 		part_info = &all->cfg1;
 		break;
 	case SWITCHTEC_FW_PART_ID_G5_NVLOG: