Home | History | Annotate | Line # | Download | only in mkubootimage
mkubootimage.c revision 1.23 
      1 /* $NetBSD: mkubootimage.c,v 1.23 2018/02/04 15:44:51 jmcneill Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2010 Jared D. McNeill <jmcneill (at) invisible.ca>
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. The name of the author may not be used to endorse or promote products
     13  *    derived from this software without specific prior written permission.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     22  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     25  * SUCH DAMAGE.
     26  */
     27 
     28 #if HAVE_NBTOOL_CONFIG_H
     29 #include "nbtool_config.h"
     30 #endif
     31 
     32 #include <sys/cdefs.h>
     33 __RCSID("$NetBSD: mkubootimage.c,v 1.23 2018/02/04 15:44:51 jmcneill Exp $");
     34 
     35 #include <sys/mman.h>
     36 #include <sys/stat.h>
     37 #include <sys/endian.h>
     38 #include <sys/param.h>
     39 #include <sys/uio.h>
     40 #include <err.h>
     41 #include <errno.h>
     42 #include <fcntl.h>
     43 #include <inttypes.h>
     44 #include <limits.h>
     45 #include <stdint.h>
     46 #include <stdio.h>
     47 #include <stdlib.h>
     48 #include <string.h>
     49 #include <time.h>
     50 #include <unistd.h>
     51 
     52 #include "uboot.h"
     53 #include "arm64.h"
     54 
     55 #ifndef __arraycount
     56 #define __arraycount(__x)	(sizeof(__x) / sizeof(__x[0]))
     57 #endif
     58 
     59 enum image_format {
     60 	FMT_UNKNOWN,
     61 	FMT_UIMG,	/* Legacy U-Boot image */
     62 	FMT_ARM64,	/* Linux ARM64 image (booti) */
     63 };
     64 
     65 extern uint32_t crc32(const void *, size_t);
     66 extern uint32_t crc32v(const struct iovec *, int);
     67 
     68 static enum uboot_image_os image_os = IH_OS_NETBSD;
     69 static enum uboot_image_arch image_arch = IH_ARCH_UNKNOWN;
     70 static enum uboot_image_type image_type = IH_TYPE_UNKNOWN;
     71 static enum uboot_image_comp image_comp = IH_COMP_NONE;
     72 static uint32_t image_loadaddr = 0;
     73 static uint32_t image_entrypoint = 0;
     74 static char *image_name;
     75 static uint32_t image_magic = IH_MAGIC;
     76 static enum image_format image_format = FMT_UIMG;
     77 
     78 static const struct uboot_image_format {
     79 	enum image_format format;
     80 	const char *name;
     81 } uboot_image_format[] = {
     82 	{ FMT_UIMG,		"uimg" },
     83 	{ FMT_ARM64,		"arm64" },
     84 };
     85 
     86 static enum image_format
     87 get_image_format(const char *name)
     88 {
     89 	unsigned int i;
     90 
     91 	for (i = 0; i < __arraycount(uboot_image_format); i++) {
     92 		if (strcmp(uboot_image_format[i].name, name) == 0)
     93 			return uboot_image_format[i].format;
     94 	}
     95 
     96 	return FMT_UNKNOWN;
     97 }
     98 
     99 static const char *
    100 get_image_format_name(enum image_format format)
    101 {
    102 	unsigned int i;
    103 
    104 	for (i = 0; i < __arraycount(uboot_image_format); i++) {
    105 		if (uboot_image_format[i].format == format)
    106 			return uboot_image_format[i].name;
    107 	}
    108 
    109 	return "Unknown";
    110 }
    111 
    112 static const struct uboot_os {
    113 	enum uboot_image_os os;
    114 	const char *name;
    115 } uboot_os[] = {
    116 	{ IH_OS_OPENBSD,	"openbsd" },
    117 	{ IH_OS_NETBSD,		"netbsd" },
    118 	{ IH_OS_FREEBSD,	"freebsd" },
    119 	{ IH_OS_LINUX,		"linux" },
    120 };
    121 
    122 static enum uboot_image_os
    123 get_os(const char *name)
    124 {
    125 	unsigned int i;
    126 
    127 	for (i = 0; i < __arraycount(uboot_os); i++) {
    128 		if (strcmp(uboot_os[i].name, name) == 0)
    129 			return uboot_os[i].os;
    130 	}
    131 
    132 	return IH_OS_UNKNOWN;
    133 }
    134 
    135 static const char *
    136 get_os_name(enum uboot_image_os os)
    137 {
    138 	unsigned int i;
    139 
    140 	for (i = 0; i < __arraycount(uboot_os); i++) {
    141 		if (uboot_os[i].os == os)
    142 			return uboot_os[i].name;
    143 	}
    144 
    145 	return "Unknown";
    146 }
    147 
    148 static const struct uboot_arch {
    149 	enum uboot_image_arch arch;
    150 	const char *name;
    151 } uboot_arch[] = {
    152 	{ IH_ARCH_ARM,		"arm" },
    153 	{ IH_ARCH_ARM64,	"arm64" },
    154 	{ IH_ARCH_I386,		"i386" },
    155 	{ IH_ARCH_MIPS,		"mips" },
    156 	{ IH_ARCH_MIPS64,	"mips64" },
    157 	{ IH_ARCH_PPC,		"powerpc" },
    158 	{ IH_ARCH_OPENRISC,	"or1k" },
    159 	{ IH_ARCH_SH,		"sh" },
    160 };
    161 
    162 static enum uboot_image_arch
    163 get_arch(const char *name)
    164 {
    165 	unsigned int i;
    166 
    167 	for (i = 0; i < __arraycount(uboot_arch); i++) {
    168 		if (strcmp(uboot_arch[i].name, name) == 0)
    169 			return uboot_arch[i].arch;
    170 	}
    171 
    172 	return IH_ARCH_UNKNOWN;
    173 }
    174 
    175 static const char *
    176 get_arch_name(enum uboot_image_arch arch)
    177 {
    178 	unsigned int i;
    179 
    180 	for (i = 0; i < __arraycount(uboot_arch); i++) {
    181 		if (uboot_arch[i].arch == arch)
    182 			return uboot_arch[i].name;
    183 	}
    184 
    185 	return "Unknown";
    186 }
    187 
    188 static const struct uboot_type {
    189 	enum uboot_image_type type;
    190 	const char *name;
    191 } uboot_type[] = {
    192 	{ IH_TYPE_STANDALONE,		"standalone" },
    193 	{ IH_TYPE_KERNEL,		"kernel" },
    194 	{ IH_TYPE_KERNEL_NOLOAD,	"kernel_noload" },
    195 	{ IH_TYPE_RAMDISK,		"ramdisk" },
    196 	{ IH_TYPE_FILESYSTEM,		"fs" },
    197 	{ IH_TYPE_SCRIPT,		"script" },
    198 };
    199 
    200 static enum uboot_image_type
    201 get_type(const char *name)
    202 {
    203 	unsigned int i;
    204 
    205 	for (i = 0; i < __arraycount(uboot_type); i++) {
    206 		if (strcmp(uboot_type[i].name, name) == 0)
    207 			return uboot_type[i].type;
    208 	}
    209 
    210 	return IH_TYPE_UNKNOWN;
    211 }
    212 
    213 static const char *
    214 get_type_name(enum uboot_image_type type)
    215 {
    216 	unsigned int i;
    217 
    218 	for (i = 0; i < __arraycount(uboot_type); i++) {
    219 		if (uboot_type[i].type == type)
    220 			return uboot_type[i].name;
    221 	}
    222 
    223 	return "Unknown";
    224 }
    225 
    226 static const struct uboot_comp {
    227 	enum uboot_image_comp comp;
    228 	const char *name;
    229 } uboot_comp[] = {
    230 	{ IH_COMP_NONE,		"none" },
    231 	{ IH_COMP_GZIP,		"gz" },
    232 	{ IH_COMP_BZIP2,	"bz2" },
    233 	{ IH_COMP_LZMA,		"lzma" },
    234 	{ IH_COMP_LZO,		"lzo" },
    235 };
    236 
    237 static enum uboot_image_comp
    238 get_comp(const char *name)
    239 {
    240 	unsigned int i;
    241 
    242 	for (i = 0; i < __arraycount(uboot_comp); i++) {
    243 		if (strcmp(uboot_comp[i].name, name) == 0)
    244 			return uboot_comp[i].comp;
    245 	}
    246 
    247 	return IH_TYPE_UNKNOWN;
    248 }
    249 
    250 static const char *
    251 get_comp_name(enum uboot_image_comp comp)
    252 {
    253 	unsigned int i;
    254 
    255 	for (i = 0; i < __arraycount(uboot_comp); i++) {
    256 		if (uboot_comp[i].comp == comp)
    257 			return uboot_comp[i].name;
    258 	}
    259 
    260 	return "Unknown";
    261 }
    262 
    263 __dead static void
    264 usage(void)
    265 {
    266 	fprintf(stderr, "usage: mkubootimage -A "
    267 	    "<arm|arm64|i386|mips|mips64|or1k|powerpc|sh>");
    268 	fprintf(stderr, " -C <none|bz2|gz|lzma|lzo>");
    269 	fprintf(stderr, " -O <openbsd|netbsd|freebsd|linux>");
    270 	fprintf(stderr, " -T <standalone|kernel|kernel_noload|ramdisk|fs|script>");
    271 	fprintf(stderr, " -a <addr> [-e <ep>] [-m <magic>] -n <name>");
    272 	fprintf(stderr, " [-f <uimg|arm64>]");
    273 	fprintf(stderr, " <srcfile> <dstfile>\n");
    274 
    275 	exit(EXIT_FAILURE);
    276 }
    277 
    278 static void
    279 dump_header_uimg(struct uboot_image_header *hdr)
    280 {
    281 	time_t tm = ntohl(hdr->ih_time);
    282 
    283 	printf(" magic:       0x%08x\n", ntohl(hdr->ih_magic));
    284 	printf(" time:        %s", ctime(&tm));
    285 	printf(" size:        %u\n", ntohl(hdr->ih_size));
    286 	printf(" load addr:   0x%08x\n", ntohl(hdr->ih_load));
    287 	printf(" entry point: 0x%08x\n", ntohl(hdr->ih_ep));
    288 	printf(" data crc:    0x%08x\n", ntohl(hdr->ih_dcrc));
    289 	printf(" os:          %d (%s)\n", hdr->ih_os,
    290 	    get_os_name(hdr->ih_os));
    291 	printf(" arch:        %d (%s)\n", hdr->ih_arch,
    292 	    get_arch_name(hdr->ih_arch));
    293 	printf(" type:        %d (%s)\n", hdr->ih_type,
    294 	    get_type_name(hdr->ih_type));
    295 	printf(" comp:        %d (%s)\n", hdr->ih_comp,
    296 	    get_comp_name(hdr->ih_comp));
    297 	printf(" name:        %s\n", hdr->ih_name);
    298 	printf(" header crc:  0x%08x\n", hdr->ih_hcrc);
    299 }
    300 
    301 static int
    302 generate_header_uimg(struct uboot_image_header *hdr, int kernel_fd)
    303 {
    304 	uint8_t *p;
    305 	struct stat st;
    306 	uint32_t crc, dsize, size_buf[2];
    307 	int error;
    308 
    309 	error = fstat(kernel_fd, &st);
    310 	if (error == -1) {
    311 		perror("stat");
    312 		return errno;
    313 	}
    314 
    315 	if (st.st_size + sizeof(*hdr) > UINT32_MAX) {
    316 		fprintf(stderr, "fatal: kernel too big\n");
    317 		return EINVAL;
    318 	}
    319 
    320 	p = mmap(0, st.st_size, PROT_READ, MAP_FILE|MAP_SHARED, kernel_fd, 0);
    321 	if (p == MAP_FAILED) {
    322 		perror("mmap kernel");
    323 		return EINVAL;
    324 	}
    325 	if (image_type == IH_TYPE_SCRIPT) {
    326 		struct iovec iov[3];
    327 		dsize = st.st_size + (sizeof(uint32_t) * 2);
    328 		size_buf[0] = htonl(st.st_size);
    329 		size_buf[1] = htonl(0);
    330 		iov[0].iov_base = &size_buf[0];
    331 		iov[0].iov_len = sizeof(size_buf[0]);
    332 		iov[1].iov_base = &size_buf[1];
    333 		iov[1].iov_len = sizeof(size_buf[1]);
    334 		iov[2].iov_base = p;
    335 		iov[2].iov_len = st.st_size;
    336 		crc = crc32v(iov, 3);
    337 	} else {
    338 		dsize = st.st_size;
    339 		crc = crc32(p, st.st_size);
    340 	}
    341 	munmap(p, st.st_size);
    342 
    343 	memset(hdr, 0, sizeof(*hdr));
    344 	hdr->ih_magic = htonl(image_magic);
    345 	hdr->ih_time = htonl(st.st_mtime);
    346 	hdr->ih_size = htonl(dsize);
    347 	hdr->ih_load = htonl(image_loadaddr);
    348 	hdr->ih_ep = htonl(image_entrypoint);
    349 	hdr->ih_dcrc = htonl(crc);
    350 	hdr->ih_os = image_os;
    351 	hdr->ih_arch = image_arch;
    352 	hdr->ih_type = image_type;
    353 	hdr->ih_comp = image_comp;
    354 	strlcpy((char *)hdr->ih_name, image_name, sizeof(hdr->ih_name));
    355 	crc = crc32((void *)hdr, sizeof(*hdr));
    356 	hdr->ih_hcrc = htonl(crc);
    357 
    358 	dump_header_uimg(hdr);
    359 
    360 	return 0;
    361 }
    362 
    363 static void
    364 dump_header_arm64(struct arm64_image_header *hdr)
    365 {
    366 	printf(" magic:       0x%" PRIx32 "\n", le32toh(hdr->magic));
    367 	printf(" text offset: 0x%" PRIx64 "\n", le64toh(hdr->text_offset));
    368 	printf(" image size:  %" PRIu64 "\n", le64toh(hdr->image_size));
    369 	printf(" flags:       0x%" PRIx64 "\n", le64toh(hdr->flags));
    370 }
    371 
    372 static int
    373 generate_header_arm64(struct arm64_image_header *hdr, int kernel_fd)
    374 {
    375 	struct stat st;
    376 	uint32_t flags;
    377 	int error;
    378 
    379 	error = fstat(kernel_fd, &st);
    380 	if (error == -1) {
    381 		perror("stat");
    382 		return errno;
    383 	}
    384 
    385 	flags = 0;
    386 
    387 	flags |= __SHIFTIN(ARM64_FLAGS_PAGE_SIZE_4K,
    388 			   ARM64_FLAGS_PAGE_SIZE);
    389 #if 0
    390 	flags |= __SHIFTIN(ARM64_FLAGS_PHYS_PLACEMENT_ANY,
    391 			   ARM64_FLAGS_PHYS_PLACEMENT);
    392 #endif
    393 
    394 	memset(hdr, 0, sizeof(*hdr));
    395 	hdr->code0 = htole32(ARM64_CODE0);
    396 	hdr->text_offset = htole64(image_entrypoint);
    397 	hdr->image_size = htole64(st.st_size + sizeof(*hdr));
    398 	hdr->flags = htole32(flags);
    399 	hdr->magic = htole32(ARM64_MAGIC);
    400 
    401 	dump_header_arm64(hdr);
    402 
    403 	return 0;
    404 }
    405 
    406 static int
    407 write_image(void *hdr, size_t hdrlen, int kernel_fd, int image_fd)
    408 {
    409 	uint8_t buf[4096];
    410 	ssize_t rlen, wlen;
    411 	struct stat st;
    412 	uint32_t size_buf[2];
    413 	int error;
    414 
    415 	error = fstat(kernel_fd, &st);
    416 	if (error == -1) {
    417 		perror("stat");
    418 		return errno;
    419 	}
    420 
    421 	wlen = write(image_fd, hdr, hdrlen);
    422 	if (wlen != (ssize_t)hdrlen) {
    423 		perror("short write");
    424 		return errno;
    425 	}
    426 
    427 	if (image_type == IH_TYPE_SCRIPT) {
    428 		size_buf[0] = htonl(st.st_size);
    429 		size_buf[1] = htonl(0);
    430 		wlen = write(image_fd, &size_buf, sizeof(size_buf));
    431 		if (wlen != sizeof(size_buf)) {
    432 			perror("short write");
    433 			return errno;
    434 		}
    435 	}
    436 
    437 	while ((rlen = read(kernel_fd, buf, sizeof(buf))) > 0) {
    438 		wlen = write(image_fd, buf, rlen);
    439 		if (wlen != rlen) {
    440 			perror("short write");
    441 			return errno;
    442 		}
    443 	}
    444 
    445 	return 0;
    446 }
    447 
    448 int
    449 main(int argc, char *argv[])
    450 {
    451 	struct uboot_image_header hdr_uimg;
    452 	struct arm64_image_header hdr_arm64;
    453 	const char *src, *dest;
    454 	char *ep;
    455 	int kernel_fd, image_fd;
    456 	int ch;
    457 	unsigned long long num;
    458 
    459 	while ((ch = getopt(argc, argv, "A:C:E:O:T:a:e:f:hm:n:")) != -1) {
    460 		switch (ch) {
    461 		case 'A':	/* arch */
    462 			image_arch = get_arch(optarg);
    463 			break;
    464 		case 'C':	/* comp */
    465 			image_comp = get_comp(optarg);
    466 			break;
    467 		case 'O':	/* os */
    468 			image_os = get_os(optarg);
    469 			break;
    470 		case 'T':	/* type */
    471 			image_type = get_type(optarg);
    472 			break;
    473 		case 'a':	/* addr */
    474 			errno = 0;
    475 			num = strtoull(optarg, &ep, 0);
    476 			if (*ep != '\0' || (errno == ERANGE &&
    477 			    (num == ULLONG_MAX || num == 0)) ||
    478 			    ((signed long long)num != (int32_t)num &&
    479 			     num != (uint32_t)num))
    480 				errx(1, "illegal number -- %s", optarg);
    481 			image_loadaddr = (uint32_t)num;
    482 			break;
    483 		case 'E':	/* ep (byte swapped) */
    484 		case 'e':	/* ep */
    485 			errno = 0;
    486 			num = strtoull(optarg, &ep, 0);
    487 			if (*ep != '\0' || (errno == ERANGE &&
    488 			    (num == ULLONG_MAX || num == 0)) ||
    489 			    ((signed long long)num != (int32_t)num &&
    490 			     num != (uint32_t)num))
    491 				errx(1, "illegal number -- %s", optarg);
    492 			image_entrypoint = (uint32_t)num;
    493 			if (ch == 'E')
    494 				image_entrypoint = bswap32(image_entrypoint);
    495 			break;
    496 		case 'f':	/* image format */
    497 			image_format = get_image_format(optarg);
    498 			break;
    499 		case 'm':	/* magic */
    500 			errno = 0;
    501 			num = strtoul(optarg, &ep, 0);
    502 			if (*ep != '\0' || (errno == ERANGE &&
    503 			    (num == ULONG_MAX || num == 0)))
    504 				errx(1, "illegal number -- %s", optarg);
    505 			image_magic = (uint32_t)num;
    506 			break;
    507 		case 'n':	/* name */
    508 			image_name = strdup(optarg);
    509 			break;
    510 		case 'h':
    511 		default:
    512 			usage();
    513 			/* NOTREACHED */
    514 		}
    515 	}
    516 	argc -= optind;
    517 	argv += optind;
    518 
    519 	if (argc != 2)
    520 		usage();
    521 
    522 	if (image_entrypoint == 0)
    523 		image_entrypoint = image_loadaddr;
    524 
    525 	switch (image_format) {
    526 	case FMT_UIMG:
    527 		if (image_arch == IH_ARCH_UNKNOWN ||
    528 		    image_type == IH_TYPE_UNKNOWN ||
    529 		    image_name == NULL)
    530 			usage();
    531 			/* NOTREACHED */
    532 
    533 		switch (image_type) {
    534 		case IH_TYPE_SCRIPT:
    535 		case IH_TYPE_RAMDISK:
    536 		case IH_TYPE_KERNEL_NOLOAD:
    537 			break;
    538 		default:
    539 			if (image_loadaddr == 0)
    540 				usage();
    541 				/* NOTREACHED */
    542 			break;
    543 		}
    544 		break;
    545 
    546 	case FMT_ARM64:
    547 		if (image_arch != IH_ARCH_UNKNOWN &&
    548 		    image_arch != IH_ARCH_ARM64)
    549 			usage();
    550 			/* NOTREACHED */
    551 
    552 		break;
    553 
    554 	default:
    555 		usage();
    556 		/* NOTREACHED */
    557 	}
    558 
    559 	src = argv[0];
    560 	dest = argv[1];
    561 
    562 	kernel_fd = open(src, O_RDONLY);
    563 	if (kernel_fd == -1) {
    564 		perror("open kernel");
    565 		return EXIT_FAILURE;
    566 	}
    567 	image_fd = open(dest, O_WRONLY|O_CREAT|O_TRUNC, 0666);
    568 	if (image_fd == -1) {
    569 		perror("open image");
    570 		return EXIT_FAILURE;
    571 	}
    572 
    573 	printf(" image type:  %s\n", get_image_format_name(image_format));
    574 
    575 	switch (image_format) {
    576 	case FMT_UIMG:
    577 		if (generate_header_uimg(&hdr_uimg, kernel_fd) != 0)
    578 			return EXIT_FAILURE;
    579 
    580 		if (write_image(&hdr_uimg, sizeof(hdr_uimg),
    581 		    kernel_fd, image_fd) != 0)
    582 			return EXIT_FAILURE;
    583 
    584 		break;
    585 	case FMT_ARM64:
    586 		if (generate_header_arm64(&hdr_arm64, kernel_fd) != 0)
    587 			return EXIT_FAILURE;
    588 
    589 		if (write_image(&hdr_arm64, sizeof(hdr_arm64),
    590 		    kernel_fd, image_fd) != 0)
    591 			return EXIT_FAILURE;
    592 
    593 		break;
    594 	default:
    595 		break;
    596 	}
    597 
    598 	close(image_fd);
    599 	close(kernel_fd);
    600 
    601 	return EXIT_SUCCESS;
    602 }
    603