arch/powerpc/boot/dtc-src/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 <stdarg.h>
  29 #include <assert.h>
  30 #include <ctype.h>
  31 #include <errno.h>
  32 #include <unistd.h>
  33 #include <netinet/in.h>
  34 #include <endian.h>
  35 #include <byteswap.h>
  36
  37 #include <fdt.h>
  38
  39 #define DEFAULT_FDT_VERSION     17
  40 /*
  41  * Command line options
  42  */
  43 extern int quiet;               /* Level of quietness */
  44 extern int reservenum;          /* Number of memory reservation slots */
  45 extern int minsize;             /* Minimum blob size */
  46 extern int padsize;             /* Additional padding to blob */
  47
  48 static inline void __attribute__((noreturn)) die(char * str, ...)
  49 {
  50         va_list ap;
  51
  52         va_start(ap, str);
  53         fprintf(stderr, "FATAL ERROR: ");
  54         vfprintf(stderr, str, ap);
  55         exit(1);
  56 }
  57
  58 static inline void *xmalloc(size_t len)
  59 {
  60         void *new = malloc(len);
  61
  62         if (! new)
  63                 die("malloc() failed\n");
  64
  65         return new;
  66 }
  67
  68 static inline void *xrealloc(void *p, size_t len)
  69 {
  70         void *new = realloc(p, len);
  71
  72         if (! new)
  73                 die("realloc() failed (len=%d)\n", len);
  74
  75         return new;
  76 }
  77
  78 typedef uint8_t u8;
  79 typedef uint16_t u16;
  80 typedef uint32_t u32;
  81 typedef uint64_t u64;
  82 typedef u32 cell_t;
  83
  84 #define cpu_to_be16(x)  htons(x)
  85 #define be16_to_cpu(x)  ntohs(x)
  86
  87 #define cpu_to_be32(x)  htonl(x)
  88 #define be32_to_cpu(x)  ntohl(x)
  89
  90 #if __BYTE_ORDER == __BIG_ENDIAN
  91 #define cpu_to_be64(x)  (x)
  92 #define be64_to_cpu(x)  (x)
  93 #else
  94 #define cpu_to_be64(x)  bswap_64(x)
  95 #define be64_to_cpu(x)  bswap_64(x)
  96 #endif
  97
  98 #define streq(a, b)     (strcmp((a), (b)) == 0)
  99 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 100
 101 #define ALIGN(x, a)     (((x) + (a) - 1) & ~((a) - 1))
 102 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 103
 104 /* Data blobs */
 105 enum markertype {
 106         REF_PHANDLE,
 107         REF_PATH,
 108         LABEL,
 109 };
 110
 111 struct  marker {
 112         enum markertype type;
 113         int offset;
 114         char *ref;
 115         struct marker *next;
 116 };
 117
 118 struct data {
 119         int len;
 120         char *val;
 121         int asize;
 122         struct marker *markers;
 123 };
 124
 125
 126 #define empty_data ((struct data){ /* all .members = 0 or NULL */ })
 127
 128 #define for_each_marker(m) \
 129         for (; (m); (m) = (m)->next)
 130 #define for_each_marker_of_type(m, t) \
 131         for_each_marker(m) \
 132                 if ((m)->type == (t))
 133
 134 void data_free(struct data d);
 135
 136 struct data data_grow_for(struct data d, int xlen);
 137
 138 struct data data_copy_mem(const char *mem, int len);
 139 struct data data_copy_escape_string(const char *s, int len);
 140 struct data data_copy_file(FILE *f, size_t len);
 141
 142 struct data data_append_data(struct data d, const void *p, int len);
 143 struct data data_insert_at_marker(struct data d, struct marker *m,
 144                                   const void *p, int len);
 145 struct data data_merge(struct data d1, struct data d2);
 146 struct data data_append_cell(struct data d, cell_t word);
 147 struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
 148 struct data data_append_addr(struct data d, u64 addr);
 149 struct data data_append_byte(struct data d, uint8_t byte);
 150 struct data data_append_zeroes(struct data d, int len);
 151 struct data data_append_align(struct data d, int align);
 152
 153 struct data data_add_marker(struct data d, enum markertype type, char *ref);
 154
 155 int data_is_one_string(struct data d);
 156
 157 /* DT constraints */
 158
 159 #define MAX_PROPNAME_LEN        31
 160 #define MAX_NODENAME_LEN        31
 161
 162 /* Live trees */
 163 struct property {
 164         char *name;
 165         struct data val;
 166
 167         struct property *next;
 168
 169         char *label;
 170 };
 171
 172 struct node {
 173         char *name;
 174         struct property *proplist;
 175         struct node *children;
 176
 177         struct node *parent;
 178         struct node *next_sibling;
 179
 180         char *fullpath;
 181         int basenamelen;
 182
 183         cell_t phandle;
 184         int addr_cells, size_cells;
 185
 186         char *label;
 187 };
 188
 189 #define for_each_property(n, p) \
 190         for ((p) = (n)->proplist; (p); (p) = (p)->next)
 191
 192 #define for_each_child(n, c)    \
 193         for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
 194
 195 struct property *build_property(char *name, struct data val, char *label);
 196 struct property *chain_property(struct property *first, struct property *list);
 197 struct property *reverse_properties(struct property *first);
 198
 199 struct node *build_node(struct property *proplist, struct node *children);
 200 struct node *name_node(struct node *node, char *name, char *label);
 201 struct node *chain_node(struct node *first, struct node *list);
 202
 203 void add_property(struct node *node, struct property *prop);
 204 void add_child(struct node *parent, struct node *child);
 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 node *get_subnode(struct node *node, const char *nodename);
 210 struct node *get_node_by_path(struct node *tree, const char *path);
 211 struct node *get_node_by_label(struct node *tree, const char *label);
 212 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
 213 struct node *get_node_by_ref(struct node *tree, const char *ref);
 214 cell_t get_node_phandle(struct node *root, struct node *node);
 215
 216 /* Boot info (tree plus memreserve information */
 217
 218 struct reserve_info {
 219         struct fdt_reserve_entry re;
 220
 221         struct reserve_info *next;
 222
 223         char *label;
 224 };
 225
 226 struct reserve_info *build_reserve_entry(u64 start, u64 len, char *label);
 227 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
 228                                          struct reserve_info *list);
 229 struct reserve_info *add_reserve_entry(struct reserve_info *list,
 230                                        struct reserve_info *new);
 231
 232
 233 struct boot_info {
 234         struct reserve_info *reservelist;
 235         struct node *dt;                /* the device tree */
 236 };
 237
 238 struct boot_info *build_boot_info(struct reserve_info *reservelist,
 239                                   struct node *tree);
 240
 241 /* Checks */
 242
 243 void process_checks(int force, struct boot_info *bi,
 244                     int checkflag, int outversion, int boot_cpuid_phys);
 245
 246 /* Flattened trees */
 247
 248 void dt_to_blob(FILE *f, struct boot_info *bi, int version,
 249                 int boot_cpuid_phys);
 250 void dt_to_asm(FILE *f, struct boot_info *bi, int version,
 251                int boot_cpuid_phys);
 252
 253 struct boot_info *dt_from_blob(FILE *f);
 254
 255 /* Tree source */
 256
 257 void dt_to_source(FILE *f, struct boot_info *bi);
 258 struct boot_info *dt_from_source(const char *f);
 259
 260 /* FS trees */
 261
 262 struct boot_info *dt_from_fs(const char *dirname);
 263
 264 /* misc */
 265
 266 char *join_path(const char *path, const char *name);
 267 void fill_fullpaths(struct node *tree, const char *prefix);
 268
 269 #endif /* _DTC_H */