xref: /openbmc/u-boot/tools/fit_image.c (revision b46694df)
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  *		FIT image specific code abstracted from mkimage.c
10  *		some functions added to address abstraction
11  *
12  * All rights reserved.
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License as
16  * published by the Free Software Foundation; either version 2 of
17  * the License, or (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
27  * MA 02111-1307 USA
28  */
29 
30 #include "mkimage.h"
31 #include <image.h>
32 #include <u-boot/crc.h>
33 
34 static image_header_t header;
35 
36 static int fit_verify_header (unsigned char *ptr, int image_size,
37 			struct mkimage_params *params)
38 {
39 	return fdt_check_header ((void *)ptr);
40 }
41 
42 static int fit_check_image_types (uint8_t type)
43 {
44 	if (type == IH_TYPE_FLATDT)
45 		return EXIT_SUCCESS;
46 	else
47 		return EXIT_FAILURE;
48 }
49 
50 int mmap_fdt(struct mkimage_params *params, const char *fname, void **blobp,
51 		struct stat *sbuf)
52 {
53 	void *ptr;
54 	int fd;
55 
56 	/* Load FIT blob into memory (we need to write hashes/signatures) */
57 	fd = open(fname, O_RDWR | O_BINARY);
58 
59 	if (fd < 0) {
60 		fprintf(stderr, "%s: Can't open %s: %s\n",
61 			params->cmdname, fname, strerror(errno));
62 		unlink(fname);
63 		return -1;
64 	}
65 
66 	if (fstat(fd, sbuf) < 0) {
67 		fprintf(stderr, "%s: Can't stat %s: %s\n",
68 			params->cmdname, fname, strerror(errno));
69 		unlink(fname);
70 		return -1;
71 	}
72 
73 	ptr = mmap(0, sbuf->st_size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
74 	if (ptr == MAP_FAILED) {
75 		fprintf(stderr, "%s: Can't read %s: %s\n",
76 			params->cmdname, fname, strerror(errno));
77 		unlink(fname);
78 		return -1;
79 	}
80 
81 	/* check if ptr has a valid blob */
82 	if (fdt_check_header(ptr)) {
83 		fprintf(stderr, "%s: Invalid FIT blob\n", params->cmdname);
84 		unlink(fname);
85 		return -1;
86 	}
87 
88 	*blobp = ptr;
89 	return fd;
90 }
91 
92 /**
93  * fit_handle_file - main FIT file processing function
94  *
95  * fit_handle_file() runs dtc to convert .its to .itb, includes
96  * binary data, updates timestamp property and calculates hashes.
97  *
98  * datafile  - .its file
99  * imagefile - .itb file
100  *
101  * returns:
102  *     only on success, otherwise calls exit (EXIT_FAILURE);
103  */
104 static int fit_handle_file (struct mkimage_params *params)
105 {
106 	char tmpfile[MKIMAGE_MAX_TMPFILE_LEN];
107 	char cmd[MKIMAGE_MAX_DTC_CMDLINE_LEN];
108 	int tfd;
109 	struct stat sbuf;
110 	void *ptr;
111 
112 	/* Flattened Image Tree (FIT) format  handling */
113 	debug ("FIT format handling\n");
114 
115 	/* call dtc to include binary properties into the tmp file */
116 	if (strlen (params->imagefile) +
117 		strlen (MKIMAGE_TMPFILE_SUFFIX) + 1 > sizeof (tmpfile)) {
118 		fprintf (stderr, "%s: Image file name (%s) too long, "
119 				"can't create tmpfile",
120 				params->imagefile, params->cmdname);
121 		return (EXIT_FAILURE);
122 	}
123 	sprintf (tmpfile, "%s%s", params->imagefile, MKIMAGE_TMPFILE_SUFFIX);
124 
125 	/* dtc -I dts -O dtb -p 500 datafile > tmpfile */
126 	sprintf (cmd, "%s %s %s > %s",
127 		MKIMAGE_DTC, params->dtc, params->datafile, tmpfile);
128 	debug ("Trying to execute \"%s\"\n", cmd);
129 	if (system (cmd) == -1) {
130 		fprintf (stderr, "%s: system(%s) failed: %s\n",
131 				params->cmdname, cmd, strerror(errno));
132 		goto err_system;
133 	}
134 
135 	tfd = mmap_fdt(params, tmpfile, &ptr, &sbuf);
136 	if (tfd < 0)
137 		goto err_mmap;
138 
139 	/* set hashes for images in the blob */
140 	if (fit_add_verification_data(ptr)) {
141 		fprintf (stderr, "%s Can't add hashes to FIT blob",
142 				params->cmdname);
143 		goto err_add_hashes;
144 	}
145 
146 	/* add a timestamp at offset 0 i.e., root  */
147 	if (fit_set_timestamp (ptr, 0, sbuf.st_mtime)) {
148 		fprintf (stderr, "%s: Can't add image timestamp\n",
149 				params->cmdname);
150 		goto err_add_timestamp;
151 	}
152 	debug ("Added timestamp successfully\n");
153 
154 	munmap ((void *)ptr, sbuf.st_size);
155 	close (tfd);
156 
157 	if (rename (tmpfile, params->imagefile) == -1) {
158 		fprintf (stderr, "%s: Can't rename %s to %s: %s\n",
159 				params->cmdname, tmpfile, params->imagefile,
160 				strerror (errno));
161 		unlink (tmpfile);
162 		unlink (params->imagefile);
163 		return (EXIT_FAILURE);
164 	}
165 	return (EXIT_SUCCESS);
166 
167 err_add_timestamp:
168 err_add_hashes:
169 	munmap(ptr, sbuf.st_size);
170 err_mmap:
171 err_system:
172 	unlink(tmpfile);
173 	return -1;
174 }
175 
176 static int fit_check_params (struct mkimage_params *params)
177 {
178 	return	((params->dflag && (params->fflag || params->lflag)) ||
179 		(params->fflag && (params->dflag || params->lflag)) ||
180 		(params->lflag && (params->dflag || params->fflag)));
181 }
182 
183 static struct image_type_params fitimage_params = {
184 	.name = "FIT Image support",
185 	.header_size = sizeof(image_header_t),
186 	.hdr = (void*)&header,
187 	.verify_header = fit_verify_header,
188 	.print_header = fit_print_contents,
189 	.check_image_type = fit_check_image_types,
190 	.fflag_handle = fit_handle_file,
191 	.set_header = NULL,	/* FIT images use DTB header */
192 	.check_params = fit_check_params,
193 };
194 
195 void init_fit_image_type (void)
196 {
197 	mkimage_register (&fitimage_params);
198 }
199