image: Move common image code to image_board and command

We should use the cmd/ directory for commands rather than for common code
used elsewhere in U-Boot. Move the common 'source' code into
image-board.c to achieve this.

The image_source_script() function needs to call run_command_list()  so
seems to belong better in the command library. Move and rename it.

Signed-off-by: Simon Glass <sjg@chromium.org>

arch/arm/mach-stm32mp/cmd_stm32prog/cmd_stm32prog.c

@@ -154,7 +154,7 @@ static int do_stm32prog(struct cmd_tbl *cmdtp, int flag, int argc,
 			do_bootz(cmdtp, 0, 4, bootm_argv);
 	}
 	if (data->script)
-		image_source_script(data->script, NULL, NULL);
+		cmd_source_script(data->script, NULL, NULL);
 
 	if (reset) {
 		puts("Reset...\n");

boot/bootmeth_script.c

@@ -101,7 +101,7 @@ static int script_boot(struct udevice *dev, struct bootflow *bflow)
 	log_debug("mmc_bootdev: %s\n", env_get("mmc_bootdev"));
 
 	addr = map_to_sysmem(bflow->buf);
-	ret = image_source_script(addr, NULL, NULL);
+	ret = cmd_source_script(addr, NULL, NULL);
 	if (ret)
 		return log_msg_ret("boot", ret);
 

boot/image-board.c

@@ -971,3 +971,162 @@ void genimg_print_time(time_t timestamp)
 	       tm.tm_year, tm.tm_mon, tm.tm_mday,
 	       tm.tm_hour, tm.tm_min, tm.tm_sec);
 }
+
+/**
+ * get_default_image() - Return default property from /images
+ *
+ * Return: Pointer to value of default property (or NULL)
+ */
+static const char *get_default_image(const void *fit)
+{
+	int images_noffset;
+
+	images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
+	if (images_noffset < 0)
+		return NULL;
+
+	return fdt_getprop(fit, images_noffset, FIT_DEFAULT_PROP, NULL);
+}
+
+int image_locate_script(void *buf, int size, const char *fit_uname,
+			const char *confname, char **datap, uint *lenp)
+{
+	const struct legacy_img_hdr *hdr;
+	const void *fit_data;
+	const void *fit_hdr;
+	size_t fit_len;
+	int noffset;
+	int verify;
+	ulong len;
+	u32 *data;
+
+	verify = env_get_yesno("verify");
+
+	switch (genimg_get_format(buf)) {
+	case IMAGE_FORMAT_LEGACY:
+		if (IS_ENABLED(CONFIG_LEGACY_IMAGE_FORMAT)) {
+			hdr = buf;
+
+			if (!image_check_magic(hdr)) {
+				puts("Bad magic number\n");
+				return 1;
+			}
+
+			if (!image_check_hcrc(hdr)) {
+				puts("Bad header crc\n");
+				return 1;
+			}
+
+			if (verify) {
+				if (!image_check_dcrc(hdr)) {
+					puts("Bad data crc\n");
+					return 1;
+				}
+			}
+
+			if (!image_check_type(hdr, IH_TYPE_SCRIPT)) {
+				puts("Bad image type\n");
+				return 1;
+			}
+
+			/* get length of script */
+			data = (u32 *)image_get_data(hdr);
+
+			len = uimage_to_cpu(*data);
+			if (!len) {
+				puts("Empty Script\n");
+				return 1;
+			}
+
+			/*
+			 * scripts are just multi-image files with one
+			 * component, so seek past the zero-terminated sequence
+			 * of image lengths to get to the actual image data
+			 */
+			while (*data++);
+		}
+		break;
+	case IMAGE_FORMAT_FIT:
+		if (IS_ENABLED(CONFIG_FIT)) {
+			fit_hdr = buf;
+			if (fit_check_format(fit_hdr, IMAGE_SIZE_INVAL)) {
+				puts("Bad FIT image format\n");
+				return 1;
+			}
+
+			if (!fit_uname) {
+				/* If confname is empty, use the default */
+				if (confname && *confname)
+					noffset = fit_conf_get_node(fit_hdr, confname);
+				else
+					noffset = fit_conf_get_node(fit_hdr, NULL);
+				if (noffset < 0) {
+					if (!confname)
+						goto fallback;
+					printf("Could not find config %s\n", confname);
+					return 1;
+				}
+
+				if (verify && fit_config_verify(fit_hdr, noffset))
+					return 1;
+
+				noffset = fit_conf_get_prop_node(fit_hdr,
+								 noffset,
+								 FIT_SCRIPT_PROP,
+								 IH_PHASE_NONE);
+				if (noffset < 0) {
+					if (!confname)
+						goto fallback;
+					printf("Could not find script in %s\n", confname);
+					return 1;
+				}
+			} else {
+fallback:
+				if (!fit_uname || !*fit_uname)
+					fit_uname = get_default_image(fit_hdr);
+				if (!fit_uname) {
+					puts("No FIT subimage unit name\n");
+					return 1;
+				}
+
+				/* get script component image node offset */
+				noffset = fit_image_get_node(fit_hdr, fit_uname);
+				if (noffset < 0) {
+					printf("Can't find '%s' FIT subimage\n",
+					       fit_uname);
+					return 1;
+				}
+			}
+
+			if (!fit_image_check_type(fit_hdr, noffset,
+						  IH_TYPE_SCRIPT)) {
+				puts("Not a image image\n");
+				return 1;
+			}
+
+			/* verify integrity */
+			if (verify && !fit_image_verify(fit_hdr, noffset)) {
+				puts("Bad Data Hash\n");
+				return 1;
+			}
+
+			/* get script subimage data address and length */
+			if (fit_image_get_data(fit_hdr, noffset, &fit_data, &fit_len)) {
+				puts("Could not find script subimage data\n");
+				return 1;
+			}
+
+			data = (u32 *)fit_data;
+			len = (ulong)fit_len;
+		}
+		break;
+	default:
+		puts("Wrong image format for \"source\" command\n");
+		return -EPERM;
+	}
+
+	*datap = (char *)data;
+	*lenp = len;
+
+	return 0;
+}

