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_BOTH;	/* 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 	uint32_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 	magic = fdt32_to_cpu(magic);
    163 	if (magic == FDT_MAGIC)
    164 		return "dtb";
    165 
    166 	return guess_type_by_name(fname, fallback);
    167 }
    168 
    169 int main(int argc, char *argv[])
    170 {
    171 	struct dt_info *dti;
    172 	const char *inform = NULL;
    173 	const char *outform = NULL;
    174 	const char *outname = "-";
    175 	const char *depname = NULL;
    176 	bool force = false, sort = false;
    177 	const char *arg;
    178 	int opt;
    179 	FILE *outf = NULL;
    180 	int outversion = DEFAULT_FDT_VERSION;
    181 	long long cmdline_boot_cpuid = -1;
    182 
    183 	quiet      = 0;
    184 	reservenum = 0;
    185 	minsize    = 0;
    186 	padsize    = 0;
    187 	alignsize  = 0;
    188 
    189 	while ((opt = util_getopt_long()) != EOF) {
    190 		switch (opt) {
    191 		case 'I':
    192 			inform = optarg;
    193 			break;
    194 		case 'O':
    195 			outform = optarg;
    196 			break;
    197 		case 'o':
    198 			outname = optarg;
    199 			break;
    200 		case 'V':
    201 			outversion = strtol(optarg, NULL, 0);
    202 			break;
    203 		case 'd':
    204 			depname = optarg;
    205 			break;
    206 		case 'R':
    207 			reservenum = strtol(optarg, NULL, 0);
    208 			break;
    209 		case 'S':
    210 			minsize = strtol(optarg, NULL, 0);
    211 			break;
    212 		case 'p':
    213 			padsize = strtol(optarg, NULL, 0);
    214 			break;
    215 		case 'a':
    216 			alignsize = strtol(optarg, NULL, 0);
    217 			if (!is_power_of_2(alignsize))
    218 				die("Invalid argument \"%d\" to -a option\n",
    219 				    optarg);
    220 			break;
    221 		case 'f':
    222 			force = true;
    223 			break;
    224 		case 'q':
    225 			quiet++;
    226 			break;
    227 		case 'b':
    228 			cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
    229 			break;
    230 		case 'i':
    231 			srcfile_add_search_path(optarg);
    232 			break;
    233 		case 'v':
    234 			util_version();
    235 		case 'H':
    236 			if (streq(optarg, "legacy"))
    237 				phandle_format = PHANDLE_LEGACY;
    238 			else if (streq(optarg, "epapr"))
    239 				phandle_format = PHANDLE_EPAPR;
    240 			else if (streq(optarg, "both"))
    241 				phandle_format = PHANDLE_BOTH;
    242 			else
    243 				die("Invalid argument \"%s\" to -H option\n",
    244 				    optarg);
    245 			break;
    246 
    247 		case 's':
    248 			sort = true;
    249 			break;
    250 
    251 		case 'W':
    252 			parse_checks_option(true, false, optarg);
    253 			break;
    254 
    255 		case 'E':
    256 			parse_checks_option(false, true, optarg);
    257 			break;
    258 
    259 		case '@':
    260 			generate_symbols = 1;
    261 			break;
    262 		case 'A':
    263 			auto_label_aliases = 1;
    264 			break;
    265 
    266 		case 'h':
    267 			usage(NULL);
    268 		default:
    269 			usage("unknown option");
    270 		}
    271 	}
    272 
    273 	if (argc > (optind+1))
    274 		usage("missing files");
    275 	else if (argc < (optind+1))
    276 		arg = "-";
    277 	else
    278 		arg = argv[optind];
    279 
    280 	/* minsize and padsize are mutually exclusive */
    281 	if (minsize && padsize)
    282 		die("Can't set both -p and -S\n");
    283 
    284 	if (depname) {
    285 		depfile = fopen(depname, "w");
    286 		if (!depfile)
    287 			die("Couldn't open dependency file %s: %s\n", depname,
    288 			    strerror(errno));
    289 		fprintf(depfile, "%s:", outname);
    290 	}
    291 
    292 	if (inform == NULL)
    293 		inform = guess_input_format(arg, "dts");
    294 	if (outform == NULL) {
    295 		outform = guess_type_by_name(outname, NULL);
    296 		if (outform == NULL) {
    297 			if (streq(inform, "dts"))
    298 				outform = "dtb";
    299 			else
    300 				outform = "dts";
    301 		}
    302 	}
    303 	if (streq(inform, "dts"))
    304 		dti = dt_from_source(arg);
    305 	else if (streq(inform, "fs"))
    306 		dti = dt_from_fs(arg);
    307 	else if(streq(inform, "dtb"))
    308 		dti = dt_from_blob(arg);
    309 	else
    310 		die("Unknown input format \"%s\"\n", inform);
    311 
    312 	if (depfile) {
    313 		fputc('\n', depfile);
    314 		fclose(depfile);
    315 	}
    316 
    317 	if (cmdline_boot_cpuid != -1)
    318 		dti->boot_cpuid_phys = cmdline_boot_cpuid;
    319 
    320 	fill_fullpaths(dti->dt, "");
    321 	process_checks(force, dti);
    322 
    323 	/* on a plugin, generate by default */
    324 	if (dti->dtsflags & DTSF_PLUGIN) {
    325 		generate_fixups = 1;
    326 	}
    327 
    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 }
    365