Home | History | Annotate | Download | only in dtc
      1 #ifndef DTC_H
      2 #define DTC_H
      3 
      4 /*
      5  * (C) Copyright David Gibson <dwg (at) 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>
     28 #include <stdbool.h>
     29 #include <stdarg.h>
     30 #include <assert.h>
     31 #include <ctype.h>
     32 #include <errno.h>
     33 #include <unistd.h>
     34 #include <inttypes.h>
     35 
     36 #include <libfdt_env.h>
     37 #include <fdt.h>
     38 
     39 #include "util.h"
     40 
     41 #ifdef DEBUG
     42 #define debug(...)	printf(__VA_ARGS__)
     43 #else
     44 #define debug(...)
     45 #endif
     46 
     47 #define DEFAULT_FDT_VERSION	17
     48 
     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 */
     56 extern int alignsize;		/* Additional padding to blob accroding to the alignsize */
     57 extern int phandle_format;	/* Use linux,phandle or phandle properties */
     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 */
     61 
     62 #define PHANDLE_LEGACY	0x1
     63 #define PHANDLE_EPAPR	0x2
     64 #define PHANDLE_BOTH	0x3
     65 
     66 typedef uint32_t cell_t;
     67 
     68 
     69 #define streq(a, b)	(strcmp((a), (b)) == 0)
     70 #define strstarts(s, prefix)	(strncmp((s), (prefix), strlen(prefix)) == 0)
     71 #define strprefixeq(a, n, b)	(strlen(b) == (n) && (memcmp(a, b, n) == 0))
     72 
     73 #define ALIGN(x, a)	(((x) + (a) - 1) & ~((a) - 1))
     74 
     75 /* Data blobs */
     76 enum markertype {
     77 	REF_PHANDLE,
     78 	REF_PATH,
     79 	LABEL,
     80 };
     81 
     82 struct  marker {
     83 	enum markertype type;
     84 	int offset;
     85 	char *ref;
     86 	struct marker *next;
     87 };
     88 
     89 struct data {
     90 	int len;
     91 	char *val;
     92 	struct marker *markers;
     93 };
     94 
     95 
     96 #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
     97 
     98 #define for_each_marker(m) \
     99 	for (; (m); (m) = (m)->next)
    100 #define for_each_marker_of_type(m, t) \
    101 	for_each_marker(m) \
    102 		if ((m)->type == (t))
    103 
    104 void data_free(struct data d);
    105 
    106 struct data data_grow_for(struct data d, int xlen);
    107 
    108 struct data data_copy_mem(const char *mem, int len);
    109 struct data data_copy_escape_string(const char *s, int len);
    110 struct data data_copy_file(FILE *f, size_t len);
    111 
    112 struct data data_append_data(struct data d, const void *p, int len);
    113 struct data data_insert_at_marker(struct data d, struct marker *m,
    114 				  const void *p, int len);
    115 struct data data_merge(struct data d1, struct data d2);
    116 struct data data_append_cell(struct data d, cell_t word);
    117 struct data data_append_integer(struct data d, uint64_t word, int bits);
    118 struct data data_append_re(struct data d, uint64_t address, uint64_t size);
    119 struct data data_append_addr(struct data d, uint64_t addr);
    120 struct data data_append_byte(struct data d, uint8_t byte);
    121 struct data data_append_zeroes(struct data d, int len);
    122 struct data data_append_align(struct data d, int align);
    123 
    124 struct data data_add_marker(struct data d, enum markertype type, char *ref);
    125 
    126 bool data_is_one_string(struct data d);
    127 
    128 /* DT constraints */
    129 
    130 #define MAX_PROPNAME_LEN	31
    131 #define MAX_NODENAME_LEN	31
    132 
    133 /* Live trees */
    134 struct label {
    135 	bool deleted;
    136 	char *label;
    137 	struct label *next;
    138 };
    139 
    140 struct bus_type {
    141 	const char *name;
    142 };
    143 
    144 struct property {
    145 	bool deleted;
    146 	char *name;
    147 	struct data val;
    148 
    149 	struct property *next;
    150 
    151 	struct label *labels;
    152 };
    153 
    154 struct node {
    155 	bool deleted;
    156 	char *name;
    157 	struct property *proplist;
    158 	struct node *children;
    159 
    160 	struct node *parent;
    161 	struct node *next_sibling;
    162 
    163 	char *fullpath;
    164 	int basenamelen;
    165 
    166 	cell_t phandle;
    167 	int addr_cells, size_cells;
    168 
    169 	struct label *labels;
    170 	const struct bus_type *bus;
    171 };
    172 
    173 #define for_each_label_withdel(l0, l) \
    174 	for ((l) = (l0); (l); (l) = (l)->next)
    175 
    176 #define for_each_label(l0, l) \
    177 	for_each_label_withdel(l0, l) \
    178 		if (!(l)->deleted)
    179 
    180 #define for_each_property_withdel(n, p) \
    181 	for ((p) = (n)->proplist; (p); (p) = (p)->next)
    182 
    183 #define for_each_property(n, p) \
    184 	for_each_property_withdel(n, p) \
    185 		if (!(p)->deleted)
    186 
    187 #define for_each_child_withdel(n, c) \
    188 	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
    189 
    190 #define for_each_child(n, c) \
    191 	for_each_child_withdel(n, c) \
    192 		if (!(c)->deleted)
    193 
    194 void add_label(struct label **labels, char *label);
    195 void delete_labels(struct label **labels);
    196 
    197 struct property *build_property(char *name, struct data val);
    198 struct property *build_property_delete(char *name);
    199 struct property *chain_property(struct property *first, struct property *list);
    200 struct property *reverse_properties(struct property *first);
    201 
    202 struct node *build_node(struct property *proplist, struct node *children);
    203 struct node *build_node_delete(void);
    204 struct node *name_node(struct node *node, char *name);
    205 struct node *chain_node(struct node *first, struct node *list);
    206 struct node *merge_nodes(struct node *old_node, struct node *new_node);
    207 struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref);
    208 
    209 void add_property(struct node *node, struct property *prop);
    210 void delete_property_by_name(struct node *node, char *name);
    211 void delete_property(struct property *prop);
    212 void add_child(struct node *parent, struct node *child);
    213 void delete_node_by_name(struct node *parent, char *name);
    214 void delete_node(struct node *node);
    215 void append_to_property(struct node *node,
    216 			char *name, const void *data, int len);
    217 
    218 const char *get_unitname(struct node *node);
    219 struct property *get_property(struct node *node, const char *propname);
    220 cell_t propval_cell(struct property *prop);
    221 cell_t propval_cell_n(struct property *prop, int n);
    222 struct property *get_property_by_label(struct node *tree, const char *label,
    223 				       struct node **node);
    224 struct marker *get_marker_label(struct node *tree, const char *label,
    225 				struct node **node, struct property **prop);
    226 struct node *get_subnode(struct node *node, const char *nodename);
    227 struct node *get_node_by_path(struct node *tree, const char *path);
    228 struct node *get_node_by_label(struct node *tree, const char *label);
    229 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
    230 struct node *get_node_by_ref(struct node *tree, const char *ref);
    231 cell_t get_node_phandle(struct node *root, struct node *node);
    232 
    233 uint32_t guess_boot_cpuid(struct node *tree);
    234 
    235 /* Boot info (tree plus memreserve information */
    236 
    237 struct reserve_info {
    238 	uint64_t address, size;
    239 
    240 	struct reserve_info *next;
    241 
    242 	struct label *labels;
    243 };
    244 
    245 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
    246 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
    247 					 struct reserve_info *list);
    248 struct reserve_info *add_reserve_entry(struct reserve_info *list,
    249 				       struct reserve_info *new);
    250 
    251 
    252 struct dt_info {
    253 	unsigned int dtsflags;
    254 	struct reserve_info *reservelist;
    255 	uint32_t boot_cpuid_phys;
    256 	struct node *dt;		/* the device tree */
    257 	const char *outname;		/* filename being written to, "-" for stdout */
    258 };
    259 
    260 /* DTS version flags definitions */
    261 #define DTSF_V1		0x0001	/* /dts-v1/ */
    262 #define DTSF_PLUGIN	0x0002	/* /plugin/ */
    263 
    264 struct dt_info *build_dt_info(unsigned int dtsflags,
    265 			      struct reserve_info *reservelist,
    266 			      struct node *tree, uint32_t boot_cpuid_phys);
    267 void sort_tree(struct dt_info *dti);
    268 void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
    269 void generate_fixups_tree(struct dt_info *dti, char *name);
    270 void generate_local_fixups_tree(struct dt_info *dti, char *name);
    271 
    272 /* Checks */
    273 
    274 void parse_checks_option(bool warn, bool error, const char *arg);
    275 void process_checks(bool force, struct dt_info *dti);
    276 
    277 /* Flattened trees */
    278 
    279 void dt_to_blob(FILE *f, struct dt_info *dti, int version);
    280 void dt_to_asm(FILE *f, struct dt_info *dti, int version);
    281 
    282 struct dt_info *dt_from_blob(const char *fname);
    283 
    284 /* Tree source */
    285 
    286 void dt_to_source(FILE *f, struct dt_info *dti);
    287 struct dt_info *dt_from_source(const char *f);
    288 
    289 /* FS trees */
    290 
    291 struct dt_info *dt_from_fs(const char *dirname);
    292 
    293 #endif /* DTC_H */
    294