drivers/core/ofnode.c

   1 /*
   2  * Copyright (c) 2017 Google, Inc
   3  * Written by Simon Glass <sjg@chromium.org>
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <dm.h>
  10 #include <fdtdec.h>
  11 #include <fdt_support.h>
  12 #include <libfdt.h>
  13 #include <dm/of_access.h>
  14 #include <dm/of_addr.h>
  15 #include <dm/ofnode.h>
  16 #include <linux/err.h>
  17 #include <linux/ioport.h>
  18
  19 int ofnode_read_u32(ofnode node, const char *propname, u32 *outp)
  20 {
  21         assert(ofnode_valid(node));
  22         debug("%s: %s: ", __func__, propname);
  23
  24         if (ofnode_is_np(node)) {
  25                 return of_read_u32(ofnode_to_np(node), propname, outp);
  26         } else {
  27                 const fdt32_t *cell;
  28                 int len;
  29
  30                 cell = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
  31                                    propname, &len);
  32                 if (!cell || len < sizeof(int)) {
  33                         debug("(not found)\n");
  34                         return -EINVAL;
  35                 }
  36                 *outp = fdt32_to_cpu(cell[0]);
  37         }
  38         debug("%#x (%d)\n", *outp, *outp);
  39
  40         return 0;
  41 }
  42
  43 int ofnode_read_u32_default(ofnode node, const char *propname, u32 def)
  44 {
  45         assert(ofnode_valid(node));
  46         ofnode_read_u32(node, propname, &def);
  47
  48         return def;
  49 }
  50
  51 int ofnode_read_s32_default(ofnode node, const char *propname, s32 def)
  52 {
  53         assert(ofnode_valid(node));
  54         ofnode_read_u32(node, propname, (u32 *)&def);
  55
  56         return def;
  57 }
  58
  59 bool ofnode_read_bool(ofnode node, const char *propname)
  60 {
  61         const void *prop;
  62
  63         assert(ofnode_valid(node));
  64         debug("%s: %s: ", __func__, propname);
  65
  66         prop = ofnode_get_property(node, propname, NULL);
  67
  68         debug("%s\n", prop ? "true" : "false");
  69
  70         return prop ? true : false;
  71 }
  72
  73 const char *ofnode_read_string(ofnode node, const char *propname)
  74 {
  75         const char *str = NULL;
  76         int len = -1;
  77
  78         assert(ofnode_valid(node));
  79         debug("%s: %s: ", __func__, propname);
  80
  81         if (ofnode_is_np(node)) {
  82                 struct property *prop = of_find_property(
  83                                 ofnode_to_np(node), propname, NULL);
  84
  85                 if (prop) {
  86                         str = prop->value;
  87                         len = prop->length;
  88                 }
  89         } else {
  90                 str = fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
  91                                   propname, &len);
  92         }
  93         if (!str) {
  94                 debug("<not found>\n");
  95                 return NULL;
  96         }
  97         if (strnlen(str, len) >= len) {
  98                 debug("<invalid>\n");
  99                 return NULL;
 100         }
 101         debug("%s\n", str);
 102
 103         return str;
 104 }
 105
 106 ofnode ofnode_find_subnode(ofnode node, const char *subnode_name)
 107 {
 108         ofnode subnode;
 109
 110         assert(ofnode_valid(node));
 111         debug("%s: %s: ", __func__, subnode_name);
 112
 113         if (ofnode_is_np(node)) {
 114                 const struct device_node *np = ofnode_to_np(node);
 115
 116                 for (np = np->child; np; np = np->sibling) {
 117                         if (!strcmp(subnode_name, np->name))
 118                                 break;
 119                 }
 120                 subnode = np_to_ofnode(np);
 121         } else {
 122                 int ooffset = fdt_subnode_offset(gd->fdt_blob,
 123                                 ofnode_to_offset(node), subnode_name);
 124                 subnode = offset_to_ofnode(ooffset);
 125         }
 126         debug("%s\n", ofnode_valid(subnode) ?
 127               ofnode_get_name(subnode) : "<none>");
 128
 129         return subnode;
 130 }
 131
 132 int ofnode_read_u32_array(ofnode node, const char *propname,
 133                           u32 *out_values, size_t sz)
 134 {
 135         assert(ofnode_valid(node));
 136         debug("%s: %s: ", __func__, propname);
 137
 138         if (ofnode_is_np(node)) {
 139                 return of_read_u32_array(ofnode_to_np(node), propname,
 140                                          out_values, sz);
 141         } else {
 142                 return fdtdec_get_int_array(gd->fdt_blob,
 143                                             ofnode_to_offset(node), propname,
 144                                             out_values, sz);
 145         }
 146 }
 147
 148 ofnode ofnode_first_subnode(ofnode node)
 149 {
 150         assert(ofnode_valid(node));
 151         if (ofnode_is_np(node))
 152                 return np_to_ofnode(node.np->child);
 153
 154         return offset_to_ofnode(
 155                 fdt_first_subnode(gd->fdt_blob, ofnode_to_offset(node)));
 156 }
 157
 158 ofnode ofnode_next_subnode(ofnode node)
 159 {
 160         assert(ofnode_valid(node));
 161         if (ofnode_is_np(node))
 162                 return np_to_ofnode(node.np->sibling);
 163
 164         return offset_to_ofnode(
 165                 fdt_next_subnode(gd->fdt_blob, ofnode_to_offset(node)));
 166 }
 167
 168 ofnode ofnode_get_parent(ofnode node)
 169 {
 170         ofnode parent;
 171
 172         assert(ofnode_valid(node));
 173         if (ofnode_is_np(node))
 174                 parent = np_to_ofnode(of_get_parent(ofnode_to_np(node)));
 175         else
 176                 parent.of_offset = fdt_parent_offset(gd->fdt_blob,
 177                                                      ofnode_to_offset(node));
 178
 179         return parent;
 180 }
 181
 182 const char *ofnode_get_name(ofnode node)
 183 {
 184         assert(ofnode_valid(node));
 185         if (ofnode_is_np(node))
 186                 return strrchr(node.np->full_name, '/') + 1;
 187
 188         return fdt_get_name(gd->fdt_blob, ofnode_to_offset(node), NULL);
 189 }
 190
 191 int ofnode_read_size(ofnode node, const char *propname)
 192 {
 193         int len;
 194
 195         if (ofnode_is_np(node)) {
 196                 struct property *prop = of_find_property(
 197                                 ofnode_to_np(node), propname, NULL);
 198
 199                 if (prop)
 200                         return prop->length;
 201         } else {
 202                 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
 203                                 &len))
 204                         return len;
 205         }
 206
 207         return -EINVAL;
 208 }
 209
 210 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
 211 {
 212         if (ofnode_is_np(node)) {
 213                 const __be32 *prop_val;
 214                 uint flags;
 215                 u64 size;
 216                 int na;
 217
 218                 prop_val = of_get_address(ofnode_to_np(node), index, &size,
 219                                           &flags);
 220                 if (!prop_val)
 221                         return FDT_ADDR_T_NONE;
 222
 223                 if (IS_ENABLED(CONFIG_OF_TRANSLATE)) {
 224                         return of_translate_address(ofnode_to_np(node), prop_val);
 225                 } else {
 226                         na = of_n_addr_cells(ofnode_to_np(node));
 227                         return of_read_number(prop_val, na);
 228                 }
 229         } else {
 230                 return fdt_get_base_address(gd->fdt_blob,
 231                                             ofnode_to_offset(node));
 232         }
 233
 234         return FDT_ADDR_T_NONE;
 235 }
 236
 237 fdt_addr_t ofnode_get_addr(ofnode node)
 238 {
 239         return ofnode_get_addr_index(node, 0);
 240 }
 241
 242 int ofnode_stringlist_search(ofnode node, const char *property,
 243                              const char *string)
 244 {
 245         if (ofnode_is_np(node)) {
 246                 return of_property_match_string(ofnode_to_np(node),
 247                                                 property, string);
 248         } else {
 249                 int ret;
 250
 251                 ret = fdt_stringlist_search(gd->fdt_blob,
 252                                             ofnode_to_offset(node), property,
 253                                             string);
 254                 if (ret == -FDT_ERR_NOTFOUND)
 255                         return -ENODATA;
 256                 else if (ret < 0)
 257                         return -EINVAL;
 258
 259                 return ret;
 260         }
 261 }
 262
 263 int ofnode_read_string_index(ofnode node, const char *property, int index,
 264                              const char **outp)
 265 {
 266         if (ofnode_is_np(node)) {
 267                 return of_property_read_string_index(ofnode_to_np(node),
 268                                                      property, index, outp);
 269         } else {
 270                 int len;
 271
 272                 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
 273                                            property, index, &len);
 274                 if (len < 0)
 275                         return -EINVAL;
 276                 return 0;
 277         }
 278 }
 279
 280 int ofnode_read_string_count(ofnode node, const char *property)
 281 {
 282         if (ofnode_is_np(node)) {
 283                 return of_property_count_strings(ofnode_to_np(node), property);
 284         } else {
 285                 return fdt_stringlist_count(gd->fdt_blob,
 286                                             ofnode_to_offset(node), property);
 287         }
 288 }
 289
 290 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
 291                                             struct ofnode_phandle_args *out)
 292 {
 293         assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
 294         out->node = offset_to_ofnode(in->node);
 295         out->args_count = in->args_count;
 296         memcpy(out->args, in->args, sizeof(out->args));
 297 }
 298
 299 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
 300                                         struct ofnode_phandle_args *out)
 301 {
 302         assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
 303         out->node = np_to_ofnode(in->np);
 304         out->args_count = in->args_count;
 305         memcpy(out->args, in->args, sizeof(out->args));
 306 }
 307
 308 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
 309                                    const char *cells_name, int cell_count,
 310                                    int index,
 311                                    struct ofnode_phandle_args *out_args)
 312 {
 313         if (ofnode_is_np(node)) {
 314                 struct of_phandle_args args;
 315                 int ret;
 316
 317                 ret = of_parse_phandle_with_args(ofnode_to_np(node),
 318                                                  list_name, cells_name, index,
 319                                                  &args);
 320                 if (ret)
 321                         return ret;
 322                 ofnode_from_of_phandle_args(&args, out_args);
 323         } else {
 324                 struct fdtdec_phandle_args args;
 325                 int ret;
 326
 327                 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
 328                                                      ofnode_to_offset(node),
 329                                                      list_name, cells_name,
 330                                                      cell_count, index, &args);
 331                 if (ret)
 332                         return ret;
 333                 ofnode_from_fdtdec_phandle_args(&args, out_args);
 334         }
 335
 336         return 0;
 337 }
 338
 339 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
 340                                    const char *cells_name)
 341 {
 342         if (ofnode_is_np(node))
 343                 return of_count_phandle_with_args(ofnode_to_np(node),
 344                                 list_name, cells_name);
 345         else
 346                 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
 347                                 ofnode_to_offset(node), list_name, cells_name,
 348                                 0, -1, NULL);
 349 }
 350
 351 ofnode ofnode_path(const char *path)
 352 {
 353         if (of_live_active())
 354                 return np_to_ofnode(of_find_node_by_path(path));
 355         else
 356                 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
 357 }
 358
 359 const char *ofnode_get_chosen_prop(const char *name)
 360 {
 361         ofnode chosen_node;
 362
 363         chosen_node = ofnode_path("/chosen");
 364
 365         return ofnode_read_string(chosen_node, name);
 366 }
 367
 368 ofnode ofnode_get_chosen_node(const char *name)
 369 {
 370         const char *prop;
 371
 372         prop = ofnode_get_chosen_prop(name);
 373         if (!prop)
 374                 return ofnode_null();
 375
 376         return ofnode_path(prop);
 377 }
 378
 379 static int decode_timing_property(ofnode node, const char *name,
 380                                   struct timing_entry *result)
 381 {
 382         int length, ret = 0;
 383
 384         length = ofnode_read_size(node, name);
 385         if (length < 0) {
 386                 debug("%s: could not find property %s\n",
 387                       ofnode_get_name(node), name);
 388                 return length;
 389         }
 390
 391         if (length == sizeof(u32)) {
 392                 result->typ = ofnode_read_u32_default(node, name, 0);
 393                 result->min = result->typ;
 394                 result->max = result->typ;
 395         } else {
 396                 ret = ofnode_read_u32_array(node, name, &result->min, 3);
 397         }
 398
 399         return ret;
 400 }
 401
 402 int ofnode_decode_display_timing(ofnode parent, int index,
 403                                  struct display_timing *dt)
 404 {
 405         int i;
 406         ofnode timings, node;
 407         u32 val = 0;
 408         int ret = 0;
 409
 410         timings = ofnode_find_subnode(parent, "display-timings");
 411         if (!ofnode_valid(timings))
 412                 return -EINVAL;
 413
 414         i = 0;
 415         ofnode_for_each_subnode(node, timings) {
 416                 if (i++ == index)
 417                         break;
 418         }
 419
 420         if (!ofnode_valid(node))
 421                 return -EINVAL;
 422
 423         memset(dt, 0, sizeof(*dt));
 424
 425         ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
 426         ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
 427         ret |= decode_timing_property(node, "hactive", &dt->hactive);
 428         ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
 429         ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
 430         ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
 431         ret |= decode_timing_property(node, "vactive", &dt->vactive);
 432         ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
 433         ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
 434
 435         dt->flags = 0;
 436         val = ofnode_read_u32_default(node, "vsync-active", -1);
 437         if (val != -1) {
 438                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
 439                                 DISPLAY_FLAGS_VSYNC_LOW;
 440         }
 441         val = ofnode_read_u32_default(node, "hsync-active", -1);
 442         if (val != -1) {
 443                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
 444                                 DISPLAY_FLAGS_HSYNC_LOW;
 445         }
 446         val = ofnode_read_u32_default(node, "de-active", -1);
 447         if (val != -1) {
 448                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
 449                                 DISPLAY_FLAGS_DE_LOW;
 450         }
 451         val = ofnode_read_u32_default(node, "pixelclk-active", -1);
 452         if (val != -1) {
 453                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
 454                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
 455         }
 456
 457         if (ofnode_read_bool(node, "interlaced"))
 458                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
 459         if (ofnode_read_bool(node, "doublescan"))
 460                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
 461         if (ofnode_read_bool(node, "doubleclk"))
 462                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
 463
 464         return ret;
 465 }
 466
 467 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
 468 {
 469         if (ofnode_is_np(node))
 470                 return of_get_property(ofnode_to_np(node), propname, lenp);
 471         else
 472                 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
 473                                    propname, lenp);
 474 }
 475
 476 bool ofnode_is_available(ofnode node)
 477 {
 478         if (ofnode_is_np(node))
 479                 return of_device_is_available(ofnode_to_np(node));
 480         else
 481                 return fdtdec_get_is_enabled(gd->fdt_blob,
 482                                              ofnode_to_offset(node));
 483 }
 484
 485 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
 486                                 fdt_size_t *sizep)
 487 {
 488         if (ofnode_is_np(node)) {
 489                 int na, ns;
 490                 int psize;
 491                 const struct device_node *np = ofnode_to_np(node);
 492                 const __be32 *prop = of_get_property(np, property, &psize);
 493
 494                 if (!prop)
 495                         return FDT_ADDR_T_NONE;
 496                 na = of_n_addr_cells(np);
 497                 ns = of_n_addr_cells(np);
 498                 *sizep = of_read_number(prop + na, ns);
 499                 return of_read_number(prop, na);
 500         } else {
 501                 return fdtdec_get_addr_size(gd->fdt_blob,
 502                                             ofnode_to_offset(node), property,
 503                                             sizep);
 504         }
 505 }
 506
 507 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
 508                                         size_t sz)
 509 {
 510         if (ofnode_is_np(node)) {
 511                 const struct device_node *np = ofnode_to_np(node);
 512                 int psize;
 513                 const __be32 *prop = of_get_property(np, propname, &psize);
 514
 515                 if (!prop || sz != psize)
 516                         return NULL;
 517                 return (uint8_t *)prop;
 518
 519         } else {
 520                 return fdtdec_locate_byte_array(gd->fdt_blob,
 521                                 ofnode_to_offset(node), propname, sz);
 522         }
 523 }
 524
 525 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
 526                          const char *propname, struct fdt_pci_addr *addr)
 527 {
 528         const fdt32_t *cell;
 529         int len;
 530         int ret = -ENOENT;
 531
 532         debug("%s: %s: ", __func__, propname);
 533
 534         /*
 535          * If we follow the pci bus bindings strictly, we should check
 536          * the value of the node's parent node's #address-cells and
 537          * #size-cells. They need to be 3 and 2 accordingly. However,
 538          * for simplicity we skip the check here.
 539          */
 540         cell = ofnode_get_property(node, propname, &len);
 541         if (!cell)
 542                 goto fail;
 543
 544         if ((len % FDT_PCI_REG_SIZE) == 0) {
 545                 int num = len / FDT_PCI_REG_SIZE;
 546                 int i;
 547
 548                 for (i = 0; i < num; i++) {
 549                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
 550                               (ulong)fdt32_to_cpu(cell[0]),
 551                               (ulong)fdt32_to_cpu(cell[1]),
 552                               (ulong)fdt32_to_cpu(cell[2]));
 553                         if ((fdt32_to_cpu(*cell) & type) == type) {
 554                                 addr->phys_hi = fdt32_to_cpu(cell[0]);
 555                                 addr->phys_mid = fdt32_to_cpu(cell[1]);
 556                                 addr->phys_lo = fdt32_to_cpu(cell[1]);
 557                                 break;
 558                         }
 559
 560                         cell += (FDT_PCI_ADDR_CELLS +
 561                                  FDT_PCI_SIZE_CELLS);
 562                 }
 563
 564                 if (i == num) {
 565                         ret = -ENXIO;
 566                         goto fail;
 567                 }
 568
 569                 return 0;
 570         }
 571
 572         ret = -EINVAL;
 573
 574 fail:
 575         debug("(not found)\n");
 576         return ret;
 577 }
 578
 579 int ofnode_read_addr_cells(ofnode node)
 580 {
 581         if (ofnode_is_np(node))
 582                 return of_n_addr_cells(ofnode_to_np(node));
 583         else  /* NOTE: this call should walk up the parent stack */
 584                 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
 585 }
 586
 587 int ofnode_read_size_cells(ofnode node)
 588 {
 589         if (ofnode_is_np(node))
 590                 return of_n_size_cells(ofnode_to_np(node));
 591         else  /* NOTE: this call should walk up the parent stack */
 592                 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
 593 }
 594
 595 int ofnode_read_simple_addr_cells(ofnode node)
 596 {
 597         if (ofnode_is_np(node))
 598                 return of_simple_addr_cells(ofnode_to_np(node));
 599         else
 600                 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
 601 }
 602
 603 int ofnode_read_simple_size_cells(ofnode node)
 604 {
 605         if (ofnode_is_np(node))
 606                 return of_simple_size_cells(ofnode_to_np(node));
 607         else
 608                 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
 609 }
 610
 611 bool ofnode_pre_reloc(ofnode node)
 612 {
 613         if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
 614                 return true;
 615
 616 #ifdef CONFIG_TPL_BUILD
 617         if (ofnode_read_bool(node, "u-boot,dm-tpl"))
 618                 return true;
 619 #elif defined(CONFIG_SPL_BUILD)
 620         if (ofnode_read_bool(node, "u-boot,dm-spl"))
 621                 return true;
 622 #else
 623         /*
 624          * In regular builds individual spl and tpl handling both
 625          * count as handled pre-relocation for later second init.
 626          */
 627         if (ofnode_read_bool(node, "u-boot,dm-spl") ||
 628             ofnode_read_bool(node, "u-boot,dm-tpl"))
 629                 return true;
 630 #endif
 631
 632         return false;
 633 }
 634
 635 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
 636 {
 637         if (ofnode_is_np(node)) {
 638                 return of_address_to_resource(ofnode_to_np(node), index, res);
 639         } else {
 640                 struct fdt_resource fres;
 641                 int ret;
 642
 643                 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
 644                                        "reg", index, &fres);
 645                 if (ret < 0)
 646                         return -EINVAL;
 647                 memset(res, '\0', sizeof(*res));
 648                 res->start = fres.start;
 649                 res->end = fres.end;
 650
 651                 return 0;
 652         }
 653 }
 654
 655 int ofnode_read_resource_byname(ofnode node, const char *name,
 656                                 struct resource *res)
 657 {
 658         int index;
 659
 660         index = ofnode_stringlist_search(node, "reg-names", name);
 661         if (index < 0)
 662                 return index;
 663
 664         return ofnode_read_resource(node, index, res);
 665 }
 666
 667 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
 668 {
 669         if (ofnode_is_np(node))
 670                 return of_translate_address(ofnode_to_np(node), in_addr);
 671         else
 672                 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
 673 }