xref: /openbmc/u-boot/tools/default_image.c (revision 0c01c3e8)
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2004
5  * DENX Software Engineering
6  * Wolfgang Denk, wd@denx.de
7  *
8  * Updated-by: Prafulla Wadaskar <prafulla@marvell.com>
9  *		default_image specific code abstracted from mkimage.c
10  *		some functions added to address abstraction
11  *
12  * All rights reserved.
13  *
14  * SPDX-License-Identifier:	GPL-2.0+
15  */
16 
17 #include "imagetool.h"
18 #include "mkimage.h"
19 
20 #include <image.h>
21 #include <u-boot/crc.h>
22 
23 static image_header_t header;
24 
25 static int image_check_image_types(uint8_t type)
26 {
27 	if (((type > IH_TYPE_INVALID) && (type < IH_TYPE_FLATDT)) ||
28 	    (type == IH_TYPE_KERNEL_NOLOAD))
29 		return EXIT_SUCCESS;
30 	else
31 		return EXIT_FAILURE;
32 }
33 
34 static int image_check_params(struct image_tool_params *params)
35 {
36 	return	((params->dflag && (params->fflag || params->lflag)) ||
37 		(params->fflag && (params->dflag || params->lflag)) ||
38 		(params->lflag && (params->dflag || params->fflag)));
39 }
40 
41 static int image_verify_header(unsigned char *ptr, int image_size,
42 			struct image_tool_params *params)
43 {
44 	uint32_t len;
45 	const unsigned char *data;
46 	uint32_t checksum;
47 	image_header_t header;
48 	image_header_t *hdr = &header;
49 
50 	/*
51 	 * create copy of header so that we can blank out the
52 	 * checksum field for checking - this can't be done
53 	 * on the PROT_READ mapped data.
54 	 */
55 	memcpy(hdr, ptr, sizeof(image_header_t));
56 
57 	if (be32_to_cpu(hdr->ih_magic) != IH_MAGIC) {
58 		debug("%s: Bad Magic Number: \"%s\" is no valid image\n",
59 		      params->cmdname, params->imagefile);
60 		return -FDT_ERR_BADMAGIC;
61 	}
62 
63 	data = (const unsigned char *)hdr;
64 	len  = sizeof(image_header_t);
65 
66 	checksum = be32_to_cpu(hdr->ih_hcrc);
67 	hdr->ih_hcrc = cpu_to_be32(0);	/* clear for re-calculation */
68 
69 	if (crc32(0, data, len) != checksum) {
70 		debug("%s: ERROR: \"%s\" has bad header checksum!\n",
71 		      params->cmdname, params->imagefile);
72 		return -FDT_ERR_BADSTATE;
73 	}
74 
75 	data = (const unsigned char *)ptr + sizeof(image_header_t);
76 	len  = image_size - sizeof(image_header_t) ;
77 
78 	checksum = be32_to_cpu(hdr->ih_dcrc);
79 	if (crc32(0, data, len) != checksum) {
80 		debug("%s: ERROR: \"%s\" has corrupted data!\n",
81 		      params->cmdname, params->imagefile);
82 		return -FDT_ERR_BADSTRUCTURE;
83 	}
84 	return 0;
85 }
86 
87 static void image_set_header(void *ptr, struct stat *sbuf, int ifd,
88 				struct image_tool_params *params)
89 {
90 	uint32_t checksum;
91 	char *source_date_epoch;
92 	struct tm *time_universal;
93 	time_t time;
94 
95 	image_header_t * hdr = (image_header_t *)ptr;
96 
97 	checksum = crc32(0,
98 			(const unsigned char *)(ptr +
99 				sizeof(image_header_t)),
100 			sbuf->st_size - sizeof(image_header_t));
101 
102 	source_date_epoch = getenv("SOURCE_DATE_EPOCH");
103 	if (source_date_epoch != NULL) {
104 		time = (time_t) strtol(source_date_epoch, NULL, 10);
105 
106 		time_universal = gmtime(&time);
107 		if (time_universal == NULL) {
108 			fprintf(stderr, "%s: SOURCE_DATE_EPOCH is not valid\n",
109 				__func__);
110 			time = 0;
111 		} else {
112 			time = mktime(time_universal);
113 		}
114 	} else {
115 		time = sbuf->st_mtime;
116 	}
117 
118 	/* Build new header */
119 	image_set_magic(hdr, IH_MAGIC);
120 	image_set_time(hdr, time);
121 	image_set_size(hdr, sbuf->st_size - sizeof(image_header_t));
122 	image_set_load(hdr, params->addr);
123 	image_set_ep(hdr, params->ep);
124 	image_set_dcrc(hdr, checksum);
125 	image_set_os(hdr, params->os);
126 	image_set_arch(hdr, params->arch);
127 	image_set_type(hdr, params->type);
128 	image_set_comp(hdr, params->comp);
129 
130 	image_set_name(hdr, params->imagename);
131 
132 	checksum = crc32(0, (const unsigned char *)hdr,
133 				sizeof(image_header_t));
134 
135 	image_set_hcrc(hdr, checksum);
136 }
137 
138 static int image_extract_subimage(void *ptr, struct image_tool_params *params)
139 {
140 	const image_header_t *hdr = (const image_header_t *)ptr;
141 	ulong file_data;
142 	ulong file_len;
143 
144 	if (image_check_type(hdr, IH_TYPE_MULTI)) {
145 		ulong idx = params->pflag;
146 		ulong count;
147 
148 		/* get the number of data files present in the image */
149 		count = image_multi_count(hdr);
150 
151 		/* retrieve the "data file" at the idx position */
152 		image_multi_getimg(hdr, idx, &file_data, &file_len);
153 
154 		if ((file_len == 0) || (idx >= count)) {
155 			fprintf(stderr, "%s: No such data file %ld in \"%s\"\n",
156 				params->cmdname, idx, params->imagefile);
157 			return -1;
158 		}
159 	} else {
160 		file_data = image_get_data(hdr);
161 		file_len = image_get_size(hdr);
162 	}
163 
164 	/* save the "data file" into the file system */
165 	return imagetool_save_subimage(params->outfile, file_data, file_len);
166 }
167 
168 /*
169  * Default image type parameters definition
170  */
171 U_BOOT_IMAGE_TYPE(
172 	defimage,
173 	"Default Image support",
174 	sizeof(image_header_t),
175 	(void *)&header,
176 	image_check_params,
177 	image_verify_header,
178 	image_print_contents,
179 	image_set_header,
180 	image_extract_subimage,
181 	image_check_image_types,
182 	NULL,
183 	NULL
184 );
185