[mirror_ubuntu-bionic-kernel.git] / scripts / dtc / dtc.h

#ifndef _DTC_H
#define _DTC_H

/*
 * (C) Copyright David Gibson <dwg@au1.ibm.com>, 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 <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <unistd.h>

#include <libfdt_env.h>
#include <fdt.h>

#include "util.h"

#ifdef DEBUG
#define debug(...)	printf(__VA_ARGS__)
#else
#define debug(...)
#endif


#define DEFAULT_FDT_VERSION	17

/*
 * Command line options
 */
extern int quiet;		/* Level of quietness */
extern int reservenum;		/* Number of memory reservation slots */
extern int minsize;		/* Minimum blob size */
extern int padsize;		/* Additional padding to blob */
extern int alignsize;		/* Additional padding to blob accroding to the alignsize */
extern int phandle_format;	/* Use linux,phandle or phandle properties */
extern int generate_symbols;	/* generate symbols for nodes with labels */
extern int generate_fixups;	/* generate fixups */
extern int auto_label_aliases;	/* auto generate labels -> aliases */

#define PHANDLE_LEGACY	0x1
#define PHANDLE_EPAPR	0x2
#define PHANDLE_BOTH	0x3

typedef uint32_t cell_t;


#define streq(a, b)	(strcmp((a), (b)) == 0)
#define strneq(a, b, n)	(strncmp((a), (b), (n)) == 0)

#define ALIGN(x, a)	(((x) + (a) - 1) & ~((a) - 1))

/* Data blobs */
enum markertype {
	REF_PHANDLE,
	REF_PATH,
	LABEL,
};

struct  marker {
	enum markertype type;
	int offset;
	char *ref;
	struct marker *next;
};

struct data {
	int len;
	char *val;
	struct marker *markers;
};


#define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })

#define for_each_marker(m) \
	for (; (m); (m) = (m)->next)
#define for_each_marker_of_type(m, t) \
	for_each_marker(m) \
		if ((m)->type == (t))

void data_free(struct data d);

struct data data_grow_for(struct data d, int xlen);

struct data data_copy_mem(const char *mem, int len);
struct data data_copy_escape_string(const char *s, int len);
struct data data_copy_file(FILE *f, size_t len);

struct data data_append_data(struct data d, const void *p, int len);
struct data data_insert_at_marker(struct data d, struct marker *m,
				  const void *p, int len);
struct data data_merge(struct data d1, struct data d2);
struct data data_append_cell(struct data d, cell_t word);
struct data data_append_integer(struct data d, uint64_t word, int bits);
struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
struct data data_append_addr(struct data d, uint64_t addr);
struct data data_append_byte(struct data d, uint8_t byte);
struct data data_append_zeroes(struct data d, int len);
struct data data_append_align(struct data d, int align);

struct data data_add_marker(struct data d, enum markertype type, char *ref);

bool data_is_one_string(struct data d);

/* DT constraints */

#define MAX_PROPNAME_LEN	31
#define MAX_NODENAME_LEN	31

/* Live trees */
struct label {
	bool deleted;
	char *label;
	struct label *next;
};

struct property {
	bool deleted;
	char *name;
	struct data val;

	struct property *next;

	struct label *labels;
};

struct node {
	bool deleted;
	char *name;
	struct property *proplist;
	struct node *children;

	struct node *parent;
	struct node *next_sibling;

	char *fullpath;
	int basenamelen;

	cell_t phandle;
	int addr_cells, size_cells;

	struct label *labels;
};

#define for_each_label_withdel(l0, l) \
	for ((l) = (l0); (l); (l) = (l)->next)

#define for_each_label(l0, l) \
	for_each_label_withdel(l0, l) \
		if (!(l)->deleted)

#define for_each_property_withdel(n, p) \
	for ((p) = (n)->proplist; (p); (p) = (p)->next)

#define for_each_property(n, p) \
	for_each_property_withdel(n, p) \
		if (!(p)->deleted)

#define for_each_child_withdel(n, c) \
	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)

#define for_each_child(n, c) \
	for_each_child_withdel(n, c) \
		if (!(c)->deleted)

void add_label(struct label **labels, char *label);
void delete_labels(struct label **labels);

struct property *build_property(char *name, struct data val);
struct property *build_property_delete(char *name);
struct property *chain_property(struct property *first, struct property *list);
struct property *reverse_properties(struct property *first);

struct node *build_node(struct property *proplist, struct node *children);
struct node *build_node_delete(void);
struct node *name_node(struct node *node, char *name);
struct node *chain_node(struct node *first, struct node *list);
struct node *merge_nodes(struct node *old_node, struct node *new_node);

