This patch enable the generation of symbols & local fixup information for trees compiled with the -@ (--symbols) option. Using this patch labels in the tree and their users emit information in __symbols__ and __local_fixups__ nodes. The __fixups__ node make possible the dynamic resolution of phandle references which are present in the plugin tree but lie in the tree that are applying the overlay against. Signed-off-by: Pantelis Antoniou <pantelis.antoniou@xxxxxxxxxxxx> Signed-off-by: Sascha Hauer <s.hauer@xxxxxxxxxxxxxx> Signed-off-by: Jan Luebbe <jlu@xxxxxxxxxxxxxx> --- Documentation/manual.txt | 16 ++++ checks.c | 8 +- dtc-lexer.l | 5 ++ dtc-parser.y | 45 ++++++++-- dtc.c | 23 +++++- dtc.h | 29 ++++++- flattree.c | 2 +- fstree.c | 2 +- livetree.c | 209 ++++++++++++++++++++++++++++++++++++++++++++++- treesource.c | 1 + 10 files changed, 327 insertions(+), 13 deletions(-) diff --git a/Documentation/manual.txt b/Documentation/manual.txt index f64c4f4..63066ec 100644 --- a/Documentation/manual.txt +++ b/Documentation/manual.txt @@ -126,6 +126,20 @@ Options: Make space for <number> reserve map entries Relevant for dtb and asm output only. + -@ + Generates a __symbols__ node at the root node of the resulting blob + for any node labels used, and for any local references using phandles + it also generates a __local_fixups__ node that tracks them. + + When using the /plugin/ tag all unresolved label references to + be tracked in the __fixups__ node, making dynamic resolution possible. + + -A + Generate automatically aliases for all node labels. This is similar to + the -@ option (the __symbols__ node contain identical information) but + the semantics are slightly different since no phandles are automatically + generated for labeled nodes. + -S <bytes> Ensure the blob at least <bytes> long, adding additional space if needed. @@ -160,6 +174,8 @@ Here is a very rough overview of the layout of a DTS source file: devicetree: '/' nodedef + plugindecl: '/' 'plugin' '/' ';' + nodedef: '{' list_of_property list_of_subnode '}' ';' property: label PROPNAME '=' propdata ';' diff --git a/checks.c b/checks.c index 386f956..3d4c3c6 100644 --- a/checks.c +++ b/checks.c @@ -490,8 +490,12 @@ static void fixup_phandle_references(struct check *c, struct node *dt, refnode = get_node_by_ref(dt, m->ref); if (! refnode) { - FAIL(c, "Reference to non-existent node or label \"%s\"\n", - m->ref); + if (!(tree_get_versionflags(dt) & VF_PLUGIN)) + FAIL(c, "Reference to non-existent node or " + "label \"%s\"\n", m->ref); + else /* mark the entry as unresolved */ + *((cell_t *)(prop->val.val + m->offset)) = + cpu_to_fdt32(0xffffffff); continue; } diff --git a/dtc-lexer.l b/dtc-lexer.l index 790fbf6..40bbc87 100644 --- a/dtc-lexer.l +++ b/dtc-lexer.l @@ -121,6 +121,11 @@ static void lexical_error(const char *fmt, ...); return DT_V1; } +<*>"/plugin/" { + DPRINT("Keyword: /plugin/\n"); + return DT_PLUGIN; + } + <*>"/memreserve/" { DPRINT("Keyword: /memreserve/\n"); BEGIN_DEFAULT(); diff --git a/dtc-parser.y b/dtc-parser.y index 000873f..2890c1c 100644 --- a/dtc-parser.y +++ b/dtc-parser.y @@ -19,6 +19,7 @@ */ %{ #include <stdio.h> +#include <inttypes.h> #include "dtc.h" #include "srcpos.h" @@ -33,6 +34,7 @@ extern void yyerror(char const *s); extern struct boot_info *the_boot_info; extern bool treesource_error; +extern unsigned int the_versionflags; %} %union { @@ -52,9 +54,11 @@ extern bool treesource_error; struct node *nodelist; struct reserve_info *re; uint64_t integer; + unsigned int flags; } %token DT_V1 +%token DT_PLUGIN %token DT_MEMRESERVE %token DT_LSHIFT DT_RSHIFT DT_LE DT_GE DT_EQ DT_NE DT_AND DT_OR %token DT_BITS @@ -71,6 +75,8 @@ extern bool treesource_error; %type <data> propdata %type <data> propdataprefix +%type <flags> versioninfo +%type <flags> plugindecl %type <re> memreserve %type <re> memreserves %type <array> arrayprefix @@ -101,13 +107,33 @@ extern bool treesource_error; %% sourcefile: - DT_V1 ';' memreserves devicetree + versioninfo ';' memreserves devicetree { - the_boot_info = build_boot_info($3, $4, + the_boot_info = build_boot_info($1, $3, $4, guess_boot_cpuid($4)); } ; +versioninfo: + DT_V1 plugindecl + { + the_versionflags |= VF_DT_V1 | $2; + $$ = the_versionflags; + } + ; + +plugindecl: + DT_PLUGIN + { + the_versionflags |= VF_PLUGIN; + $$ = VF_PLUGIN; + } + | /* empty */ + { + $$ = 0; + } + ; + memreserves: /* empty */ { @@ -156,10 +182,14 @@ devicetree: { struct node *target = get_node_by_ref($1, $2); - if (target) + if (target) { merge_nodes(target, $3); - else - ERROR(&@2, "Label or path %s not found", $2); + } else { + if (the_versionflags & VF_PLUGIN) + add_orphan_node($1, $3, $2); + else + ERROR(&@2, "Label or path %s not found", $2); + } $$ = $1; } | devicetree DT_DEL_NODE DT_REF ';' @@ -174,6 +204,11 @@ devicetree: $$ = $1; } + | /* empty */ + { + /* build empty node */ + $$ = name_node(build_node(NULL, NULL), ""); + } ; nodedef: diff --git a/dtc.c b/dtc.c index 63c2c9c..a25f852 100644 --- a/dtc.c +++ b/dtc.c @@ -31,6 +31,8 @@ int reservenum; /* Number of memory reservation slots */ int minsize; /* Minimum blob size */ int padsize; /* Additional padding to blob */ int phandle_format = PHANDLE_BOTH; /* Use linux,phandle or phandle properties */ +int symbol_fixup_support; +int auto_label_aliases; static void fill_fullpaths(struct node *tree, const char *prefix) { @@ -53,7 +55,7 @@ static void fill_fullpaths(struct node *tree, const char *prefix) #define FDT_VERSION(version) _FDT_VERSION(version) #define _FDT_VERSION(version) #version static const char usage_synopsis[] = "dtc [options] <input file>"; -static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:fb:i:H:sW:E:hv"; +static const char usage_short_opts[] = "qI:O:o:V:d:R:S:p:fb:i:H:sW:E:@Ahv"; static struct option const usage_long_opts[] = { {"quiet", no_argument, NULL, 'q'}, {"in-format", a_argument, NULL, 'I'}, @@ -71,6 +73,8 @@ static struct option const usage_long_opts[] = { {"phandle", a_argument, NULL, 'H'}, {"warning", a_argument, NULL, 'W'}, {"error", a_argument, NULL, 'E'}, + {"symbols", no_argument, NULL, '@'}, + {"auto-alias", no_argument, NULL, 'A'}, {"help", no_argument, NULL, 'h'}, {"version", no_argument, NULL, 'v'}, {NULL, no_argument, NULL, 0x0}, @@ -101,6 +105,8 @@ static const char * const usage_opts_help[] = { "\t\tboth - Both \"linux,phandle\" and \"phandle\" properties", "\n\tEnable/disable warnings (prefix with \"no-\")", "\n\tEnable/disable errors (prefix with \"no-\")", + "\n\tEnable symbols/fixup support", + "\n\tEnable auto-alias of labels", "\n\tPrint this help and exit", "\n\tPrint version and exit", NULL, @@ -237,7 +243,12 @@ int main(int argc, char *argv[]) case 'E': parse_checks_option(false, true, optarg); break; - + case '@': + symbol_fixup_support = 1; + break; + case 'A': + auto_label_aliases = 1; + break; case 'h': usage(NULL); default: @@ -295,6 +306,14 @@ int main(int argc, char *argv[]) fill_fullpaths(bi->dt, ""); process_checks(force, bi); + if (auto_label_aliases) + generate_label_tree(bi->dt, "aliases", false); + + if (symbol_fixup_support) { + generate_label_tree(bi->dt, "__symbols__", true); + generate_fixups_tree(bi->dt); + } + if (sort) sort_tree(bi); diff --git a/dtc.h b/dtc.h index 9d7f2d6..392cde7 100644 --- a/dtc.h +++ b/dtc.h @@ -54,6 +54,12 @@ extern int reservenum; /* Number of memory reservation slots */ extern int minsize; /* Minimum blob size */ extern int padsize; /* Additional padding to blob */ extern int phandle_format; /* Use linux,phandle or phandle properties */ +extern int symbol_fixup_support;/* enable symbols & fixup support */ +extern int auto_label_aliases; /* auto generate labels -> aliases */ + +/* + * Tree source globals + */ #define PHANDLE_LEGACY 0x1 #define PHANDLE_EPAPR 0x2 @@ -158,6 +164,9 @@ struct node { int addr_cells, size_cells; struct label *labels; + + /* only for the root (parent == NULL) */ + struct boot_info *bi; }; #define for_each_label_withdel(l0, l) \ @@ -194,6 +203,7 @@ struct node *build_node_delete(void); struct node *name_node(struct node *node, char *name); struct node *chain_node(struct node *first, struct node *list); struct node *merge_nodes(struct node *old_node, struct node *new_node); +void add_orphan_node(struct node *old_node, struct node *new_node, char *ref); void add_property(struct node *node, struct property *prop); void delete_property_by_name(struct node *node, char *name); @@ -201,6 +211,8 @@ void delete_property(struct property *prop); void add_child(struct node *parent, struct node *child); void delete_node_by_name(struct node *parent, char *name); void delete_node(struct node *node); +struct property *append_to_property(struct node *node, + char *name, const void *data, int len); const char *get_unitname(struct node *node); struct property *get_property(struct node *node, const char *propname); @@ -236,14 +248,29 @@ struct reserve_info *add_reserve_entry(struct reserve_info *list, struct boot_info { + unsigned int versionflags; struct reserve_info *reservelist; struct node *dt; /* the device tree */ uint32_t boot_cpuid_phys; }; -struct boot_info *build_boot_info(struct reserve_info *reservelist, +/* version flags definitions */ +#define VF_DT_V1 0x0001 /* /dts-v1/ */ +#define VF_PLUGIN 0x0002 /* /plugin/ */ + +static inline unsigned int tree_get_versionflags(struct node *dt) +{ + if (!dt || !dt->bi) + return 0; + return dt->bi->versionflags; +} + +struct boot_info *build_boot_info(unsigned int versionflags, + struct reserve_info *reservelist, struct node *tree, uint32_t boot_cpuid_phys); void sort_tree(struct boot_info *bi); +void generate_label_tree(struct node *dt, char *gen_node_name, bool allocph); +void generate_fixups_tree(struct node *dt); /* Checks */ diff --git a/flattree.c b/flattree.c index 64ed375..4fe64d4 100644 --- a/flattree.c +++ b/flattree.c @@ -930,5 +930,5 @@ struct boot_info *dt_from_blob(const char *fname) fclose(f); - return build_boot_info(reservelist, tree, boot_cpuid_phys); + return build_boot_info(VF_DT_V1, reservelist, tree, boot_cpuid_phys); } diff --git a/fstree.c b/fstree.c index 6d1beec..54f520b 100644 --- a/fstree.c +++ b/fstree.c @@ -86,6 +86,6 @@ struct boot_info *dt_from_fs(const char *dirname) tree = read_fstree(dirname); tree = name_node(tree, ""); - return build_boot_info(NULL, tree, guess_boot_cpuid(tree)); + return build_boot_info(VF_DT_V1, NULL, tree, guess_boot_cpuid(tree)); } diff --git a/livetree.c b/livetree.c index e229b84..3eab9e2 100644 --- a/livetree.c +++ b/livetree.c @@ -216,6 +216,31 @@ struct node *merge_nodes(struct node *old_node, struct node *new_node) return old_node; } +void add_orphan_node(struct node *dt, struct node *new_node, char *ref) +{ + static unsigned int next_orphan_fragment = 0; + struct node *node = xmalloc(sizeof(*node)); + struct property *p; + struct data d = empty_data; + char *name; + + memset(node, 0, sizeof(*node)); + + d = data_add_marker(d, REF_PHANDLE, ref); + d = data_append_integer(d, 0xffffffff, 32); + + p = build_property("target", d); + add_property(node, p); + + xasprintf(&name, "fragment@%u", + next_orphan_fragment++); + name_node(node, name); + name_node(new_node, "__overlay__"); + + add_child(dt, node); + add_child(node, new_node); +} + struct node *chain_node(struct node *first, struct node *list) { assert(first->next_sibling == NULL); @@ -296,6 +321,24 @@ void delete_node(struct node *node) delete_labels(&node->labels); } +struct property *append_to_property(struct node *node, + char *name, const void *data, int len) +{ + struct data d; + struct property *p; + + p = get_property(node, name); + if (p) { + d = data_append_data(p->val, data, len); + p->val = d; + } else { + d = data_append_data(empty_data, data, len); + p = build_property(name, d); + add_property(node, p); + } + return p; +} + struct reserve_info *build_reserve_entry(uint64_t address, uint64_t size) { struct reserve_info *new = xmalloc(sizeof(*new)); @@ -335,15 +378,19 @@ struct reserve_info *add_reserve_entry(struct reserve_info *list, return list; } -struct boot_info *build_boot_info(struct reserve_info *reservelist, +struct boot_info *build_boot_info(unsigned int versionflags, + struct reserve_info *reservelist, struct node *tree, uint32_t boot_cpuid_phys) { struct boot_info *bi; bi = xmalloc(sizeof(*bi)); + bi->versionflags = versionflags; bi->reservelist = reservelist; bi->dt = tree; bi->boot_cpuid_phys = boot_cpuid_phys; + /* link back */ + tree->bi = bi; return bi; } @@ -709,3 +756,163 @@ void sort_tree(struct boot_info *bi) sort_reserve_entries(bi); sort_node(bi->dt); } + +/* utility helper to avoid code duplication */ +static struct node *build_and_name_child_node(struct node *parent, char *name) +{ + struct node *node; + + node = build_node(NULL, NULL); + name_node(node, xstrdup(name)); + add_child(parent, node); + + return node; +} + +static void generate_label_tree_internal(struct node *dt, struct node *node, + struct node *an, bool allocph) +{ + struct node *c; + struct property *p; + struct label *l; + + /* if if there are labels */ + if (node->labels) { + /* now add the label in the node */ + for_each_label(node->labels, l) { + /* check whether the label already exists */ + p = get_property(an, l->label); + if (p) { + fprintf(stderr, "WARNING: label %s already" + " exists in /%s", l->label, + an->name); + continue; + } + + /* insert it */ + p = build_property(l->label, + data_copy_escape_string(node->fullpath, + strlen(node->fullpath))); + add_property(an, p); + } + + /* force allocation of a phandle for this node */ + if (allocph) + (void)get_node_phandle(dt, node); + } + + for_each_child(node, c) + generate_label_tree_internal(dt, c, an, allocph); +} + +void generate_label_tree(struct node *dt, char *gen_node_name, bool allocph) +{ + struct node *an; + + an = build_and_name_child_node(dt, gen_node_name); + if (!an) + die("Could not build label node /%s\n", gen_node_name); + + generate_label_tree_internal(dt, dt, an, allocph); +} + +static char *fixups_name = "__fixups__"; +static char *local_fixups_name = "__local_fixups__"; + +static void add_fixup_entry(struct node *dt, struct node *node, + struct property *prop, struct marker *m) +{ + struct node *fn; /* fixup node */ + char *entry; + + /* m->ref can only be a REF_PHANDLE, but check anyway */ + assert(m->type == REF_PHANDLE); + + /* fn is the node we're putting entries in */ + fn = get_subnode(dt, fixups_name); + assert(fn != NULL); + + /* there shouldn't be any ':' in the arguments */ + if (strchr(node->fullpath, ':') || strchr(prop->name, ':')) + die("arguments should not contain ':'\n"); + + xasprintf(&entry, "%s:%s:%u", + node->fullpath, prop->name, m->offset); + append_to_property(fn, m->ref, entry, strlen(entry) + 1); +} + +static void add_local_fixup_entry(struct node *dt, struct node *node, + struct property *prop, struct marker *m, + struct node *refnode) +{ + struct node *lfn, *wn, *nwn; /* local fixup node, walk node, new */ + uint32_t value_32; + char *s, *e, *comp; + int len; + + /* fn is the node we're putting entries in */ + lfn = get_subnode(dt, local_fixups_name); + assert(lfn != NULL); + + /* walk the path components creating nodes if they don't exist */ + comp = xmalloc(strlen(node->fullpath) + 1); + /* start skipping the first / */ + s = node->fullpath + 1; + wn = lfn; + while (*s) { + /* retrieve path component */ + e = strchr(s, '/'); + if (e == NULL) + e = s + strlen(s); + len = e - s; + memcpy(comp, s, len); + comp[len] = '\0'; + + /* if no node exists, create it */ + nwn = get_subnode(wn, comp); + if (!nwn) + nwn = build_and_name_child_node(wn, comp); + wn = nwn; + + /* last path component */ + if (!*e) + break; + + /* next path component */ + s = e + 1; + } + free(comp); + + value_32 = cpu_to_fdt32(m->offset); + append_to_property(wn, prop->name, &value_32, sizeof(value_32)); +} + +static void generate_fixups_tree_internal(struct node *dt, struct node *node) +{ + struct node *c; + struct property *prop; + struct marker *m; + struct node *refnode; + + for_each_property(node, prop) { + m = prop->val.markers; + for_each_marker_of_type(m, REF_PHANDLE) { + refnode = get_node_by_ref(dt, m->ref); + if (!refnode) + add_fixup_entry(dt, node, prop, m); + else + add_local_fixup_entry(dt, node, prop, m, + refnode); + } + } + + for_each_child(node, c) + generate_fixups_tree_internal(dt, c); +} + +void generate_fixups_tree(struct node *dt) +{ + build_and_name_child_node(dt, fixups_name); + build_and_name_child_node(dt, local_fixups_name); + generate_fixups_tree_internal(dt, dt); +} diff --git a/treesource.c b/treesource.c index a55d1d1..2539a57 100644 --- a/treesource.c +++ b/treesource.c @@ -27,6 +27,7 @@ extern YYLTYPE yylloc; struct boot_info *the_boot_info; bool treesource_error; +unsigned int the_versionflags; struct boot_info *dt_from_source(const char *fname) { -- 1.7.12 -- To unsubscribe from this list: send the line "unsubscribe devicetree-compiler" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html