2 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2007.
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 (*tree_check_fn
)(struct check
*c
, struct node
*dt
);
44 typedef void (*node_check_fn
)(struct check
*c
, struct node
*dt
, struct node
*node
);
45 typedef void (*prop_check_fn
)(struct check
*c
, struct node
*dt
,
46 struct node
*node
, struct property
*prop
);
50 tree_check_fn tree_fn
;
51 node_check_fn node_fn
;
52 prop_check_fn prop_fn
;
55 enum checkstatus status
;
58 struct check
**prereq
;
61 #define CHECK_ENTRY(nm, tfn, nfn, pfn, d, w, e, ...) \
62 static struct check *nm##_prereqs[] = { __VA_ARGS__ }; \
63 static struct check nm = { \
71 .status = UNCHECKED, \
72 .num_prereqs = ARRAY_SIZE(nm##_prereqs), \
73 .prereq = nm##_prereqs, \
75 #define WARNING(nm, tfn, nfn, pfn, d, ...) \
76 CHECK_ENTRY(nm, tfn, nfn, pfn, d, true, false, __VA_ARGS__)
77 #define ERROR(nm, tfn, nfn, pfn, d, ...) \
78 CHECK_ENTRY(nm, tfn, nfn, pfn, d, false, true, __VA_ARGS__)
79 #define CHECK(nm, tfn, nfn, pfn, d, ...) \
80 CHECK_ENTRY(nm, tfn, nfn, pfn, d, false, false, __VA_ARGS__)
82 #define TREE_WARNING(nm, d, ...) \
83 WARNING(nm, check_##nm, NULL, NULL, d, __VA_ARGS__)
84 #define TREE_ERROR(nm, d, ...) \
85 ERROR(nm, check_##nm, NULL, NULL, d, __VA_ARGS__)
86 #define TREE_CHECK(nm, d, ...) \
87 CHECK(nm, check_##nm, NULL, NULL, d, __VA_ARGS__)
88 #define NODE_WARNING(nm, d, ...) \
89 WARNING(nm, NULL, check_##nm, NULL, d, __VA_ARGS__)
90 #define NODE_ERROR(nm, d, ...) \
91 ERROR(nm, NULL, check_##nm, NULL, d, __VA_ARGS__)
92 #define NODE_CHECK(nm, d, ...) \
93 CHECK(nm, NULL, check_##nm, NULL, d, __VA_ARGS__)
94 #define PROP_WARNING(nm, d, ...) \
95 WARNING(nm, NULL, NULL, check_##nm, d, __VA_ARGS__)
96 #define PROP_ERROR(nm, d, ...) \
97 ERROR(nm, NULL, NULL, check_##nm, d, __VA_ARGS__)
98 #define PROP_CHECK(nm, d, ...) \
99 CHECK(nm, NULL, NULL, check_##nm, d, __VA_ARGS__)
102 static inline void check_msg(struct check
*c
, const char *fmt
, ...) __attribute__((format (printf
, 2, 3)));
104 static inline void check_msg(struct check
*c
, const char *fmt
, ...)
109 if ((c
->warn
&& (quiet
< 1))
110 || (c
->error
&& (quiet
< 2))) {
111 fprintf(stderr
, "%s (%s): ",
112 (c
->error
) ? "ERROR" : "Warning", c
->name
);
113 vfprintf(stderr
, fmt
, ap
);
114 fprintf(stderr
, "\n");
119 #define FAIL(c, ...) \
121 TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__); \
122 (c)->status = FAILED; \
123 check_msg((c), __VA_ARGS__); \
126 static void check_nodes_props(struct check
*c
, struct node
*dt
, struct node
*node
)
129 struct property
*prop
;
131 TRACE(c
, "%s", node
->fullpath
);
133 c
->node_fn(c
, dt
, node
);
136 for_each_property(node
, prop
) {
137 TRACE(c
, "%s\t'%s'", node
->fullpath
, prop
->name
);
138 c
->prop_fn(c
, dt
, node
, prop
);
141 for_each_child(node
, child
)
142 check_nodes_props(c
, dt
, child
);
145 static bool run_check(struct check
*c
, struct node
*dt
)
150 assert(!c
->inprogress
);
152 if (c
->status
!= UNCHECKED
)
155 c
->inprogress
= true;
157 for (i
= 0; i
< c
->num_prereqs
; i
++) {
158 struct check
*prq
= c
->prereq
[i
];
159 error
= error
|| run_check(prq
, dt
);
160 if (prq
->status
!= PASSED
) {
162 check_msg(c
, "Failed prerequisite '%s'",
167 if (c
->status
!= UNCHECKED
)
170 if (c
->node_fn
|| c
->prop_fn
)
171 check_nodes_props(c
, dt
, dt
);
175 if (c
->status
== UNCHECKED
)
178 TRACE(c
, "\tCompleted, status %d", c
->status
);
181 c
->inprogress
= false;
182 if ((c
->status
!= PASSED
) && (c
->error
))
188 * Utility check functions
191 /* A check which always fails, for testing purposes only */
192 static inline void check_always_fail(struct check
*c
, struct node
*dt
)
194 FAIL(c
, "always_fail check");
196 TREE_CHECK(always_fail
, NULL
);
198 static void check_is_string(struct check
*c
, struct node
*root
,
201 struct property
*prop
;
202 char *propname
= c
->data
;
204 prop
= get_property(node
, propname
);
206 return; /* Not present, assumed ok */
208 if (!data_is_one_string(prop
->val
))
209 FAIL(c
, "\"%s\" property in %s is not a string",
210 propname
, node
->fullpath
);
212 #define WARNING_IF_NOT_STRING(nm, propname) \
213 WARNING(nm, NULL, check_is_string, NULL, (propname))
214 #define ERROR_IF_NOT_STRING(nm, propname) \
215 ERROR(nm, NULL, check_is_string, NULL, (propname))
217 static void check_is_cell(struct check
*c
, struct node
*root
,
220 struct property
*prop
;
221 char *propname
= c
->data
;
223 prop
= get_property(node
, propname
);
225 return; /* Not present, assumed ok */
227 if (prop
->val
.len
!= sizeof(cell_t
))
228 FAIL(c
, "\"%s\" property in %s is not a single cell",
229 propname
, node
->fullpath
);
231 #define WARNING_IF_NOT_CELL(nm, propname) \
232 WARNING(nm, NULL, check_is_cell, NULL, (propname))
233 #define ERROR_IF_NOT_CELL(nm, propname) \
234 ERROR(nm, NULL, check_is_cell, NULL, (propname))
237 * Structural check functions
240 static void check_duplicate_node_names(struct check
*c
, struct node
*dt
,
243 struct node
*child
, *child2
;
245 for_each_child(node
, child
)
246 for (child2
= child
->next_sibling
;
248 child2
= child2
->next_sibling
)
249 if (streq(child
->name
, child2
->name
))
250 FAIL(c
, "Duplicate node name %s",
253 NODE_ERROR(duplicate_node_names
, NULL
);
255 static void check_duplicate_property_names(struct check
*c
, struct node
*dt
,
258 struct property
*prop
, *prop2
;
260 for_each_property(node
, prop
) {
261 for (prop2
= prop
->next
; prop2
; prop2
= prop2
->next
) {
264 if (streq(prop
->name
, prop2
->name
))
265 FAIL(c
, "Duplicate property name %s in %s",
266 prop
->name
, node
->fullpath
);
270 NODE_ERROR(duplicate_property_names
, NULL
);
272 #define LOWERCASE "abcdefghijklmnopqrstuvwxyz"
273 #define UPPERCASE "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
274 #define DIGITS "0123456789"
275 #define PROPNODECHARS LOWERCASE UPPERCASE DIGITS ",._+*#?-"
277 static void check_node_name_chars(struct check
*c
, struct node
*dt
,
280 int n
= strspn(node
->name
, c
->data
);
282 if (n
< strlen(node
->name
))
283 FAIL(c
, "Bad character '%c' in node %s",
284 node
->name
[n
], node
->fullpath
);
286 NODE_ERROR(node_name_chars
, PROPNODECHARS
"@");
288 static void check_node_name_format(struct check
*c
, struct node
*dt
,
291 if (strchr(get_unitname(node
), '@'))
292 FAIL(c
, "Node %s has multiple '@' characters in name",
295 NODE_ERROR(node_name_format
, NULL
, &node_name_chars
);
297 static void check_property_name_chars(struct check
*c
, struct node
*dt
,
298 struct node
*node
, struct property
*prop
)
300 int n
= strspn(prop
->name
, c
->data
);
302 if (n
< strlen(prop
->name
))
303 FAIL(c
, "Bad character '%c' in property name \"%s\", node %s",
304 prop
->name
[n
], prop
->name
, node
->fullpath
);
306 PROP_ERROR(property_name_chars
, PROPNODECHARS
);
308 #define DESCLABEL_FMT "%s%s%s%s%s"
309 #define DESCLABEL_ARGS(node,prop,mark) \
310 ((mark) ? "value of " : ""), \
311 ((prop) ? "'" : ""), \
312 ((prop) ? (prop)->name : ""), \
313 ((prop) ? "' in " : ""), (node)->fullpath
315 static void check_duplicate_label(struct check
*c
, struct node
*dt
,
316 const char *label
, struct node
*node
,
317 struct property
*prop
, struct marker
*mark
)
319 struct node
*othernode
= NULL
;
320 struct property
*otherprop
= NULL
;
321 struct marker
*othermark
= NULL
;
323 othernode
= get_node_by_label(dt
, label
);
326 otherprop
= get_property_by_label(dt
, label
, &othernode
);
328 othermark
= get_marker_label(dt
, label
, &othernode
,
334 if ((othernode
!= node
) || (otherprop
!= prop
) || (othermark
!= mark
))
335 FAIL(c
, "Duplicate label '%s' on " DESCLABEL_FMT
336 " and " DESCLABEL_FMT
,
337 label
, DESCLABEL_ARGS(node
, prop
, mark
),
338 DESCLABEL_ARGS(othernode
, otherprop
, othermark
));
341 static void check_duplicate_label_node(struct check
*c
, struct node
*dt
,
346 for_each_label(node
->labels
, l
)
347 check_duplicate_label(c
, dt
, l
->label
, node
, NULL
, NULL
);
349 static void check_duplicate_label_prop(struct check
*c
, struct node
*dt
,
350 struct node
*node
, struct property
*prop
)
352 struct marker
*m
= prop
->val
.markers
;
355 for_each_label(prop
->labels
, l
)
356 check_duplicate_label(c
, dt
, l
->label
, node
, prop
, NULL
);
358 for_each_marker_of_type(m
, LABEL
)
359 check_duplicate_label(c
, dt
, m
->ref
, node
, prop
, m
);
361 ERROR(duplicate_label
, NULL
, check_duplicate_label_node
,
362 check_duplicate_label_prop
, NULL
);
364 static void check_explicit_phandles(struct check
*c
, struct node
*root
,
365 struct node
*node
, struct property
*prop
)
371 if (!streq(prop
->name
, "phandle")
372 && !streq(prop
->name
, "linux,phandle"))
375 if (prop
->val
.len
!= sizeof(cell_t
)) {
376 FAIL(c
, "%s has bad length (%d) %s property",
377 node
->fullpath
, prop
->val
.len
, prop
->name
);
381 m
= prop
->val
.markers
;
382 for_each_marker_of_type(m
, REF_PHANDLE
) {
383 assert(m
->offset
== 0);
384 if (node
!= get_node_by_ref(root
, m
->ref
))
385 /* "Set this node's phandle equal to some
386 * other node's phandle". That's nonsensical
387 * by construction. */ {
388 FAIL(c
, "%s in %s is a reference to another node",
389 prop
->name
, node
->fullpath
);
392 /* But setting this node's phandle equal to its own
393 * phandle is allowed - that means allocate a unique
394 * phandle for this node, even if it's not otherwise
395 * referenced. The value will be filled in later, so
396 * no further checking for now. */
400 phandle
= propval_cell(prop
);
402 if ((phandle
== 0) || (phandle
== -1)) {
403 FAIL(c
, "%s has bad value (0x%x) in %s property",
404 node
->fullpath
, phandle
, prop
->name
);
408 if (node
->phandle
&& (node
->phandle
!= phandle
))
409 FAIL(c
, "%s has %s property which replaces existing phandle information",
410 node
->fullpath
, prop
->name
);
412 other
= get_node_by_phandle(root
, phandle
);
413 if (other
&& (other
!= node
)) {
414 FAIL(c
, "%s has duplicated phandle 0x%x (seen before at %s)",
415 node
->fullpath
, phandle
, other
->fullpath
);
419 node
->phandle
= phandle
;
421 PROP_ERROR(explicit_phandles
, NULL
);
423 static void check_name_properties(struct check
*c
, struct node
*root
,
426 struct property
**pp
, *prop
= NULL
;
428 for (pp
= &node
->proplist
; *pp
; pp
= &((*pp
)->next
))
429 if (streq((*pp
)->name
, "name")) {
435 return; /* No name property, that's fine */
437 if ((prop
->val
.len
!= node
->basenamelen
+1)
438 || (memcmp(prop
->val
.val
, node
->name
, node
->basenamelen
) != 0)) {
439 FAIL(c
, "\"name\" property in %s is incorrect (\"%s\" instead"
440 " of base node name)", node
->fullpath
, prop
->val
.val
);
442 /* The name property is correct, and therefore redundant.
446 data_free(prop
->val
);
450 ERROR_IF_NOT_STRING(name_is_string
, "name");
451 NODE_ERROR(name_properties
, NULL
, &name_is_string
);
454 * Reference fixup functions
457 static void fixup_phandle_references(struct check
*c
, struct node
*dt
,
458 struct node
*node
, struct property
*prop
)
460 struct marker
*m
= prop
->val
.markers
;
461 struct node
*refnode
;
464 for_each_marker_of_type(m
, REF_PHANDLE
) {
465 assert(m
->offset
+ sizeof(cell_t
) <= prop
->val
.len
);
467 refnode
= get_node_by_ref(dt
, m
->ref
);
469 FAIL(c
, "Reference to non-existent node or label \"%s\"\n",
474 phandle
= get_node_phandle(dt
, refnode
);
475 *((cell_t
*)(prop
->val
.val
+ m
->offset
)) = cpu_to_fdt32(phandle
);
478 ERROR(phandle_references
, NULL
, NULL
, fixup_phandle_references
, NULL
,
479 &duplicate_node_names
, &explicit_phandles
);
481 static void fixup_path_references(struct check
*c
, struct node
*dt
,
482 struct node
*node
, struct property
*prop
)
484 struct marker
*m
= prop
->val
.markers
;
485 struct node
*refnode
;
488 for_each_marker_of_type(m
, REF_PATH
) {
489 assert(m
->offset
<= prop
->val
.len
);
491 refnode
= get_node_by_ref(dt
, m
->ref
);
493 FAIL(c
, "Reference to non-existent node or label \"%s\"\n",
498 path
= refnode
->fullpath
;
499 prop
->val
= data_insert_at_marker(prop
->val
, m
, path
,
503 ERROR(path_references
, NULL
, NULL
, fixup_path_references
, NULL
,
504 &duplicate_node_names
);
509 WARNING_IF_NOT_CELL(address_cells_is_cell
, "#address-cells");
510 WARNING_IF_NOT_CELL(size_cells_is_cell
, "#size-cells");
511 WARNING_IF_NOT_CELL(interrupt_cells_is_cell
, "#interrupt-cells");
513 WARNING_IF_NOT_STRING(device_type_is_string
, "device_type");
514 WARNING_IF_NOT_STRING(model_is_string
, "model");
515 WARNING_IF_NOT_STRING(status_is_string
, "status");
517 static void fixup_addr_size_cells(struct check
*c
, struct node
*dt
,
520 struct property
*prop
;
522 node
->addr_cells
= -1;
523 node
->size_cells
= -1;
525 prop
= get_property(node
, "#address-cells");
527 node
->addr_cells
= propval_cell(prop
);
529 prop
= get_property(node
, "#size-cells");
531 node
->size_cells
= propval_cell(prop
);
533 WARNING(addr_size_cells
, NULL
, fixup_addr_size_cells
, NULL
, NULL
,
534 &address_cells_is_cell
, &size_cells_is_cell
);
536 #define node_addr_cells(n) \
537 (((n)->addr_cells == -1) ? 2 : (n)->addr_cells)
538 #define node_size_cells(n) \
539 (((n)->size_cells == -1) ? 1 : (n)->size_cells)
541 static void check_reg_format(struct check
*c
, struct node
*dt
,
544 struct property
*prop
;
545 int addr_cells
, size_cells
, entrylen
;
547 prop
= get_property(node
, "reg");
549 return; /* No "reg", that's fine */
552 FAIL(c
, "Root node has a \"reg\" property");
556 if (prop
->val
.len
== 0)
557 FAIL(c
, "\"reg\" property in %s is empty", node
->fullpath
);
559 addr_cells
= node_addr_cells(node
->parent
);
560 size_cells
= node_size_cells(node
->parent
);
561 entrylen
= (addr_cells
+ size_cells
) * sizeof(cell_t
);
563 if ((prop
->val
.len
% entrylen
) != 0)
564 FAIL(c
, "\"reg\" property in %s has invalid length (%d bytes) "
565 "(#address-cells == %d, #size-cells == %d)",
566 node
->fullpath
, prop
->val
.len
, addr_cells
, size_cells
);
568 NODE_WARNING(reg_format
, NULL
, &addr_size_cells
);
570 static void check_ranges_format(struct check
*c
, struct node
*dt
,
573 struct property
*prop
;
574 int c_addr_cells
, p_addr_cells
, c_size_cells
, p_size_cells
, entrylen
;
576 prop
= get_property(node
, "ranges");
581 FAIL(c
, "Root node has a \"ranges\" property");
585 p_addr_cells
= node_addr_cells(node
->parent
);
586 p_size_cells
= node_size_cells(node
->parent
);
587 c_addr_cells
= node_addr_cells(node
);
588 c_size_cells
= node_size_cells(node
);
589 entrylen
= (p_addr_cells
+ c_addr_cells
+ c_size_cells
) * sizeof(cell_t
);
591 if (prop
->val
.len
== 0) {
592 if (p_addr_cells
!= c_addr_cells
)
593 FAIL(c
, "%s has empty \"ranges\" property but its "
594 "#address-cells (%d) differs from %s (%d)",
595 node
->fullpath
, c_addr_cells
, node
->parent
->fullpath
,
597 if (p_size_cells
!= c_size_cells
)
598 FAIL(c
, "%s has empty \"ranges\" property but its "
599 "#size-cells (%d) differs from %s (%d)",
600 node
->fullpath
, c_size_cells
, node
->parent
->fullpath
,
602 } else if ((prop
->val
.len
% entrylen
) != 0) {
603 FAIL(c
, "\"ranges\" property in %s has invalid length (%d bytes) "
604 "(parent #address-cells == %d, child #address-cells == %d, "
605 "#size-cells == %d)", node
->fullpath
, prop
->val
.len
,
606 p_addr_cells
, c_addr_cells
, c_size_cells
);
609 NODE_WARNING(ranges_format
, NULL
, &addr_size_cells
);
614 static void check_avoid_default_addr_size(struct check
*c
, struct node
*dt
,
617 struct property
*reg
, *ranges
;
620 return; /* Ignore root node */
622 reg
= get_property(node
, "reg");
623 ranges
= get_property(node
, "ranges");
628 if (node
->parent
->addr_cells
== -1)
629 FAIL(c
, "Relying on default #address-cells value for %s",
632 if (node
->parent
->size_cells
== -1)
633 FAIL(c
, "Relying on default #size-cells value for %s",
636 NODE_WARNING(avoid_default_addr_size
, NULL
, &addr_size_cells
);
638 static void check_obsolete_chosen_interrupt_controller(struct check
*c
,
642 struct property
*prop
;
644 chosen
= get_node_by_path(dt
, "/chosen");
648 prop
= get_property(chosen
, "interrupt-controller");
650 FAIL(c
, "/chosen has obsolete \"interrupt-controller\" "
653 TREE_WARNING(obsolete_chosen_interrupt_controller
, NULL
);
655 static struct check
*check_table
[] = {
656 &duplicate_node_names
, &duplicate_property_names
,
657 &node_name_chars
, &node_name_format
, &property_name_chars
,
658 &name_is_string
, &name_properties
,
663 &phandle_references
, &path_references
,
665 &address_cells_is_cell
, &size_cells_is_cell
, &interrupt_cells_is_cell
,
666 &device_type_is_string
, &model_is_string
, &status_is_string
,
668 &addr_size_cells
, ®_format
, &ranges_format
,
670 &avoid_default_addr_size
,
671 &obsolete_chosen_interrupt_controller
,
676 static void enable_warning_error(struct check
*c
, bool warn
, bool error
)
680 /* Raising level, also raise it for prereqs */
681 if ((warn
&& !c
->warn
) || (error
&& !c
->error
))
682 for (i
= 0; i
< c
->num_prereqs
; i
++)
683 enable_warning_error(c
->prereq
[i
], warn
, error
);
685 c
->warn
= c
->warn
|| warn
;
686 c
->error
= c
->error
|| error
;
689 static void disable_warning_error(struct check
*c
, bool warn
, bool error
)
693 /* Lowering level, also lower it for things this is the prereq
695 if ((warn
&& c
->warn
) || (error
&& c
->error
)) {
696 for (i
= 0; i
< ARRAY_SIZE(check_table
); i
++) {
697 struct check
*cc
= check_table
[i
];
700 for (j
= 0; j
< cc
->num_prereqs
; j
++)
701 if (cc
->prereq
[j
] == c
)
702 disable_warning_error(cc
, warn
, error
);
706 c
->warn
= c
->warn
&& !warn
;
707 c
->error
= c
->error
&& !error
;
710 void parse_checks_option(bool warn
, bool error
, const char *arg
)
713 const char *name
= arg
;
716 if ((strncmp(arg
, "no-", 3) == 0)
717 || (strncmp(arg
, "no_", 3) == 0)) {
722 for (i
= 0; i
< ARRAY_SIZE(check_table
); i
++) {
723 struct check
*c
= check_table
[i
];
725 if (streq(c
->name
, name
)) {
727 enable_warning_error(c
, warn
, error
);
729 disable_warning_error(c
, warn
, error
);
734 die("Unrecognized check name \"%s\"\n", name
);
737 void process_checks(bool force
, struct boot_info
*bi
)
739 struct node
*dt
= bi
->dt
;
743 for (i
= 0; i
< ARRAY_SIZE(check_table
); i
++) {
744 struct check
*c
= check_table
[i
];
746 if (c
->warn
|| c
->error
)
747 error
= error
|| run_check(c
, dt
);
752 fprintf(stderr
, "ERROR: Input tree has errors, aborting "
753 "(use -f to force output)\n");
755 } else if (quiet
< 3) {
756 fprintf(stderr
, "Warning: Input tree has errors, "