void add_property(struct node *node, struct property *prop);
void delete_property_by_name(struct node *node, char *name);
void delete_property(struct property *prop);
void add_child(struct node *parent, struct node *child);
void delete_node_by_name(struct node *parent, char *name);
void delete_node(struct node *node);
void append_to_property(struct node *node,
			char *name, const void *data, int len);

const char *get_unitname(struct node *node);
struct property *get_property(struct node *node, const char *propname);
cell_t propval_cell(struct property *prop);
struct property *get_property_by_label(struct node *tree, const char *label,
				       struct node **node);
struct marker *get_marker_label(struct node *tree, const char *label,
				struct node **node, struct property **prop);
struct node *get_subnode(struct node *node, const char *nodename);
struct node *get_node_by_path(struct node *tree, const char *path);
struct node *get_node_by_label(struct node *tree, const char *label);
struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
struct node *get_node_by_ref(struct node *tree, const char *ref);
cell_t get_node_phandle(struct node *root, struct node *node);

uint32_t guess_boot_cpuid(struct node *tree);

/* Boot info (tree plus memreserve information */

struct reserve_info {
	struct fdt_reserve_entry re;

	struct reserve_info *next;

	struct label *labels;
};

struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
struct reserve_info *chain_reserve_entry(struct reserve_info *first,
					 struct reserve_info *list);
struct reserve_info *add_reserve_entry(struct reserve_info *list,
				       struct reserve_info *new);


struct dt_info {
	unsigned int dtsflags;
	struct reserve_info *reservelist;
	uint32_t boot_cpuid_phys;
	struct node *dt;		/* the device tree */
};

/* DTS version flags definitions */
#define DTSF_V1		0x0001	/* /dts-v1/ */
#define DTSF_PLUGIN	0x0002	/* /plugin/ */

struct dt_info *build_dt_info(unsigned int dtsflags,
			      struct reserve_info *reservelist,
			      struct node *tree, uint32_t boot_cpuid_phys);
void sort_tree(struct dt_info *dti);
void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
void generate_fixups_tree(struct dt_info *dti, char *name);
void generate_local_fixups_tree(struct dt_info *dti, char *name);

/* Checks */

void parse_checks_option(bool warn, bool error, const char *arg);
void process_checks(bool force, struct dt_info *dti);

/* Flattened trees */

void dt_to_blob(FILE *f, struct dt_info *dti, int version);
void dt_to_asm(FILE *f, struct dt_info *dti, int version);

struct dt_info *dt_from_blob(const char *fname);

/* Tree source */

void dt_to_source(FILE *f, struct dt_info *dti);
struct dt_info *dt_from_source(const char *f);

/* FS trees */

struct dt_info *dt_from_fs(const char *dirname);

#endif /* _DTC_H */
Commit	Line	Data
a4da2e3e DG	1	#ifndef _DTC_H
	2	#define _DTC_H
	3
	4	/*
	5	* (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005.
	6	*
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as
	10	* published by the Free Software Foundation; either version 2 of the
	11	* License, or (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	21	* USA
	22	*/
	23
	24	#include <stdio.h>
	25	#include <string.h>
	26	#include <stdlib.h>
	27	#include <stdint.h>
cd296721	28	#include <stdbool.h>
a4da2e3e DG	29	#include <stdarg.h>
	30	#include <assert.h>
	31	#include <ctype.h>
	32	#include <errno.h>
	33	#include <unistd.h>
a4da2e3e	34
ed95d745	35	#include <libfdt_env.h>
a4da2e3e DG	36	#include <fdt.h>
a4da2e3e DG	37
658f29a5 JB	38	#include "util.h"
	39
	40	#ifdef DEBUG
47605971	41	#define debug(...) printf(__VA_ARGS__)
658f29a5	42	#else
47605971	43	#define debug(...)
658f29a5 JB	44	#endif
	45
	46
a4da2e3e	47	#define DEFAULT_FDT_VERSION 17
658f29a5	48
a4da2e3e DG	49	/*
	50	* Command line options
	51	*/
	52	extern int quiet; /* Level of quietness */
	53	extern int reservenum; /* Number of memory reservation slots */
	54	extern int minsize; /* Minimum blob size */
	55	extern int padsize; /* Additional padding to blob */
6f05afcb	56	extern int alignsize; /* Additional padding to blob accroding to the alignsize */
658f29a5	57	extern int phandle_format; /* Use linux,phandle or phandle properties */
6f05afcb RH	58	extern int generate_symbols; /* generate symbols for nodes with labels */
	59	extern int generate_fixups; /* generate fixups */
	60	extern int auto_label_aliases; /* auto generate labels -> aliases */
