[deliverable/linux.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(fmt,args...)	printf(fmt, ##args)
#else
#define debug(fmt,args...)
#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 phandle_format;	/* Use linux,phandle or phandle properties */

#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))
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))

/* 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){ /* 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);

int data_is_one_string(struct data d);

/* DT constraints */

#define MAX_PROPNAME_LEN	31
#define MAX_NODENAME_LEN	31

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

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

	struct property *next;

	struct label *labels;
};

struct node {
	int 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;
};

static inline struct label *for_each_label_next(struct label *l)
{
	do {
		l = l->next;
	} while (l && l->deleted);

	return l;
}

#define for_each_label(l0, l) \
	for ((l) = (l0); (l); (l) = for_each_label_next(l))

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

static inline struct property *for_each_property_next(struct property *p)
{
	do {
		p = p->next;
	} while (p && p->deleted);

	return p;
}

#define for_each_property(n, p) \
	for ((p) = (n)->proplist; (p); (p) = for_each_property_next(p))

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

static inline struct node *for_each_child_next(struct node *c)
{
	do {
		c = c->next_sibling;
	} while (c && c->deleted);

	return c;
}

#define for_each_child(n, c) \
	for ((c) = (n)->children; (c); (c) = for_each_child_next(c))

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

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);

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 boot_info {
	struct reserve_info *reservelist;
	struct node *dt;		/* the device tree */
	uint32_t boot_cpuid_phys;
};

struct boot_info *build_boot_info(struct reserve_info *reservelist,
				  struct node *tree, uint32_t boot_cpuid_phys);
void sort_tree(struct boot_info *bi);

/* Checks */

void parse_checks_option(bool warn, bool error, const char *optarg);
void process_checks(int force, struct boot_info *bi);

/* Flattened trees */

void dt_to_blob(FILE *f, struct boot_info *bi, int version);
void dt_to_asm(FILE *f, struct boot_info *bi, int version);

struct boot_info *dt_from_blob(const char *fname);

/* Tree source */

void dt_to_source(FILE *f, struct boot_info *bi);
struct boot_info *dt_from_source(const char *f);

/* FS trees */

struct boot_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
	41	#define debug(fmt,args...) printf(fmt, ##args)
	42	#else
	43	#define debug(fmt,args...)
	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 */
658f29a5	56	extern int phandle_format; /* Use linux,phandle or phandle properties */
a4da2e3e	57
658f29a5 JB	58	#define PHANDLE_LEGACY 0x1
	59	#define PHANDLE_EPAPR 0x2
	60	#define PHANDLE_BOTH 0x3
a4da2e3e	61
ed95d745	62	typedef uint32_t cell_t;
a4da2e3e	63
a4da2e3e DG	64
	65	#define streq(a, b) (strcmp((a), (b)) == 0)
	66	#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
	67
	68	#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
	69	#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
	70
	71	/* Data blobs */
	72	enum markertype {
	73	REF_PHANDLE,
	74	REF_PATH,
	75	LABEL,
	76	};
	77
	78	struct marker {
	79	enum markertype type;
	80	int offset;
	81	char *ref;
	82	struct marker *next;
	83	};
	84
	85	struct data {
	86	int len;
	87	char *val;
a4da2e3e DG	88	struct marker *markers;
	89	};
	90
	91
	92	#define empty_data ((struct data){ /* all .members = 0 or NULL */ })
	93
	94	#define for_each_marker(m) \
	95	for (; (m); (m) = (m)->next)
	96	#define for_each_marker_of_type(m, t) \
	97	for_each_marker(m) \
	98	if ((m)->type == (t))
	99
	100	void data_free(struct data d);
	101
	102	struct data data_grow_for(struct data d, int xlen);
	103
	104	struct data data_copy_mem(const char *mem, int len);
	105	struct data data_copy_escape_string(const char *s, int len);
	106	struct data data_copy_file(FILE *f, size_t len);
	107
	108	struct data data_append_data(struct data d, const void *p, int len);
	109	struct data data_insert_at_marker(struct data d, struct marker *m,
	110	const void *p, int len);
	111	struct data data_merge(struct data d1, struct data d2);
	112	struct data data_append_cell(struct data d, cell_t word);
cd296721	113	struct data data_append_integer(struct data d, uint64_t word, int bits);
a4da2e3e	114	struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
ed95d745	115	struct data data_append_addr(struct data d, uint64_t addr);
a4da2e3e DG	116	struct data data_append_byte(struct data d, uint8_t byte);
	117	struct data data_append_zeroes(struct data d, int len);
	118	struct data data_append_align(struct data d, int align);
	119
	120	struct data data_add_marker(struct data d, enum markertype type, char *ref);
	121
	122	int data_is_one_string(struct data d);
	123
	124	/* DT constraints */
	125
	126	#define MAX_PROPNAME_LEN 31
	127	#define MAX_NODENAME_LEN 31
	128
	129	/* Live trees */
658f29a5	130	struct label {
cd296721	131	int deleted;
658f29a5 JB	132	char *label;
	133	struct label *next;
	134	};
	135
a4da2e3e	136	struct property {
cd296721	137	int deleted;
a4da2e3e DG	138	char *name;
	139	struct data val;
	140
	141	struct property *next;
	142
658f29a5	143	struct label *labels;
a4da2e3e DG	144	};
	145
	146	struct node {
cd296721	147	int deleted;
a4da2e3e DG	148	char *name;
	149	struct property *proplist;
	150	struct node *children;
	151
	152	struct node *parent;
	153	struct node *next_sibling;
	154
	155	char *fullpath;
	156	int basenamelen;
	157
	158	cell_t phandle;
	159	int addr_cells, size_cells;
	160
658f29a5	161	struct label *labels;
a4da2e3e DG	162	};
a4da2e3e DG	163
cd296721 SW	164	static inline struct label for_each_label_next(struct label l)
	165	{
	166	do {
	167	l = l->next;
	168	} while (l && l->deleted);
	169
	170	return l;
	171	}
	172
