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> 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 TYPE_NONE, 78 REF_PHANDLE, 79 REF_PATH, 80 LABEL, 81 TYPE_UINT8, 82 TYPE_UINT16, 83 TYPE_UINT32, 84 TYPE_UINT64, 85 TYPE_STRING, 86 }; 87 extern const char *markername(enum markertype markertype); 88 89 struct marker { 90 enum markertype type; 91 int offset; 92 char *ref; 93 struct marker *next; 94 }; 95 96 struct data { 97 int len; 98 char *val; 99 struct marker *markers; 100 }; 101 102 103 #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ }) 104 105 #define for_each_marker(m) \ 106 for (; (m); (m) = (m)->next) 107 #define for_each_marker_of_type(m, t) \ 108 for_each_marker(m) \ 109 if ((m)->type == (t)) 110 111 size_t type_marker_length(struct marker *m); 112 113 void data_free(struct data d); 114 115 struct data data_grow_for(struct data d, int xlen); 116 117 struct data data_copy_mem(const char *mem, int len); 118 struct data data_copy_escape_string(const char *s, int len); 119 struct data data_copy_file(FILE *f, size_t len); 120 121 struct data data_append_data(struct data d, const void *p, int len); 122 struct data data_insert_at_marker(struct data d, struct marker *m, 123 const void *p, int len); 124 struct data data_merge(struct data d1, struct data d2); 125 struct data data_append_cell(struct data d, cell_t word); 126 struct data data_append_integer(struct data d, uint64_t word, int bits); 127 struct data data_append_re(struct data d, uint64_t address, uint64_t size); 128 struct data data_append_addr(struct data d, uint64_t addr); 129 struct data data_append_byte(struct data d, uint8_t byte); 130 struct data data_append_zeroes(struct data d, int len); 131 struct data data_append_align(struct data d, int align); 132 133 struct data data_add_marker(struct data d, enum markertype type, char *ref); 134 135 bool data_is_one_string(struct data d); 136 137 /* DT constraints */ 138 139 #define MAX_PROPNAME_LEN 31 140 #define MAX_NODENAME_LEN 31 141 142 /* Live trees */ 143 struct label { 144 bool deleted; 145 char *label; 146 struct label *next; 147 }; 148 149 struct bus_type { 150 const char *name; 151 }; 152 153 struct property { 154 bool deleted; 155 char *name; 156 struct data val; 157 158 struct property *next; 159 160 struct label *labels; 161 }; 162 163 struct node { 164 bool deleted; 165 char *name; 166 struct property *proplist; 167 struct node *children; 168 169 struct node *parent; 170 struct node *next_sibling; 171 172 char *fullpath; 173 int basenamelen; 174 175 cell_t phandle; 176 int addr_cells, size_cells; 177 178 struct label *labels; 179 const struct bus_type *bus; 180 181 bool omit_if_unused, is_referenced; 182 }; 183 184 #define for_each_label_withdel(l0, l) \ 185 for ((l) = (l0); (l); (l) = (l)->next) 186 187 #define for_each_label(l0, l) \ 188 for_each_label_withdel(l0, l) \ 189 if (!(l)->deleted) 190 191 #define for_each_property_withdel(n, p) \ 192 for ((p) = (n)->proplist; (p); (p) = (p)->next) 193 194 #define for_each_property(n, p) \ 195 for_each_property_withdel(n, p) \ 196 if (!(p)->deleted) 197 198 #define for_each_child_withdel(n, c) \ 199 for ((c) = (n)->children; (c); (c) = (c)->next_sibling) 200 201 #define for_each_child(n, c) \ 202 for_each_child_withdel(n, c) \ 203 if (!(c)->deleted) 204 205 void add_label(struct label **labels, char *label); 206 void delete_labels(struct label **labels); 207 208 struct property *build_property(char *name, struct data val); 209 struct property *build_property_delete(char *name); 210 struct property *chain_property(struct property *first, struct property *list); 211 struct property *reverse_properties(struct property *first); 212 213 struct node *build_node(struct property *proplist, struct node *children); 214 struct node *build_node_delete(void); 215 struct node *name_node(struct node *node, char *name); 216 struct node *omit_node_if_unused(struct node *node); 217 struct node *reference_node(struct node *node); 218 struct node *chain_node(struct node *first, struct node *list); 219 struct node *merge_nodes(struct node *old_node, struct node *new_node); 220 struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref); 221 222 void add_property(struct node *node, struct property *prop); 223 void delete_property_by_name(struct node *node, char *name); 224 void delete_property(struct property *prop); 225 void add_child(struct node *parent, struct node *child); 226 void delete_node_by_name(struct node *parent, char *name); 227 void delete_node(struct node *node); 228 void append_to_property(struct node *node, 229 char *name, const void *data, int len); 230 231 const char *get_unitname(struct node *node); 232 struct property *get_property(struct node *node, const char *propname); 233 cell_t propval_cell(struct property *prop); 234 cell_t propval_cell_n(struct property *prop, int n); 235 struct property *get_property_by_label(struct node *tree, const char *label, 236 struct node **node); 237 struct marker *get_marker_label(struct node *tree, const char *label, 238 struct node **node, struct property **prop); 239 struct node *get_subnode(struct node *node, const char *nodename); 240 struct node *get_node_by_path(struct node *tree, const char *path); 241 struct node *get_node_by_label(struct node *tree, const char *label); 242 struct node *get_node_by_phandle(struct node *tree, cell_t phandle); 243 struct node *get_node_by_ref(struct node *tree, const char *ref); 244 cell_t get_node_phandle(struct node *root, struct node *node); 245 246 uint32_t guess_boot_cpuid(struct node *tree); 247 248 /* Boot info (tree plus memreserve information */ 249 250 struct reserve_info { 251 uint64_t address, size; 252 253 struct reserve_info *next; 254 255 struct label *labels; 256 }; 257 258 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len); 259 struct reserve_info *chain_reserve_entry(struct reserve_info *first, 260 struct reserve_info *list); 261 struct reserve_info *add_reserve_entry(struct reserve_info *list, 262 struct reserve_info *new); 263 264 265 struct dt_info { 266 unsigned int dtsflags; 267 struct reserve_info *reservelist; 268 uint32_t boot_cpuid_phys; 269 struct node *dt; /* the device tree */ 270 const char *outname; /* filename being written to, "-" for stdout */ 271 }; 272 273 /* DTS version flags definitions */ 274 #define DTSF_V1 0x0001 /* /dts-v1/ */ 275 #define DTSF_PLUGIN 0x0002 /* /plugin/ */ 276 277 struct dt_info *build_dt_info(unsigned int dtsflags, 278 struct reserve_info *reservelist, 279 struct node *tree, uint32_t boot_cpuid_phys); 280 void sort_tree(struct dt_info *dti); 281 void generate_label_tree(struct dt_info *dti, char *name, bool allocph); 282 void generate_fixups_tree(struct dt_info *dti, char *name); 283 void generate_local_fixups_tree(struct dt_info *dti, char *name); 284 285 /* Checks */ 286 287 void parse_checks_option(bool warn, bool error, const char *arg); 288 void process_checks(bool force, struct dt_info *dti); 289 290 /* Flattened trees */ 291 292 void dt_to_blob(FILE *f, struct dt_info *dti, int version); 293 void dt_to_asm(FILE *f, struct dt_info *dti, int version); 294 295 struct dt_info *dt_from_blob(const char *fname); 296 297 /* Tree source */ 298 299 void dt_to_source(FILE *f, struct dt_info *dti); 300 struct dt_info *dt_from_source(const char *f); 301 302 /* YAML source */ 303 304 void dt_to_yaml(FILE *f, struct dt_info *dti); 305 306 /* FS trees */ 307 308 struct dt_info *dt_from_fs(const char *dirname); 309 310 #endif /* DTC_H */ 311