blob: a50dd20b19aafcab44cbd15c9d357b40eaf05985 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenk48abe7b2004-06-09 10:15:00 +00002/*
3 * (C) Copyright 2000-2004
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 *
6 * (C) Copyright 2003
7 * Kai-Uwe Bloem, Auerswald GmbH & Co KG, <linux-development@auerswald.de>
wdenk48abe7b2004-06-09 10:15:00 +00008 */
9
wdenk48abe7b2004-06-09 10:15:00 +000010
11/*
12 * Multi Image extract
13 */
14#include <common.h>
15#include <command.h>
Simon Glass1eb69ae2019-11-14 12:57:39 -070016#include <cpu_func.h>
Simon Glassc7694dd2019-08-01 09:46:46 -060017#include <env.h>
Simon Glass0c670fc2019-08-01 09:46:36 -060018#include <gzip.h>
wdenk48abe7b2004-06-09 10:15:00 +000019#include <image.h>
Simon Glass336d4612020-02-03 07:36:16 -070020#include <malloc.h>
Joe Hershberger0eb25b62015-03-22 17:08:59 -050021#include <mapmem.h>
Wolfgang Wegner5912d362009-12-10 10:11:21 +010022#include <watchdog.h>
23#if defined(CONFIG_BZIP2)
24#include <bzlib.h>
25#endif
wdenk48abe7b2004-06-09 10:15:00 +000026#include <asm/byteorder.h>
Simon Glass90526e92020-05-10 11:39:56 -060027#include <asm/cache.h>
Simon Glass628af172013-08-30 11:00:09 -060028#include <asm/io.h>
wdenk48abe7b2004-06-09 10:15:00 +000029
Tom Rini6e7df1d2023-01-10 11:19:45 -050030#ifndef CFG_SYS_XIMG_LEN
Wolfgang Wegner5912d362009-12-10 10:11:21 +010031/* use 8MByte as default max gunzip size */
Tom Rini6e7df1d2023-01-10 11:19:45 -050032#define CFG_SYS_XIMG_LEN 0x800000
Wolfgang Wegner5912d362009-12-10 10:11:21 +010033#endif
34
Kim Phillips088f1b12012-10-29 13:34:31 +000035static int
Simon Glass09140112020-05-10 11:40:03 -060036do_imgextract(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
wdenk48abe7b2004-06-09 10:15:00 +000037{
Simon Glassbb872dd2019-12-28 10:45:02 -070038 ulong addr = image_load_addr;
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010039 ulong dest = 0;
Heiko Schocher21d29f72014-05-28 11:33:33 +020040 ulong data, len;
Bartlomiej Siekafbe7a152008-03-20 19:38:45 +010041 int verify;
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010042 int part = 0;
Tom Rinic76c93a2019-05-23 07:14:07 -040043#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Heiko Schocher21d29f72014-05-28 11:33:33 +020044 ulong count;
Simon Glassf3543e62022-09-06 20:26:52 -060045 struct legacy_img_hdr *hdr = NULL;
Heiko Schocher21d29f72014-05-28 11:33:33 +020046#endif
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010047#if defined(CONFIG_FIT)
Bartlomiej Siekafbe7a152008-03-20 19:38:45 +010048 const char *uname = NULL;
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010049 const void* fit_hdr;
50 int noffset;
51 const void *fit_data;
52 size_t fit_len;
53#endif
Simon Glassa92181b2013-04-17 16:13:45 +000054#ifdef CONFIG_GZIP
Tom Rini6e7df1d2023-01-10 11:19:45 -050055 uint unc_len = CFG_SYS_XIMG_LEN;
Simon Glassa92181b2013-04-17 16:13:45 +000056#endif
Wolfgang Wegner5912d362009-12-10 10:11:21 +010057 uint8_t comp;
wdenk48abe7b2004-06-09 10:15:00 +000058
Simon Glassbfebc8c2017-08-03 12:22:13 -060059 verify = env_get_yesno("verify");
wdenk48abe7b2004-06-09 10:15:00 +000060
61 if (argc > 1) {
Simon Glass7e5f4602021-07-24 09:03:29 -060062 addr = hextoul(argv[1], NULL);
wdenk48abe7b2004-06-09 10:15:00 +000063 }
64 if (argc > 2) {
Simon Glass7e5f4602021-07-24 09:03:29 -060065 part = hextoul(argv[2], NULL);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010066#if defined(CONFIG_FIT)
67 uname = argv[2];
68#endif
wdenk48abe7b2004-06-09 10:15:00 +000069 }
70 if (argc > 3) {
Simon Glass7e5f4602021-07-24 09:03:29 -060071 dest = hextoul(argv[3], NULL);
wdenk48abe7b2004-06-09 10:15:00 +000072 }
73
Stephen Warren712fbcf2011-10-18 11:11:49 +000074 switch (genimg_get_format((void *)addr)) {
Tom Rinic76c93a2019-05-23 07:14:07 -040075#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010076 case IMAGE_FORMAT_LEGACY:
wdenk48abe7b2004-06-09 10:15:00 +000077
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010078 printf("## Copying part %d from legacy image "
79 "at %08lx ...\n", part, addr);
80
Simon Glassf3543e62022-09-06 20:26:52 -060081 hdr = (struct legacy_img_hdr *)addr;
Stephen Warren712fbcf2011-10-18 11:11:49 +000082 if (!image_check_magic(hdr)) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010083 printf("Bad Magic Number\n");
wdenk48abe7b2004-06-09 10:15:00 +000084 return 1;
85 }
wdenk48abe7b2004-06-09 10:15:00 +000086
Stephen Warren712fbcf2011-10-18 11:11:49 +000087 if (!image_check_hcrc(hdr)) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010088 printf("Bad Header Checksum\n");
89 return 1;
90 }
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010091#ifdef DEBUG
Stephen Warren712fbcf2011-10-18 11:11:49 +000092 image_print_contents(hdr);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +010093#endif
wdenk48abe7b2004-06-09 10:15:00 +000094
Pierre Aubert83636fa2015-09-16 08:29:11 +020095 if (!image_check_type(hdr, IH_TYPE_MULTI) &&
96 !image_check_type(hdr, IH_TYPE_SCRIPT)) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010097 printf("Wrong Image Type for %s command\n",
98 cmdtp->name);
99 return 1;
100 }
101
Stephen Warren712fbcf2011-10-18 11:11:49 +0000102 comp = image_get_comp(hdr);
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100103 if ((comp != IH_COMP_NONE) && (argc < 4)) {
104 printf("Must specify load address for %s command "
105 "with compressed image\n",
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100106 cmdtp->name);
107 return 1;
108 }
109
110 if (verify) {
111 printf(" Verifying Checksum ... ");
Stephen Warren712fbcf2011-10-18 11:11:49 +0000112 if (!image_check_dcrc(hdr)) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100113 printf("Bad Data CRC\n");
114 return 1;
115 }
116 printf("OK\n");
117 }
118
Stephen Warren712fbcf2011-10-18 11:11:49 +0000119 count = image_multi_count(hdr);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100120 if (part >= count) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100121 printf("Bad Image Part\n");
122 return 1;
123 }
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100124
Stephen Warren712fbcf2011-10-18 11:11:49 +0000125 image_multi_getimg(hdr, part, &data, &len);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100126 break;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200127#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100128#if defined(CONFIG_FIT)
129 case IMAGE_FORMAT_FIT:
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100130 if (uname == NULL) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000131 puts("No FIT subimage unit name\n");
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100132 return 1;
133 }
134
135 printf("## Copying '%s' subimage from FIT image "
136 "at %08lx ...\n", uname, addr);
137
138 fit_hdr = (const void *)addr;
Simon Glassc5819702021-02-15 17:08:09 -0700139 if (fit_check_format(fit_hdr, IMAGE_SIZE_INVAL)) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000140 puts("Bad FIT image format\n");
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100141 return 1;
142 }
143
144 /* get subimage node offset */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000145 noffset = fit_image_get_node(fit_hdr, uname);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100146 if (noffset < 0) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000147 printf("Can't find '%s' FIT subimage\n", uname);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100148 return 1;
149 }
150
Stefan Theil240e58e2019-01-07 10:25:52 +0100151 if (!fit_image_check_comp(fit_hdr, noffset, IH_COMP_NONE)
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100152 && (argc < 4)) {
153 printf("Must specify load address for %s command "
154 "with compressed image\n",
155 cmdtp->name);
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100156 return 1;
157 }
158
159 /* verify integrity */
160 if (verify) {
Simon Glassb8da8362013-05-07 06:11:57 +0000161 if (!fit_image_verify(fit_hdr, noffset)) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000162 puts("Bad Data Hash\n");
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100163 return 1;
164 }
165 }
166
Tien Fong Chee3695ea52019-02-12 20:49:30 +0800167 /* get subimage/external data address and length */
168 if (fit_image_get_data_and_size(fit_hdr, noffset,
169 &fit_data, &fit_len)) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000170 puts("Could not find script subimage data\n");
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100171 return 1;
172 }
173
Daniel Golle88de6c52022-08-27 04:17:28 +0100174 if (fit_image_get_comp(fit_hdr, noffset, &comp))
175 comp = IH_COMP_NONE;
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100176
Bartlomiej Siekafbe7a152008-03-20 19:38:45 +0100177 data = (ulong)fit_data;
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100178 len = (ulong)fit_len;
179 break;
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100180#endif
181 default:
Stephen Warren712fbcf2011-10-18 11:11:49 +0000182 puts("Invalid image type for imxtract\n");
wdenk48abe7b2004-06-09 10:15:00 +0000183 return 1;
184 }
wdenk48abe7b2004-06-09 10:15:00 +0000185
186 if (argc > 3) {
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100187 switch (comp) {
188 case IH_COMP_NONE:
189#if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
190 {
191 size_t l = len;
192 size_t tail;
193 void *to = (void *) dest;
194 void *from = (void *)data;
195
Stephen Warren712fbcf2011-10-18 11:11:49 +0000196 printf(" Loading part %d ... ", part);
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100197
198 while (l > 0) {
199 tail = (l > CHUNKSZ) ? CHUNKSZ : l;
Stefan Roese29caf932022-09-02 14:10:46 +0200200 schedule();
Stephen Warren712fbcf2011-10-18 11:11:49 +0000201 memmove(to, from, tail);
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100202 to += tail;
203 from += tail;
204 l -= tail;
205 }
206 }
207#else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
Stephen Warren712fbcf2011-10-18 11:11:49 +0000208 printf(" Loading part %d ... ", part);
209 memmove((char *) dest, (char *)data, len);
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100210#endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
211 break;
Matthew McClintock0e0996e2011-05-24 05:48:26 +0000212#ifdef CONFIG_GZIP
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100213 case IH_COMP_GZIP:
Stephen Warren712fbcf2011-10-18 11:11:49 +0000214 printf(" Uncompressing part %d ... ", part);
215 if (gunzip((void *) dest, unc_len,
216 (uchar *) data, &len) != 0) {
217 puts("GUNZIP ERROR - image not loaded\n");
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100218 return 1;
219 }
220 break;
Matthew McClintock0e0996e2011-05-24 05:48:26 +0000221#endif
Tom Rinic76c93a2019-05-23 07:14:07 -0400222#if defined(CONFIG_BZIP2) && defined(CONFIG_LEGACY_IMAGE_FORMAT)
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100223 case IH_COMP_BZIP2:
Wolfgang Denk5f566f42010-01-31 21:51:43 +0100224 {
225 int i;
226
Stephen Warren712fbcf2011-10-18 11:11:49 +0000227 printf(" Uncompressing part %d ... ", part);
Wolfgang Denk5f566f42010-01-31 21:51:43 +0100228 /*
Wolfgang Denk93910ed2010-03-12 23:06:04 +0100229 * If we've got less than 4 MB of malloc()
Wolfgang Denk5f566f42010-01-31 21:51:43 +0100230 * space, use slower decompression algorithm
231 * which requires at most 2300 KB of memory.
232 */
233 i = BZ2_bzBuffToBuffDecompress(
Simon Glass628af172013-08-30 11:00:09 -0600234 map_sysmem(ntohl(hdr->ih_load), 0),
Wolfgang Denk5f566f42010-01-31 21:51:43 +0100235 &unc_len, (char *)data, len,
236 CONFIG_SYS_MALLOC_LEN < (4096 * 1024),
237 0);
238 if (i != BZ_OK) {
Stephen Warren712fbcf2011-10-18 11:11:49 +0000239 printf("BUNZIP2 ERROR %d - "
Wolfgang Denk5f566f42010-01-31 21:51:43 +0100240 "image not loaded\n", i);
241 return 1;
242 }
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100243 }
244 break;
245#endif /* CONFIG_BZIP2 */
246 default:
Stephen Warren712fbcf2011-10-18 11:11:49 +0000247 printf("Unimplemented compression type %d\n", comp);
Wolfgang Wegner5912d362009-12-10 10:11:21 +0100248 return 1;
249 }
Stephen Warren712fbcf2011-10-18 11:11:49 +0000250 puts("OK\n");
wdenk48abe7b2004-06-09 10:15:00 +0000251 }
252
Mario Six8354aa22018-03-28 14:39:10 +0200253 flush_cache(dest, ALIGN(len, ARCH_DMA_MINALIGN));
Pieter Voorthuijsenc72b65c2015-01-12 16:23:18 +0100254
Simon Glass018f5302017-08-03 12:22:10 -0600255 env_set_hex("fileaddr", data);
256 env_set_hex("filesize", len);
wdenk48abe7b2004-06-09 10:15:00 +0000257
258 return 0;
259}
260
Tom Rini36162182023-10-07 15:13:08 -0400261U_BOOT_LONGHELP(imgextract,
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200262 "addr part [dest]\n"
263 " - extract <part> from legacy image at <addr> and copy to <dest>"
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100264#if defined(CONFIG_FIT)
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200265 "\n"
266 "addr uname [dest]\n"
267 " - extract <uname> subimage from FIT image at <addr> and copy to <dest>"
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100268#endif
Tom Rini36162182023-10-07 15:13:08 -0400269 );
Kim Phillips088f1b12012-10-29 13:34:31 +0000270
271U_BOOT_CMD(
272 imxtract, 4, 1, do_imgextract,
273 "extract a part of a multi-image", imgextract_help_text
Marian Balakowicz1b7897f2008-03-12 10:33:00 +0100274);