xref: /openbmc/u-boot/cmd/source.c (revision 1d2c0506)
1 /*
2  * (C) Copyright 2001
3  * Kyle Harris, kharris@nexus-tech.net
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 /*
9  * The "source" command allows to define "script images", i. e. files
10  * that contain command sequences that can be executed by the command
11  * interpreter. It returns the exit status of the last command
12  * executed from the script. This is very similar to running a shell
13  * script in a UNIX shell, hence the name for the command.
14  */
15 
16 /* #define DEBUG */
17 
18 #include <common.h>
19 #include <command.h>
20 #include <image.h>
21 #include <malloc.h>
22 #include <mapmem.h>
23 #include <asm/byteorder.h>
24 #include <asm/io.h>
25 #if defined(CONFIG_8xx)
26 #include <mpc8xx.h>
27 #endif
28 
29 int
30 source (ulong addr, const char *fit_uname)
31 {
32 	ulong		len;
33 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
34 	const image_header_t *hdr;
35 #endif
36 	u32		*data;
37 	int		verify;
38 	void *buf;
39 #if defined(CONFIG_FIT)
40 	const void*	fit_hdr;
41 	int		noffset;
42 	const void	*fit_data;
43 	size_t		fit_len;
44 #endif
45 
46 	verify = getenv_yesno ("verify");
47 
48 	buf = map_sysmem(addr, 0);
49 	switch (genimg_get_format(buf)) {
50 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
51 	case IMAGE_FORMAT_LEGACY:
52 		hdr = buf;
53 
54 		if (!image_check_magic (hdr)) {
55 			puts ("Bad magic number\n");
56 			return 1;
57 		}
58 
59 		if (!image_check_hcrc (hdr)) {
60 			puts ("Bad header crc\n");
61 			return 1;
62 		}
63 
64 		if (verify) {
65 			if (!image_check_dcrc (hdr)) {
66 				puts ("Bad data crc\n");
67 				return 1;
68 			}
69 		}
70 
71 		if (!image_check_type (hdr, IH_TYPE_SCRIPT)) {
72 			puts ("Bad image type\n");
73 			return 1;
74 		}
75 
76 		/* get length of script */
77 		data = (u32 *)image_get_data (hdr);
78 
79 		if ((len = uimage_to_cpu (*data)) == 0) {
80 			puts ("Empty Script\n");
81 			return 1;
82 		}
83 
84 		/*
85 		 * scripts are just multi-image files with one component, seek
86 		 * past the zero-terminated sequence of image lengths to get
87 		 * to the actual image data
88 		 */
89 		while (*data++);
90 		break;
91 #endif
92 #if defined(CONFIG_FIT)
93 	case IMAGE_FORMAT_FIT:
94 		if (fit_uname == NULL) {
95 			puts ("No FIT subimage unit name\n");
96 			return 1;
97 		}
98 
99 		fit_hdr = buf;
100 		if (!fit_check_format (fit_hdr)) {
101 			puts ("Bad FIT image format\n");
102 			return 1;
103 		}
104 
105 		/* get script component image node offset */
106 		noffset = fit_image_get_node (fit_hdr, fit_uname);
107 		if (noffset < 0) {
108 			printf ("Can't find '%s' FIT subimage\n", fit_uname);
109 			return 1;
110 		}
111 
112 		if (!fit_image_check_type (fit_hdr, noffset, IH_TYPE_SCRIPT)) {
113 			puts ("Not a image image\n");
114 			return 1;
115 		}
116 
117 		/* verify integrity */
118 		if (verify) {
119 			if (!fit_image_verify(fit_hdr, noffset)) {
120 				puts ("Bad Data Hash\n");
121 				return 1;
122 			}
123 		}
124 
125 		/* get script subimage data address and length */
126 		if (fit_image_get_data (fit_hdr, noffset, &fit_data, &fit_len)) {
127 			puts ("Could not find script subimage data\n");
128 			return 1;
129 		}
130 
131 		data = (u32 *)fit_data;
132 		len = (ulong)fit_len;
133 		break;
134 #endif
135 	default:
136 		puts ("Wrong image format for \"source\" command\n");
137 		return 1;
138 	}
139 
140 	debug ("** Script length: %ld\n", len);
141 	return run_command_list((char *)data, len, 0);
142 }
143 
144 /**************************************************/
145 #if defined(CONFIG_CMD_SOURCE)
146 static int do_source(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
147 {
148 	ulong addr;
149 	int rcode;
150 	const char *fit_uname = NULL;
151 
152 	/* Find script image */
153 	if (argc < 2) {
154 		addr = CONFIG_SYS_LOAD_ADDR;
155 		debug ("*  source: default load address = 0x%08lx\n", addr);
156 #if defined(CONFIG_FIT)
157 	} else if (fit_parse_subimage (argv[1], load_addr, &addr, &fit_uname)) {
158 		debug ("*  source: subimage '%s' from FIT image at 0x%08lx\n",
159 				fit_uname, addr);
160 #endif
161 	} else {
162 		addr = simple_strtoul(argv[1], NULL, 16);
163 		debug ("*  source: cmdline image address = 0x%08lx\n", addr);
164 	}
165 
166 	printf ("## Executing script at %08lx\n", addr);
167 	rcode = source (addr, fit_uname);
168 	return rcode;
169 }
170 
171 #ifdef CONFIG_SYS_LONGHELP
172 static char source_help_text[] =
173 	"[addr]\n"
174 	"\t- run script starting at addr\n"
175 	"\t- A valid image header must be present"
176 #if defined(CONFIG_FIT)
177 	"\n"
178 	"For FIT format uImage addr must include subimage\n"
179 	"unit name in the form of addr:<subimg_uname>"
180 #endif
181 	"";
182 #endif
183 
184 U_BOOT_CMD(
185 	source, 2, 0,	do_source,
186 	"run script from memory", source_help_text
187 );
188 #endif
189