linux/scripts/dtc/checks.c
<<
>>
Prefs
   1/*
   2 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation.  2007.
   3 *
   4 *
   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.
   9 *
  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.
  14 *
  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
  18 *                                                                   USA
  19 */
  20
  21#include "dtc.h"
  22
  23#ifdef TRACE_CHECKS
  24#define TRACE(c, ...) \
  25        do { \
  26                fprintf(stderr, "=== %s: ", (c)->name); \
  27                fprintf(stderr, __VA_ARGS__); \
  28                fprintf(stderr, "\n"); \
  29        } while (0)
  30#else
  31#define TRACE(c, fmt, ...)      do { } while (0)
  32#endif
  33
  34enum checkstatus {
  35        UNCHECKED = 0,
  36        PREREQ,
  37        PASSED,
  38        FAILED,
  39};
  40
  41struct check;
  42
  43typedef void (*check_fn)(struct check *c, struct dt_info *dti, struct node *node);
  44
  45struct check {
  46        const char *name;
  47        check_fn fn;
  48        void *data;
  49        bool warn, error;
  50        enum checkstatus status;
  51        bool inprogress;
  52        int num_prereqs;
  53        struct check **prereq;
  54};
  55
  56#define CHECK_ENTRY(nm_, fn_, d_, w_, e_, ...)         \
  57        static struct check *nm_##_prereqs[] = { __VA_ARGS__ }; \
  58        static struct check nm_ = { \
  59                .name = #nm_, \
  60                .fn = (fn_), \
  61                .data = (d_), \
  62                .warn = (w_), \
  63                .error = (e_), \
  64                .status = UNCHECKED, \
  65                .num_prereqs = ARRAY_SIZE(nm_##_prereqs), \
  66                .prereq = nm_##_prereqs, \
  67        };
  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__)
  74
  75static inline void  PRINTF(5, 6) check_msg(struct check *c, struct dt_info *dti,
  76                                           struct node *node,
  77                                           struct property *prop,
  78                                           const char *fmt, ...)
  79{
  80        va_list ap;
  81        va_start(ap, fmt);
  82
  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);
  88                if (node) {
  89                        fprintf(stderr, "%s", node->fullpath);
  90                        if (prop)
  91                                fprintf(stderr, ":%s", prop->name);
  92                        fputs(": ", stderr);
  93                }
  94                vfprintf(stderr, fmt, ap);
  95                fprintf(stderr, "\n");
  96        }
  97        va_end(ap);
  98}
  99
 100#define FAIL(c, dti, node, ...)                                         \
 101        do {                                                            \
 102                TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__);  \
 103                (c)->status = FAILED;                                   \
 104                check_msg((c), dti, node, NULL, __VA_ARGS__);           \
 105        } while (0)
 106
 107#define FAIL_PROP(c, dti, node, prop, ...)                              \
 108        do {                                                            \
 109                TRACE((c), "\t\tFAILED at %s:%d", __FILE__, __LINE__);  \
 110                (c)->status = FAILED;                                   \
 111                check_msg((c), dti, node, prop, __VA_ARGS__);           \
 112        } while (0)
 113
 114
 115static void check_nodes_props(struct check *c, struct dt_info *dti, struct node *node)
 116{
 117        struct node *child;
 118
 119        TRACE(c, "%s", node->fullpath);
 120        if (c->fn)
 121                c->fn(c, dti, node);
 122
 123        for_each_child(node, child)
 124                check_nodes_props(c, dti, child);
 125}
 126
 127static bool run_check(struct check *c, struct dt_info *dti)
 128{
 129        struct node *dt = dti->dt;
 130        bool error = false;
 131        int i;
 132
 133        assert(!c->inprogress);
 134
 135        if (c->status != UNCHECKED)
 136                goto out;
 137
 138        c->inprogress = true;
 139
 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) {
 144                        c->status = PREREQ;
 145                        check_msg(c, dti, NULL, NULL, "Failed prerequisite '%s'",
 146                                  c->prereq[i]->name);
 147                }
 148        }
 149
 150        if (c->status != UNCHECKED)
 151                goto out;
 152
 153        check_nodes_props(c, dti, dt);
 154
 155        if (c->status == UNCHECKED)
 156                c->status = PASSED;
 157
 158        TRACE(c, "\tCompleted, status %d", c->status);
 159
 160out:
 161        c->inprogress = false;
 162        if ((c->status != PASSED) && (c->error))
 163                error = true;
 164        return error;
 165}
 166
 167/*
 168 * Utility check functions
 169 */
 170
 171/* A check which always fails, for testing purposes only */
 172static inline void check_always_fail(struct check *c, struct dt_info *dti,
 173                                     struct node *node)
 174{
 175        FAIL(c, dti, node, "always_fail check");
 176}
 177CHECK(always_fail, check_always_fail, NULL);
 178
 179static void check_is_string(struct check *c, struct dt_info *dti,
 180                            struct node *node)
 181{
 182        struct property *prop;
 183        char *propname = c->data;
 184
 185        prop = get_property(node, propname);
 186        if (!prop)
 187                return; /* Not present, assumed ok */
 188
 189        if (!data_is_one_string(prop->val))
 190                FAIL_PROP(c, dti, node, prop, "property is not a string");
 191}
 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))
 196
 197static void check_is_string_list(struct check *c, struct dt_info *dti,
 198                                 struct node *node)
 199{
 200        int rem, l;
 201        struct property *prop;
 202        char *propname = c->data;
 203        char *str;
 204
 205        prop = get_property(node, propname);
 206        if (!prop)
 207                return; /* Not present, assumed ok */
 208
 209        str = prop->val.val;
 210        rem = prop->val.len;
 211        while (rem > 0) {
 212                l = strnlen(str, rem);
 213                if (l == rem) {
 214                        FAIL_PROP(c, dti, node, prop, "property is not a string list");
 215                        break;
 216                }
 217                rem -= l + 1;
 218                str += l + 1;
 219        }
 220}
 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))
 225
 226static void check_is_cell(struct check *c, struct dt_info *dti,
 227                          struct node *node)
 228{
 229        struct property *prop;
 230        char *propname = c->data;
 231
 232        prop = get_property(node, propname);
 233        if (!prop)
 234                return; /* Not present, assumed ok */
 235
 236        if (prop->val.len != sizeof(cell_t))
 237                FAIL_PROP(c, dti, node, prop, "property is not a single cell");
 238}
 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))
 243
 244/*
 245 * Structural check functions
 246 */
 247
 248static void check_duplicate_node_names(struct check *c, struct dt_info *dti,
 249                                       struct node *node)
 250{
 251        struct node *child, *child2;
 252
 253        for_each_child(node, child)
 254                for (child2 = child->next_sibling;
 255                     child2;
 256                     child2 = child2->next_sibling)
 257                        if (streq(child->name, child2->name))
 258                                FAIL(c, dti, child2, "Duplicate node name");
 259}
 260ERROR(duplicate_node_names, check_duplicate_node_names, NULL);
 261
 262static void check_duplicate_property_names(struct check *c, struct dt_info *dti,
 263                                           struct node *node)
 264{
 265        struct property *prop, *prop2;
 266
 267        for_each_property(node, prop) {
 268                for (prop2 = prop->next; prop2; prop2 = prop2->next) {
 269                        if (prop2->deleted)
 270                                continue;
 271                        if (streq(prop->name, prop2->name))
 272                                FAIL_PROP(c, dti, node, prop, "Duplicate property name");
 273                }
 274        }
 275}
 276ERROR(duplicate_property_names, check_duplicate_property_names, NULL);
 277
 278#define LOWERCASE       "abcdefghijklmnopqrstuvwxyz"
 279#define UPPERCASE       "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 280#define DIGITS          "0123456789"
 281#define PROPNODECHARS   LOWERCASE UPPERCASE DIGITS ",._+*#?-"
 282#define PROPNODECHARSSTRICT     LOWERCASE UPPERCASE DIGITS ",-"
 283
 284static void check_node_name_chars(struct check *c, struct dt_info *dti,
 285                                  struct node *node)
 286{
 287        int n = strspn(node->name, c->data);
 288
 289        if (n < strlen(node->name))
 290                FAIL(c, dti, node, "Bad character '%c' in node name",
 291                     node->name[n]);
 292}
 293ERROR(node_name_chars, check_node_name_chars, PROPNODECHARS "@");
 294
 295static void check_node_name_chars_strict(struct check *c, struct dt_info *dti,
 296                                         struct node *node)
 297{
 298        int n = strspn(node->name, c->data);
 299
 300        if (n < node->basenamelen)
 301                FAIL(c, dti, node, "Character '%c' not recommended in node name",
 302                     node->name[n]);
 303}
 304CHECK(node_name_chars_strict, check_node_name_chars_strict, PROPNODECHARSSTRICT);
 305
 306static void check_node_name_format(struct check *c, struct dt_info *dti,
 307                                   struct node *node)
 308{
 309        if (strchr(get_unitname(node), '@'))
 310                FAIL(c, dti, node, "multiple '@' characters in node name");
 311}
 312ERROR(node_name_format, check_node_name_format, NULL, &node_name_chars);
 313
 314static void check_unit_address_vs_reg(struct check *c, struct dt_info *dti,
 315                                      struct node *node)
 316{
 317        const char *unitname = get_unitname(node);
 318        struct property *prop = get_property(node, "reg");
 319
 320        if (get_subnode(node, "__overlay__")) {
 321                /* HACK: Overlay fragments are a special case */
 322                return;
 323        }
 324
 325        if (!prop) {
 326                prop = get_property(node, "ranges");
 327                if (prop && !prop->val.len)
 328                        prop = NULL;
 329        }
 330
 331        if (prop) {
 332                if (!unitname[0])
 333                        FAIL(c, dti, node, "node has a reg or ranges property, but no unit name");
 334        } else {
 335                if (unitname[0])
 336                        FAIL(c, dti, node, "node has a unit name, but no reg property");
 337        }
 338}
 339WARNING(unit_address_vs_reg, check_unit_address_vs_reg, NULL);
 340
 341static void check_property_name_chars(struct check *c, struct dt_info *dti,
 342                                      struct node *node)
 343{
 344        struct property *prop;
 345
 346        for_each_property(node, prop) {
 347                int n = strspn(prop->name, c->data);
 348
 349                if (n < strlen(prop->name))
 350                        FAIL_PROP(c, dti, node, prop, "Bad character '%c' in property name",
 351                                  prop->name[n]);
 352        }
 353}
 354ERROR(property_name_chars, check_property_name_chars, PROPNODECHARS);
 355
 356static void check_property_name_chars_strict(struct check *c,
 357                                             struct dt_info *dti,
 358                                             struct node *node)
 359{
 360        struct property *prop;
 361
 362        for_each_property(node, prop) {
 363                const char *name = prop->name;
 364                int n = strspn(name, c->data);
 365
 366                if (n == strlen(prop->name))
 367                        continue;
 368
 369                /* Certain names are whitelisted */
 370                if (streq(name, "device_type"))
 371                        continue;
 372
 373                /*
 374                 * # is only allowed at the beginning of property names not counting
 375                 * the vendor prefix.
 376                 */
 377                if (name[n] == '#' && ((n == 0) || (name[n-1] == ','))) {
 378                        name += n + 1;
 379                        n = strspn(name, c->data);
 380                }
 381                if (n < strlen(name))
 382                        FAIL_PROP(c, dti, node, prop, "Character '%c' not recommended in property name",
 383                                  name[n]);
 384        }
 385}
 386CHECK(property_name_chars_strict, check_property_name_chars_strict, PROPNODECHARSSTRICT);
 387
 388#define DESCLABEL_FMT   "%s%s%s%s%s"
 389#define DESCLABEL_ARGS(node,prop,mark)          \
 390        ((mark) ? "value of " : ""),            \
 391        ((prop) ? "'" : ""), \
 392        ((prop) ? (prop)->name : ""), \
 393        ((prop) ? "' in " : ""), (node)->fullpath
 394
 395static void check_duplicate_label(struct check *c, struct dt_info *dti,
 396                                  const char *label, struct node *node,
 397                                  struct property *prop, struct marker *mark)
 398{
 399        struct node *dt = dti->dt;
 400        struct node *othernode = NULL;
 401        struct property *otherprop = NULL;
 402        struct marker *othermark = NULL;
 403
 404        othernode = get_node_by_label(dt, label);
 405
 406        if (!othernode)
 407                otherprop = get_property_by_label(dt, label, &othernode);
 408        if (!othernode)
 409                othermark = get_marker_label(dt, label, &othernode,
 410                                               &otherprop);
 411
 412        if (!othernode)
 413                return;
 414
 415        if ((othernode != node) || (otherprop != prop) || (othermark != mark))
 416                FAIL(c, dti, node, "Duplicate label '%s' on " DESCLABEL_FMT
 417                     " and " DESCLABEL_FMT,
 418                     label, DESCLABEL_ARGS(node, prop, mark),
 419                     DESCLABEL_ARGS(othernode, otherprop, othermark));
 420}
 421
 422static void check_duplicate_label_node(struct check *c, struct dt_info *dti,
 423                                       struct node *node)
 424{
 425        struct label *l;
 426        struct property *prop;
 427
 428        for_each_label(node->labels, l)
 429                check_duplicate_label(c, dti, l->label, node, NULL, NULL);
 430
 431        for_each_property(node, prop) {
 432                struct marker *m = prop->val.markers;
 433
 434                for_each_label(prop->labels, l)
 435                        check_duplicate_label(c, dti, l->label, node, prop, NULL);
 436
 437                for_each_marker_of_type(m, LABEL)
 438                        check_duplicate_label(c, dti, m->ref, node, prop, m);
 439        }
 440}
 441ERROR(duplicate_label, check_duplicate_label_node, NULL);
 442
 443static cell_t check_phandle_prop(struct check *c, struct dt_info *dti,
 444                                 struct node *node, const char *propname)
 445{
 446        struct node *root = dti->dt;
 447        struct property *prop;
 448        struct marker *m;
 449        cell_t phandle;
 450
 451        prop = get_property(node, propname);
 452        if (!prop)
 453                return 0;
 454
 455        if (prop->val.len != sizeof(cell_t)) {
 456                FAIL_PROP(c, dti, node, prop, "bad length (%d) %s property",
 457                          prop->val.len, prop->name);
 458                return 0;
 459        }
 460
 461        m = prop->val.markers;
 462        for_each_marker_of_type(m, REF_PHANDLE) {
 463                assert(m->offset == 0);
 464                if (node != get_node_by_ref(root, m->ref))
 465                        /* "Set this node's phandle equal to some
 466                         * other node's phandle".  That's nonsensical
 467                         * by construction. */ {
 468                        FAIL(c, dti, node, "%s is a reference to another node",
 469                             prop->name);
 470                }
 471                /* But setting this node's phandle equal to its own
 472                 * phandle is allowed - that means allocate a unique
 473                 * phandle for this node, even if it's not otherwise
 474                 * referenced.  The value will be filled in later, so
 475                 * we treat it as having no phandle data for now. */
 476                return 0;
 477        }
 478
 479        phandle = propval_cell(prop);
 480
 481        if ((phandle == 0) || (phandle == -1)) {
 482                FAIL_PROP(c, dti, node, prop, "bad value (0x%x) in %s property",
 483                     phandle, prop->name);
 484                return 0;
 485        }
 486
 487        return phandle;
 488}
 489
 490static void check_explicit_phandles(struct check *c, struct dt_info *dti,
 491                                    struct node *node)
 492{
 493        struct node *root = dti->dt;
 494        struct node *other;
 495        cell_t phandle, linux_phandle;
 496
 497        /* Nothing should have assigned phandles yet */
 498        assert(!node->phandle);
 499
 500        phandle = check_phandle_prop(c, dti, node, "phandle");
 501
 502        linux_phandle = check_phandle_prop(c, dti, node, "linux,phandle");
 503
 504        if (!phandle && !linux_phandle)
 505                /* No valid phandles; nothing further to check */
 506                return;
 507
 508        if (linux_phandle && phandle && (phandle != linux_phandle))
 509                FAIL(c, dti, node, "mismatching 'phandle' and 'linux,phandle'"
 510                     " properties");
 511
 512        if (linux_phandle && !phandle)
 513                phandle = linux_phandle;
 514
 515        other = get_node_by_phandle(root, phandle);
 516        if (other && (other != node)) {
 517                FAIL(c, dti, node, "duplicated phandle 0x%x (seen before at %s)",
 518                     phandle, other->fullpath);
 519                return;
 520        }
 521
 522        node->phandle = phandle;
 523}
 524ERROR(explicit_phandles, check_explicit_phandles, NULL);
 525
 526static void check_name_properties(struct check *c, struct dt_info *dti,
 527                                  struct node *node)
 528{
 529        struct property **pp, *prop = NULL;
 530
 531        for (pp = &node->proplist; *pp; pp = &((*pp)->next))
 532                if (streq((*pp)->name, "name")) {
 533                        prop = *pp;
 534                        break;
 535                }
 536
 537        if (!prop)
 538                return; /* No name property, that's fine */
 539
 540        if ((prop->val.len != node->basenamelen+1)
 541            || (memcmp(prop->val.val, node->name, node->basenamelen) != 0)) {
 542                FAIL(c, dti, node, "\"name\" property is incorrect (\"%s\" instead"
 543                     " of base node name)", prop->val.val);
 544        } else {
 545                /* The name property is correct, and therefore redundant.
 546                 * Delete it */
 547                *pp = prop->next;
 548                free(prop->name);
 549                data_free(prop->val);
 550                free(prop);
 551        }
 552}
 553ERROR_IF_NOT_STRING(name_is_string, "name");
 554ERROR(name_properties, check_name_properties, NULL, &name_is_string);
 555
 556/*
 557 * Reference fixup functions
 558 */
 559
 560static void fixup_phandle_references(struct check *c, struct dt_info *dti,
 561                                     struct node *node)
 562{
 563        struct node *dt = dti->dt;
 564        struct property *prop;
 565
 566        for_each_property(node, prop) {
 567                struct marker *m = prop->val.markers;
 568                struct node *refnode;
 569                cell_t phandle;
 570
 571                for_each_marker_of_type(m, REF_PHANDLE) {
 572                        assert(m->offset + sizeof(cell_t) <= prop->val.len);
 573
 574                        refnode = get_node_by_ref(dt, m->ref);
 575                        if (! refnode) {
 576                                if (!(dti->dtsflags & DTSF_PLUGIN))
 577                                        FAIL(c, dti, node, "Reference to non-existent node or "
 578                                                        "label \"%s\"\n", m->ref);
 579                                else /* mark the entry as unresolved */
 580                                        *((fdt32_t *)(prop->val.val + m->offset)) =
 581                                                cpu_to_fdt32(0xffffffff);
 582                                continue;
 583                        }
 584
 585                        phandle = get_node_phandle(dt, refnode);
 586                        *((fdt32_t *)(prop->val.val + m->offset)) = cpu_to_fdt32(phandle);
 587
 588                        reference_node(refnode);
 589                }
 590        }
 591}
 592ERROR(phandle_references, fixup_phandle_references, NULL,
 593      &duplicate_node_names, &explicit_phandles);
 594
 595static void fixup_path_references(struct check *c, struct dt_info *dti,
 596                                  struct node *node)
 597{
 598        struct node *dt = dti->dt;
 599        struct property *prop;
 600
 601        for_each_property(node, prop) {
 602                struct marker *m = prop->val.markers;
 603                struct node *refnode;
 604                char *path;
 605
 606                for_each_marker_of_type(m, REF_PATH) {
 607                        assert(m->offset <= prop->val.len);
 608
 609                        refnode = get_node_by_ref(dt, m->ref);
 610                        if (!refnode) {
 611                                FAIL(c, dti, node, "Reference to non-existent node or label \"%s\"\n",
 612                                     m->ref);
 613                                continue;
 614                        }
 615
 616                        path = refnode->fullpath;
 617                        prop->val = data_insert_at_marker(prop->val, m, path,
 618                                                          strlen(path) + 1);
 619
 620                        reference_node(refnode);
 621                }
 622        }
 623}
 624ERROR(path_references, fixup_path_references, NULL, &duplicate_node_names);
 625
 626static void fixup_omit_unused_nodes(struct check *c, struct dt_info *dti,
 627                                    struct node *node)
 628{
 629        if (node->omit_if_unused && !node->is_referenced)
 630                delete_node(node);
 631}
 632ERROR(omit_unused_nodes, fixup_omit_unused_nodes, NULL, &phandle_references, &path_references);
 633
 634/*
 635 * Semantic checks
 636 */
 637WARNING_IF_NOT_CELL(address_cells_is_cell, "#address-cells");
 638WARNING_IF_NOT_CELL(size_cells_is_cell, "#size-cells");
 639WARNING_IF_NOT_CELL(interrupt_cells_is_cell, "#interrupt-cells");
 640
 641WARNING_IF_NOT_STRING(device_type_is_string, "device_type");
 642WARNING_IF_NOT_STRING(model_is_string, "model");
 643WARNING_IF_NOT_STRING(status_is_string, "status");
 644WARNING_IF_NOT_STRING(label_is_string, "label");
 645
 646WARNING_IF_NOT_STRING_LIST(compatible_is_string_list, "compatible");
 647
 648static void check_names_is_string_list(struct check *c, struct dt_info *dti,
 649                                       struct node *node)
 650{
 651        struct property *prop;
 652
 653        for_each_property(node, prop) {
 654                const char *s = strrchr(prop->name, '-');
 655                if (!s || !streq(s, "-names"))
 656                        continue;
 657
 658                c->data = prop->name;
 659                check_is_string_list(c, dti, node);
 660        }
 661}
 662WARNING(names_is_string_list, check_names_is_string_list, NULL);
 663
 664static void check_alias_paths(struct check *c, struct dt_info *dti,
 665                                    struct node *node)
 666{
 667        struct property *prop;
 668
 669        if (!streq(node->name, "aliases"))
 670                return;
 671
 672        for_each_property(node, prop) {
 673                if (!prop->val.val || !get_node_by_path(dti->dt, prop->val.val)) {
 674                        FAIL_PROP(c, dti, node, prop, "aliases property is not a valid node (%s)",
 675                                  prop->val.val);
 676                        continue;
 677                }
 678                if (strspn(prop->name, LOWERCASE DIGITS "-") != strlen(prop->name))
 679                        FAIL(c, dti, node, "aliases property name must include only lowercase and '-'");
 680        }
 681}
 682WARNING(alias_paths, check_alias_paths, NULL);
 683
 684static void fixup_addr_size_cells(struct check *c, struct dt_info *dti,
 685                                  struct node *node)
 686{
 687        struct property *prop;
 688
 689        node->addr_cells = -1;
 690        node->size_cells = -1;
 691
 692        prop = get_property(node, "#address-cells");
 693        if (prop)
 694                node->addr_cells = propval_cell(prop);
 695
 696        prop = get_property(node, "#size-cells");
 697        if (prop)
 698                node->size_cells = propval_cell(prop);
 699}
 700WARNING(addr_size_cells, fixup_addr_size_cells, NULL,
 701        &address_cells_is_cell, &size_cells_is_cell);
 702
 703#define node_addr_cells(n) \
 704        (((n)->addr_cells == -1) ? 2 : (n)->addr_cells)
 705#define node_size_cells(n) \
 706        (((n)->size_cells == -1) ? 1 : (n)->size_cells)
 707
 708static void check_reg_format(struct check *c, struct dt_info *dti,
 709                             struct node *node)
 710{
 711        struct property *prop;
 712        int addr_cells, size_cells, entrylen;
 713
 714        prop = get_property(node, "reg");
 715        if (!prop)
 716                return; /* No "reg", that's fine */
 717
 718        if (!node->parent) {
 719                FAIL(c, dti, node, "Root node has a \"reg\" property");
 720                return;
 721        }
 722
 723        if (prop->val.len == 0)
 724                FAIL_PROP(c, dti, node, prop, "property is empty");
 725
 726        addr_cells = node_addr_cells(node->parent);
 727        size_cells = node_size_cells(node->parent);
 728        entrylen = (addr_cells + size_cells) * sizeof(cell_t);
 729
 730        if (!entrylen || (prop->val.len % entrylen) != 0)
 731                FAIL_PROP(c, dti, node, prop, "property has invalid length (%d bytes) "
 732                          "(#address-cells == %d, #size-cells == %d)",
 733                          prop->val.len, addr_cells, size_cells);
 734}
 735WARNING(reg_format, check_reg_format, NULL, &addr_size_cells);
 736
 737static void check_ranges_format(struct check *c, struct dt_info *dti,
 738                                struct node *node)
 739{
 740        struct property *prop;
 741        int c_addr_cells, p_addr_cells, c_size_cells, p_size_cells, entrylen;
 742
 743        prop = get_property(node, "ranges");
 744        if (!prop)
 745                return;
 746
 747        if (!node->parent) {
 748                FAIL_PROP(c, dti, node, prop, "Root node has a \"ranges\" property");
 749                return;
 750        }
 751
 752        p_addr_cells = node_addr_cells(node->parent);
 753        p_size_cells = node_size_cells(node->parent);
 754        c_addr_cells = node_addr_cells(node);
 755        c_size_cells = node_size_cells(node);
 756        entrylen = (p_addr_cells + c_addr_cells + c_size_cells) * sizeof(cell_t);
 757
 758        if (prop->val.len == 0) {
 759                if (p_addr_cells != c_addr_cells)
 760                        FAIL_PROP(c, dti, node, prop, "empty \"ranges\" property but its "
 761                                  "#address-cells (%d) differs from %s (%d)",
 762                                  c_addr_cells, node->parent->fullpath,
 763                                  p_addr_cells);
 764                if (p_size_cells != c_size_cells)
 765                        FAIL_PROP(c, dti, node, prop, "empty \"ranges\" property but its "
 766                                  "#size-cells (%d) differs from %s (%d)",
 767                                  c_size_cells, node->parent->fullpath,
 768                                  p_size_cells);
 769        } else if ((prop->val.len % entrylen) != 0) {
 770                FAIL_PROP(c, dti, node, prop, "\"ranges\" property has invalid length (%d bytes) "
 771                          "(parent #address-cells == %d, child #address-cells == %d, "
 772                          "#size-cells == %d)", prop->val.len,
 773                          p_addr_cells, c_addr_cells, c_size_cells);
 774        }
 775}
 776WARNING(ranges_format, check_ranges_format, NULL, &addr_size_cells);
 777
 778static const struct bus_type pci_bus = {
 779        .name = "PCI",
 780};
 781
 782static void check_pci_bridge(struct check *c, struct dt_info *dti, struct node *node)
 783{
 784        struct property *prop;
 785        cell_t *cells;
 786
 787        prop = get_property(node, "device_type");
 788        if (!prop || !streq(prop->val.val, "pci"))
 789                return;
 790
 791        node->bus = &pci_bus;
 792
 793        if (!strprefixeq(node->name, node->basenamelen, "pci") &&
 794            !strprefixeq(node->name, node->basenamelen, "pcie"))
 795                FAIL(c, dti, node, "node name is not \"pci\" or \"pcie\"");
 796
 797        prop = get_property(node, "ranges");
 798        if (!prop)
 799                FAIL(c, dti, node, "missing ranges for PCI bridge (or not a bridge)");
 800
 801        if (node_addr_cells(node) != 3)
 802                FAIL(c, dti, node, "incorrect #address-cells for PCI bridge");
 803        if (node_size_cells(node) != 2)
 804                FAIL(c, dti, node, "incorrect #size-cells for PCI bridge");
 805
 806        prop = get_property(node, "bus-range");
 807        if (!prop)
 808                return;
 809
 810        if (prop->val.len != (sizeof(cell_t) * 2)) {
 811                FAIL_PROP(c, dti, node, prop, "value must be 2 cells");
 812                return;
 813        }
 814        cells = (cell_t *)prop->val.val;
 815        if (fdt32_to_cpu(cells[0]) > fdt32_to_cpu(cells[1]))
 816                FAIL_PROP(c, dti, node, prop, "1st cell must be less than or equal to 2nd cell");
 817        if (fdt32_to_cpu(cells[1]) > 0xff)
 818                FAIL_PROP(c, dti, node, prop, "maximum bus number must be less than 256");
 819}
 820WARNING(pci_bridge, check_pci_bridge, NULL,
 821        &device_type_is_string, &addr_size_cells);
 822
 823static void check_pci_device_bus_num(struct check *c, struct dt_info *dti, struct node *node)
 824{
 825        struct property *prop;
 826        unsigned int bus_num, min_bus, max_bus;
 827        cell_t *cells;
 828
 829        if (!node->parent || (node->parent->bus != &pci_bus))
 830                return;
 831
 832        prop = get_property(node, "reg");
 833        if (!prop)
 834                return;
 835
 836        cells = (cell_t *)prop->val.val;
 837        bus_num = (fdt32_to_cpu(cells[0]) & 0x00ff0000) >> 16;
 838
 839        prop = get_property(node->parent, "bus-range");
 840        if (!prop) {
 841                min_bus = max_bus = 0;
 842        } else {
 843                cells = (cell_t *)prop->val.val;
 844                min_bus = fdt32_to_cpu(cells[0]);
 845                max_bus = fdt32_to_cpu(cells[0]);
 846        }
 847        if ((bus_num < min_bus) || (bus_num > max_bus))
 848                FAIL_PROP(c, dti, node, prop, "PCI bus number %d out of range, expected (%d - %d)",
 849                          bus_num, min_bus, max_bus);
 850}
 851WARNING(pci_device_bus_num, check_pci_device_bus_num, NULL, &reg_format, &pci_bridge);
 852
 853static void check_pci_device_reg(struct check *c, struct dt_info *dti, struct node *node)
 854{
 855        struct property *prop;
 856        const char *unitname = get_unitname(node);
 857        char unit_addr[5];
 858        unsigned int dev, func, reg;
 859        cell_t *cells;
 860
 861        if (!node->parent || (node->parent->bus != &pci_bus))
 862                return;
 863
 864        prop = get_property(node, "reg");
 865        if (!prop) {
 866                FAIL(c, dti, node, "missing PCI reg property");
 867                return;
 868        }
 869
 870        cells = (cell_t *)prop->val.val;
 871        if (cells[1] || cells[2])
 872                FAIL_PROP(c, dti, node, prop, "PCI reg config space address cells 2 and 3 must be 0");
 873
 874        reg = fdt32_to_cpu(cells[0]);
 875        dev = (reg & 0xf800) >> 11;
 876        func = (reg & 0x700) >> 8;
 877
 878        if (reg & 0xff000000)
 879                FAIL_PROP(c, dti, node, prop, "PCI reg address is not configuration space");
 880        if (reg & 0x000000ff)
 881                FAIL_PROP(c, dti, node, prop, "PCI reg config space address register number must be 0");
 882
 883        if (func == 0) {
 884                snprintf(unit_addr, sizeof(unit_addr), "%x", dev);
 885                if (streq(unitname, unit_addr))
 886                        return;
 887        }
 888
 889        snprintf(unit_addr, sizeof(unit_addr), "%x,%x", dev, func);
 890        if (streq(unitname, unit_addr))
 891                return;
 892
 893        FAIL(c, dti, node, "PCI unit address format error, expected \"%s\"",
 894             unit_addr);
 895}
 896WARNING(pci_device_reg, check_pci_device_reg, NULL, &reg_format, &pci_bridge);
 897
 898static const struct bus_type simple_bus = {
 899        .name = "simple-bus",
 900};
 901
 902static bool node_is_compatible(struct node *node, const char *compat)
 903{
 904        struct property *prop;
 905        const char *str, *end;
 906
 907        prop = get_property(node, "compatible");
 908        if (!prop)
 909                return false;
 910
 911        for (str = prop->val.val, end = str + prop->val.len; str < end;
 912             str += strnlen(str, end - str) + 1) {
 913                if (strprefixeq(str, end - str, compat))
 914                        return true;
 915        }
 916        return false;
 917}
 918
 919static void check_simple_bus_bridge(struct check *c, struct dt_info *dti, struct node *node)
 920{
 921        if (node_is_compatible(node, "simple-bus"))
 922                node->bus = &simple_bus;
 923}
 924WARNING(simple_bus_bridge, check_simple_bus_bridge, NULL, &addr_size_cells);
 925
 926static void check_simple_bus_reg(struct check *c, struct dt_info *dti, struct node *node)
 927{
 928        struct property *prop;
 929        const char *unitname = get_unitname(node);
 930        char unit_addr[17];
 931        unsigned int size;
 932        uint64_t reg = 0;
 933        cell_t *cells = NULL;
 934
 935        if (!node->parent || (node->parent->bus != &simple_bus))
 936                return;
 937
 938        prop = get_property(node, "reg");
 939        if (prop)
 940                cells = (cell_t *)prop->val.val;
 941        else {
 942                prop = get_property(node, "ranges");
 943                if (prop && prop->val.len)
 944                        /* skip of child address */
 945                        cells = ((cell_t *)prop->val.val) + node_addr_cells(node);
 946        }
 947
 948        if (!cells) {
 949                if (node->parent->parent && !(node->bus == &simple_bus))
 950                        FAIL(c, dti, node, "missing or empty reg/ranges property");
 951                return;
 952        }
 953
 954        size = node_addr_cells(node->parent);
 955        while (size--)
 956                reg = (reg << 32) | fdt32_to_cpu(*(cells++));
 957
 958        snprintf(unit_addr, sizeof(unit_addr), "%"PRIx64, reg);
 959        if (!streq(unitname, unit_addr))
 960                FAIL(c, dti, node, "simple-bus unit address format error, expected \"%s\"",
 961                     unit_addr);
 962}
 963WARNING(simple_bus_reg, check_simple_bus_reg, NULL, &reg_format, &simple_bus_bridge);
 964
 965static void check_unit_address_format(struct check *c, struct dt_info *dti,
 966                                      struct node *node)
 967{
 968        const char *unitname = get_unitname(node);
 969
 970        if (node->parent && node->parent->bus)
 971                return;
 972
 973        if (!unitname[0])
 974                return;
 975
 976        if (!strncmp(unitname, "0x", 2)) {
 977                FAIL(c, dti, node, "unit name should not have leading \"0x\"");
 978                /* skip over 0x for next test */
 979                unitname += 2;
 980        }
 981        if (unitname[0] == '0' && isxdigit(unitname[1]))
 982                FAIL(c, dti, node, "unit name should not have leading 0s");
 983}
 984WARNING(unit_address_format, check_unit_address_format, NULL,
 985        &node_name_format, &pci_bridge, &simple_bus_bridge);
 986
 987/*
 988 * Style checks
 989 */
 990static void check_avoid_default_addr_size(struct check *c, struct dt_info *dti,
 991                                          struct node *node)
 992{
 993        struct property *reg, *ranges;
 994
 995        if (!node->parent)
 996                return; /* Ignore root node */
 997
 998        reg = get_property(node, "reg");
 999        ranges = get_property(node, "ranges");
1000
1001        if (!reg && !ranges)
1002                return;
1003
1004        if (node->parent->addr_cells == -1)
1005                FAIL(c, dti, node, "Relying on default #address-cells value");
1006
1007        if (node->parent->size_cells == -1)
1008                FAIL(c, dti, node, "Relying on default #size-cells value");
1009}
1010WARNING(avoid_default_addr_size, check_avoid_default_addr_size, NULL,
1011        &addr_size_cells);
1012
1013static void check_avoid_unnecessary_addr_size(struct check *c, struct dt_info *dti,
1014                                              struct node *node)
1015{
1016        struct property *prop;
1017        struct node *child;
1018        bool has_reg = false;
1019
1020        if (!node->parent || node->addr_cells < 0 || node->size_cells < 0)
1021                return;
1022
1023        if (get_property(node, "ranges") || !node->children)
1024                return;
1025
1026        for_each_child(node, child) {
1027                prop = get_property(child, "reg");
1028                if (prop)
1029                        has_reg = true;
1030        }
1031
1032        if (!has_reg)
1033                FAIL(c, dti, node, "unnecessary #address-cells/#size-cells without \"ranges\" or child \"reg\" property");
1034}
1035WARNING(avoid_unnecessary_addr_size, check_avoid_unnecessary_addr_size, NULL, &avoid_default_addr_size);
1036
1037static void check_unique_unit_address(struct check *c, struct dt_info *dti,
1038                                              struct node *node)
1039{
1040        struct node *childa;
1041
1042        if (node->addr_cells < 0 || node->size_cells < 0)
1043                return;
1044
1045        if (!node->children)
1046                return;
1047
1048        for_each_child(node, childa) {
1049                struct node *childb;
1050                const char *addr_a = get_unitname(childa);
1051
1052                if (!strlen(addr_a))
1053                        continue;
1054
1055                for_each_child(node, childb) {
1056                        const char *addr_b = get_unitname(childb);
1057                        if (childa == childb)
1058                                break;
1059
1060                        if (streq(addr_a, addr_b))
1061                                FAIL(c, dti, childb, "duplicate unit-address (also used in node %s)", childa->fullpath);
1062                }
1063        }
1064}
1065WARNING(unique_unit_address, check_unique_unit_address, NULL, &avoid_default_addr_size);
1066
1067static void check_obsolete_chosen_interrupt_controller(struct check *c,
1068                                                       struct dt_info *dti,
1069                                                       struct node *node)
1070{
1071        struct node *dt = dti->dt;
1072        struct node *chosen;
1073        struct property *prop;
1074
1075        if (node != dt)
1076                return;
1077
1078
1079        chosen = get_node_by_path(dt, "/chosen");
1080        if (!chosen)
1081                return;
1082
1083        prop = get_property(chosen, "interrupt-controller");
1084        if (prop)
1085                FAIL_PROP(c, dti, node, prop,
1086                          "/chosen has obsolete \"interrupt-controller\" property");
1087}
1088WARNING(obsolete_chosen_interrupt_controller,
1089        check_obsolete_chosen_interrupt_controller, NULL);
1090
1091static void check_chosen_node_is_root(struct check *c, struct dt_info *dti,
1092                                      struct node *node)
1093{
1094        if (!streq(node->name, "chosen"))
1095                return;
1096
1097        if (node->parent != dti->dt)
1098                FAIL(c, dti, node, "chosen node must be at root node");
1099}
1100WARNING(chosen_node_is_root, check_chosen_node_is_root, NULL);
1101
1102static void check_chosen_node_bootargs(struct check *c, struct dt_info *dti,
1103                                       struct node *node)
1104{
1105        struct property *prop;
1106
1107        if (!streq(node->name, "chosen"))
1108                return;
1109
1110        prop = get_property(node, "bootargs");
1111        if (!prop)
1112                return;
1113
1114        c->data = prop->name;
1115        check_is_string(c, dti, node);
1116}
1117WARNING(chosen_node_bootargs, check_chosen_node_bootargs, NULL);
1118
1119static void check_chosen_node_stdout_path(struct check *c, struct dt_info *dti,
1120                                          struct node *node)
1121{
1122        struct property *prop;
1123
1124        if (!streq(node->name, "chosen"))
1125                return;
1126
1127        prop = get_property(node, "stdout-path");
1128        if (!prop) {
1129                prop = get_property(node, "linux,stdout-path");
1130                if (!prop)
1131                        return;
1132                FAIL_PROP(c, dti, node, prop, "Use 'stdout-path' instead");
1133        }
1134
1135        c->data = prop->name;
1136        check_is_string(c, dti, node);
1137}
1138WARNING(chosen_node_stdout_path, check_chosen_node_stdout_path, NULL);
1139
1140struct provider {
1141        const char *prop_name;
1142        const char *cell_name;
1143        bool optional;
1144};
1145
1146static void check_property_phandle_args(struct check *c,
1147                                          struct dt_info *dti,
1148                                          struct node *node,
1149                                          struct property *prop,
1150                                          const struct provider *provider)
1151{
1152        struct node *root = dti->dt;
1153        int cell, cellsize = 0;
1154
1155        if (prop->val.len % sizeof(cell_t)) {
1156                FAIL_PROP(c, dti, node, prop,
1157                          "property size (%d) is invalid, expected multiple of %zu",
1158                          prop->val.len, sizeof(cell_t));
1159                return;
1160        }
1161
1162        for (cell = 0; cell < prop->val.len / sizeof(cell_t); cell += cellsize + 1) {
1163                struct node *provider_node;
1164                struct property *cellprop;
1165                int phandle;
1166
1167                phandle = propval_cell_n(prop, cell);
1168                /*
1169                 * Some bindings use a cell value 0 or -1 to skip over optional
1170                 * entries when each index position has a specific definition.
1171                 */
1172                if (phandle == 0 || phandle == -1) {
1173                        /* Give up if this is an overlay with external references */
1174                        if (dti->dtsflags & DTSF_PLUGIN)
1175                                break;
1176
1177                        cellsize = 0;
1178                        continue;
1179                }
1180
1181                /* If we have markers, verify the current cell is a phandle */
1182                if (prop->val.markers) {
1183                        struct marker *m = prop->val.markers;
1184                        for_each_marker_of_type(m, REF_PHANDLE) {
1185                                if (m->offset == (cell * sizeof(cell_t)))
1186                                        break;
1187                        }
1188                        if (!m)
1189                                FAIL_PROP(c, dti, node, prop,
1190                                          "cell %d is not a phandle reference",
1191                                          cell);
1192                }
1193
1194                provider_node = get_node_by_phandle(root, phandle);
1195                if (!provider_node) {
1196                        FAIL_PROP(c, dti, node, prop,
1197                                  "Could not get phandle node for (cell %d)",
1198                                  cell);
1199                        break;
1200                }
1201
1202                cellprop = get_property(provider_node, provider->cell_name);
1203                if (cellprop) {
1204                        cellsize = propval_cell(cellprop);
1205                } else if (provider->optional) {
1206                        cellsize = 0;
1207                } else {
1208                        FAIL(c, dti, node, "Missing property '%s' in node %s or bad phandle (referred from %s[%d])",
1209                             provider->cell_name,
1210                             provider_node->fullpath,
1211                             prop->name, cell);
1212                        break;
1213                }
1214
1215                if (prop->val.len < ((cell + cellsize + 1) * sizeof(cell_t))) {
1216                        FAIL_PROP(c, dti, node, prop,
1217                                  "property size (%d) too small for cell size %d",
1218                                  prop->val.len, cellsize);
1219                }
1220        }
1221}
1222
1223static void check_provider_cells_property(struct check *c,
1224                                          struct dt_info *dti,
1225                                          struct node *node)
1226{
1227        struct provider *provider = c->data;
1228        struct property *prop;
1229
1230        prop = get_property(node, provider->prop_name);
1231        if (!prop)
1232                return;
1233
1234        check_property_phandle_args(c, dti, node, prop, provider);
1235}
1236#define WARNING_PROPERTY_PHANDLE_CELLS(nm, propname, cells_name, ...) \
1237        static struct provider nm##_provider = { (propname), (cells_name), __VA_ARGS__ }; \
1238        WARNING(nm##_property, check_provider_cells_property, &nm##_provider, &phandle_references);
1239
1240WARNING_PROPERTY_PHANDLE_CELLS(clocks, "clocks", "#clock-cells");
1241WARNING_PROPERTY_PHANDLE_CELLS(cooling_device, "cooling-device", "#cooling-cells");
1242WARNING_PROPERTY_PHANDLE_CELLS(dmas, "dmas", "#dma-cells");
1243WARNING_PROPERTY_PHANDLE_CELLS(hwlocks, "hwlocks", "#hwlock-cells");
1244WARNING_PROPERTY_PHANDLE_CELLS(interrupts_extended, "interrupts-extended", "#interrupt-cells");
1245WARNING_PROPERTY_PHANDLE_CELLS(io_channels, "io-channels", "#io-channel-cells");
1246WARNING_PROPERTY_PHANDLE_CELLS(iommus, "iommus", "#iommu-cells");
1247WARNING_PROPERTY_PHANDLE_CELLS(mboxes, "mboxes", "#mbox-cells");
1248WARNING_PROPERTY_PHANDLE_CELLS(msi_parent, "msi-parent", "#msi-cells", true);
1249WARNING_PROPERTY_PHANDLE_CELLS(mux_controls, "mux-controls", "#mux-control-cells");
1250WARNING_PROPERTY_PHANDLE_CELLS(phys, "phys", "#phy-cells");
1251WARNING_PROPERTY_PHANDLE_CELLS(power_domains, "power-domains", "#power-domain-cells");
1252WARNING_PROPERTY_PHANDLE_CELLS(pwms, "pwms", "#pwm-cells");
1253WARNING_PROPERTY_PHANDLE_CELLS(resets, "resets", "#reset-cells");
1254WARNING_PROPERTY_PHANDLE_CELLS(sound_dai, "sound-dai", "#sound-dai-cells");
1255WARNING_PROPERTY_PHANDLE_CELLS(thermal_sensors, "thermal-sensors", "#thermal-sensor-cells");
1256
1257static bool prop_is_gpio(struct property *prop)
1258{
1259        char *str;
1260
1261        /*
1262         * *-gpios and *-gpio can appear in property names,
1263         * so skip over any false matches (only one known ATM)
1264         */
1265        if (strstr(prop->name, "nr-gpio"))
1266                return false;
1267
1268        str = strrchr(prop->name, '-');
1269        if (str)
1270                str++;
1271        else
1272                str = prop->name;
1273        if (!(streq(str, "gpios") || streq(str, "gpio")))
1274                return false;
1275
1276        return true;
1277}
1278
1279static void check_gpios_property(struct check *c,
1280                                          struct dt_info *dti,
1281                                          struct node *node)
1282{
1283        struct property *prop;
1284
1285        /* Skip GPIO hog nodes which have 'gpios' property */
1286        if (get_property(node, "gpio-hog"))
1287                return;
1288
1289        for_each_property(node, prop) {
1290                struct provider provider;
1291
1292                if (!prop_is_gpio(prop))
1293                        continue;
1294
1295                provider.prop_name = prop->name;
1296                provider.cell_name = "#gpio-cells";
1297                provider.optional = false;
1298                check_property_phandle_args(c, dti, node, prop, &provider);
1299        }
1300
1301}
1302WARNING(gpios_property, check_gpios_property, NULL, &phandle_references);
1303
1304static void check_deprecated_gpio_property(struct check *c,
1305                                           struct dt_info *dti,
1306                                           struct node *node)
1307{
1308        struct property *prop;
1309
1310        for_each_property(node, prop) {
1311                char *str;
1312
1313                if (!prop_is_gpio(prop))
1314                        continue;
1315
1316                str = strstr(prop->name, "gpio");
1317                if (!streq(str, "gpio"))
1318                        continue;
1319
1320                FAIL_PROP(c, dti, node, prop,
1321                          "'[*-]gpio' is deprecated, use '[*-]gpios' instead");
1322        }
1323
1324}
1325CHECK(deprecated_gpio_property, check_deprecated_gpio_property, NULL);
1326
1327static bool node_is_interrupt_provider(struct node *node)
1328{
1329        struct property *prop;
1330
1331        prop = get_property(node, "interrupt-controller");
1332        if (prop)
1333                return true;
1334
1335        prop = get_property(node, "interrupt-map");
1336        if (prop)
1337                return true;
1338
1339        return false;
1340}
1341static void check_interrupts_property(struct check *c,
1342                                      struct dt_info *dti,
1343                                      struct node *node)
1344{
1345        struct node *root = dti->dt;
1346        struct node *irq_node = NULL, *parent = node;
1347        struct property *irq_prop, *prop = NULL;
1348        int irq_cells, phandle;
1349
1350        irq_prop = get_property(node, "interrupts");
1351        if (!irq_prop)
1352                return;
1353
1354        if (irq_prop->val.len % sizeof(cell_t))
1355                FAIL_PROP(c, dti, node, irq_prop, "size (%d) is invalid, expected multiple of %zu",
1356                     irq_prop->val.len, sizeof(cell_t));
1357
1358        while (parent && !prop) {
1359                if (parent != node && node_is_interrupt_provider(parent)) {
1360                        irq_node = parent;
1361                        break;
1362                }
1363
1364                prop = get_property(parent, "interrupt-parent");
1365                if (prop) {
1366                        phandle = propval_cell(prop);
1367                        /* Give up if this is an overlay with external references */
1368                        if ((phandle == 0 || phandle == -1) &&
1369                            (dti->dtsflags & DTSF_PLUGIN))
1370                                        return;
1371
1372                        irq_node = get_node_by_phandle(root, phandle);
1373                        if (!irq_node) {
1374                                FAIL_PROP(c, dti, parent, prop, "Bad phandle");
1375                                return;
1376                        }
1377                        if (!node_is_interrupt_provider(irq_node))
1378                                FAIL(c, dti, irq_node,
1379                                     "Missing interrupt-controller or interrupt-map property");
1380
1381                        break;
1382                }
1383
1384                parent = parent->parent;
1385        }
1386
1387        if (!irq_node) {
1388                FAIL(c, dti, node, "Missing interrupt-parent");
1389                return;
1390        }
1391
1392        prop = get_property(irq_node, "#interrupt-cells");
1393        if (!prop) {
1394                FAIL(c, dti, irq_node, "Missing #interrupt-cells in interrupt-parent");
1395                return;
1396        }
1397
1398        irq_cells = propval_cell(prop);
1399        if (irq_prop->val.len % (irq_cells * sizeof(cell_t))) {
1400                FAIL_PROP(c, dti, node, prop,
1401                          "size is (%d), expected multiple of %d",
1402                          irq_prop->val.len, (int)(irq_cells * sizeof(cell_t)));
1403        }
1404}
1405WARNING(interrupts_property, check_interrupts_property, &phandle_references);
1406
1407static const struct bus_type graph_port_bus = {
1408        .name = "graph-port",
1409};
1410
1411static const struct bus_type graph_ports_bus = {
1412        .name = "graph-ports",
1413};
1414
1415static void check_graph_nodes(struct check *c, struct dt_info *dti,
1416                              struct node *node)
1417{
1418        struct node *child;
1419
1420        for_each_child(node, child) {
1421                if (!(strprefixeq(child->name, child->basenamelen, "endpoint") ||
1422                      get_property(child, "remote-endpoint")))
1423                        continue;
1424
1425                node->bus = &graph_port_bus;
1426
1427                /* The parent of 'port' nodes can be either 'ports' or a device */
1428                if (!node->parent->bus &&
1429                    (streq(node->parent->name, "ports") || get_property(node, "reg")))
1430                        node->parent->bus = &graph_ports_bus;
1431
1432                break;
1433        }
1434
1435}
1436WARNING(graph_nodes, check_graph_nodes, NULL);
1437
1438static void check_graph_child_address(struct check *c, struct dt_info *dti,
1439                                      struct node *node)
1440{
1441        int cnt = 0;
1442        struct node *child;
1443
1444        if (node->bus != &graph_ports_bus && node->bus != &graph_port_bus)
1445                return;
1446
1447        for_each_child(node, child) {
1448                struct property *prop = get_property(child, "reg");
1449
1450                /* No error if we have any non-zero unit address */
1451                if (prop && propval_cell(prop) != 0)
1452                        return;
1453
1454                cnt++;
1455        }
1456
1457        if (cnt == 1 && node->addr_cells != -1)
1458                FAIL(c, dti, node, "graph node has single child node '%s', #address-cells/#size-cells are not necessary",
1459                     node->children->name);
1460}
1461WARNING(graph_child_address, check_graph_child_address, NULL, &graph_nodes);
1462
1463static void check_graph_reg(struct check *c, struct dt_info *dti,
1464                            struct node *node)
1465{
1466        char unit_addr[9];
1467        const char *unitname = get_unitname(node);
1468        struct property *prop;
1469
1470        prop = get_property(node, "reg");
1471        if (!prop || !unitname)
1472                return;
1473
1474        if (!(prop->val.val && prop->val.len == sizeof(cell_t))) {
1475                FAIL(c, dti, node, "graph node malformed 'reg' property");
1476                return;
1477        }
1478
1479        snprintf(unit_addr, sizeof(unit_addr), "%x", propval_cell(prop));
1480        if (!streq(unitname, unit_addr))
1481                FAIL(c, dti, node, "graph node unit address error, expected \"%s\"",
1482                     unit_addr);
1483
1484        if (node->parent->addr_cells != 1)
1485                FAIL_PROP(c, dti, node, get_property(node, "#address-cells"),
1486                          "graph node '#address-cells' is %d, must be 1",
1487                          node->parent->addr_cells);
1488        if (node->parent->size_cells != 0)
1489                FAIL_PROP(c, dti, node, get_property(node, "#size-cells"),
1490                          "graph node '#size-cells' is %d, must be 0",
1491                          node->parent->size_cells);
1492}
1493
1494static void check_graph_port(struct check *c, struct dt_info *dti,
1495                             struct node *node)
1496{
1497        if (node->bus != &graph_port_bus)
1498                return;
1499
1500        if (!strprefixeq(node->name, node->basenamelen, "port"))
1501                FAIL(c, dti, node, "graph port node name should be 'port'");
1502
1503        check_graph_reg(c, dti, node);
1504}
1505WARNING(graph_port, check_graph_port, NULL, &graph_nodes);
1506
1507static struct node *get_remote_endpoint(struct check *c, struct dt_info *dti,
1508                                        struct node *endpoint)
1509{
1510        int phandle;
1511        struct node *node;
1512        struct property *prop;
1513
1514        prop = get_property(endpoint, "remote-endpoint");
1515        if (!prop)
1516                return NULL;
1517
1518        phandle = propval_cell(prop);
1519        /* Give up if this is an overlay with external references */
1520        if (phandle == 0 || phandle == -1)
1521                return NULL;
1522
1523        node = get_node_by_phandle(dti->dt, phandle);
1524        if (!node)
1525                FAIL_PROP(c, dti, endpoint, prop, "graph phandle is not valid");
1526
1527        return node;
1528}
1529
1530static void check_graph_endpoint(struct check *c, struct dt_info *dti,
1531                                 struct node *node)
1532{
1533        struct node *remote_node;
1534
1535        if (!node->parent || node->parent->bus != &graph_port_bus)
1536                return;
1537
1538        if (!strprefixeq(node->name, node->basenamelen, "endpoint"))
1539                FAIL(c, dti, node, "graph endpont node name should be 'endpoint'");
1540
1541        check_graph_reg(c, dti, node);
1542
1543        remote_node = get_remote_endpoint(c, dti, node);
1544        if (!remote_node)
1545                return;
1546
1547        if (get_remote_endpoint(c, dti, remote_node) != node)
1548                FAIL(c, dti, node, "graph connection to node '%s' is not bidirectional",
1549                     remote_node->fullpath);
1550}
1551WARNING(graph_endpoint, check_graph_endpoint, NULL, &graph_nodes);
1552
1553static struct check *check_table[] = {
1554        &duplicate_node_names, &duplicate_property_names,
1555        &node_name_chars, &node_name_format, &property_name_chars,
1556        &name_is_string, &name_properties,
1557
1558        &duplicate_label,
1559
1560        &explicit_phandles,
1561        &phandle_references, &path_references,
1562        &omit_unused_nodes,
1563
1564        &address_cells_is_cell, &size_cells_is_cell, &interrupt_cells_is_cell,
1565        &device_type_is_string, &model_is_string, &status_is_string,
1566        &label_is_string,
1567
1568        &compatible_is_string_list, &names_is_string_list,
1569
1570        &property_name_chars_strict,
1571        &node_name_chars_strict,
1572
1573        &addr_size_cells, &reg_format, &ranges_format,
1574
1575        &unit_address_vs_reg,
1576        &unit_address_format,
1577
1578        &pci_bridge,
1579        &pci_device_reg,
1580        &pci_device_bus_num,
1581
1582        &simple_bus_bridge,
1583        &simple_bus_reg,
1584
1585        &avoid_default_addr_size,
1586        &avoid_unnecessary_addr_size,
1587        &unique_unit_address,
1588        &obsolete_chosen_interrupt_controller,
1589        &chosen_node_is_root, &chosen_node_bootargs, &chosen_node_stdout_path,
1590
1591        &clocks_property,
1592        &cooling_device_property,
1593        &dmas_property,
1594        &hwlocks_property,
1595        &interrupts_extended_property,
1596        &io_channels_property,
1597        &iommus_property,
1598        &mboxes_property,
1599        &msi_parent_property,
1600        &mux_controls_property,
1601        &phys_property,
1602        &power_domains_property,
1603        &pwms_property,
1604        &resets_property,
1605        &sound_dai_property,
1606        &thermal_sensors_property,
1607
1608        &deprecated_gpio_property,
1609        &gpios_property,
1610        &interrupts_property,
1611
1612        &alias_paths,
1613
1614        &graph_nodes, &graph_child_address, &graph_port, &graph_endpoint,
1615
1616        &always_fail,
1617};
1618
1619static void enable_warning_error(struct check *c, bool warn, bool error)
1620{
1621        int i;
1622
1623        /* Raising level, also raise it for prereqs */
1624        if ((warn && !c->warn) || (error && !c->error))
1625                for (i = 0; i < c->num_prereqs; i++)
1626                        enable_warning_error(c->prereq[i], warn, error);
1627
1628        c->warn = c->warn || warn;
1629        c->error = c->error || error;
1630}
1631
1632static void disable_warning_error(struct check *c, bool warn, bool error)
1633{
1634        int i;
1635
1636        /* Lowering level, also lower it for things this is the prereq
1637         * for */
1638        if ((warn && c->warn) || (error && c->error)) {
1639                for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1640                        struct check *cc = check_table[i];
1641                        int j;
1642
1643                        for (j = 0; j < cc->num_prereqs; j++)
1644                                if (cc->prereq[j] == c)
1645                                        disable_warning_error(cc, warn, error);
1646                }
1647        }
1648
1649        c->warn = c->warn && !warn;
1650        c->error = c->error && !error;
1651}
1652
1653void parse_checks_option(bool warn, bool error, const char *arg)
1654{
1655        int i;
1656        const char *name = arg;
1657        bool enable = true;
1658
1659        if ((strncmp(arg, "no-", 3) == 0)
1660            || (strncmp(arg, "no_", 3) == 0)) {
1661                name = arg + 3;
1662                enable = false;
1663        }
1664
1665        for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1666                struct check *c = check_table[i];
1667
1668                if (streq(c->name, name)) {
1669                        if (enable)
1670                                enable_warning_error(c, warn, error);
1671                        else
1672                                disable_warning_error(c, warn, error);
1673                        return;
1674                }
1675        }
1676
1677        die("Unrecognized check name \"%s\"\n", name);
1678}
1679
1680void process_checks(bool force, struct dt_info *dti)
1681{
1682        int i;
1683        int error = 0;
1684
1685        for (i = 0; i < ARRAY_SIZE(check_table); i++) {
1686                struct check *c = check_table[i];
1687
1688                if (c->warn || c->error)
1689                        error = error || run_check(c, dti);
1690        }
1691
1692        if (error) {
1693                if (!force) {
1694                        fprintf(stderr, "ERROR: Input tree has errors, aborting "
1695                                "(use -f to force output)\n");
1696                        exit(2);
1697                } else if (quiet < 3) {
1698                        fprintf(stderr, "Warning: Input tree has errors, "
1699                                "output forced\n");
1700                }
1701        }
1702}
1703