xref: /openbmc/u-boot/tools/default_image.c (revision 2399e401)
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) || (type == IH_TYPE_FIRMWARE_IVT))
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 	time_t time;
92 	uint32_t imagesize;
93 
94 	image_header_t * hdr = (image_header_t *)ptr;
95 
96 	checksum = crc32(0,
97 			(const unsigned char *)(ptr +
98 				sizeof(image_header_t)),
99 			sbuf->st_size - sizeof(image_header_t));
100 
101 	time = imagetool_get_source_date(params, sbuf->st_mtime);
102 	if (params->type == IH_TYPE_FIRMWARE_IVT)
103 		/* Add size of CSF minus IVT */
104 		imagesize = sbuf->st_size - sizeof(image_header_t) + 0x1FE0;
105 	else
106 		imagesize = sbuf->st_size - sizeof(image_header_t);
107 
108 	/* Build new header */
109 	image_set_magic(hdr, IH_MAGIC);
110 	image_set_time(hdr, time);
111 	image_set_size(hdr, imagesize);
112 	image_set_load(hdr, params->addr);
113 	image_set_ep(hdr, params->ep);
114 	image_set_dcrc(hdr, checksum);
115 	image_set_os(hdr, params->os);
116 	image_set_arch(hdr, params->arch);
117 	image_set_type(hdr, params->type);
118 	image_set_comp(hdr, params->comp);
119 
120 	image_set_name(hdr, params->imagename);
121 
122 	checksum = crc32(0, (const unsigned char *)hdr,
123 				sizeof(image_header_t));
124 
125 	image_set_hcrc(hdr, checksum);
126 }
127 
128 static int image_extract_subimage(void *ptr, struct image_tool_params *params)
129 {
130 	const image_header_t *hdr = (const image_header_t *)ptr;
131 	ulong file_data;
132 	ulong file_len;
133 
134 	if (image_check_type(hdr, IH_TYPE_MULTI)) {
135 		ulong idx = params->pflag;
136 		ulong count;
137 
138 		/* get the number of data files present in the image */
139 		count = image_multi_count(hdr);
140 
141 		/* retrieve the "data file" at the idx position */
142 		image_multi_getimg(hdr, idx, &file_data, &file_len);
143 
144 		if ((file_len == 0) || (idx >= count)) {
145 			fprintf(stderr, "%s: No such data file %ld in \"%s\"\n",
146 				params->cmdname, idx, params->imagefile);
147 			return -1;
148 		}
149 	} else {
150 		file_data = image_get_data(hdr);
151 		file_len = image_get_size(hdr);
152 	}
153 
154 	/* save the "data file" into the file system */
155 	return imagetool_save_subimage(params->outfile, file_data, file_len);
156 }
157 
158 /*
159  * Default image type parameters definition
160  */
161 U_BOOT_IMAGE_TYPE(
162 	defimage,
163 	"Default Image support",
164 	sizeof(image_header_t),
165 	(void *)&header,
166 	image_check_params,
167 	image_verify_header,
168 	image_print_contents,
169 	image_set_header,
170 	image_extract_subimage,
171 	image_check_image_types,
172 	NULL,
173 	NULL
174 );
175