Home | History | Annotate | Download | only in dtc
      1 /*
      2  * (C) Copyright David Gibson <dwg (at) au1.ibm.com>, 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 */
     34 int phandle_format = PHANDLE_EPAPR;	/* Use linux,phandle or phandle properties */
     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. */
     62 #define FDT_VERSION(version)	_FDT_VERSION(version)
     63 #define _FDT_VERSION(version)	#version
     64 static const char usage_synopsis[] = "dtc [options] <input file>";
     65 static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:a:fb:i:H:sW:E:@Ahv";
     66 static struct option const usage_long_opts[] = {
     67 	{"quiet",            no_argument, NULL, 'q'},
     68 	{"in-format",         a_argument, NULL, 'I'},
     69 	{"out",               a_argument, NULL, 'o'},
     70 	{"out-format",        a_argument, NULL, 'O'},
     71 	{"out-version",       a_argument, NULL, 'V'},
     72 	{"out-dependency",    a_argument, NULL, 'd'},
     73 	{"reserve",           a_argument, NULL, 'R'},
     74 	{"space",             a_argument, NULL, 'S'},
     75 	{"pad",               a_argument, NULL, 'p'},
     76 	{"align",             a_argument, NULL, 'a'},
     77 	{"boot-cpu",          a_argument, NULL, 'b'},
     78 	{"force",            no_argument, NULL, 'f'},
     79 	{"include",           a_argument, NULL, 'i'},
     80 	{"sort",             no_argument, NULL, 's'},
     81 	{"phandle",           a_argument, NULL, 'H'},
     82 	{"warning",           a_argument, NULL, 'W'},
     83 	{"error",             a_argument, NULL, 'E'},
     84 	{"symbols",	     no_argument, NULL, '@'},
     85 	{"auto-alias",       no_argument, NULL, 'A'},
     86 	{"help",             no_argument, NULL, 'h'},
     87 	{"version",          no_argument, NULL, 'v'},
     88 	{NULL,               no_argument, NULL, 0x0},
     89 };
     90 static const char * const usage_opts_help[] = {
     91 	"\n\tQuiet: -q suppress warnings, -qq errors, -qqq all",
     92 	"\n\tInput formats are:\n"
     93 	 "\t\tdts - device tree source text\n"
     94 	 "\t\tdtb - device tree blob\n"
     95 	 "\t\tfs  - /proc/device-tree style directory",
     96 	"\n\tOutput file",
     97 	"\n\tOutput formats are:\n"
     98 	 "\t\tdts - device tree source text\n"
     99 	 "\t\tdtb - device tree blob\n"
    100 	 "\t\tasm - assembler source",
    101 	"\n\tBlob version to produce, defaults to "FDT_VERSION(DEFAULT_FDT_VERSION)" (for dtb and asm output)",
    102 	"\n\tOutput dependency file",
    103 	"\n\tMake space for <number> reserve map entries (for dtb and asm output)",
    104 	"\n\tMake the blob at least <bytes> long (extra space)",
    105 	"\n\tAdd padding to the blob of <bytes> long (extra space)",
    106 	"\n\tMake the blob align to the <bytes> (extra space)",
    107 	"\n\tSet the physical boot cpu",
    108 	"\n\tTry to produce output even if the input tree has errors",
    109 	"\n\tAdd a path to search for include files",
    110 	"\n\tSort nodes and properties before outputting (useful for comparing trees)",
    111 	"\n\tValid phandle formats are:\n"
    112 	 "\t\tlegacy - \"linux,phandle\" properties only\n"
    113 	 "\t\tepapr  - \"phandle\" properties only\n"
    114 	 "\t\tboth   - Both \"linux,phandle\" and \"phandle\" properties",
    115 	"\n\tEnable/disable warnings (prefix with \"no-\")",
    116 	"\n\tEnable/disable errors (prefix with \"no-\")",
    117 	"\n\tEnable generation of symbols",
    118 	"\n\tEnable auto-alias of labels",
    119 	"\n\tPrint this help and exit",
    120 	"\n\tPrint version and exit",
    121 	NULL,
    122 };
    123 
    124 static const char *guess_type_by_name(const char *fname, const char *fallback)
    125 {
    126 	const char *s;
    127 
    128 	s = strrchr(fname, '.');
    129 	if (s == NULL)
    130 		return fallback;
    131 	if (!strcasecmp(s, ".dts"))
    132 		return "dts";
    133 	if (!strcasecmp(s, ".dtb"))
    134 		return "dtb";
    135 	return fallback;
    136 }
    137 
    138 static const char *guess_input_format(const char *fname, const char *fallback)
    139 {
    140 	struct stat statbuf;
    141 	fdt32_t magic;
    142 	FILE *f;
    143 
    144 	if (stat(fname, &statbuf) != 0)
    145 		return fallback;
    146 
    147 	if (S_ISDIR(statbuf.st_mode))
    148 		return "fs";
    149 
    150 	if (!S_ISREG(statbuf.st_mode))
    151 		return fallback;
    152 
    153 	f = fopen(fname, "r");
    154 	if (f == NULL)
    155 		return fallback;
    156 	if (fread(&magic, 4, 1, f) != 1) {
    157 		fclose(f);
    158 		return fallback;
    159 	}
    160 	fclose(f);
    161 
    162 	if (fdt32_to_cpu(magic) == FDT_MAGIC)
    163 		return "dtb";
    164 
    165 	return guess_type_by_name(fname, fallback);
    166 }
    167 
    168 int main(int argc, char *argv[])
    169 {
    170 	struct dt_info *dti;
    171 	const char *inform = NULL;
    172 	const char *outform = NULL;
    173 	const char *outname = "-";
    174 	const char *depname = NULL;
    175 	bool force = false, sort = false;
    176 	const char *arg;
    177 	int opt;
    178 	FILE *outf = NULL;
    179 	int outversion = DEFAULT_FDT_VERSION;
    180 	long long cmdline_boot_cpuid = -1;
    181 
    182 	quiet      = 0;
    183 	reservenum = 0;
    184 	minsize    = 0;
    185 	padsize    = 0;
    186 	alignsize  = 0;
    187 
    188 	while ((opt = util_getopt_long()) != EOF) {
    189 		switch (opt) {
    190 		case 'I':
    191 			inform = optarg;
    192 			break;
    193 		case 'O':
    194 			outform = optarg;
    195 			break;
    196 		case 'o':
    197 			outname = optarg;
    198 			break;
    199 		case 'V':
    200 			outversion = strtol(optarg, NULL, 0);
    201 			break;
    202 		case 'd':
    203 			depname = optarg;
    204 			break;
    205 		case 'R':
    206 			reservenum = strtol(optarg, NULL, 0);
    207 			break;
    208 		case 'S':
    209 			minsize = strtol(optarg, NULL, 0);
    210 			break;
    211 		case 'p':
    212 			padsize = strtol(optarg, NULL, 0);
    213 			break;
    214 		case 'a':
    215 			alignsize = strtol(optarg, NULL, 0);
    216 			if (!is_power_of_2(alignsize))
    217 				die("Invalid argument \"%d\" to -a option\n",
    218 				    alignsize);
    219 			break;
    220 		case 'f':
    221 			force = true;
    222 			break;
    223 		case 'q':
    224 			quiet++;
    225 			break;
    226 		case 'b':
    227 			cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
    228 			break;
    229 		case 'i':
    230 			srcfile_add_search_path(optarg);
    231 			break;
    232 		case 'v':
    233 			util_version();
    234 		case 'H':
    235 			if (streq(optarg, "legacy"))
    236 				phandle_format = PHANDLE_LEGACY;
    237 			else if (streq(optarg, "epapr"))
    238 				phandle_format = PHANDLE_EPAPR;
    239 			else if (streq(optarg, "both"))
    240 				phandle_format = PHANDLE_BOTH;
    241 			else
    242 				die("Invalid argument \"%s\" to -H option\n",
    243 				    optarg);
    244 			break;
    245 
    246 		case 's':
    247 			sort = true;
    248 			break;
    249 
    250 		case 'W':
    251 			parse_checks_option(true, false, optarg);
    252 			break;
    253 
    254 		case 'E':
    255 			parse_checks_option(false, true, optarg);
    256 			break;
    257 
    258 		case '@':
    259 			generate_symbols = 1;
    260 			break;
    261 		case 'A':
    262 			auto_label_aliases = 1;
    263 			break;
    264 
    265 		case 'h':
    266 			usage(NULL);
    267 		default:
    268 			usage("unknown option");
    269 		}
    270 	}
    271 
    272 	if (argc > (optind+1))
    273 		usage("missing files");
    274 	else if (argc < (optind+1))
    275 		arg = "-";
    276 	else
    277 		arg = argv[optind];
    278 
    279 	/* minsize and padsize are mutually exclusive */
    280 	if (minsize && padsize)
    281 		die("Can't set both -p and -S\n");
    282 
    283 	if (depname) {
    284 		depfile = fopen(depname, "w");
    285 		if (!depfile)
    286 			die("Couldn't open dependency file %s: %s\n", depname,
    287 			    strerror(errno));
    288 		fprintf(depfile, "%s:", outname);
    289 	}
    290 
    291 	if (inform == NULL)
    292 		inform = guess_input_format(arg, "dts");
    293 	if (outform == NULL) {
    294 		outform = guess_type_by_name(outname, NULL);
    295 		if (outform == NULL) {
    296 			if (streq(inform, "dts"))
    297 				outform = "dtb";
    298 			else
    299 				outform = "dts";
    300 		}
    301 	}
    302 	if (streq(inform, "dts"))
    303 		dti = dt_from_source(arg);
    304 	else if (streq(inform, "fs"))
    305 		dti = dt_from_fs(arg);
    306 	else if(streq(inform, "dtb"))
    307 		dti = dt_from_blob(arg);
    308 	else
    309 		die("Unknown input format \"%s\"\n", inform);
    310 
    311 	dti->outname = outname;
    312 
    313 	if (depfile) {
    314 		fputc('\n', depfile);
    315 		fclose(depfile);
    316 	}
    317 
    318 	if (cmdline_boot_cpuid != -1)
    319 		dti->boot_cpuid_phys = cmdline_boot_cpuid;
    320 
    321 	fill_fullpaths(dti->dt, "");
    322 	process_checks(force, dti);
    323 
    324 	/* on a plugin, generate by default */
    325 	if (dti->dtsflags & DTSF_PLUGIN) {
    326 		generate_fixups = 1;
    327 	}
    328 
    329 	if (auto_label_aliases)
    330 		generate_label_tree(dti, "aliases", false);
    331 
    332 	if (generate_symbols)
    333 		generate_label_tree(dti, "__symbols__", true);
    334 
    335 	if (generate_fixups) {
    336 		generate_fixups_tree(dti, "__fixups__");
    337 		generate_local_fixups_tree(dti, "__local_fixups__");
    338 	}
    339 
    340 	if (sort)
    341 		sort_tree(dti);
    342 
    343 	if (streq(outname, "-")) {
    344 		outf = stdout;
    345 	} else {
    346 		outf = fopen(outname, "wb");
    347 		if (! outf)
    348 			die("Couldn't open output file %s: %s\n",
    349 			    outname, strerror(errno));
    350 	}
    351 
    352 	if (streq(outform, "dts")) {
    353 		dt_to_source(outf, dti);
    354 	} else if (streq(outform, "dtb")) {
    355 		dt_to_blob(outf, dti, outversion);
    356 	} else if (streq(outform, "asm")) {
    357 		dt_to_asm(outf, dti, outversion);
    358 	} else if (streq(outform, "null")) {
    359 		/* do nothing */
    360 	} else {
    361 		die("Unknown output format \"%s\"\n", outform);
    362 	}
    363 
    364 	exit(0);
    365 }
    366