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