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