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