/scripts/dtc/dtc.h

http://github.com/mirrors/linux · C Header · 301 lines · 213 code · 71 blank · 17 comment · 14 complexity · 2efe942d19833dc2bf1ab650b774f60a MD5 · raw file

  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. #ifndef DTC_H
  3. #define DTC_H
  4. /*
  5. * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005.
  6. */
  7. #include <stdio.h>
  8. #include <string.h>
  9. #include <stdlib.h>
  10. #include <stdint.h>
  11. #include <stdbool.h>
  12. #include <stdarg.h>
  13. #include <assert.h>
  14. #include <ctype.h>
  15. #include <errno.h>
  16. #include <unistd.h>
  17. #include <inttypes.h>
  18. #include <libfdt_env.h>
  19. #include <fdt.h>
  20. #include "util.h"
  21. #ifdef DEBUG
  22. #define debug(...) printf(__VA_ARGS__)
  23. #else
  24. #define debug(...)
  25. #endif
  26. #define DEFAULT_FDT_VERSION 17
  27. /*
  28. * Command line options
  29. */
  30. extern int quiet; /* Level of quietness */
  31. extern int reservenum; /* Number of memory reservation slots */
  32. extern int minsize; /* Minimum blob size */
  33. extern int padsize; /* Additional padding to blob */
  34. extern int alignsize; /* Additional padding to blob accroding to the alignsize */
  35. extern int phandle_format; /* Use linux,phandle or phandle properties */
  36. extern int generate_symbols; /* generate symbols for nodes with labels */
  37. extern int generate_fixups; /* generate fixups */
  38. extern int auto_label_aliases; /* auto generate labels -> aliases */
  39. extern int annotate; /* annotate .dts with input source location */
  40. #define PHANDLE_LEGACY 0x1
  41. #define PHANDLE_EPAPR 0x2
  42. #define PHANDLE_BOTH 0x3
  43. typedef uint32_t cell_t;
  44. #define streq(a, b) (strcmp((a), (b)) == 0)
  45. #define strstarts(s, prefix) (strncmp((s), (prefix), strlen(prefix)) == 0)
  46. #define strprefixeq(a, n, b) (strlen(b) == (n) && (memcmp(a, b, n) == 0))
  47. #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
  48. /* Data blobs */
  49. enum markertype {
  50. TYPE_NONE,
  51. REF_PHANDLE,
  52. REF_PATH,
  53. LABEL,
  54. TYPE_UINT8,
  55. TYPE_UINT16,
  56. TYPE_UINT32,
  57. TYPE_UINT64,
  58. TYPE_STRING,
  59. };
  60. extern const char *markername(enum markertype markertype);
  61. struct marker {
  62. enum markertype type;
  63. int offset;
  64. char *ref;
  65. struct marker *next;
  66. };
  67. struct data {
  68. int len;
  69. char *val;
  70. struct marker *markers;
  71. };
  72. #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
  73. #define for_each_marker(m) \
  74. for (; (m); (m) = (m)->next)
  75. #define for_each_marker_of_type(m, t) \
  76. for_each_marker(m) \
  77. if ((m)->type == (t))
  78. size_t type_marker_length(struct marker *m);
  79. void data_free(struct data d);
  80. struct data data_grow_for(struct data d, int xlen);
  81. struct data data_copy_mem(const char *mem, int len);
  82. struct data data_copy_escape_string(const char *s, int len);
  83. struct data data_copy_file(FILE *f, size_t len);
  84. struct data data_append_data(struct data d, const void *p, int len);
  85. struct data data_insert_at_marker(struct data d, struct marker *m,
  86. const void *p, int len);
  87. struct data data_merge(struct data d1, struct data d2);
  88. struct data data_append_cell(struct data d, cell_t word);
  89. struct data data_append_integer(struct data d, uint64_t word, int bits);
  90. struct data data_append_re(struct data d, uint64_t address, uint64_t size);
  91. struct data data_append_addr(struct data d, uint64_t addr);
  92. struct data data_append_byte(struct data d, uint8_t byte);
  93. struct data data_append_zeroes(struct data d, int len);
  94. struct data data_append_align(struct data d, int align);
  95. struct data data_add_marker(struct data d, enum markertype type, char *ref);
  96. bool data_is_one_string(struct data d);
  97. /* DT constraints */
  98. #define MAX_PROPNAME_LEN 31
  99. #define MAX_NODENAME_LEN 31
  100. /* Live trees */
  101. struct label {
  102. bool deleted;
  103. char *label;
  104. struct label *next;
  105. };
  106. struct bus_type {
  107. const char *name;
  108. };
  109. struct property {
  110. bool deleted;
  111. char *name;
  112. struct data val;
  113. struct property *next;
  114. struct label *labels;
  115. struct srcpos *srcpos;
  116. };
  117. struct node {
  118. bool deleted;
  119. char *name;
  120. struct property *proplist;
  121. struct node *children;
  122. struct node *parent;
  123. struct node *next_sibling;
  124. char *fullpath;
  125. int basenamelen;
  126. cell_t phandle;
  127. int addr_cells, size_cells;
  128. struct label *labels;
  129. const struct bus_type *bus;
  130. struct srcpos *srcpos;
  131. bool omit_if_unused, is_referenced;
  132. };
  133. #define for_each_label_withdel(l0, l) \
  134. for ((l) = (l0); (l); (l) = (l)->next)
  135. #define for_each_label(l0, l) \
  136. for_each_label_withdel(l0, l) \
  137. if (!(l)->deleted)
  138. #define for_each_property_withdel(n, p) \
  139. for ((p) = (n)->proplist; (p); (p) = (p)->next)
  140. #define for_each_property(n, p) \
  141. for_each_property_withdel(n, p) \
  142. if (!(p)->deleted)
  143. #define for_each_child_withdel(n, c) \
  144. for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
  145. #define for_each_child(n, c) \
  146. for_each_child_withdel(n, c) \
  147. if (!(c)->deleted)
  148. void add_label(struct label **labels, char *label);
  149. void delete_labels(struct label **labels);
  150. struct property *build_property(char *name, struct data val,
  151. struct srcpos *srcpos);
  152. struct property *build_property_delete(char *name);
  153. struct property *chain_property(struct property *first, struct property *list);
  154. struct property *reverse_properties(struct property *first);
  155. struct node *build_node(struct property *proplist, struct node *children,
  156. struct srcpos *srcpos);
  157. struct node *build_node_delete(struct srcpos *srcpos);
  158. struct node *name_node(struct node *node, char *name);
  159. struct node *omit_node_if_unused(struct node *node);
  160. struct node *reference_node(struct node *node);
  161. struct node *chain_node(struct node *first, struct node *list);
  162. struct node *merge_nodes(struct node *old_node, struct node *new_node);
  163. struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref);
  164. void add_property(struct node *node, struct property *prop);
  165. void delete_property_by_name(struct node *node, char *name);
  166. void delete_property(struct property *prop);
  167. void add_child(struct node *parent, struct node *child);
  168. void delete_node_by_name(struct node *parent, char *name);
  169. void delete_node(struct node *node);
  170. void append_to_property(struct node *node,
  171. char *name, const void *data, int len,
  172. enum markertype type);
  173. const char *get_unitname(struct node *node);
  174. struct property *get_property(struct node *node, const char *propname);
  175. cell_t propval_cell(struct property *prop);
  176. cell_t propval_cell_n(struct property *prop, int n);
  177. struct property *get_property_by_label(struct node *tree, const char *label,
  178. struct node **node);
  179. struct marker *get_marker_label(struct node *tree, const char *label,
  180. struct node **node, struct property **prop);
  181. struct node *get_subnode(struct node *node, const char *nodename);
  182. struct node *get_node_by_path(struct node *tree, const char *path);
  183. struct node *get_node_by_label(struct node *tree, const char *label);
  184. struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
  185. struct node *get_node_by_ref(struct node *tree, const char *ref);
  186. cell_t get_node_phandle(struct node *root, struct node *node);
  187. uint32_t guess_boot_cpuid(struct node *tree);
  188. /* Boot info (tree plus memreserve information */
  189. struct reserve_info {
  190. uint64_t address, size;
  191. struct reserve_info *next;
  192. struct label *labels;
  193. };
  194. struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
  195. struct reserve_info *chain_reserve_entry(struct reserve_info *first,
  196. struct reserve_info *list);
  197. struct reserve_info *add_reserve_entry(struct reserve_info *list,
  198. struct reserve_info *new);
  199. struct dt_info {
  200. unsigned int dtsflags;
  201. struct reserve_info *reservelist;
  202. uint32_t boot_cpuid_phys;
  203. struct node *dt; /* the device tree */
  204. const char *outname; /* filename being written to, "-" for stdout */
  205. };
  206. /* DTS version flags definitions */
  207. #define DTSF_V1 0x0001 /* /dts-v1/ */
  208. #define DTSF_PLUGIN 0x0002 /* /plugin/ */
  209. struct dt_info *build_dt_info(unsigned int dtsflags,
  210. struct reserve_info *reservelist,
  211. struct node *tree, uint32_t boot_cpuid_phys);
  212. void sort_tree(struct dt_info *dti);
  213. void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
  214. void generate_fixups_tree(struct dt_info *dti, char *name);
  215. void generate_local_fixups_tree(struct dt_info *dti, char *name);
  216. /* Checks */
  217. void parse_checks_option(bool warn, bool error, const char *arg);
  218. void process_checks(bool force, struct dt_info *dti);
  219. /* Flattened trees */
  220. void dt_to_blob(FILE *f, struct dt_info *dti, int version);
  221. void dt_to_asm(FILE *f, struct dt_info *dti, int version);
  222. struct dt_info *dt_from_blob(const char *fname);
  223. /* Tree source */
  224. void dt_to_source(FILE *f, struct dt_info *dti);
  225. struct dt_info *dt_from_source(const char *f);
  226. /* YAML source */
  227. void dt_to_yaml(FILE *f, struct dt_info *dti);
  228. /* FS trees */
  229. struct dt_info *dt_from_fs(const char *dirname);
  230. #endif /* DTC_H */