scripts/dtc/dtc.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 #ifndef DTC_H
0003 #define DTC_H
0004
0005 /*
0006  * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation.  2005.
0007  */
0008
0009 #include <stdio.h>
0010 #include <string.h>
0011 #include <stdlib.h>
0012 #include <stdint.h>
0013 #include <stdbool.h>
0014 #include <stdarg.h>
0015 #include <assert.h>
0016 #include <ctype.h>
0017 #include <errno.h>
0018 #include <unistd.h>
0019 #include <inttypes.h>
0020
0021 #include <libfdt_env.h>
0022 #include <fdt.h>
0023
0024 #include "util.h"
0025
0026 #ifdef DEBUG
0027 #define debug(...)  printf(__VA_ARGS__)
0028 #else
0029 #define debug(...)
0030 #endif
0031
0032 #define DEFAULT_FDT_VERSION 17
0033
0034 /*
0035  * Command line options
0036  */
0037 extern int quiet;       /* Level of quietness */
0038 extern unsigned int reservenum; /* Number of memory reservation slots */
0039 extern int minsize;     /* Minimum blob size */
0040 extern int padsize;     /* Additional padding to blob */
0041 extern int alignsize;       /* Additional padding to blob accroding to the alignsize */
0042 extern int phandle_format;  /* Use linux,phandle or phandle properties */
0043 extern int generate_symbols;    /* generate symbols for nodes with labels */
0044 extern int generate_fixups; /* generate fixups */
0045 extern int auto_label_aliases;  /* auto generate labels -> aliases */
0046 extern int annotate;        /* annotate .dts with input source location */
0047
0048 #define PHANDLE_LEGACY  0x1
0049 #define PHANDLE_EPAPR   0x2
0050 #define PHANDLE_BOTH    0x3
0051
0052 typedef uint32_t cell_t;
0053
0054 static inline bool phandle_is_valid(cell_t phandle)
0055 {
0056     return phandle != 0 && phandle != ~0U;
0057 }
0058
0059 static inline uint16_t dtb_ld16(const void *p)
0060 {
0061     const uint8_t *bp = (const uint8_t *)p;
0062
0063     return ((uint16_t)bp[0] << 8)
0064         | bp[1];
0065 }
0066
0067 static inline uint32_t dtb_ld32(const void *p)
0068 {
0069     const uint8_t *bp = (const uint8_t *)p;
0070
0071     return ((uint32_t)bp[0] << 24)
0072         | ((uint32_t)bp[1] << 16)
0073         | ((uint32_t)bp[2] << 8)
0074         | bp[3];
0075 }
0076
0077 static inline uint64_t dtb_ld64(const void *p)
0078 {
0079     const uint8_t *bp = (const uint8_t *)p;
0080
0081     return ((uint64_t)bp[0] << 56)
0082         | ((uint64_t)bp[1] << 48)
0083         | ((uint64_t)bp[2] << 40)
0084         | ((uint64_t)bp[3] << 32)
0085         | ((uint64_t)bp[4] << 24)
0086         | ((uint64_t)bp[5] << 16)
0087         | ((uint64_t)bp[6] << 8)
0088         | bp[7];
0089 }
0090
0091 #define streq(a, b) (strcmp((a), (b)) == 0)
0092 #define strstarts(s, prefix)    (strncmp((s), (prefix), strlen(prefix)) == 0)
0093 #define strprefixeq(a, n, b)    (strlen(b) == (n) && (memcmp(a, b, n) == 0))
0094 static inline bool strends(const char *str, const char *suffix)
0095 {
0096     unsigned int len, suffix_len;
0097
0098     len = strlen(str);
0099     suffix_len = strlen(suffix);
0100     if (len < suffix_len)
0101         return false;
0102     return streq(str + len - suffix_len, suffix);
0103 }
0104
0105 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
0106
0107 /* Data blobs */
0108 enum markertype {
0109     TYPE_NONE,
0110     REF_PHANDLE,
0111     REF_PATH,
0112     LABEL,
0113     TYPE_UINT8,
0114     TYPE_UINT16,
0115     TYPE_UINT32,
0116     TYPE_UINT64,
0117     TYPE_STRING,
0118 };
0119
0120 static inline bool is_type_marker(enum markertype type)
0121 {
0122     return type >= TYPE_UINT8;
0123 }
0124
0125 extern const char *markername(enum markertype markertype);
0126
0127 struct  marker {
0128     enum markertype type;
0129     unsigned int offset;
0130     char *ref;
0131     struct marker *next;
0132 };
0133
0134 struct data {
0135     unsigned int len;
0136     char *val;
0137     struct marker *markers;
0138 };
0139
0140
0141 #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
0142
0143 #define for_each_marker(m) \
0144     for (; (m); (m) = (m)->next)
0145 #define for_each_marker_of_type(m, t) \
0146     for_each_marker(m) \
0147         if ((m)->type == (t))
0148
0149 static inline struct marker *next_type_marker(struct marker *m)
0150 {
0151     for_each_marker(m)
0152         if (is_type_marker(m->type))
0153             break;
0154     return m;
0155 }
0156
0157 static inline size_t type_marker_length(struct marker *m)
0158 {
0159     struct marker *next = next_type_marker(m->next);
0160
0161     if (next)
0162         return next->offset - m->offset;
0163     return 0;
0164 }
0165
0166 void data_free(struct data d);
0167
0168 struct data data_grow_for(struct data d, unsigned int xlen);
0169
0170 struct data data_copy_mem(const char *mem, int len);
0171 struct data data_copy_escape_string(const char *s, int len);
0172 struct data data_copy_file(FILE *f, size_t len);
0173
0174 struct data data_append_data(struct data d, const void *p, int len);
0175 struct data data_insert_at_marker(struct data d, struct marker *m,
0176                   const void *p, int len);
0177 struct data data_merge(struct data d1, struct data d2);
0178 struct data data_append_cell(struct data d, cell_t word);
0179 struct data data_append_integer(struct data d, uint64_t word, int bits);
0180 struct data data_append_re(struct data d, uint64_t address, uint64_t size);
0181 struct data data_append_addr(struct data d, uint64_t addr);
0182 struct data data_append_byte(struct data d, uint8_t byte);
0183 struct data data_append_zeroes(struct data d, int len);
0184 struct data data_append_align(struct data d, int align);
0185
0186 struct data data_add_marker(struct data d, enum markertype type, char *ref);
0187
0188 bool data_is_one_string(struct data d);
0189
0190 /* DT constraints */
0191
0192 #define MAX_PROPNAME_LEN    31
0193 #define MAX_NODENAME_LEN    31
0194
0195 /* Live trees */
0196 struct label {
0197     bool deleted;
0198     char *label;
0199     struct label *next;
0200 };
0201
0202 struct bus_type {
0203     const char *name;
0204 };
0205
0206 struct property {
0207     bool deleted;
0208     char *name;
0209     struct data val;
0210
0211     struct property *next;
0212
0213     struct label *labels;
0214     struct srcpos *srcpos;
0215 };
0216
0217 struct node {
0218     bool deleted;
0219     char *name;
0220     struct property *proplist;
0221     struct node *children;
0222
0223     struct node *parent;
0224     struct node *next_sibling;
0225
0226     char *fullpath;
0227     int basenamelen;
0228
0229     cell_t phandle;
0230     int addr_cells, size_cells;
0231
0232     struct label *labels;
0233     const struct bus_type *bus;
0234     struct srcpos *srcpos;
0235
0236     bool omit_if_unused, is_referenced;
0237 };
0238
0239 #define for_each_label_withdel(l0, l) \
0240     for ((l) = (l0); (l); (l) = (l)->next)
0241
0242 #define for_each_label(l0, l) \
0243     for_each_label_withdel(l0, l) \
0244         if (!(l)->deleted)
0245
0246 #define for_each_property_withdel(n, p) \
0247     for ((p) = (n)->proplist; (p); (p) = (p)->next)
0248
0249 #define for_each_property(n, p) \
0250     for_each_property_withdel(n, p) \
0251         if (!(p)->deleted)
0252
0253 #define for_each_child_withdel(n, c) \
0254     for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
0255
0256 #define for_each_child(n, c) \
0257     for_each_child_withdel(n, c) \
0258         if (!(c)->deleted)
0259
0260 void add_label(struct label **labels, char *label);
0261 void delete_labels(struct label **labels);
0262
0263 struct property *build_property(char *name, struct data val,
0264                 struct srcpos *srcpos);
0265 struct property *build_property_delete(char *name);
0266 struct property *chain_property(struct property *first, struct property *list);
0267 struct property *reverse_properties(struct property *first);
0268
0269 struct node *build_node(struct property *proplist, struct node *children,
0270             struct srcpos *srcpos);
0271 struct node *build_node_delete(struct srcpos *srcpos);
0272 struct node *name_node(struct node *node, char *name);
0273 struct node *omit_node_if_unused(struct node *node);
0274 struct node *reference_node(struct node *node);
0275 struct node *chain_node(struct node *first, struct node *list);
0276 struct node *merge_nodes(struct node *old_node, struct node *new_node);
0277 struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref);
0278
0279 void add_property(struct node *node, struct property *prop);
0280 void delete_property_by_name(struct node *node, char *name);
0281 void delete_property(struct property *prop);
0282 void add_child(struct node *parent, struct node *child);
0283 void delete_node_by_name(struct node *parent, char *name);
0284 void delete_node(struct node *node);
0285 void append_to_property(struct node *node,
0286             char *name, const void *data, int len,
0287             enum markertype type);
0288
0289 const char *get_unitname(struct node *node);
0290 struct property *get_property(struct node *node, const char *propname);
0291 cell_t propval_cell(struct property *prop);
0292 cell_t propval_cell_n(struct property *prop, unsigned int n);
0293 struct property *get_property_by_label(struct node *tree, const char *label,
0294                        struct node **node);
0295 struct marker *get_marker_label(struct node *tree, const char *label,
0296                 struct node **node, struct property **prop);
0297 struct node *get_subnode(struct node *node, const char *nodename);
0298 struct node *get_node_by_path(struct node *tree, const char *path);
0299 struct node *get_node_by_label(struct node *tree, const char *label);
0300 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
0301 struct node *get_node_by_ref(struct node *tree, const char *ref);
0302 cell_t get_node_phandle(struct node *root, struct node *node);
0303
0304 uint32_t guess_boot_cpuid(struct node *tree);
0305
0306 /* Boot info (tree plus memreserve information */
0307
0308 struct reserve_info {
0309     uint64_t address, size;
0310
0311     struct reserve_info *next;
0312
0313     struct label *labels;
0314 };
0315
0316 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
0317 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
0318                      struct reserve_info *list);
0319 struct reserve_info *add_reserve_entry(struct reserve_info *list,
0320                        struct reserve_info *new);
0321
0322
0323 struct dt_info {
0324     unsigned int dtsflags;
0325     struct reserve_info *reservelist;
0326     uint32_t boot_cpuid_phys;
0327     struct node *dt;        /* the device tree */
0328     const char *outname;        /* filename being written to, "-" for stdout */
0329 };
0330
0331 /* DTS version flags definitions */
0332 #define DTSF_V1     0x0001  /* /dts-v1/ */
0333 #define DTSF_PLUGIN 0x0002  /* /plugin/ */
0334
0335 struct dt_info *build_dt_info(unsigned int dtsflags,
0336                   struct reserve_info *reservelist,
0337                   struct node *tree, uint32_t boot_cpuid_phys);
0338 void sort_tree(struct dt_info *dti);
0339 void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
0340 void generate_fixups_tree(struct dt_info *dti, char *name);
0341 void generate_local_fixups_tree(struct dt_info *dti, char *name);
0342
0343 /* Checks */
0344
0345 void parse_checks_option(bool warn, bool error, const char *arg);
0346 void process_checks(bool force, struct dt_info *dti);
0347
0348 /* Flattened trees */
0349
0350 void dt_to_blob(FILE *f, struct dt_info *dti, int version);
0351 void dt_to_asm(FILE *f, struct dt_info *dti, int version);
0352
0353 struct dt_info *dt_from_blob(const char *fname);
0354
0355 /* Tree source */
0356
0357 void dt_to_source(FILE *f, struct dt_info *dti);
0358 struct dt_info *dt_from_source(const char *f);
0359
0360 /* YAML source */
0361
0362 void dt_to_yaml(FILE *f, struct dt_info *dti);
0363
0364 /* FS trees */
0365
0366 struct dt_info *dt_from_fs(const char *dirname);
0367
0368 #endif /* DTC_H */