Blame dtc.c

Packit Service 87beb7
// SPDX-License-Identifier: GPL-2.0-or-later
Packit Service 87beb7
/*
Packit Service 87beb7
 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation.  2005.
Packit Service 87beb7
 */
Packit Service 87beb7
Packit Service 87beb7
#include <sys/stat.h>
Packit Service 87beb7
Packit Service 87beb7
#include "dtc.h"
Packit Service 87beb7
#include "srcpos.h"
Packit Service 87beb7
Packit Service 87beb7
/*
Packit Service 87beb7
 * Command line options
Packit Service 87beb7
 */
Packit Service 87beb7
int quiet;		/* Level of quietness */
Packit Service 87beb7
int reservenum;		/* Number of memory reservation slots */
Packit Service 87beb7
int minsize;		/* Minimum blob size */
Packit Service 87beb7
int padsize;		/* Additional padding to blob */
Packit Service 87beb7
int alignsize;		/* Additional padding to blob accroding to the alignsize */
Packit Service 87beb7
int phandle_format = PHANDLE_EPAPR;	/* Use linux,phandle or phandle properties */
Packit Service 87beb7
int generate_symbols;	/* enable symbols & fixup support */
Packit Service 87beb7
int generate_fixups;		/* suppress generation of fixups on symbol support */
Packit Service 87beb7
int auto_label_aliases;		/* auto generate labels -> aliases */
Packit Service 87beb7
int annotate;		/* Level of annotation: 1 for input source location
Packit Service 87beb7
			   >1 for full input source location. */
