blob: 698d9f86d9652f264c5e749ec616f25d9b90309d [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkd0dd1072002-10-20 17:17:16 +00002/*
3 * (C) Copyright 2001
4 * Kyle Harris, kharris@nexus-tech.net
wdenkd0dd1072002-10-20 17:17:16 +00005 */
6
7/*
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02008 * The "source" command allows to define "script images", i. e. files
9 * that contain command sequences that can be executed by the command
10 * interpreter. It returns the exit status of the last command
11 * executed from the script. This is very similar to running a shell
12 * script in a UNIX shell, hence the name for the command.
wdenkd0dd1072002-10-20 17:17:16 +000013 */
14
15/* #define DEBUG */
16
17#include <common.h>
18#include <command.h>
Simon Glass6bf6dbe2019-08-01 09:46:49 -060019#include <env.h>
wdenkd0dd1072002-10-20 17:17:16 +000020#include <image.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060021#include <log.h>
wdenkd0dd1072002-10-20 17:17:16 +000022#include <malloc.h>
Joe Hershberger0eb25b62015-03-22 17:08:59 -050023#include <mapmem.h>
wdenkd0dd1072002-10-20 17:17:16 +000024#include <asm/byteorder.h>
Simon Glass4ca30d62013-04-20 08:42:49 +000025#include <asm/io.h>
wdenkd0dd1072002-10-20 17:17:16 +000026
Alex Kiernan201d9cd2018-06-22 14:58:02 +000027#if defined(CONFIG_FIT)
28/**
29 * get_default_image() - Return default property from /images
30 *
31 * Return: Pointer to value of default property (or NULL)
32 */
33static const char *get_default_image(const void *fit)
34{
35 int images_noffset;
36
37 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
38 if (images_noffset < 0)
39 return NULL;
40
41 return fdt_getprop(fit, images_noffset, FIT_DEFAULT_PROP, NULL);
42}
43#endif
44
Simon Glass220a3a42019-12-28 10:45:04 -070045int image_source_script(ulong addr, const char *fit_uname)
wdenkd0dd1072002-10-20 17:17:16 +000046{
Wolfgang Denk53677ef2008-05-20 16:00:29 +020047 ulong len;
Tom Rinic76c93a2019-05-23 07:14:07 -040048#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Simon Glassf3543e62022-09-06 20:26:52 -060049 const struct legacy_img_hdr *hdr;
Heiko Schocher21d29f72014-05-28 11:33:33 +020050#endif
Gong Qianyu210fbee2015-07-30 14:00:01 +080051 u32 *data;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +010052 int verify;
Simon Glass4ca30d62013-04-20 08:42:49 +000053 void *buf;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +010054#if defined(CONFIG_FIT)
55 const void* fit_hdr;
56 int noffset;
57 const void *fit_data;
58 size_t fit_len;
59#endif
wdenkd0dd1072002-10-20 17:17:16 +000060
Simon Glassbfebc8c2017-08-03 12:22:13 -060061 verify = env_get_yesno("verify");
wdenkd0dd1072002-10-20 17:17:16 +000062
Simon Glass4ca30d62013-04-20 08:42:49 +000063 buf = map_sysmem(addr, 0);
64 switch (genimg_get_format(buf)) {
Tom Rinic76c93a2019-05-23 07:14:07 -040065#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010066 case IMAGE_FORMAT_LEGACY:
Simon Glass4ca30d62013-04-20 08:42:49 +000067 hdr = buf;
wdenkd0dd1072002-10-20 17:17:16 +000068
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010069 if (!image_check_magic (hdr)) {
70 puts ("Bad magic number\n");
wdenkd0dd1072002-10-20 17:17:16 +000071 return 1;
72 }
wdenkd0dd1072002-10-20 17:17:16 +000073
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010074 if (!image_check_hcrc (hdr)) {
75 puts ("Bad header crc\n");
76 return 1;
77 }
78
79 if (verify) {
80 if (!image_check_dcrc (hdr)) {
81 puts ("Bad data crc\n");
82 return 1;
83 }
84 }
85
86 if (!image_check_type (hdr, IH_TYPE_SCRIPT)) {
87 puts ("Bad image type\n");
88 return 1;
89 }
90
91 /* get length of script */
Gong Qianyu210fbee2015-07-30 14:00:01 +080092 data = (u32 *)image_get_data (hdr);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010093
Marian Balakowicz9a4daad2008-02-29 14:58:34 +010094 if ((len = uimage_to_cpu (*data)) == 0) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010095 puts ("Empty Script\n");
96 return 1;
97 }
Bartlomiej Sieka36cc8cb2008-03-20 23:10:19 +010098
99 /*
100 * scripts are just multi-image files with one component, seek
101 * past the zero-terminated sequence of image lengths to get
102 * to the actual image data
103 */
104 while (*data++);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100105 break;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200106#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100107#if defined(CONFIG_FIT)
108 case IMAGE_FORMAT_FIT:
Simon Glass4ca30d62013-04-20 08:42:49 +0000109 fit_hdr = buf;
Simon Glassc5819702021-02-15 17:08:09 -0700110 if (fit_check_format(fit_hdr, IMAGE_SIZE_INVAL)) {
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100111 puts ("Bad FIT image format\n");
112 return 1;
113 }
114
Alex Kiernan201d9cd2018-06-22 14:58:02 +0000115 if (!fit_uname)
116 fit_uname = get_default_image(fit_hdr);
117
118 if (!fit_uname) {
119 puts("No FIT subimage unit name\n");
120 return 1;
121 }
122
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100123 /* get script component image node offset */
124 noffset = fit_image_get_node (fit_hdr, fit_uname);
125 if (noffset < 0) {
126 printf ("Can't find '%s' FIT subimage\n", fit_uname);
127 return 1;
128 }
129
130 if (!fit_image_check_type (fit_hdr, noffset, IH_TYPE_SCRIPT)) {
131 puts ("Not a image image\n");
132 return 1;
133 }
134
135 /* verify integrity */
136 if (verify) {
Simon Glassb8da8362013-05-07 06:11:57 +0000137 if (!fit_image_verify(fit_hdr, noffset)) {
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100138 puts ("Bad Data Hash\n");
139 return 1;
140 }
141 }
142
143 /* get script subimage data address and length */
144 if (fit_image_get_data (fit_hdr, noffset, &fit_data, &fit_len)) {
145 puts ("Could not find script subimage data\n");
146 return 1;
147 }
148
Gong Qianyu210fbee2015-07-30 14:00:01 +0800149 data = (u32 *)fit_data;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100150 len = (ulong)fit_len;
151 break;
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100152#endif
153 default:
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200154 puts ("Wrong image format for \"source\" command\n");
wdenkd0dd1072002-10-20 17:17:16 +0000155 return 1;
156 }
157
Simon Glass3c7dded2020-05-10 11:40:04 -0600158 debug("** Script length: %ld\n", len);
Simon Glassd51004a2012-03-30 21:30:55 +0000159 return run_command_list((char *)data, len, 0);
wdenkd0dd1072002-10-20 17:17:16 +0000160}
161
wdenk8bde7f72003-06-27 21:31:46 +0000162/**************************************************/
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200163#if defined(CONFIG_CMD_SOURCE)
Simon Glass09140112020-05-10 11:40:03 -0600164static int do_source(struct cmd_tbl *cmdtp, int flag, int argc,
165 char *const argv[])
wdenkd0dd1072002-10-20 17:17:16 +0000166{
167 ulong addr;
168 int rcode;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100169 const char *fit_uname = NULL;
wdenkd0dd1072002-10-20 17:17:16 +0000170
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100171 /* Find script image */
wdenkd0dd1072002-10-20 17:17:16 +0000172 if (argc < 2) {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200173 addr = CONFIG_SYS_LOAD_ADDR;
Simon Glass3c7dded2020-05-10 11:40:04 -0600174 debug("* source: default load address = 0x%08lx\n", addr);
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100175#if defined(CONFIG_FIT)
Simon Glassbb872dd2019-12-28 10:45:02 -0700176 } else if (fit_parse_subimage(argv[1], image_load_addr, &addr,
177 &fit_uname)) {
Simon Glass3c7dded2020-05-10 11:40:04 -0600178 debug("* source: subimage '%s' from FIT image at 0x%08lx\n",
179 fit_uname, addr);
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100180#endif
wdenkd0dd1072002-10-20 17:17:16 +0000181 } else {
Simon Glass7e5f4602021-07-24 09:03:29 -0600182 addr = hextoul(argv[1], NULL);
Simon Glass3c7dded2020-05-10 11:40:04 -0600183 debug("* source: cmdline image address = 0x%08lx\n", addr);
wdenkd0dd1072002-10-20 17:17:16 +0000184 }
185
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100186 printf ("## Executing script at %08lx\n", addr);
Simon Glass220a3a42019-12-28 10:45:04 -0700187 rcode = image_source_script(addr, fit_uname);
wdenkd0dd1072002-10-20 17:17:16 +0000188 return rcode;
189}
wdenk8bde7f72003-06-27 21:31:46 +0000190
Kim Phillips088f1b12012-10-29 13:34:31 +0000191#ifdef CONFIG_SYS_LONGHELP
192static char source_help_text[] =
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200193 "[addr]\n"
194 "\t- run script starting at addr\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200195 "\t- A valid image header must be present"
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100196#if defined(CONFIG_FIT)
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200197 "\n"
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100198 "For FIT format uImage addr must include subimage\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200199 "unit name in the form of addr:<subimg_uname>"
Jon Loeliger90253172007-07-10 11:02:44 -0500200#endif
Kim Phillips088f1b12012-10-29 13:34:31 +0000201 "";
202#endif
203
204U_BOOT_CMD(
205 source, 2, 0, do_source,
206 "run script from memory", source_help_text
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100207);
Jon Loeliger90253172007-07-10 11:02:44 -0500208#endif