FPGA Image Tools: fpga-describe-local-image outputs the SH version + supporting MBOX HAL changes. Also added rescan option for future use

Author: AWSrobertmj

sdk/management/fpga_image_tools/src/fpga_local_cmd.c

@@ -124,6 +124,56 @@ cli_show_slot_app_pfs(uint32_t afi_slot)
 	return -1;
 }
 
+/**
+ * Rescan the application PF map info for the given AFI slot.
+ *
+ * @param[in]   afi_slot	the fpga slot
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+static int 
+cli_rescan_slot_app_pfs(uint32_t afi_slot)
+{
+	fail_on_quiet(afi_slot >= FPGA_SLOT_MAX, err, CLI_INTERNAL_ERR_STR);
+
+	/** Retrieve and display associated application PFs (if any) */
+	bool found_app_pf = false;
+	int ret;
+	int i;
+	for (i = F1_APP_PF_START; i <= F1_APP_PF_END; i++) {
+		struct fpga_pci_resource_map app_map;
+
+		/** 
+		 * cli_get_app_pf_map will skip the Mbox PF (ret==1).
+		 * We continue up through F1_APP_PF_END (e.g. 15) for future 
+		 * compatibilty with any gaps in the PF numbering.
+		 */
+		ret = cli_get_app_pf_map(afi_slot, i, &app_map);
+		if (ret == 0) {
+			ret = cli_remove_app_pf(afi_slot, app_map.func);
+			if (ret != 0) {
+				/** Output an error but continue with the other app PFs */
+				printf("Error: could not remove application PF device " 
+						PCI_DEV_FMT "\n", 
+						app_map.domain, app_map.bus, app_map.dev, 
+						app_map.func);
+			}
+			found_app_pf = true;
+		} 
+	}
+	if (found_app_pf) {
+		ret = cli_pci_rescan();
+		fail_on_user(ret != 0, err,
+				"Error: could not rescan for application PF devices");
+	}
+
+	return 0;
+err:
+	return -1;
+}
+
 /**
  * Attach for CLI processing.
  *
@@ -533,6 +583,7 @@ handle_afi_cmd_metrics_rsp(const union afi_cmd *cmd,
 	(void)cmd;
 	/** We've already validated the header... */
 	struct afi_cmd_metrics_rsp *metrics = (void *)rsp->body;
+	int ret;
 
 	uint32_t tmp_len = 
 		sizeof(struct afi_cmd_hdr) + sizeof(struct afi_cmd_metrics_rsp);
@@ -541,7 +592,7 @@ handle_afi_cmd_metrics_rsp(const union afi_cmd *cmd,
 			len, tmp_len);
 
 	if (f1.show_headers) {
-		printf("Type  FpgaImageSlot  FpgaImageId             StatusName    StatusCode\n");         
+		printf("Type  FpgaImageSlot  FpgaImageId             StatusName    StatusCode   ShVersion\n");         
 	}
 
 	char *afi_id = (!metrics->ids.afi_id[0]) ? "none" : metrics->ids.afi_id;