Packit Service 87beb7
Packit Service 87beb7
static int is_power_of_2(int x)
Packit Service 87beb7
{
Packit Service 87beb7
	return (x > 0) && ((x & (x - 1)) == 0);
Packit Service 87beb7
}
Packit Service 87beb7
Packit Service 87beb7
static void fill_fullpaths(struct node *tree, const char *prefix)
Packit Service 87beb7
{
Packit Service 87beb7
	struct node *child;
Packit Service 87beb7
	const char *unit;
Packit Service 87beb7
Packit Service 87beb7
	tree->fullpath = join_path(prefix, tree->name);
Packit Service 87beb7
Packit Service 87beb7
	unit = strchr(tree->name, '@');
Packit Service 87beb7
	if (unit)
Packit Service 87beb7
		tree->basenamelen = unit - tree->name;
Packit Service 87beb7
	else
Packit Service 87beb7
		tree->basenamelen = strlen(tree->name);
Packit Service 87beb7
Packit Service 87beb7
	for_each_child(tree, child)
Packit Service 87beb7
		fill_fullpaths(child, tree->fullpath);
Packit Service 87beb7
}
Packit Service 87beb7
Packit Service 87beb7
/* Usage related data. */
Packit Service 87beb7
static const char usage_synopsis[] = "dtc [options] <input file>";
Packit Service 87beb7
static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:a:fb:i:H:sW:E:@AThv";
Packit Service 87beb7
static struct option const usage_long_opts[] = {
Packit Service 87beb7
	{"quiet",            no_argument, NULL, 'q'},
Packit Service 87beb7
	{"in-format",         a_argument, NULL, 'I'},
Packit Service 87beb7
	{"out",               a_argument, NULL, 'o'},
Packit Service 87beb7
	{"out-format",        a_argument, NULL, 'O'},
Packit Service 87beb7
	{"out-version",       a_argument, NULL, 'V'},
Packit Service 87beb7
	{"out-dependency",    a_argument, NULL, 'd'},
Packit Service 87beb7
	{"reserve",           a_argument, NULL, 'R'},
Packit Service 87beb7
	{"space",             a_argument, NULL, 'S'},
Packit Service 87beb7
	{"pad",               a_argument, NULL, 'p'},
Packit Service 87beb7
	{"align",             a_argument, NULL, 'a'},
Packit Service 87beb7
	{"boot-cpu",          a_argument, NULL, 'b'},
Packit Service 87beb7
	{"force",            no_argument, NULL, 'f'},
Packit Service 87beb7
	{"include",           a_argument, NULL, 'i'},
Packit Service 87beb7
	{"sort",             no_argument, NULL, 's'},
Packit Service 87beb7
	{"phandle",           a_argument, NULL, 'H'},
Packit Service 87beb7
	{"warning",           a_argument, NULL, 'W'},
Packit Service 87beb7
	{"error",             a_argument, NULL, 'E'},
Packit Service 87beb7
	{"symbols",	     no_argument, NULL, '@'},
Packit Service 87beb7
	{"auto-alias",       no_argument, NULL, 'A'},
Packit Service 87beb7
	{"annotate",         no_argument, NULL, 'T'},
Packit Service 87beb7
	{"help",             no_argument, NULL, 'h'},
Packit Service 87beb7
	{"version",          no_argument, NULL, 'v'},
Packit Service 87beb7
	{NULL,               no_argument, NULL, 0x0},
Packit Service 87beb7
};
Packit Service 87beb7
static const char * const usage_opts_help[] = {
Packit Service 87beb7
	"\n\tQuiet: -q suppress warnings, -qq errors, -qqq all",
Packit Service 87beb7
	"\n\tInput formats are:\n"
Packit Service 87beb7
	 "\t\tdts - device tree source text\n"
Packit Service 87beb7
	 "\t\tdtb - device tree blob\n"
Packit Service 87beb7
	 "\t\tfs  - /proc/device-tree style directory",
Packit Service 87beb7
	"\n\tOutput file",
Packit Service 87beb7
	"\n\tOutput formats are:\n"
Packit Service 87beb7
	 "\t\tdts - device tree source text\n"
Packit Service 87beb7
	 "\t\tdtb - device tree blob\n"
Packit Service 87beb7
#ifndef NO_YAML
Packit Service 87beb7
	 "\t\tyaml - device tree encoded as YAML\n"
Packit Service 87beb7
#endif
Packit Service 87beb7
	 "\t\tasm - assembler source",
Packit Service 87beb7
	"\n\tBlob version to produce, defaults to "stringify(DEFAULT_FDT_VERSION)" (for dtb and asm output)",
Packit Service 87beb7
	"\n\tOutput dependency file",
Packit Service 87beb7
	"\n\tMake space for <number> reserve map entries (for dtb and asm output)",
Packit Service 87beb7
	"\n\tMake the blob at least <bytes> long (extra space)",
Packit Service 87beb7
	"\n\tAdd padding to the blob of <bytes> long (extra space)",
Packit Service 87beb7
	"\n\tMake the blob align to the <bytes> (extra space)",
Packit Service 87beb7
	"\n\tSet the physical boot cpu",
Packit Service 87beb7
	"\n\tTry to produce output even if the input tree has errors",
Packit Service 87beb7
	"\n\tAdd a path to search for include files",
Packit Service 87beb7
	"\n\tSort nodes and properties before outputting (useful for comparing trees)",
Packit Service 87beb7
	"\n\tValid phandle formats are:\n"
Packit Service 87beb7
	 "\t\tlegacy - \"linux,phandle\" properties only\n"
Packit Service 87beb7
	 "\t\tepapr  - \"phandle\" properties only\n"
Packit Service 87beb7
	 "\t\tboth   - Both \"linux,phandle\" and \"phandle\" properties",
Packit Service 87beb7
	"\n\tEnable/disable warnings (prefix with \"no-\")",
Packit Service 87beb7
	"\n\tEnable/disable errors (prefix with \"no-\")",
Packit Service 87beb7
	"\n\tEnable generation of symbols",
Packit Service 87beb7
	"\n\tEnable auto-alias of labels",
Packit Service 87beb7
	"\n\tAnnotate output .dts with input source file and line (-T -T for more details)",
Packit Service 87beb7
	"\n\tPrint this help and exit",
Packit Service 87beb7
	"\n\tPrint version and exit",
Packit Service 87beb7
	NULL,
Packit Service 87beb7
};
Packit Service 87beb7
Packit Service 87beb7
static const char *guess_type_by_name(const char *fname, const char *fallback)
Packit Service 87beb7
{
Packit Service 87beb7
	const char *s;
Packit Service 87beb7
Packit Service 87beb7
	s = strrchr(fname, '.');
Packit Service 87beb7
	if (s == NULL)
Packit Service 87beb7
		return fallback;
Packit Service 87beb7
	if (!strcasecmp(s, ".dts"))
Packit Service 87beb7
		return "dts";
Packit Service 87beb7
	if (!strcasecmp(s, ".yaml"))
Packit Service 87beb7
		return "yaml";
Packit Service 87beb7
	if (!strcasecmp(s, ".dtb"))
Packit Service 87beb7
		return "dtb";
Packit Service 87beb7
	return fallback;
Packit Service 87beb7
}
Packit Service 87beb7
Packit Service 87beb7
static const char *guess_input_format(const char *fname, const char *fallback)
Packit Service 87beb7
{
Packit Service 87beb7
	struct stat statbuf;
Packit Service 87beb7
	fdt32_t magic;
Packit Service 87beb7
	FILE *f;
Packit Service 87beb7
Packit Service 87beb7
	if (stat(fname, &statbuf) != 0)
Packit Service 87beb7
		return fallback;
Packit Service 87beb7
Packit Service 87beb7
	if (S_ISDIR(statbuf.st_mode))
Packit Service 87beb7
		return "fs";
Packit Service 87beb7
Packit Service 87beb7
	if (!S_ISREG(statbuf.st_mode))
Packit Service 87beb7
		return fallback;
Packit Service 87beb7
Packit Service 87beb7
	f = fopen(fname, "r");
Packit Service 87beb7
	if (f == NULL)
Packit Service 87beb7
		return fallback;
Packit Service 87beb7
	if (fread(&magic, 4, 1, f) != 1) {
Packit Service 87beb7
		fclose(f);
Packit Service 87beb7
		return fallback;
Packit Service 87beb7
	}
Packit Service 87beb7
	fclose(f);
Packit Service 87beb7
Packit Service 87beb7
	if (fdt32_to_cpu(magic) == FDT_MAGIC)
Packit Service 87beb7
		return "dtb";
Packit Service 87beb7
Packit Service 87beb7
	return guess_type_by_name(fname, fallback);
Packit Service 87beb7
}
Packit Service 87beb7
Packit Service 87beb7
int main(int argc, char *argv[])
Packit Service 87beb7
{
Packit Service 87beb7
	struct dt_info *dti;
Packit Service 87beb7
	const char *inform = NULL;
Packit Service 87beb7
	const char *outform = NULL;
Packit Service 87beb7
	const char *outname = "-";
Packit Service 87beb7
	const char *depname = NULL;
Packit Service 87beb7
	bool force = false, sort = false;
Packit Service 87beb7
	const char *arg;
Packit Service 87beb7
	int opt;
Packit Service 87beb7
	FILE *outf = NULL;
Packit Service 87beb7
	int outversion = DEFAULT_FDT_VERSION;
Packit Service 87beb7
	long long cmdline_boot_cpuid = -1;
Packit Service 87beb7
Packit Service 87beb7
	quiet      = 0;
Packit Service 87beb7
	reservenum = 0;
Packit Service 87beb7
	minsize    = 0;
Packit Service 87beb7
	padsize    = 0;
Packit Service 87beb7
	alignsize  = 0;
Packit Service 87beb7
Packit Service 87beb7
	while ((opt = util_getopt_long()) != EOF) {
Packit Service 87beb7
		switch (opt) {
Packit Service 87beb7
		case 'I':
Packit Service 87beb7
			inform = optarg;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'O':
Packit Service 87beb7
			outform = optarg;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'o':
Packit Service 87beb7
			outname = optarg;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'V':
Packit Service 87beb7
			outversion = strtol(optarg, NULL, 0);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'd':
Packit Service 87beb7
			depname = optarg;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'R':
Packit Service 87beb7
			reservenum = strtol(optarg, NULL, 0);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'S':
Packit Service 87beb7
			minsize = strtol(optarg, NULL, 0);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'p':
Packit Service 87beb7
			padsize = strtol(optarg, NULL, 0);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'a':
Packit Service 87beb7
			alignsize = strtol(optarg, NULL, 0);
Packit Service 87beb7
			if (!is_power_of_2(alignsize))
Packit Service 87beb7
				die("Invalid argument \"%d\" to -a option\n",
Packit Service 87beb7
				    alignsize);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'f':
Packit Service 87beb7
			force = true;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'q':
Packit Service 87beb7
			quiet++;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'b':
Packit Service 87beb7
			cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'i':
Packit Service 87beb7
			srcfile_add_search_path(optarg);
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'v':
Packit Service 87beb7
			util_version();
Packit Service 87beb7
		case 'H':
Packit Service 87beb7
			if (streq(optarg, "legacy"))
Packit Service 87beb7
				phandle_format = PHANDLE_LEGACY;
Packit Service 87beb7
			else if (streq(optarg, "epapr"))
Packit Service 87beb7
				phandle_format = PHANDLE_EPAPR;
Packit Service 87beb7
			else if (streq(optarg, "both"))
Packit Service 87beb7
				phandle_format = PHANDLE_BOTH;
Packit Service 87beb7
			else
Packit Service 87beb7
				die("Invalid argument \"%s\" to -H option\n",
Packit Service 87beb7
				    optarg);
Packit Service 87beb7
			break;
Packit Service 87beb7
Packit Service 87beb7
		case 's':
Packit Service 87beb7
			sort = true;
Packit Service 87beb7
			break;
Packit Service 87beb7
Packit Service 87beb7
		case 'W':
Packit Service 87beb7
			parse_checks_option(true, false, optarg);
Packit Service 87beb7
			break;
Packit Service 87beb7
Packit Service 87beb7
		case 'E':
Packit Service 87beb7
			parse_checks_option(false, true, optarg);
Packit Service 87beb7
			break;
Packit Service 87beb7
Packit Service 87beb7
		case '@':
Packit Service 87beb7
			generate_symbols = 1;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'A':
Packit Service 87beb7
			auto_label_aliases = 1;
Packit Service 87beb7
			break;
Packit Service 87beb7
		case 'T':
Packit Service 87beb7
			annotate++;
Packit Service 87beb7
			break;
Packit Service 87beb7
Packit Service 87beb7
		case 'h':
Packit Service 87beb7
			usage(NULL);
Packit Service 87beb7
		default:
Packit Service 87beb7
			usage("unknown option");
Packit Service 87beb7
		}
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	if (argc > (optind+1))
Packit Service 87beb7
		usage("missing files");
Packit Service 87beb7
	else if (argc < (optind+1))
Packit Service 87beb7
		arg = "-";
Packit Service 87beb7
	else
Packit Service 87beb7
		arg = argv[optind];
Packit Service 87beb7
Packit Service 87beb7
	/* minsize and padsize are mutually exclusive */
Packit Service 87beb7
	if (minsize && padsize)
Packit Service 87beb7
		die("Can't set both -p and -S\n");
Packit Service 87beb7
Packit Service 87beb7
	if (depname) {
Packit Service 87beb7
		depfile = fopen(depname, "w");
Packit Service 87beb7
		if (!depfile)
Packit Service 87beb7
			die("Couldn't open dependency file %s: %s\n", depname,
Packit Service 87beb7
			    strerror(errno));
Packit Service 87beb7
		fprintf(depfile, "%s:", outname);
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	if (inform == NULL)
Packit Service 87beb7
		inform = guess_input_format(arg, "dts");
Packit Service 87beb7
	if (outform == NULL) {
Packit Service 87beb7
		outform = guess_type_by_name(outname, NULL);
Packit Service 87beb7
		if (outform == NULL) {
Packit Service 87beb7
			if (streq(inform, "dts"))
Packit Service 87beb7
				outform = "dtb";
Packit Service 87beb7
			else
Packit Service 87beb7
				outform = "dts";
Packit Service 87beb7
		}
Packit Service 87beb7
	}
Packit Service 87beb7
	if (annotate && (!streq(inform, "dts") || !streq(outform, "dts")))
Packit Service 87beb7
		die("--annotate requires -I dts -O dts\n");
Packit Service 87beb7
	if (streq(inform, "dts"))
Packit Service 87beb7
		dti = dt_from_source(arg);
Packit Service 87beb7
	else if (streq(inform, "fs"))
Packit Service 87beb7
		dti = dt_from_fs(arg);
Packit Service 87beb7
	else if(streq(inform, "dtb"))
Packit Service 87beb7
		dti = dt_from_blob(arg);
Packit Service 87beb7
	else
Packit Service 87beb7
		die("Unknown input format \"%s\"\n", inform);
Packit Service 87beb7
Packit Service 87beb7
	dti->outname = outname;
Packit Service 87beb7
Packit Service 87beb7
	if (depfile) {
Packit Service 87beb7
		fputc('\n', depfile);
Packit Service 87beb7
		fclose(depfile);
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	if (cmdline_boot_cpuid != -1)
Packit Service 87beb7
		dti->boot_cpuid_phys = cmdline_boot_cpuid;
Packit Service 87beb7
Packit Service 87beb7
	fill_fullpaths(dti->dt, "");
Packit Service 87beb7
Packit Service 87beb7
	/* on a plugin, generate by default */
Packit Service 87beb7
	if (dti->dtsflags & DTSF_PLUGIN) {
Packit Service 87beb7
		generate_fixups = 1;
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	process_checks(force, dti);
Packit Service 87beb7
Packit Service 87beb7
	if (auto_label_aliases)
Packit Service 87beb7
		generate_label_tree(dti, "aliases", false);
Packit Service 87beb7
Packit Service 87beb7
	if (generate_symbols)
Packit Service 87beb7
		generate_label_tree(dti, "__symbols__", true);
Packit Service 87beb7
Packit Service 87beb7
	if (generate_fixups) {
Packit Service 87beb7
		generate_fixups_tree(dti, "__fixups__");
Packit Service 87beb7
		generate_local_fixups_tree(dti, "__local_fixups__");
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	if (sort)
Packit Service 87beb7
		sort_tree(dti);
Packit Service 87beb7
Packit Service 87beb7
	if (streq(outname, "-")) {
Packit Service 87beb7
		outf = stdout;
Packit Service 87beb7
	} else {
Packit Service 87beb7
		outf = fopen(outname, "wb");
Packit Service 87beb7
		if (! outf)
Packit Service 87beb7
			die("Couldn't open output file %s: %s\n",
Packit Service 87beb7
			    outname, strerror(errno));
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	if (streq(outform, "dts")) {
Packit Service 87beb7
		dt_to_source(outf, dti);
Packit Service 87beb7
#ifndef NO_YAML
Packit Service 87beb7
	} else if (streq(outform, "yaml")) {
Packit Service 87beb7
		if (!streq(inform, "dts"))
Packit Service 87beb7
			die("YAML output format requires dts input format\n");
Packit Service 87beb7
		dt_to_yaml(outf, dti);
Packit Service 87beb7
#endif
Packit Service 87beb7
	} else if (streq(outform, "dtb")) {
Packit Service 87beb7
		dt_to_blob(outf, dti, outversion);
Packit Service 87beb7
	} else if (streq(outform, "asm")) {
Packit Service 87beb7
		dt_to_asm(outf, dti, outversion);
Packit Service 87beb7
	} else if (streq(outform, "null")) {
Packit Service 87beb7
		/* do nothing */
Packit Service 87beb7
	} else {
Packit Service 87beb7
		die("Unknown output format \"%s\"\n", outform);
Packit Service 87beb7
	}
Packit Service 87beb7
Packit Service 87beb7
	exit(0);
Packit Service 87beb7
}