blob: 92f8f77ee6fcc60a1cc56f59d4e26db87f720758 [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>
21#include <malloc.h>
Joe Hershberger0eb25b62015-03-22 17:08:59 -050022#include <mapmem.h>
wdenkd0dd1072002-10-20 17:17:16 +000023#include <asm/byteorder.h>
Simon Glass4ca30d62013-04-20 08:42:49 +000024#include <asm/io.h>
wdenkd0dd1072002-10-20 17:17:16 +000025
Alex Kiernan201d9cd2018-06-22 14:58:02 +000026#if defined(CONFIG_FIT)
27/**
28 * get_default_image() - Return default property from /images
29 *
30 * Return: Pointer to value of default property (or NULL)
31 */
32static const char *get_default_image(const void *fit)
33{
34 int images_noffset;
35
36 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
37 if (images_noffset < 0)
38 return NULL;
39
40 return fdt_getprop(fit, images_noffset, FIT_DEFAULT_PROP, NULL);
41}
42#endif
43
Simon Glass220a3a42019-12-28 10:45:04 -070044int image_source_script(ulong addr, const char *fit_uname)
wdenkd0dd1072002-10-20 17:17:16 +000045{
Wolfgang Denk53677ef2008-05-20 16:00:29 +020046 ulong len;
Tom Rinic76c93a2019-05-23 07:14:07 -040047#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Simon Glass4ca30d62013-04-20 08:42:49 +000048 const image_header_t *hdr;
Heiko Schocher21d29f72014-05-28 11:33:33 +020049#endif
Gong Qianyu210fbee2015-07-30 14:00:01 +080050 u32 *data;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +010051 int verify;
Simon Glass4ca30d62013-04-20 08:42:49 +000052 void *buf;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +010053#if defined(CONFIG_FIT)
54 const void* fit_hdr;
55 int noffset;
56 const void *fit_data;
57 size_t fit_len;
58#endif
wdenkd0dd1072002-10-20 17:17:16 +000059
Simon Glassbfebc8c2017-08-03 12:22:13 -060060 verify = env_get_yesno("verify");
wdenkd0dd1072002-10-20 17:17:16 +000061
Simon Glass4ca30d62013-04-20 08:42:49 +000062 buf = map_sysmem(addr, 0);
63 switch (genimg_get_format(buf)) {
Tom Rinic76c93a2019-05-23 07:14:07 -040064#if defined(CONFIG_LEGACY_IMAGE_FORMAT)
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010065 case IMAGE_FORMAT_LEGACY:
Simon Glass4ca30d62013-04-20 08:42:49 +000066 hdr = buf;
wdenkd0dd1072002-10-20 17:17:16 +000067
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010068 if (!image_check_magic (hdr)) {
69 puts ("Bad magic number\n");
wdenkd0dd1072002-10-20 17:17:16 +000070 return 1;
71 }
wdenkd0dd1072002-10-20 17:17:16 +000072
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010073 if (!image_check_hcrc (hdr)) {
74 puts ("Bad header crc\n");
75 return 1;
76 }
77
78 if (verify) {
79 if (!image_check_dcrc (hdr)) {
80 puts ("Bad data crc\n");
81 return 1;
82 }
83 }
84
85 if (!image_check_type (hdr, IH_TYPE_SCRIPT)) {
86 puts ("Bad image type\n");
87 return 1;
88 }
89
90 /* get length of script */
Gong Qianyu210fbee2015-07-30 14:00:01 +080091 data = (u32 *)image_get_data (hdr);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010092
Marian Balakowicz9a4daad2008-02-29 14:58:34 +010093 if ((len = uimage_to_cpu (*data)) == 0) {
Marian Balakowiczd5934ad2008-02-04 08:28:09 +010094 puts ("Empty Script\n");
95 return 1;
96 }
Bartlomiej Sieka36cc8cb2008-03-20 23:10:19 +010097
98 /*
99 * scripts are just multi-image files with one component, seek
100 * past the zero-terminated sequence of image lengths to get
101 * to the actual image data
102 */
103 while (*data++);
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100104 break;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200105#endif
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100106#if defined(CONFIG_FIT)
107 case IMAGE_FORMAT_FIT:
Simon Glass4ca30d62013-04-20 08:42:49 +0000108 fit_hdr = buf;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100109 if (!fit_check_format (fit_hdr)) {
110 puts ("Bad FIT image format\n");
111 return 1;
112 }
113
Alex Kiernan201d9cd2018-06-22 14:58:02 +0000114 if (!fit_uname)
115 fit_uname = get_default_image(fit_hdr);
116
117 if (!fit_uname) {
118 puts("No FIT subimage unit name\n");
119 return 1;
120 }
121
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100122 /* get script component image node offset */
123 noffset = fit_image_get_node (fit_hdr, fit_uname);
124 if (noffset < 0) {
125 printf ("Can't find '%s' FIT subimage\n", fit_uname);
126 return 1;
127 }
128
129 if (!fit_image_check_type (fit_hdr, noffset, IH_TYPE_SCRIPT)) {
130 puts ("Not a image image\n");
131 return 1;
132 }
133
134 /* verify integrity */
135 if (verify) {
Simon Glassb8da8362013-05-07 06:11:57 +0000136 if (!fit_image_verify(fit_hdr, noffset)) {
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100137 puts ("Bad Data Hash\n");
138 return 1;
139 }
140 }
141
142 /* get script subimage data address and length */
143 if (fit_image_get_data (fit_hdr, noffset, &fit_data, &fit_len)) {
144 puts ("Could not find script subimage data\n");
145 return 1;
146 }
147
Gong Qianyu210fbee2015-07-30 14:00:01 +0800148 data = (u32 *)fit_data;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100149 len = (ulong)fit_len;
150 break;
Marian Balakowiczd5934ad2008-02-04 08:28:09 +0100151#endif
152 default:
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200153 puts ("Wrong image format for \"source\" command\n");
wdenkd0dd1072002-10-20 17:17:16 +0000154 return 1;
155 }
156
wdenk699b13a2002-11-03 18:03:52 +0000157 debug ("** Script length: %ld\n", len);
Simon Glassd51004a2012-03-30 21:30:55 +0000158 return run_command_list((char *)data, len, 0);
wdenkd0dd1072002-10-20 17:17:16 +0000159}
160
wdenk8bde7f72003-06-27 21:31:46 +0000161/**************************************************/
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200162#if defined(CONFIG_CMD_SOURCE)
Jeroen Hofstee0e350f82014-06-23 00:22:08 +0200163static int do_source(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
wdenkd0dd1072002-10-20 17:17:16 +0000164{
165 ulong addr;
166 int rcode;
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100167 const char *fit_uname = NULL;
wdenkd0dd1072002-10-20 17:17:16 +0000168
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100169 /* Find script image */
wdenkd0dd1072002-10-20 17:17:16 +0000170 if (argc < 2) {
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200171 addr = CONFIG_SYS_LOAD_ADDR;
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200172 debug ("* source: default load address = 0x%08lx\n", addr);
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100173#if defined(CONFIG_FIT)
Simon Glassbb872dd2019-12-28 10:45:02 -0700174 } else if (fit_parse_subimage(argv[1], image_load_addr, &addr,
175 &fit_uname)) {
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200176 debug ("* source: subimage '%s' from FIT image at 0x%08lx\n",
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100177 fit_uname, addr);
178#endif
wdenkd0dd1072002-10-20 17:17:16 +0000179 } else {
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100180 addr = simple_strtoul(argv[1], NULL, 16);
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200181 debug ("* source: cmdline image address = 0x%08lx\n", addr);
wdenkd0dd1072002-10-20 17:17:16 +0000182 }
183
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100184 printf ("## Executing script at %08lx\n", addr);
Simon Glass220a3a42019-12-28 10:45:04 -0700185 rcode = image_source_script(addr, fit_uname);
wdenkd0dd1072002-10-20 17:17:16 +0000186 return rcode;
187}
wdenk8bde7f72003-06-27 21:31:46 +0000188
Kim Phillips088f1b12012-10-29 13:34:31 +0000189#ifdef CONFIG_SYS_LONGHELP
190static char source_help_text[] =
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200191 "[addr]\n"
192 "\t- run script starting at addr\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200193 "\t- A valid image header must be present"
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100194#if defined(CONFIG_FIT)
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200195 "\n"
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100196 "For FIT format uImage addr must include subimage\n"
Wolfgang Denka89c33d2009-05-24 17:06:54 +0200197 "unit name in the form of addr:<subimg_uname>"
Jon Loeliger90253172007-07-10 11:02:44 -0500198#endif
Kim Phillips088f1b12012-10-29 13:34:31 +0000199 "";
200#endif
201
202U_BOOT_CMD(
203 source, 2, 0, do_source,
204 "run script from memory", source_help_text
Marian Balakowicz424c4ab2008-03-12 10:33:00 +0100205);
Jon Loeliger90253172007-07-10 11:02:44 -0500206#endif