a4da2e3e	61
658f29a5 JB	62	#define PHANDLE_LEGACY 0x1
	63	#define PHANDLE_EPAPR 0x2
	64	#define PHANDLE_BOTH 0x3
a4da2e3e	65
ed95d745	66	typedef uint32_t cell_t;
a4da2e3e	67
a4da2e3e DG	68
	69	#define streq(a, b) (strcmp((a), (b)) == 0)
	70	#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
	71
	72	#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
a4da2e3e DG	73
	74	/* Data blobs */
	75	enum markertype {
	76	REF_PHANDLE,
	77	REF_PATH,
	78	LABEL,
	79	};
	80
	81	struct marker {
	82	enum markertype type;
	83	int offset;
	84	char *ref;
	85	struct marker *next;
	86	};
	87
	88	struct data {
	89	int len;
	90	char *val;
a4da2e3e DG	91	struct marker *markers;
	92	};
	93
	94
47605971	95	#define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
a4da2e3e DG	96
	97	#define for_each_marker(m) \
	98	for (; (m); (m) = (m)->next)
	99	#define for_each_marker_of_type(m, t) \
	100	for_each_marker(m) \
	101	if ((m)->type == (t))
	102
	103	void data_free(struct data d);
	104
	105	struct data data_grow_for(struct data d, int xlen);
	106
	107	struct data data_copy_mem(const char *mem, int len);
	108	struct data data_copy_escape_string(const char *s, int len);
	109	struct data data_copy_file(FILE *f, size_t len);
	110
	111	struct data data_append_data(struct data d, const void *p, int len);
	112	struct data data_insert_at_marker(struct data d, struct marker *m,
	113	const void *p, int len);
	114	struct data data_merge(struct data d1, struct data d2);
	115	struct data data_append_cell(struct data d, cell_t word);
cd296721	116	struct data data_append_integer(struct data d, uint64_t word, int bits);
a4da2e3e	117	struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
ed95d745	118	struct data data_append_addr(struct data d, uint64_t addr);
a4da2e3e DG	119	struct data data_append_byte(struct data d, uint8_t byte);
	120	struct data data_append_zeroes(struct data d, int len);
	121	struct data data_append_align(struct data d, int align);
	122
	123	struct data data_add_marker(struct data d, enum markertype type, char *ref);
	124
47605971	125	bool data_is_one_string(struct data d);
a4da2e3e DG	126
	127	/* DT constraints */
	128
	129	#define MAX_PROPNAME_LEN 31
	130	#define MAX_NODENAME_LEN 31
	131
	132	/* Live trees */
658f29a5	133	struct label {
47605971	134	bool deleted;
658f29a5 JB	135	char *label;
	136	struct label *next;
	137	};
	138
a4da2e3e	139	struct property {
47605971	140	bool deleted;
a4da2e3e DG	141	char *name;
	142	struct data val;
	143
	144	struct property *next;
	145
658f29a5	146	struct label *labels;
a4da2e3e DG	147	};
	148
	149	struct node {
47605971	150	bool deleted;
a4da2e3e DG	151	char *name;
	152	struct property *proplist;
	153	struct node *children;
	154
	155	struct node *parent;
	156	struct node *next_sibling;
	157
	158	char *fullpath;
	159	int basenamelen;
	160
	161	cell_t phandle;
	162	int addr_cells, size_cells;
	163
658f29a5	164	struct label *labels;
a4da2e3e DG	165	};
a4da2e3e DG	166
cd296721	167	#define for_each_label_withdel(l0, l) \
658f29a5 JB	168	for ((l) = (l0); (l); (l) = (l)->next)
658f29a5 JB	169
205a8eb7 SW	170	#define for_each_label(l0, l) \
	171	for_each_label_withdel(l0, l) \
	172	if (!(l)->deleted)
cd296721 SW	173
cd296721 SW	174	#define for_each_property_withdel(n, p) \
a4da2e3e DG	175	for ((p) = (n)->proplist; (p); (p) = (p)->next)
a4da2e3e DG	176
205a8eb7 SW	177	#define for_each_property(n, p) \
	178	for_each_property_withdel(n, p) \
	179	if (!(p)->deleted)
cd296721 SW	180
cd296721 SW	181	#define for_each_child_withdel(n, c) \
a4da2e3e DG	182	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
a4da2e3e DG	183
205a8eb7 SW	184	#define for_each_child(n, c) \
	185	for_each_child_withdel(n, c) \
	186	if (!(c)->deleted)
	187
