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 ofnode ofnode_get_by_phandle(uint phandle)
 192 {
 193         ofnode node;
 194
 195         if (of_live_active())
 196                 node = np_to_ofnode(of_find_node_by_phandle(phandle));
 197         else
 198                 node.of_offset = fdt_node_offset_by_phandle(gd->fdt_blob,
 199                                                             phandle);
 200
 201         return node;
 202 }
 203
 204 int ofnode_read_size(ofnode node, const char *propname)
 205 {
 206         int len;
 207
 208         if (ofnode_is_np(node)) {
 209                 struct property *prop = of_find_property(
 210                                 ofnode_to_np(node), propname, NULL);
 211
 212                 if (prop)
 213                         return prop->length;
 214         } else {
 215                 if (fdt_getprop(gd->fdt_blob, ofnode_to_offset(node), propname,
 216                                 &len))
 217                         return len;
 218         }
 219
 220         return -EINVAL;
 221 }
 222
 223 fdt_addr_t ofnode_get_addr_index(ofnode node, int index)
 224 {
 225         if (ofnode_is_np(node)) {
 226                 const __be32 *prop_val;
 227                 uint flags;
 228                 u64 size;
 229                 int na;
 230
 231                 prop_val = of_get_address(ofnode_to_np(node), index, &size,
 232                                           &flags);
 233                 if (!prop_val)
 234                         return FDT_ADDR_T_NONE;
 235
 236                 if (IS_ENABLED(CONFIG_OF_TRANSLATE)) {
 237                         return of_translate_address(ofnode_to_np(node), prop_val);
 238                 } else {
 239                         na = of_n_addr_cells(ofnode_to_np(node));
 240                         return of_read_number(prop_val, na);
 241                 }
 242         } else {
 243                 return fdt_get_base_address(gd->fdt_blob,
 244                                             ofnode_to_offset(node));
 245         }
 246
 247         return FDT_ADDR_T_NONE;
 248 }
 249
 250 fdt_addr_t ofnode_get_addr(ofnode node)
 251 {
 252         return ofnode_get_addr_index(node, 0);
 253 }
 254
 255 int ofnode_stringlist_search(ofnode node, const char *property,
 256                              const char *string)
 257 {
 258         if (ofnode_is_np(node)) {
 259                 return of_property_match_string(ofnode_to_np(node),
 260                                                 property, string);
 261         } else {
 262                 int ret;
 263
 264                 ret = fdt_stringlist_search(gd->fdt_blob,
 265                                             ofnode_to_offset(node), property,
 266                                             string);
 267                 if (ret == -FDT_ERR_NOTFOUND)
 268                         return -ENODATA;
 269                 else if (ret < 0)
 270                         return -EINVAL;
 271
 272                 return ret;
 273         }
 274 }
 275
 276 int ofnode_read_string_index(ofnode node, const char *property, int index,
 277                              const char **outp)
 278 {
 279         if (ofnode_is_np(node)) {
 280                 return of_property_read_string_index(ofnode_to_np(node),
 281                                                      property, index, outp);
 282         } else {
 283                 int len;
 284
 285                 *outp = fdt_stringlist_get(gd->fdt_blob, ofnode_to_offset(node),
 286                                            property, index, &len);
 287                 if (len < 0)
 288                         return -EINVAL;
 289                 return 0;
 290         }
 291 }
 292
 293 int ofnode_read_string_count(ofnode node, const char *property)
 294 {
 295         if (ofnode_is_np(node)) {
 296                 return of_property_count_strings(ofnode_to_np(node), property);
 297         } else {
 298                 return fdt_stringlist_count(gd->fdt_blob,
 299                                             ofnode_to_offset(node), property);
 300         }
 301 }
 302
 303 static void ofnode_from_fdtdec_phandle_args(struct fdtdec_phandle_args *in,
 304                                             struct ofnode_phandle_args *out)
 305 {
 306         assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
 307         out->node = offset_to_ofnode(in->node);
 308         out->args_count = in->args_count;
 309         memcpy(out->args, in->args, sizeof(out->args));
 310 }
 311
 312 static void ofnode_from_of_phandle_args(struct of_phandle_args *in,
 313                                         struct ofnode_phandle_args *out)
 314 {
 315         assert(OF_MAX_PHANDLE_ARGS == MAX_PHANDLE_ARGS);
 316         out->node = np_to_ofnode(in->np);
 317         out->args_count = in->args_count;
 318         memcpy(out->args, in->args, sizeof(out->args));
 319 }
 320
 321 int ofnode_parse_phandle_with_args(ofnode node, const char *list_name,
 322                                    const char *cells_name, int cell_count,
 323                                    int index,
 324                                    struct ofnode_phandle_args *out_args)
 325 {
 326         if (ofnode_is_np(node)) {
 327                 struct of_phandle_args args;
 328                 int ret;
 329
 330                 ret = of_parse_phandle_with_args(ofnode_to_np(node),
 331                                                  list_name, cells_name, index,
 332                                                  &args);
 333                 if (ret)
 334                         return ret;
 335                 ofnode_from_of_phandle_args(&args, out_args);
 336         } else {
 337                 struct fdtdec_phandle_args args;
 338                 int ret;
 339
 340                 ret = fdtdec_parse_phandle_with_args(gd->fdt_blob,
 341                                                      ofnode_to_offset(node),
 342                                                      list_name, cells_name,
 343                                                      cell_count, index, &args);
 344                 if (ret)
 345                         return ret;
 346                 ofnode_from_fdtdec_phandle_args(&args, out_args);
 347         }
 348
 349         return 0;
 350 }
 351
 352 int ofnode_count_phandle_with_args(ofnode node, const char *list_name,
 353                                    const char *cells_name)
 354 {
 355         if (ofnode_is_np(node))
 356                 return of_count_phandle_with_args(ofnode_to_np(node),
 357                                 list_name, cells_name);
 358         else
 359                 return fdtdec_parse_phandle_with_args(gd->fdt_blob,
 360                                 ofnode_to_offset(node), list_name, cells_name,
 361                                 0, -1, NULL);
 362 }
 363
 364 ofnode ofnode_path(const char *path)
 365 {
 366         if (of_live_active())
 367                 return np_to_ofnode(of_find_node_by_path(path));
 368         else
 369                 return offset_to_ofnode(fdt_path_offset(gd->fdt_blob, path));
 370 }
 371
 372 const char *ofnode_get_chosen_prop(const char *name)
 373 {
 374         ofnode chosen_node;
 375
 376         chosen_node = ofnode_path("/chosen");
 377
 378         return ofnode_read_string(chosen_node, name);
 379 }
 380
 381 ofnode ofnode_get_chosen_node(const char *name)
 382 {
 383         const char *prop;
 384
 385         prop = ofnode_get_chosen_prop(name);
 386         if (!prop)
 387                 return ofnode_null();
 388
 389         return ofnode_path(prop);
 390 }
 391
 392 static int decode_timing_property(ofnode node, const char *name,
 393                                   struct timing_entry *result)
 394 {
 395         int length, ret = 0;
 396
 397         length = ofnode_read_size(node, name);
 398         if (length < 0) {
 399                 debug("%s: could not find property %s\n",
 400                       ofnode_get_name(node), name);
 401                 return length;
 402         }
 403
 404         if (length == sizeof(u32)) {
 405                 result->typ = ofnode_read_u32_default(node, name, 0);
 406                 result->min = result->typ;
 407                 result->max = result->typ;
 408         } else {
 409                 ret = ofnode_read_u32_array(node, name, &result->min, 3);
 410         }
 411
 412         return ret;
 413 }
 414
 415 int ofnode_decode_display_timing(ofnode parent, int index,
 416                                  struct display_timing *dt)
 417 {
 418         int i;
 419         ofnode timings, node;
 420         u32 val = 0;
 421         int ret = 0;
 422
 423         timings = ofnode_find_subnode(parent, "display-timings");
 424         if (!ofnode_valid(timings))
 425                 return -EINVAL;
 426
 427         i = 0;
 428         ofnode_for_each_subnode(node, timings) {
 429                 if (i++ == index)
 430                         break;
 431         }
 432
 433         if (!ofnode_valid(node))
 434                 return -EINVAL;
 435
 436         memset(dt, 0, sizeof(*dt));
 437
 438         ret |= decode_timing_property(node, "hback-porch", &dt->hback_porch);
 439         ret |= decode_timing_property(node, "hfront-porch", &dt->hfront_porch);
 440         ret |= decode_timing_property(node, "hactive", &dt->hactive);
 441         ret |= decode_timing_property(node, "hsync-len", &dt->hsync_len);
 442         ret |= decode_timing_property(node, "vback-porch", &dt->vback_porch);
 443         ret |= decode_timing_property(node, "vfront-porch", &dt->vfront_porch);
 444         ret |= decode_timing_property(node, "vactive", &dt->vactive);
 445         ret |= decode_timing_property(node, "vsync-len", &dt->vsync_len);
 446         ret |= decode_timing_property(node, "clock-frequency", &dt->pixelclock);
 447
 448         dt->flags = 0;
 449         val = ofnode_read_u32_default(node, "vsync-active", -1);
 450         if (val != -1) {
 451                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
 452                                 DISPLAY_FLAGS_VSYNC_LOW;
 453         }
 454         val = ofnode_read_u32_default(node, "hsync-active", -1);
 455         if (val != -1) {
 456                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
 457                                 DISPLAY_FLAGS_HSYNC_LOW;
 458         }
 459         val = ofnode_read_u32_default(node, "de-active", -1);
 460         if (val != -1) {
 461                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
 462                                 DISPLAY_FLAGS_DE_LOW;
 463         }
 464         val = ofnode_read_u32_default(node, "pixelclk-active", -1);
 465         if (val != -1) {
 466                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
 467                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
 468         }
 469
 470         if (ofnode_read_bool(node, "interlaced"))
 471                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
 472         if (ofnode_read_bool(node, "doublescan"))
 473                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
 474         if (ofnode_read_bool(node, "doubleclk"))
 475                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
 476
 477         return ret;
 478 }
 479
 480 const void *ofnode_get_property(ofnode node, const char *propname, int *lenp)
 481 {
 482         if (ofnode_is_np(node))
 483                 return of_get_property(ofnode_to_np(node), propname, lenp);
 484         else
 485                 return fdt_getprop(gd->fdt_blob, ofnode_to_offset(node),
 486                                    propname, lenp);
 487 }
 488
 489 bool ofnode_is_available(ofnode node)
 490 {
 491         if (ofnode_is_np(node))
 492                 return of_device_is_available(ofnode_to_np(node));
 493         else
 494                 return fdtdec_get_is_enabled(gd->fdt_blob,
 495                                              ofnode_to_offset(node));
 496 }
 497
 498 fdt_addr_t ofnode_get_addr_size(ofnode node, const char *property,
 499                                 fdt_size_t *sizep)
 500 {
 501         if (ofnode_is_np(node)) {
 502                 int na, ns;
 503                 int psize;
 504                 const struct device_node *np = ofnode_to_np(node);
 505                 const __be32 *prop = of_get_property(np, property, &psize);
 506
 507                 if (!prop)
 508                         return FDT_ADDR_T_NONE;
 509                 na = of_n_addr_cells(np);
 510                 ns = of_n_addr_cells(np);
 511                 *sizep = of_read_number(prop + na, ns);
 512                 return of_read_number(prop, na);
 513         } else {
 514                 return fdtdec_get_addr_size(gd->fdt_blob,
 515                                             ofnode_to_offset(node), property,
 516                                             sizep);
 517         }
 518 }
 519
 520 const uint8_t *ofnode_read_u8_array_ptr(ofnode node, const char *propname,
 521                                         size_t sz)
 522 {
 523         if (ofnode_is_np(node)) {
 524                 const struct device_node *np = ofnode_to_np(node);
 525                 int psize;
 526                 const __be32 *prop = of_get_property(np, propname, &psize);
 527
 528                 if (!prop || sz != psize)
 529                         return NULL;
 530                 return (uint8_t *)prop;
 531
 532         } else {
 533                 return fdtdec_locate_byte_array(gd->fdt_blob,
 534                                 ofnode_to_offset(node), propname, sz);
 535         }
 536 }
 537
 538 int ofnode_read_pci_addr(ofnode node, enum fdt_pci_space type,
 539                          const char *propname, struct fdt_pci_addr *addr)
 540 {
 541         const fdt32_t *cell;
 542         int len;
 543         int ret = -ENOENT;
 544
 545         debug("%s: %s: ", __func__, propname);
 546
 547         /*
 548          * If we follow the pci bus bindings strictly, we should check
 549          * the value of the node's parent node's #address-cells and
 550          * #size-cells. They need to be 3 and 2 accordingly. However,
 551          * for simplicity we skip the check here.
 552          */
 553         cell = ofnode_get_property(node, propname, &len);
 554         if (!cell)
 555                 goto fail;
 556
 557         if ((len % FDT_PCI_REG_SIZE) == 0) {
 558                 int num = len / FDT_PCI_REG_SIZE;
 559                 int i;
 560
 561                 for (i = 0; i < num; i++) {
 562                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
 563                               (ulong)fdt32_to_cpu(cell[0]),
 564                               (ulong)fdt32_to_cpu(cell[1]),
 565                               (ulong)fdt32_to_cpu(cell[2]));
 566                         if ((fdt32_to_cpu(*cell) & type) == type) {
 567                                 addr->phys_hi = fdt32_to_cpu(cell[0]);
 568                                 addr->phys_mid = fdt32_to_cpu(cell[1]);
 569                                 addr->phys_lo = fdt32_to_cpu(cell[1]);
 570                                 break;
 571                         }
 572
 573                         cell += (FDT_PCI_ADDR_CELLS +
 574                                  FDT_PCI_SIZE_CELLS);
 575                 }
 576
 577                 if (i == num) {
 578                         ret = -ENXIO;
 579                         goto fail;
 580                 }
 581
 582                 return 0;
 583         }
 584
 585         ret = -EINVAL;
 586
 587 fail:
 588         debug("(not found)\n");
 589         return ret;
 590 }
 591
 592 int ofnode_read_addr_cells(ofnode node)
 593 {
 594         if (ofnode_is_np(node))
 595                 return of_n_addr_cells(ofnode_to_np(node));
 596         else  /* NOTE: this call should walk up the parent stack */
 597                 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
 598 }
 599
 600 int ofnode_read_size_cells(ofnode node)
 601 {
 602         if (ofnode_is_np(node))
 603                 return of_n_size_cells(ofnode_to_np(node));
 604         else  /* NOTE: this call should walk up the parent stack */
 605                 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
 606 }
 607
 608 int ofnode_read_simple_addr_cells(ofnode node)
 609 {
 610         if (ofnode_is_np(node))
 611                 return of_simple_addr_cells(ofnode_to_np(node));
 612         else
 613                 return fdt_address_cells(gd->fdt_blob, ofnode_to_offset(node));
 614 }
 615
 616 int ofnode_read_simple_size_cells(ofnode node)
 617 {
 618         if (ofnode_is_np(node))
 619                 return of_simple_size_cells(ofnode_to_np(node));
 620         else
 621                 return fdt_size_cells(gd->fdt_blob, ofnode_to_offset(node));
 622 }
 623
 624 bool ofnode_pre_reloc(ofnode node)
 625 {
 626         if (ofnode_read_bool(node, "u-boot,dm-pre-reloc"))
 627                 return true;
 628
 629 #ifdef CONFIG_TPL_BUILD
 630         if (ofnode_read_bool(node, "u-boot,dm-tpl"))
 631                 return true;
 632 #elif defined(CONFIG_SPL_BUILD)
 633         if (ofnode_read_bool(node, "u-boot,dm-spl"))
 634                 return true;
 635 #else
 636         /*
 637          * In regular builds individual spl and tpl handling both
 638          * count as handled pre-relocation for later second init.
 639          */
 640         if (ofnode_read_bool(node, "u-boot,dm-spl") ||
 641             ofnode_read_bool(node, "u-boot,dm-tpl"))
 642                 return true;
 643 #endif
 644
 645         return false;
 646 }
 647
 648 int ofnode_read_resource(ofnode node, uint index, struct resource *res)
 649 {
 650         if (ofnode_is_np(node)) {
 651                 return of_address_to_resource(ofnode_to_np(node), index, res);
 652         } else {
 653                 struct fdt_resource fres;
 654                 int ret;
 655
 656                 ret = fdt_get_resource(gd->fdt_blob, ofnode_to_offset(node),
 657                                        "reg", index, &fres);
 658                 if (ret < 0)
 659                         return -EINVAL;
 660                 memset(res, '\0', sizeof(*res));
 661                 res->start = fres.start;
 662                 res->end = fres.end;
 663
 664                 return 0;
 665         }
 666 }
 667
 668 int ofnode_read_resource_byname(ofnode node, const char *name,
 669                                 struct resource *res)
 670 {
 671         int index;
 672
 673         index = ofnode_stringlist_search(node, "reg-names", name);
 674         if (index < 0)
 675                 return index;
 676
 677         return ofnode_read_resource(node, index, res);
 678 }
 679
 680 u64 ofnode_translate_address(ofnode node, const fdt32_t *in_addr)
 681 {
 682         if (ofnode_is_np(node))
 683                 return of_translate_address(ofnode_to_np(node), in_addr);
 684         else
 685                 return fdt_translate_address(gd->fdt_blob, ofnode_to_offset(node), in_addr);
 686 }