@@ -551,10 +602,22 @@ handle_afi_cmd_metrics_rsp(const union afi_cmd *cmd,
 	if ((metrics->status < ACMS_END) && acms_tbl[metrics->status]) {
 		status_name = (void *)acms_tbl[metrics->status]; 
 	}
-	printf("  %-8s         %2u\n", status_name, metrics->status); 
+
+	struct fpga_hal_mbox_versions ver;
+	ret = fpga_hal_mbox_get_versions(&ver);
+	fail_on_quiet(ret != 0, err, "fpga_hal_mbox_get_versions failed");
+
+	printf("  %-8s         %2u        0x%08x\n", 
+			status_name, metrics->status, ver.sh_version); 
+
+	if (f1.rescan) {
+		/** Rescan the application PFs for this slot */
+		ret = cli_rescan_slot_app_pfs(f1.afi_slot);
+		fail_on_quiet(ret != 0, err, "cli_rescan_slot_app_pfs failed");
+	}
 
 	/** Display the application PFs for this slot */
-	int ret = cli_show_slot_app_pfs(f1.afi_slot);
+	ret = cli_show_slot_app_pfs(f1.afi_slot);
 	fail_on_quiet(ret != 0, err, "cli_show_slot_app_pfs failed");
 
 	return 0;

sdk/management/fpga_image_tools/src/fpga_local_cmd.h

@@ -120,6 +120,7 @@ struct ec2_fpga_cmd {
 	bool	 show_headers;
 	bool	 get_hw_metrics;
 	bool	 clear_hw_metrics;
+	bool	 rescan;
 };
 
 extern struct ec2_fpga_cmd f1;
@@ -160,3 +161,26 @@ void cli_pci_free(void);
  */
 int cli_get_app_pf_map(uint32_t slot, uint32_t app_pf_num, 
 		struct fpga_pci_resource_map *map);
+
+/**
+ * Remove the application PF for the given mbox slot.
+ *
+ * @param[in]   slot		the fpga slot
+ * @param[in]   app_pf_num	the application PF number to check 
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+int
+cli_remove_app_pf(uint32_t slot, uint32_t app_pf_num);
+
+/**
+ * PCI rescan.
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+int
+cli_pci_rescan(void);

sdk/management/fpga_image_tools/src/fpga_local_cmd_parse.c

@@ -82,6 +82,13 @@ static const char *describe_afi_usage[] = {
 	"      -S, --fpga-image-slot",
 	"          The logical slot number for the FPGA image.",
 	"          Constraints: Positive integer from 0 to the total slots minus 1.",
+	"      -R  --rescan",
+	"          Rescan the AFIDEVICE to update the per-AFI PCI VendorId and",
+	"          DeviceId that may be dynamically modified due to a",
+	"          fpga-load-local-image or fpga-clear-local-image command.",
+	"          NOTE: this option removes the AFIDEVICE from the sysfs PCI", 
+	"          subsystem and then rescans the PCI subsystem in order for",
+	"          the modified AFI PCI IDs to be refreshed.",
 	"      -?, --help",
 	"          Display this help.",
 	"      -H, --headers",
@@ -224,15 +231,15 @@ parse_args_load_afi(int argc, char *argv[])
 	static struct option long_options[] = {
 		{"fpga-image-slot",		required_argument,	0,	'S'	},
 		{"fpga-image-id",		required_argument,	0,	'I'	},
-		{"request-timeout",		required_argument,	0,	'R'	},
+		{"request-timeout",		required_argument,	0,	'r'	},
 		{"headers",				no_argument,		0,	'H'	},
 		{"help",				no_argument,		0,	'?'	},
 		{"version",				no_argument,		0,	'V'	},
 		{0,						0,					0,	0	},
 	};
 
 	int long_index = 0;
-	while ((opt = getopt_long(argc, argv, "S:I:R:H?hV",
+	while ((opt = getopt_long(argc, argv, "S:I:r:H?hV",
 			long_options, &long_index)) != -1) {
 		switch (opt) {
 		case 'S': {
@@ -249,7 +256,7 @@ parse_args_load_afi(int argc, char *argv[])
 			f1.afi_id[sizeof(f1.afi_id) - 1] = 0; 
 			break;
 		}
-		case 'R': {
+		case 'r': {
 			uint32_t value32;
 			string_to_uint(&value32, optarg);
 			int ret = config_request_timeout(value32);
@@ -295,15 +302,15 @@ parse_args_clear_afi(int argc, char *argv[])
 
 	static struct option long_options[] = {
 		{"fpga-image-slot",		required_argument,	0,	'S'	},
-		{"request-timeout",		required_argument,	0,	'R'	},
+		{"request-timeout",		required_argument,	0,	'r'	},
 		{"headers",				no_argument,		0,	'H'	},
 		{"help",				no_argument,		0,	'?'	},
 		{"version",				no_argument,		0,	'V'	},
 		{0,						0,					0,	0	},
 	};
 
 	int long_index = 0;
-	while ((opt = getopt_long(argc, argv, "S:R:H?hV",
+	while ((opt = getopt_long(argc, argv, "S:r:H?hV",
 			long_options, &long_index)) != -1) {
 		switch (opt) {
 		case 'S': {
@@ -312,7 +319,7 @@ parse_args_clear_afi(int argc, char *argv[])
 					FPGA_SLOT_MAX);
 			break;
 		}
-		case 'R': {
+		case 'r': {
 			uint32_t value32;
 			string_to_uint(&value32, optarg);
 			int ret = config_request_timeout(value32);
@@ -357,15 +364,16 @@ parse_args_describe_afi(int argc, char *argv[])
 
 	static struct option long_options[] = {
 		{"fpga-image-slot",		required_argument,	0,	'S'	},
-		{"request-timeout",		required_argument,	0,	'R'	},
+		{"request-timeout",		required_argument,	0,	'r'	},
+		{"rescan",				no_argument,		0,	'R'	},
 		{"headers",				no_argument,		0,	'H'	},
 		{"help",				no_argument,		0,	'?'	},
 		{"version",				no_argument,		0,	'V'	},
 		{0,						0,					0,	0	},
 	};
 
 	int long_index = 0;
-	while ((opt = getopt_long(argc, argv, "S:MCR:H?hV",
+	while ((opt = getopt_long(argc, argv, "S:r:RH?hV",
 			long_options, &long_index)) != -1) {
 		switch (opt) {
 		case 'S': {
@@ -374,13 +382,17 @@ parse_args_describe_afi(int argc, char *argv[])
 					"fpga-image-slot must be less than %u", FPGA_SLOT_MAX);
 			break;
 		}
-		case 'R': {
+		case 'r': {
 			uint32_t value32;
 			string_to_uint(&value32, optarg);
 			int ret = config_request_timeout(value32);
 			fail_on_quiet(ret != 0, err, "Could not configure the request-timeout");
 			break;
 		}
+		case 'R': {
+			f1.rescan = true;
+			break;
+		}
 		case 'H': {
 			f1.show_headers = true;
 			break;
@@ -418,18 +430,18 @@ parse_args_describe_afi_slots(int argc, char *argv[])
 	int opt = 0;
 
 	static struct option long_options[] = {
-		{"request-timeout",		required_argument,	0,	'R'	},
+		{"request-timeout",		required_argument,	0,	'r'	},
 		{"headers",				no_argument,		0,	'H'	},
 		{"help",				no_argument,		0,	'?'	},
 		{"version",				no_argument,		0,	'V'	},
 		{0,						0,					0,	0	},
 	};
 
 	int long_index = 0;
-	while ((opt = getopt_long(argc, argv, "R:H?hV",
+	while ((opt = getopt_long(argc, argv, "r:H?hV",
 			long_options, &long_index)) != -1) {
 		switch (opt) {
-		case 'R': {
+		case 'r': {
 			uint32_t value32;
 			string_to_uint(&value32, optarg);
 			int ret = config_request_timeout(value32);

sdk/management/fpga_image_tools/src/fpga_local_cmd_pci_sysfs.c

@@ -19,6 +19,8 @@
 
 #include <assert.h>
 #include <limits.h>
+#include <fcntl.h>
+#include <unistd.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <stdlib.h>
@@ -227,6 +229,112 @@ cli_get_app_pf_map(uint32_t slot, uint32_t app_pf_num,
 	return -1;
 }
 
+/**
+ * Write a '1' to the given sysfs file.
+ *
+ * @param[in]		path	the sysfs file path 
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+static int
+cli_write_one2file(char *path)
+{
+	int ret = -1;
+
+	int fd = open(path, O_WRONLY);
+	fail_on_quiet(fd == -1, err, "opening %s", path);
+
+	char buf[] = { '1', 0 };
+	ret = -!!write_loop(fd, buf, sizeof(buf)); 
+	fail_on_quiet(ret != 0, err_close, "error writing %s", path);
+
+err_close:
+	close(fd);
+err:
+	return ret;
+}
+
+/**
+ * Remove the application PF for the given mbox slot.
+ *
+ * @param[in]   slot		the fpga slot
+ * @param[in]   app_pf_num	the application PF number to check 
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+int
+cli_remove_app_pf(uint32_t slot, uint32_t app_pf_num)
+{
+	fail_on_quiet(slot >= FPGA_SLOT_MAX, err, CLI_INTERNAL_ERR_STR);
+	fail_on_quiet(app_pf_num > F1_APP_PF_END, err, CLI_INTERNAL_ERR_STR);
+
+	/** Setup pointers to the mbox and associated PCI resource maps */
+	struct fpga_pci_resource_map *mbox_map = &f1.mbox_slot_devs[slot].map;
+
+	/** Construct the PCI device directory name using the PCI_DEV_FMT */
+	char dir_name[NAME_MAX + 1];
+	int ret = snprintf(dir_name, sizeof(dir_name), PCI_DEV_FMT,
+		mbox_map->domain, mbox_map->bus, mbox_map->dev, app_pf_num);
+
+	fail_on_quiet(ret < 0, err, "Error building the dir_name");
+	fail_on_quiet((size_t) ret >= sizeof(dir_name), err, "dir_name too long");
+
+	/** Setup the path to the device's remove file */
+	char sysfs_name[NAME_MAX + 1];
+	ret = snprintf(sysfs_name, sizeof(sysfs_name), 
+			"/sys/bus/pci/devices/%s/remove", dir_name);
+
+	fail_on_quiet(ret < 0, err, 
+			"Error building the sysfs path for remove file");
+	fail_on_quiet((size_t) ret >= sizeof(sysfs_name), err, 
+			"sysfs path too long for remove file");
+
+	/** Write a "1" to the device's remove file */
+	ret = cli_write_one2file(sysfs_name);
+	fail_on_quiet(ret != 0, err, "cli_write_one2file failed");
+
+	/** Check for file existence, should fail */
+	struct stat file_stat;
+	ret = stat(sysfs_name, &file_stat);
+	fail_on_quiet(ret == 0, err, "remove failed for path=%s", sysfs_name);
+
+	return 0;
+err:
+	return -1;
+}
+
+/**
+ * PCI rescan.
+ *
+ * @returns
+ *  0	on success 
+ * -1	on failure
+ */
+int
+cli_pci_rescan(void)
+{
+	/** Setup and write '1' to the PCI rescan file */
+	char sysfs_name[NAME_MAX + 1];
+	int ret = snprintf(sysfs_name, sizeof(sysfs_name), "/sys/bus/pci/rescan");
+
+	fail_on_quiet(ret < 0, err, 
+			"Error building the sysfs path for PCI rescan file");
+	fail_on_quiet((size_t) ret >= sizeof(sysfs_name), err, 
+			"sysfs path too long for PCI rescan file");
+
+	/** Write a "1" to the PCI rescan file */
+	ret = cli_write_one2file(sysfs_name);
+	fail_on_quiet(ret != 0, err, "cli_write_one2file failed");
+
+	return 0;
+err:
+	return -1;
+}
+
 /**
  * Handle one PCI device directory with the given directory name, and see if 
  * it is an AFI mbox slot.  If so, initialize a slot device structure for it