xref: /rk3399_ARM-atf/tools/fiptool/fiptool.c (revision 9df69ba37f3dd3a3f02fc8c0ba41236960b6b771)
1819281eeSdp-arm /*
2819281eeSdp-arm  * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
3819281eeSdp-arm  *
4819281eeSdp-arm  * Redistribution and use in source and binary forms, with or without
5819281eeSdp-arm  * modification, are permitted provided that the following conditions are met:
6819281eeSdp-arm  *
7819281eeSdp-arm  * Redistributions of source code must retain the above copyright notice, this
8819281eeSdp-arm  * list of conditions and the following disclaimer.
9819281eeSdp-arm  *
10819281eeSdp-arm  * Redistributions in binary form must reproduce the above copyright notice,
11819281eeSdp-arm  * this list of conditions and the following disclaimer in the documentation
12819281eeSdp-arm  * and/or other materials provided with the distribution.
13819281eeSdp-arm  *
14819281eeSdp-arm  * Neither the name of ARM nor the names of its contributors may be used
15819281eeSdp-arm  * to endorse or promote products derived from this software without specific
16819281eeSdp-arm  * prior written permission.
17819281eeSdp-arm  *
18819281eeSdp-arm  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19819281eeSdp-arm  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20819281eeSdp-arm  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21819281eeSdp-arm  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22819281eeSdp-arm  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23819281eeSdp-arm  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24819281eeSdp-arm  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25819281eeSdp-arm  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26819281eeSdp-arm  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27819281eeSdp-arm  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28819281eeSdp-arm  * POSSIBILITY OF SUCH DAMAGE.
29819281eeSdp-arm  */
30819281eeSdp-arm 
31819281eeSdp-arm #include <sys/types.h>
32819281eeSdp-arm #include <sys/stat.h>
33819281eeSdp-arm 
34819281eeSdp-arm #include <assert.h>
35819281eeSdp-arm #include <errno.h>
36819281eeSdp-arm #include <getopt.h>
37819281eeSdp-arm #include <limits.h>
38819281eeSdp-arm #include <stdarg.h>
39819281eeSdp-arm #include <stdint.h>
40819281eeSdp-arm #include <stdio.h>
41819281eeSdp-arm #include <stdlib.h>
42819281eeSdp-arm #include <string.h>
43819281eeSdp-arm #include <unistd.h>
44819281eeSdp-arm 
45*9df69ba3Sdp-arm #include <openssl/sha.h>
46*9df69ba3Sdp-arm 
47819281eeSdp-arm #include "fiptool.h"
48819281eeSdp-arm #include "firmware_image_package.h"
49819281eeSdp-arm #include "tbbr_config.h"
50819281eeSdp-arm 
51819281eeSdp-arm #define OPT_TOC_ENTRY 0
52819281eeSdp-arm #define OPT_PLAT_TOC_FLAGS 1
53819281eeSdp-arm 
54819281eeSdp-arm static int info_cmd(int argc, char *argv[]);
55819281eeSdp-arm static void info_usage(void);
56819281eeSdp-arm static int create_cmd(int argc, char *argv[]);
57819281eeSdp-arm static void create_usage(void);
58819281eeSdp-arm static int update_cmd(int argc, char *argv[]);
59819281eeSdp-arm static void update_usage(void);
60819281eeSdp-arm static int unpack_cmd(int argc, char *argv[]);
61819281eeSdp-arm static void unpack_usage(void);
62819281eeSdp-arm static int remove_cmd(int argc, char *argv[]);
63819281eeSdp-arm static void remove_usage(void);
64819281eeSdp-arm static int version_cmd(int argc, char *argv[]);
65819281eeSdp-arm static void version_usage(void);
66819281eeSdp-arm static int help_cmd(int argc, char *argv[]);
67819281eeSdp-arm static void usage(void);
68819281eeSdp-arm 
69819281eeSdp-arm /* Available subcommands. */
70819281eeSdp-arm static cmd_t cmds[] = {
71819281eeSdp-arm 	{ .name = "info",    .handler = info_cmd,    .usage = info_usage    },
72819281eeSdp-arm 	{ .name = "create",  .handler = create_cmd,  .usage = create_usage  },
73819281eeSdp-arm 	{ .name = "update",  .handler = update_cmd,  .usage = update_usage  },
74819281eeSdp-arm 	{ .name = "unpack",  .handler = unpack_cmd,  .usage = unpack_usage  },
75819281eeSdp-arm 	{ .name = "remove",  .handler = remove_cmd,  .usage = remove_usage  },
76819281eeSdp-arm 	{ .name = "version", .handler = version_cmd, .usage = version_usage },
77819281eeSdp-arm 	{ .name = "help",    .handler = help_cmd,    .usage = NULL          },
78819281eeSdp-arm };
79819281eeSdp-arm 
80819281eeSdp-arm static image_t *images[MAX_IMAGES];
81819281eeSdp-arm static size_t nr_images;
82819281eeSdp-arm static uuid_t uuid_null = { 0 };
83819281eeSdp-arm static int verbose;
84819281eeSdp-arm 
85819281eeSdp-arm static void vlog(int prio, char *msg, va_list ap)
86819281eeSdp-arm {
87819281eeSdp-arm 	char *prefix[] = { "DEBUG", "WARN", "ERROR" };
88819281eeSdp-arm 
89819281eeSdp-arm 	fprintf(stderr, "%s: ", prefix[prio]);
90819281eeSdp-arm 	vfprintf(stderr, msg, ap);
91819281eeSdp-arm 	fputc('\n', stderr);
92819281eeSdp-arm }
93819281eeSdp-arm 
94819281eeSdp-arm static void log_dbgx(char *msg, ...)
95819281eeSdp-arm {
96819281eeSdp-arm 	va_list ap;
97819281eeSdp-arm 
98819281eeSdp-arm 	va_start(ap, msg);
99819281eeSdp-arm 	vlog(LOG_DBG, msg, ap);
100819281eeSdp-arm 	va_end(ap);
101819281eeSdp-arm }
102819281eeSdp-arm 
103819281eeSdp-arm static void log_warnx(char *msg, ...)
104819281eeSdp-arm {
105819281eeSdp-arm 	va_list ap;
106819281eeSdp-arm 
107819281eeSdp-arm 	va_start(ap, msg);
108819281eeSdp-arm 	vlog(LOG_WARN, msg, ap);
109819281eeSdp-arm 	va_end(ap);
110819281eeSdp-arm }
111819281eeSdp-arm 
112819281eeSdp-arm static void log_err(char *msg, ...)
113819281eeSdp-arm {
114819281eeSdp-arm 	char buf[512];
115819281eeSdp-arm 	va_list ap;
116819281eeSdp-arm 
117819281eeSdp-arm 	va_start(ap, msg);
118819281eeSdp-arm 	snprintf(buf, sizeof(buf), "%s: %s", msg, strerror(errno));
119819281eeSdp-arm 	vlog(LOG_ERR, buf, ap);
120819281eeSdp-arm 	va_end(ap);
121819281eeSdp-arm 	exit(1);
122819281eeSdp-arm }
123819281eeSdp-arm 
124819281eeSdp-arm static void log_errx(char *msg, ...)
125819281eeSdp-arm {
126819281eeSdp-arm 	va_list ap;
127819281eeSdp-arm 
128819281eeSdp-arm 	va_start(ap, msg);
129819281eeSdp-arm 	vlog(LOG_ERR, msg, ap);
130819281eeSdp-arm 	va_end(ap);
131819281eeSdp-arm 	exit(1);
132819281eeSdp-arm }
133819281eeSdp-arm 
134819281eeSdp-arm static void add_image(image_t *image)
135819281eeSdp-arm {
136819281eeSdp-arm 	if (nr_images + 1 > MAX_IMAGES)
137819281eeSdp-arm 		log_errx("Too many images");
138819281eeSdp-arm 	images[nr_images++] = image;
139819281eeSdp-arm }
140819281eeSdp-arm 
141819281eeSdp-arm static void free_image(image_t *image)
142819281eeSdp-arm {
143819281eeSdp-arm 	free(image->buffer);
144819281eeSdp-arm 	free(image);
145819281eeSdp-arm }
146819281eeSdp-arm 
147819281eeSdp-arm static void replace_image(image_t *image_dst, image_t *image_src)
148819281eeSdp-arm {
149819281eeSdp-arm 	int i;
150819281eeSdp-arm 
151819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
152819281eeSdp-arm 		if (images[i] == image_dst) {
153819281eeSdp-arm 			free_image(images[i]);
154819281eeSdp-arm 			images[i] = image_src;
155819281eeSdp-arm 			break;
156819281eeSdp-arm 		}
157819281eeSdp-arm 	}
158819281eeSdp-arm 	assert(i != nr_images);
159819281eeSdp-arm }
160819281eeSdp-arm 
161819281eeSdp-arm static void remove_image(image_t *image)
162819281eeSdp-arm {
163819281eeSdp-arm 	int i;
164819281eeSdp-arm 
165819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
166819281eeSdp-arm 		if (images[i] == image) {
167819281eeSdp-arm 			free_image(images[i]);
168819281eeSdp-arm 			images[i] = NULL;
169819281eeSdp-arm 			break;
170819281eeSdp-arm 		}
171819281eeSdp-arm 	}
172819281eeSdp-arm 	assert(i != nr_images);
173819281eeSdp-arm 
174819281eeSdp-arm 	/* Compact array. */
175819281eeSdp-arm 	memmove(&images[i], &images[i + 1],
176819281eeSdp-arm 	    (nr_images - i - 1) * sizeof(*images));
177819281eeSdp-arm 	nr_images--;
178819281eeSdp-arm }
179819281eeSdp-arm 
180819281eeSdp-arm static void free_images(void)
181819281eeSdp-arm {
182819281eeSdp-arm 	int i;
183819281eeSdp-arm 
184819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
185819281eeSdp-arm 		free_image(images[i]);
186819281eeSdp-arm 		images[i] = NULL;
187819281eeSdp-arm 	}
188819281eeSdp-arm }
189819281eeSdp-arm 
190819281eeSdp-arm static toc_entry_t *get_entry_lookup_from_uuid(const uuid_t *uuid)
191819281eeSdp-arm {
192819281eeSdp-arm 	toc_entry_t *toc_entry = toc_entries;
193819281eeSdp-arm 
194819281eeSdp-arm 	for (; toc_entry->cmdline_name != NULL; toc_entry++)
195819281eeSdp-arm 		if (memcmp(&toc_entry->uuid, uuid, sizeof(uuid_t)) == 0)
196819281eeSdp-arm 			return toc_entry;
197819281eeSdp-arm 	return NULL;
198819281eeSdp-arm }
199819281eeSdp-arm 
200819281eeSdp-arm static int parse_fip(char *filename, fip_toc_header_t *toc_header_out)
201819281eeSdp-arm {
202819281eeSdp-arm 	struct stat st;
203819281eeSdp-arm 	FILE *fp;
204819281eeSdp-arm 	char *buf, *bufend;
205819281eeSdp-arm 	fip_toc_header_t *toc_header;
206819281eeSdp-arm 	fip_toc_entry_t *toc_entry;
207819281eeSdp-arm 	image_t *image;
208819281eeSdp-arm 	int terminated = 0;
209819281eeSdp-arm 
210819281eeSdp-arm 	fp = fopen(filename, "r");
211819281eeSdp-arm 	if (fp == NULL)
212819281eeSdp-arm 		log_err("fopen %s", filename);
213819281eeSdp-arm 
214819281eeSdp-arm 	if (fstat(fileno(fp), &st) == -1)
215819281eeSdp-arm 		log_err("fstat %s", filename);
216819281eeSdp-arm 
217819281eeSdp-arm 	buf = malloc(st.st_size);
218819281eeSdp-arm 	if (buf == NULL)
219819281eeSdp-arm 		log_err("malloc");
220819281eeSdp-arm 
221819281eeSdp-arm 	if (fread(buf, 1, st.st_size, fp) != st.st_size)
222819281eeSdp-arm 		log_errx("Failed to read %s", filename);
223819281eeSdp-arm 	bufend = buf + st.st_size;
224819281eeSdp-arm 	fclose(fp);
225819281eeSdp-arm 
226819281eeSdp-arm 	if (st.st_size < sizeof(fip_toc_header_t))
227819281eeSdp-arm 		log_errx("FIP %s is truncated", filename);
228819281eeSdp-arm 
229819281eeSdp-arm 	toc_header = (fip_toc_header_t *)buf;
230819281eeSdp-arm 	toc_entry = (fip_toc_entry_t *)(toc_header + 1);
231819281eeSdp-arm 
232819281eeSdp-arm 	if (toc_header->name != TOC_HEADER_NAME)
233819281eeSdp-arm 		log_errx("%s is not a FIP file", filename);
234819281eeSdp-arm 
235819281eeSdp-arm 	/* Return the ToC header if the caller wants it. */
236819281eeSdp-arm 	if (toc_header_out != NULL)
237819281eeSdp-arm 		*toc_header_out = *toc_header;
238819281eeSdp-arm 
239819281eeSdp-arm 	/* Walk through each ToC entry in the file. */
240819281eeSdp-arm 	while ((char *)toc_entry + sizeof(*toc_entry) - 1 < bufend) {
241819281eeSdp-arm 		/* Found the ToC terminator, we are done. */
242819281eeSdp-arm 		if (memcmp(&toc_entry->uuid, &uuid_null, sizeof(uuid_t)) == 0) {
243819281eeSdp-arm 			terminated = 1;
244819281eeSdp-arm 			break;
245819281eeSdp-arm 		}
246819281eeSdp-arm 
247819281eeSdp-arm 		/*
248819281eeSdp-arm 		 * Build a new image out of the ToC entry and add it to the
249819281eeSdp-arm 		 * table of images.
250819281eeSdp-arm 		 */
251819281eeSdp-arm 		image = malloc(sizeof(*image));
252819281eeSdp-arm 		if (image == NULL)
253819281eeSdp-arm 			log_err("malloc");
254819281eeSdp-arm 
255819281eeSdp-arm 		memcpy(&image->uuid, &toc_entry->uuid, sizeof(uuid_t));
256819281eeSdp-arm 
257819281eeSdp-arm 		image->buffer = malloc(toc_entry->size);
258819281eeSdp-arm 		if (image->buffer == NULL)
259819281eeSdp-arm 			log_err("malloc");
260819281eeSdp-arm 
261819281eeSdp-arm 		/* Overflow checks before memory copy. */
262819281eeSdp-arm 		if (toc_entry->size > (uint64_t)-1 - toc_entry->offset_address)
263819281eeSdp-arm 			log_errx("FIP %s is corrupted", filename);
264819281eeSdp-arm 		if (toc_entry->size + toc_entry->offset_address > st.st_size)
265819281eeSdp-arm 			log_errx("FIP %s is corrupted", filename);
266819281eeSdp-arm 
267819281eeSdp-arm 		memcpy(image->buffer, buf + toc_entry->offset_address,
268819281eeSdp-arm 		    toc_entry->size);
269819281eeSdp-arm 		image->size = toc_entry->size;
270819281eeSdp-arm 
271819281eeSdp-arm 		image->toc_entry = get_entry_lookup_from_uuid(&toc_entry->uuid);
272819281eeSdp-arm 		if (image->toc_entry == NULL) {
273819281eeSdp-arm 			add_image(image);
274819281eeSdp-arm 			toc_entry++;
275819281eeSdp-arm 			continue;
276819281eeSdp-arm 		}
277819281eeSdp-arm 
278819281eeSdp-arm 		assert(image->toc_entry->image == NULL);
279819281eeSdp-arm 		/* Link backpointer from lookup entry. */
280819281eeSdp-arm 		image->toc_entry->image = image;
281819281eeSdp-arm 		add_image(image);
282819281eeSdp-arm 
283819281eeSdp-arm 		toc_entry++;
284819281eeSdp-arm 	}
285819281eeSdp-arm 
286819281eeSdp-arm 	if (terminated == 0)
287819281eeSdp-arm 		log_errx("FIP %s does not have a ToC terminator entry",
288819281eeSdp-arm 		    filename);
289819281eeSdp-arm 	free(buf);
290819281eeSdp-arm 	return 0;
291819281eeSdp-arm }
292819281eeSdp-arm 
293819281eeSdp-arm static image_t *read_image_from_file(toc_entry_t *toc_entry, char *filename)
294819281eeSdp-arm {
295819281eeSdp-arm 	struct stat st;
296819281eeSdp-arm 	image_t *image;
297819281eeSdp-arm 	FILE *fp;
298819281eeSdp-arm 
299819281eeSdp-arm 	fp = fopen(filename, "r");
300819281eeSdp-arm 	if (fp == NULL)
301819281eeSdp-arm 		log_err("fopen %s", filename);
302819281eeSdp-arm 
303819281eeSdp-arm 	if (fstat(fileno(fp), &st) == -1)
304819281eeSdp-arm 		log_errx("fstat %s", filename);
305819281eeSdp-arm 
306819281eeSdp-arm 	image = malloc(sizeof(*image));
307819281eeSdp-arm 	if (image == NULL)
308819281eeSdp-arm 		log_err("malloc");
309819281eeSdp-arm 
310819281eeSdp-arm 	memcpy(&image->uuid, &toc_entry->uuid, sizeof(uuid_t));
311819281eeSdp-arm 
312819281eeSdp-arm 	image->buffer = malloc(st.st_size);
313819281eeSdp-arm 	if (image->buffer == NULL)
314819281eeSdp-arm 		log_err("malloc");
315819281eeSdp-arm 	if (fread(image->buffer, 1, st.st_size, fp) != st.st_size)
316819281eeSdp-arm 		log_errx("Failed to read %s", filename);
317819281eeSdp-arm 	image->size = st.st_size;
318819281eeSdp-arm 	image->toc_entry = toc_entry;
319819281eeSdp-arm 
320819281eeSdp-arm 	fclose(fp);
321819281eeSdp-arm 	return image;
322819281eeSdp-arm }
323819281eeSdp-arm 
324819281eeSdp-arm static int write_image_to_file(image_t *image, char *filename)
325819281eeSdp-arm {
326819281eeSdp-arm 	FILE *fp;
327819281eeSdp-arm 
328819281eeSdp-arm 	fp = fopen(filename, "w");
329819281eeSdp-arm 	if (fp == NULL)
330819281eeSdp-arm 		log_err("fopen");
331819281eeSdp-arm 	if (fwrite(image->buffer, 1, image->size, fp) != image->size)
332819281eeSdp-arm 		log_errx("Failed to write %s", filename);
333819281eeSdp-arm 	fclose(fp);
334819281eeSdp-arm 	return 0;
335819281eeSdp-arm }
336819281eeSdp-arm 
337819281eeSdp-arm static int fill_common_opts(struct option *opts, int has_arg)
338819281eeSdp-arm {
339819281eeSdp-arm 	int i;
340819281eeSdp-arm 
341819281eeSdp-arm 	for (i = 0; toc_entries[i].cmdline_name != NULL; i++) {
342819281eeSdp-arm 		opts[i].name = toc_entries[i].cmdline_name;
343819281eeSdp-arm 		opts[i].has_arg = has_arg;
344819281eeSdp-arm 		opts[i].flag = NULL;
345819281eeSdp-arm 		opts[i].val = 0;
346819281eeSdp-arm 	}
347819281eeSdp-arm 	return i;
348819281eeSdp-arm }
349819281eeSdp-arm 
350819281eeSdp-arm static void add_opt(struct option *opts, int idx, char *name,
351819281eeSdp-arm     int has_arg, int val)
352819281eeSdp-arm {
353819281eeSdp-arm 	opts[idx].name = name;
354819281eeSdp-arm 	opts[idx].has_arg = has_arg;
355819281eeSdp-arm 	opts[idx].flag = NULL;
356819281eeSdp-arm 	opts[idx].val = val;
357819281eeSdp-arm }
358819281eeSdp-arm 
359*9df69ba3Sdp-arm static void md_print(unsigned char *md, size_t len)
360*9df69ba3Sdp-arm {
361*9df69ba3Sdp-arm 	size_t i;
362*9df69ba3Sdp-arm 
363*9df69ba3Sdp-arm 	for (i = 0; i < len; i++)
364*9df69ba3Sdp-arm 		printf("%02x", md[i]);
365*9df69ba3Sdp-arm }
366*9df69ba3Sdp-arm 
367819281eeSdp-arm static int info_cmd(int argc, char *argv[])
368819281eeSdp-arm {
369819281eeSdp-arm 	image_t *image;
370819281eeSdp-arm 	uint64_t image_offset;
371819281eeSdp-arm 	uint64_t image_size = 0;
372819281eeSdp-arm 	fip_toc_header_t toc_header;
373819281eeSdp-arm 	int i;
374819281eeSdp-arm 
375819281eeSdp-arm 	if (argc != 2)
376819281eeSdp-arm 		usage();
377819281eeSdp-arm 	argc--, argv++;
378819281eeSdp-arm 
379819281eeSdp-arm 	parse_fip(argv[0], &toc_header);
380819281eeSdp-arm 
381819281eeSdp-arm 	if (verbose) {
382819281eeSdp-arm 		log_dbgx("toc_header[name]: 0x%llX",
383819281eeSdp-arm 		    (unsigned long long)toc_header.name);
384819281eeSdp-arm 		log_dbgx("toc_header[serial_number]: 0x%llX",
385819281eeSdp-arm 		    (unsigned long long)toc_header.serial_number);
386819281eeSdp-arm 		log_dbgx("toc_header[flags]: 0x%llX",
387819281eeSdp-arm 		    (unsigned long long)toc_header.flags);
388819281eeSdp-arm 	}
389819281eeSdp-arm 
390819281eeSdp-arm 	image_offset = sizeof(fip_toc_header_t) +
391819281eeSdp-arm 	    (sizeof(fip_toc_entry_t) * (nr_images + 1));
392819281eeSdp-arm 
393819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
394819281eeSdp-arm 		image = images[i];
395819281eeSdp-arm 		if (image->toc_entry != NULL)
396819281eeSdp-arm 			printf("%s: ", image->toc_entry->name);
397819281eeSdp-arm 		else
398819281eeSdp-arm 			printf("Unknown entry: ");
399819281eeSdp-arm 		image_size = image->size;
400819281eeSdp-arm 		printf("offset=0x%llX, size=0x%llX",
401819281eeSdp-arm 		    (unsigned long long)image_offset,
402819281eeSdp-arm 		    (unsigned long long)image_size);
403819281eeSdp-arm 		if (image->toc_entry != NULL)
404*9df69ba3Sdp-arm 			printf(", cmdline=\"--%s\"",
405819281eeSdp-arm 			    image->toc_entry->cmdline_name);
406*9df69ba3Sdp-arm 		if (verbose) {
407*9df69ba3Sdp-arm 			unsigned char md[SHA256_DIGEST_LENGTH];
408*9df69ba3Sdp-arm 
409*9df69ba3Sdp-arm 			SHA256(image->buffer, image_size, md);
410*9df69ba3Sdp-arm 			printf(", sha256=");
411*9df69ba3Sdp-arm 			md_print(md, sizeof(md));
412*9df69ba3Sdp-arm 		}
413819281eeSdp-arm 		putchar('\n');
414819281eeSdp-arm 		image_offset += image_size;
415819281eeSdp-arm 	}
416819281eeSdp-arm 
417819281eeSdp-arm 	free_images();
418819281eeSdp-arm 	return 0;
419819281eeSdp-arm }
420819281eeSdp-arm 
421819281eeSdp-arm static void info_usage(void)
422819281eeSdp-arm {
423819281eeSdp-arm 	printf("fiptool info FIP_FILENAME\n");
424819281eeSdp-arm }
425819281eeSdp-arm 
426819281eeSdp-arm static int pack_images(char *filename, uint64_t toc_flags)
427819281eeSdp-arm {
428819281eeSdp-arm 	FILE *fp;
429819281eeSdp-arm 	image_t *image;
430819281eeSdp-arm 	fip_toc_header_t *toc_header;
431819281eeSdp-arm 	fip_toc_entry_t *toc_entry;
432819281eeSdp-arm 	char *buf;
433819281eeSdp-arm 	uint64_t entry_offset, buf_size, payload_size;
434819281eeSdp-arm 	int i;
435819281eeSdp-arm 
436819281eeSdp-arm 	/* Calculate total payload size and allocate scratch buffer. */
437819281eeSdp-arm 	payload_size = 0;
438819281eeSdp-arm 	for (i = 0; i < nr_images; i++)
439819281eeSdp-arm 		payload_size += images[i]->size;
440819281eeSdp-arm 
441819281eeSdp-arm 	buf_size = sizeof(fip_toc_header_t) +
442819281eeSdp-arm 	    sizeof(fip_toc_entry_t) * (nr_images + 1);
443819281eeSdp-arm 	buf = calloc(1, buf_size);
444819281eeSdp-arm 	if (buf == NULL)
445819281eeSdp-arm 		log_err("calloc");
446819281eeSdp-arm 
447819281eeSdp-arm 	/* Build up header and ToC entries from the image table. */
448819281eeSdp-arm 	toc_header = (fip_toc_header_t *)buf;
449819281eeSdp-arm 	toc_header->name = TOC_HEADER_NAME;
450819281eeSdp-arm 	toc_header->serial_number = TOC_HEADER_SERIAL_NUMBER;
451819281eeSdp-arm 	toc_header->flags = toc_flags;
452819281eeSdp-arm 
453819281eeSdp-arm 	toc_entry = (fip_toc_entry_t *)(toc_header + 1);
454819281eeSdp-arm 
455819281eeSdp-arm 	entry_offset = buf_size;
456819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
457819281eeSdp-arm 		image = images[i];
458819281eeSdp-arm 		memcpy(&toc_entry->uuid, &image->uuid, sizeof(uuid_t));
459819281eeSdp-arm 		toc_entry->offset_address = entry_offset;
460819281eeSdp-arm 		toc_entry->size = image->size;
461819281eeSdp-arm 		toc_entry->flags = 0;
462819281eeSdp-arm 		entry_offset += toc_entry->size;
463819281eeSdp-arm 		toc_entry++;
464819281eeSdp-arm 	}
465819281eeSdp-arm 
466819281eeSdp-arm 	/* Append a null uuid entry to mark the end of ToC entries. */
467819281eeSdp-arm 	memcpy(&toc_entry->uuid, &uuid_null, sizeof(uuid_t));
468819281eeSdp-arm 	toc_entry->offset_address = entry_offset;
469819281eeSdp-arm 	toc_entry->size = 0;
470819281eeSdp-arm 	toc_entry->flags = 0;
471819281eeSdp-arm 
472819281eeSdp-arm 	/* Generate the FIP file. */
473819281eeSdp-arm 	fp = fopen(filename, "w");
474819281eeSdp-arm 	if (fp == NULL)
475819281eeSdp-arm 		log_err("fopen %s", filename);
476819281eeSdp-arm 
477819281eeSdp-arm 	if (verbose)
478819281eeSdp-arm 		log_dbgx("Metadata size: %zu bytes", buf_size);
479819281eeSdp-arm 
480819281eeSdp-arm 	if (fwrite(buf, 1, buf_size, fp) != buf_size)
481819281eeSdp-arm 		log_errx("Failed to write image to %s", filename);
482819281eeSdp-arm 	free(buf);
483819281eeSdp-arm 
484819281eeSdp-arm 	if (verbose)
485819281eeSdp-arm 		log_dbgx("Payload size: %zu bytes", payload_size);
486819281eeSdp-arm 
487819281eeSdp-arm 	for (i = 0; i < nr_images; i++) {
488819281eeSdp-arm 		image = images[i];
489819281eeSdp-arm 		if (fwrite(image->buffer, 1, image->size, fp) != image->size)
490819281eeSdp-arm 			log_errx("Failed to write image to %s", filename);
491819281eeSdp-arm 	}
492819281eeSdp-arm 
493819281eeSdp-arm 	fclose(fp);
494819281eeSdp-arm 	return 0;
495819281eeSdp-arm }
496819281eeSdp-arm 
497819281eeSdp-arm /*
498819281eeSdp-arm  * This function is shared between the create and update subcommands.
499819281eeSdp-arm  * The difference between the two subcommands is that when the FIP file
500819281eeSdp-arm  * is created, the parsing of an existing FIP is skipped.  This results
501819281eeSdp-arm  * in update_fip() creating the new FIP file from scratch because the
502819281eeSdp-arm  * internal image table is not populated.
503819281eeSdp-arm  */
504819281eeSdp-arm static void update_fip(void)
505819281eeSdp-arm {
506819281eeSdp-arm 	toc_entry_t *toc_entry;
507819281eeSdp-arm 	image_t *image;
508819281eeSdp-arm 
509819281eeSdp-arm 	/* Add or replace images in the FIP file. */
510819281eeSdp-arm 	for (toc_entry = toc_entries;
511819281eeSdp-arm 	     toc_entry->cmdline_name != NULL;
512819281eeSdp-arm 	     toc_entry++) {
513819281eeSdp-arm 		if (toc_entry->action != DO_PACK)
514819281eeSdp-arm 			continue;
515819281eeSdp-arm 
516819281eeSdp-arm 		image = read_image_from_file(toc_entry, toc_entry->action_arg);
517819281eeSdp-arm 		if (toc_entry->image != NULL) {
518819281eeSdp-arm 			if (verbose)
519819281eeSdp-arm 				log_dbgx("Replacing image %s.bin with %s",
520819281eeSdp-arm 				    toc_entry->cmdline_name,
521819281eeSdp-arm 				    toc_entry->action_arg);
522819281eeSdp-arm 			replace_image(toc_entry->image, image);
523819281eeSdp-arm 		} else {
524819281eeSdp-arm 			if (verbose)
525819281eeSdp-arm 				log_dbgx("Adding image %s",
526819281eeSdp-arm 				    toc_entry->action_arg);
527819281eeSdp-arm 			add_image(image);
528819281eeSdp-arm 		}
529819281eeSdp-arm 		/* Link backpointer from lookup entry. */
530819281eeSdp-arm 		toc_entry->image = image;
531819281eeSdp-arm 
532819281eeSdp-arm 		free(toc_entry->action_arg);
533819281eeSdp-arm 		toc_entry->action_arg = NULL;
534819281eeSdp-arm 	}
535819281eeSdp-arm }
536819281eeSdp-arm 
537819281eeSdp-arm static void parse_plat_toc_flags(char *arg, unsigned long long *toc_flags)
538819281eeSdp-arm {
539819281eeSdp-arm 	unsigned long long flags;
540819281eeSdp-arm 	char *endptr;
541819281eeSdp-arm 
542819281eeSdp-arm 	errno = 0;
543819281eeSdp-arm 	flags = strtoull(arg, &endptr, 16);
544819281eeSdp-arm 	if (*endptr != '\0' || flags > UINT16_MAX || errno != 0)
545819281eeSdp-arm 		log_errx("Invalid platform ToC flags: %s", arg);
546819281eeSdp-arm 	/* Platform ToC flags is a 16-bit field occupying bits [32-47]. */
547819281eeSdp-arm 	*toc_flags |= flags << 32;
548819281eeSdp-arm }
549819281eeSdp-arm 
550819281eeSdp-arm static int create_cmd(int argc, char *argv[])
551819281eeSdp-arm {
552819281eeSdp-arm 	struct option opts[toc_entries_len + 1];
553819281eeSdp-arm 	unsigned long long toc_flags = 0;
554819281eeSdp-arm 	int i;
555819281eeSdp-arm 
556819281eeSdp-arm 	if (argc < 2)
557819281eeSdp-arm 		usage();
558819281eeSdp-arm 
559819281eeSdp-arm 	i = fill_common_opts(opts, required_argument);
560819281eeSdp-arm 	add_opt(opts, i, "plat-toc-flags", required_argument,
561819281eeSdp-arm 	    OPT_PLAT_TOC_FLAGS);
562819281eeSdp-arm 	add_opt(opts, ++i, NULL, 0, 0);
563819281eeSdp-arm 
564819281eeSdp-arm 	while (1) {
565819281eeSdp-arm 		int c, opt_index;
566819281eeSdp-arm 
567819281eeSdp-arm 		c = getopt_long(argc, argv, "o:", opts, &opt_index);
568819281eeSdp-arm 		if (c == -1)
569819281eeSdp-arm 			break;
570819281eeSdp-arm 
571819281eeSdp-arm 		switch (c) {
572819281eeSdp-arm 		case OPT_TOC_ENTRY: {
573819281eeSdp-arm 			toc_entry_t *toc_entry;
574819281eeSdp-arm 
575819281eeSdp-arm 			toc_entry = &toc_entries[opt_index];
576819281eeSdp-arm 			toc_entry->action = DO_PACK;
577819281eeSdp-arm 			toc_entry->action_arg = strdup(optarg);
578819281eeSdp-arm 			if (toc_entry->action_arg == NULL)
579819281eeSdp-arm 				log_err("strdup");
580819281eeSdp-arm 			break;
581819281eeSdp-arm 		}
582819281eeSdp-arm 		case OPT_PLAT_TOC_FLAGS:
583819281eeSdp-arm 			parse_plat_toc_flags(optarg, &toc_flags);
584819281eeSdp-arm 			break;
585819281eeSdp-arm 		default:
586819281eeSdp-arm 			usage();
587819281eeSdp-arm 		}
588819281eeSdp-arm 	}
589819281eeSdp-arm 	argc -= optind;
590819281eeSdp-arm 	argv += optind;
591819281eeSdp-arm 
592819281eeSdp-arm 	if (argc == 0)
593819281eeSdp-arm 		usage();
594819281eeSdp-arm 
595819281eeSdp-arm 	update_fip();
596819281eeSdp-arm 
597819281eeSdp-arm 	pack_images(argv[0], toc_flags);
598819281eeSdp-arm 	free_images();
599819281eeSdp-arm 	return 0;
600819281eeSdp-arm }
601819281eeSdp-arm 
602819281eeSdp-arm static void create_usage(void)
603819281eeSdp-arm {
604819281eeSdp-arm 	toc_entry_t *toc_entry = toc_entries;
605819281eeSdp-arm 
60623fcb90dSdp-arm 	printf("fiptool create [--plat-toc-flags <value>] [opts] FIP_FILENAME\n");
607819281eeSdp-arm 	printf("  --plat-toc-flags <value>\t16-bit platform specific flag field "
608819281eeSdp-arm 	    "occupying bits 32-47 in 64-bit ToC header.\n");
609819281eeSdp-arm 	fputc('\n', stderr);
610819281eeSdp-arm 	printf("Specific images are packed with the following options:\n");
611819281eeSdp-arm 	for (; toc_entry->cmdline_name != NULL; toc_entry++)
612819281eeSdp-arm 		printf("  --%-16s FILENAME\t%s\n", toc_entry->cmdline_name,
613819281eeSdp-arm 		    toc_entry->name);
614819281eeSdp-arm }
615819281eeSdp-arm 
616819281eeSdp-arm static int update_cmd(int argc, char *argv[])
617819281eeSdp-arm {
618819281eeSdp-arm 	struct option opts[toc_entries_len + 2];
619819281eeSdp-arm 	char outfile[FILENAME_MAX] = { 0 };
620819281eeSdp-arm 	fip_toc_header_t toc_header = { 0 };
621819281eeSdp-arm 	unsigned long long toc_flags = 0;
622819281eeSdp-arm 	int pflag = 0;
623819281eeSdp-arm 	int i;
624819281eeSdp-arm 
625819281eeSdp-arm 	if (argc < 2)
626819281eeSdp-arm 		usage();
627819281eeSdp-arm 
628819281eeSdp-arm 	i = fill_common_opts(opts, required_argument);
629819281eeSdp-arm 	add_opt(opts, i, "out", required_argument, 'o');
630819281eeSdp-arm 	add_opt(opts, ++i, "plat-toc-flags", required_argument,
631819281eeSdp-arm 	    OPT_PLAT_TOC_FLAGS);
632819281eeSdp-arm 	add_opt(opts, ++i, NULL, 0, 0);
633819281eeSdp-arm 
634819281eeSdp-arm 	while (1) {
635819281eeSdp-arm 		int c, opt_index;
636819281eeSdp-arm 
637819281eeSdp-arm 		c = getopt_long(argc, argv, "o:", opts, &opt_index);
638819281eeSdp-arm 		if (c == -1)
639819281eeSdp-arm 			break;
640819281eeSdp-arm 
641819281eeSdp-arm 		switch (c) {
642819281eeSdp-arm 		case OPT_TOC_ENTRY: {
643819281eeSdp-arm 			toc_entry_t *toc_entry;
644819281eeSdp-arm 
645819281eeSdp-arm 			toc_entry = &toc_entries[opt_index];
646819281eeSdp-arm 			toc_entry->action = DO_PACK;
647819281eeSdp-arm 			toc_entry->action_arg = strdup(optarg);
648819281eeSdp-arm 			if (toc_entry->action_arg == NULL)
649819281eeSdp-arm 				log_err("strdup");
650819281eeSdp-arm 			break;
651819281eeSdp-arm 		}
652819281eeSdp-arm 		case OPT_PLAT_TOC_FLAGS: {
653819281eeSdp-arm 			parse_plat_toc_flags(optarg, &toc_flags);
654819281eeSdp-arm 			pflag = 1;
655819281eeSdp-arm 			break;
656819281eeSdp-arm 		}
657819281eeSdp-arm 		case 'o':
658819281eeSdp-arm 			snprintf(outfile, sizeof(outfile), "%s", optarg);
659819281eeSdp-arm 			break;
660819281eeSdp-arm 		default:
661819281eeSdp-arm 			usage();
662819281eeSdp-arm 		}
663819281eeSdp-arm 	}
664819281eeSdp-arm 	argc -= optind;
665819281eeSdp-arm 	argv += optind;
666819281eeSdp-arm 
667819281eeSdp-arm 	if (argc == 0)
668819281eeSdp-arm 		usage();
669819281eeSdp-arm 
670819281eeSdp-arm 	if (outfile[0] == '\0')
671819281eeSdp-arm 		snprintf(outfile, sizeof(outfile), "%s", argv[0]);
672819281eeSdp-arm 
673819281eeSdp-arm 	if (access(outfile, F_OK) == 0)
674819281eeSdp-arm 		parse_fip(argv[0], &toc_header);
675819281eeSdp-arm 
676819281eeSdp-arm 	if (pflag)
677819281eeSdp-arm 		toc_header.flags &= ~(0xffffULL << 32);
678819281eeSdp-arm 	toc_flags = (toc_header.flags |= toc_flags);
679819281eeSdp-arm 
680819281eeSdp-arm 	update_fip();
681819281eeSdp-arm 
682819281eeSdp-arm 	pack_images(outfile, toc_flags);
683819281eeSdp-arm 	free_images();
684819281eeSdp-arm 	return 0;
685819281eeSdp-arm }
686819281eeSdp-arm 
687819281eeSdp-arm static void update_usage(void)
688819281eeSdp-arm {
689819281eeSdp-arm 	toc_entry_t *toc_entry = toc_entries;
690819281eeSdp-arm 
69123fcb90dSdp-arm 	printf("fiptool update [--out FIP_FILENAME] "
692819281eeSdp-arm 	    "[--plat-toc-flags <value>] [opts] FIP_FILENAME\n");
693819281eeSdp-arm 	printf("  --out FIP_FILENAME\t\tSet an alternative output FIP file.\n");
694819281eeSdp-arm 	printf("  --plat-toc-flags <value>\t16-bit platform specific flag field "
695819281eeSdp-arm 	    "occupying bits 32-47 in 64-bit ToC header.\n");
696819281eeSdp-arm 	fputc('\n', stderr);
697819281eeSdp-arm 	printf("Specific images are packed with the following options:\n");
698819281eeSdp-arm 	for (; toc_entry->cmdline_name != NULL; toc_entry++)
699819281eeSdp-arm 		printf("  --%-16s FILENAME\t%s\n", toc_entry->cmdline_name,
700819281eeSdp-arm 		    toc_entry->name);
701819281eeSdp-arm }
702819281eeSdp-arm 
703819281eeSdp-arm static int unpack_cmd(int argc, char *argv[])
704819281eeSdp-arm {
705819281eeSdp-arm 	struct option opts[toc_entries_len + 3];
706819281eeSdp-arm 	char file[FILENAME_MAX], outdir[PATH_MAX] = { 0 };
707819281eeSdp-arm 	toc_entry_t *toc_entry;
708819281eeSdp-arm 	int fflag = 0;
709819281eeSdp-arm 	int unpack_all = 1;
710819281eeSdp-arm 	int i;
711819281eeSdp-arm 
712819281eeSdp-arm 	if (argc < 2)
713819281eeSdp-arm 		usage();
714819281eeSdp-arm 
715819281eeSdp-arm 	i = fill_common_opts(opts, required_argument);
716819281eeSdp-arm 	add_opt(opts, i, "force", no_argument, 'f');
717819281eeSdp-arm 	add_opt(opts, ++i, "out", required_argument, 'o');
718819281eeSdp-arm 	add_opt(opts, ++i, NULL, 0, 0);
719819281eeSdp-arm 
720819281eeSdp-arm 	while (1) {
721819281eeSdp-arm 		int c, opt_index;
722819281eeSdp-arm 
723819281eeSdp-arm 		c = getopt_long(argc, argv, "fo:", opts, &opt_index);
724819281eeSdp-arm 		if (c == -1)
725819281eeSdp-arm 			break;
726819281eeSdp-arm 
727819281eeSdp-arm 		switch (c) {
728819281eeSdp-arm 		case OPT_TOC_ENTRY:
729819281eeSdp-arm 			unpack_all = 0;
730819281eeSdp-arm 			toc_entry = &toc_entries[opt_index];
731819281eeSdp-arm 			toc_entry->action = DO_UNPACK;
732819281eeSdp-arm 			toc_entry->action_arg = strdup(optarg);
733819281eeSdp-arm 			if (toc_entry->action_arg == NULL)
734819281eeSdp-arm 				log_err("strdup");
735819281eeSdp-arm 			break;
736819281eeSdp-arm 		case 'f':
737819281eeSdp-arm 			fflag = 1;
738819281eeSdp-arm 			break;
739819281eeSdp-arm 		case 'o':
740819281eeSdp-arm 			snprintf(outdir, sizeof(outdir), "%s", optarg);
741819281eeSdp-arm 			break;
742819281eeSdp-arm 		default:
743819281eeSdp-arm 			usage();
744819281eeSdp-arm 		}
745819281eeSdp-arm 	}
746819281eeSdp-arm 	argc -= optind;
747819281eeSdp-arm 	argv += optind;
748819281eeSdp-arm 
749819281eeSdp-arm 	if (argc == 0)
750819281eeSdp-arm 		usage();
751819281eeSdp-arm 
752819281eeSdp-arm 	parse_fip(argv[0], NULL);
753819281eeSdp-arm 
754819281eeSdp-arm 	if (outdir[0] != '\0')
755819281eeSdp-arm 		if (chdir(outdir) == -1)
756819281eeSdp-arm 			log_err("chdir %s", outdir);
757819281eeSdp-arm 
758819281eeSdp-arm 	/* Mark all images to be unpacked. */
759819281eeSdp-arm 	if (unpack_all) {
760819281eeSdp-arm 		for (toc_entry = toc_entries;
761819281eeSdp-arm 		     toc_entry->cmdline_name != NULL;
762819281eeSdp-arm 		     toc_entry++) {
763819281eeSdp-arm 			if (toc_entry->image != NULL) {
764819281eeSdp-arm 				toc_entry->action = DO_UNPACK;
765819281eeSdp-arm 				toc_entry->action_arg = NULL;
766819281eeSdp-arm 			}
767819281eeSdp-arm 		}
768819281eeSdp-arm 	}
769819281eeSdp-arm 
770819281eeSdp-arm 	/* Unpack all specified images. */
771819281eeSdp-arm 	for (toc_entry = toc_entries;
772819281eeSdp-arm 	     toc_entry->cmdline_name != NULL;
773819281eeSdp-arm 	     toc_entry++) {
774819281eeSdp-arm 		if (toc_entry->action != DO_UNPACK)
775819281eeSdp-arm 			continue;
776819281eeSdp-arm 
777819281eeSdp-arm 		/* Build filename. */
778819281eeSdp-arm 		if (toc_entry->action_arg == NULL)
779819281eeSdp-arm 			snprintf(file, sizeof(file), "%s.bin",
780819281eeSdp-arm 			    toc_entry->cmdline_name);
781819281eeSdp-arm 		else
782819281eeSdp-arm 			snprintf(file, sizeof(file), "%s",
783819281eeSdp-arm 			    toc_entry->action_arg);
784819281eeSdp-arm 
785819281eeSdp-arm 		if (toc_entry->image == NULL) {
786819281eeSdp-arm 			log_warnx("Requested image %s is not in %s",
787819281eeSdp-arm 			    file, argv[0]);
788819281eeSdp-arm 			free(toc_entry->action_arg);
789819281eeSdp-arm 			toc_entry->action_arg = NULL;
790819281eeSdp-arm 			continue;
791819281eeSdp-arm 		}
792819281eeSdp-arm 
793819281eeSdp-arm 		if (access(file, F_OK) != 0 || fflag) {
794819281eeSdp-arm 			if (verbose)
795819281eeSdp-arm 				log_dbgx("Unpacking %s", file);
796819281eeSdp-arm 			write_image_to_file(toc_entry->image, file);
797819281eeSdp-arm 		} else {
798819281eeSdp-arm 			log_warnx("File %s already exists, use --force to overwrite it",
799819281eeSdp-arm 			    file);
800819281eeSdp-arm 		}
801819281eeSdp-arm 
802819281eeSdp-arm 		free(toc_entry->action_arg);
803819281eeSdp-arm 		toc_entry->action_arg = NULL;
804819281eeSdp-arm 	}
805819281eeSdp-arm 
806819281eeSdp-arm 	free_images();
807819281eeSdp-arm 	return 0;
808819281eeSdp-arm }
809819281eeSdp-arm 
810819281eeSdp-arm static void unpack_usage(void)
811819281eeSdp-arm {
812819281eeSdp-arm 	toc_entry_t *toc_entry = toc_entries;
813819281eeSdp-arm 
814819281eeSdp-arm 	printf("fiptool unpack [--force] [--out <path>] [opts] FIP_FILENAME\n");
815819281eeSdp-arm 	printf("  --force\tIf the output file already exists, use --force to "
816819281eeSdp-arm 	    "overwrite it.\n");
817819281eeSdp-arm 	printf("  --out path\tSet the output directory path.\n");
818819281eeSdp-arm 	fputc('\n', stderr);
819819281eeSdp-arm 	printf("Specific images are unpacked with the following options:\n");
820819281eeSdp-arm 	for (; toc_entry->cmdline_name != NULL; toc_entry++)
821819281eeSdp-arm 		printf("  --%-16s FILENAME\t%s\n", toc_entry->cmdline_name,
822819281eeSdp-arm 		    toc_entry->name);
823819281eeSdp-arm 	fputc('\n', stderr);
824819281eeSdp-arm 	printf("If no options are provided, all images will be unpacked.\n");
825819281eeSdp-arm }
826819281eeSdp-arm 
827819281eeSdp-arm static int remove_cmd(int argc, char *argv[])
828819281eeSdp-arm {
829819281eeSdp-arm 	struct option opts[toc_entries_len + 2];
830819281eeSdp-arm 	char outfile[FILENAME_MAX] = { 0 };
831819281eeSdp-arm 	fip_toc_header_t toc_header;
832819281eeSdp-arm 	toc_entry_t *toc_entry;
833819281eeSdp-arm 	int fflag = 0;
834819281eeSdp-arm 	int i;
835819281eeSdp-arm 
836819281eeSdp-arm 	if (argc < 2)
837819281eeSdp-arm 		usage();
838819281eeSdp-arm 
839819281eeSdp-arm 	i = fill_common_opts(opts, no_argument);
840819281eeSdp-arm 	add_opt(opts, i, "force", no_argument, 'f');
841819281eeSdp-arm 	add_opt(opts, ++i, "out", required_argument, 'o');
842819281eeSdp-arm 	add_opt(opts, ++i, NULL, 0, 0);
843819281eeSdp-arm 
844819281eeSdp-arm 	while (1) {
845819281eeSdp-arm 		int c, opt_index;
846819281eeSdp-arm 
847819281eeSdp-arm 		c = getopt_long(argc, argv, "fo:", opts, &opt_index);
848819281eeSdp-arm 		if (c == -1)
849819281eeSdp-arm 			break;
850819281eeSdp-arm 
851819281eeSdp-arm 		switch (c) {
852819281eeSdp-arm 		case OPT_TOC_ENTRY:
853819281eeSdp-arm 			toc_entry = &toc_entries[opt_index];
854819281eeSdp-arm 			toc_entry->action = DO_REMOVE;
855819281eeSdp-arm 			break;
856819281eeSdp-arm 		case 'f':
857819281eeSdp-arm 			fflag = 1;
858819281eeSdp-arm 			break;
859819281eeSdp-arm 		case 'o':
860819281eeSdp-arm 			snprintf(outfile, sizeof(outfile), "%s", optarg);
861819281eeSdp-arm 			break;
862819281eeSdp-arm 		default:
863819281eeSdp-arm 			usage();
864819281eeSdp-arm 		}
865819281eeSdp-arm 	}
866819281eeSdp-arm 	argc -= optind;
867819281eeSdp-arm 	argv += optind;
868819281eeSdp-arm 
869819281eeSdp-arm 	if (argc == 0)
870819281eeSdp-arm 		usage();
871819281eeSdp-arm 
872819281eeSdp-arm 	if (outfile[0] != '\0' && access(outfile, F_OK) == 0 && !fflag)
873819281eeSdp-arm 		log_errx("File %s already exists, use --force to overwrite it",
874819281eeSdp-arm 		    outfile);
875819281eeSdp-arm 
876819281eeSdp-arm 	if (outfile[0] == '\0')
877819281eeSdp-arm 		snprintf(outfile, sizeof(outfile), "%s", argv[0]);
878819281eeSdp-arm 
879819281eeSdp-arm 	parse_fip(argv[0], &toc_header);
880819281eeSdp-arm 
881819281eeSdp-arm 	for (toc_entry = toc_entries;
882819281eeSdp-arm 	     toc_entry->cmdline_name != NULL;
883819281eeSdp-arm 	     toc_entry++) {
884819281eeSdp-arm 		if (toc_entry->action != DO_REMOVE)
885819281eeSdp-arm 			continue;
886819281eeSdp-arm 		if (toc_entry->image != NULL) {
887819281eeSdp-arm 			if (verbose)
888819281eeSdp-arm 				log_dbgx("Removing %s.bin",
889819281eeSdp-arm 				    toc_entry->cmdline_name);
890819281eeSdp-arm 			remove_image(toc_entry->image);
891819281eeSdp-arm 		} else {
892819281eeSdp-arm 			log_warnx("Requested image %s.bin is not in %s",
893819281eeSdp-arm 			    toc_entry->cmdline_name, argv[0]);
894819281eeSdp-arm 		}
895819281eeSdp-arm 	}
896819281eeSdp-arm 
897819281eeSdp-arm 	pack_images(outfile, toc_header.flags);
898819281eeSdp-arm 	free_images();
899819281eeSdp-arm 	return 0;
900819281eeSdp-arm }
901819281eeSdp-arm 
902819281eeSdp-arm static void remove_usage(void)
903819281eeSdp-arm {
904819281eeSdp-arm 	toc_entry_t *toc_entry = toc_entries;
905819281eeSdp-arm 
906819281eeSdp-arm 	printf("fiptool remove [--force] [--out FIP_FILENAME] [opts] FIP_FILENAME\n");
907819281eeSdp-arm 	printf("  --force\t\tIf the output FIP file already exists, use --force to "
908819281eeSdp-arm 	    "overwrite it.\n");
909819281eeSdp-arm 	printf("  --out FIP_FILENAME\tSet an alternative output FIP file.\n");
910819281eeSdp-arm 	fputc('\n', stderr);
911819281eeSdp-arm 	printf("Specific images are removed with the following options:\n");
912819281eeSdp-arm 	for (; toc_entry->cmdline_name != NULL; toc_entry++)
913819281eeSdp-arm 		printf("  --%-16s\t%s\n", toc_entry->cmdline_name,
914819281eeSdp-arm 		    toc_entry->name);
915819281eeSdp-arm }
916819281eeSdp-arm 
917819281eeSdp-arm static int version_cmd(int argc, char *argv[])
918819281eeSdp-arm {
919819281eeSdp-arm #ifdef VERSION
920819281eeSdp-arm 	puts(VERSION);
921819281eeSdp-arm #else
922819281eeSdp-arm 	/* If built from fiptool directory, VERSION is not set. */
923819281eeSdp-arm 	puts("Unknown version");
924819281eeSdp-arm #endif
925819281eeSdp-arm 	return 0;
926819281eeSdp-arm }
927819281eeSdp-arm 
928819281eeSdp-arm static void version_usage(void)
929819281eeSdp-arm {
930819281eeSdp-arm 	printf("fiptool version\n");
931819281eeSdp-arm }
932819281eeSdp-arm 
933819281eeSdp-arm static int help_cmd(int argc, char *argv[])
934819281eeSdp-arm {
935819281eeSdp-arm 	int i;
936819281eeSdp-arm 
937819281eeSdp-arm 	if (argc < 2)
938819281eeSdp-arm 		usage();
939819281eeSdp-arm 	argc--, argv++;
940819281eeSdp-arm 
941819281eeSdp-arm 	for (i = 0; i < NELEM(cmds); i++) {
942819281eeSdp-arm 		if (strcmp(cmds[i].name, argv[0]) == 0 &&
943819281eeSdp-arm 		    cmds[i].usage != NULL) {
944819281eeSdp-arm 			cmds[i].usage();
945819281eeSdp-arm 			break;
946819281eeSdp-arm 		}
947819281eeSdp-arm 	}
948819281eeSdp-arm 	if (i == NELEM(cmds))
949819281eeSdp-arm 		printf("No help for subcommand '%s'\n", argv[0]);
950819281eeSdp-arm 	return 0;
951819281eeSdp-arm }
952819281eeSdp-arm 
953819281eeSdp-arm static void usage(void)
954819281eeSdp-arm {
955819281eeSdp-arm 	printf("usage: [--verbose] fiptool <command> [<args>]\n");
956819281eeSdp-arm 	printf("Global options supported:\n");
957819281eeSdp-arm 	printf("  --verbose\tEnable verbose output for all commands.\n");
958819281eeSdp-arm 	fputc('\n', stderr);
959819281eeSdp-arm 	printf("Commands supported:\n");
960819281eeSdp-arm 	printf("  info\t\tList images contained in FIP.\n");
961819281eeSdp-arm 	printf("  create\tCreate a new FIP with the given images.\n");
962819281eeSdp-arm 	printf("  update\tUpdate an existing FIP with the given images.\n");
963819281eeSdp-arm 	printf("  unpack\tUnpack images from FIP.\n");
964819281eeSdp-arm 	printf("  remove\tRemove images from FIP.\n");
965819281eeSdp-arm 	printf("  version\tShow fiptool version.\n");
966819281eeSdp-arm 	printf("  help\t\tShow help for given command.\n");
967819281eeSdp-arm 	exit(1);
968819281eeSdp-arm }
969819281eeSdp-arm 
970819281eeSdp-arm int main(int argc, char *argv[])
971819281eeSdp-arm {
972819281eeSdp-arm 	int i, ret = 0;
973819281eeSdp-arm 
974819281eeSdp-arm 	if (argc < 2)
975819281eeSdp-arm 		usage();
976819281eeSdp-arm 	argc--, argv++;
977819281eeSdp-arm 
978819281eeSdp-arm 	if (strcmp(argv[0], "-v") == 0 ||
979819281eeSdp-arm 	    strcmp(argv[0], "--verbose") == 0) {
980819281eeSdp-arm 		verbose = 1;
981819281eeSdp-arm 		argc--, argv++;
982819281eeSdp-arm 	}
983819281eeSdp-arm 
984819281eeSdp-arm 	for (i = 0; i < NELEM(cmds); i++) {
985819281eeSdp-arm 		if (strcmp(cmds[i].name, argv[0]) == 0) {
986819281eeSdp-arm 			ret = cmds[i].handler(argc, argv);
987819281eeSdp-arm 			break;
988819281eeSdp-arm 		}
989819281eeSdp-arm 	}
990819281eeSdp-arm 	if (i == NELEM(cmds))
991819281eeSdp-arm 		usage();
992819281eeSdp-arm 	return ret;
993819281eeSdp-arm }
994