1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 #ifndef DTC_H 3 #define DTC_H 4 5 /* 6 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005. 7 */ 8 9 #include <stdio.h> 10 #include <string.h> 11 #include <stdlib.h> 12 #include <stdint.h> 13 #include <stdbool.h> 14 #include <stdarg.h> 15 #include <assert.h> 16 #include <ctype.h> 17 #include <errno.h> 18 #include <unistd.h> 19 #include <inttypes.h> 20 21 #include <libfdt_env.h> 22 #include <fdt.h> 23 24 #include "util.h" 25 26 #ifdef DEBUG 27 #define debug(...) printf(__VA_ARGS__) 28 #else 29 #define debug(...) 30 #endif 31 32 #define DEFAULT_FDT_VERSION 17 33 34 /* 35 * Command line options 36 */ 37 extern int quiet; /* Level of quietness */ 38 extern int reservenum; /* Number of memory reservation slots */ 39 extern int minsize; /* Minimum blob size */ 40 extern int padsize; /* Additional padding to blob */ 41 extern int alignsize; /* Additional padding to blob accroding to the alignsize */ 42 extern int phandle_format; /* Use linux,phandle or phandle properties */ 43 extern int generate_symbols; /* generate symbols for nodes with labels */ 44 extern int generate_fixups; /* generate fixups */ 45 extern int auto_label_aliases; /* auto generate labels -> aliases */ 46 extern int annotate; /* annotate .dts with input source location */ 47 48 #define PHANDLE_LEGACY 0x1 49 #define PHANDLE_EPAPR 0x2 50 #define PHANDLE_BOTH 0x3 51 52 typedef uint32_t cell_t; 53 54 static inline uint16_t dtb_ld16(const void *p) 55 { 56 const uint8_t *bp = (const uint8_t *)p; 57 58 return ((uint16_t)bp[0] << 8) 59 | bp[1]; 60 } 61 62 static inline uint32_t dtb_ld32(const void *p) 63 { 64 const uint8_t *bp = (const uint8_t *)p; 65 66 return ((uint32_t)bp[0] << 24) 67 | ((uint32_t)bp[1] << 16) 68 | ((uint32_t)bp[2] << 8) 69 | bp[3]; 70 } 71 72 static inline uint64_t dtb_ld64(const void *p) 73 { 74 const uint8_t *bp = (const uint8_t *)p; 75 76 return ((uint64_t)bp[0] << 56) 77 | ((uint64_t)bp[1] << 48) 78 | ((uint64_t)bp[2] << 40) 79 | ((uint64_t)bp[3] << 32) 80 | ((uint64_t)bp[4] << 24) 81 | ((uint64_t)bp[5] << 16) 82 | ((uint64_t)bp[6] << 8) 83 | bp[7]; 84 } 85 86 #define streq(a, b) (strcmp((a), (b)) == 0) 87 #define strstarts(s, prefix) (strncmp((s), (prefix), strlen(prefix)) == 0) 88 #define strprefixeq(a, n, b) (strlen(b) == (n) && (memcmp(a, b, n) == 0)) 89 90 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1)) 91 92 /* Data blobs */ 93 enum markertype { 94 TYPE_NONE, 95 REF_PHANDLE, 96 REF_PATH, 97 LABEL, 98 TYPE_UINT8, 99 TYPE_UINT16, 100 TYPE_UINT32, 101 TYPE_UINT64, 102 TYPE_STRING, 103 }; 104 extern const char *markername(enum markertype markertype); 105 106 struct marker { 107 enum markertype type; 108 unsigned int offset; 109 char *ref; 110 struct marker *next; 111 }; 112 113 struct data { 114 unsigned int len; 115 char *val; 116 struct marker *markers; 117 }; 118 119 120 #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ }) 121 122 #define for_each_marker(m) \ 123 for (; (m); (m) = (m)->next) 124 #define for_each_marker_of_type(m, t) \ 125 for_each_marker(m) \ 126 if ((m)->type == (t)) 127 128 size_t type_marker_length(struct marker *m); 129 130 void data_free(struct data d); 131 132 struct data data_grow_for(struct data d, unsigned int xlen); 133 134 struct data data_copy_mem(const char *mem, int len); 135 struct data data_copy_escape_string(const char *s, int len); 136 struct data data_copy_file(FILE *f, size_t len); 137 138 struct data data_append_data(struct data d, const void *p, int len); 139 struct data data_insert_at_marker(struct data d, struct marker *m, 140 const void *p, int len); 141 struct data data_merge(struct data d1, struct data d2); 142 struct data data_append_cell(struct data d, cell_t word); 143 struct data data_append_integer(struct data d, uint64_t word, int bits); 144 struct data data_append_re(struct data d, uint64_t address, uint64_t size); 145 struct data data_append_addr(struct data d, uint64_t addr); 146 struct data data_append_byte(struct data d, uint8_t byte); 147 struct data data_append_zeroes(struct data d, int len); 148 struct data data_append_align(struct data d, int align); 149 150 struct data data_add_marker(struct data d, enum markertype type, char *ref); 151 152 bool data_is_one_string(struct data d); 153 154 /* DT constraints */ 155 156 #define MAX_PROPNAME_LEN 31 157 #define MAX_NODENAME_LEN 31 158 159 /* Live trees */ 160 struct label { 161 bool deleted; 162 char *label; 163 struct label *next; 164 }; 165 166 struct bus_type { 167 const char *name; 168 }; 169 170 struct property { 171 bool deleted; 172 char *name; 173 struct data val; 174 175 struct property *next; 176 177 struct label *labels; 178 struct srcpos *srcpos; 179 }; 180 181 struct node { 182 bool deleted; 183 char *name; 184 struct property *proplist; 185 struct node *children; 186 187 struct node *parent; 188 struct node *next_sibling; 189 190 char *fullpath; 191 int basenamelen; 192 193 cell_t phandle; 194 int addr_cells, size_cells; 195 196 struct label *labels; 197 const struct bus_type *bus; 198 struct srcpos *srcpos; 199 200 bool omit_if_unused, is_referenced; 201 }; 202 203 #define for_each_label_withdel(l0, l) \ 204 for ((l) = (l0); (l); (l) = (l)->next) 205 206 #define for_each_label(l0, l) \ 207 for_each_label_withdel(l0, l) \ 208 if (!(l)->deleted) 209 210 #define for_each_property_withdel(n, p) \ 211 for ((p) = (n)->proplist; (p); (p) = (p)->next) 212 213 #define for_each_property(n, p) \ 214 for_each_property_withdel(n, p) \ 215 if (!(p)->deleted) 216 217 #define for_each_child_withdel(n, c) \ 218 for ((c) = (n)->children; (c); (c) = (c)->next_sibling) 219 220 #define for_each_child(n, c) \ 221 for_each_child_withdel(n, c) \ 222 if (!(c)->deleted) 223 224 void add_label(struct label **labels, char *label); 225 void delete_labels(struct label **labels); 226 227 struct property *build_property(char *name, struct data val, 228 struct srcpos *srcpos); 229 struct property *build_property_delete(char *name); 230 struct property *chain_property(struct property *first, struct property *list); 231 struct property *reverse_properties(struct property *first); 232 233 struct node *build_node(struct property *proplist, struct node *children, 234 struct srcpos *srcpos); 235 struct node *build_node_delete(struct srcpos *srcpos); 236 struct node *name_node(struct node *node, char *name); 237 struct node *omit_node_if_unused(struct node *node); 238 struct node *reference_node(struct node *node); 239 struct node *chain_node(struct node *first, struct node *list); 240 struct node *merge_nodes(struct node *old_node, struct node *new_node); 241 struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref); 242 243 void add_property(struct node *node, struct property *prop); 244 void delete_property_by_name(struct node *node, char *name); 245 void delete_property(struct property *prop); 246 void add_child(struct node *parent, struct node *child); 247 void delete_node_by_name(struct node *parent, char *name); 248 void delete_node(struct node *node); 249 void append_to_property(struct node *node, 250 char *name, const void *data, int len, 251 enum markertype type); 252 253 const char *get_unitname(struct node *node); 254 struct property *get_property(struct node *node, const char *propname); 255 cell_t propval_cell(struct property *prop); 256 cell_t propval_cell_n(struct property *prop, unsigned int n); 257 struct property *get_property_by_label(struct node *tree, const char *label, 258 struct node **node); 259 struct marker *get_marker_label(struct node *tree, const char *label, 260 struct node **node, struct property **prop); 261 struct node *get_subnode(struct node *node, const char *nodename); 262 struct node *get_node_by_path(struct node *tree, const char *path); 263 struct node *get_node_by_label(struct node *tree, const char *label); 264 struct node *get_node_by_phandle(struct node *tree, cell_t phandle); 265 struct node *get_node_by_ref(struct node *tree, const char *ref); 266 cell_t get_node_phandle(struct node *root, struct node *node); 267 268 uint32_t guess_boot_cpuid(struct node *tree); 269 270 /* Boot info (tree plus memreserve information */ 271 272 struct reserve_info { 273 uint64_t address, size; 274 275 struct reserve_info *next; 276 277 struct label *labels; 278 }; 279 280 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len); 281 struct reserve_info *chain_reserve_entry(struct reserve_info *first, 282 struct reserve_info *list); 283 struct reserve_info *add_reserve_entry(struct reserve_info *list, 284 struct reserve_info *new); 285 286 287 struct dt_info { 288 unsigned int dtsflags; 289 struct reserve_info *reservelist; 290 uint32_t boot_cpuid_phys; 291 struct node *dt; /* the device tree */ 292 const char *outname; /* filename being written to, "-" for stdout */ 293 }; 294 295 /* DTS version flags definitions */ 296 #define DTSF_V1 0x0001 /* /dts-v1/ */ 297 #define DTSF_PLUGIN 0x0002 /* /plugin/ */ 298 299 struct dt_info *build_dt_info(unsigned int dtsflags, 300 struct reserve_info *reservelist, 301 struct node *tree, uint32_t boot_cpuid_phys); 302 void sort_tree(struct dt_info *dti); 303 void generate_label_tree(struct dt_info *dti, char *name, bool allocph); 304 void generate_fixups_tree(struct dt_info *dti, char *name); 305 void generate_local_fixups_tree(struct dt_info *dti, char *name); 306 307 /* Checks */ 308 309 void parse_checks_option(bool warn, bool error, const char *arg); 310 void process_checks(bool force, struct dt_info *dti); 311 312 /* Flattened trees */ 313 314 void dt_to_blob(FILE *f, struct dt_info *dti, int version); 315 void dt_to_asm(FILE *f, struct dt_info *dti, int version); 316 317 struct dt_info *dt_from_blob(const char *fname); 318 319 /* Tree source */ 320 321 void dt_to_source(FILE *f, struct dt_info *dti); 322 struct dt_info *dt_from_source(const char *f); 323 324 /* YAML source */ 325 326 void dt_to_yaml(FILE *f, struct dt_info *dti); 327 328 /* FS trees */ 329 330 struct dt_info *dt_from_fs(const char *dirname); 331 332 #endif /* DTC_H */ 333