183d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
22e192b24SSimon Glass /*
32e192b24SSimon Glass * (C) Copyright 2001
42e192b24SSimon Glass * Kyle Harris, kharris@nexus-tech.net
52e192b24SSimon Glass */
62e192b24SSimon Glass
72e192b24SSimon Glass /*
82e192b24SSimon Glass * The "source" command allows to define "script images", i. e. files
92e192b24SSimon Glass * that contain command sequences that can be executed by the command
102e192b24SSimon Glass * interpreter. It returns the exit status of the last command
112e192b24SSimon Glass * executed from the script. This is very similar to running a shell
122e192b24SSimon Glass * script in a UNIX shell, hence the name for the command.
132e192b24SSimon Glass */
142e192b24SSimon Glass
152e192b24SSimon Glass /* #define DEBUG */
162e192b24SSimon Glass
172e192b24SSimon Glass #include <common.h>
182e192b24SSimon Glass #include <command.h>
192e192b24SSimon Glass #include <image.h>
202e192b24SSimon Glass #include <malloc.h>
212e192b24SSimon Glass #include <mapmem.h>
222e192b24SSimon Glass #include <asm/byteorder.h>
232e192b24SSimon Glass #include <asm/io.h>
242e192b24SSimon Glass
25*201d9cd2SAlex Kiernan #if defined(CONFIG_FIT)
26*201d9cd2SAlex Kiernan /**
27*201d9cd2SAlex Kiernan * get_default_image() - Return default property from /images
28*201d9cd2SAlex Kiernan *
29*201d9cd2SAlex Kiernan * Return: Pointer to value of default property (or NULL)
30*201d9cd2SAlex Kiernan */
get_default_image(const void * fit)31*201d9cd2SAlex Kiernan static const char *get_default_image(const void *fit)
32*201d9cd2SAlex Kiernan {
33*201d9cd2SAlex Kiernan int images_noffset;
34*201d9cd2SAlex Kiernan
35*201d9cd2SAlex Kiernan images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
36*201d9cd2SAlex Kiernan if (images_noffset < 0)
37*201d9cd2SAlex Kiernan return NULL;
38*201d9cd2SAlex Kiernan
39*201d9cd2SAlex Kiernan return fdt_getprop(fit, images_noffset, FIT_DEFAULT_PROP, NULL);
40*201d9cd2SAlex Kiernan }
41*201d9cd2SAlex Kiernan #endif
42*201d9cd2SAlex Kiernan
432e192b24SSimon Glass int
source(ulong addr,const char * fit_uname)442e192b24SSimon Glass source (ulong addr, const char *fit_uname)
452e192b24SSimon Glass {
462e192b24SSimon Glass ulong len;
472e192b24SSimon Glass #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
482e192b24SSimon Glass const image_header_t *hdr;
492e192b24SSimon Glass #endif
502e192b24SSimon Glass u32 *data;
512e192b24SSimon Glass int verify;
522e192b24SSimon Glass void *buf;
532e192b24SSimon Glass #if defined(CONFIG_FIT)
542e192b24SSimon Glass const void* fit_hdr;
552e192b24SSimon Glass int noffset;
562e192b24SSimon Glass const void *fit_data;
572e192b24SSimon Glass size_t fit_len;
582e192b24SSimon Glass #endif
592e192b24SSimon Glass
60bfebc8c9SSimon Glass verify = env_get_yesno("verify");
612e192b24SSimon Glass
622e192b24SSimon Glass buf = map_sysmem(addr, 0);
632e192b24SSimon Glass switch (genimg_get_format(buf)) {
642e192b24SSimon Glass #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
652e192b24SSimon Glass case IMAGE_FORMAT_LEGACY:
662e192b24SSimon Glass hdr = buf;
672e192b24SSimon Glass
682e192b24SSimon Glass if (!image_check_magic (hdr)) {
692e192b24SSimon Glass puts ("Bad magic number\n");
702e192b24SSimon Glass return 1;
712e192b24SSimon Glass }
722e192b24SSimon Glass
732e192b24SSimon Glass if (!image_check_hcrc (hdr)) {
742e192b24SSimon Glass puts ("Bad header crc\n");
752e192b24SSimon Glass return 1;
762e192b24SSimon Glass }
772e192b24SSimon Glass
782e192b24SSimon Glass if (verify) {
792e192b24SSimon Glass if (!image_check_dcrc (hdr)) {
802e192b24SSimon Glass puts ("Bad data crc\n");
812e192b24SSimon Glass return 1;
822e192b24SSimon Glass }
832e192b24SSimon Glass }
842e192b24SSimon Glass
852e192b24SSimon Glass if (!image_check_type (hdr, IH_TYPE_SCRIPT)) {
862e192b24SSimon Glass puts ("Bad image type\n");
872e192b24SSimon Glass return 1;
882e192b24SSimon Glass }
892e192b24SSimon Glass
902e192b24SSimon Glass /* get length of script */
912e192b24SSimon Glass data = (u32 *)image_get_data (hdr);
922e192b24SSimon Glass
932e192b24SSimon Glass if ((len = uimage_to_cpu (*data)) == 0) {
942e192b24SSimon Glass puts ("Empty Script\n");
952e192b24SSimon Glass return 1;
962e192b24SSimon Glass }
972e192b24SSimon Glass
982e192b24SSimon Glass /*
992e192b24SSimon Glass * scripts are just multi-image files with one component, seek
1002e192b24SSimon Glass * past the zero-terminated sequence of image lengths to get
1012e192b24SSimon Glass * to the actual image data
1022e192b24SSimon Glass */
1032e192b24SSimon Glass while (*data++);
1042e192b24SSimon Glass break;
1052e192b24SSimon Glass #endif
1062e192b24SSimon Glass #if defined(CONFIG_FIT)
1072e192b24SSimon Glass case IMAGE_FORMAT_FIT:
1082e192b24SSimon Glass fit_hdr = buf;
1092e192b24SSimon Glass if (!fit_check_format (fit_hdr)) {
1102e192b24SSimon Glass puts ("Bad FIT image format\n");
1112e192b24SSimon Glass return 1;
1122e192b24SSimon Glass }
1132e192b24SSimon Glass
114*201d9cd2SAlex Kiernan if (!fit_uname)
115*201d9cd2SAlex Kiernan fit_uname = get_default_image(fit_hdr);
116*201d9cd2SAlex Kiernan
117*201d9cd2SAlex Kiernan if (!fit_uname) {
118*201d9cd2SAlex Kiernan puts("No FIT subimage unit name\n");
119*201d9cd2SAlex Kiernan return 1;
120*201d9cd2SAlex Kiernan }
121*201d9cd2SAlex Kiernan
1222e192b24SSimon Glass /* get script component image node offset */
1232e192b24SSimon Glass noffset = fit_image_get_node (fit_hdr, fit_uname);
1242e192b24SSimon Glass if (noffset < 0) {
1252e192b24SSimon Glass printf ("Can't find '%s' FIT subimage\n", fit_uname);
1262e192b24SSimon Glass return 1;
1272e192b24SSimon Glass }
1282e192b24SSimon Glass
1292e192b24SSimon Glass if (!fit_image_check_type (fit_hdr, noffset, IH_TYPE_SCRIPT)) {
1302e192b24SSimon Glass puts ("Not a image image\n");
1312e192b24SSimon Glass return 1;
1322e192b24SSimon Glass }
1332e192b24SSimon Glass
1342e192b24SSimon Glass /* verify integrity */
1352e192b24SSimon Glass if (verify) {
1362e192b24SSimon Glass if (!fit_image_verify(fit_hdr, noffset)) {
1372e192b24SSimon Glass puts ("Bad Data Hash\n");
1382e192b24SSimon Glass return 1;
1392e192b24SSimon Glass }
1402e192b24SSimon Glass }
1412e192b24SSimon Glass
1422e192b24SSimon Glass /* get script subimage data address and length */
1432e192b24SSimon Glass if (fit_image_get_data (fit_hdr, noffset, &fit_data, &fit_len)) {
1442e192b24SSimon Glass puts ("Could not find script subimage data\n");
1452e192b24SSimon Glass return 1;
1462e192b24SSimon Glass }
1472e192b24SSimon Glass
1482e192b24SSimon Glass data = (u32 *)fit_data;
1492e192b24SSimon Glass len = (ulong)fit_len;
1502e192b24SSimon Glass break;
1512e192b24SSimon Glass #endif
1522e192b24SSimon Glass default:
1532e192b24SSimon Glass puts ("Wrong image format for \"source\" command\n");
1542e192b24SSimon Glass return 1;
1552e192b24SSimon Glass }
1562e192b24SSimon Glass
1572e192b24SSimon Glass debug ("** Script length: %ld\n", len);
1582e192b24SSimon Glass return run_command_list((char *)data, len, 0);
1592e192b24SSimon Glass }
1602e192b24SSimon Glass
1612e192b24SSimon Glass /**************************************************/
1622e192b24SSimon Glass #if defined(CONFIG_CMD_SOURCE)
do_source(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])1632e192b24SSimon Glass static int do_source(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1642e192b24SSimon Glass {
1652e192b24SSimon Glass ulong addr;
1662e192b24SSimon Glass int rcode;
1672e192b24SSimon Glass const char *fit_uname = NULL;
1682e192b24SSimon Glass
1692e192b24SSimon Glass /* Find script image */
1702e192b24SSimon Glass if (argc < 2) {
1712e192b24SSimon Glass addr = CONFIG_SYS_LOAD_ADDR;
1722e192b24SSimon Glass debug ("* source: default load address = 0x%08lx\n", addr);
1732e192b24SSimon Glass #if defined(CONFIG_FIT)
1742e192b24SSimon Glass } else if (fit_parse_subimage (argv[1], load_addr, &addr, &fit_uname)) {
1752e192b24SSimon Glass debug ("* source: subimage '%s' from FIT image at 0x%08lx\n",
1762e192b24SSimon Glass fit_uname, addr);
1772e192b24SSimon Glass #endif
1782e192b24SSimon Glass } else {
1792e192b24SSimon Glass addr = simple_strtoul(argv[1], NULL, 16);
1802e192b24SSimon Glass debug ("* source: cmdline image address = 0x%08lx\n", addr);
1812e192b24SSimon Glass }
1822e192b24SSimon Glass
1832e192b24SSimon Glass printf ("## Executing script at %08lx\n", addr);
1842e192b24SSimon Glass rcode = source (addr, fit_uname);
1852e192b24SSimon Glass return rcode;
1862e192b24SSimon Glass }
1872e192b24SSimon Glass
1882e192b24SSimon Glass #ifdef CONFIG_SYS_LONGHELP
1892e192b24SSimon Glass static char source_help_text[] =
1902e192b24SSimon Glass "[addr]\n"
1912e192b24SSimon Glass "\t- run script starting at addr\n"
1922e192b24SSimon Glass "\t- A valid image header must be present"
1932e192b24SSimon Glass #if defined(CONFIG_FIT)
1942e192b24SSimon Glass "\n"
1952e192b24SSimon Glass "For FIT format uImage addr must include subimage\n"
1962e192b24SSimon Glass "unit name in the form of addr:<subimg_uname>"
1972e192b24SSimon Glass #endif
1982e192b24SSimon Glass "";
1992e192b24SSimon Glass #endif
2002e192b24SSimon Glass
2012e192b24SSimon Glass U_BOOT_CMD(
2022e192b24SSimon Glass source, 2, 0, do_source,
2032e192b24SSimon Glass "run script from memory", source_help_text
2042e192b24SSimon Glass );
2052e192b24SSimon Glass #endif
206