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(fmt,args...)      printf(fmt, ##args)
  42 #else
  43 #define debug(fmt,args...)
  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 phandle_format;      /* Use linux,phandle or phandle properties */
  57
  58 #define PHANDLE_LEGACY  0x1
  59 #define PHANDLE_EPAPR   0x2
  60 #define PHANDLE_BOTH    0x3
  61
  62 typedef uint32_t cell_t;
  63
  64
  65 #define streq(a, b)     (strcmp((a), (b)) == 0)
  66 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  67
  68 #define ALIGN(x, a)     (((x) + (a) - 1) & ~((a) - 1))
  69 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  70
  71 /* Data blobs */
  72 enum markertype {
  73         REF_PHANDLE,
  74         REF_PATH,
  75         LABEL,
  76 };
  77
  78 struct  marker {
  79         enum markertype type;
  80         int offset;
  81         char *ref;
  82         struct marker *next;
  83 };
  84
  85 struct data {
  86         int len;
  87         char *val;
  88         struct marker *markers;
  89 };
  90
  91
  92 #define empty_data ((struct data){ /* all .members = 0 or NULL */ })
  93
  94 #define for_each_marker(m) \
  95         for (; (m); (m) = (m)->next)
  96 #define for_each_marker_of_type(m, t) \
  97         for_each_marker(m) \
  98                 if ((m)->type == (t))
  99
 100 void data_free(struct data d);
 101
 102 struct data data_grow_for(struct data d, int xlen);
 103
 104 struct data data_copy_mem(const char *mem, int len);
 105 struct data data_copy_escape_string(const char *s, int len);
 106 struct data data_copy_file(FILE *f, size_t len);
 107
 108 struct data data_append_data(struct data d, const void *p, int len);
 109 struct data data_insert_at_marker(struct data d, struct marker *m,
 110                                   const void *p, int len);
 111 struct data data_merge(struct data d1, struct data d2);
 112 struct data data_append_cell(struct data d, cell_t word);
 113 struct data data_append_integer(struct data d, uint64_t word, int bits);
 114 struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
 115 struct data data_append_addr(struct data d, uint64_t addr);
 116 struct data data_append_byte(struct data d, uint8_t byte);
 117 struct data data_append_zeroes(struct data d, int len);
 118 struct data data_append_align(struct data d, int align);
 119
 120 struct data data_add_marker(struct data d, enum markertype type, char *ref);
 121
 122 int data_is_one_string(struct data d);
 123
 124 /* DT constraints */
 125
 126 #define MAX_PROPNAME_LEN        31
 127 #define MAX_NODENAME_LEN        31
 128
 129 /* Live trees */
 130 struct label {
 131         int deleted;
 132         char *label;
 133         struct label *next;
 134 };
 135
 136 struct property {
 137         int deleted;
 138         char *name;
 139         struct data val;
 140
 141         struct property *next;
 142
 143         struct label *labels;
 144 };
 145
 146 struct node {
 147         int deleted;
 148         char *name;
 149         struct property *proplist;
 150         struct node *children;
 151
 152         struct node *parent;
 153         struct node *next_sibling;
 154
 155         char *fullpath;
 156         int basenamelen;
 157
 158         cell_t phandle;
 159         int addr_cells, size_cells;
 160
 161         struct label *labels;
 162 };
 163
 164 #define for_each_label_withdel(l0, l) \
 165         for ((l) = (l0); (l); (l) = (l)->next)
 166
 167 #define for_each_label(l0, l) \
 168         for_each_label_withdel(l0, l) \
 169                 if (!(l)->deleted)
 170
 171 #define for_each_property_withdel(n, p) \
 172         for ((p) = (n)->proplist; (p); (p) = (p)->next)
 173
 174 #define for_each_property(n, p) \
 175         for_each_property_withdel(n, p) \
 176                 if (!(p)->deleted)
 177
 178 #define for_each_child_withdel(n, c) \
 179         for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
 180
 181 #define for_each_child(n, c) \
 182         for_each_child_withdel(n, c) \
 183                 if (!(c)->deleted)
 184
 185 void add_label(struct label **labels, char *label);
 186 void delete_labels(struct label **labels);
 187
 188 struct property *build_property(char *name, struct data val);
 189 struct property *build_property_delete(char *name);
 190 struct property *chain_property(struct property *first, struct property *list);
 191 struct property *reverse_properties(struct property *first);
 192
 193 struct node *build_node(struct property *proplist, struct node *children);
 194 struct node *build_node_delete(void);
 195 struct node *name_node(struct node *node, char *name);
 196 struct node *chain_node(struct node *first, struct node *list);
 197 struct node *merge_nodes(struct node *old_node, struct node *new_node);
 198
 199 void add_property(struct node *node, struct property *prop);
 200 void delete_property_by_name(struct node *node, char *name);
 201 void delete_property(struct property *prop);
 202 void add_child(struct node *parent, struct node *child);
 203 void delete_node_by_name(struct node *parent, char *name);
 204 void delete_node(struct node *node);
 205
 206 const char *get_unitname(struct node *node);
 207 struct property *get_property(struct node *node, const char *propname);
 208 cell_t propval_cell(struct property *prop);
 209 struct property *get_property_by_label(struct node *tree, const char *label,
 210                                        struct node **node);
 211 struct marker *get_marker_label(struct node *tree, const char *label,
 212                                 struct node **node, struct property **prop);
 213 struct node *get_subnode(struct node *node, const char *nodename);
 214 struct node *get_node_by_path(struct node *tree, const char *path);
 215 struct node *get_node_by_label(struct node *tree, const char *label);
 216 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
 217 struct node *get_node_by_ref(struct node *tree, const char *ref);
 218 cell_t get_node_phandle(struct node *root, struct node *node);
 219
 220 uint32_t guess_boot_cpuid(struct node *tree);
 221
 222 /* Boot info (tree plus memreserve information */
 223
 224 struct reserve_info {
 225         struct fdt_reserve_entry re;
 226
 227         struct reserve_info *next;
 228
 229         struct label *labels;
 230 };
 231
 232 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
 233 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
 234                                          struct reserve_info *list);
 235 struct reserve_info *add_reserve_entry(struct reserve_info *list,
 236                                        struct reserve_info *new);
 237
 238
 239 struct boot_info {
 240         struct reserve_info *reservelist;
 241         struct node *dt;                /* the device tree */
 242         uint32_t boot_cpuid_phys;
 243 };
 244
 245 struct boot_info *build_boot_info(struct reserve_info *reservelist,
 246                                   struct node *tree, uint32_t boot_cpuid_phys);
 247 void sort_tree(struct boot_info *bi);
 248
 249 /* Checks */
 250
 251 void parse_checks_option(bool warn, bool error, const char *optarg);
 252 void process_checks(int force, struct boot_info *bi);
 253
 254 /* Flattened trees */
 255
 256 void dt_to_blob(FILE *f, struct boot_info *bi, int version);
 257 void dt_to_asm(FILE *f, struct boot_info *bi, int version);
 258
 259 struct boot_info *dt_from_blob(const char *fname);
 260
 261 /* Tree source */
 262
 263 void dt_to_source(FILE *f, struct boot_info *bi);
 264 struct boot_info *dt_from_source(const char *f);
 265
 266 /* FS trees */
 267
 268 struct boot_info *dt_from_fs(const char *dirname);
 269
 270 #endif /* _DTC_H */