firmware-utils: update to version 2021-10-05

Includes following changes:

 db65821f006c cmake: fix missing install target
 3a0cfc856991 Add initial GitLab CI support
 8f47adea6f87 Add missing includes for byte swap operations
 fbafae9f8037 Convert to CMake based project

Additionaly moves source code into separate Git project repository and
converts the package build to utilize CMake.

Signed-off-by: Petr Štetiar <ynezz@true.cz>
[rmilecki: rebase, update to the latest repo git & rm -r src]
Signed-off-by: Rafał Miłecki <rafal@milecki.pl>

1 files changed, 0 insertions, 647 deletions

diff --git a/tools/firmware-utils/src/mktplinkfw2.c b/tools/firmware-utils/src/mktplinkfw2.c
deleted file mode 100644
index 47fe710dff..0000000000
--- a/tools/firmware-utils/src/mktplinkfw2.c
+++ /dev/null
@@ -1,647 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0-only
-/*
- * Copyright (C) 2009 Gabor Juhos <juhosg@openwrt.org>
- *
- * This tool was based on:
- *   TP-Link WR941 V2 firmware checksum fixing tool.
- *   Copyright (C) 2008,2009 Wang Jian <lark@linux.net.cn>
- */
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <string.h>
-#include <unistd.h>     /* for unlink() */
-#include <libgen.h>
-#include <getopt.h>     /* for getopt() */
-#include <stdarg.h>
-#include <errno.h>
-#include <stdbool.h>
-#include <endian.h>
-#include <sys/stat.h>
-
-#include <arpa/inet.h>
-#include <netinet/in.h>
-
-#include "md5.h"
-#include "mktplinkfw-lib.h"
-
-struct fw_header {
-	uint32_t	version;			/* 0x00: header version */
-	char		fw_version[48];			/* 0x04: fw version string */
-	uint32_t	hw_id;				/* 0x34: hardware id */
-	uint32_t	hw_rev;				/* 0x38: FIXME: hardware revision? */
-	uint32_t	hw_ver_add;			/* 0x3c: additional hardware version */
-	uint8_t		md5sum1[MD5SUM_LEN];		/* 0x40 */
-	uint32_t	unk2;				/* 0x50: 0x00000000 */
-	uint8_t		md5sum2[MD5SUM_LEN];		/* 0x54 */
-	uint32_t	unk3;				/* 0x64: 0xffffffff */
-
-	uint32_t	kernel_la;			/* 0x68: kernel load address */
-	uint32_t	kernel_ep;			/* 0x6c: kernel entry point */
-	uint32_t	fw_length;			/* 0x70: total length of the image */
-	uint32_t	kernel_ofs;			/* 0x74: kernel data offset */
-	uint32_t	kernel_len;			/* 0x78: kernel data length */
-	uint32_t	rootfs_ofs;			/* 0x7c: rootfs data offset */
-	uint32_t	rootfs_len;			/* 0x80: rootfs data length */
-	uint32_t	boot_ofs;			/* 0x84: bootloader offset */
-	uint32_t	boot_len;			/* 0x88: bootloader length */
-	uint16_t	unk4;				/* 0x8c: 0x55aa */
-	uint8_t		sver_hi;			/* 0x8e */
-	uint8_t		sver_lo;			/* 0x8f */
-	uint8_t		unk5;				/* 0x90: magic: 0xa5 */
-	uint8_t		ver_hi;				/* 0x91 */
-	uint8_t		ver_mid;			/* 0x92 */
-	uint8_t		ver_lo;				/* 0x93 */
-	uint8_t		pad[364];
-} __attribute__ ((packed));
-
-#define FLAG_LE_KERNEL_LA_EP			0x00000001	/* Little-endian used for kernel load address & entry point */
-
-struct board_info {
-	char		*id;
-	uint32_t	hw_id;
-	uint32_t	hw_rev;
-	uint32_t	hw_ver_add;
-	char		*layout_id;
-	uint32_t	hdr_ver;
-	uint32_t	flags;
-};
-
-/*
- * Globals
- */
-char *ofname;
-char *progname;
-static char *vendor = "TP-LINK Technologies";
-static char *version = "ver. 1.0";
-static char *fw_ver = "0.0.0";
-static char *sver = "1.0";
-static uint32_t hdr_ver = 2;
-
-static struct board_info custom_board;
-
-static struct board_info *board;
-static char *layout_id;
-struct flash_layout *layout;
-static char *opt_hw_id;
-static char *opt_hw_rev;
-static char *opt_hw_ver_add;
-static int fw_ver_lo;
-static int fw_ver_mid;
-static int fw_ver_hi;
-static int sver_lo;
-static int sver_hi;
-struct file_info kernel_info;
-static uint32_t kernel_la = 0;
-static uint32_t kernel_ep = 0;
-uint32_t kernel_len = 0;
-struct file_info rootfs_info;
-uint32_t rootfs_ofs = 0;
-uint32_t rootfs_align;
-static struct file_info boot_info;
-int combined;
-int strip_padding;
-int add_jffs2_eof;
-
-static struct file_info inspect_info;
-static int extract = 0;
-
-char md5salt_normal[MD5SUM_LEN] = {
-	0xdc, 0xd7, 0x3a, 0xa5, 0xc3, 0x95, 0x98, 0xfb,
-	0xdc, 0xf9, 0xe7, 0xf4, 0x0e, 0xae, 0x47, 0x37,
-};
-
-char md5salt_boot[MD5SUM_LEN] = {
-	0x8c, 0xef, 0x33, 0x5f, 0xd5, 0xc5, 0xce, 0xfa,
-	0xac, 0x9c, 0x28, 0xda, 0xb2, 0xe9, 0x0f, 0x42,
-};
-
-static struct flash_layout layouts[] = {
-	{
-		.id		= "4Mmtk",
-		.fw_max_len	= 0x3c0000,
-		.kernel_la	= 0x80000000,
-		.kernel_ep	= 0x80000000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "4MLmtk",
-		.fw_max_len	= 0x3d0000,
-		.kernel_la	= 0x80000000,
-		.kernel_ep	= 0x80000000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "8Mltq",
-		.fw_max_len	= 0x7a0000,
-		.kernel_la	= 0x80002000,
-		.kernel_ep	= 0x80002000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "16Mltq",
-		.fw_max_len	= 0xf90000,
-		.kernel_la	= 0x80002000,
-		.kernel_ep	= 0x800061b0,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "8Mmtk",
-		.fw_max_len	= 0x7a0000,
-		.kernel_la	= 0x80000000,
-		.kernel_ep	= 0x80000000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "8MSUmtk", /* Split U-Boot OS */
-		.fw_max_len	= 0x770000,
-		.kernel_la	= 0x80000000,
-		.kernel_ep	= 0x80000000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id		= "8MLmtk",
-		.fw_max_len	= 0x7b0000,
-		.kernel_la	= 0x80000000,
-		.kernel_ep	= 0x80000000,
-		.rootfs_ofs	= 0x140000,
-	}, {
-		.id             = "8Mqca",
-		.fw_max_len     = 0x7a0000,
-		.kernel_la      = 0x80060000,
-		.kernel_ep      = 0x80060000,
-		.rootfs_ofs     = 0x140000,
-	}, {
-		.id             = "16Mqca",
-		.fw_max_len     = 0xf90000,
-		.kernel_la      = 0x80060000,
-		.kernel_ep      = 0x80060000,
-		.rootfs_ofs     = 0x140000,
-	}, {
-		/* terminating entry */
-	}
-};
-
-static void usage(int status)
-{
-	FILE *stream = (status != EXIT_SUCCESS) ? stderr : stdout;
-
-	fprintf(stream, "Usage: %s [OPTIONS...]\n", progname);
-	fprintf(stream,
-"\n"
-"Options:\n"
-"  -c              use combined kernel image\n"
-"  -e              swap endianness in kernel load address and entry point\n"
-"  -E <ep>         overwrite kernel entry point with <ep> (hexval prefixed with 0x)\n"
-"  -L <la>         overwrite kernel load address with <la> (hexval prefixed with 0x)\n"
-"  -H <hwid>       use hardware id specified with <hwid>\n"
-"  -W <hwrev>      use hardware revision specified with <hwrev>\n"
-"  -w <hwveradd>   use additional hardware version specified with <hwveradd>\n"
-"  -F <id>         use flash layout specified with <id>\n"
-"  -k <file>       read kernel image from the file <file>\n"
-"  -r <file>       read rootfs image from the file <file>\n"
-"  -a <align>      align the rootfs start on an <align> bytes boundary\n"
-"  -R <offset>     overwrite rootfs offset with <offset> (hexval prefixed with 0x)\n"
-"  -o <file>       write output to the file <file>\n"
-"  -s              strip padding from the end of the image\n"
-"  -j              add jffs2 end-of-filesystem markers\n"
-"  -N <vendor>     set image vendor to <vendor>\n"
-"  -T <version>    set header version to <version>\n"
-"  -V <version>    set image version to <version>\n"
-"  -v <version>    set firmware version to <version>\n"
-"  -y <version>    set secondary version to <version>\n"
-"  -i <file>       inspect given firmware file <file>\n"
-"  -x              extract kernel and rootfs while inspecting (requires -i)\n"
-"  -h              show this screen\n"
-	);
-
-	exit(status);
-}
-
-static int check_options(void)
-{
-	int ret;
-
-	if (inspect_info.file_name) {
-		ret = get_file_stat(&inspect_info);
-		if (ret)
-			return ret;
-
-		return 0;
-	} else if (extract) {
-		ERR("no firmware for inspection specified");
-		return -1;
-	}
-
-	if (opt_hw_id == NULL) {
-		ERR("hardware id must be specified");
-		return -1;
-	}
-
-	board = &custom_board;
-
-	if (layout_id == NULL) {
-		ERR("flash layout is not specified");
-		return -1;
-	}
-
-	board->hw_id = strtoul(opt_hw_id, NULL, 0);
-
-	board->hw_rev = 1;
-	board->hw_ver_add = 0;
-
-	if (opt_hw_rev)
-		board->hw_rev = strtoul(opt_hw_rev, NULL, 0);
-	if (opt_hw_ver_add)
-		board->hw_ver_add = strtoul(opt_hw_ver_add, NULL, 0);
-
-	layout = find_layout(layouts, layout_id);
-	if (layout == NULL) {
-		ERR("unknown flash layout \"%s\"", layout_id);
-		return -1;
-	}
-
-	if (!kernel_la)
-		kernel_la = layout->kernel_la;
-	if (!kernel_ep)
-		kernel_ep = layout->kernel_ep;
-	if (!rootfs_ofs)
-		rootfs_ofs = layout->rootfs_ofs;
-
-	if (kernel_info.file_name == NULL) {
-		ERR("no kernel image specified");
-		return -1;
-	}
-
-	ret = get_file_stat(&kernel_info);
-	if (ret)
-		return ret;
-
-	kernel_len = kernel_info.file_size;
-
-	if (combined) {
-		if (kernel_info.file_size >
-		    layout->fw_max_len - sizeof(struct fw_header)) {
-			ERR("kernel image is too big");
-			return -1;
-		}
-	} else {
-		if (rootfs_info.file_name == NULL) {
-			ERR("no rootfs image specified");
-			return -1;
-		}
-
-		ret = get_file_stat(&rootfs_info);
-		if (ret)
-			return ret;
-
-		if (rootfs_align) {
-			kernel_len += sizeof(struct fw_header);
-			rootfs_ofs = ALIGN(kernel_len, rootfs_align);
-			kernel_len -= sizeof(struct fw_header);
-
-			DBG("rootfs offset aligned to 0x%u", rootfs_ofs);
-
-			if (kernel_len + rootfs_info.file_size >
-			    layout->fw_max_len - sizeof(struct fw_header)) {
-				ERR("images are too big");
-				return -1;
-			}
-		} else {
-			if (kernel_info.file_size >
-			    rootfs_ofs - sizeof(struct fw_header)) {
-				ERR("kernel image is too big");
-				return -1;
-			}
-
-			if (rootfs_info.file_size >
-			    (layout->fw_max_len - rootfs_ofs)) {
-				ERR("rootfs image is too big");
-				return -1;
-			}
-		}
-	}
-
-	if (ofname == NULL) {
-		ERR("no output file specified");
-		return -1;
-	}
-
-	ret = sscanf(fw_ver, "%d.%d.%d", &fw_ver_hi, &fw_ver_mid, &fw_ver_lo);
-	if (ret != 3) {
-		ERR("invalid firmware version '%s'", fw_ver);
-		return -1;
-	}
-
-	ret = sscanf(sver, "%d.%d", &sver_hi, &sver_lo);
-	if (ret != 2) {
-		ERR("invalid secondary version '%s'", sver);
-		return -1;
-	}
-
-	return 0;
-}
-
-void fill_header(char *buf, int len)
-{
-	struct fw_header *hdr = (struct fw_header *)buf;
-	unsigned ver_len;
-
-	memset(hdr, '\xff', sizeof(struct fw_header));
-
-	hdr->version = htonl(bswap_32(hdr_ver));
-	ver_len = strlen(version);
-	if (ver_len > (sizeof(hdr->fw_version) - 1))
-		ver_len = sizeof(hdr->fw_version) - 1;
-
-	memcpy(hdr->fw_version, version, ver_len);
-	hdr->fw_version[ver_len] = 0;
-
-	hdr->hw_id = htonl(board->hw_id);
-	hdr->hw_rev = htonl(board->hw_rev);
-	hdr->hw_ver_add = htonl(board->hw_ver_add);
-
-	if (boot_info.file_size == 0) {
-		memcpy(hdr->md5sum1, md5salt_normal, sizeof(hdr->md5sum1));
-		hdr->boot_ofs = htonl(0);
-		hdr->boot_len = htonl(0);
-	} else {
-		memcpy(hdr->md5sum1, md5salt_boot, sizeof(hdr->md5sum1));
-		hdr->boot_ofs = htonl(rootfs_ofs + rootfs_info.file_size);
-		hdr->boot_len = htonl(rootfs_info.file_size);
-	}
-
-	hdr->kernel_la = htonl(kernel_la);
-	hdr->kernel_ep = htonl(kernel_ep);
-	hdr->fw_length = htonl(layout->fw_max_len);
-	hdr->kernel_ofs = htonl(sizeof(struct fw_header));
-	hdr->kernel_len = htonl(kernel_len);
-	if (!combined) {
-		hdr->rootfs_ofs = htonl(rootfs_ofs);
-		hdr->rootfs_len = htonl(rootfs_info.file_size);
-	}
-
-	hdr->boot_ofs = htonl(0);
-	hdr->boot_len = htonl(boot_info.file_size);
-
-	hdr->unk2 = htonl(0);
-	hdr->unk3 = htonl(0xffffffff);
-	hdr->unk4 = htons(0x55aa);
-	hdr->unk5 = 0xa5;
-
-	hdr->sver_hi = sver_hi;
-	hdr->sver_lo = sver_lo;
-
-	hdr->ver_hi = fw_ver_hi;
-	hdr->ver_mid = fw_ver_mid;
-	hdr->ver_lo = fw_ver_lo;
-
-	if (board->flags & FLAG_LE_KERNEL_LA_EP) {
-		hdr->kernel_la = bswap_32(hdr->kernel_la);
-		hdr->kernel_ep = bswap_32(hdr->kernel_ep);
-	}
-
-	get_md5(buf, len, hdr->md5sum1);
-}
-
-static int inspect_fw(void)
-{
-	char *buf;
-	struct fw_header *hdr;
-	uint8_t md5sum[MD5SUM_LEN];
-	struct board_info *board;
-	int ret = EXIT_FAILURE;
-
-	buf = malloc(inspect_info.file_size);
-	if (!buf) {
-		ERR("no memory for buffer!\n");
-		goto out;
-	}
-
-	ret = read_to_buf(&inspect_info, buf);
-	if (ret)
-		goto out_free_buf;
-	hdr = (struct fw_header *)buf;
-
-	board = &custom_board;
-
-	if (board->flags & FLAG_LE_KERNEL_LA_EP) {
-		hdr->kernel_la = bswap_32(hdr->kernel_la);
-		hdr->kernel_ep = bswap_32(hdr->kernel_ep);
-	}
-
-	inspect_fw_pstr("File name", inspect_info.file_name);
-	inspect_fw_phexdec("File size", inspect_info.file_size);
-
-	switch(bswap_32(ntohl(hdr->version))) {
-	case 2:
-	case 3:
-		break;
-	default:
-		ERR("file does not seem to have V2/V3 header!\n");
-		goto out_free_buf;
-	}
-
-	inspect_fw_phexdec("Version 2 Header size", sizeof(struct fw_header));
-
-	memcpy(md5sum, hdr->md5sum1, sizeof(md5sum));
-	if (ntohl(hdr->boot_len) == 0)
-		memcpy(hdr->md5sum1, md5salt_normal, sizeof(md5sum));
-	else
-		memcpy(hdr->md5sum1, md5salt_boot, sizeof(md5sum));
-	get_md5(buf, inspect_info.file_size, hdr->md5sum1);
-
-	if (memcmp(md5sum, hdr->md5sum1, sizeof(md5sum))) {
-		inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(*ERROR*)");
-		inspect_fw_pmd5sum("          --> expected", hdr->md5sum1, "");
-	} else {
-		inspect_fw_pmd5sum("Header MD5Sum1", md5sum, "(ok)");
-	}
-	if (ntohl(hdr->unk2) != 0)
-		inspect_fw_phexdec("Unknown value 2", hdr->unk2);
-	inspect_fw_pmd5sum("Header MD5Sum2", hdr->md5sum2,
-	                   "(purpose yet unknown, unchecked here)");
-
-	if (ntohl(hdr->unk3) != 0xffffffff)
-		inspect_fw_phexdec("Unknown value 3", hdr->unk3);
-
-	if (ntohs(hdr->unk4) != 0x55aa)
-		inspect_fw_phexdec("Unknown value 4", hdr->unk4);
-
-	if (hdr->unk5 != 0xa5)
-		inspect_fw_phexdec("Unknown value 5", hdr->unk5);
-
-	printf("\n");
-
-	inspect_fw_pstr("Firmware version", hdr->fw_version);
-	inspect_fw_phex("Hardware ID", ntohl(hdr->hw_id));
-	inspect_fw_phex("Hardware Revision",
-			ntohl(hdr->hw_rev));
-	inspect_fw_phex("Additional HW Version",
-			ntohl(hdr->hw_ver_add));
-
-	printf("%-23s: %d.%d.%d-%d.%d\n", "Software version",
-	       hdr->ver_hi, hdr->ver_mid, hdr->ver_lo,
-	       hdr->sver_hi, hdr->sver_lo);
-
-	printf("\n");
-
-	inspect_fw_phexdec("Kernel data offset",
-	                   ntohl(hdr->kernel_ofs));
-	inspect_fw_phexdec("Kernel data length",
-	                   ntohl(hdr->kernel_len));
-	inspect_fw_phex("Kernel load address",
-			ntohl(hdr->kernel_la));
-	inspect_fw_phex("Kernel entry point",
-			ntohl(hdr->kernel_ep));
-	inspect_fw_phexdec("Rootfs data offset",
-			   ntohl(hdr->rootfs_ofs));
-	inspect_fw_phexdec("Rootfs data length",
-	                   ntohl(hdr->rootfs_len));
-	inspect_fw_phexdec("Boot loader data offset",
-	                   ntohl(hdr->boot_ofs));
-	inspect_fw_phexdec("Boot loader data length",
-	                   ntohl(hdr->boot_len));
-	inspect_fw_phexdec("Total firmware length",
-	                   ntohl(hdr->fw_length));
-
-	if (extract) {
-		FILE *fp;
-		char *filename;
-
-		printf("\n");
-
-		filename = malloc(strlen(inspect_info.file_name) + 8);
-		sprintf(filename, "%s-kernel", inspect_info.file_name);
-		printf("Extracting kernel to \"%s\"...\n", filename);
-		fp = fopen(filename, "w");
-		if (fp)	{
-			if (!fwrite(buf + ntohl(hdr->kernel_ofs),
-			            ntohl(hdr->kernel_len), 1, fp)) {
-				ERR("error in fwrite(): %s", strerror(errno));
-			}
-			fclose(fp);
-		} else {
-			ERR("error in fopen(): %s", strerror(errno));
-		}
-		free(filename);
-
-		filename = malloc(strlen(inspect_info.file_name) + 8);
-		sprintf(filename, "%s-rootfs", inspect_info.file_name);
-		printf("Extracting rootfs to \"%s\"...\n", filename);
-		fp = fopen(filename, "w");
-		if (fp)	{
-			if (!fwrite(buf + ntohl(hdr->rootfs_ofs),
-			            ntohl(hdr->rootfs_len), 1, fp)) {
-				ERR("error in fwrite(): %s", strerror(errno));
-			}
-			fclose(fp);
-		} else {
-			ERR("error in fopen(): %s", strerror(errno));
-		}
-		free(filename);
-	}
-
- out_free_buf:
-	free(buf);
- out:
-	return ret;
-}
-
-int main(int argc, char *argv[])
-{
-	int ret = EXIT_FAILURE;
-
-	progname = basename(argv[0]);
-
-	while ( 1 ) {
-		int c;
-
-		c = getopt(argc, argv, "a:H:E:F:L:V:N:W:w:ci:k:r:R:o:xhsjv:y:T:e");
-		if (c == -1)
-			break;
-
-		switch (c) {
-		case 'a':
-			sscanf(optarg, "0x%x", &rootfs_align);
-			break;
-		case 'H':
-			opt_hw_id = optarg;
-			break;
-		case 'E':
-			sscanf(optarg, "0x%x", &kernel_ep);
-			break;
-		case 'F':
-			layout_id = optarg;
-			break;
-		case 'W':
-			opt_hw_rev = optarg;
-			break;
-		case 'w':
-			opt_hw_ver_add = optarg;
-			break;
-		case 'L':
-			sscanf(optarg, "0x%x", &kernel_la);
-			break;
-		case 'V':
-			version = optarg;
-			break;
-		case 'v':
-			fw_ver = optarg;
-			break;
-		case 'y':
-			sver = optarg;
-			break;
-		case 'N':
-			vendor = optarg;
-			break;
-		case 'c':
-			combined++;
-			break;
-		case 'k':
-			kernel_info.file_name = optarg;
-			break;
-		case 'r':
-			rootfs_info.file_name = optarg;
-			break;
-		case 'R':
-			sscanf(optarg, "0x%x", &rootfs_ofs);
-			break;
-		case 'o':
-			ofname = optarg;
-			break;
-		case 's':
-			strip_padding = 1;
-			break;
-		case 'i':
-			inspect_info.file_name = optarg;
-			break;
-		case 'j':
-			add_jffs2_eof = 1;
-			break;
-		case 'x':
-			extract = 1;
-			break;
-		case 'T':
-			hdr_ver = atoi(optarg);
-			break;
-		case 'e':
-			custom_board.flags = FLAG_LE_KERNEL_LA_EP;
-			break;
-		case 'h':
-			usage(EXIT_SUCCESS);
-			break;
-		default:
-			usage(EXIT_FAILURE);
-			break;
-		}
-	}
-
-	ret = check_options();
-	if (ret)
-		goto out;
-
-	if (!inspect_info.file_name)
-		ret = build_fw(sizeof(struct fw_header));
-	else
-		ret = inspect_fw();
-
- out:
-	return ret;
-}
-