cmd/source.c

@@ -24,184 +24,6 @@
 #include <asm/byteorder.h>
 #include <asm/io.h>
 
-/**
- * get_default_image() - Return default property from /images
- *
- * Return: Pointer to value of default property (or NULL)
- */
-static const char *get_default_image(const void *fit)
-{
-	int images_noffset;
-
-	images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
-	if (images_noffset < 0)
-		return NULL;
-
-	return fdt_getprop(fit, images_noffset, FIT_DEFAULT_PROP, NULL);
-}
-
-int image_locate_script(void *buf, int size, const char *fit_uname,
-			const char *confname, char **datap, uint *lenp)
-{
-	ulong		len;
-	const struct legacy_img_hdr *hdr;
-	u32		*data;
-	int		verify;
-	const void*	fit_hdr;
-	int		noffset;
-	const void	*fit_data;
-	size_t		fit_len;
-
-	verify = env_get_yesno("verify");
-
-	switch (genimg_get_format(buf)) {
-	case IMAGE_FORMAT_LEGACY:
-		if (IS_ENABLED(CONFIG_LEGACY_IMAGE_FORMAT)) {
-			hdr = buf;
-
-			if (!image_check_magic(hdr)) {
-				puts("Bad magic number\n");
-				return 1;
-			}
-
-			if (!image_check_hcrc(hdr)) {
-				puts("Bad header crc\n");
-				return 1;
-			}
-
-			if (verify) {
-				if (!image_check_dcrc(hdr)) {
-					puts("Bad data crc\n");
-					return 1;
-				}
-			}
-
-			if (!image_check_type(hdr, IH_TYPE_SCRIPT)) {
-				puts("Bad image type\n");
-				return 1;
-			}
-
-			/* get length of script */
-			data = (u32 *)image_get_data(hdr);
-
-			len = uimage_to_cpu(*data);
-			if (!len) {
-				puts("Empty Script\n");
-				return 1;
-			}
-
-			/*
-			 * scripts are just multi-image files with one
-			 * component, so seek past the zero-terminated sequence
-			 * of image lengths to get to the actual image data
-			 */
-			while (*data++);
-		}
-		break;
-	case IMAGE_FORMAT_FIT:
-		if (IS_ENABLED(CONFIG_FIT)) {
-			fit_hdr = buf;
-			if (fit_check_format(fit_hdr, IMAGE_SIZE_INVAL)) {
-				puts("Bad FIT image format\n");
-				return 1;
-			}
-
-			if (!fit_uname) {
-				/* If confname is empty, use the default */
-				if (confname && *confname)
-					noffset = fit_conf_get_node(fit_hdr, confname);
-				else
-					noffset = fit_conf_get_node(fit_hdr, NULL);
-				if (noffset < 0) {
-					if (!confname)
-						goto fallback;
-					printf("Could not find config %s\n", confname);
-					return 1;
-				}
-
-				if (verify && fit_config_verify(fit_hdr, noffset))
-					return 1;
-
-				noffset = fit_conf_get_prop_node(fit_hdr,
-								 noffset,
-								 FIT_SCRIPT_PROP,
-								 IH_PHASE_NONE);
-				if (noffset < 0) {
-					if (!confname)
-						goto fallback;
-					printf("Could not find script in %s\n", confname);
-					return 1;
-				}
-			} else {
-fallback:
-				if (!fit_uname || !*fit_uname)
-					fit_uname = get_default_image(fit_hdr);
-				if (!fit_uname) {
-					puts("No FIT subimage unit name\n");
-					return 1;
-				}
-
-				/* get script component image node offset */
-				noffset = fit_image_get_node(fit_hdr, fit_uname);
-				if (noffset < 0) {
-					printf("Can't find '%s' FIT subimage\n",
-					      fit_uname);
-					return 1;
-				}
-			}
-
-			if (!fit_image_check_type(fit_hdr, noffset,
-						  IH_TYPE_SCRIPT)) {
-				puts("Not a image image\n");
-				return 1;
-			}
-
-			/* verify integrity */
-			if (verify && !fit_image_verify(fit_hdr, noffset)) {
-				puts("Bad Data Hash\n");
-				return 1;
-			}
-
-			/* get script subimage data address and length */
-			if (fit_image_get_data(fit_hdr, noffset, &fit_data, &fit_len)) {
-				puts("Could not find script subimage data\n");
-				return 1;
-			}
-
-			data = (u32 *)fit_data;
-			len = (ulong)fit_len;
-		}
-		break;
-	default:
-		puts("Wrong image format for \"source\" command\n");
-		return -EPERM;
-	}
-
-	*datap = (char *)data;
-	*lenp = len;
-
-	return 0;
-}
-
-int image_source_script(ulong addr, const char *fit_uname, const char *confname)
-{
-	char *data;
-	void *buf;
-	uint len;
-	int ret;
-
-	buf = map_sysmem(addr, 0);
-	ret = image_locate_script(buf, 0, fit_uname, confname, &data, &len);
-	unmap_sysmem(buf);
-	if (ret)
-		return CMD_RET_FAILURE;
-
-	debug("** Script length: %d\n", len);
-	return run_command_list(data, len, 0);
-}
-
-/**************************************************/
-#if defined(CONFIG_CMD_SOURCE)
 static int do_source(struct cmd_tbl *cmdtp, int flag, int argc,
 		     char *const argv[])
 {
@@ -228,7 +50,7 @@ static int do_source(struct cmd_tbl *cmdtp, int flag, int argc,
 	}
 
 	printf ("## Executing script at %08lx\n", addr);
-	rcode = image_source_script(addr, fit_uname, confname);
+	rcode = cmd_source_script(addr, fit_uname, confname);
 	return rcode;
 }
 
