[J-u-boot.git] / scripts / dtc / dtc.c

/*
 * (C) Copyright David Gibson <[email protected]>, IBM Corporation.  2005.
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *                                                                   USA
 */

#include <sys/stat.h>

#include "dtc.h"
#include "srcpos.h"

/*
 * Command line options
 */
int quiet;		/* Level of quietness */
int reservenum;		/* Number of memory reservation slots */
int minsize;		/* Minimum blob size */
int padsize;		/* Additional padding to blob */
int alignsize;		/* Additional padding to blob accroding to the alignsize */
int phandle_format = PHANDLE_EPAPR;	/* Use linux,phandle or phandle properties */
int generate_symbols;	/* enable symbols & fixup support */
int generate_fixups;		/* suppress generation of fixups on symbol support */
int auto_label_aliases;		/* auto generate labels -> aliases */

static int is_power_of_2(int x)
{
	return (x > 0) && ((x & (x - 1)) == 0);
}

static void fill_fullpaths(struct node *tree, const char *prefix)
{
	struct node *child;
	const char *unit;

	tree->fullpath = join_path(prefix, tree->name);

	unit = strchr(tree->name, '@');
	if (unit)
		tree->basenamelen = unit - tree->name;
	else
		tree->basenamelen = strlen(tree->name);

	for_each_child(tree, child)
		fill_fullpaths(child, tree->fullpath);
}

/* Usage related data. */
static const char usage_synopsis[] = "dtc [options] <input file>";
static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:a:fb:i:H:sW:E:@Ahv";
static struct option const usage_long_opts[] = {
	{"quiet",            no_argument, NULL, 'q'},
	{"in-format",         a_argument, NULL, 'I'},
	{"out",               a_argument, NULL, 'o'},
	{"out-format",        a_argument, NULL, 'O'},
	{"out-version",       a_argument, NULL, 'V'},
	{"out-dependency",    a_argument, NULL, 'd'},
	{"reserve",           a_argument, NULL, 'R'},
	{"space",             a_argument, NULL, 'S'},
	{"pad",               a_argument, NULL, 'p'},
	{"align",             a_argument, NULL, 'a'},
	{"boot-cpu",          a_argument, NULL, 'b'},
	{"force",            no_argument, NULL, 'f'},
	{"include",           a_argument, NULL, 'i'},
	{"sort",             no_argument, NULL, 's'},
	{"phandle",           a_argument, NULL, 'H'},
	{"warning",           a_argument, NULL, 'W'},
	{"error",             a_argument, NULL, 'E'},
	{"symbols",	     no_argument, NULL, '@'},
	{"auto-alias",       no_argument, NULL, 'A'},
	{"help",             no_argument, NULL, 'h'},
	{"version",          no_argument, NULL, 'v'},
	{NULL,               no_argument, NULL, 0x0},
};
static const char * const usage_opts_help[] = {
	"\n\tQuiet: -q suppress warnings, -qq errors, -qqq all",
	"\n\tInput formats are:\n"
	 "\t\tdts - device tree source text\n"
	 "\t\tdtb - device tree blob\n"
	 "\t\tfs  - /proc/device-tree style directory",
	"\n\tOutput file",
	"\n\tOutput formats are:\n"
	 "\t\tdts - device tree source text\n"
	 "\t\tdtb - device tree blob\n"
	 "\t\tasm - assembler source",
	"\n\tBlob version to produce, defaults to "stringify(DEFAULT_FDT_VERSION)" (for dtb and asm output)",
	"\n\tOutput dependency file",
	"\n\tMake space for <number> reserve map entries (for dtb and asm output)",
	"\n\tMake the blob at least <bytes> long (extra space)",
	"\n\tAdd padding to the blob of <bytes> long (extra space)",
	"\n\tMake the blob align to the <bytes> (extra space)",
	"\n\tSet the physical boot cpu",
	"\n\tTry to produce output even if the input tree has errors",
	"\n\tAdd a path to search for include files",
	"\n\tSort nodes and properties before outputting (useful for comparing trees)",
	"\n\tValid phandle formats are:\n"
	 "\t\tlegacy - \"linux,phandle\" properties only\n"
	 "\t\tepapr  - \"phandle\" properties only\n"
	 "\t\tboth   - Both \"linux,phandle\" and \"phandle\" properties",
	"\n\tEnable/disable warnings (prefix with \"no-\")",
	"\n\tEnable/disable errors (prefix with \"no-\")",
	"\n\tEnable generation of symbols",
	"\n\tEnable auto-alias of labels",
	"\n\tPrint this help and exit",
	"\n\tPrint version and exit",
	NULL,
};

