xref: /OK3568_Linux_fs/u-boot/cmd/ximg.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * (C) Copyright 2000-2004
3*4882a593Smuzhiyun  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * (C) Copyright 2003
6*4882a593Smuzhiyun  * Kai-Uwe Bloem, Auerswald GmbH & Co KG, <linux-development@auerswald.de>
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /*
13*4882a593Smuzhiyun  * Multi Image extract
14*4882a593Smuzhiyun  */
15*4882a593Smuzhiyun #include <common.h>
16*4882a593Smuzhiyun #include <command.h>
17*4882a593Smuzhiyun #include <image.h>
18*4882a593Smuzhiyun #include <mapmem.h>
19*4882a593Smuzhiyun #include <watchdog.h>
20*4882a593Smuzhiyun #if defined(CONFIG_BZIP2)
21*4882a593Smuzhiyun #include <bzlib.h>
22*4882a593Smuzhiyun #endif
23*4882a593Smuzhiyun #include <asm/byteorder.h>
24*4882a593Smuzhiyun #include <asm/io.h>
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun #ifndef CONFIG_SYS_XIMG_LEN
27*4882a593Smuzhiyun /* use 8MByte as default max gunzip size */
28*4882a593Smuzhiyun #define CONFIG_SYS_XIMG_LEN	0x800000
29*4882a593Smuzhiyun #endif
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun static int
do_imgextract(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])32*4882a593Smuzhiyun do_imgextract(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
33*4882a593Smuzhiyun {
34*4882a593Smuzhiyun 	ulong		addr = load_addr;
35*4882a593Smuzhiyun 	ulong		dest = 0;
36*4882a593Smuzhiyun 	ulong		data, len;
37*4882a593Smuzhiyun 	int		verify;
38*4882a593Smuzhiyun 	int		part = 0;
39*4882a593Smuzhiyun #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
40*4882a593Smuzhiyun 	ulong		count;
41*4882a593Smuzhiyun 	image_header_t	*hdr = NULL;
42*4882a593Smuzhiyun #endif
43*4882a593Smuzhiyun #if defined(CONFIG_FIT)
44*4882a593Smuzhiyun 	const char	*uname = NULL;
45*4882a593Smuzhiyun 	const void*	fit_hdr;
46*4882a593Smuzhiyun 	int		noffset;
47*4882a593Smuzhiyun 	const void	*fit_data;
48*4882a593Smuzhiyun 	size_t		fit_len;
49*4882a593Smuzhiyun #endif
50*4882a593Smuzhiyun #ifdef CONFIG_GZIP
51*4882a593Smuzhiyun 	uint		unc_len = CONFIG_SYS_XIMG_LEN;
52*4882a593Smuzhiyun #endif
53*4882a593Smuzhiyun 	uint8_t		comp;
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	verify = env_get_yesno("verify");
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	if (argc > 1) {
58*4882a593Smuzhiyun 		addr = simple_strtoul(argv[1], NULL, 16);
59*4882a593Smuzhiyun 	}
60*4882a593Smuzhiyun 	if (argc > 2) {
61*4882a593Smuzhiyun 		part = simple_strtoul(argv[2], NULL, 16);
62*4882a593Smuzhiyun #if defined(CONFIG_FIT)
63*4882a593Smuzhiyun 		uname = argv[2];
64*4882a593Smuzhiyun #endif
65*4882a593Smuzhiyun 	}
66*4882a593Smuzhiyun 	if (argc > 3) {
67*4882a593Smuzhiyun 		dest = simple_strtoul(argv[3], NULL, 16);
68*4882a593Smuzhiyun 	}
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	switch (genimg_get_format((void *)addr)) {
71*4882a593Smuzhiyun #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
72*4882a593Smuzhiyun 	case IMAGE_FORMAT_LEGACY:
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 		printf("## Copying part %d from legacy image "
75*4882a593Smuzhiyun 			"at %08lx ...\n", part, addr);
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun 		hdr = (image_header_t *)addr;
78*4882a593Smuzhiyun 		if (!image_check_magic(hdr)) {
79*4882a593Smuzhiyun 			printf("Bad Magic Number\n");
80*4882a593Smuzhiyun 			return 1;
81*4882a593Smuzhiyun 		}
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 		if (!image_check_hcrc(hdr)) {
84*4882a593Smuzhiyun 			printf("Bad Header Checksum\n");
85*4882a593Smuzhiyun 			return 1;
86*4882a593Smuzhiyun 		}
87*4882a593Smuzhiyun #ifdef DEBUG
88*4882a593Smuzhiyun 		image_print_contents(hdr);
89*4882a593Smuzhiyun #endif
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 		if (!image_check_type(hdr, IH_TYPE_MULTI) &&
92*4882a593Smuzhiyun 		    !image_check_type(hdr, IH_TYPE_SCRIPT)) {
93*4882a593Smuzhiyun 			printf("Wrong Image Type for %s command\n",
94*4882a593Smuzhiyun 					cmdtp->name);
95*4882a593Smuzhiyun 			return 1;
96*4882a593Smuzhiyun 		}
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 		comp = image_get_comp(hdr);
99*4882a593Smuzhiyun 		if ((comp != IH_COMP_NONE) && (argc < 4)) {
100*4882a593Smuzhiyun 			printf("Must specify load address for %s command "
101*4882a593Smuzhiyun 					"with compressed image\n",
102*4882a593Smuzhiyun 					cmdtp->name);
103*4882a593Smuzhiyun 			return 1;
104*4882a593Smuzhiyun 		}
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 		if (verify) {
107*4882a593Smuzhiyun 			printf("   Verifying Checksum ... ");
108*4882a593Smuzhiyun 			if (!image_check_dcrc(hdr)) {
109*4882a593Smuzhiyun 				printf("Bad Data CRC\n");
110*4882a593Smuzhiyun 				return 1;
111*4882a593Smuzhiyun 			}
112*4882a593Smuzhiyun 			printf("OK\n");
113*4882a593Smuzhiyun 		}
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 		count = image_multi_count(hdr);
116*4882a593Smuzhiyun 		if (part >= count) {
117*4882a593Smuzhiyun 			printf("Bad Image Part\n");
118*4882a593Smuzhiyun 			return 1;
119*4882a593Smuzhiyun 		}
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 		image_multi_getimg(hdr, part, &data, &len);
122*4882a593Smuzhiyun 		break;
123*4882a593Smuzhiyun #endif
124*4882a593Smuzhiyun #if defined(CONFIG_FIT)
125*4882a593Smuzhiyun 	case IMAGE_FORMAT_FIT:
126*4882a593Smuzhiyun 		if (uname == NULL) {
127*4882a593Smuzhiyun 			puts("No FIT subimage unit name\n");
128*4882a593Smuzhiyun 			return 1;
129*4882a593Smuzhiyun 		}
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun 		printf("## Copying '%s' subimage from FIT image "
132*4882a593Smuzhiyun 			"at %08lx ...\n", uname, addr);
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 		fit_hdr = (const void *)addr;
135*4882a593Smuzhiyun 		if (!fit_check_format(fit_hdr)) {
136*4882a593Smuzhiyun 			puts("Bad FIT image format\n");
137*4882a593Smuzhiyun 			return 1;
138*4882a593Smuzhiyun 		}
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 		/* get subimage node offset */
141*4882a593Smuzhiyun 		noffset = fit_image_get_node(fit_hdr, uname);
142*4882a593Smuzhiyun 		if (noffset < 0) {
143*4882a593Smuzhiyun 			printf("Can't find '%s' FIT subimage\n", uname);
144*4882a593Smuzhiyun 			return 1;
145*4882a593Smuzhiyun 		}
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 		if (fit_image_check_comp(fit_hdr, noffset, IH_COMP_NONE)
148*4882a593Smuzhiyun 		    && (argc < 4)) {
149*4882a593Smuzhiyun 			printf("Must specify load address for %s command "
150*4882a593Smuzhiyun 				"with compressed image\n",
151*4882a593Smuzhiyun 				cmdtp->name);
152*4882a593Smuzhiyun 			return 1;
153*4882a593Smuzhiyun 		}
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 		/* verify integrity */
156*4882a593Smuzhiyun 		if (verify) {
157*4882a593Smuzhiyun 			if (!fit_image_verify(fit_hdr, noffset)) {
158*4882a593Smuzhiyun 				puts("Bad Data Hash\n");
159*4882a593Smuzhiyun 				return 1;
160*4882a593Smuzhiyun 			}
161*4882a593Smuzhiyun 		}
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun 		/* get subimage data address and length */
164*4882a593Smuzhiyun 		if (fit_image_get_data(fit_hdr, noffset,
165*4882a593Smuzhiyun 					&fit_data, &fit_len)) {
166*4882a593Smuzhiyun 			puts("Could not find script subimage data\n");
167*4882a593Smuzhiyun 			return 1;
168*4882a593Smuzhiyun 		}
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 		if (fit_image_get_comp(fit_hdr, noffset, &comp)) {
171*4882a593Smuzhiyun 			puts("Could not find script subimage "
172*4882a593Smuzhiyun 				"compression type\n");
173*4882a593Smuzhiyun 			return 1;
174*4882a593Smuzhiyun 		}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 		data = (ulong)fit_data;
177*4882a593Smuzhiyun 		len = (ulong)fit_len;
178*4882a593Smuzhiyun 		break;
179*4882a593Smuzhiyun #endif
180*4882a593Smuzhiyun 	default:
181*4882a593Smuzhiyun 		puts("Invalid image type for imxtract\n");
182*4882a593Smuzhiyun 		return 1;
183*4882a593Smuzhiyun 	}
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	if (argc > 3) {
186*4882a593Smuzhiyun 		switch (comp) {
187*4882a593Smuzhiyun 		case IH_COMP_NONE:
188*4882a593Smuzhiyun #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
189*4882a593Smuzhiyun 			{
190*4882a593Smuzhiyun 				size_t l = len;
191*4882a593Smuzhiyun 				size_t tail;
192*4882a593Smuzhiyun 				void *to = (void *) dest;
193*4882a593Smuzhiyun 				void *from = (void *)data;
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun 				printf("   Loading part %d ... ", part);
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 				while (l > 0) {
198*4882a593Smuzhiyun 					tail = (l > CHUNKSZ) ? CHUNKSZ : l;
199*4882a593Smuzhiyun 					WATCHDOG_RESET();
200*4882a593Smuzhiyun 					memmove(to, from, tail);
201*4882a593Smuzhiyun 					to += tail;
202*4882a593Smuzhiyun 					from += tail;
203*4882a593Smuzhiyun 					l -= tail;
204*4882a593Smuzhiyun 				}
205*4882a593Smuzhiyun 			}
206*4882a593Smuzhiyun #else	/* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
207*4882a593Smuzhiyun 			printf("   Loading part %d ... ", part);
208*4882a593Smuzhiyun 			memmove((char *) dest, (char *)data, len);
209*4882a593Smuzhiyun #endif	/* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
210*4882a593Smuzhiyun 			break;
211*4882a593Smuzhiyun #ifdef CONFIG_GZIP
212*4882a593Smuzhiyun 		case IH_COMP_GZIP:
213*4882a593Smuzhiyun 			printf("   Uncompressing part %d ... ", part);
214*4882a593Smuzhiyun 			if (gunzip((void *) dest, unc_len,
215*4882a593Smuzhiyun 				   (uchar *) data, &len) != 0) {
216*4882a593Smuzhiyun 				puts("GUNZIP ERROR - image not loaded\n");
217*4882a593Smuzhiyun 				return 1;
218*4882a593Smuzhiyun 			}
219*4882a593Smuzhiyun 			break;
220*4882a593Smuzhiyun #endif
221*4882a593Smuzhiyun #if defined(CONFIG_BZIP2) && defined(CONFIG_IMAGE_FORMAT_LEGACY)
222*4882a593Smuzhiyun 		case IH_COMP_BZIP2:
223*4882a593Smuzhiyun 			{
224*4882a593Smuzhiyun 				int i;
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun 				printf("   Uncompressing part %d ... ", part);
227*4882a593Smuzhiyun 				/*
228*4882a593Smuzhiyun 				 * If we've got less than 4 MB of malloc()
229*4882a593Smuzhiyun 				 * space, use slower decompression algorithm
230*4882a593Smuzhiyun 				 * which requires at most 2300 KB of memory.
231*4882a593Smuzhiyun 				 */
232*4882a593Smuzhiyun 				i = BZ2_bzBuffToBuffDecompress(
233*4882a593Smuzhiyun 					map_sysmem(ntohl(hdr->ih_load), 0),
234*4882a593Smuzhiyun 					&unc_len, (char *)data, len,
235*4882a593Smuzhiyun 					CONFIG_SYS_MALLOC_LEN < (4096 * 1024),
236*4882a593Smuzhiyun 					0);
237*4882a593Smuzhiyun 				if (i != BZ_OK) {
238*4882a593Smuzhiyun 					printf("BUNZIP2 ERROR %d - "
239*4882a593Smuzhiyun 						"image not loaded\n", i);
240*4882a593Smuzhiyun 					return 1;
241*4882a593Smuzhiyun 				}
242*4882a593Smuzhiyun 			}
243*4882a593Smuzhiyun 			break;
244*4882a593Smuzhiyun #endif /* CONFIG_BZIP2 */
245*4882a593Smuzhiyun 		default:
246*4882a593Smuzhiyun 			printf("Unimplemented compression type %d\n", comp);
247*4882a593Smuzhiyun 			return 1;
248*4882a593Smuzhiyun 		}
249*4882a593Smuzhiyun 		puts("OK\n");
250*4882a593Smuzhiyun 	}
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun 	flush_cache(dest, len);
253*4882a593Smuzhiyun 
254*4882a593Smuzhiyun 	env_set_hex("fileaddr", data);
255*4882a593Smuzhiyun 	env_set_hex("filesize", len);
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 	return 0;
258*4882a593Smuzhiyun }
259*4882a593Smuzhiyun 
260*4882a593Smuzhiyun #ifdef CONFIG_SYS_LONGHELP
261*4882a593Smuzhiyun static char imgextract_help_text[] =
262*4882a593Smuzhiyun 	"addr part [dest]\n"
263*4882a593Smuzhiyun 	"    - extract <part> from legacy image at <addr> and copy to <dest>"
264*4882a593Smuzhiyun #if defined(CONFIG_FIT)
265*4882a593Smuzhiyun 	"\n"
266*4882a593Smuzhiyun 	"addr uname [dest]\n"
267*4882a593Smuzhiyun 	"    - extract <uname> subimage from FIT image at <addr> and copy to <dest>"
268*4882a593Smuzhiyun #endif
269*4882a593Smuzhiyun 	"";
270*4882a593Smuzhiyun #endif
271*4882a593Smuzhiyun 
272*4882a593Smuzhiyun U_BOOT_CMD(
273*4882a593Smuzhiyun 	imxtract, 4, 1, do_imgextract,
274*4882a593Smuzhiyun 	"extract a part of a multi-image", imgextract_help_text
275*4882a593Smuzhiyun );
276