scripts/dtc/dtc.h

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