658f29a5	173	#define for_each_label(l0, l) \
cd296721 SW	174	for ((l) = (l0); (l); (l) = for_each_label_next(l))
	175
	176	#define for_each_label_withdel(l0, l) \
658f29a5 JB	177	for ((l) = (l0); (l); (l) = (l)->next)
658f29a5 JB	178
cd296721 SW	179	static inline struct property for_each_property_next(struct property p)
	180	{
	181	do {
	182	p = p->next;
	183	} while (p && p->deleted);
	184
	185	return p;
	186	}
	187
a4da2e3e	188	#define for_each_property(n, p) \
cd296721 SW	189	for ((p) = (n)->proplist; (p); (p) = for_each_property_next(p))
	190
	191	#define for_each_property_withdel(n, p) \
a4da2e3e DG	192	for ((p) = (n)->proplist; (p); (p) = (p)->next)
a4da2e3e DG	193
cd296721 SW	194	static inline struct node for_each_child_next(struct node c)
	195	{
	196	do {
	197	c = c->next_sibling;
	198	} while (c && c->deleted);
	199
	200	return c;
	201	}
	202
	203	#define for_each_child(n, c) \
	204	for ((c) = (n)->children; (c); (c) = for_each_child_next(c))
	205
	206	#define for_each_child_withdel(n, c) \
a4da2e3e DG	207	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
a4da2e3e DG	208
658f29a5	209	void add_label(struct label *labels, char label);
cd296721	210	void delete_labels(struct label **labels);
658f29a5 JB	211
658f29a5 JB	212	struct property build_property(char name, struct data val);
cd296721	213	struct property build_property_delete(char name);
a4da2e3e DG	214	struct property chain_property(struct property first, struct property *list);
	215	struct property reverse_properties(struct property first);
	216
	217	struct node build_node(struct property proplist, struct node *children);
cd296721	218	struct node *build_node_delete(void);
658f29a5	219	struct node name_node(struct node node, char *name);
a4da2e3e	220	struct node chain_node(struct node first, struct node *list);
658f29a5	221	struct node merge_nodes(struct node old_node, struct node *new_node);
a4da2e3e DG	222
a4da2e3e DG	223	void add_property(struct node node, struct property prop);
cd296721 SW	224	void delete_property_by_name(struct node node, char name);
cd296721 SW	225	void delete_property(struct property *prop);
a4da2e3e	226	void add_child(struct node parent, struct node child);
cd296721 SW	227	void delete_node_by_name(struct node parent, char name);
cd296721 SW	228	void delete_node(struct node *node);
a4da2e3e DG	229
	230	const char get_unitname(struct node node);
	231	struct property get_property(struct node node, const char *propname);
	232	cell_t propval_cell(struct property *prop);
658f29a5 JB	233	struct property get_property_by_label(struct node tree, const char *label,
	234	struct node **node);
	235	struct marker get_marker_label(struct node tree, const char *label,
	236	struct node node, struct property prop);
a4da2e3e DG	237	struct node get_subnode(struct node node, const char *nodename);
	238	struct node get_node_by_path(struct node tree, const char *path);
	239	struct node get_node_by_label(struct node tree, const char *label);
	240	struct node get_node_by_phandle(struct node tree, cell_t phandle);
	241	struct node get_node_by_ref(struct node tree, const char *ref);
	242	cell_t get_node_phandle(struct node root, struct node node);
	243
658f29a5 JB	244	uint32_t guess_boot_cpuid(struct node *tree);
658f29a5 JB	245
a4da2e3e DG	246	/* Boot info (tree plus memreserve information */
	247
	248	struct reserve_info {
	249	struct fdt_reserve_entry re;
	250
	251	struct reserve_info *next;
	252
658f29a5	253	struct label *labels;
a4da2e3e DG	254	};
a4da2e3e DG	255
658f29a5	256	struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
a4da2e3e DG	257	struct reserve_info chain_reserve_entry(struct reserve_info first,
	258	struct reserve_info *list);
	259	struct reserve_info add_reserve_entry(struct reserve_info list,
	260	struct reserve_info *new);
	261
	262
	263	struct boot_info {
	264	struct reserve_info *reservelist;
	265	struct node dt; / the device tree */
ed95d745	266	uint32_t boot_cpuid_phys;
a4da2e3e DG	267	};
	268
	269	struct boot_info build_boot_info(struct reserve_info reservelist,
ed95d745	270	struct node *tree, uint32_t boot_cpuid_phys);
658f29a5	271	void sort_tree(struct boot_info *bi);
a4da2e3e DG	272
	273	/* Checks */
	274
cd296721	275	void parse_checks_option(bool warn, bool error, const char *optarg);
ed95d745	276	void process_checks(int force, struct boot_info *bi);
a4da2e3e DG	277
	278	/* Flattened trees */
	279
ed95d745 DG	280	void dt_to_blob(FILE f, struct boot_info bi, int version);
ed95d745 DG	281	void dt_to_asm(FILE f, struct boot_info bi, int version);
a4da2e3e	282
ed95d745	283	struct boot_info dt_from_blob(const char fname);
a4da2e3e DG	284
	285	/* Tree source */
	286
	287	void dt_to_source(FILE f, struct boot_info bi);
	288	struct boot_info dt_from_source(const char f);
	289
	290	/* FS trees */
	291
	292	struct boot_info dt_from_fs(const char dirname);
	293
a4da2e3e	294	#endif /* _DTC_H */