@@ -250,4 +72,3 @@ U_BOOT_CMD(
 	source, 2, 0,	do_source,
 	"run script from memory", source_help_text
 );
-#endif

common/command.c

@@ -13,7 +13,9 @@
 #include <command.h>
 #include <console.h>
 #include <env.h>
+#include <image.h>
 #include <log.h>
+#include <mapmem.h>
 #include <asm/global_data.h>
 #include <linux/ctype.h>
 
@@ -654,3 +656,20 @@ int cmd_process_error(struct cmd_tbl *cmdtp, int err)
 
 	return CMD_RET_SUCCESS;
 }
+
+int cmd_source_script(ulong addr, const char *fit_uname, const char *confname)
+{
+	char *data;
+	void *buf;
+	uint len;
+	int ret;
+
+	buf = map_sysmem(addr, 0);
+	ret = image_locate_script(buf, 0, fit_uname, confname, &data, &len);
+	unmap_sysmem(buf);
+	if (ret)
+		return CMD_RET_FAILURE;
+
+	debug("** Script length: %d\n", len);
+	return run_command_list(data, len, 0);
+}

drivers/usb/gadget/f_sdp.c

@@ -868,7 +868,7 @@ static int sdp_handle_in_ep(struct spl_image_info *spl_image,
 			jump_to_image_no_args(&spl_image);
 #else
 			/* In U-Boot, allow jumps to scripts */
-			image_source_script(sdp_func->jmp_address, NULL, NULL);
+			cmd_source_script(sdp_func->jmp_address, NULL, NULL);
 #endif
 		}
 

include/command.h

@@ -279,6 +279,18 @@ int run_commandf(const char *fmt, ...);
  * Return: 0 on success, or != 0 on error.
  */
 int run_command_list(const char *cmd, int len, int flag);
+
+/**
+ * cmd_source_script() - Execute a script
+ *
+ * Executes a U-Boot script at a particular address in memory. The script should
+ * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
+ *
+ * @addr: Address of script
+ * @fit_uname: FIT subimage name
+ * Return: result code (enum command_ret_t)
+ */
+int cmd_source_script(ulong addr, const char *fit_uname, const char *confname);
 #endif	/* __ASSEMBLY__ */
 
 /*

include/image.h

@@ -709,26 +709,6 @@ int fit_image_load(struct bootm_headers *images, ulong addr,
 		   int arch, int image_ph_type, int bootstage_id,
 		   enum fit_load_op load_op, ulong *datap, ulong *lenp);
 
-/**
- * image_source_script() - Execute a script
- * @addr: Address of script
- * @fit_uname: FIT subimage name
- * @confname: FIT config name. The subimage is chosen based on FIT_SCRIPT_PROP.
- *
- * Executes a U-Boot script at a particular address in memory. The script should
- * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
- *
- * If @fit_uname is the empty string, then the default image is used. If
- * @confname is the empty string, the default config is used. If @confname and
- * @fit_uname are both non-%NULL, then @confname is ignored. If @confname and
- * @fit_uname are both %NULL, then first the default config is tried, and then
- * the default image.
- *
- * Return: result code (enum command_ret_t)
- */
-int image_source_script(ulong addr, const char *fit_uname,
-			const char *confname);
-
 /**
  * image_locate_script() - Locate the raw script in an image
  *