xref: /openbmc/linux/scripts/dtc/dtc.c (revision 0d456bad)
1 /*
2  * (C) Copyright David Gibson <dwg@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 "dtc.h"
22 #include "srcpos.h"
23 
24 #include "version_gen.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 phandle_format = PHANDLE_BOTH;	/* Use linux,phandle or phandle properties */
34 
35 static void fill_fullpaths(struct node *tree, const char *prefix)
36 {
37 	struct node *child;
38 	const char *unit;
39 
40 	tree->fullpath = join_path(prefix, tree->name);
41 
42 	unit = strchr(tree->name, '@');
43 	if (unit)
44 		tree->basenamelen = unit - tree->name;
45 	else
46 		tree->basenamelen = strlen(tree->name);
47 
48 	for_each_child(tree, child)
49 		fill_fullpaths(child, tree->fullpath);
50 }
51 
52 static void  __attribute__ ((noreturn)) usage(void)
53 {
54 	fprintf(stderr, "Usage:\n");
55 	fprintf(stderr, "\tdtc [options] <input file>\n");
56 	fprintf(stderr, "\nOptions:\n");
57 	fprintf(stderr, "\t-h\n");
58 	fprintf(stderr, "\t\tThis help text\n");
59 	fprintf(stderr, "\t-q\n");
60 	fprintf(stderr, "\t\tQuiet: -q suppress warnings, -qq errors, -qqq all\n");
61 	fprintf(stderr, "\t-I <input format>\n");
62 	fprintf(stderr, "\t\tInput formats are:\n");
63 	fprintf(stderr, "\t\t\tdts - device tree source text\n");
64 	fprintf(stderr, "\t\t\tdtb - device tree blob\n");
65 	fprintf(stderr, "\t\t\tfs - /proc/device-tree style directory\n");
66 	fprintf(stderr, "\t-o <output file>\n");
67 	fprintf(stderr, "\t-O <output format>\n");
68 	fprintf(stderr, "\t\tOutput formats are:\n");
69 	fprintf(stderr, "\t\t\tdts - device tree source text\n");
70 	fprintf(stderr, "\t\t\tdtb - device tree blob\n");
71 	fprintf(stderr, "\t\t\tasm - assembler source\n");
72 	fprintf(stderr, "\t-V <output version>\n");
73 	fprintf(stderr, "\t\tBlob version to produce, defaults to %d (relevant for dtb\n\t\tand asm output only)\n", DEFAULT_FDT_VERSION);
74 	fprintf(stderr, "\t-d <output dependency file>\n");
75 	fprintf(stderr, "\t-R <number>\n");
76 	fprintf(stderr, "\t\tMake space for <number> reserve map entries (relevant for \n\t\tdtb and asm output only)\n");
77 	fprintf(stderr, "\t-S <bytes>\n");
78 	fprintf(stderr, "\t\tMake the blob at least <bytes> long (extra space)\n");
79 	fprintf(stderr, "\t-p <bytes>\n");
80 	fprintf(stderr, "\t\tAdd padding to the blob of <bytes> long (extra space)\n");
81 	fprintf(stderr, "\t-b <number>\n");
82 	fprintf(stderr, "\t\tSet the physical boot cpu\n");
83 	fprintf(stderr, "\t-f\n");
84 	fprintf(stderr, "\t\tForce - try to produce output even if the input tree has errors\n");
85 	fprintf(stderr, "\t-i\n");
86 	fprintf(stderr, "\t\tAdd a path to search for include files\n");
87 	fprintf(stderr, "\t-s\n");
88 	fprintf(stderr, "\t\tSort nodes and properties before outputting (only useful for\n\t\tcomparing trees)\n");
89 	fprintf(stderr, "\t-v\n");
90 	fprintf(stderr, "\t\tPrint DTC version and exit\n");
91 	fprintf(stderr, "\t-H <phandle format>\n");
92 	fprintf(stderr, "\t\tphandle formats are:\n");
93 	fprintf(stderr, "\t\t\tlegacy - \"linux,phandle\" properties only\n");
94 	fprintf(stderr, "\t\t\tepapr - \"phandle\" properties only\n");
95 	fprintf(stderr, "\t\t\tboth - Both \"linux,phandle\" and \"phandle\" properties\n");
96 	fprintf(stderr, "\t-W [no-]<checkname>\n");
97 	fprintf(stderr, "\t-E [no-]<checkname>\n");
98 	fprintf(stderr, "\t\t\tenable or disable warnings and errors\n");
99 	exit(3);
100 }
101 
102 int main(int argc, char *argv[])
103 {
104 	struct boot_info *bi;
105 	const char *inform = "dts";
106 	const char *outform = "dts";
107 	const char *outname = "-";
108 	const char *depname = NULL;
109 	int force = 0, sort = 0;
110 	const char *arg;
111 	int opt;
112 	FILE *outf = NULL;
113 	int outversion = DEFAULT_FDT_VERSION;
114 	long long cmdline_boot_cpuid = -1;
115 
116 	quiet      = 0;
117 	reservenum = 0;
118 	minsize    = 0;
119 	padsize    = 0;
120 
121 	while ((opt = getopt(argc, argv, "hI:O:o:V:d:R:S:p:fqb:i:vH:sW:E:"))
122 			!= EOF) {
123 		switch (opt) {
124 		case 'I':
125 			inform = optarg;
126 			break;
127 		case 'O':
128 			outform = optarg;
129 			break;
130 		case 'o':
131 			outname = optarg;
132 			break;
133 		case 'V':
134 			outversion = strtol(optarg, NULL, 0);
135 			break;
136 		case 'd':
137 			depname = optarg;
138 			break;
139 		case 'R':
140 			reservenum = strtol(optarg, NULL, 0);
141 			break;
142 		case 'S':
143 			minsize = strtol(optarg, NULL, 0);
144 			break;
145 		case 'p':
146 			padsize = strtol(optarg, NULL, 0);
147 			break;
148 		case 'f':
149 			force = 1;
150 			break;
151 		case 'q':
152 			quiet++;
153 			break;
154 		case 'b':
155 			cmdline_boot_cpuid = strtoll(optarg, NULL, 0);
156 			break;
157 		case 'i':
158 			srcfile_add_search_path(optarg);
159 			break;
160 		case 'v':
161 			printf("Version: %s\n", DTC_VERSION);
162 			exit(0);
163 		case 'H':
164 			if (streq(optarg, "legacy"))
165 				phandle_format = PHANDLE_LEGACY;
166 			else if (streq(optarg, "epapr"))
167 				phandle_format = PHANDLE_EPAPR;
168 			else if (streq(optarg, "both"))
169 				phandle_format = PHANDLE_BOTH;
170 			else
171 				die("Invalid argument \"%s\" to -H option\n",
172 				    optarg);
173 			break;
174 
175 		case 's':
176 			sort = 1;
177 			break;
178 
179 		case 'W':
180 			parse_checks_option(true, false, optarg);
181 			break;
182 
183 		case 'E':
184 			parse_checks_option(false, true, optarg);
185 			break;
186 
187 		case 'h':
188 		default:
189 			usage();
190 		}
191 	}
192 
193 	if (argc > (optind+1))
194 		usage();
195 	else if (argc < (optind+1))
196 		arg = "-";
197 	else
198 		arg = argv[optind];
199 
200 	/* minsize and padsize are mutually exclusive */
201 	if (minsize && padsize)
202 		die("Can't set both -p and -S\n");
203 
204 	if (minsize)
205 		fprintf(stderr, "DTC: Use of \"-S\" is deprecated; it will be removed soon, use \"-p\" instead\n");
206 
207 	if (depname) {
208 		depfile = fopen(depname, "w");
209 		if (!depfile)
210 			die("Couldn't open dependency file %s: %s\n", depname,
211 			    strerror(errno));
212 		fprintf(depfile, "%s:", outname);
213 	}
214 
215 	if (streq(inform, "dts"))
216 		bi = dt_from_source(arg);
217 	else if (streq(inform, "fs"))
218 		bi = dt_from_fs(arg);
219 	else if(streq(inform, "dtb"))
220 		bi = dt_from_blob(arg);
221 	else
222 		die("Unknown input format \"%s\"\n", inform);
223 
224 	if (depfile) {
225 		fputc('\n', depfile);
226 		fclose(depfile);
227 	}
228 
229 	if (cmdline_boot_cpuid != -1)
230 		bi->boot_cpuid_phys = cmdline_boot_cpuid;
231 
232 	fill_fullpaths(bi->dt, "");
233 	process_checks(force, bi);
234 
235 	if (sort)
236 		sort_tree(bi);
237 
238 	if (streq(outname, "-")) {
239 		outf = stdout;
240 	} else {
241 		outf = fopen(outname, "w");
242 		if (! outf)
243 			die("Couldn't open output file %s: %s\n",
244 			    outname, strerror(errno));
245 	}
246 
247 	if (streq(outform, "dts")) {
248 		dt_to_source(outf, bi);
249 	} else if (streq(outform, "dtb")) {
250 		dt_to_blob(outf, bi, outversion);
251 	} else if (streq(outform, "asm")) {
252 		dt_to_asm(outf, bi, outversion);
253 	} else if (streq(outform, "null")) {
254 		/* do nothing */
255 	} else {
256 		die("Unknown output format \"%s\"\n", outform);
257 	}
258 
259 	exit(0);
260 }
261