static const char *guess_type_by_name(const char *fname, const char *fallback)
{
	const char *s;

	s = strrchr(fname, '.');
	if (s == NULL)
		return fallback;
	if (!strcasecmp(s, ".dts"))
		return "dts";
	if (!strcasecmp(s, ".dtb"))
		return "dtb";
	return fallback;
}

static const char *guess_input_format(const char *fname, const char *fallback)
{
	struct stat statbuf;
	fdt32_t magic;
	FILE *f;

	if (stat(fname, &statbuf) != 0)
		return fallback;

	if (S_ISDIR(statbuf.st_mode))
		return "fs";

	if (!S_ISREG(statbuf.st_mode))
		return fallback;

	f = fopen(fname, "r");
	if (f == NULL)
		return fallback;
	if (fread(&magic, 4, 1, f) != 1) {
		fclose(f);
		return fallback;
	}
	fclose(f);

	if (fdt32_to_cpu(magic) == FDT_MAGIC)
		return "dtb";

	return guess_type_by_name(fname, fallback);
}

int main(int argc, char *argv[])
{
	struct dt_info *dti;
	const char *inform = NULL;
	const char *outform = NULL;
	const char *outname = "-";
	const char *depname = NULL;
	bool force = false, sort = false;
	const char *arg;
	int opt;
	FILE *outf = NULL;
	int outversion = DEFAULT_FDT_VERSION;
	long long cmdline_boot_cpuid = -1;

	quiet      = 0;
	reservenum = 0;
	minsize    = 0;
	padsize    = 0;
	alignsize  = 0;

	while ((opt = util_getopt_long()) != EOF) {
		switch (opt) {
		case 'I':
			inform = optarg;
			break;
		case 'O':
			outform = optarg;
			break;
		case 'o':
			outname = optarg;
			break;
		case 'V':
			outversion = strtol(optarg, NULL, 0);
			break;
		case 'd':
			depname = optarg;
			break;
		case 'R':
			reservenum = strtol(optarg, NULL, 0);
			break;
		case 'S':
			minsize = strtol(optarg, NULL, 0);
			break;
		case 'p':
			padsize = strtol(optarg, NULL, 0);
			break;
		case 'a':
			alignsize = strtol(optarg, NULL, 0);
			if (!is_power_of_2(alignsize))
				die("Invalid argument \"%d\" to -a option\n",
				    alignsize);
			break;
		case 'f':
			force = true;
			break;
		case 'q':
			quiet++;
			break;
		case 'b':
			cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
			break;
		case 'i':
			srcfile_add_search_path(optarg);
			break;
		case 'v':
			util_version();
		case 'H':
			if (streq(optarg, "legacy"))
				phandle_format = PHANDLE_LEGACY;
			else if (streq(optarg, "epapr"))
				phandle_format = PHANDLE_EPAPR;
			else if (streq(optarg, "both"))
				phandle_format = PHANDLE_BOTH;
			else
				die("Invalid argument \"%s\" to -H option\n",
				    optarg);
			break;

		case 's':
			sort = true;
			break;

		case 'W':
			parse_checks_option(true, false, optarg);
			break;

		case 'E':
			parse_checks_option(false, true, optarg);
			break;

		case '@':
			generate_symbols = 1;
			break;
		case 'A':
			auto_label_aliases = 1;
			break;

		case 'h':
			usage(NULL);
		default:
			usage("unknown option");
		}
	}

	if (argc > (optind+1))
		usage("missing files");
	else if (argc < (optind+1))
		arg = "-";
	else
		arg = argv[optind];

	/* minsize and padsize are mutually exclusive */
	if (minsize && padsize)
		die("Can't set both -p and -S\n");

	if (depname) {
		depfile = fopen(depname, "w");
		if (!depfile)
			die("Couldn't open dependency file %s: %s\n", depname,
			    strerror(errno));
		fprintf(depfile, "%s:", outname);
	}

	if (inform == NULL)
		inform = guess_input_format(arg, "dts");
	if (outform == NULL) {
		outform = guess_type_by_name(outname, NULL);
		if (outform == NULL) {
			if (streq(inform, "dts"))
				outform = "dtb";
			else
				outform = "dts";
		}
	}
	if (streq(inform, "dts"))
		dti = dt_from_source(arg);
	else if (streq(inform, "fs"))
		dti = dt_from_fs(arg);
	else if(streq(inform, "dtb"))
		dti = dt_from_blob(arg);
	else
		die("Unknown input format \"%s\"\n", inform);

	dti->outname = outname;

	if (depfile) {
		fputc('\n', depfile);
		fclose(depfile);
	}

	if (cmdline_boot_cpuid != -1)
		dti->boot_cpuid_phys = cmdline_boot_cpuid;

	fill_fullpaths(dti->dt, "");

	/* on a plugin, generate by default */
	if (dti->dtsflags & DTSF_PLUGIN) {
		generate_fixups = 1;
	}

	process_checks(force, dti);

	if (auto_label_aliases)
		generate_label_tree(dti, "aliases", false);

	if (generate_symbols)
		generate_label_tree(dti, "__symbols__", true);

	if (generate_fixups) {
		generate_fixups_tree(dti, "__fixups__");
		generate_local_fixups_tree(dti, "__local_fixups__");
	}

	if (sort)
		sort_tree(dti);

	if (streq(outname, "-")) {
		outf = stdout;
	} else {
		outf = fopen(outname, "wb");
		if (! outf)
			die("Couldn't open output file %s: %s\n",
			    outname, strerror(errno));
	}

	if (streq(outform, "dts")) {
		dt_to_source(outf, dti);
	} else if (streq(outform, "dtb")) {
		dt_to_blob(outf, dti, outversion);
	} else if (streq(outform, "asm")) {
		dt_to_asm(outf, dti, outversion);
	} else if (streq(outform, "null")) {
		/* do nothing */
	} else {
		die("Unknown output format \"%s\"\n", outform);
	}

	exit(0);
}
Commit	Line	Data
c0e032e0 TR	1	/*
	2	* (C) Copyright David Gibson <[email protected]>, IBM Corporation. 2005.
	3	*
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License as
	7	* published by the Free Software Foundation; either version 2 of the
	8	* License, or (at your option) any later version.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	* General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	18	* USA
	19	*/
	20
	21	#include <sys/stat.h>
	22
	23	#include "dtc.h"
	24	#include "srcpos.h"
	25
	26	/*
	27	* Command line options
	28	*/
	29	int quiet; /* Level of quietness */
	30	int reservenum; /* Number of memory reservation slots */
	31	int minsize; /* Minimum blob size */
	32	int padsize; /* Additional padding to blob */
	33	int alignsize; /* Additional padding to blob accroding to the alignsize */