658f29a5	188	void add_label(struct label *labels, char label);
cd296721	189	void delete_labels(struct label **labels);
658f29a5 JB	190
658f29a5 JB	191	struct property build_property(char name, struct data val);
cd296721	192	struct property build_property_delete(char name);
a4da2e3e DG	193	struct property chain_property(struct property first, struct property *list);
	194	struct property reverse_properties(struct property first);
	195
	196	struct node build_node(struct property proplist, struct node *children);
cd296721	197	struct node *build_node_delete(void);
658f29a5	198	struct node name_node(struct node node, char *name);
a4da2e3e	199	struct node chain_node(struct node first, struct node *list);
658f29a5	200	struct node merge_nodes(struct node old_node, struct node *new_node);
a4da2e3e DG	201
a4da2e3e DG	202	void add_property(struct node node, struct property prop);
cd296721 SW	203	void delete_property_by_name(struct node node, char name);
cd296721 SW	204	void delete_property(struct property *prop);
a4da2e3e	205	void add_child(struct node parent, struct node child);
cd296721 SW	206	void delete_node_by_name(struct node parent, char name);
cd296721 SW	207	void delete_node(struct node *node);
6f05afcb RH	208	void append_to_property(struct node *node,
6f05afcb RH	209	char name, const void data, int len);
a4da2e3e DG	210
	211	const char get_unitname(struct node node);
	212	struct property get_property(struct node node, const char *propname);
	213	cell_t propval_cell(struct property *prop);
658f29a5 JB	214	struct property get_property_by_label(struct node tree, const char *label,
	215	struct node **node);
	216	struct marker get_marker_label(struct node tree, const char *label,
	217	struct node node, struct property prop);
a4da2e3e DG	218	struct node get_subnode(struct node node, const char *nodename);
	219	struct node get_node_by_path(struct node tree, const char *path);
	220	struct node get_node_by_label(struct node tree, const char *label);
	221	struct node get_node_by_phandle(struct node tree, cell_t phandle);
	222	struct node get_node_by_ref(struct node tree, const char *ref);
	223	cell_t get_node_phandle(struct node root, struct node node);
	224
658f29a5 JB	225	uint32_t guess_boot_cpuid(struct node *tree);
658f29a5 JB	226
a4da2e3e DG	227	/* Boot info (tree plus memreserve information */
	228
	229	struct reserve_info {
	230	struct fdt_reserve_entry re;
	231
	232	struct reserve_info *next;
	233
658f29a5	234	struct label *labels;
a4da2e3e DG	235	};
a4da2e3e DG	236
658f29a5	237	struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
a4da2e3e DG	238	struct reserve_info chain_reserve_entry(struct reserve_info first,
	239	struct reserve_info *list);
	240	struct reserve_info add_reserve_entry(struct reserve_info list,
	241	struct reserve_info *new);
	242
	243
6f05afcb RH	244	struct dt_info {
6f05afcb RH	245	unsigned int dtsflags;
a4da2e3e	246	struct reserve_info *reservelist;
ed95d745	247	uint32_t boot_cpuid_phys;
6f05afcb	248	struct node dt; / the device tree */
a4da2e3e DG	249	};
a4da2e3e DG	250
6f05afcb RH	251	/* DTS version flags definitions */
	252	#define DTSF_V1 0x0001 /* /dts-v1/ */
	253	#define DTSF_PLUGIN 0x0002 /* /plugin/ */
	254
	255	struct dt_info *build_dt_info(unsigned int dtsflags,
	256	struct reserve_info *reservelist,
	257	struct node *tree, uint32_t boot_cpuid_phys);
	258	void sort_tree(struct dt_info *dti);
	259	void generate_label_tree(struct dt_info dti, char name, bool allocph);
	260	void generate_fixups_tree(struct dt_info dti, char name);
	261	void generate_local_fixups_tree(struct dt_info dti, char name);
a4da2e3e DG	262
	263	/* Checks */
	264
47605971	265	void parse_checks_option(bool warn, bool error, const char *arg);
6f05afcb	266	void process_checks(bool force, struct dt_info *dti);
a4da2e3e DG	267
	268	/* Flattened trees */
	269
6f05afcb RH	270	void dt_to_blob(FILE f, struct dt_info dti, int version);
6f05afcb RH	271	void dt_to_asm(FILE f, struct dt_info dti, int version);
a4da2e3e	272
6f05afcb	273	struct dt_info dt_from_blob(const char fname);
a4da2e3e DG	274
	275	/* Tree source */
	276
6f05afcb RH	277	void dt_to_source(FILE f, struct dt_info dti);
6f05afcb RH	278	struct dt_info dt_from_source(const char f);
a4da2e3e DG	279
	280	/* FS trees */
	281
6f05afcb	282	struct dt_info dt_from_fs(const char dirname);
a4da2e3e	283
a4da2e3e	284	#endif /* _DTC_H */