xref: /linux-6.15/scripts/dtc/treesource.c (revision 12d638f4)
11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
29fffb55fSDavid Gibson /*
39fffb55fSDavid Gibson  * (C) Copyright David Gibson <[email protected]>, IBM Corporation.  2005.
49fffb55fSDavid Gibson  */
59fffb55fSDavid Gibson 
69fffb55fSDavid Gibson #include "dtc.h"
79fffb55fSDavid Gibson #include "srcpos.h"
89fffb55fSDavid Gibson 
99fffb55fSDavid Gibson extern FILE *yyin;
109fffb55fSDavid Gibson extern int yyparse(void);
11cd296721SStephen Warren extern YYLTYPE yylloc;
129fffb55fSDavid Gibson 
136f05afcbSRob Herring struct dt_info *parser_output;
1447605971SRob Herring bool treesource_error;
159fffb55fSDavid Gibson 
dt_from_source(const char * fname)166f05afcbSRob Herring struct dt_info *dt_from_source(const char *fname)
179fffb55fSDavid Gibson {
186f05afcbSRob Herring 	parser_output = NULL;
1947605971SRob Herring 	treesource_error = false;
209fffb55fSDavid Gibson 
21658f29a5SJohn Bonesio 	srcfile_push(fname);
22658f29a5SJohn Bonesio 	yyin = current_srcfile->f;
23cd296721SStephen Warren 	yylloc.file = current_srcfile;
249fffb55fSDavid Gibson 
259fffb55fSDavid Gibson 	if (yyparse() != 0)
269fffb55fSDavid Gibson 		die("Unable to parse input tree\n");
279fffb55fSDavid Gibson 
289fffb55fSDavid Gibson 	if (treesource_error)
299fffb55fSDavid Gibson 		die("Syntax error parsing input tree\n");
309fffb55fSDavid Gibson 
316f05afcbSRob Herring 	return parser_output;
329fffb55fSDavid Gibson }
339fffb55fSDavid Gibson 
write_prefix(FILE * f,int level)349fffb55fSDavid Gibson static void write_prefix(FILE *f, int level)
359fffb55fSDavid Gibson {
369fffb55fSDavid Gibson 	int i;
379fffb55fSDavid Gibson 
389fffb55fSDavid Gibson 	for (i = 0; i < level; i++)
399fffb55fSDavid Gibson 		fputc('\t', f);
409fffb55fSDavid Gibson }
419fffb55fSDavid Gibson 
isstring(char c)4247605971SRob Herring static bool isstring(char c)
439fffb55fSDavid Gibson {
4447605971SRob Herring 	return (isprint((unsigned char)c)
459fffb55fSDavid Gibson 		|| (c == '\0')
469fffb55fSDavid Gibson 		|| strchr("\a\b\t\n\v\f\r", c));
479fffb55fSDavid Gibson }
489fffb55fSDavid Gibson 
write_propval_string(FILE * f,const char * s,size_t len)49f858927fSRob Herring static void write_propval_string(FILE *f, const char *s, size_t len)
509fffb55fSDavid Gibson {
51f858927fSRob Herring 	const char *end = s + len - 1;
52c2e7075cSRob Herring 
53c2e7075cSRob Herring 	if (!len)
54c2e7075cSRob Herring 		return;
55c2e7075cSRob Herring 
56f858927fSRob Herring 	assert(*end == '\0');
579fffb55fSDavid Gibson 
589fffb55fSDavid Gibson 	fprintf(f, "\"");
59f858927fSRob Herring 	while (s < end) {
60f858927fSRob Herring 		char c = *s++;
619fffb55fSDavid Gibson 		switch (c) {
629fffb55fSDavid Gibson 		case '\a':
639fffb55fSDavid Gibson 			fprintf(f, "\\a");
649fffb55fSDavid Gibson 			break;
659fffb55fSDavid Gibson 		case '\b':
669fffb55fSDavid Gibson 			fprintf(f, "\\b");
679fffb55fSDavid Gibson 			break;
689fffb55fSDavid Gibson 		case '\t':
699fffb55fSDavid Gibson 			fprintf(f, "\\t");
709fffb55fSDavid Gibson 			break;
719fffb55fSDavid Gibson 		case '\n':
729fffb55fSDavid Gibson 			fprintf(f, "\\n");
739fffb55fSDavid Gibson 			break;
749fffb55fSDavid Gibson 		case '\v':
759fffb55fSDavid Gibson 			fprintf(f, "\\v");
769fffb55fSDavid Gibson 			break;
779fffb55fSDavid Gibson 		case '\f':
789fffb55fSDavid Gibson 			fprintf(f, "\\f");
799fffb55fSDavid Gibson 			break;
809fffb55fSDavid Gibson 		case '\r':
819fffb55fSDavid Gibson 			fprintf(f, "\\r");
829fffb55fSDavid Gibson 			break;
839fffb55fSDavid Gibson 		case '\\':
849fffb55fSDavid Gibson 			fprintf(f, "\\\\");
859fffb55fSDavid Gibson 			break;
869fffb55fSDavid Gibson 		case '\"':
879fffb55fSDavid Gibson 			fprintf(f, "\\\"");
889fffb55fSDavid Gibson 			break;
899fffb55fSDavid Gibson 		case '\0':
90f858927fSRob Herring 			fprintf(f, "\\0");
919fffb55fSDavid Gibson 			break;
929fffb55fSDavid Gibson 		default:
9347605971SRob Herring 			if (isprint((unsigned char)c))
949fffb55fSDavid Gibson 				fprintf(f, "%c", c);
959fffb55fSDavid Gibson 			else
96f858927fSRob Herring 				fprintf(f, "\\x%02"PRIx8, c);
979fffb55fSDavid Gibson 		}
989fffb55fSDavid Gibson 	}
999fffb55fSDavid Gibson 	fprintf(f, "\"");
1009fffb55fSDavid Gibson }
1019fffb55fSDavid Gibson 
write_propval_int(FILE * f,const char * p,size_t len,size_t width)102f858927fSRob Herring static void write_propval_int(FILE *f, const char *p, size_t len, size_t width)
1039fffb55fSDavid Gibson {
104f858927fSRob Herring 	const char *end = p + len;
105f858927fSRob Herring 	assert(len % width == 0);
1069fffb55fSDavid Gibson 
107f858927fSRob Herring 	for (; p < end; p += width) {
108f858927fSRob Herring 		switch (width) {
109f858927fSRob Herring 		case 1:
110f858927fSRob Herring 			fprintf(f, "%02"PRIx8, *(const uint8_t*)p);
1119fffb55fSDavid Gibson 			break;
112f858927fSRob Herring 		case 2:
1133eb619b2SRob Herring 			fprintf(f, "0x%02"PRIx16, dtb_ld16(p));
114f858927fSRob Herring 			break;
115f858927fSRob Herring 		case 4:
1163eb619b2SRob Herring 			fprintf(f, "0x%02"PRIx32, dtb_ld32(p));
117f858927fSRob Herring 			break;
118f858927fSRob Herring 		case 8:
1193eb619b2SRob Herring 			fprintf(f, "0x%02"PRIx64, dtb_ld64(p));
120f858927fSRob Herring 			break;
121f858927fSRob Herring 		}
122c2e7075cSRob Herring 		if (p + width < end)
123c2e7075cSRob Herring 			fputc(' ', f);
124f858927fSRob Herring 	}
1259fffb55fSDavid Gibson }
1269fffb55fSDavid Gibson 
127f858927fSRob Herring static const char *delim_start[] = {
128f858927fSRob Herring 	[TYPE_UINT8] = "[",
129f858927fSRob Herring 	[TYPE_UINT16] = "/bits/ 16 <",
130f858927fSRob Herring 	[TYPE_UINT32] = "<",
131f858927fSRob Herring 	[TYPE_UINT64] = "/bits/ 64 <",
132f858927fSRob Herring 	[TYPE_STRING] = "",
133f858927fSRob Herring };
134f858927fSRob Herring static const char *delim_end[] = {
135f858927fSRob Herring 	[TYPE_UINT8] = "]",
136f858927fSRob Herring 	[TYPE_UINT16] = ">",
137f858927fSRob Herring 	[TYPE_UINT32] = ">",
138f858927fSRob Herring 	[TYPE_UINT64] = ">",
139f858927fSRob Herring 	[TYPE_STRING] = "",
140f858927fSRob Herring };
1419fffb55fSDavid Gibson 
add_string_markers(struct property * prop)142*12d638f4SRob Herring (Arm) static void add_string_markers(struct property *prop)
143*12d638f4SRob Herring (Arm) {
144*12d638f4SRob Herring (Arm) 	int l, len = prop->val.len;
145*12d638f4SRob Herring (Arm) 	const char *p = prop->val.val;
146*12d638f4SRob Herring (Arm) 
147*12d638f4SRob Herring (Arm) 	for (l = strlen(p) + 1; l < len; l += strlen(p + l) + 1) {
148*12d638f4SRob Herring (Arm) 		struct marker *m, **nextp;
149*12d638f4SRob Herring (Arm) 
150*12d638f4SRob Herring (Arm) 		m = xmalloc(sizeof(*m));
151*12d638f4SRob Herring (Arm) 		m->offset = l;
152*12d638f4SRob Herring (Arm) 		m->type = TYPE_STRING;
153*12d638f4SRob Herring (Arm) 		m->ref = NULL;
154*12d638f4SRob Herring (Arm) 		m->next = NULL;
155*12d638f4SRob Herring (Arm) 
156*12d638f4SRob Herring (Arm) 		/* Find the end of the markerlist */
157*12d638f4SRob Herring (Arm) 		nextp = &prop->val.markers;
158*12d638f4SRob Herring (Arm) 		while (*nextp)
159*12d638f4SRob Herring (Arm) 			nextp = &((*nextp)->next);
160*12d638f4SRob Herring (Arm) 		*nextp = m;
161*12d638f4SRob Herring (Arm) 	}
162*12d638f4SRob Herring (Arm) }
163*12d638f4SRob Herring (Arm) 
guess_value_type(struct property * prop)164f858927fSRob Herring static enum markertype guess_value_type(struct property *prop)
1659fffb55fSDavid Gibson {
1669fffb55fSDavid Gibson 	int len = prop->val.len;
1679fffb55fSDavid Gibson 	const char *p = prop->val.val;
1689fffb55fSDavid Gibson 	struct marker *m = prop->val.markers;
1699fffb55fSDavid Gibson 	int nnotstring = 0, nnul = 0;
1709fffb55fSDavid Gibson 	int nnotstringlbl = 0, nnotcelllbl = 0;
1719fffb55fSDavid Gibson 	int i;
1729fffb55fSDavid Gibson 
1739fffb55fSDavid Gibson 	for (i = 0; i < len; i++) {
1749fffb55fSDavid Gibson 		if (! isstring(p[i]))
1759fffb55fSDavid Gibson 			nnotstring++;
1769fffb55fSDavid Gibson 		if (p[i] == '\0')
1779fffb55fSDavid Gibson 			nnul++;
1789fffb55fSDavid Gibson 	}
1799fffb55fSDavid Gibson 
1809fffb55fSDavid Gibson 	for_each_marker_of_type(m, LABEL) {
1819fffb55fSDavid Gibson 		if ((m->offset > 0) && (prop->val.val[m->offset - 1] != '\0'))
1829fffb55fSDavid Gibson 			nnotstringlbl++;
1839fffb55fSDavid Gibson 		if ((m->offset % sizeof(cell_t)) != 0)
1849fffb55fSDavid Gibson 			nnotcelllbl++;
1859fffb55fSDavid Gibson 	}
1869fffb55fSDavid Gibson 
1873eb619b2SRob Herring 	if ((p[len-1] == '\0') && (nnotstring == 0) && (nnul <= (len-nnul))
1889fffb55fSDavid Gibson 	    && (nnotstringlbl == 0)) {
189*12d638f4SRob Herring (Arm) 		if (nnul > 1)
190*12d638f4SRob Herring (Arm) 			add_string_markers(prop);
191f858927fSRob Herring 		return TYPE_STRING;
1929fffb55fSDavid Gibson 	} else if (((len % sizeof(cell_t)) == 0) && (nnotcelllbl == 0)) {
193f858927fSRob Herring 		return TYPE_UINT32;
1949fffb55fSDavid Gibson 	}
1959fffb55fSDavid Gibson 
196f858927fSRob Herring 	return TYPE_UINT8;
197f858927fSRob Herring }
198f858927fSRob Herring 
write_propval(FILE * f,struct property * prop)199f858927fSRob Herring static void write_propval(FILE *f, struct property *prop)
200f858927fSRob Herring {
201f858927fSRob Herring 	size_t len = prop->val.len;
202f858927fSRob Herring 	struct marker *m = prop->val.markers;
203f858927fSRob Herring 	struct marker dummy_marker;
204f858927fSRob Herring 	enum markertype emit_type = TYPE_NONE;
205c2e7075cSRob Herring 	char *srcstr;
206f858927fSRob Herring 
207f858927fSRob Herring 	if (len == 0) {
208c2e7075cSRob Herring 		fprintf(f, ";");
209c2e7075cSRob Herring 		if (annotate) {
210c2e7075cSRob Herring 			srcstr = srcpos_string_first(prop->srcpos, annotate);
211c2e7075cSRob Herring 			if (srcstr) {
212c2e7075cSRob Herring 				fprintf(f, " /* %s */", srcstr);
213c2e7075cSRob Herring 				free(srcstr);
214c2e7075cSRob Herring 			}
215c2e7075cSRob Herring 		}
216c2e7075cSRob Herring 		fprintf(f, "\n");
217f858927fSRob Herring 		return;
218f858927fSRob Herring 	}
219f858927fSRob Herring 
220f858927fSRob Herring 	fprintf(f, " =");
221f858927fSRob Herring 
222f858927fSRob Herring 	if (!next_type_marker(m)) {
223f858927fSRob Herring 		/* data type information missing, need to guess */
224f858927fSRob Herring 		dummy_marker.type = guess_value_type(prop);
225f858927fSRob Herring 		dummy_marker.next = prop->val.markers;
226f858927fSRob Herring 		dummy_marker.offset = 0;
227f858927fSRob Herring 		dummy_marker.ref = NULL;
228f858927fSRob Herring 		m = &dummy_marker;
229f858927fSRob Herring 	}
230f858927fSRob Herring 
231f858927fSRob Herring 	for_each_marker(m) {
232c2e7075cSRob Herring 		size_t chunk_len = (m->next ? m->next->offset : len) - m->offset;
233c2e7075cSRob Herring 		size_t data_len = type_marker_length(m) ? : len - m->offset;
234f858927fSRob Herring 		const char *p = &prop->val.val[m->offset];
235a77725a9SRob Herring 		struct marker *m_phandle;
236f858927fSRob Herring 
237a77725a9SRob Herring 		if (is_type_marker(m->type)) {
238f858927fSRob Herring 			emit_type = m->type;
239f858927fSRob Herring 			fprintf(f, " %s", delim_start[emit_type]);
240c2e7075cSRob Herring 		} else if (m->type == LABEL)
241c2e7075cSRob Herring 			fprintf(f, " %s:", m->ref);
242f858927fSRob Herring 
243a77725a9SRob Herring 		if (emit_type == TYPE_NONE || chunk_len == 0)
244f858927fSRob Herring 			continue;
245f858927fSRob Herring 
246f858927fSRob Herring 		switch(emit_type) {
247f858927fSRob Herring 		case TYPE_UINT16:
248f858927fSRob Herring 			write_propval_int(f, p, chunk_len, 2);
249f858927fSRob Herring 			break;
250f858927fSRob Herring 		case TYPE_UINT32:
251a77725a9SRob Herring 			m_phandle = prop->val.markers;
252a77725a9SRob Herring 			for_each_marker_of_type(m_phandle, REF_PHANDLE)
253a77725a9SRob Herring 				if (m->offset == m_phandle->offset)
254a77725a9SRob Herring 					break;
255a77725a9SRob Herring 
256a77725a9SRob Herring 			if (m_phandle) {
257a77725a9SRob Herring 				if (m_phandle->ref[0] == '/')
258a77725a9SRob Herring 					fprintf(f, "&{%s}", m_phandle->ref);
259a77725a9SRob Herring 				else
260a77725a9SRob Herring 					fprintf(f, "&%s", m_phandle->ref);
261a77725a9SRob Herring 				if (chunk_len > 4) {
262a77725a9SRob Herring 					fputc(' ', f);
263a77725a9SRob Herring 					write_propval_int(f, p + 4, chunk_len - 4, 4);
264a77725a9SRob Herring 				}
265a77725a9SRob Herring 			} else {
266f858927fSRob Herring 				write_propval_int(f, p, chunk_len, 4);
267a77725a9SRob Herring 			}
268*12d638f4SRob Herring (Arm) 			if (data_len > chunk_len)
269*12d638f4SRob Herring (Arm) 				fputc(' ', f);
270f858927fSRob Herring 			break;
271f858927fSRob Herring 		case TYPE_UINT64:
272f858927fSRob Herring 			write_propval_int(f, p, chunk_len, 8);
273f858927fSRob Herring 			break;
274f858927fSRob Herring 		case TYPE_STRING:
275f858927fSRob Herring 			write_propval_string(f, p, chunk_len);
276f858927fSRob Herring 			break;
277f858927fSRob Herring 		default:
278f858927fSRob Herring 			write_propval_int(f, p, chunk_len, 1);
279f858927fSRob Herring 		}
280f858927fSRob Herring 
281c2e7075cSRob Herring 		if (chunk_len == data_len) {
282c2e7075cSRob Herring 			size_t pos = m->offset + chunk_len;
283c2e7075cSRob Herring 			fprintf(f, pos == len ? "%s" : "%s,",
284c2e7075cSRob Herring 			        delim_end[emit_type] ? : "");
285c2e7075cSRob Herring 			emit_type = TYPE_NONE;
286f858927fSRob Herring 		}
287c2e7075cSRob Herring 	}
288c2e7075cSRob Herring 	fprintf(f, ";");
289c2e7075cSRob Herring 	if (annotate) {
290c2e7075cSRob Herring 		srcstr = srcpos_string_first(prop->srcpos, annotate);
291c2e7075cSRob Herring 		if (srcstr) {
292c2e7075cSRob Herring 			fprintf(f, " /* %s */", srcstr);
293c2e7075cSRob Herring 			free(srcstr);
294c2e7075cSRob Herring 		}
295c2e7075cSRob Herring 	}
296c2e7075cSRob Herring 	fprintf(f, "\n");
2979fffb55fSDavid Gibson }
2989fffb55fSDavid Gibson 
write_tree_source_node(FILE * f,struct node * tree,int level)2999fffb55fSDavid Gibson static void write_tree_source_node(FILE *f, struct node *tree, int level)
3009fffb55fSDavid Gibson {
3019fffb55fSDavid Gibson 	struct property *prop;
3029fffb55fSDavid Gibson 	struct node *child;
303658f29a5SJohn Bonesio 	struct label *l;
304c2e7075cSRob Herring 	char *srcstr;
3059fffb55fSDavid Gibson 
3069fffb55fSDavid Gibson 	write_prefix(f, level);
307658f29a5SJohn Bonesio 	for_each_label(tree->labels, l)
308658f29a5SJohn Bonesio 		fprintf(f, "%s: ", l->label);
3099fffb55fSDavid Gibson 	if (tree->name && (*tree->name))
310c2e7075cSRob Herring 		fprintf(f, "%s {", tree->name);
3119fffb55fSDavid Gibson 	else
312c2e7075cSRob Herring 		fprintf(f, "/ {");
313c2e7075cSRob Herring 
314c2e7075cSRob Herring 	if (annotate) {
315c2e7075cSRob Herring 		srcstr = srcpos_string_first(tree->srcpos, annotate);
316c2e7075cSRob Herring 		if (srcstr) {
317c2e7075cSRob Herring 			fprintf(f, " /* %s */", srcstr);
318c2e7075cSRob Herring 			free(srcstr);
319c2e7075cSRob Herring 		}
320c2e7075cSRob Herring 	}
321c2e7075cSRob Herring 	fprintf(f, "\n");
3229fffb55fSDavid Gibson 
3239fffb55fSDavid Gibson 	for_each_property(tree, prop) {
3249fffb55fSDavid Gibson 		write_prefix(f, level+1);
325658f29a5SJohn Bonesio 		for_each_label(prop->labels, l)
326658f29a5SJohn Bonesio 			fprintf(f, "%s: ", l->label);
3279fffb55fSDavid Gibson 		fprintf(f, "%s", prop->name);
3289fffb55fSDavid Gibson 		write_propval(f, prop);
3299fffb55fSDavid Gibson 	}
3309fffb55fSDavid Gibson 	for_each_child(tree, child) {
3319fffb55fSDavid Gibson 		fprintf(f, "\n");
3329fffb55fSDavid Gibson 		write_tree_source_node(f, child, level+1);
3339fffb55fSDavid Gibson 	}
3349fffb55fSDavid Gibson 	write_prefix(f, level);
335c2e7075cSRob Herring 	fprintf(f, "};");
336c2e7075cSRob Herring 	if (annotate) {
337c2e7075cSRob Herring 		srcstr = srcpos_string_last(tree->srcpos, annotate);
338c2e7075cSRob Herring 		if (srcstr) {
339c2e7075cSRob Herring 			fprintf(f, " /* %s */", srcstr);
340c2e7075cSRob Herring 			free(srcstr);
3419fffb55fSDavid Gibson 		}
342c2e7075cSRob Herring 	}
343c2e7075cSRob Herring 	fprintf(f, "\n");
344c2e7075cSRob Herring }
3459fffb55fSDavid Gibson 
dt_to_source(FILE * f,struct dt_info * dti)3466f05afcbSRob Herring void dt_to_source(FILE *f, struct dt_info *dti)
3479fffb55fSDavid Gibson {
3489fffb55fSDavid Gibson 	struct reserve_info *re;
3499fffb55fSDavid Gibson 
3509fffb55fSDavid Gibson 	fprintf(f, "/dts-v1/;\n\n");
3519fffb55fSDavid Gibson 
3526f05afcbSRob Herring 	for (re = dti->reservelist; re; re = re->next) {
353658f29a5SJohn Bonesio 		struct label *l;
354658f29a5SJohn Bonesio 
355658f29a5SJohn Bonesio 		for_each_label(re->labels, l)
356658f29a5SJohn Bonesio 			fprintf(f, "%s: ", l->label);
3579fffb55fSDavid Gibson 		fprintf(f, "/memreserve/\t0x%016llx 0x%016llx;\n",
35889d12310SRob Herring 			(unsigned long long)re->address,
35989d12310SRob Herring 			(unsigned long long)re->size);
3609fffb55fSDavid Gibson 	}
3619fffb55fSDavid Gibson 
3626f05afcbSRob Herring 	write_tree_source_node(f, dti->dt, 0);
3639fffb55fSDavid Gibson }
364