blob: bea516025fde2f2c1734047fb69b5f3baa681939 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glassb6396402014-06-12 07:24:46 -06002/*
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Simon Glassb6396402014-06-12 07:24:46 -06005 */
6
Simon Glassea51a622014-06-12 07:24:51 -06007#ifndef USE_HOSTCC
Simon Glassb6396402014-06-12 07:24:46 -06008#include <common.h>
Simon Glassea51a622014-06-12 07:24:51 -06009#include <bootstage.h>
Simon Glassb6396402014-06-12 07:24:46 -060010#include <bzlib.h>
Simon Glass90268b82014-10-19 21:11:24 -060011#include <errno.h>
Simon Glassb6396402014-06-12 07:24:46 -060012#include <fdt_support.h>
13#include <lmb.h>
14#include <malloc.h>
Joe Hershberger0eb25b62015-03-22 17:08:59 -050015#include <mapmem.h>
Simon Glassb6396402014-06-12 07:24:46 -060016#include <asm/io.h>
17#include <linux/lzo.h>
18#include <lzma/LzmaTypes.h>
19#include <lzma/LzmaDec.h>
20#include <lzma/LzmaTools.h>
Simon Glassb6396402014-06-12 07:24:46 -060021#if defined(CONFIG_CMD_USB)
22#include <usb.h>
23#endif
Simon Glassea51a622014-06-12 07:24:51 -060024#else
25#include "mkimage.h"
26#endif
Simon Glassb6396402014-06-12 07:24:46 -060027
Simon Glassea51a622014-06-12 07:24:51 -060028#include <command.h>
29#include <bootm.h>
30#include <image.h>
Simon Glassb6396402014-06-12 07:24:46 -060031
32#ifndef CONFIG_SYS_BOOTM_LEN
33/* use 8MByte as default max gunzip size */
34#define CONFIG_SYS_BOOTM_LEN 0x800000
35#endif
36
37#define IH_INITRD_ARCH IH_ARCH_DEFAULT
38
Simon Glassea51a622014-06-12 07:24:51 -060039#ifndef USE_HOSTCC
40
41DECLARE_GLOBAL_DATA_PTR;
42
Tom Rini5db28902016-08-12 08:31:15 -040043bootm_headers_t images; /* pointers to os/initrd/fdt images */
44
Simon Glassb6396402014-06-12 07:24:46 -060045static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
46 char * const argv[], bootm_headers_t *images,
47 ulong *os_data, ulong *os_len);
48
Simon Glass329da482018-05-16 09:42:25 -060049__weak void board_quiesce_devices(void)
50{
51}
52
Simon Glassb6396402014-06-12 07:24:46 -060053#ifdef CONFIG_LMB
54static void boot_start_lmb(bootm_headers_t *images)
55{
56 ulong mem_start;
57 phys_size_t mem_size;
58
Simon Glass723806c2017-08-03 12:22:15 -060059 mem_start = env_get_bootm_low();
60 mem_size = env_get_bootm_size();
Simon Glassb6396402014-06-12 07:24:46 -060061
Simon Goldschmidt9cc23232019-01-26 22:13:04 +010062 lmb_init_and_reserve_range(&images->lmb, (phys_addr_t)mem_start,
63 mem_size, NULL);
Simon Glassb6396402014-06-12 07:24:46 -060064}
65#else
66#define lmb_reserve(lmb, base, size)
67static inline void boot_start_lmb(bootm_headers_t *images) { }
68#endif
69
70static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc,
71 char * const argv[])
72{
73 memset((void *)&images, 0, sizeof(images));
Simon Glassbfebc8c2017-08-03 12:22:13 -060074 images.verify = env_get_yesno("verify");
Simon Glassb6396402014-06-12 07:24:46 -060075
76 boot_start_lmb(&images);
77
78 bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
79 images.state = BOOTM_STATE_START;
80
81 return 0;
82}
83
84static int bootm_find_os(cmd_tbl_t *cmdtp, int flag, int argc,
85 char * const argv[])
86{
87 const void *os_hdr;
88 bool ep_found = false;
Simon Glass90268b82014-10-19 21:11:24 -060089 int ret;
Simon Glassb6396402014-06-12 07:24:46 -060090
91 /* get kernel image header, start address and length */
92 os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
93 &images, &images.os.image_start, &images.os.image_len);
94 if (images.os.image_len == 0) {
95 puts("ERROR: can't get kernel image!\n");
96 return 1;
97 }
98
99 /* get image parameters */
100 switch (genimg_get_format(os_hdr)) {
Tom Rinic76c93a2019-05-23 07:14:07 -0400101#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
Simon Glassb6396402014-06-12 07:24:46 -0600102 case IMAGE_FORMAT_LEGACY:
103 images.os.type = image_get_type(os_hdr);
104 images.os.comp = image_get_comp(os_hdr);
105 images.os.os = image_get_os(os_hdr);
106
107 images.os.end = image_get_image_end(os_hdr);
108 images.os.load = image_get_load(os_hdr);
Simon Glass90268b82014-10-19 21:11:24 -0600109 images.os.arch = image_get_arch(os_hdr);
Simon Glassb6396402014-06-12 07:24:46 -0600110 break;
111#endif
Simon Glass73223f02016-02-22 22:55:43 -0700112#if IMAGE_ENABLE_FIT
Simon Glassb6396402014-06-12 07:24:46 -0600113 case IMAGE_FORMAT_FIT:
114 if (fit_image_get_type(images.fit_hdr_os,
115 images.fit_noffset_os,
116 &images.os.type)) {
117 puts("Can't get image type!\n");
118 bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
119 return 1;
120 }
121
122 if (fit_image_get_comp(images.fit_hdr_os,
123 images.fit_noffset_os,
124 &images.os.comp)) {
125 puts("Can't get image compression!\n");
126 bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
127 return 1;
128 }
129
130 if (fit_image_get_os(images.fit_hdr_os, images.fit_noffset_os,
131 &images.os.os)) {
132 puts("Can't get image OS!\n");
133 bootstage_error(BOOTSTAGE_ID_FIT_OS);
134 return 1;
135 }
136
Simon Glass90268b82014-10-19 21:11:24 -0600137 if (fit_image_get_arch(images.fit_hdr_os,
138 images.fit_noffset_os,
139 &images.os.arch)) {
140 puts("Can't get image ARCH!\n");
141 return 1;
142 }
143
Simon Glassb6396402014-06-12 07:24:46 -0600144 images.os.end = fit_get_end(images.fit_hdr_os);
145
146 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
147 &images.os.load)) {
148 puts("Can't get image load address!\n");
149 bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
150 return 1;
151 }
152 break;
153#endif
154#ifdef CONFIG_ANDROID_BOOT_IMAGE
155 case IMAGE_FORMAT_ANDROID:
156 images.os.type = IH_TYPE_KERNEL;
Eugeniu Rosca829ceb22019-04-08 17:35:27 +0200157 images.os.comp = android_image_get_kcomp(os_hdr);
Simon Glassb6396402014-06-12 07:24:46 -0600158 images.os.os = IH_OS_LINUX;
Simon Glassb6396402014-06-12 07:24:46 -0600159
160 images.os.end = android_image_get_end(os_hdr);
161 images.os.load = android_image_get_kload(os_hdr);
Ahmad Draidi86f46952014-10-23 20:50:07 +0300162 images.ep = images.os.load;
163 ep_found = true;
Simon Glassb6396402014-06-12 07:24:46 -0600164 break;
165#endif
166 default:
167 puts("ERROR: unknown image format type!\n");
168 return 1;
169 }
170
Simon Glass90268b82014-10-19 21:11:24 -0600171 /* If we have a valid setup.bin, we will use that for entry (x86) */
Simon Glass5bda35c2014-10-10 08:21:57 -0600172 if (images.os.arch == IH_ARCH_I386 ||
173 images.os.arch == IH_ARCH_X86_64) {
Simon Glass90268b82014-10-19 21:11:24 -0600174 ulong len;
175
176 ret = boot_get_setup(&images, IH_ARCH_I386, &images.ep, &len);
177 if (ret < 0 && ret != -ENOENT) {
178 puts("Could not find a valid setup.bin for x86\n");
179 return 1;
180 }
181 /* Kernel entry point is the setup.bin */
182 } else if (images.legacy_hdr_valid) {
Simon Glassb6396402014-06-12 07:24:46 -0600183 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
Simon Glass73223f02016-02-22 22:55:43 -0700184#if IMAGE_ENABLE_FIT
Simon Glassb6396402014-06-12 07:24:46 -0600185 } else if (images.fit_uname_os) {
186 int ret;
187
188 ret = fit_image_get_entry(images.fit_hdr_os,
189 images.fit_noffset_os, &images.ep);
190 if (ret) {
191 puts("Can't get entry point property!\n");
192 return 1;
193 }
194#endif
195 } else if (!ep_found) {
196 puts("Could not find kernel entry point!\n");
197 return 1;
198 }
199
200 if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
Marek Vasut487b5fa2018-06-13 06:13:33 +0200201 if (CONFIG_IS_ENABLED(CMD_BOOTI) &&
202 images.os.arch == IH_ARCH_ARM64) {
203 ulong image_addr;
204 ulong image_size;
205
206 ret = booti_setup(images.os.image_start, &image_addr,
207 &image_size, true);
208 if (ret != 0)
209 return 1;
210
211 images.os.type = IH_TYPE_KERNEL;
212 images.os.load = image_addr;
213 images.ep = image_addr;
214 } else {
215 images.os.load = images.os.image_start;
216 images.ep += images.os.image_start;
217 }
Simon Glassb6396402014-06-12 07:24:46 -0600218 }
219
Simon Glass7a80de42016-02-24 09:14:42 -0700220 images.os.start = map_to_sysmem(os_hdr);
Simon Glassb6396402014-06-12 07:24:46 -0600221
222 return 0;
223}
224
Karl Apsited52e8572015-05-21 09:52:49 -0400225/**
226 * bootm_find_images - wrapper to find and locate various images
227 * @flag: Ignored Argument
228 * @argc: command argument count
229 * @argv: command argument list
230 *
231 * boot_find_images() will attempt to load an available ramdisk,
232 * flattened device tree, as well as specifically marked
233 * "loadable" images (loadables are FIT only)
234 *
235 * Note: bootm_find_images will skip an image if it is not found
236 *
237 * @return:
238 * 0, if all existing images were loaded correctly
239 * 1, if an image is found but corrupted, or invalid
240 */
241int bootm_find_images(int flag, int argc, char * const argv[])
Simon Glassb6396402014-06-12 07:24:46 -0600242{
243 int ret;
244
245 /* find ramdisk */
246 ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
247 &images.rd_start, &images.rd_end);
248 if (ret) {
249 puts("Ramdisk image is corrupt or invalid\n");
250 return 1;
251 }
252
Simon Glassaa34fbc2016-02-22 22:55:45 -0700253#if IMAGE_ENABLE_OF_LIBFDT
Simon Glassb6396402014-06-12 07:24:46 -0600254 /* find flattened device tree */
255 ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
256 &images.ft_addr, &images.ft_len);
257 if (ret) {
258 puts("Could not find a valid device tree\n");
259 return 1;
260 }
Simon Goldschmidt596be5f2018-12-17 20:14:42 +0100261 if (CONFIG_IS_ENABLED(CMD_FDT))
262 set_working_fdt_addr(map_to_sysmem(images.ft_addr));
Simon Glassb6396402014-06-12 07:24:46 -0600263#endif
264
Simon Glass73223f02016-02-22 22:55:43 -0700265#if IMAGE_ENABLE_FIT
Goldschmidt Simon8b93a922017-11-10 14:17:41 +0000266#if defined(CONFIG_FPGA)
Michal Simek62afc602016-05-17 14:03:50 +0200267 /* find bitstreams */
268 ret = boot_get_fpga(argc, argv, &images, IH_ARCH_DEFAULT,
269 NULL, NULL);
270 if (ret) {
271 printf("FPGA image is corrupted or invalid\n");
272 return 1;
273 }
274#endif
275
Karl Apsite84a07db2015-05-21 09:52:48 -0400276 /* find all of the loadables */
277 ret = boot_get_loadable(argc, argv, &images, IH_ARCH_DEFAULT,
278 NULL, NULL);
279 if (ret) {
280 printf("Loadable(s) is corrupt or invalid\n");
281 return 1;
282 }
Karl Apsite84a07db2015-05-21 09:52:48 -0400283#endif
284
Simon Glassb6396402014-06-12 07:24:46 -0600285 return 0;
286}
287
288static int bootm_find_other(cmd_tbl_t *cmdtp, int flag, int argc,
289 char * const argv[])
290{
291 if (((images.os.type == IH_TYPE_KERNEL) ||
292 (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
293 (images.os.type == IH_TYPE_MULTI)) &&
294 (images.os.os == IH_OS_LINUX ||
295 images.os.os == IH_OS_VXWORKS))
Karl Apsited52e8572015-05-21 09:52:49 -0400296 return bootm_find_images(flag, argc, argv);
Simon Glassb6396402014-06-12 07:24:46 -0600297
298 return 0;
299}
Simon Glass40e59752014-12-02 13:17:30 -0700300#endif /* USE_HOSTC */
301
Simon Glass8fd6a4b2014-12-02 13:17:36 -0700302/**
303 * print_decomp_msg() - Print a suitable decompression/loading message
304 *
305 * @type: OS type (IH_OS_...)
306 * @comp_type: Compression type being used (IH_COMP_...)
307 * @is_xip: true if the load address matches the image start
308 */
309static void print_decomp_msg(int comp_type, int type, bool is_xip)
Simon Glass40e59752014-12-02 13:17:30 -0700310{
Simon Glass8fd6a4b2014-12-02 13:17:36 -0700311 const char *name = genimg_get_type_name(type);
312
313 if (comp_type == IH_COMP_NONE)
314 printf(" %s %s ... ", is_xip ? "XIP" : "Loading", name);
315 else
316 printf(" Uncompressing %s ... ", name);
Simon Glass40e59752014-12-02 13:17:30 -0700317}
318
Simon Glass3086c052014-12-02 13:17:37 -0700319/**
320 * handle_decomp_error() - display a decompression error
321 *
322 * This function tries to produce a useful message. In the case where the
323 * uncompressed size is the same as the available space, we can assume that
324 * the image is too large for the buffer.
325 *
326 * @comp_type: Compression type being used (IH_COMP_...)
327 * @uncomp_size: Number of bytes uncompressed
328 * @unc_len: Amount of space available for decompression
329 * @ret: Error code to report
330 * @return BOOTM_ERR_RESET, indicating that the board must be reset
331 */
332static int handle_decomp_error(int comp_type, size_t uncomp_size,
333 size_t unc_len, int ret)
Simon Glass40e59752014-12-02 13:17:30 -0700334{
Simon Glass3086c052014-12-02 13:17:37 -0700335 const char *name = genimg_get_comp_name(comp_type);
336
337 if (uncomp_size >= unc_len)
338 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
Simon Glass40e59752014-12-02 13:17:30 -0700339 else
Simon Glass3086c052014-12-02 13:17:37 -0700340 printf("%s: uncompress error %d\n", name, ret);
341
342 /*
343 * The decompression routines are now safe, so will not write beyond
344 * their bounds. Probably it is not necessary to reset, but maintain
345 * the current behaviour for now.
346 */
347 printf("Must RESET board to recover\n");
Simon Glass40e59752014-12-02 13:17:30 -0700348#ifndef USE_HOSTCC
349 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
350#endif
351
352 return BOOTM_ERR_RESET;
353}
Simon Glassb6396402014-06-12 07:24:46 -0600354
Simon Glass081cc192014-12-02 13:17:33 -0700355int bootm_decomp_image(int comp, ulong load, ulong image_start, int type,
356 void *load_buf, void *image_buf, ulong image_len,
357 uint unc_len, ulong *load_end)
Simon Glassb6396402014-06-12 07:24:46 -0600358{
Simon Glass3086c052014-12-02 13:17:37 -0700359 int ret = 0;
360
Simon Glass2b164f12014-06-12 07:24:52 -0600361 *load_end = load;
Simon Glass8fd6a4b2014-12-02 13:17:36 -0700362 print_decomp_msg(comp, type, load == image_start);
Simon Glass3086c052014-12-02 13:17:37 -0700363
364 /*
365 * Load the image to the right place, decompressing if needed. After
366 * this, image_len will be set to the number of uncompressed bytes
367 * loaded, ret will be non-zero on error.
368 */
Simon Glassb6396402014-06-12 07:24:46 -0600369 switch (comp) {
370 case IH_COMP_NONE:
Simon Glass3086c052014-12-02 13:17:37 -0700371 if (load == image_start)
372 break;
373 if (image_len <= unc_len)
Simon Glassb6396402014-06-12 07:24:46 -0600374 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
Simon Glass3086c052014-12-02 13:17:37 -0700375 else
376 ret = 1;
Simon Glassb6396402014-06-12 07:24:46 -0600377 break;
378#ifdef CONFIG_GZIP
Simon Glass40e59752014-12-02 13:17:30 -0700379 case IH_COMP_GZIP: {
Simon Glass40e59752014-12-02 13:17:30 -0700380 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
Simon Glassb6396402014-06-12 07:24:46 -0600381 break;
Simon Glass40e59752014-12-02 13:17:30 -0700382 }
Simon Glassb6396402014-06-12 07:24:46 -0600383#endif /* CONFIG_GZIP */
384#ifdef CONFIG_BZIP2
Simon Glass40e59752014-12-02 13:17:30 -0700385 case IH_COMP_BZIP2: {
Simon Glass3086c052014-12-02 13:17:37 -0700386 uint size = unc_len;
Simon Glass40e59752014-12-02 13:17:30 -0700387
Simon Glassb6396402014-06-12 07:24:46 -0600388 /*
389 * If we've got less than 4 MB of malloc() space,
390 * use slower decompression algorithm which requires
391 * at most 2300 KB of memory.
392 */
Simon Glass3086c052014-12-02 13:17:37 -0700393 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
Simon Glassb6396402014-06-12 07:24:46 -0600394 image_buf, image_len,
395 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
Simon Glass3086c052014-12-02 13:17:37 -0700396 image_len = size;
Simon Glassb6396402014-06-12 07:24:46 -0600397 break;
Simon Glass40e59752014-12-02 13:17:30 -0700398 }
Simon Glassb6396402014-06-12 07:24:46 -0600399#endif /* CONFIG_BZIP2 */
400#ifdef CONFIG_LZMA
401 case IH_COMP_LZMA: {
402 SizeT lzma_len = unc_len;
Simon Glass2b164f12014-06-12 07:24:52 -0600403
Simon Glassb6396402014-06-12 07:24:46 -0600404 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
405 image_buf, image_len);
Simon Glass3086c052014-12-02 13:17:37 -0700406 image_len = lzma_len;
Simon Glassb6396402014-06-12 07:24:46 -0600407 break;
408 }
409#endif /* CONFIG_LZMA */
410#ifdef CONFIG_LZO
411 case IH_COMP_LZO: {
412 size_t size = unc_len;
413
Simon Glassb6396402014-06-12 07:24:46 -0600414 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
Simon Glass3086c052014-12-02 13:17:37 -0700415 image_len = size;
Simon Glassb6396402014-06-12 07:24:46 -0600416 break;
417 }
418#endif /* CONFIG_LZO */
Julius Werner027b7282015-10-06 20:03:53 -0700419#ifdef CONFIG_LZ4
420 case IH_COMP_LZ4: {
421 size_t size = unc_len;
422
423 ret = ulz4fn(image_buf, image_len, load_buf, &size);
424 image_len = size;
425 break;
426 }
427#endif /* CONFIG_LZ4 */
Simon Glassb6396402014-06-12 07:24:46 -0600428 default:
429 printf("Unimplemented compression type %d\n", comp);
430 return BOOTM_ERR_UNIMPLEMENTED;
431 }
432
Simon Glass3086c052014-12-02 13:17:37 -0700433 if (ret)
434 return handle_decomp_error(comp, image_len, unc_len, ret);
435 *load_end = load + image_len;
436
Simon Glass2b164f12014-06-12 07:24:52 -0600437 puts("OK\n");
438
439 return 0;
440}
441
Simon Glassce1400f2014-06-12 07:24:53 -0600442#ifndef USE_HOSTCC
Tom Rinicc955352018-05-01 12:32:37 -0400443static int bootm_load_os(bootm_headers_t *images, int boot_progress)
Simon Glass2b164f12014-06-12 07:24:52 -0600444{
445 image_info_t os = images->os;
446 ulong load = os.load;
Tom Rinicc955352018-05-01 12:32:37 -0400447 ulong load_end;
Simon Glass2b164f12014-06-12 07:24:52 -0600448 ulong blob_start = os.start;
449 ulong blob_end = os.end;
450 ulong image_start = os.image_start;
451 ulong image_len = os.image_len;
Bryan O'Donoghuebbac9222018-04-15 11:48:17 +0100452 ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
Simon Glass2b164f12014-06-12 07:24:52 -0600453 bool no_overlap;
454 void *load_buf, *image_buf;
455 int err;
456
457 load_buf = map_sysmem(load, 0);
458 image_buf = map_sysmem(os.image_start, image_len);
Simon Glass081cc192014-12-02 13:17:33 -0700459 err = bootm_decomp_image(os.comp, load, os.image_start, os.type,
460 load_buf, image_buf, image_len,
Tom Rinicc955352018-05-01 12:32:37 -0400461 CONFIG_SYS_BOOTM_LEN, &load_end);
Simon Glass2b164f12014-06-12 07:24:52 -0600462 if (err) {
463 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
464 return err;
465 }
Bryan O'Donoghuebbac9222018-04-15 11:48:17 +0100466
Trent Piephob4353b32019-03-27 23:50:09 +0000467 flush_cache(flush_start, ALIGN(load_end, ARCH_DMA_MINALIGN) - flush_start);
Simon Glassb6396402014-06-12 07:24:46 -0600468
Tom Rinicc955352018-05-01 12:32:37 -0400469 debug(" kernel loaded at 0x%08lx, end = 0x%08lx\n", load, load_end);
Simon Glassb6396402014-06-12 07:24:46 -0600470 bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
471
Simon Glass2b164f12014-06-12 07:24:52 -0600472 no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
473
Tom Rinicc955352018-05-01 12:32:37 -0400474 if (!no_overlap && load < blob_end && load_end > blob_start) {
Simon Glassb6396402014-06-12 07:24:46 -0600475 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
476 blob_start, blob_end);
477 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
Tom Rinicc955352018-05-01 12:32:37 -0400478 load_end);
Simon Glassb6396402014-06-12 07:24:46 -0600479
480 /* Check what type of image this is. */
481 if (images->legacy_hdr_valid) {
482 if (image_get_type(&images->legacy_hdr_os_copy)
483 == IH_TYPE_MULTI)
484 puts("WARNING: legacy format multi component image overwritten\n");
485 return BOOTM_ERR_OVERLAP;
486 } else {
487 puts("ERROR: new format image overwritten - must RESET the board to recover\n");
488 bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
489 return BOOTM_ERR_RESET;
490 }
491 }
492
Tom Rinicc955352018-05-01 12:32:37 -0400493 lmb_reserve(&images->lmb, images->os.load, (load_end -
494 images->os.load));
Simon Glassb6396402014-06-12 07:24:46 -0600495 return 0;
496}
497
498/**
499 * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
500 *
501 * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
502 * enabled)
503 */
504ulong bootm_disable_interrupts(void)
505{
506 ulong iflag;
507
508 /*
509 * We have reached the point of no return: we are going to
510 * overwrite all exception vector code, so we cannot easily
511 * recover from any failures any more...
512 */
513 iflag = disable_interrupts();
514#ifdef CONFIG_NETCONSOLE
515 /* Stop the ethernet stack if NetConsole could have left it up */
516 eth_halt();
Bernhard Nortmann4917c062015-09-14 15:29:45 +0200517# ifndef CONFIG_DM_ETH
Simon Glassb6396402014-06-12 07:24:46 -0600518 eth_unregister(eth_get_dev());
Bernhard Nortmann4917c062015-09-14 15:29:45 +0200519# endif
Simon Glassb6396402014-06-12 07:24:46 -0600520#endif
521
522#if defined(CONFIG_CMD_USB)
523 /*
524 * turn off USB to prevent the host controller from writing to the
525 * SDRAM while Linux is booting. This could happen (at least for OHCI
526 * controller), because the HCCA (Host Controller Communication Area)
527 * lies within the SDRAM and the host controller writes continously to
528 * this area (as busmaster!). The HccaFrameNumber is for example
529 * updated every 1 ms within the HCCA structure in SDRAM! For more
530 * details see the OpenHCI specification.
531 */
532 usb_stop();
533#endif
534 return iflag;
535}
536
537#if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
538
539#define CONSOLE_ARG "console="
540#define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
541
542static void fixup_silent_linux(void)
543{
544 char *buf;
545 const char *env_val;
Simon Glass00caae62017-08-03 12:22:12 -0600546 char *cmdline = env_get("bootargs");
Simon Glassb6396402014-06-12 07:24:46 -0600547 int want_silent;
548
549 /*
550 * Only fix cmdline when requested. The environment variable can be:
551 *
552 * no - we never fixup
553 * yes - we always fixup
554 * unset - we rely on the console silent flag
555 */
Simon Glassbfebc8c2017-08-03 12:22:13 -0600556 want_silent = env_get_yesno("silent_linux");
Simon Glassb6396402014-06-12 07:24:46 -0600557 if (want_silent == 0)
558 return;
559 else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
560 return;
561
562 debug("before silent fix-up: %s\n", cmdline);
563 if (cmdline && (cmdline[0] != '\0')) {
564 char *start = strstr(cmdline, CONSOLE_ARG);
565
566 /* Allocate space for maximum possible new command line */
567 buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
568 if (!buf) {
569 debug("%s: out of memory\n", __func__);
570 return;
571 }
572
573 if (start) {
574 char *end = strchr(start, ' ');
575 int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
576
577 strncpy(buf, cmdline, num_start_bytes);
578 if (end)
579 strcpy(buf + num_start_bytes, end);
580 else
581 buf[num_start_bytes] = '\0';
582 } else {
583 sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
584 }
585 env_val = buf;
586 } else {
587 buf = NULL;
588 env_val = CONSOLE_ARG;
589 }
590
Simon Glass382bee52017-08-03 12:22:09 -0600591 env_set("bootargs", env_val);
Simon Glassb6396402014-06-12 07:24:46 -0600592 debug("after silent fix-up: %s\n", env_val);
593 free(buf);
594}
595#endif /* CONFIG_SILENT_CONSOLE */
596
597/**
598 * Execute selected states of the bootm command.
599 *
600 * Note the arguments to this state must be the first argument, Any 'bootm'
601 * or sub-command arguments must have already been taken.
602 *
603 * Note that if states contains more than one flag it MUST contain
604 * BOOTM_STATE_START, since this handles and consumes the command line args.
605 *
606 * Also note that aside from boot_os_fn functions and bootm_load_os no other
607 * functions we store the return value of in 'ret' may use a negative return
608 * value, without special handling.
609 *
610 * @param cmdtp Pointer to bootm command table entry
611 * @param flag Command flags (CMD_FLAG_...)
612 * @param argc Number of subcommand arguments (0 = no arguments)
613 * @param argv Arguments
614 * @param states Mask containing states to run (BOOTM_STATE_...)
615 * @param images Image header information
616 * @param boot_progress 1 to show boot progress, 0 to not do this
617 * @return 0 if ok, something else on error. Some errors will cause this
618 * function to perform a reboot! If states contains BOOTM_STATE_OS_GO
619 * then the intent is to boot an OS, so this function will not return
620 * unless the image type is standalone.
621 */
622int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
623 int states, bootm_headers_t *images, int boot_progress)
624{
625 boot_os_fn *boot_fn;
626 ulong iflag = 0;
627 int ret = 0, need_boot_fn;
628
629 images->state |= states;
630
631 /*
632 * Work through the states and see how far we get. We stop on
633 * any error.
634 */
635 if (states & BOOTM_STATE_START)
636 ret = bootm_start(cmdtp, flag, argc, argv);
637
638 if (!ret && (states & BOOTM_STATE_FINDOS))
639 ret = bootm_find_os(cmdtp, flag, argc, argv);
640
Zubair Lutfullah Kakakhelba079842016-09-09 09:18:58 +0100641 if (!ret && (states & BOOTM_STATE_FINDOTHER))
Simon Glassb6396402014-06-12 07:24:46 -0600642 ret = bootm_find_other(cmdtp, flag, argc, argv);
Simon Glassb6396402014-06-12 07:24:46 -0600643
644 /* Load the OS */
645 if (!ret && (states & BOOTM_STATE_LOADOS)) {
Simon Glassb6396402014-06-12 07:24:46 -0600646 iflag = bootm_disable_interrupts();
Tom Rinicc955352018-05-01 12:32:37 -0400647 ret = bootm_load_os(images, 0);
648 if (ret && ret != BOOTM_ERR_OVERLAP)
Simon Glassb6396402014-06-12 07:24:46 -0600649 goto err;
650 else if (ret == BOOTM_ERR_OVERLAP)
651 ret = 0;
Simon Glassb6396402014-06-12 07:24:46 -0600652 }
653
654 /* Relocate the ramdisk */
655#ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
656 if (!ret && (states & BOOTM_STATE_RAMDISK)) {
657 ulong rd_len = images->rd_end - images->rd_start;
658
659 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
660 rd_len, &images->initrd_start, &images->initrd_end);
661 if (!ret) {
Simon Glass018f5302017-08-03 12:22:10 -0600662 env_set_hex("initrd_start", images->initrd_start);
663 env_set_hex("initrd_end", images->initrd_end);
Simon Glassb6396402014-06-12 07:24:46 -0600664 }
665 }
666#endif
Simon Glassaa34fbc2016-02-22 22:55:45 -0700667#if IMAGE_ENABLE_OF_LIBFDT && defined(CONFIG_LMB)
Simon Glassb6396402014-06-12 07:24:46 -0600668 if (!ret && (states & BOOTM_STATE_FDT)) {
669 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
670 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
671 &images->ft_len);
672 }
673#endif
674
675 /* From now on, we need the OS boot function */
676 if (ret)
677 return ret;
678 boot_fn = bootm_os_get_boot_func(images->os.os);
679 need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
680 BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
681 BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
682 if (boot_fn == NULL && need_boot_fn) {
683 if (iflag)
684 enable_interrupts();
685 printf("ERROR: booting os '%s' (%d) is not supported\n",
686 genimg_get_os_name(images->os.os), images->os.os);
687 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
688 return 1;
689 }
690
Hector Palacios19e86492016-07-11 12:34:37 +0200691
Simon Glassb6396402014-06-12 07:24:46 -0600692 /* Call various other states that are not generally used */
693 if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
694 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
695 if (!ret && (states & BOOTM_STATE_OS_BD_T))
696 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
Hector Palacios19e86492016-07-11 12:34:37 +0200697 if (!ret && (states & BOOTM_STATE_OS_PREP)) {
698#if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
699 if (images->os.os == IH_OS_LINUX)
700 fixup_silent_linux();
701#endif
Simon Glassb6396402014-06-12 07:24:46 -0600702 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
Hector Palacios19e86492016-07-11 12:34:37 +0200703 }
Simon Glassb6396402014-06-12 07:24:46 -0600704
705#ifdef CONFIG_TRACE
706 /* Pretend to run the OS, then run a user command */
707 if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
Simon Glass00caae62017-08-03 12:22:12 -0600708 char *cmd_list = env_get("fakegocmd");
Simon Glassb6396402014-06-12 07:24:46 -0600709
710 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
711 images, boot_fn);
712 if (!ret && cmd_list)
713 ret = run_command_list(cmd_list, -1, flag);
714 }
715#endif
716
717 /* Check for unsupported subcommand. */
718 if (ret) {
719 puts("subcommand not supported\n");
720 return ret;
721 }
722
723 /* Now run the OS! We hope this doesn't return */
724 if (!ret && (states & BOOTM_STATE_OS_GO))
725 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
726 images, boot_fn);
727
728 /* Deal with any fallout */
729err:
730 if (iflag)
731 enable_interrupts();
732
733 if (ret == BOOTM_ERR_UNIMPLEMENTED)
734 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
735 else if (ret == BOOTM_ERR_RESET)
736 do_reset(cmdtp, flag, argc, argv);
737
738 return ret;
739}
740
Tom Rinic76c93a2019-05-23 07:14:07 -0400741#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
Simon Glassb6396402014-06-12 07:24:46 -0600742/**
743 * image_get_kernel - verify legacy format kernel image
744 * @img_addr: in RAM address of the legacy format image to be verified
745 * @verify: data CRC verification flag
746 *
747 * image_get_kernel() verifies legacy image integrity and returns pointer to
748 * legacy image header if image verification was completed successfully.
749 *
750 * returns:
751 * pointer to a legacy image header if valid image was found
752 * otherwise return NULL
753 */
754static image_header_t *image_get_kernel(ulong img_addr, int verify)
755{
756 image_header_t *hdr = (image_header_t *)img_addr;
757
758 if (!image_check_magic(hdr)) {
759 puts("Bad Magic Number\n");
760 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
761 return NULL;
762 }
763 bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
764
765 if (!image_check_hcrc(hdr)) {
766 puts("Bad Header Checksum\n");
767 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
768 return NULL;
769 }
770
771 bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
772 image_print_contents(hdr);
773
774 if (verify) {
775 puts(" Verifying Checksum ... ");
776 if (!image_check_dcrc(hdr)) {
777 printf("Bad Data CRC\n");
778 bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
779 return NULL;
780 }
781 puts("OK\n");
782 }
783 bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
784
785 if (!image_check_target_arch(hdr)) {
786 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
787 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
788 return NULL;
789 }
790 return hdr;
791}
792#endif
793
794/**
795 * boot_get_kernel - find kernel image
796 * @os_data: pointer to a ulong variable, will hold os data start address
797 * @os_len: pointer to a ulong variable, will hold os data length
798 *
799 * boot_get_kernel() tries to find a kernel image, verifies its integrity
800 * and locates kernel data.
801 *
802 * returns:
803 * pointer to image header if valid image was found, plus kernel start
804 * address and length, otherwise NULL
805 */
806static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
807 char * const argv[], bootm_headers_t *images,
808 ulong *os_data, ulong *os_len)
809{
Tom Rinic76c93a2019-05-23 07:14:07 -0400810#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
Simon Glassb6396402014-06-12 07:24:46 -0600811 image_header_t *hdr;
812#endif
813 ulong img_addr;
814 const void *buf;
Simon Glassb6396402014-06-12 07:24:46 -0600815 const char *fit_uname_config = NULL;
816 const char *fit_uname_kernel = NULL;
Simon Glass73223f02016-02-22 22:55:43 -0700817#if IMAGE_ENABLE_FIT
Simon Glassb6396402014-06-12 07:24:46 -0600818 int os_noffset;
819#endif
820
Bryan Wue6c88a62014-08-15 16:51:39 -0700821 img_addr = genimg_get_kernel_addr_fit(argc < 1 ? NULL : argv[0],
822 &fit_uname_config,
823 &fit_uname_kernel);
Simon Glassb6396402014-06-12 07:24:46 -0600824
825 bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
826
Simon Glassb6396402014-06-12 07:24:46 -0600827 /* check image type, for FIT images get FIT kernel node */
828 *os_data = *os_len = 0;
829 buf = map_sysmem(img_addr, 0);
830 switch (genimg_get_format(buf)) {
Tom Rinic76c93a2019-05-23 07:14:07 -0400831#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
Simon Glassb6396402014-06-12 07:24:46 -0600832 case IMAGE_FORMAT_LEGACY:
833 printf("## Booting kernel from Legacy Image at %08lx ...\n",
834 img_addr);
835 hdr = image_get_kernel(img_addr, images->verify);
836 if (!hdr)
837 return NULL;
838 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
839
840 /* get os_data and os_len */
841 switch (image_get_type(hdr)) {
842 case IH_TYPE_KERNEL:
843 case IH_TYPE_KERNEL_NOLOAD:
844 *os_data = image_get_data(hdr);
845 *os_len = image_get_data_size(hdr);
846 break;
847 case IH_TYPE_MULTI:
848 image_multi_getimg(hdr, 0, os_data, os_len);
849 break;
850 case IH_TYPE_STANDALONE:
851 *os_data = image_get_data(hdr);
852 *os_len = image_get_data_size(hdr);
853 break;
854 default:
855 printf("Wrong Image Type for %s command\n",
856 cmdtp->name);
857 bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
858 return NULL;
859 }
860
861 /*
862 * copy image header to allow for image overwrites during
863 * kernel decompression.
864 */
865 memmove(&images->legacy_hdr_os_copy, hdr,
866 sizeof(image_header_t));
867
868 /* save pointer to image header */
869 images->legacy_hdr_os = hdr;
870
871 images->legacy_hdr_valid = 1;
872 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
873 break;
874#endif
Simon Glass73223f02016-02-22 22:55:43 -0700875#if IMAGE_ENABLE_FIT
Simon Glassb6396402014-06-12 07:24:46 -0600876 case IMAGE_FORMAT_FIT:
Simon Glass126cc862014-06-12 07:24:47 -0600877 os_noffset = fit_image_load(images, img_addr,
Simon Glassb6396402014-06-12 07:24:46 -0600878 &fit_uname_kernel, &fit_uname_config,
879 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
880 BOOTSTAGE_ID_FIT_KERNEL_START,
881 FIT_LOAD_IGNORED, os_data, os_len);
882 if (os_noffset < 0)
883 return NULL;
884
885 images->fit_hdr_os = map_sysmem(img_addr, 0);
886 images->fit_uname_os = fit_uname_kernel;
887 images->fit_uname_cfg = fit_uname_config;
888 images->fit_noffset_os = os_noffset;
889 break;
890#endif
891#ifdef CONFIG_ANDROID_BOOT_IMAGE
892 case IMAGE_FORMAT_ANDROID:
893 printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
Simon Glass07c0cd72014-06-12 07:24:48 -0600894 if (android_image_get_kernel(buf, images->verify,
Simon Glassb6396402014-06-12 07:24:46 -0600895 os_data, os_len))
896 return NULL;
897 break;
898#endif
899 default:
900 printf("Wrong Image Format for %s command\n", cmdtp->name);
901 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
902 return NULL;
903 }
904
905 debug(" kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
906 *os_data, *os_len, *os_len);
907
908 return buf;
909}
Heinrich Schuchardtf6c6df72019-01-08 18:13:06 +0100910
911/**
912 * switch_to_non_secure_mode() - switch to non-secure mode
913 *
914 * This routine is overridden by architectures requiring this feature.
915 */
916void __weak switch_to_non_secure_mode(void)
917{
918}
919
Simon Glassce1400f2014-06-12 07:24:53 -0600920#else /* USE_HOSTCC */
921
922void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
923{
924 memmove(to, from, len);
925}
926
Fabrice Fontaine93e07882019-05-03 22:37:05 +0200927#if defined(CONFIG_FIT_SIGNATURE)
Simon Glassce1400f2014-06-12 07:24:53 -0600928static int bootm_host_load_image(const void *fit, int req_image_type)
929{
930 const char *fit_uname_config = NULL;
931 ulong data, len;
932 bootm_headers_t images;
933 int noffset;
934 ulong load_end;
935 uint8_t image_type;
936 uint8_t imape_comp;
937 void *load_buf;
938 int ret;
939
940 memset(&images, '\0', sizeof(images));
941 images.verify = 1;
942 noffset = fit_image_load(&images, (ulong)fit,
943 NULL, &fit_uname_config,
944 IH_ARCH_DEFAULT, req_image_type, -1,
945 FIT_LOAD_IGNORED, &data, &len);
946 if (noffset < 0)
947 return noffset;
948 if (fit_image_get_type(fit, noffset, &image_type)) {
949 puts("Can't get image type!\n");
950 return -EINVAL;
951 }
952
953 if (fit_image_get_comp(fit, noffset, &imape_comp)) {
954 puts("Can't get image compression!\n");
955 return -EINVAL;
956 }
957
958 /* Allow the image to expand by a factor of 4, should be safe */
959 load_buf = malloc((1 << 20) + len * 4);
Simon Glass081cc192014-12-02 13:17:33 -0700960 ret = bootm_decomp_image(imape_comp, 0, data, image_type, load_buf,
961 (void *)data, len, CONFIG_SYS_BOOTM_LEN,
962 &load_end);
Simon Glassce1400f2014-06-12 07:24:53 -0600963 free(load_buf);
Simon Glass081cc192014-12-02 13:17:33 -0700964
Simon Glassce1400f2014-06-12 07:24:53 -0600965 if (ret && ret != BOOTM_ERR_UNIMPLEMENTED)
966 return ret;
967
968 return 0;
969}
970
971int bootm_host_load_images(const void *fit, int cfg_noffset)
972{
973 static uint8_t image_types[] = {
974 IH_TYPE_KERNEL,
975 IH_TYPE_FLATDT,
976 IH_TYPE_RAMDISK,
977 };
978 int err = 0;
979 int i;
980
981 for (i = 0; i < ARRAY_SIZE(image_types); i++) {
982 int ret;
983
984 ret = bootm_host_load_image(fit, image_types[i]);
985 if (!err && ret && ret != -ENOENT)
986 err = ret;
987 }
988
989 /* Return the first error we found */
990 return err;
991}
Fabrice Fontaine93e07882019-05-03 22:37:05 +0200992#endif
Simon Glassea51a622014-06-12 07:24:51 -0600993
994#endif /* ndef USE_HOSTCC */