5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 #define TRACE(c, ...) \
26 fprintf(stderr, "=== %s: ", (c)->name); \
27 fprintf(stderr, __VA_ARGS__); \
28 fprintf(stderr, "\n"); \
31 #define TRACE(c, fmt, ...) do { } while (0)
43 typedef void (*check_fn)(struct check *c, struct dt_info *dti, struct node *node);
50 enum checkstatus status;
53 struct check **prereq;
56 #define CHECK_ENTRY(nm_, fn_, d_, w_, e_, ...) \
57 static struct check *nm_##_prereqs[] = { __VA_ARGS__ }; \
58 static struct check nm_ = { \
64 .status = UNCHECKED, \
65 .num_prereqs = ARRAY_SIZE(nm_##_prereqs), \
66 .prereq = nm_##_prereqs, \
68 #define WARNING(nm_, fn_, d_, ...) \
69 CHECK_ENTRY(nm_, fn_, d_, true, false, __VA_ARGS__)
70 #define ERROR(nm_, fn_, d_, ...) \
71 CHECK_ENTRY(nm_, fn_, d_, false, true, __VA_ARGS__)
72 #define CHECK(nm_, fn_, d_, ...) \
73 CHECK_ENTRY(nm_, fn_, d_, false, false, __VA_ARGS__)
75 static inline void PRINTF(5, 6) check_msg(struct check *c, struct dt_info *dti,
77 struct property *prop,
83 if ((c->warn && (quiet < 1))
84 || (c->error && (quiet < 2))) {
85 fprintf(stderr, "%s: %s (%s): ",
86 strcmp(dti->outname, "-") ? dti->outname : "<stdout>",
87 (c->error) ? "ERROR" : "Warning", c->name);
89 fprintf(stderr, "%s", node->fullpath);
91 fprintf(stderr, ":%s", prop->name);
94 vfprintf(stderr, fmt, ap);
95 fprintf(stderr, "\n");
100 #define FAIL(c, dti, node, ...) \
102 TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__); \
103 (c)->status = FAILED; \
104 check_msg((c), dti, node, NULL, __VA_ARGS__); \
107 #define FAIL_PROP(c, dti, node, prop, ...) \
109 TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__); \
110 (c)->status = FAILED; \
111 check_msg((c), dti, node, prop, __VA_ARGS__); \
115 static void check_nodes_props(struct check *c, struct dt_info *dti, struct node *node)
119 TRACE(c, "%s", node->fullpath);
123 for_each_child(node, child)
124 check_nodes_props(c, dti, child);
127 static bool run_check(struct check *c, struct dt_info *dti)
129 struct node *dt = dti->dt;
133 assert(!c->inprogress);
135 if (c->status != UNCHECKED)
138 c->inprogress = true;
140 for (i = 0; i < c->num_prereqs; i++) {
141 struct check *prq = c->prereq[i];
142 error = error || run_check(prq, dti);
143 if (prq->status != PASSED) {
145 check_msg(c, dti, NULL, NULL, "Failed prerequisite '%s'",
150 if (c->status != UNCHECKED)
153 check_nodes_props(c, dti, dt);
155 if (c->status == UNCHECKED)
158 TRACE(c, "\tCompleted, status %d", c->status);
161 c->inprogress = false;
162 if ((c->status != PASSED) && (c->error))
168 * Utility check functions
171 /* A check which always fails, for testing purposes only */
172 static inline void check_always_fail(struct check *c, struct dt_info *dti,
175 FAIL(c, dti, node, "always_fail check");
177 CHECK(always_fail, check_always_fail, NULL);
179 static void check_is_string(struct check *c, struct dt_info *dti,
182 struct property *prop;
183 char *propname = c->data;
185 prop = get_property(node, propname);
187 return; /* Not present, assumed ok */
189 if (!data_is_one_string(prop->val))
190 FAIL_PROP(c, dti, node, prop, "property is not a string");
192 #define WARNING_IF_NOT_STRING(nm, propname) \
193 WARNING(nm, check_is_string, (propname))
194 #define ERROR_IF_NOT_STRING(nm, propname) \
195 ERROR(nm, check_is_string, (propname))
197 static void check_is_string_list(struct check *c, struct dt_info *dti,
201 struct property *prop;
202 char *propname = c->data;
205 prop = get_property(node, propname);
207 return; /* Not present, assumed ok */
212 l = strnlen(str, rem);
214 FAIL_PROP(c, dti, node, prop, "property is not a string list");
221 #define WARNING_IF_NOT_STRING_LIST(nm, propname) \
222 WARNING(nm, check_is_string_list, (propname))
223 #define ERROR_IF_NOT_STRING_LIST(nm, propname) \
224 ERROR(nm, check_is_string_list, (propname))
226 static void check_is_cell(struct check *c, struct dt_info *dti,
229 struct property *prop;
230 char *propname = c->data;
232 prop = get_property(node, propname);
234 return; /* Not present, assumed ok */
236 if (prop->val.len != sizeof(cell_t))
237 FAIL_PROP(c, dti, node, prop, "property is not a single cell");
239 #define WARNING_IF_NOT_CELL(nm, propname) \
240 WARNING(nm, check_is_cell, (propname))
241 #define ERROR_IF_NOT_CELL(nm, propname) \
242 ERROR(nm, check_is_cell, (propname))
245 * Structural check functions
248 static void check_duplicate_node_names(struct check *c, struct dt_info *dti,
251 struct node *child, *child2;
253 for_each_child(node, child)
254 for (child2 = child->next_sibling;
256 child2 = child2->next_sibling)
257 if (streq(child->name, child2->name))
258 FAIL(c, dti, node, "Duplicate node name");
260 ERROR(duplicate_node_names, check_duplicate_node_names, NULL);
262 static void check_duplicate_property_names(struct check *c, struct dt_info *dti,
265 struct property *prop, *prop2;
267 for_each_property(node, prop) {
268 for (prop2 = prop->next; prop2; prop2 = prop2->next) {
271 if (streq(prop->name, prop2->name))
272 FAIL_PROP(c, dti, node, prop, "Duplicate property name");
276 ERROR(duplicate_property_names, check_duplicate_property_names, NULL);
278 #define LOWERCASE "abcdefghijklmnopqrstuvwxyz"
279 #define UPPERCASE "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
280 #define DIGITS "0123456789"
281 #define PROPNODECHARS LOWERCASE UPPERCASE DIGITS ",._+*#?-"
282 #define PROPNODECHARSSTRICT LOWERCASE UPPERCASE DIGITS ",-"
284 static void check_node_name_chars(struct check *c, struct dt_info *dti,
287 int n = strspn(node->name, c->data);
289 if (n < strlen(node->name))
290 FAIL(c, dti, node, "Bad character '%c' in node name",
293 ERROR(node_name_chars, check_node_name_chars, PROPNODECHARS "@");
295 static void check_node_name_chars_strict(struct check *c, struct dt_info *dti,
298 int n = strspn(node->name, c->data);
300 if (n < node->basenamelen)
301 FAIL(c, dti, node, "Character '%c' not recommended in node name",
304 CHECK(node_name_chars_strict, check_node_name_chars_strict, PROPNODECHARSSTRICT);
306 static void check_node_name_format(struct check *c, struct dt_info *dti,
309 if (strchr(get_unitname(node), '@'))
310 FAIL(c, dti, node, "multiple '@' characters in node name");
312 ERROR(node_name_format, check_node_name_format, NULL, &node_name_chars);
314 static void check_unit_address_vs_reg(struct check *c, struct dt_info *dti,
317 const char *unitname = get_unitname(node);
318 struct property *prop = get_property(node, "reg");
321 prop = get_property(node, "ranges");
322 if (prop && !prop->val.len)
328 FAIL(c, dti, node, "node has a reg or ranges property, but no unit name");
331 FAIL(c, dti, node, "node has a unit name, but no reg property");
334 WARNING(unit_address_vs_reg, check_unit_address_vs_reg, NULL);
336 static void check_property_name_chars(struct check *c, struct dt_info *dti,
339 struct property *prop;
341 for_each_property(node, prop) {
342 int n = strspn(prop->name, c->data);
344 if (n < strlen(prop->name))
345 FAIL_PROP(c, dti, node, prop, "Bad character '%c' in property name",
349 ERROR(property_name_chars, check_property_name_chars, PROPNODECHARS);
351 static void check_property_name_chars_strict(struct check *c,
355 struct property *prop;
357 for_each_property(node, prop) {
358 const char *name = prop->name;
359 int n = strspn(name, c->data);
361 if (n == strlen(prop->name))
364 /* Certain names are whitelisted */
365 if (streq(name, "device_type"))
369 * # is only allowed at the beginning of property names not counting
372 if (name[n] == '#' && ((n == 0) || (name[n-1] == ','))) {
374 n = strspn(name, c->data);
376 if (n < strlen(name))
377 FAIL_PROP(c, dti, node, prop, "Character '%c' not recommended in property name",
381 CHECK(property_name_chars_strict, check_property_name_chars_strict, PROPNODECHARSSTRICT);
383 #define DESCLABEL_FMT "%s%s%s%s%s"
384 #define DESCLABEL_ARGS(node,prop,mark) \
385 ((mark) ? "value of " : ""), \
386 ((prop) ? "'" : ""), \
387 ((prop) ? (prop)->name : ""), \
388 ((prop) ? "' in " : ""), (node)->fullpath
390 static void check_duplicate_label(struct check *c, struct dt_info *dti,
391 const char *label, struct node *node,
392 struct property *prop, struct marker *mark)
394 struct node *dt = dti->dt;
395 struct node *othernode = NULL;
396 struct property *otherprop = NULL;
397 struct marker *othermark = NULL;
399 othernode = get_node_by_label(dt, label);
402 otherprop = get_property_by_label(dt, label, &othernode);
404 othermark = get_marker_label(dt, label, &othernode,
410 if ((othernode != node) || (otherprop != prop) || (othermark != mark))
411 FAIL(c, dti, node, "Duplicate label '%s' on " DESCLABEL_FMT
412 " and " DESCLABEL_FMT,
413 label, DESCLABEL_ARGS(node, prop, mark),
414 DESCLABEL_ARGS(othernode, otherprop, othermark));
417 static void check_duplicate_label_node(struct check *c, struct dt_info *dti,
421 struct property *prop;
423 for_each_label(node->labels, l)
424 check_duplicate_label(c, dti, l->label, node, NULL, NULL);
426 for_each_property(node, prop) {
427 struct marker *m = prop->val.markers;
429 for_each_label(prop->labels, l)
430 check_duplicate_label(c, dti, l->label, node, prop, NULL);
432 for_each_marker_of_type(m, LABEL)
433 check_duplicate_label(c, dti, m->ref, node, prop, m);
436 ERROR(duplicate_label, check_duplicate_label_node, NULL);
438 static cell_t check_phandle_prop(struct check *c, struct dt_info *dti,
439 struct node *node, const char *propname)
441 struct node *root = dti->dt;
442 struct property *prop;
446 prop = get_property(node, propname);
450 if (prop->val.len != sizeof(cell_t)) {
451 FAIL_PROP(c, dti, node, prop, "bad length (%d) %s property",
452 prop->val.len, prop->name);
456 m = prop->val.markers;
457 for_each_marker_of_type(m, REF_PHANDLE) {
458 assert(m->offset == 0);
459 if (node != get_node_by_ref(root, m->ref))
460 /* "Set this node's phandle equal to some
461 * other node's phandle". That's nonsensical
462 * by construction. */ {
463 FAIL(c, dti, node, "%s is a reference to another node",
466 /* But setting this node's phandle equal to its own
467 * phandle is allowed - that means allocate a unique
468 * phandle for this node, even if it's not otherwise
469 * referenced. The value will be filled in later, so
470 * we treat it as having no phandle data for now. */
474 phandle = propval_cell(prop);
476 if ((phandle == 0) || (phandle == -1)) {
477 FAIL_PROP(c, dti, node, prop, "bad value (0x%x) in %s property",
478 phandle, prop->name);
485 static void check_explicit_phandles(struct check *c, struct dt_info *dti,
488 struct node *root = dti->dt;
490 cell_t phandle, linux_phandle;
492 /* Nothing should have assigned phandles yet */
493 assert(!node->phandle);
495 phandle = check_phandle_prop(c, dti, node, "phandle");
497 linux_phandle = check_phandle_prop(c, dti, node, "linux,phandle");
499 if (!phandle && !linux_phandle)
500 /* No valid phandles; nothing further to check */
503 if (linux_phandle && phandle && (phandle != linux_phandle))
504 FAIL(c, dti, node, "mismatching 'phandle' and 'linux,phandle'"
507 if (linux_phandle && !phandle)
508 phandle = linux_phandle;
510 other = get_node_by_phandle(root, phandle);
511 if (other && (other != node)) {
512 FAIL(c, dti, node, "duplicated phandle 0x%x (seen before at %s)",
513 phandle, other->fullpath);
517 node->phandle = phandle;
519 ERROR(explicit_phandles, check_explicit_phandles, NULL);
521 static void check_name_properties(struct check *c, struct dt_info *dti,
524 struct property **pp, *prop = NULL;
526 for (pp = &node->proplist; *pp; pp = &((*pp)->next))
527 if (streq((*pp)->name, "name")) {
533 return; /* No name property, that's fine */
535 if ((prop->val.len != node->basenamelen+1)
536 || (memcmp(prop->val.val, node->name, node->basenamelen) != 0)) {
537 FAIL(c, dti, node, "\"name\" property is incorrect (\"%s\" instead"
538 " of base node name)", prop->val.val);
540 /* The name property is correct, and therefore redundant.
544 data_free(prop->val);
548 ERROR_IF_NOT_STRING(name_is_string, "name");
549 ERROR(name_properties, check_name_properties, NULL, &name_is_string);
552 * Reference fixup functions
555 static void fixup_phandle_references(struct check *c, struct dt_info *dti,
558 struct node *dt = dti->dt;
559 struct property *prop;
561 for_each_property(node, prop) {
562 struct marker *m = prop->val.markers;
563 struct node *refnode;
566 for_each_marker_of_type(m, REF_PHANDLE) {
567 assert(m->offset + sizeof(cell_t) <= prop->val.len);
569 refnode = get_node_by_ref(dt, m->ref);
571 if (!(dti->dtsflags & DTSF_PLUGIN))
572 FAIL(c, dti, node, "Reference to non-existent node or "
573 "label \"%s\"\n", m->ref);
574 else /* mark the entry as unresolved */
575 *((fdt32_t *)(prop->val.val + m->offset)) =
576 cpu_to_fdt32(0xffffffff);
580 phandle = get_node_phandle(dt, refnode);
581 *((fdt32_t *)(prop->val.val + m->offset)) = cpu_to_fdt32(phandle);
585 ERROR(phandle_references, fixup_phandle_references, NULL,
586 &duplicate_node_names, &explicit_phandles);
588 static void fixup_path_references(struct check *c, struct dt_info *dti,
591 struct node *dt = dti->dt;
592 struct property *prop;
594 for_each_property(node, prop) {
595 struct marker *m = prop->val.markers;
596 struct node *refnode;
599 for_each_marker_of_type(m, REF_PATH) {
600 assert(m->offset <= prop->val.len);
602 refnode = get_node_by_ref(dt, m->ref);
604 FAIL(c, dti, node, "Reference to non-existent node or label \"%s\"\n",
609 path = refnode->fullpath;
610 prop->val = data_insert_at_marker(prop->val, m, path,
615 ERROR(path_references, fixup_path_references, NULL, &duplicate_node_names);
620 WARNING_IF_NOT_CELL(address_cells_is_cell, "#address-cells");
621 WARNING_IF_NOT_CELL(size_cells_is_cell, "#size-cells");
622 WARNING_IF_NOT_CELL(interrupt_cells_is_cell, "#interrupt-cells");
624 WARNING_IF_NOT_STRING(device_type_is_string, "device_type");
625 WARNING_IF_NOT_STRING(model_is_string, "model");
626 WARNING_IF_NOT_STRING(status_is_string, "status");
627 WARNING_IF_NOT_STRING(label_is_string, "label");
629 WARNING_IF_NOT_STRING_LIST(compatible_is_string_list, "compatible");
631 static void check_names_is_string_list(struct check *c, struct dt_info *dti,
634 struct property *prop;
636 for_each_property(node, prop) {
637 const char *s = strrchr(prop->name, '-');
638 if (!s || !streq(s, "-names"))
641 c->data = prop->name;
642 check_is_string_list(c, dti, node);
645 WARNING(names_is_string_list, check_names_is_string_list, NULL);
647 static void check_alias_paths(struct check *c, struct dt_info *dti,
650 struct property *prop;
652 if (!streq(node->name, "aliases"))
655 for_each_property(node, prop) {
656 if (!prop->val.val || !get_node_by_path(dti->dt, prop->val.val)) {
657 FAIL_PROP(c, dti, node, prop, "aliases property is not a valid node (%s)",
661 if (strspn(prop->name, LOWERCASE DIGITS "-") != strlen(prop->name))
662 FAIL(c, dti, node, "aliases property name must include only lowercase and '-'");
665 WARNING(alias_paths, check_alias_paths, NULL);
667 static void fixup_addr_size_cells(struct check *c, struct dt_info *dti,
670 struct property *prop;
672 node->addr_cells = -1;
673 node->size_cells = -1;
675 prop = get_property(node, "#address-cells");
677 node->addr_cells = propval_cell(prop);
679 prop = get_property(node, "#size-cells");
681 node->size_cells = propval_cell(prop);
683 WARNING(addr_size_cells, fixup_addr_size_cells, NULL,
684 &address_cells_is_cell, &size_cells_is_cell);
686 #define node_addr_cells(n) \
687 (((n)->addr_cells == -1) ? 2 : (n)->addr_cells)
688 #define node_size_cells(n) \
689 (((n)->size_cells == -1) ? 1 : (n)->size_cells)
691 static void check_reg_format(struct check *c, struct dt_info *dti,
694 struct property *prop;
695 int addr_cells, size_cells, entrylen;
697 prop = get_property(node, "reg");
699 return; /* No "reg", that's fine */
702 FAIL(c, dti, node, "Root node has a \"reg\" property");
706 if (prop->val.len == 0)
707 FAIL_PROP(c, dti, node, prop, "property is empty");
709 addr_cells = node_addr_cells(node->parent);
710 size_cells = node_size_cells(node->parent);
711 entrylen = (addr_cells + size_cells) * sizeof(cell_t);
713 if (!entrylen || (prop->val.len % entrylen) != 0)
714 FAIL_PROP(c, dti, node, prop, "property has invalid length (%d bytes) "
715 "(#address-cells == %d, #size-cells == %d)",
716 prop->val.len, addr_cells, size_cells);
718 WARNING(reg_format, check_reg_format, NULL, &addr_size_cells);
720 static void check_ranges_format(struct check *c, struct dt_info *dti,
723 struct property *prop;
724 int c_addr_cells, p_addr_cells, c_size_cells, p_size_cells, entrylen;
726 prop = get_property(node, "ranges");
731 FAIL_PROP(c, dti, node, prop, "Root node has a \"ranges\" property");
735 p_addr_cells = node_addr_cells(node->parent);
736 p_size_cells = node_size_cells(node->parent);
737 c_addr_cells = node_addr_cells(node);
738 c_size_cells = node_size_cells(node);
739 entrylen = (p_addr_cells + c_addr_cells + c_size_cells) * sizeof(cell_t);
741 if (prop->val.len == 0) {
742 if (p_addr_cells != c_addr_cells)
743 FAIL_PROP(c, dti, node, prop, "empty \"ranges\" property but its "
744 "#address-cells (%d) differs from %s (%d)",
745 c_addr_cells, node->parent->fullpath,
747 if (p_size_cells != c_size_cells)
748 FAIL_PROP(c, dti, node, prop, "empty \"ranges\" property but its "
749 "#size-cells (%d) differs from %s (%d)",
750 c_size_cells, node->parent->fullpath,
752 } else if ((prop->val.len % entrylen) != 0) {
753 FAIL_PROP(c, dti, node, prop, "\"ranges\" property has invalid length (%d bytes) "
754 "(parent #address-cells == %d, child #address-cells == %d, "
755 "#size-cells == %d)", prop->val.len,
756 p_addr_cells, c_addr_cells, c_size_cells);
759 WARNING(ranges_format, check_ranges_format, NULL, &addr_size_cells);
761 static const struct bus_type pci_bus = {
765 static void check_pci_bridge(struct check *c, struct dt_info *dti, struct node *node)
767 struct property *prop;
770 prop = get_property(node, "device_type");
771 if (!prop || !streq(prop->val.val, "pci"))
774 node->bus = &pci_bus;
776 if (!strprefixeq(node->name, node->basenamelen, "pci") &&
777 !strprefixeq(node->name, node->basenamelen, "pcie"))
778 FAIL(c, dti, node, "node name is not \"pci\" or \"pcie\"");
780 prop = get_property(node, "ranges");
782 FAIL(c, dti, node, "missing ranges for PCI bridge (or not a bridge)");
784 if (node_addr_cells(node) != 3)
785 FAIL(c, dti, node, "incorrect #address-cells for PCI bridge");
786 if (node_size_cells(node) != 2)
787 FAIL(c, dti, node, "incorrect #size-cells for PCI bridge");
789 prop = get_property(node, "bus-range");
791 FAIL(c, dti, node, "missing bus-range for PCI bridge");
794 if (prop->val.len != (sizeof(cell_t) * 2)) {
795 FAIL_PROP(c, dti, node, prop, "value must be 2 cells");
798 cells = (cell_t *)prop->val.val;
799 if (fdt32_to_cpu(cells[0]) > fdt32_to_cpu(cells[1]))
800 FAIL_PROP(c, dti, node, prop, "1st cell must be less than or equal to 2nd cell");
801 if (fdt32_to_cpu(cells[1]) > 0xff)
802 FAIL_PROP(c, dti, node, prop, "maximum bus number must be less than 256");
804 WARNING(pci_bridge, check_pci_bridge, NULL,
805 &device_type_is_string, &addr_size_cells);
807 static void check_pci_device_bus_num(struct check *c, struct dt_info *dti, struct node *node)
809 struct property *prop;
810 unsigned int bus_num, min_bus, max_bus;
813 if (!node->parent || (node->parent->bus != &pci_bus))
816 prop = get_property(node, "reg");
820 cells = (cell_t *)prop->val.val;
821 bus_num = (fdt32_to_cpu(cells[0]) & 0x00ff0000) >> 16;
823 prop = get_property(node->parent, "bus-range");
825 min_bus = max_bus = 0;
827 cells = (cell_t *)prop->val.val;
828 min_bus = fdt32_to_cpu(cells[0]);
829 max_bus = fdt32_to_cpu(cells[0]);
831 if ((bus_num < min_bus) || (bus_num > max_bus))
832 FAIL_PROP(c, dti, node, prop, "PCI bus number %d out of range, expected (%d - %d)",
833 bus_num, min_bus, max_bus);
835 WARNING(pci_device_bus_num, check_pci_device_bus_num, NULL, ®_format, &pci_bridge);
837 static void check_pci_device_reg(struct check *c, struct dt_info *dti, struct node *node)
839 struct property *prop;
840 const char *unitname = get_unitname(node);
842 unsigned int dev, func, reg;
845 if (!node->parent || (node->parent->bus != &pci_bus))
848 prop = get_property(node, "reg");
850 FAIL(c, dti, node, "missing PCI reg property");
854 cells = (cell_t *)prop->val.val;
855 if (cells[1] || cells[2])
856 FAIL_PROP(c, dti, node, prop, "PCI reg config space address cells 2 and 3 must be 0");
858 reg = fdt32_to_cpu(cells[0]);
859 dev = (reg & 0xf800) >> 11;
860 func = (reg & 0x700) >> 8;
862 if (reg & 0xff000000)
863 FAIL_PROP(c, dti, node, prop, "PCI reg address is not configuration space");
864 if (reg & 0x000000ff)
865 FAIL_PROP(c, dti, node, prop, "PCI reg config space address register number must be 0");
868 snprintf(unit_addr, sizeof(unit_addr), "%x", dev);
869 if (streq(unitname, unit_addr))
873 snprintf(unit_addr, sizeof(unit_addr), "%x,%x", dev, func);
874 if (streq(unitname, unit_addr))
877 FAIL(c, dti, node, "PCI unit address format error, expected \"%s\"",
880 WARNING(pci_device_reg, check_pci_device_reg, NULL, ®_format, &pci_bridge);
882 static const struct bus_type simple_bus = {
883 .name = "simple-bus",
886 static bool node_is_compatible(struct node *node, const char *compat)
888 struct property *prop;
889 const char *str, *end;
891 prop = get_property(node, "compatible");
895 for (str = prop->val.val, end = str + prop->val.len; str < end;
896 str += strnlen(str, end - str) + 1) {
897 if (strprefixeq(str, end - str, compat))
903 static void check_simple_bus_bridge(struct check *c, struct dt_info *dti, struct node *node)
905 if (node_is_compatible(node, "simple-bus"))
906 node->bus = &simple_bus;
908 WARNING(simple_bus_bridge, check_simple_bus_bridge, NULL, &addr_size_cells);
910 static void check_simple_bus_reg(struct check *c, struct dt_info *dti, struct node *node)
912 struct property *prop;
913 const char *unitname = get_unitname(node);
917 cell_t *cells = NULL;
919 if (!node->parent || (node->parent->bus != &simple_bus))
922 prop = get_property(node, "reg");
924 cells = (cell_t *)prop->val.val;
926 prop = get_property(node, "ranges");
927 if (prop && prop->val.len)
928 /* skip of child address */
929 cells = ((cell_t *)prop->val.val) + node_addr_cells(node);
933 if (node->parent->parent && !(node->bus == &simple_bus))
934 FAIL(c, dti, node, "missing or empty reg/ranges property");
938 size = node_addr_cells(node->parent);
940 reg = (reg << 32) | fdt32_to_cpu(*(cells++));
942 snprintf(unit_addr, sizeof(unit_addr), "%"PRIx64, reg);
943 if (!streq(unitname, unit_addr))
944 FAIL(c, dti, node, "simple-bus unit address format error, expected \"%s\"",
947 WARNING(simple_bus_reg, check_simple_bus_reg, NULL, ®_format, &simple_bus_bridge);
949 static void check_unit_address_format(struct check *c, struct dt_info *dti,
952 const char *unitname = get_unitname(node);
954 if (node->parent && node->parent->bus)
960 if (!strncmp(unitname, "0x", 2)) {
961 FAIL(c, dti, node, "unit name should not have leading \"0x\"");
962 /* skip over 0x for next test */
965 if (unitname[0] == '0' && isxdigit(unitname[1]))
966 FAIL(c, dti, node, "unit name should not have leading 0s");
968 WARNING(unit_address_format, check_unit_address_format, NULL,
969 &node_name_format, &pci_bridge, &simple_bus_bridge);
974 static void check_avoid_default_addr_size(struct check *c, struct dt_info *dti,
977 struct property *reg, *ranges;
980 return; /* Ignore root node */
982 reg = get_property(node, "reg");
983 ranges = get_property(node, "ranges");
988 if (node->parent->addr_cells == -1)
989 FAIL(c, dti, node, "Relying on default #address-cells value");
991 if (node->parent->size_cells == -1)
992 FAIL(c, dti, node, "Relying on default #size-cells value");
994 WARNING(avoid_default_addr_size, check_avoid_default_addr_size, NULL,
997 static void check_avoid_unnecessary_addr_size(struct check *c, struct dt_info *dti,
1000 struct property *prop;
1002 bool has_reg = false;
1004 if (!node->parent || node->addr_cells < 0 || node->size_cells < 0)
1007 if (get_property(node, "ranges") || !node->children)
1010 for_each_child(node, child) {
1011 prop = get_property(child, "reg");
1017 FAIL(c, dti, node, "unnecessary #address-cells/#size-cells without \"ranges\" or child \"reg\" property");
1019 WARNING(avoid_unnecessary_addr_size, check_avoid_unnecessary_addr_size, NULL, &avoid_default_addr_size);
1021 static void check_obsolete_chosen_interrupt_controller(struct check *c,
1022 struct dt_info *dti,
1025 struct node *dt = dti->dt;
1026 struct node *chosen;
1027 struct property *prop;
1033 chosen = get_node_by_path(dt, "/chosen");
1037 prop = get_property(chosen, "interrupt-controller");
1039 FAIL_PROP(c, dti, node, prop,
1040 "/chosen has obsolete \"interrupt-controller\" property");
1042 WARNING(obsolete_chosen_interrupt_controller,
1043 check_obsolete_chosen_interrupt_controller, NULL);
1045 static void check_chosen_node_is_root(struct check *c, struct dt_info *dti,
1048 if (!streq(node->name, "chosen"))
1051 if (node->parent != dti->dt)
1052 FAIL(c, dti, node, "chosen node must be at root node");
1054 WARNING(chosen_node_is_root, check_chosen_node_is_root, NULL);
1056 static void check_chosen_node_bootargs(struct check *c, struct dt_info *dti,
1059 struct property *prop;
1061 if (!streq(node->name, "chosen"))
1064 prop = get_property(node, "bootargs");
1068 c->data = prop->name;
1069 check_is_string(c, dti, node);
1071 WARNING(chosen_node_bootargs, check_chosen_node_bootargs, NULL);
1073 static void check_chosen_node_stdout_path(struct check *c, struct dt_info *dti,
1076 struct property *prop;
1078 if (!streq(node->name, "chosen"))
1081 prop = get_property(node, "stdout-path");
1083 prop = get_property(node, "linux,stdout-path");
1086 FAIL_PROP(c, dti, node, prop, "Use 'stdout-path' instead");
1089 c->data = prop->name;
1090 check_is_string(c, dti, node);
1092 WARNING(chosen_node_stdout_path, check_chosen_node_stdout_path, NULL);
1095 const char *prop_name;
1096 const char *cell_name;
1100 static void check_property_phandle_args(struct check *c,
1101 struct dt_info *dti,
1103 struct property *prop,
1104 const struct provider *provider)
1106 struct node *root = dti->dt;
1107 int cell, cellsize = 0;
1109 if (prop->val.len % sizeof(cell_t)) {
1110 FAIL_PROP(c, dti, node, prop,
1111 "property size (%d) is invalid, expected multiple of %zu",
1112 prop->val.len, sizeof(cell_t));
1116 for (cell = 0; cell < prop->val.len / sizeof(cell_t); cell += cellsize + 1) {
1117 struct node *provider_node;
1118 struct property *cellprop;
1121 phandle = propval_cell_n(prop, cell);
1123 * Some bindings use a cell value 0 or -1 to skip over optional
1124 * entries when each index position has a specific definition.
1126 if (phandle == 0 || phandle == -1) {
1127 /* Give up if this is an overlay with external references */
1128 if (dti->dtsflags & DTSF_PLUGIN)
1135 /* If we have markers, verify the current cell is a phandle */
1136 if (prop->val.markers) {
1137 struct marker *m = prop->val.markers;
1138 for_each_marker_of_type(m, REF_PHANDLE) {
1139 if (m->offset == (cell * sizeof(cell_t)))
1143 FAIL_PROP(c, dti, node, prop,
1144 "cell %d is not a phandle reference",
1148 provider_node = get_node_by_phandle(root, phandle);
1149 if (!provider_node) {
1150 FAIL_PROP(c, dti, node, prop,
1151 "Could not get phandle node for (cell %d)",
1156 cellprop = get_property(provider_node, provider->cell_name);
1158 cellsize = propval_cell(cellprop);
1159 } else if (provider->optional) {
1162 FAIL(c, dti, node, "Missing property '%s' in node %s or bad phandle (referred from %s[%d])",
1163 provider->cell_name,
1164 provider_node->fullpath,
1169 if (prop->val.len < ((cell + cellsize + 1) * sizeof(cell_t))) {
1170 FAIL_PROP(c, dti, node, prop,
1171 "property size (%d) too small for cell size %d",
1172 prop->val.len, cellsize);
1177 static void check_provider_cells_property(struct check *c,
1178 struct dt_info *dti,
1181 struct provider *provider = c->data;
1182 struct property *prop;
1184 prop = get_property(node, provider->prop_name);
1188 check_property_phandle_args(c, dti, node, prop, provider);
1190 #define WARNING_PROPERTY_PHANDLE_CELLS(nm, propname, cells_name, ...) \
1191 static struct provider nm##_provider = { (propname), (cells_name), __VA_ARGS__ }; \
1192 WARNING(nm##_property, check_provider_cells_property, &nm##_provider, &phandle_references);
1194 WARNING_PROPERTY_PHANDLE_CELLS(clocks, "clocks", "#clock-cells");
1195 WARNING_PROPERTY_PHANDLE_CELLS(cooling_device, "cooling-device", "#cooling-cells");
1196 WARNING_PROPERTY_PHANDLE_CELLS(dmas, "dmas", "#dma-cells");
1197 WARNING_PROPERTY_PHANDLE_CELLS(hwlocks, "hwlocks", "#hwlock-cells");
1198 WARNING_PROPERTY_PHANDLE_CELLS(interrupts_extended, "interrupts-extended", "#interrupt-cells");
1199 WARNING_PROPERTY_PHANDLE_CELLS(io_channels, "io-channels", "#io-channel-cells");
1200 WARNING_PROPERTY_PHANDLE_CELLS(iommus, "iommus", "#iommu-cells");
1201 WARNING_PROPERTY_PHANDLE_CELLS(mboxes, "mboxes", "#mbox-cells");
1202 WARNING_PROPERTY_PHANDLE_CELLS(msi_parent, "msi-parent", "#msi-cells", true);
1203 WARNING_PROPERTY_PHANDLE_CELLS(mux_controls, "mux-controls", "#mux-control-cells");
1204 WARNING_PROPERTY_PHANDLE_CELLS(phys, "phys", "#phy-cells");
1205 WARNING_PROPERTY_PHANDLE_CELLS(power_domains, "power-domains", "#power-domain-cells");
1206 WARNING_PROPERTY_PHANDLE_CELLS(pwms, "pwms", "#pwm-cells");
1207 WARNING_PROPERTY_PHANDLE_CELLS(resets, "resets", "#reset-cells");
1208 WARNING_PROPERTY_PHANDLE_CELLS(sound_dai, "sound-dai", "#sound-dai-cells");
1209 WARNING_PROPERTY_PHANDLE_CELLS(thermal_sensors, "thermal-sensors", "#thermal-sensor-cells");
1211 static bool prop_is_gpio(struct property *prop)
1216 * *-gpios and *-gpio can appear in property names,
1217 * so skip over any false matches (only one known ATM)
1219 if (strstr(prop->name, "nr-gpio"))
1222 str = strrchr(prop->name, '-');
1227 if (!(streq(str, "gpios") || streq(str, "gpio")))
1233 static void check_gpios_property(struct check *c,
1234 struct dt_info *dti,
1237 struct property *prop;
1239 /* Skip GPIO hog nodes which have 'gpios' property */
1240 if (get_property(node, "gpio-hog"))
1243 for_each_property(node, prop) {
1244 struct provider provider;
1246 if (!prop_is_gpio(prop))
1249 provider.prop_name = prop->name;
1250 provider.cell_name = "#gpio-cells";
1251 provider.optional = false;
1252 check_property_phandle_args(c, dti, node, prop, &provider);
1256 WARNING(gpios_property, check_gpios_property, NULL, &phandle_references);
1258 static void check_deprecated_gpio_property(struct check *c,
1259 struct dt_info *dti,
1262 struct property *prop;
1264 for_each_property(node, prop) {
1267 if (!prop_is_gpio(prop))
1270 str = strstr(prop->name, "gpio");
1271 if (!streq(str, "gpio"))
1274 FAIL_PROP(c, dti, node, prop,
1275 "'[*-]gpio' is deprecated, use '[*-]gpios' instead");
1279 CHECK(deprecated_gpio_property, check_deprecated_gpio_property, NULL);
1281 static bool node_is_interrupt_provider(struct node *node)
1283 struct property *prop;
1285 prop = get_property(node, "interrupt-controller");
1289 prop = get_property(node, "interrupt-map");
1295 static void check_interrupts_property(struct check *c,
1296 struct dt_info *dti,
1299 struct node *root = dti->dt;
1300 struct node *irq_node = NULL, *parent = node;
1301 struct property *irq_prop, *prop = NULL;
1302 int irq_cells, phandle;
1304 irq_prop = get_property(node, "interrupts");
1308 if (irq_prop->val.len % sizeof(cell_t))
1309 FAIL_PROP(c, dti, node, irq_prop, "size (%d) is invalid, expected multiple of %zu",
1310 irq_prop->val.len, sizeof(cell_t));
1312 while (parent && !prop) {
1313 if (parent != node && node_is_interrupt_provider(parent)) {
1318 prop = get_property(parent, "interrupt-parent");
1320 phandle = propval_cell(prop);
1321 /* Give up if this is an overlay with external references */
1322 if ((phandle == 0 || phandle == -1) &&
1323 (dti->dtsflags & DTSF_PLUGIN))
1326 irq_node = get_node_by_phandle(root, phandle);
1328 FAIL_PROP(c, dti, parent, prop, "Bad phandle");
1331 if (!node_is_interrupt_provider(irq_node))
1332 FAIL(c, dti, irq_node,
1333 "Missing interrupt-controller or interrupt-map property");
1338 parent = parent->parent;
1342 FAIL(c, dti, node, "Missing interrupt-parent");
1346 prop = get_property(irq_node, "#interrupt-cells");
1348 FAIL(c, dti, irq_node, "Missing #interrupt-cells in interrupt-parent");
1352 irq_cells = propval_cell(prop);
1353 if (irq_prop->val.len % (irq_cells * sizeof(cell_t))) {
1354 FAIL_PROP(c, dti, node, prop,
1355 "size is (%d), expected multiple of %d",
1356 irq_prop->val.len, (int)(irq_cells * sizeof(cell_t)));
1359 WARNING(interrupts_property, check_interrupts_property, &phandle_references);
1361 static struct check *check_table[] = {
1362 &duplicate_node_names, &duplicate_property_names,
1363 &node_name_chars, &node_name_format, &property_name_chars,
1364 &name_is_string, &name_properties,
1369 &phandle_references, &path_references,
1371 &address_cells_is_cell, &size_cells_is_cell, &interrupt_cells_is_cell,
1372 &device_type_is_string, &model_is_string, &status_is_string,
1375 &compatible_is_string_list, &names_is_string_list,
1377 &property_name_chars_strict,
1378 &node_name_chars_strict,
1380 &addr_size_cells, ®_format, &ranges_format,
1382 &unit_address_vs_reg,
1383 &unit_address_format,
1387 &pci_device_bus_num,
1392 &avoid_default_addr_size,
1393 &avoid_unnecessary_addr_size,
1394 &obsolete_chosen_interrupt_controller,
1395 &chosen_node_is_root, &chosen_node_bootargs, &chosen_node_stdout_path,
1398 &cooling_device_property,
1401 &interrupts_extended_property,
1402 &io_channels_property,
1405 &msi_parent_property,
1406 &mux_controls_property,
1408 &power_domains_property,
1411 &sound_dai_property,
1412 &thermal_sensors_property,
1414 &deprecated_gpio_property,
1416 &interrupts_property,
1423 static void enable_warning_error(struct check *c, bool warn, bool error)
1427 /* Raising level, also raise it for prereqs */
1428 if ((warn && !c->warn) || (error && !c->error))
1429 for (i = 0; i < c->num_prereqs; i++)
1430 enable_warning_error(c->prereq[i], warn, error);
1432 c->warn = c->warn || warn;
1433 c->error = c->error || error;
1436 static void disable_warning_error(struct check *c, bool warn, bool error)
1440 /* Lowering level, also lower it for things this is the prereq
1442 if ((warn && c->warn) || (error && c->error)) {
1443 for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1444 struct check *cc = check_table[i];
1447 for (j = 0; j < cc->num_prereqs; j++)
1448 if (cc->prereq[j] == c)
1449 disable_warning_error(cc, warn, error);
1453 c->warn = c->warn && !warn;
1454 c->error = c->error && !error;
1457 void parse_checks_option(bool warn, bool error, const char *arg)
1460 const char *name = arg;
1463 if ((strncmp(arg, "no-", 3) == 0)
1464 || (strncmp(arg, "no_", 3) == 0)) {
1469 for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1470 struct check *c = check_table[i];
1472 if (streq(c->name, name)) {
1474 enable_warning_error(c, warn, error);
1476 disable_warning_error(c, warn, error);
1481 die("Unrecognized check name \"%s\"\n", name);
1484 void process_checks(bool force, struct dt_info *dti)
1489 for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1490 struct check *c = check_table[i];
1492 if (c->warn || c->error)
1493 error = error || run_check(c, dti);
1498 fprintf(stderr, "ERROR: Input tree has errors, aborting "
1499 "(use -f to force output)\n");
1501 } else if (quiet < 3) {
1502 fprintf(stderr, "Warning: Input tree has errors, "