1 /*- 2 * Copyright (c) 2009-2010 The FreeBSD Foundation 3 * All rights reserved. 4 * 5 * This software was developed by Semihalf under sponsorship from 6 * the FreeBSD Foundation. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #include <sys/cdefs.h> 31 __FBSDID("$FreeBSD$"); 32 33 #include <sys/param.h> 34 #include <sys/systm.h> 35 #include <sys/kernel.h> 36 #include <sys/module.h> 37 #include <sys/bus.h> 38 #include <sys/limits.h> 39 40 #include <machine/resource.h> 41 42 #include <dev/fdt/fdt_common.h> 43 #include <dev/ofw/ofw_bus.h> 44 #include <dev/ofw/ofw_bus_subr.h> 45 #include <dev/ofw/openfirm.h> 46 47 #include "ofw_bus_if.h" 48 49 #ifdef DEBUG 50 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \ 51 printf(fmt,##args); } while (0) 52 #else 53 #define debugf(fmt, args...) 54 #endif 55 56 #define FDT_COMPAT_LEN 255 57 #define FDT_TYPE_LEN 64 58 59 #define FDT_REG_CELLS 4 60 61 vm_paddr_t fdt_immr_pa; 62 vm_offset_t fdt_immr_va; 63 vm_offset_t fdt_immr_size; 64 65 struct fdt_ic_list fdt_ic_list_head = SLIST_HEAD_INITIALIZER(fdt_ic_list_head); 66 67 int 68 fdt_get_range(phandle_t node, int range_id, u_long *base, u_long *size) 69 { 70 pcell_t ranges[6], *rangesptr; 71 pcell_t addr_cells, size_cells, par_addr_cells; 72 int len, tuple_size, tuples; 73 74 if ((fdt_addrsize_cells(node, &addr_cells, &size_cells)) != 0) 75 return (ENXIO); 76 /* 77 * Process 'ranges' property. 78 */ 79 par_addr_cells = fdt_parent_addr_cells(node); 80 if (par_addr_cells > 2) 81 return (ERANGE); 82 83 len = OF_getproplen(node, "ranges"); 84 if (len > sizeof(ranges)) 85 return (ENOMEM); 86 if (len == 0) { 87 *base = 0; 88 *size = ULONG_MAX; 89 return (0); 90 } 91 92 if (!(range_id < len)) 93 return (ERANGE); 94 95 if (OF_getprop(node, "ranges", ranges, sizeof(ranges)) <= 0) 96 return (EINVAL); 97 98 tuple_size = sizeof(pcell_t) * (addr_cells + par_addr_cells + 99 size_cells); 100 tuples = len / tuple_size; 101 102 if (fdt_ranges_verify(ranges, tuples, par_addr_cells, 103 addr_cells, size_cells)) { 104 return (ERANGE); 105 } 106 *base = 0; 107 *size = 0; 108 rangesptr = &ranges[range_id]; 109 110 *base = fdt_data_get((void *)rangesptr, addr_cells); 111 rangesptr += addr_cells; 112 *base += fdt_data_get((void *)rangesptr, par_addr_cells); 113 rangesptr += par_addr_cells; 114 *size = fdt_data_get((void *)rangesptr, size_cells); 115 return (0); 116 } 117 118 int 119 fdt_immr_addr(vm_offset_t immr_va) 120 { 121 phandle_t node; 122 u_long base, size; 123 int r; 124 125 /* 126 * Try to access the SOC node directly i.e. through /aliases/. 127 */ 128 if ((node = OF_finddevice("soc")) != 0) 129 if (fdt_is_compatible_strict(node, "simple-bus")) 130 goto moveon; 131 /* 132 * Find the node the long way. 133 */ 134 if ((node = OF_finddevice("/")) == 0) 135 return (ENXIO); 136 137 if ((node = fdt_find_compatible(node, "simple-bus", 1)) == 0) 138 return (ENXIO); 139 140 moveon: 141 if ((r = fdt_get_range(node, 0, &base, &size)) == 0) { 142 fdt_immr_pa = base; 143 fdt_immr_va = immr_va; 144 fdt_immr_size = size; 145 } 146 147 return (r); 148 } 149 150 /* 151 * This routine is an early-usage version of the ofw_bus_is_compatible() when 152 * the ofw_bus I/F is not available (like early console routines and similar). 153 * Note the buffer has to be on the stack since malloc() is usually not 154 * available in such cases either. 155 */ 156 int 157 fdt_is_compatible(phandle_t node, const char *compatstr) 158 { 159 char buf[FDT_COMPAT_LEN]; 160 char *compat; 161 int len, onelen, l, rv; 162 163 if ((len = OF_getproplen(node, "compatible")) <= 0) 164 return (0); 165 166 compat = (char *)&buf; 167 bzero(compat, FDT_COMPAT_LEN); 168 169 if (OF_getprop(node, "compatible", compat, FDT_COMPAT_LEN) < 0) 170 return (0); 171 172 onelen = strlen(compatstr); 173 rv = 0; 174 while (len > 0) { 175 if (strncasecmp(compat, compatstr, onelen) == 0) { 176 /* Found it. */ 177 rv = 1; 178 break; 179 } 180 /* Slide to the next sub-string. */ 181 l = strlen(compat) + 1; 182 compat += l; 183 len -= l; 184 } 185 186 return (rv); 187 } 188 189 int 190 fdt_is_compatible_strict(phandle_t node, const char *compatible) 191 { 192 char compat[FDT_COMPAT_LEN]; 193 194 if (OF_getproplen(node, "compatible") <= 0) 195 return (0); 196 197 if (OF_getprop(node, "compatible", compat, FDT_COMPAT_LEN) < 0) 198 return (0); 199 200 if (strncasecmp(compat, compatible, FDT_COMPAT_LEN) == 0) 201 /* This fits. */ 202 return (1); 203 204 return (0); 205 } 206 207 phandle_t 208 fdt_find_compatible(phandle_t start, const char *compat, int strict) 209 { 210 phandle_t child; 211 212 /* 213 * Traverse all children of 'start' node, and find first with 214 * matching 'compatible' property. 215 */ 216 for (child = OF_child(start); child != 0; child = OF_peer(child)) 217 if (fdt_is_compatible(child, compat)) { 218 if (strict) 219 if (!fdt_is_compatible_strict(child, compat)) 220 continue; 221 return (child); 222 } 223 return (0); 224 } 225 226 int 227 fdt_is_enabled(phandle_t node) 228 { 229 char *stat; 230 int ena, len; 231 232 len = OF_getprop_alloc(node, "status", sizeof(char), 233 (void **)&stat); 234 235 if (len <= 0) 236 /* It is OK if no 'status' property. */ 237 return (1); 238 239 /* Anything other than 'okay' means disabled. */ 240 ena = 0; 241 if (strncmp((char *)stat, "okay", len) == 0) 242 ena = 1; 243 244 free(stat, M_OFWPROP); 245 return (ena); 246 } 247 248 int 249 fdt_is_type(phandle_t node, const char *typestr) 250 { 251 char type[FDT_TYPE_LEN]; 252 253 if (OF_getproplen(node, "device_type") <= 0) 254 return (0); 255 256 if (OF_getprop(node, "device_type", type, FDT_TYPE_LEN) < 0) 257 return (0); 258 259 if (strncasecmp(type, typestr, FDT_TYPE_LEN) == 0) 260 /* This fits. */ 261 return (1); 262 263 return (0); 264 } 265 266 int 267 fdt_parent_addr_cells(phandle_t node) 268 { 269 pcell_t addr_cells; 270 271 /* Find out #address-cells of the superior bus. */ 272 if (OF_searchprop(OF_parent(node), "#address-cells", &addr_cells, 273 sizeof(addr_cells)) <= 0) 274 addr_cells = 2; 275 276 return ((int)fdt32_to_cpu(addr_cells)); 277 } 278 279 int 280 fdt_data_verify(void *data, int cells) 281 { 282 uint64_t d64; 283 284 if (cells > 1) { 285 d64 = fdt64_to_cpu(*((uint64_t *)data)); 286 if (((d64 >> 32) & 0xffffffffull) != 0 || cells > 2) 287 return (ERANGE); 288 } 289 290 return (0); 291 } 292 293 int 294 fdt_pm_is_enabled(phandle_t node) 295 { 296 int ret; 297 298 ret = 1; 299 300 #if defined(SOC_MV_KIRKWOOD) || defined(SOC_MV_DISCOVERY) 301 ret = fdt_pm(node); 302 #endif 303 return (ret); 304 } 305 306 u_long 307 fdt_data_get(void *data, int cells) 308 { 309 310 if (cells == 1) 311 return (fdt32_to_cpu(*((uint32_t *)data))); 312 313 return (fdt64_to_cpu(*((uint64_t *)data))); 314 } 315 316 int 317 fdt_addrsize_cells(phandle_t node, int *addr_cells, int *size_cells) 318 { 319 pcell_t cell; 320 int cell_size; 321 322 /* 323 * Retrieve #{address,size}-cells. 324 */ 325 cell_size = sizeof(cell); 326 if (OF_getprop(node, "#address-cells", &cell, cell_size) < cell_size) 327 cell = 2; 328 *addr_cells = fdt32_to_cpu((int)cell); 329 330 if (OF_getprop(node, "#size-cells", &cell, cell_size) < cell_size) 331 cell = 1; 332 *size_cells = fdt32_to_cpu((int)cell); 333 334 if (*addr_cells > 3 || *size_cells > 2) 335 return (ERANGE); 336 return (0); 337 } 338 339 int 340 fdt_ranges_verify(pcell_t *ranges, int tuples, int par_addr_cells, 341 int this_addr_cells, int this_size_cells) 342 { 343 int i, rv, ulsz; 344 345 if (par_addr_cells > 2 || this_addr_cells > 2 || this_size_cells > 2) 346 return (ERANGE); 347 348 /* 349 * This is the max size the resource manager can handle for addresses 350 * and sizes. 351 */ 352 ulsz = sizeof(u_long); 353 if (par_addr_cells <= ulsz && this_addr_cells <= ulsz && 354 this_size_cells <= ulsz) 355 /* We can handle everything */ 356 return (0); 357 358 rv = 0; 359 for (i = 0; i < tuples; i++) { 360 361 if (fdt_data_verify((void *)ranges, par_addr_cells)) 362 goto err; 363 ranges += par_addr_cells; 364 365 if (fdt_data_verify((void *)ranges, this_addr_cells)) 366 goto err; 367 ranges += this_addr_cells; 368 369 if (fdt_data_verify((void *)ranges, this_size_cells)) 370 goto err; 371 ranges += this_size_cells; 372 } 373 374 return (0); 375 376 err: 377 debugf("using address range >%d-bit not supported\n", ulsz * 8); 378 return (ERANGE); 379 } 380 381 int 382 fdt_data_to_res(pcell_t *data, int addr_cells, int size_cells, u_long *start, 383 u_long *count) 384 { 385 386 /* Address portion. */ 387 if (fdt_data_verify((void *)data, addr_cells)) 388 return (ERANGE); 389 390 *start = fdt_data_get((void *)data, addr_cells); 391 data += addr_cells; 392 393 /* Size portion. */ 394 if (fdt_data_verify((void *)data, size_cells)) 395 return (ERANGE); 396 397 *count = fdt_data_get((void *)data, size_cells); 398 return (0); 399 } 400 401 int 402 fdt_regsize(phandle_t node, u_long *base, u_long *size) 403 { 404 pcell_t reg[4]; 405 int addr_cells, len, size_cells; 406 407 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells)) 408 return (ENXIO); 409 410 if ((sizeof(pcell_t) * (addr_cells + size_cells)) > sizeof(reg)) 411 return (ENOMEM); 412 413 len = OF_getprop(node, "reg", ®, sizeof(reg)); 414 if (len <= 0) 415 return (EINVAL); 416 417 *base = fdt_data_get(®[0], addr_cells); 418 *size = fdt_data_get(®[addr_cells], size_cells); 419 return (0); 420 } 421 422 int 423 fdt_reg_to_rl(phandle_t node, struct resource_list *rl) 424 { 425 u_long end, count, start; 426 pcell_t *reg, *regptr; 427 pcell_t addr_cells, size_cells; 428 int tuple_size, tuples; 429 int i, rv; 430 long busaddr, bussize; 431 432 if (fdt_addrsize_cells(OF_parent(node), &addr_cells, &size_cells) != 0) 433 return (ENXIO); 434 if (fdt_get_range(OF_parent(node), 0, &busaddr, &bussize)) { 435 busaddr = 0; 436 bussize = 0; 437 } 438 439 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells); 440 tuples = OF_getprop_alloc(node, "reg", tuple_size, (void **)®); 441 debugf("addr_cells = %d, size_cells = %d\n", addr_cells, size_cells); 442 debugf("tuples = %d, tuple size = %d\n", tuples, tuple_size); 443 if (tuples <= 0) 444 /* No 'reg' property in this node. */ 445 return (0); 446 447 regptr = reg; 448 for (i = 0; i < tuples; i++) { 449 450 rv = fdt_data_to_res(reg, addr_cells, size_cells, &start, 451 &count); 452 if (rv != 0) { 453 resource_list_free(rl); 454 goto out; 455 } 456 reg += addr_cells + size_cells; 457 458 /* Calculate address range relative to base. */ 459 start += busaddr; 460 end = start + count - 1; 461 462 debugf("reg addr start = %lx, end = %lx, count = %lx\n", start, 463 end, count); 464 465 resource_list_add(rl, SYS_RES_MEMORY, i, start, end, 466 count); 467 } 468 rv = 0; 469 470 out: 471 free(regptr, M_OFWPROP); 472 return (rv); 473 } 474 475 int 476 fdt_intr_to_rl(device_t dev, phandle_t node, struct resource_list *rl, 477 struct fdt_sense_level *intr_sl) 478 { 479 phandle_t iparent; 480 uint32_t *intr, icells; 481 int nintr, i, k; 482 483 nintr = OF_getencprop_alloc(node, "interrupts", sizeof(*intr), 484 (void **)&intr); 485 if (nintr > 0) { 486 if (OF_searchencprop(node, "interrupt-parent", &iparent, 487 sizeof(iparent)) == -1) { 488 device_printf(dev, "No interrupt-parent found, " 489 "assuming direct parent\n"); 490 iparent = OF_parent(node); 491 } 492 if (OF_searchencprop(OF_xref_phandle(iparent), 493 "#interrupt-cells", &icells, sizeof(icells)) == -1) { 494 device_printf(dev, "Missing #interrupt-cells property, " 495 "assuming <1>\n"); 496 icells = 1; 497 } 498 if (icells < 1 || icells > nintr) { 499 device_printf(dev, "Invalid #interrupt-cells property " 500 "value <%d>, assuming <1>\n", icells); 501 icells = 1; 502 } 503 for (i = 0, k = 0; i < nintr; i += icells, k++) { 504 intr[i] = ofw_bus_map_intr(dev, iparent, intr[i]); 505 resource_list_add(rl, SYS_RES_IRQ, k, intr[i], intr[i], 506 1); 507 if (icells > 1) 508 ofw_bus_config_intr(dev, intr[i], intr[i+1]); 509 } 510 free(intr, M_OFWPROP); 511 } 512 513 return (0); 514 } 515 516 int 517 fdt_get_phyaddr(phandle_t node, device_t dev, int *phy_addr, void **phy_sc) 518 { 519 phandle_t phy_node; 520 pcell_t phy_handle, phy_reg; 521 uint32_t i; 522 device_t parent, child; 523 524 if (OF_getencprop(node, "phy-handle", (void *)&phy_handle, 525 sizeof(phy_handle)) <= 0) 526 return (ENXIO); 527 528 phy_node = OF_xref_phandle(phy_handle); 529 530 if (OF_getprop(phy_node, "reg", (void *)&phy_reg, 531 sizeof(phy_reg)) <= 0) 532 return (ENXIO); 533 534 *phy_addr = fdt32_to_cpu(phy_reg); 535 536 /* 537 * Search for softc used to communicate with phy. 538 */ 539 540 /* 541 * Step 1: Search for ancestor of the phy-node with a "phy-handle" 542 * property set. 543 */ 544 phy_node = OF_parent(phy_node); 545 while (phy_node != 0) { 546 if (OF_getprop(phy_node, "phy-handle", (void *)&phy_handle, 547 sizeof(phy_handle)) > 0) 548 break; 549 phy_node = OF_parent(phy_node); 550 } 551 if (phy_node == 0) 552 return (ENXIO); 553 554 /* 555 * Step 2: For each device with the same parent and name as ours 556 * compare its node with the one found in step 1, ancestor of phy 557 * node (stored in phy_node). 558 */ 559 parent = device_get_parent(dev); 560 i = 0; 561 child = device_find_child(parent, device_get_name(dev), i); 562 while (child != NULL) { 563 if (ofw_bus_get_node(child) == phy_node) 564 break; 565 i++; 566 child = device_find_child(parent, device_get_name(dev), i); 567 } 568 if (child == NULL) 569 return (ENXIO); 570 571 /* 572 * Use softc of the device found. 573 */ 574 *phy_sc = (void *)device_get_softc(child); 575 576 return (0); 577 } 578 579 int 580 fdt_get_reserved_regions(struct mem_region *mr, int *mrcnt) 581 { 582 pcell_t reserve[FDT_REG_CELLS * FDT_MEM_REGIONS]; 583 pcell_t *reservep; 584 phandle_t memory, root; 585 uint32_t memory_size; 586 int addr_cells, size_cells; 587 int i, max_size, res_len, rv, tuple_size, tuples; 588 589 max_size = sizeof(reserve); 590 root = OF_finddevice("/"); 591 memory = OF_finddevice("/memory"); 592 if (memory == -1) { 593 rv = ENXIO; 594 goto out; 595 } 596 597 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells, 598 &size_cells)) != 0) 599 goto out; 600 601 if (addr_cells > 2) { 602 rv = ERANGE; 603 goto out; 604 } 605 606 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells); 607 608 res_len = OF_getproplen(root, "memreserve"); 609 if (res_len <= 0 || res_len > sizeof(reserve)) { 610 rv = ERANGE; 611 goto out; 612 } 613 614 if (OF_getprop(root, "memreserve", reserve, res_len) <= 0) { 615 rv = ENXIO; 616 goto out; 617 } 618 619 memory_size = 0; 620 tuples = res_len / tuple_size; 621 reservep = (pcell_t *)&reserve; 622 for (i = 0; i < tuples; i++) { 623 624 rv = fdt_data_to_res(reservep, addr_cells, size_cells, 625 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size); 626 627 if (rv != 0) 628 goto out; 629 630 reservep += addr_cells + size_cells; 631 } 632 633 *mrcnt = i; 634 rv = 0; 635 out: 636 return (rv); 637 } 638 639 int 640 fdt_get_mem_regions(struct mem_region *mr, int *mrcnt, uint32_t *memsize) 641 { 642 pcell_t reg[FDT_REG_CELLS * FDT_MEM_REGIONS]; 643 pcell_t *regp; 644 phandle_t memory; 645 uint32_t memory_size; 646 int addr_cells, size_cells; 647 int i, max_size, reg_len, rv, tuple_size, tuples; 648 649 max_size = sizeof(reg); 650 memory = OF_finddevice("/memory"); 651 if (memory == -1) { 652 rv = ENXIO; 653 goto out; 654 } 655 656 if ((rv = fdt_addrsize_cells(OF_parent(memory), &addr_cells, 657 &size_cells)) != 0) 658 goto out; 659 660 if (addr_cells > 2) { 661 rv = ERANGE; 662 goto out; 663 } 664 665 tuple_size = sizeof(pcell_t) * (addr_cells + size_cells); 666 reg_len = OF_getproplen(memory, "reg"); 667 if (reg_len <= 0 || reg_len > sizeof(reg)) { 668 rv = ERANGE; 669 goto out; 670 } 671 672 if (OF_getprop(memory, "reg", reg, reg_len) <= 0) { 673 rv = ENXIO; 674 goto out; 675 } 676 677 memory_size = 0; 678 tuples = reg_len / tuple_size; 679 regp = (pcell_t *)® 680 for (i = 0; i < tuples; i++) { 681 682 rv = fdt_data_to_res(regp, addr_cells, size_cells, 683 (u_long *)&mr[i].mr_start, (u_long *)&mr[i].mr_size); 684 685 if (rv != 0) 686 goto out; 687 688 regp += addr_cells + size_cells; 689 memory_size += mr[i].mr_size; 690 } 691 692 if (memory_size == 0) { 693 rv = ERANGE; 694 goto out; 695 } 696 697 *mrcnt = i; 698 *memsize = memory_size; 699 rv = 0; 700 out: 701 return (rv); 702 } 703 704 int 705 fdt_get_unit(device_t dev) 706 { 707 const char * name; 708 709 name = ofw_bus_get_name(dev); 710 name = strchr(name, '@') + 1; 711 712 return (strtol(name,NULL,0)); 713 } 714