| // SPDX-License-Identifier: GPL-2.0-or-later |
| /* |
| * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2007. |
| */ |
| |
| #include "dtc.h" |
| #include "srcpos.h" |
| |
| #ifdef TRACE_CHECKS |
| #define TRACE(c, ...) \ |
| do { \ |
| fprintf(stderr, "=== %s: ", (c)->name); \ |
| fprintf(stderr, __VA_ARGS__); \ |
| fprintf(stderr, "\n"); \ |
| } while (0) |
| #else |
| #define TRACE(c, fmt, ...) do { } while (0) |
| #endif |
| |
| enum checkstatus { |
| UNCHECKED = 0, |
| PREREQ, |
| PASSED, |
| FAILED, |
| }; |
| |
| struct check; |
| |
| typedef void (*check_fn)(struct check *c, struct dt_info *dti, struct node *node); |
| |
| struct check { |
| const char *name; |
| check_fn fn; |
| void *data; |
| bool warn, error; |
| enum checkstatus status; |
| bool inprogress; |
| int num_prereqs; |
| struct check **prereq; |
| }; |
| |
| #define CHECK_ENTRY(nm_, fn_, d_, w_, e_, ...) \ |
| static struct check *nm_##_prereqs[] = { __VA_ARGS__ }; \ |
| static struct check nm_ = { \ |
| .name = #nm_, \ |
| .fn = (fn_), \ |
| .data = (d_), \ |
| .warn = (w_), \ |
| .error = (e_), \ |
| .status = UNCHECKED, \ |
| .num_prereqs = ARRAY_SIZE(nm_##_prereqs), \ |
| .prereq = nm_##_prereqs, \ |
| }; |
| #define WARNING(nm_, fn_, d_, ...) \ |
| CHECK_ENTRY(nm_, fn_, d_, true, false, __VA_ARGS__) |
| #define ERROR(nm_, fn_, d_, ...) \ |
| CHECK_ENTRY(nm_, fn_, d_, false, true, __VA_ARGS__) |
| #define CHECK(nm_, fn_, d_, ...) \ |
| CHECK_ENTRY(nm_, fn_, d_, false, false, __VA_ARGS__) |
| |
| static inline void PRINTF(5, 6) check_msg(struct check *c, struct dt_info *dti, |
| struct node *node, |
| struct property *prop, |
| const char *fmt, ...) |
| { |
| va_list ap; |
| char *str = NULL; |
| struct srcpos *pos = NULL; |
| char *file_str; |
| |
| if (!(c->warn && (quiet < 1)) && !(c->error && (quiet < 2))) |
| return; |
| |
| if (prop && prop->srcpos) |
| pos = prop->srcpos; |
| else if (node && node->srcpos) |
| pos = node->srcpos; |
| |
| if (pos) { |
| file_str = srcpos_string(pos); |
| xasprintf(&str, "%s", file_str); |
| free(file_str); |
| } else if (streq(dti->outname, "-")) { |
| xasprintf(&str, "<stdout>"); |
| } else { |
| xasprintf(&str, "%s", dti->outname); |
| } |
| |
| xasprintf_append(&str, ": %s (%s): ", |
| (c->error) ? "ERROR" : "Warning", c->name); |
| |
| if (node) { |
| if (prop) |
| xasprintf_append(&str, "%s:%s: ", node->fullpath, prop->name); |
| else |
| xasprintf_append(&str, "%s: ", node->fullpath); |
| } |
| |
| va_start(ap, fmt); |
| xavsprintf_append(&str, fmt, ap); |
| va_end(ap); |
| |
| xasprintf_append(&str, "\n"); |
| |
| if (!prop && pos) { |
| pos = node->srcpos; |
| while (pos->next) { |
| pos = pos->next; |
| |
| file_str = srcpos_string(pos); |
| xasprintf_append(&str, " also defined at %s\n", file_str); |
| free(file_str); |
| } |
| } |
| |
| fputs(str, stderr); |
| } |
| |
| #define FAIL(c, dti, node, ...) \ |
| do { \ |
| TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__); \ |
| (c)->status = FAILED; \ |
| check_msg((c), dti, node, NULL, __VA_ARGS__); \ |
| } while (0) |
| |
| #define FAIL_PROP(c, dti, node, prop, ...) \ |
| do { \ |
| TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__); \ |
| (c)->status = FAILED; \ |
| check_msg((c), dti, node, prop, __VA_ARGS__); \ |
| } while (0) |
| |
| |
| static void check_nodes_props(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct node *child; |
| |
| TRACE(c, "%s", node->fullpath); |
| if (c->fn) |
| c->fn(c, dti, node); |
| |
| for_each_child(node, child) |
| check_nodes_props(c, dti, child); |
| } |
| |
| static bool is_multiple_of(int multiple, int divisor) |
| { |
| if (divisor == 0) |
| return multiple == 0; |
| else |
| return (multiple % divisor) == 0; |
| } |
| |
| static bool run_check(struct check *c, struct dt_info *dti) |
| { |
| struct node *dt = dti->dt; |
| bool error = false; |
| int i; |
| |
| assert(!c->inprogress); |
| |
| if (c->status != UNCHECKED) |
| goto out; |
| |
| c->inprogress = true; |
| |
| for (i = 0; i < c->num_prereqs; i++) { |
| struct check *prq = c->prereq[i]; |
| error = error || run_check(prq, dti); |
| if (prq->status != PASSED) { |
| c->status = PREREQ; |
| check_msg(c, dti, NULL, NULL, "Failed prerequisite '%s'", |
| c->prereq[i]->name); |
| } |
| } |
| |
| if (c->status != UNCHECKED) |
| goto out; |
| |
| check_nodes_props(c, dti, dt); |
| |
| if (c->status == UNCHECKED) |
| c->status = PASSED; |
| |
| TRACE(c, "\tCompleted, status %d", c->status); |
| |
| out: |
| c->inprogress = false; |
| if ((c->status != PASSED) && (c->error)) |
| error = true; |
| return error; |
| } |
| |
| /* |
| * Utility check functions |
| */ |
| |
| /* A check which always fails, for testing purposes only */ |
| static inline void check_always_fail(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| FAIL(c, dti, node, "always_fail check"); |
| } |
| CHECK(always_fail, check_always_fail, NULL); |
| |
| static void check_is_string(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| char *propname = c->data; |
| |
| prop = get_property(node, propname); |
| if (!prop) |
| return; /* Not present, assumed ok */ |
| |
| if (!data_is_one_string(prop->val)) |
| FAIL_PROP(c, dti, node, prop, "property is not a string"); |
| } |
| #define WARNING_IF_NOT_STRING(nm, propname) \ |
| WARNING(nm, check_is_string, (propname)) |
| #define ERROR_IF_NOT_STRING(nm, propname) \ |
| ERROR(nm, check_is_string, (propname)) |
| |
| static void check_is_string_list(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| int rem, l; |
| struct property *prop; |
| char *propname = c->data; |
| char *str; |
| |
| prop = get_property(node, propname); |
| if (!prop) |
| return; /* Not present, assumed ok */ |
| |
| str = prop->val.val; |
| rem = prop->val.len; |
| while (rem > 0) { |
| l = strnlen(str, rem); |
| if (l == rem) { |
| FAIL_PROP(c, dti, node, prop, "property is not a string list"); |
| break; |
| } |
| rem -= l + 1; |
| str += l + 1; |
| } |
| } |
| #define WARNING_IF_NOT_STRING_LIST(nm, propname) \ |
| WARNING(nm, check_is_string_list, (propname)) |
| #define ERROR_IF_NOT_STRING_LIST(nm, propname) \ |
| ERROR(nm, check_is_string_list, (propname)) |
| |
| static void check_is_cell(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| char *propname = c->data; |
| |
| prop = get_property(node, propname); |
| if (!prop) |
| return; /* Not present, assumed ok */ |
| |
| if (prop->val.len != sizeof(cell_t)) |
| FAIL_PROP(c, dti, node, prop, "property is not a single cell"); |
| } |
| #define WARNING_IF_NOT_CELL(nm, propname) \ |
| WARNING(nm, check_is_cell, (propname)) |
| #define ERROR_IF_NOT_CELL(nm, propname) \ |
| ERROR(nm, check_is_cell, (propname)) |
| |
| /* |
| * Structural check functions |
| */ |
| |
| static void check_duplicate_node_names(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *child, *child2; |
| |
| for_each_child(node, child) |
| for (child2 = child->next_sibling; |
| child2; |
| child2 = child2->next_sibling) |
| if (streq(child->name, child2->name)) |
| FAIL(c, dti, child2, "Duplicate node name"); |
| } |
| ERROR(duplicate_node_names, check_duplicate_node_names, NULL); |
| |
| static void check_duplicate_property_names(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop, *prop2; |
| |
| for_each_property(node, prop) { |
| for (prop2 = prop->next; prop2; prop2 = prop2->next) { |
| if (prop2->deleted) |
| continue; |
| if (streq(prop->name, prop2->name)) |
| FAIL_PROP(c, dti, node, prop, "Duplicate property name"); |
| } |
| } |
| } |
| ERROR(duplicate_property_names, check_duplicate_property_names, NULL); |
| |
| #define LOWERCASE "abcdefghijklmnopqrstuvwxyz" |
| #define UPPERCASE "ABCDEFGHIJKLMNOPQRSTUVWXYZ" |
| #define DIGITS "0123456789" |
| #define NODECHARS LOWERCASE UPPERCASE DIGITS ",._+-@" |
| #define PROPCHARS LOWERCASE UPPERCASE DIGITS ",._+*#?-" |
| #define PROPNODECHARSSTRICT LOWERCASE UPPERCASE DIGITS ",-" |
| |
| static void check_node_name_chars(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| size_t n = strspn(node->name, c->data); |
| |
| if (n < strlen(node->name)) |
| FAIL(c, dti, node, "Bad character '%c' in node name", |
| node->name[n]); |
| } |
| ERROR(node_name_chars, check_node_name_chars, NODECHARS); |
| |
| static void check_node_name_chars_strict(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| int n = strspn(node->name, c->data); |
| |
| if (n < node->basenamelen) |
| FAIL(c, dti, node, "Character '%c' not recommended in node name", |
| node->name[n]); |
| } |
| CHECK(node_name_chars_strict, check_node_name_chars_strict, PROPNODECHARSSTRICT); |
| |
| static void check_node_name_format(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| if (strchr(get_unitname(node), '@')) |
| FAIL(c, dti, node, "multiple '@' characters in node name"); |
| } |
| ERROR(node_name_format, check_node_name_format, NULL, &node_name_chars); |
| |
| static void check_node_name_vs_property_name(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| if (!node->parent) |
| return; |
| |
| if (get_property(node->parent, node->name)) { |
| FAIL(c, dti, node, "node name and property name conflict"); |
| } |
| } |
| WARNING(node_name_vs_property_name, check_node_name_vs_property_name, |
| NULL, &node_name_chars); |
| |
| static void check_unit_address_vs_reg(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| const char *unitname = get_unitname(node); |
| struct property *prop = get_property(node, "reg"); |
| |
| if (get_subnode(node, "__overlay__")) { |
| /* HACK: Overlay fragments are a special case */ |
| return; |
| } |
| |
| if (!prop) { |
| prop = get_property(node, "ranges"); |
| if (prop && !prop->val.len) |
| prop = NULL; |
| } |
| |
| if (prop) { |
| if (!unitname[0]) |
| FAIL(c, dti, node, "node has a reg or ranges property, but no unit name"); |
| } else { |
| if (unitname[0]) |
| FAIL(c, dti, node, "node has a unit name, but no reg or ranges property"); |
| } |
| } |
| WARNING(unit_address_vs_reg, check_unit_address_vs_reg, NULL); |
| |
| static void check_property_name_chars(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| size_t n = strspn(prop->name, c->data); |
| |
| if (n < strlen(prop->name)) |
| FAIL_PROP(c, dti, node, prop, "Bad character '%c' in property name", |
| prop->name[n]); |
| } |
| } |
| ERROR(property_name_chars, check_property_name_chars, PROPCHARS); |
| |
| static void check_property_name_chars_strict(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| const char *name = prop->name; |
| size_t n = strspn(name, c->data); |
| |
| if (n == strlen(prop->name)) |
| continue; |
| |
| /* Certain names are whitelisted */ |
| if (streq(name, "device_type")) |
| continue; |
| |
| /* |
| * # is only allowed at the beginning of property names not counting |
| * the vendor prefix. |
| */ |
| if (name[n] == '#' && ((n == 0) || (name[n-1] == ','))) { |
| name += n + 1; |
| n = strspn(name, c->data); |
| } |
| if (n < strlen(name)) |
| FAIL_PROP(c, dti, node, prop, "Character '%c' not recommended in property name", |
| name[n]); |
| } |
| } |
| CHECK(property_name_chars_strict, check_property_name_chars_strict, PROPNODECHARSSTRICT); |
| |
| #define DESCLABEL_FMT "%s%s%s%s%s" |
| #define DESCLABEL_ARGS(node,prop,mark) \ |
| ((mark) ? "value of " : ""), \ |
| ((prop) ? "'" : ""), \ |
| ((prop) ? (prop)->name : ""), \ |
| ((prop) ? "' in " : ""), (node)->fullpath |
| |
| static void check_duplicate_label(struct check *c, struct dt_info *dti, |
| const char *label, struct node *node, |
| struct property *prop, struct marker *mark) |
| { |
| struct node *dt = dti->dt; |
| struct node *othernode = NULL; |
| struct property *otherprop = NULL; |
| struct marker *othermark = NULL; |
| |
| othernode = get_node_by_label(dt, label); |
| |
| if (!othernode) |
| otherprop = get_property_by_label(dt, label, &othernode); |
| if (!othernode) |
| othermark = get_marker_label(dt, label, &othernode, |
| &otherprop); |
| |
| if (!othernode) |
| return; |
| |
| if ((othernode != node) || (otherprop != prop) || (othermark != mark)) |
| FAIL(c, dti, node, "Duplicate label '%s' on " DESCLABEL_FMT |
| " and " DESCLABEL_FMT, |
| label, DESCLABEL_ARGS(node, prop, mark), |
| DESCLABEL_ARGS(othernode, otherprop, othermark)); |
| } |
| |
| static void check_duplicate_label_node(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct label *l; |
| struct property *prop; |
| |
| for_each_label(node->labels, l) |
| check_duplicate_label(c, dti, l->label, node, NULL, NULL); |
| |
| for_each_property(node, prop) { |
| struct marker *m = prop->val.markers; |
| |
| for_each_label(prop->labels, l) |
| check_duplicate_label(c, dti, l->label, node, prop, NULL); |
| |
| for_each_marker_of_type(m, LABEL) |
| check_duplicate_label(c, dti, m->ref, node, prop, m); |
| } |
| } |
| ERROR(duplicate_label, check_duplicate_label_node, NULL); |
| |
| static cell_t check_phandle_prop(struct check *c, struct dt_info *dti, |
| struct node *node, const char *propname) |
| { |
| struct node *root = dti->dt; |
| struct property *prop; |
| struct marker *m; |
| cell_t phandle; |
| |
| prop = get_property(node, propname); |
| if (!prop) |
| return 0; |
| |
| if (prop->val.len != sizeof(cell_t)) { |
| FAIL_PROP(c, dti, node, prop, "bad length (%d) %s property", |
| prop->val.len, prop->name); |
| return 0; |
| } |
| |
| m = prop->val.markers; |
| for_each_marker_of_type(m, REF_PHANDLE) { |
| assert(m->offset == 0); |
| if (node != get_node_by_ref(root, m->ref)) |
| /* "Set this node's phandle equal to some |
| * other node's phandle". That's nonsensical |
| * by construction. */ { |
| FAIL(c, dti, node, "%s is a reference to another node", |
| prop->name); |
| } |
| /* But setting this node's phandle equal to its own |
| * phandle is allowed - that means allocate a unique |
| * phandle for this node, even if it's not otherwise |
| * referenced. The value will be filled in later, so |
| * we treat it as having no phandle data for now. */ |
| return 0; |
| } |
| |
| phandle = propval_cell(prop); |
| |
| if (!phandle_is_valid(phandle)) { |
| FAIL_PROP(c, dti, node, prop, "bad value (0x%x) in %s property", |
| phandle, prop->name); |
| return 0; |
| } |
| |
| return phandle; |
| } |
| |
| static void check_explicit_phandles(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *root = dti->dt; |
| struct node *other; |
| cell_t phandle, linux_phandle; |
| |
| /* Nothing should have assigned phandles yet */ |
| assert(!node->phandle); |
| |
| phandle = check_phandle_prop(c, dti, node, "phandle"); |
| |
| linux_phandle = check_phandle_prop(c, dti, node, "linux,phandle"); |
| |
| if (!phandle && !linux_phandle) |
| /* No valid phandles; nothing further to check */ |
| return; |
| |
| if (linux_phandle && phandle && (phandle != linux_phandle)) |
| FAIL(c, dti, node, "mismatching 'phandle' and 'linux,phandle'" |
| " properties"); |
| |
| if (linux_phandle && !phandle) |
| phandle = linux_phandle; |
| |
| other = get_node_by_phandle(root, phandle); |
| if (other && (other != node)) { |
| FAIL(c, dti, node, "duplicated phandle 0x%x (seen before at %s)", |
| phandle, other->fullpath); |
| return; |
| } |
| |
| node->phandle = phandle; |
| } |
| ERROR(explicit_phandles, check_explicit_phandles, NULL); |
| |
| static void check_name_properties(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property **pp, *prop = NULL; |
| |
| for (pp = &node->proplist; *pp; pp = &((*pp)->next)) |
| if (streq((*pp)->name, "name")) { |
| prop = *pp; |
| break; |
| } |
| |
| if (!prop) |
| return; /* No name property, that's fine */ |
| |
| if ((prop->val.len != node->basenamelen + 1U) |
| || (memcmp(prop->val.val, node->name, node->basenamelen) != 0)) { |
| FAIL(c, dti, node, "\"name\" property is incorrect (\"%s\" instead" |
| " of base node name)", prop->val.val); |
| } else { |
| /* The name property is correct, and therefore redundant. |
| * Delete it */ |
| *pp = prop->next; |
| free(prop->name); |
| data_free(prop->val); |
| free(prop); |
| } |
| } |
| ERROR_IF_NOT_STRING(name_is_string, "name"); |
| ERROR(name_properties, check_name_properties, NULL, &name_is_string); |
| |
| /* |
| * Reference fixup functions |
| */ |
| |
| static void fixup_phandle_references(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *dt = dti->dt; |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| struct marker *m = prop->val.markers; |
| struct node *refnode; |
| cell_t phandle; |
| |
| for_each_marker_of_type(m, REF_PHANDLE) { |
| assert(m->offset + sizeof(cell_t) <= prop->val.len); |
| |
| refnode = get_node_by_ref(dt, m->ref); |
| if (! refnode) { |
| if (!(dti->dtsflags & DTSF_PLUGIN)) |
| FAIL(c, dti, node, "Reference to non-existent node or " |
| "label \"%s\"\n", m->ref); |
| else /* mark the entry as unresolved */ |
| *((fdt32_t *)(prop->val.val + m->offset)) = |
| cpu_to_fdt32(0xffffffff); |
| continue; |
| } |
| |
| phandle = get_node_phandle(dt, refnode); |
| *((fdt32_t *)(prop->val.val + m->offset)) = cpu_to_fdt32(phandle); |
| |
| reference_node(refnode); |
| } |
| } |
| } |
| ERROR(phandle_references, fixup_phandle_references, NULL, |
| &duplicate_node_names, &explicit_phandles); |
| |
| static void fixup_path_references(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *dt = dti->dt; |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| struct marker *m = prop->val.markers; |
| struct node *refnode; |
| char *path; |
| |
| for_each_marker_of_type(m, REF_PATH) { |
| assert(m->offset <= prop->val.len); |
| |
| refnode = get_node_by_ref(dt, m->ref); |
| if (!refnode) { |
| FAIL(c, dti, node, "Reference to non-existent node or label \"%s\"\n", |
| m->ref); |
| continue; |
| } |
| |
| path = refnode->fullpath; |
| prop->val = data_insert_at_marker(prop->val, m, path, |
| strlen(path) + 1); |
| |
| reference_node(refnode); |
| } |
| } |
| } |
| ERROR(path_references, fixup_path_references, NULL, &duplicate_node_names); |
| |
| static void fixup_omit_unused_nodes(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| if (generate_symbols && node->labels) |
| return; |
| if (node->omit_if_unused && !node->is_referenced) |
| delete_node(node); |
| } |
| ERROR(omit_unused_nodes, fixup_omit_unused_nodes, NULL, &phandle_references, &path_references); |
| |
| /* |
| * Semantic checks |
| */ |
| WARNING_IF_NOT_CELL(address_cells_is_cell, "#address-cells"); |
| WARNING_IF_NOT_CELL(size_cells_is_cell, "#size-cells"); |
| |
| WARNING_IF_NOT_STRING(device_type_is_string, "device_type"); |
| WARNING_IF_NOT_STRING(model_is_string, "model"); |
| WARNING_IF_NOT_STRING(status_is_string, "status"); |
| WARNING_IF_NOT_STRING(label_is_string, "label"); |
| |
| WARNING_IF_NOT_STRING_LIST(compatible_is_string_list, "compatible"); |
| |
| static void check_names_is_string_list(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| if (!strends(prop->name, "-names")) |
| continue; |
| |
| c->data = prop->name; |
| check_is_string_list(c, dti, node); |
| } |
| } |
| WARNING(names_is_string_list, check_names_is_string_list, NULL); |
| |
| static void check_alias_paths(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| if (!streq(node->name, "aliases")) |
| return; |
| |
| for_each_property(node, prop) { |
| if (streq(prop->name, "phandle") |
| || streq(prop->name, "linux,phandle")) { |
| continue; |
| } |
| |
| if (!prop->val.val || !get_node_by_path(dti->dt, prop->val.val)) { |
| FAIL_PROP(c, dti, node, prop, "aliases property is not a valid node (%s)", |
| prop->val.val); |
| continue; |
| } |
| if (strspn(prop->name, LOWERCASE DIGITS "-") != strlen(prop->name)) |
| FAIL(c, dti, node, "aliases property name must include only lowercase and '-'"); |
| } |
| } |
| WARNING(alias_paths, check_alias_paths, NULL); |
| |
| static void fixup_addr_size_cells(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| node->addr_cells = -1; |
| node->size_cells = -1; |
| |
| prop = get_property(node, "#address-cells"); |
| if (prop) |
| node->addr_cells = propval_cell(prop); |
| |
| prop = get_property(node, "#size-cells"); |
| if (prop) |
| node->size_cells = propval_cell(prop); |
| } |
| WARNING(addr_size_cells, fixup_addr_size_cells, NULL, |
| &address_cells_is_cell, &size_cells_is_cell); |
| |
| #define node_addr_cells(n) \ |
| (((n)->addr_cells == -1) ? 2 : (n)->addr_cells) |
| #define node_size_cells(n) \ |
| (((n)->size_cells == -1) ? 1 : (n)->size_cells) |
| |
| static void check_reg_format(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| int addr_cells, size_cells, entrylen; |
| |
| prop = get_property(node, "reg"); |
| if (!prop) |
| return; /* No "reg", that's fine */ |
| |
| if (!node->parent) { |
| FAIL(c, dti, node, "Root node has a \"reg\" property"); |
| return; |
| } |
| |
| if (prop->val.len == 0) |
| FAIL_PROP(c, dti, node, prop, "property is empty"); |
| |
| addr_cells = node_addr_cells(node->parent); |
| size_cells = node_size_cells(node->parent); |
| entrylen = (addr_cells + size_cells) * sizeof(cell_t); |
| |
| if (!is_multiple_of(prop->val.len, entrylen)) |
| FAIL_PROP(c, dti, node, prop, "property has invalid length (%d bytes) " |
| "(#address-cells == %d, #size-cells == %d)", |
| prop->val.len, addr_cells, size_cells); |
| } |
| WARNING(reg_format, check_reg_format, NULL, &addr_size_cells); |
| |
| static void check_ranges_format(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| int c_addr_cells, p_addr_cells, c_size_cells, p_size_cells, entrylen; |
| const char *ranges = c->data; |
| |
| prop = get_property(node, ranges); |
| if (!prop) |
| return; |
| |
| if (!node->parent) { |
| FAIL_PROP(c, dti, node, prop, "Root node has a \"%s\" property", |
| ranges); |
| return; |
| } |
| |
| p_addr_cells = node_addr_cells(node->parent); |
| p_size_cells = node_size_cells(node->parent); |
| c_addr_cells = node_addr_cells(node); |
| c_size_cells = node_size_cells(node); |
| entrylen = (p_addr_cells + c_addr_cells + c_size_cells) * sizeof(cell_t); |
| |
| if (prop->val.len == 0) { |
| if (p_addr_cells != c_addr_cells) |
| FAIL_PROP(c, dti, node, prop, "empty \"%s\" property but its " |
| "#address-cells (%d) differs from %s (%d)", |
| ranges, c_addr_cells, node->parent->fullpath, |
| p_addr_cells); |
| if (p_size_cells != c_size_cells) |
| FAIL_PROP(c, dti, node, prop, "empty \"%s\" property but its " |
| "#size-cells (%d) differs from %s (%d)", |
| ranges, c_size_cells, node->parent->fullpath, |
| p_size_cells); |
| } else if (!is_multiple_of(prop->val.len, entrylen)) { |
| FAIL_PROP(c, dti, node, prop, "\"%s\" property has invalid length (%d bytes) " |
| "(parent #address-cells == %d, child #address-cells == %d, " |
| "#size-cells == %d)", ranges, prop->val.len, |
| p_addr_cells, c_addr_cells, c_size_cells); |
| } |
| } |
| WARNING(ranges_format, check_ranges_format, "ranges", &addr_size_cells); |
| WARNING(dma_ranges_format, check_ranges_format, "dma-ranges", &addr_size_cells); |
| |
| static const struct bus_type pci_bus = { |
| .name = "PCI", |
| }; |
| |
| static void check_pci_bridge(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| cell_t *cells; |
| |
| prop = get_property(node, "device_type"); |
| if (!prop || !streq(prop->val.val, "pci")) |
| return; |
| |
| node->bus = &pci_bus; |
| |
| if (!strprefixeq(node->name, node->basenamelen, "pci") && |
| !strprefixeq(node->name, node->basenamelen, "pcie")) |
| FAIL(c, dti, node, "node name is not \"pci\" or \"pcie\""); |
| |
| prop = get_property(node, "ranges"); |
| if (!prop) |
| FAIL(c, dti, node, "missing ranges for PCI bridge (or not a bridge)"); |
| |
| if (node_addr_cells(node) != 3) |
| FAIL(c, dti, node, "incorrect #address-cells for PCI bridge"); |
| if (node_size_cells(node) != 2) |
| FAIL(c, dti, node, "incorrect #size-cells for PCI bridge"); |
| |
| prop = get_property(node, "bus-range"); |
| if (!prop) |
| return; |
| |
| if (prop->val.len != (sizeof(cell_t) * 2)) { |
| FAIL_PROP(c, dti, node, prop, "value must be 2 cells"); |
| return; |
| } |
| cells = (cell_t *)prop->val.val; |
| if (fdt32_to_cpu(cells[0]) > fdt32_to_cpu(cells[1])) |
| FAIL_PROP(c, dti, node, prop, "1st cell must be less than or equal to 2nd cell"); |
| if (fdt32_to_cpu(cells[1]) > 0xff) |
| FAIL_PROP(c, dti, node, prop, "maximum bus number must be less than 256"); |
| } |
| WARNING(pci_bridge, check_pci_bridge, NULL, |
| &device_type_is_string, &addr_size_cells); |
| |
| static void check_pci_device_bus_num(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| unsigned int bus_num, min_bus, max_bus; |
| cell_t *cells; |
| |
| if (!node->parent || (node->parent->bus != &pci_bus)) |
| return; |
| |
| prop = get_property(node, "reg"); |
| if (!prop) |
| return; |
| |
| cells = (cell_t *)prop->val.val; |
| bus_num = (fdt32_to_cpu(cells[0]) & 0x00ff0000) >> 16; |
| |
| prop = get_property(node->parent, "bus-range"); |
| if (!prop) { |
| min_bus = max_bus = 0; |
| } else { |
| cells = (cell_t *)prop->val.val; |
| min_bus = fdt32_to_cpu(cells[0]); |
| max_bus = fdt32_to_cpu(cells[1]); |
| } |
| if ((bus_num < min_bus) || (bus_num > max_bus)) |
| FAIL_PROP(c, dti, node, prop, "PCI bus number %d out of range, expected (%d - %d)", |
| bus_num, min_bus, max_bus); |
| } |
| WARNING(pci_device_bus_num, check_pci_device_bus_num, NULL, ®_format, &pci_bridge); |
| |
| static void check_pci_device_reg(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| const char *unitname = get_unitname(node); |
| char unit_addr[5]; |
| unsigned int dev, func, reg; |
| cell_t *cells; |
| |
| if (!node->parent || (node->parent->bus != &pci_bus)) |
| return; |
| |
| prop = get_property(node, "reg"); |
| if (!prop) |
| return; |
| |
| cells = (cell_t *)prop->val.val; |
| if (cells[1] || cells[2]) |
| FAIL_PROP(c, dti, node, prop, "PCI reg config space address cells 2 and 3 must be 0"); |
| |
| reg = fdt32_to_cpu(cells[0]); |
| dev = (reg & 0xf800) >> 11; |
| func = (reg & 0x700) >> 8; |
| |
| if (reg & 0xff000000) |
| FAIL_PROP(c, dti, node, prop, "PCI reg address is not configuration space"); |
| if (reg & 0x000000ff) |
| FAIL_PROP(c, dti, node, prop, "PCI reg config space address register number must be 0"); |
| |
| if (func == 0) { |
| snprintf(unit_addr, sizeof(unit_addr), "%x", dev); |
| if (streq(unitname, unit_addr)) |
| return; |
| } |
| |
| snprintf(unit_addr, sizeof(unit_addr), "%x,%x", dev, func); |
| if (streq(unitname, unit_addr)) |
| return; |
| |
| FAIL(c, dti, node, "PCI unit address format error, expected \"%s\"", |
| unit_addr); |
| } |
| WARNING(pci_device_reg, check_pci_device_reg, NULL, ®_format, &pci_bridge); |
| |
| static const struct bus_type simple_bus = { |
| .name = "simple-bus", |
| }; |
| |
| static bool node_is_compatible(struct node *node, const char *compat) |
| { |
| struct property *prop; |
| const char *str, *end; |
| |
| prop = get_property(node, "compatible"); |
| if (!prop) |
| return false; |
| |
| for (str = prop->val.val, end = str + prop->val.len; str < end; |
| str += strnlen(str, end - str) + 1) { |
| if (streq(str, compat)) |
| return true; |
| } |
| return false; |
| } |
| |
| static void check_simple_bus_bridge(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| if (node_is_compatible(node, "simple-bus")) |
| node->bus = &simple_bus; |
| } |
| WARNING(simple_bus_bridge, check_simple_bus_bridge, NULL, |
| &addr_size_cells, &compatible_is_string_list); |
| |
| static void check_simple_bus_reg(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| const char *unitname = get_unitname(node); |
| char unit_addr[17]; |
| unsigned int size; |
| uint64_t reg = 0; |
| cell_t *cells = NULL; |
| |
| if (!node->parent || (node->parent->bus != &simple_bus)) |
| return; |
| |
| prop = get_property(node, "reg"); |
| if (prop) |
| cells = (cell_t *)prop->val.val; |
| else { |
| prop = get_property(node, "ranges"); |
| if (prop && prop->val.len) |
| /* skip of child address */ |
| cells = ((cell_t *)prop->val.val) + node_addr_cells(node); |
| } |
| |
| if (!cells) { |
| if (node->parent->parent && !(node->bus == &simple_bus)) |
| FAIL(c, dti, node, "missing or empty reg/ranges property"); |
| return; |
| } |
| |
| size = node_addr_cells(node->parent); |
| while (size--) |
| reg = (reg << 32) | fdt32_to_cpu(*(cells++)); |
| |
| snprintf(unit_addr, sizeof(unit_addr), "%"PRIx64, reg); |
| if (!streq(unitname, unit_addr)) |
| FAIL(c, dti, node, "simple-bus unit address format error, expected \"%s\"", |
| unit_addr); |
| } |
| WARNING(simple_bus_reg, check_simple_bus_reg, NULL, ®_format, &simple_bus_bridge); |
| |
| static const struct bus_type i2c_bus = { |
| .name = "i2c-bus", |
| }; |
| |
| static void check_i2c_bus_bridge(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| if (strprefixeq(node->name, node->basenamelen, "i2c-bus") || |
| strprefixeq(node->name, node->basenamelen, "i2c-arb")) { |
| node->bus = &i2c_bus; |
| } else if (strprefixeq(node->name, node->basenamelen, "i2c")) { |
| struct node *child; |
| for_each_child(node, child) { |
| if (strprefixeq(child->name, node->basenamelen, "i2c-bus")) |
| return; |
| } |
| node->bus = &i2c_bus; |
| } else |
| return; |
| |
| if (!node->children) |
| return; |
| |
| if (node_addr_cells(node) != 1) |
| FAIL(c, dti, node, "incorrect #address-cells for I2C bus"); |
| if (node_size_cells(node) != 0) |
| FAIL(c, dti, node, "incorrect #size-cells for I2C bus"); |
| |
| } |
| WARNING(i2c_bus_bridge, check_i2c_bus_bridge, NULL, &addr_size_cells); |
| |
| #define I2C_OWN_SLAVE_ADDRESS (1U << 30) |
| #define I2C_TEN_BIT_ADDRESS (1U << 31) |
| |
| static void check_i2c_bus_reg(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| const char *unitname = get_unitname(node); |
| char unit_addr[17]; |
| uint32_t reg = 0; |
| int len; |
| cell_t *cells = NULL; |
| |
| if (!node->parent || (node->parent->bus != &i2c_bus)) |
| return; |
| |
| prop = get_property(node, "reg"); |
| if (prop) |
| cells = (cell_t *)prop->val.val; |
| |
| if (!cells) { |
| FAIL(c, dti, node, "missing or empty reg property"); |
| return; |
| } |
| |
| reg = fdt32_to_cpu(*cells); |
| /* Ignore I2C_OWN_SLAVE_ADDRESS */ |
| reg &= ~I2C_OWN_SLAVE_ADDRESS; |
| snprintf(unit_addr, sizeof(unit_addr), "%x", reg); |
| if (!streq(unitname, unit_addr)) |
| FAIL(c, dti, node, "I2C bus unit address format error, expected \"%s\"", |
| unit_addr); |
| |
| for (len = prop->val.len; len > 0; len -= 4) { |
| reg = fdt32_to_cpu(*(cells++)); |
| /* Ignore I2C_OWN_SLAVE_ADDRESS */ |
| reg &= ~I2C_OWN_SLAVE_ADDRESS; |
| |
| if ((reg & I2C_TEN_BIT_ADDRESS) && ((reg & ~I2C_TEN_BIT_ADDRESS) > 0x3ff)) |
| FAIL_PROP(c, dti, node, prop, "I2C address must be less than 10-bits, got \"0x%x\"", |
| reg); |
| else if (reg > 0x7f) |
| FAIL_PROP(c, dti, node, prop, "I2C address must be less than 7-bits, got \"0x%x\". Set I2C_TEN_BIT_ADDRESS for 10 bit addresses or fix the property", |
| reg); |
| } |
| } |
| WARNING(i2c_bus_reg, check_i2c_bus_reg, NULL, ®_format, &i2c_bus_bridge); |
| |
| static const struct bus_type spi_bus = { |
| .name = "spi-bus", |
| }; |
| |
| static void check_spi_bus_bridge(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| int spi_addr_cells = 1; |
| |
| if (strprefixeq(node->name, node->basenamelen, "spi")) { |
| node->bus = &spi_bus; |
| } else { |
| /* Try to detect SPI buses which don't have proper node name */ |
| struct node *child; |
| |
| if (node_addr_cells(node) != 1 || node_size_cells(node) != 0) |
| return; |
| |
| for_each_child(node, child) { |
| struct property *prop; |
| for_each_property(child, prop) { |
| if (strprefixeq(prop->name, 4, "spi-")) { |
| node->bus = &spi_bus; |
| break; |
| } |
| } |
| if (node->bus == &spi_bus) |
| break; |
| } |
| |
| if (node->bus == &spi_bus && get_property(node, "reg")) |
| FAIL(c, dti, node, "node name for SPI buses should be 'spi'"); |
| } |
| if (node->bus != &spi_bus || !node->children) |
| return; |
| |
| if (get_property(node, "spi-slave")) |
| spi_addr_cells = 0; |
| if (node_addr_cells(node) != spi_addr_cells) |
| FAIL(c, dti, node, "incorrect #address-cells for SPI bus"); |
| if (node_size_cells(node) != 0) |
| FAIL(c, dti, node, "incorrect #size-cells for SPI bus"); |
| |
| } |
| WARNING(spi_bus_bridge, check_spi_bus_bridge, NULL, &addr_size_cells); |
| |
| static void check_spi_bus_reg(struct check *c, struct dt_info *dti, struct node *node) |
| { |
| struct property *prop; |
| const char *unitname = get_unitname(node); |
| char unit_addr[9]; |
| uint32_t reg = 0; |
| cell_t *cells = NULL; |
| |
| if (!node->parent || (node->parent->bus != &spi_bus)) |
| return; |
| |
| if (get_property(node->parent, "spi-slave")) |
| return; |
| |
| prop = get_property(node, "reg"); |
| if (prop) |
| cells = (cell_t *)prop->val.val; |
| |
| if (!cells) { |
| FAIL(c, dti, node, "missing or empty reg property"); |
| return; |
| } |
| |
| reg = fdt32_to_cpu(*cells); |
| snprintf(unit_addr, sizeof(unit_addr), "%x", reg); |
| if (!streq(unitname, unit_addr)) |
| FAIL(c, dti, node, "SPI bus unit address format error, expected \"%s\"", |
| unit_addr); |
| } |
| WARNING(spi_bus_reg, check_spi_bus_reg, NULL, ®_format, &spi_bus_bridge); |
| |
| static void check_unit_address_format(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| const char *unitname = get_unitname(node); |
| |
| if (node->parent && node->parent->bus) |
| return; |
| |
| if (!unitname[0]) |
| return; |
| |
| if (!strncmp(unitname, "0x", 2)) { |
| FAIL(c, dti, node, "unit name should not have leading \"0x\""); |
| /* skip over 0x for next test */ |
| unitname += 2; |
| } |
| if (unitname[0] == '0' && isxdigit(unitname[1])) |
| FAIL(c, dti, node, "unit name should not have leading 0s"); |
| } |
| WARNING(unit_address_format, check_unit_address_format, NULL, |
| &node_name_format, &pci_bridge, &simple_bus_bridge); |
| |
| /* |
| * Style checks |
| */ |
| static void check_avoid_default_addr_size(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *reg, *ranges; |
| |
| if (!node->parent) |
| return; /* Ignore root node */ |
| |
| reg = get_property(node, "reg"); |
| ranges = get_property(node, "ranges"); |
| |
| if (!reg && !ranges) |
| return; |
| |
| if (node->parent->addr_cells == -1) |
| FAIL(c, dti, node, "Relying on default #address-cells value"); |
| |
| if (node->parent->size_cells == -1) |
| FAIL(c, dti, node, "Relying on default #size-cells value"); |
| } |
| WARNING(avoid_default_addr_size, check_avoid_default_addr_size, NULL, |
| &addr_size_cells); |
| |
| static void check_avoid_unnecessary_addr_size(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| struct node *child; |
| bool has_reg = false; |
| |
| if (!node->parent || node->addr_cells < 0 || node->size_cells < 0) |
| return; |
| |
| if (get_property(node, "ranges") || !node->children) |
| return; |
| |
| for_each_child(node, child) { |
| prop = get_property(child, "reg"); |
| if (prop) |
| has_reg = true; |
| } |
| |
| if (!has_reg) |
| FAIL(c, dti, node, "unnecessary #address-cells/#size-cells without \"ranges\" or child \"reg\" property"); |
| } |
| WARNING(avoid_unnecessary_addr_size, check_avoid_unnecessary_addr_size, NULL, &avoid_default_addr_size); |
| |
| static bool node_is_disabled(struct node *node) |
| { |
| struct property *prop; |
| |
| prop = get_property(node, "status"); |
| if (prop) { |
| char *str = prop->val.val; |
| if (streq("disabled", str)) |
| return true; |
| } |
| |
| return false; |
| } |
| |
| static void check_unique_unit_address_common(struct check *c, |
| struct dt_info *dti, |
| struct node *node, |
| bool disable_check) |
| { |
| struct node *childa; |
| |
| if (node->addr_cells < 0 || node->size_cells < 0) |
| return; |
| |
| if (!node->children) |
| return; |
| |
| for_each_child(node, childa) { |
| struct node *childb; |
| const char *addr_a = get_unitname(childa); |
| |
| if (!strlen(addr_a)) |
| continue; |
| |
| if (disable_check && node_is_disabled(childa)) |
| continue; |
| |
| for_each_child(node, childb) { |
| const char *addr_b = get_unitname(childb); |
| if (childa == childb) |
| break; |
| |
| if (disable_check && node_is_disabled(childb)) |
| continue; |
| |
| if (streq(addr_a, addr_b)) |
| FAIL(c, dti, childb, "duplicate unit-address (also used in node %s)", childa->fullpath); |
| } |
| } |
| } |
| |
| static void check_unique_unit_address(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| check_unique_unit_address_common(c, dti, node, false); |
| } |
| WARNING(unique_unit_address, check_unique_unit_address, NULL, &avoid_default_addr_size); |
| |
| static void check_unique_unit_address_if_enabled(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| check_unique_unit_address_common(c, dti, node, true); |
| } |
| CHECK_ENTRY(unique_unit_address_if_enabled, check_unique_unit_address_if_enabled, |
| NULL, false, false, &avoid_default_addr_size); |
| |
| static void check_obsolete_chosen_interrupt_controller(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *dt = dti->dt; |
| struct node *chosen; |
| struct property *prop; |
| |
| if (node != dt) |
| return; |
| |
| |
| chosen = get_node_by_path(dt, "/chosen"); |
| if (!chosen) |
| return; |
| |
| prop = get_property(chosen, "interrupt-controller"); |
| if (prop) |
| FAIL_PROP(c, dti, node, prop, |
| "/chosen has obsolete \"interrupt-controller\" property"); |
| } |
| WARNING(obsolete_chosen_interrupt_controller, |
| check_obsolete_chosen_interrupt_controller, NULL); |
| |
| static void check_chosen_node_is_root(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| if (!streq(node->name, "chosen")) |
| return; |
| |
| if (node->parent != dti->dt) |
| FAIL(c, dti, node, "chosen node must be at root node"); |
| } |
| WARNING(chosen_node_is_root, check_chosen_node_is_root, NULL); |
| |
| static void check_chosen_node_bootargs(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| if (!streq(node->name, "chosen")) |
| return; |
| |
| prop = get_property(node, "bootargs"); |
| if (!prop) |
| return; |
| |
| c->data = prop->name; |
| check_is_string(c, dti, node); |
| } |
| WARNING(chosen_node_bootargs, check_chosen_node_bootargs, NULL); |
| |
| static void check_chosen_node_stdout_path(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| if (!streq(node->name, "chosen")) |
| return; |
| |
| prop = get_property(node, "stdout-path"); |
| if (!prop) { |
| prop = get_property(node, "linux,stdout-path"); |
| if (!prop) |
| return; |
| FAIL_PROP(c, dti, node, prop, "Use 'stdout-path' instead"); |
| } |
| |
| c->data = prop->name; |
| check_is_string(c, dti, node); |
| } |
| WARNING(chosen_node_stdout_path, check_chosen_node_stdout_path, NULL); |
| |
| struct provider { |
| const char *prop_name; |
| const char *cell_name; |
| bool optional; |
| }; |
| |
| static void check_property_phandle_args(struct check *c, |
| struct dt_info *dti, |
| struct node *node, |
| struct property *prop, |
| const struct provider *provider) |
| { |
| struct node *root = dti->dt; |
| unsigned int cell, cellsize = 0; |
| |
| if (!is_multiple_of(prop->val.len, sizeof(cell_t))) { |
| FAIL_PROP(c, dti, node, prop, |
| "property size (%d) is invalid, expected multiple of %zu", |
| prop->val.len, sizeof(cell_t)); |
| return; |
| } |
| |
| for (cell = 0; cell < prop->val.len / sizeof(cell_t); cell += cellsize + 1) { |
| struct node *provider_node; |
| struct property *cellprop; |
| cell_t phandle; |
| |
| phandle = propval_cell_n(prop, cell); |
| /* |
| * Some bindings use a cell value 0 or -1 to skip over optional |
| * entries when each index position has a specific definition. |
| */ |
| if (!phandle_is_valid(phandle)) { |
| /* Give up if this is an overlay with external references */ |
| if (dti->dtsflags & DTSF_PLUGIN) |
| break; |
| |
| cellsize = 0; |
| continue; |
| } |
| |
| /* If we have markers, verify the current cell is a phandle */ |
| if (prop->val.markers) { |
| struct marker *m = prop->val.markers; |
| for_each_marker_of_type(m, REF_PHANDLE) { |
| if (m->offset == (cell * sizeof(cell_t))) |
| break; |
| } |
| if (!m) |
| FAIL_PROP(c, dti, node, prop, |
| "cell %d is not a phandle reference", |
| cell); |
| } |
| |
| provider_node = get_node_by_phandle(root, phandle); |
| if (!provider_node) { |
| FAIL_PROP(c, dti, node, prop, |
| "Could not get phandle node for (cell %d)", |
| cell); |
| break; |
| } |
| |
| cellprop = get_property(provider_node, provider->cell_name); |
| if (cellprop) { |
| cellsize = propval_cell(cellprop); |
| } else if (provider->optional) { |
| cellsize = 0; |
| } else { |
| FAIL(c, dti, node, "Missing property '%s' in node %s or bad phandle (referred from %s[%d])", |
| provider->cell_name, |
| provider_node->fullpath, |
| prop->name, cell); |
| break; |
| } |
| |
| if (prop->val.len < ((cell + cellsize + 1) * sizeof(cell_t))) { |
| FAIL_PROP(c, dti, node, prop, |
| "property size (%d) too small for cell size %d", |
| prop->val.len, cellsize); |
| } |
| } |
| } |
| |
| static void check_provider_cells_property(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct provider *provider = c->data; |
| struct property *prop; |
| |
| prop = get_property(node, provider->prop_name); |
| if (!prop) |
| return; |
| |
| check_property_phandle_args(c, dti, node, prop, provider); |
| } |
| #define WARNING_PROPERTY_PHANDLE_CELLS(nm, propname, cells_name, ...) \ |
| static struct provider nm##_provider = { (propname), (cells_name), __VA_ARGS__ }; \ |
| WARNING_IF_NOT_CELL(nm##_is_cell, cells_name); \ |
| WARNING(nm##_property, check_provider_cells_property, &nm##_provider, &nm##_is_cell, &phandle_references); |
| |
| WARNING_PROPERTY_PHANDLE_CELLS(clocks, "clocks", "#clock-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(cooling_device, "cooling-device", "#cooling-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(dmas, "dmas", "#dma-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(hwlocks, "hwlocks", "#hwlock-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(interrupts_extended, "interrupts-extended", "#interrupt-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(io_channels, "io-channels", "#io-channel-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(iommus, "iommus", "#iommu-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(mboxes, "mboxes", "#mbox-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(msi_parent, "msi-parent", "#msi-cells", true); |
| WARNING_PROPERTY_PHANDLE_CELLS(mux_controls, "mux-controls", "#mux-control-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(phys, "phys", "#phy-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(power_domains, "power-domains", "#power-domain-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(pwms, "pwms", "#pwm-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(resets, "resets", "#reset-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(sound_dai, "sound-dai", "#sound-dai-cells"); |
| WARNING_PROPERTY_PHANDLE_CELLS(thermal_sensors, "thermal-sensors", "#thermal-sensor-cells"); |
| |
| static bool prop_is_gpio(struct property *prop) |
| { |
| /* |
| * *-gpios and *-gpio can appear in property names, |
| * so skip over any false matches (only one known ATM) |
| */ |
| if (strends(prop->name, ",nr-gpios")) |
| return false; |
| |
| return strends(prop->name, "-gpios") || |
| streq(prop->name, "gpios") || |
| strends(prop->name, "-gpio") || |
| streq(prop->name, "gpio"); |
| } |
| |
| static void check_gpios_property(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| /* Skip GPIO hog nodes which have 'gpios' property */ |
| if (get_property(node, "gpio-hog")) |
| return; |
| |
| for_each_property(node, prop) { |
| struct provider provider; |
| |
| if (!prop_is_gpio(prop)) |
| continue; |
| |
| provider.prop_name = prop->name; |
| provider.cell_name = "#gpio-cells"; |
| provider.optional = false; |
| check_property_phandle_args(c, dti, node, prop, &provider); |
| } |
| |
| } |
| WARNING(gpios_property, check_gpios_property, NULL, &phandle_references); |
| |
| static void check_deprecated_gpio_property(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| |
| for_each_property(node, prop) { |
| if (!prop_is_gpio(prop)) |
| continue; |
| |
| if (!strends(prop->name, "gpio")) |
| continue; |
| |
| FAIL_PROP(c, dti, node, prop, |
| "'[*-]gpio' is deprecated, use '[*-]gpios' instead"); |
| } |
| |
| } |
| CHECK(deprecated_gpio_property, check_deprecated_gpio_property, NULL); |
| |
| static bool node_is_interrupt_provider(struct node *node) |
| { |
| struct property *prop; |
| |
| prop = get_property(node, "interrupt-controller"); |
| if (prop) |
| return true; |
| |
| prop = get_property(node, "interrupt-map"); |
| if (prop) |
| return true; |
| |
| return false; |
| } |
| |
| static void check_interrupt_provider(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct property *prop; |
| bool irq_provider = node_is_interrupt_provider(node); |
| |
| prop = get_property(node, "#interrupt-cells"); |
| if (irq_provider && !prop) { |
| FAIL(c, dti, node, |
| "Missing '#interrupt-cells' in interrupt provider"); |
| return; |
| } |
| |
| if (!irq_provider && prop) { |
| FAIL(c, dti, node, |
| "'#interrupt-cells' found, but node is not an interrupt provider"); |
| return; |
| } |
| } |
| WARNING(interrupt_provider, check_interrupt_provider, NULL, &interrupts_extended_is_cell); |
| |
| static void check_interrupt_map(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *root = dti->dt; |
| struct property *prop, *irq_map_prop; |
| size_t cellsize, cell, map_cells; |
| |
| irq_map_prop = get_property(node, "interrupt-map"); |
| if (!irq_map_prop) |
| return; |
| |
| if (node->addr_cells < 0) { |
| FAIL(c, dti, node, |
| "Missing '#address-cells' in interrupt-map provider"); |
| return; |
| } |
| cellsize = node_addr_cells(node); |
| cellsize += propval_cell(get_property(node, "#interrupt-cells")); |
| |
| prop = get_property(node, "interrupt-map-mask"); |
| if (prop && (prop->val.len != (cellsize * sizeof(cell_t)))) |
| FAIL_PROP(c, dti, node, prop, |
| "property size (%d) is invalid, expected %zu", |
| prop->val.len, cellsize * sizeof(cell_t)); |
| |
| if (!is_multiple_of(irq_map_prop->val.len, sizeof(cell_t))) { |
| FAIL_PROP(c, dti, node, irq_map_prop, |
| "property size (%d) is invalid, expected multiple of %zu", |
| irq_map_prop->val.len, sizeof(cell_t)); |
| return; |
| } |
| |
| map_cells = irq_map_prop->val.len / sizeof(cell_t); |
| for (cell = 0; cell < map_cells; ) { |
| struct node *provider_node; |
| struct property *cellprop; |
| int phandle; |
| size_t parent_cellsize; |
| |
| if ((cell + cellsize) >= map_cells) { |
| FAIL_PROP(c, dti, node, irq_map_prop, |
| "property size (%d) too small, expected > %zu", |
| irq_map_prop->val.len, (cell + cellsize) * sizeof(cell_t)); |
| break; |
| } |
| cell += cellsize; |
| |
| phandle = propval_cell_n(irq_map_prop, cell); |
| if (!phandle_is_valid(phandle)) { |
| /* Give up if this is an overlay with external references */ |
| if (!(dti->dtsflags & DTSF_PLUGIN)) |
| FAIL_PROP(c, dti, node, irq_map_prop, |
| "Cell %zu is not a phandle(%d)", |
| cell, phandle); |
| break; |
| } |
| |
| provider_node = get_node_by_phandle(root, phandle); |
| if (!provider_node) { |
| FAIL_PROP(c, dti, node, irq_map_prop, |
| "Could not get phandle(%d) node for (cell %zu)", |
| phandle, cell); |
| break; |
| } |
| |
| cellprop = get_property(provider_node, "#interrupt-cells"); |
| if (cellprop) { |
| parent_cellsize = propval_cell(cellprop); |
| } else { |
| FAIL(c, dti, node, "Missing property '#interrupt-cells' in node %s or bad phandle (referred from interrupt-map[%zu])", |
| provider_node->fullpath, cell); |
| break; |
| } |
| |
| cellprop = get_property(provider_node, "#address-cells"); |
| if (cellprop) |
| parent_cellsize += propval_cell(cellprop); |
| |
| cell += 1 + parent_cellsize; |
| } |
| } |
| WARNING(interrupt_map, check_interrupt_map, NULL, &phandle_references, &addr_size_cells, &interrupt_provider); |
| |
| static void check_interrupts_property(struct check *c, |
| struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *root = dti->dt; |
| struct node *irq_node = NULL, *parent = node; |
| struct property *irq_prop, *prop = NULL; |
| cell_t irq_cells, phandle; |
| |
| irq_prop = get_property(node, "interrupts"); |
| if (!irq_prop) |
| return; |
| |
| if (!is_multiple_of(irq_prop->val.len, sizeof(cell_t))) |
| FAIL_PROP(c, dti, node, irq_prop, "size (%d) is invalid, expected multiple of %zu", |
| irq_prop->val.len, sizeof(cell_t)); |
| |
| while (parent && !prop) { |
| if (parent != node && node_is_interrupt_provider(parent)) { |
| irq_node = parent; |
| break; |
| } |
| |
| prop = get_property(parent, "interrupt-parent"); |
| if (prop) { |
| phandle = propval_cell(prop); |
| if (!phandle_is_valid(phandle)) { |
| /* Give up if this is an overlay with |
| * external references */ |
| if (dti->dtsflags & DTSF_PLUGIN) |
| return; |
| FAIL_PROP(c, dti, parent, prop, "Invalid phandle"); |
| continue; |
| } |
| |
| irq_node = get_node_by_phandle(root, phandle); |
| if (!irq_node) { |
| FAIL_PROP(c, dti, parent, prop, "Bad phandle"); |
| return; |
| } |
| if (!node_is_interrupt_provider(irq_node)) |
| FAIL(c, dti, irq_node, |
| "Missing interrupt-controller or interrupt-map property"); |
| |
| break; |
| } |
| |
| parent = parent->parent; |
| } |
| |
| if (!irq_node) { |
| FAIL(c, dti, node, "Missing interrupt-parent"); |
| return; |
| } |
| |
| prop = get_property(irq_node, "#interrupt-cells"); |
| if (!prop) { |
| /* We warn about that already in another test. */ |
| return; |
| } |
| |
| irq_cells = propval_cell(prop); |
| if (!is_multiple_of(irq_prop->val.len, irq_cells * sizeof(cell_t))) { |
| FAIL_PROP(c, dti, node, prop, |
| "size is (%d), expected multiple of %d", |
| irq_prop->val.len, (int)(irq_cells * sizeof(cell_t))); |
| } |
| } |
| WARNING(interrupts_property, check_interrupts_property, &phandle_references); |
| |
| static const struct bus_type graph_port_bus = { |
| .name = "graph-port", |
| }; |
| |
| static const struct bus_type graph_ports_bus = { |
| .name = "graph-ports", |
| }; |
| |
| static void check_graph_nodes(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *child; |
| |
| for_each_child(node, child) { |
| if (!(strprefixeq(child->name, child->basenamelen, "endpoint") || |
| get_property(child, "remote-endpoint"))) |
| continue; |
| |
| node->bus = &graph_port_bus; |
| |
| /* The parent of 'port' nodes can be either 'ports' or a device */ |
| if (!node->parent->bus && |
| (streq(node->parent->name, "ports") || get_property(node, "reg"))) |
| node->parent->bus = &graph_ports_bus; |
| |
| break; |
| } |
| |
| } |
| WARNING(graph_nodes, check_graph_nodes, NULL); |
| |
| static void check_graph_child_address(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| int cnt = 0; |
| struct node *child; |
| |
| if (node->bus != &graph_ports_bus && node->bus != &graph_port_bus) |
| return; |
| |
| for_each_child(node, child) { |
| struct property *prop = get_property(child, "reg"); |
| |
| /* No error if we have any non-zero unit address */ |
| if (prop && propval_cell(prop) != 0) |
| return; |
| |
| cnt++; |
| } |
| |
| if (cnt == 1 && node->addr_cells != -1) |
| FAIL(c, dti, node, "graph node has single child node '%s', #address-cells/#size-cells are not necessary", |
| node->children->name); |
| } |
| WARNING(graph_child_address, check_graph_child_address, NULL, &graph_nodes); |
| |
| static void check_graph_reg(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| char unit_addr[9]; |
| const char *unitname = get_unitname(node); |
| struct property *prop; |
| |
| prop = get_property(node, "reg"); |
| if (!prop || !unitname) |
| return; |
| |
| if (!(prop->val.val && prop->val.len == sizeof(cell_t))) { |
| FAIL(c, dti, node, "graph node malformed 'reg' property"); |
| return; |
| } |
| |
| snprintf(unit_addr, sizeof(unit_addr), "%x", propval_cell(prop)); |
| if (!streq(unitname, unit_addr)) |
| FAIL(c, dti, node, "graph node unit address error, expected \"%s\"", |
| unit_addr); |
| |
| if (node->parent->addr_cells != 1) |
| FAIL_PROP(c, dti, node, get_property(node, "#address-cells"), |
| "graph node '#address-cells' is %d, must be 1", |
| node->parent->addr_cells); |
| if (node->parent->size_cells != 0) |
| FAIL_PROP(c, dti, node, get_property(node, "#size-cells"), |
| "graph node '#size-cells' is %d, must be 0", |
| node->parent->size_cells); |
| } |
| |
| static void check_graph_port(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| if (node->bus != &graph_port_bus) |
| return; |
| |
| if (!strprefixeq(node->name, node->basenamelen, "port")) |
| FAIL(c, dti, node, "graph port node name should be 'port'"); |
| |
| check_graph_reg(c, dti, node); |
| } |
| WARNING(graph_port, check_graph_port, NULL, &graph_nodes); |
| |
| static struct node *get_remote_endpoint(struct check *c, struct dt_info *dti, |
| struct node *endpoint) |
| { |
| cell_t phandle; |
| struct node *node; |
| struct property *prop; |
| |
| prop = get_property(endpoint, "remote-endpoint"); |
| if (!prop) |
| return NULL; |
| |
| phandle = propval_cell(prop); |
| /* Give up if this is an overlay with external references */ |
| if (!phandle_is_valid(phandle)) |
| return NULL; |
| |
| node = get_node_by_phandle(dti->dt, phandle); |
| if (!node) |
| FAIL_PROP(c, dti, endpoint, prop, "graph phandle is not valid"); |
| |
| return node; |
| } |
| |
| static void check_graph_endpoint(struct check *c, struct dt_info *dti, |
| struct node *node) |
| { |
| struct node *remote_node; |
| |
| if (!node->parent || node->parent->bus != &graph_port_bus) |
| return; |
| |
| if (!strprefixeq(node->name, node->basenamelen, "endpoint")) |
| FAIL(c, dti, node, "graph endpoint node name should be 'endpoint'"); |
| |
| check_graph_reg(c, dti, node); |
| |
| remote_node = get_remote_endpoint(c, dti, node); |
| if (!remote_node) |
| return; |
| |
| if (get_remote_endpoint(c, dti, remote_node) != node) |
| FAIL(c, dti, node, "graph connection to node '%s' is not bidirectional", |
| remote_node->fullpath); |
| } |
| WARNING(graph_endpoint, check_graph_endpoint, NULL, &graph_nodes); |
| |
| static struct check *check_table[] = { |
| &duplicate_node_names, &duplicate_property_names, |
| &node_name_chars, &node_name_format, &property_name_chars, |
| &name_is_string, &name_properties, &node_name_vs_property_name, |
| |
| &duplicate_label, |
| |
| &explicit_phandles, |
| &phandle_references, &path_references, |
| &omit_unused_nodes, |
| |
| &address_cells_is_cell, &size_cells_is_cell, |
| &device_type_is_string, &model_is_string, &status_is_string, |
| &label_is_string, |
| |
| &compatible_is_string_list, &names_is_string_list, |
| |
| &property_name_chars_strict, |
| &node_name_chars_strict, |
| |
| &addr_size_cells, ®_format, &ranges_format, &dma_ranges_format, |
| |
| &unit_address_vs_reg, |
| &unit_address_format, |
| |
| &pci_bridge, |
| &pci_device_reg, |
| &pci_device_bus_num, |
| |
| &simple_bus_bridge, |
| &simple_bus_reg, |
| |
| &i2c_bus_bridge, |
| &i2c_bus_reg, |
| |
| &spi_bus_bridge, |
| &spi_bus_reg, |
| |
| &avoid_default_addr_size, |
| &avoid_unnecessary_addr_size, |
| &unique_unit_address, |
| &unique_unit_address_if_enabled, |
| &obsolete_chosen_interrupt_controller, |
| &chosen_node_is_root, &chosen_node_bootargs, &chosen_node_stdout_path, |
| |
| &clocks_property, |
| &clocks_is_cell, |
| &cooling_device_property, |
| &cooling_device_is_cell, |
| &dmas_property, |
| &dmas_is_cell, |
| &hwlocks_property, |
| &hwlocks_is_cell, |
| &interrupts_extended_property, |
| &interrupts_extended_is_cell, |
| &io_channels_property, |
| &io_channels_is_cell, |
| &iommus_property, |
| &iommus_is_cell, |
| &mboxes_property, |
| &mboxes_is_cell, |
| &msi_parent_property, |
| &msi_parent_is_cell, |
| &mux_controls_property, |
| &mux_controls_is_cell, |
| &phys_property, |
| &phys_is_cell, |
| &power_domains_property, |
| &power_domains_is_cell, |
| &pwms_property, |
| &pwms_is_cell, |
| &resets_property, |
| &resets_is_cell, |
| &sound_dai_property, |
| &sound_dai_is_cell, |
| &thermal_sensors_property, |
| &thermal_sensors_is_cell, |
| |
| &deprecated_gpio_property, |
| &gpios_property, |
| &interrupts_property, |
| &interrupt_provider, |
| &interrupt_map, |
| |
| &alias_paths, |
| |
| &graph_nodes, &graph_child_address, &graph_port, &graph_endpoint, |
| |
| &always_fail, |
| }; |
| |
| static void enable_warning_error(struct check *c, bool warn, bool error) |
| { |
| int i; |
| |
| /* Raising level, also raise it for prereqs */ |
| if ((warn && !c->warn) || (error && !c->error)) |
| for (i = 0; i < c->num_prereqs; i++) |
| enable_warning_error(c->prereq[i], warn, error); |
| |
| c->warn = c->warn || warn; |
| c->error = c->error || error; |
| } |
| |
| static void disable_warning_error(struct check *c, bool warn, bool error) |
| { |
| unsigned int i; |
| |
| /* Lowering level, also lower it for things this is the prereq |
| * for */ |
| if ((warn && c->warn) || (error && c->error)) { |
| for (i = 0; i < ARRAY_SIZE(check_table); i++) { |
| struct check *cc = check_table[i]; |
| int j; |
| |
| for (j = 0; j < cc->num_prereqs; j++) |
| if (cc->prereq[j] == c) |
| disable_warning_error(cc, warn, error); |
| } |
| } |
| |
| c->warn = c->warn && !warn; |
| c->error = c->error && !error; |
| } |
| |
| void parse_checks_option(bool warn, bool error, const char *arg) |
| { |
| unsigned int i; |
| const char *name = arg; |
| bool enable = true; |
| |
| if ((strncmp(arg, "no-", 3) == 0) |
| || (strncmp(arg, "no_", 3) == 0)) { |
| name = arg + 3; |
| enable = false; |
| } |
| |
| for (i = 0; i < ARRAY_SIZE(check_table); i++) { |
| struct check *c = check_table[i]; |
| |
| if (streq(c->name, name)) { |
| if (enable) |
| enable_warning_error(c, warn, error); |
| else |
| disable_warning_error(c, warn, error); |
| return; |
| } |
| } |
| |
| die("Unrecognized check name \"%s\"\n", name); |
| } |
| |
| void process_checks(bool force, struct dt_info *dti) |
| { |
| unsigned int i; |
| int error = 0; |
| |
| for (i = 0; i < ARRAY_SIZE(check_table); i++) { |
| struct check *c = check_table[i]; |
| |
| if (c->warn || c->error) |
| error = error || run_check(c, dti); |
| } |
| |
| if (error) { |
| if (!force) { |
| fprintf(stderr, "ERROR: Input tree has errors, aborting " |
| "(use -f to force output)\n"); |
| exit(2); |
| } else if (quiet < 3) { |
| fprintf(stderr, "Warning: Input tree has errors, " |
| "output forced\n"); |
| } |
| } |
| } |