2d4c2259	34	int phandle_format = PHANDLE_EPAPR; /* Use linux,phandle or phandle properties */
c0e032e0 TR	35	int generate_symbols; /* enable symbols & fixup support */
	36	int generate_fixups; /* suppress generation of fixups on symbol support */
	37	int auto_label_aliases; /* auto generate labels -> aliases */
	38
	39	static int is_power_of_2(int x)
	40	{
	41	return (x > 0) && ((x & (x - 1)) == 0);
	42	}
	43
	44	static void fill_fullpaths(struct node tree, const char prefix)
	45	{
	46	struct node *child;
	47	const char *unit;
	48
	49	tree->fullpath = join_path(prefix, tree->name);
	50
	51	unit = strchr(tree->name, '@');
	52	if (unit)
	53	tree->basenamelen = unit - tree->name;
	54	else
	55	tree->basenamelen = strlen(tree->name);
	56
	57	for_each_child(tree, child)
	58	fill_fullpaths(child, tree->fullpath);
	59	}
	60
	61	/* Usage related data. */
c0e032e0 TR	62	static const char usage_synopsis[] = "dtc [options] <input file>";
	63	static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:a:fb:i:H:sW:E:@Ahv";
	64	static struct option const usage_long_opts[] = {
	65	{"quiet", no_argument, NULL, 'q'},
	66	{"in-format", a_argument, NULL, 'I'},
	67	{"out", a_argument, NULL, 'o'},
	68	{"out-format", a_argument, NULL, 'O'},
	69	{"out-version", a_argument, NULL, 'V'},
	70	{"out-dependency", a_argument, NULL, 'd'},
	71	{"reserve", a_argument, NULL, 'R'},
	72	{"space", a_argument, NULL, 'S'},
	73	{"pad", a_argument, NULL, 'p'},
	74	{"align", a_argument, NULL, 'a'},
	75	{"boot-cpu", a_argument, NULL, 'b'},
	76	{"force", no_argument, NULL, 'f'},
	77	{"include", a_argument, NULL, 'i'},
	78	{"sort", no_argument, NULL, 's'},
	79	{"phandle", a_argument, NULL, 'H'},
	80	{"warning", a_argument, NULL, 'W'},
	81	{"error", a_argument, NULL, 'E'},
	82	{"symbols", no_argument, NULL, '@'},
	83	{"auto-alias", no_argument, NULL, 'A'},
	84	{"help", no_argument, NULL, 'h'},
	85	{"version", no_argument, NULL, 'v'},
	86	{NULL, no_argument, NULL, 0x0},
	87	};
	88	static const char * const usage_opts_help[] = {
	89	"\n\tQuiet: -q suppress warnings, -qq errors, -qqq all",
	90	"\n\tInput formats are:\n"
	91	"\t\tdts - device tree source text\n"
	92	"\t\tdtb - device tree blob\n"
	93	"\t\tfs - /proc/device-tree style directory",
	94	"\n\tOutput file",
	95	"\n\tOutput formats are:\n"
	96	"\t\tdts - device tree source text\n"
	97	"\t\tdtb - device tree blob\n"
	98	"\t\tasm - assembler source",
db405d19	99	"\n\tBlob version to produce, defaults to "stringify(DEFAULT_FDT_VERSION)" (for dtb and asm output)",
c0e032e0 TR	100	"\n\tOutput dependency file",
	101	"\n\tMake space for <number> reserve map entries (for dtb and asm output)",
	102	"\n\tMake the blob at least <bytes> long (extra space)",
	103	"\n\tAdd padding to the blob of <bytes> long (extra space)",
	104	"\n\tMake the blob align to the <bytes> (extra space)",
	105	"\n\tSet the physical boot cpu",
	106	"\n\tTry to produce output even if the input tree has errors",
	107	"\n\tAdd a path to search for include files",
	108	"\n\tSort nodes and properties before outputting (useful for comparing trees)",
	109	"\n\tValid phandle formats are:\n"
	110	"\t\tlegacy - \"linux,phandle\" properties only\n"
	111	"\t\tepapr - \"phandle\" properties only\n"
	112	"\t\tboth - Both \"linux,phandle\" and \"phandle\" properties",
	113	"\n\tEnable/disable warnings (prefix with \"no-\")",
	114	"\n\tEnable/disable errors (prefix with \"no-\")",
	115	"\n\tEnable generation of symbols",
	116	"\n\tEnable auto-alias of labels",
	117	"\n\tPrint this help and exit",
	118	"\n\tPrint version and exit",
	119	NULL,
	120	};
	121
	122	static const char guess_type_by_name(const char fname, const char *fallback)
	123	{
	124	const char *s;
	125
	126	s = strrchr(fname, '.');
	127	if (s == NULL)
	128	return fallback;
	129	if (!strcasecmp(s, ".dts"))
	130	return "dts";
	131	if (!strcasecmp(s, ".dtb"))
	132	return "dtb";
	133	return fallback;
	134	}
	135
	136	static const char guess_input_format(const char fname, const char *fallback)
	137	{
	138	struct stat statbuf;
d6fc90ce	139	fdt32_t magic;
c0e032e0 TR	140	FILE *f;
	141
	142	if (stat(fname, &statbuf) != 0)
	143	return fallback;
	144
	145	if (S_ISDIR(statbuf.st_mode))
	146	return "fs";
	147
	148	if (!S_ISREG(statbuf.st_mode))
	149	return fallback;
	150
	151	f = fopen(fname, "r");
	152	if (f == NULL)
	153	return fallback;
	154	if (fread(&magic, 4, 1, f) != 1) {
	155	fclose(f);
	156	return fallback;
	157	}
	158	fclose(f);
	159
d6fc90ce	160	if (fdt32_to_cpu(magic) == FDT_MAGIC)
c0e032e0 TR	161	return "dtb";
	162
	163	return guess_type_by_name(fname, fallback);
	164	}
	165
	166	int main(int argc, char *argv[])
	167	{
	168	struct dt_info *dti;
	169	const char *inform = NULL;
	170	const char *outform = NULL;
	171	const char *outname = "-";
	172	const char *depname = NULL;
	173	bool force = false, sort = false;
	174	const char *arg;
	175	int opt;
	176	FILE *outf = NULL;
	177	int outversion = DEFAULT_FDT_VERSION;
	178	long long cmdline_boot_cpuid = -1;
	179
	180	quiet = 0;
	181	reservenum = 0;
	182	minsize = 0;
	183	padsize = 0;
	184	alignsize = 0;
	185
	186	while ((opt = util_getopt_long()) != EOF) {
	187	switch (opt) {
	188	case 'I':
	189	inform = optarg;
	190	break;
	191	case 'O':
	192	outform = optarg;
	193	break;
	194	case 'o':
	195	outname = optarg;
	196	break;
	197	case 'V':
	198	outversion = strtol(optarg, NULL, 0);
	199	break;
	200	case 'd':
	201	depname = optarg;
	202	break;
	203	case 'R':
	204	reservenum = strtol(optarg, NULL, 0);
	205	break;
	206	case 'S':
	207	minsize = strtol(optarg, NULL, 0);
	208	break;
	209	case 'p':
	210	padsize = strtol(optarg, NULL, 0);
	211	break;
	212	case 'a':
	213	alignsize = strtol(optarg, NULL, 0);
	214	if (!is_power_of_2(alignsize))
	215	die("Invalid argument \"%d\" to -a option\n",
	216	alignsize);
	217	break;
	218	case 'f':
	219	force = true;
	220	break;
	221	case 'q':
	222	quiet++;
	223	break;
	224	case 'b':
225	cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
226	break;
227	case 'i':
228	srcfile_add_search_path(optarg);
229	break;
230	case 'v':
231	util_version();
232	case 'H':
233	if (streq(optarg, "legacy"))
234	phandle_format = PHANDLE_LEGACY;
235	else if (streq(optarg, "epapr"))
236	phandle_format = PHANDLE_EPAPR;
237	else if (streq(optarg, "both"))
238	phandle_format = PHANDLE_BOTH;
239	else
240	die("Invalid argument \"%s\" to -H option\n",
241	optarg);
242	break;
243
244	case 's':
245	sort = true;
246	break;
247
248	case 'W':
249	parse_checks_option(true, false, optarg);
250	break;
251
252	case 'E':
253	parse_checks_option(false, true, optarg);
254	break;
255
256	case '@':
257	generate_symbols = 1;
258	break;
259	case 'A':
260	auto_label_aliases = 1;
261	break;
262
263	case 'h':
264	usage(NULL);
265	default:
266	usage("unknown option");
267	}
268	}
269
270	if (argc > (optind+1))
271	usage("missing files");
272	else if (argc < (optind+1))
273	arg = "-";
274	else
275	arg = argv[optind];
276
277	/* minsize and padsize are mutually exclusive */
278	if (minsize && padsize)
279	die("Can't set both -p and -S\n");
280
281	if (depname) {
282	depfile = fopen(depname, "w");
283	if (!depfile)
284	die("Couldn't open dependency file %s: %s\n", depname,
285	strerror(errno));
286	fprintf(depfile, "%s:", outname);
287	}
288
289	if (inform == NULL)
290	inform = guess_input_format(arg, "dts");
291	if (outform == NULL) {
292	outform = guess_type_by_name(outname, NULL);
293	if (outform == NULL) {
294	if (streq(inform, "dts"))
295	outform = "dtb";
296	else
297	outform = "dts";
298	}
299	}
300	if (streq(inform, "dts"))
301	dti = dt_from_source(arg);
302	else if (streq(inform, "fs"))
303	dti = dt_from_fs(arg);
304	else if(streq(inform, "dtb"))
305	dti = dt_from_blob(arg);
306	else
307	die("Unknown input format \"%s\"\n", inform);
308
309	dti->outname = outname;
310
311	if (depfile) {
312	fputc('\n', depfile);
313	fclose(depfile);
314	}
315
316	if (cmdline_boot_cpuid != -1)
317	dti->boot_cpuid_phys = cmdline_boot_cpuid;
318
319	fill_fullpaths(dti->dt, "");
c0e032e0 TR	320
	321	/* on a plugin, generate by default */
	322	if (dti->dtsflags & DTSF_PLUGIN) {
	323	generate_fixups = 1;
	324	}
	325
db405d19 RH	326	process_checks(force, dti);
db405d19 RH	327
c0e032e0 TR	328	if (auto_label_aliases)
	329	generate_label_tree(dti, "aliases", false);
	330
	331	if (generate_symbols)
	332	generate_label_tree(dti, "__symbols__", true);
	333
	334	if (generate_fixups) {
	335	generate_fixups_tree(dti, "__fixups__");
	336	generate_local_fixups_tree(dti, "__local_fixups__");
	337	}
	338
	339	if (sort)
	340	sort_tree(dti);
	341
	342	if (streq(outname, "-")) {
	343	outf = stdout;
	344	} else {
	345	outf = fopen(outname, "wb");
	346	if (! outf)
	347	die("Couldn't open output file %s: %s\n",
	348	outname, strerror(errno));
	349	}
	350
	351	if (streq(outform, "dts")) {
	352	dt_to_source(outf, dti);
	353	} else if (streq(outform, "dtb")) {
	354	dt_to_blob(outf, dti, outversion);
	355	} else if (streq(outform, "asm")) {
	356	dt_to_asm(outf, dti, outversion);
	357	} else if (streq(outform, "null")) {
	358	/* do nothing */
	359	} else {
	360	die("Unknown output format \"%s\"\n", outform);
	361	}
	362
	363	exit(0);
	364	}