drivers/of/address.c

   1
   2 #include <linux/device.h>
   3 #include <linux/io.h>
   4 #include <linux/ioport.h>
   5 #include <linux/module.h>
   6 #include <linux/of_address.h>
   7 #include <linux/pci_regs.h>
   8 #include <linux/string.h>
   9
  10 /* Max address size we deal with */
  11 #define OF_MAX_ADDR_CELLS       4
  12 #define OF_CHECK_ADDR_COUNT(na) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS)
  13 #define OF_CHECK_COUNTS(na, ns) (OF_CHECK_ADDR_COUNT(na) && (ns) > 0)
  14
  15 static struct of_bus *of_match_bus(struct device_node *np);
  16 static int __of_address_to_resource(struct device_node *dev,
  17                 const __be32 *addrp, u64 size, unsigned int flags,
  18                 const char *name, struct resource *r);
  19
  20 /* Debug utility */
  21 #ifdef DEBUG
  22 static void of_dump_addr(const char *s, const __be32 *addr, int na)
  23 {
  24         printk(KERN_DEBUG "%s", s);
  25         while (na--)
  26                 printk(" %08x", be32_to_cpu(*(addr++)));
  27         printk("\n");
  28 }
  29 #else
  30 static void of_dump_addr(const char *s, const __be32 *addr, int na) { }
  31 #endif
  32
  33 /* Callbacks for bus specific translators */
  34 struct of_bus {
  35         const char      *name;
  36         const char      *addresses;
  37         int             (*match)(struct device_node *parent);
  38         void            (*count_cells)(struct device_node *child,
  39                                        int *addrc, int *sizec);
  40         u64             (*map)(__be32 *addr, const __be32 *range,
  41                                 int na, int ns, int pna);
  42         int             (*translate)(__be32 *addr, u64 offset, int na);
  43         unsigned int    (*get_flags)(const __be32 *addr);
  44 };
  45
  46 /*
  47  * Default translator (generic bus)
  48  */
  49
  50 static void of_bus_default_count_cells(struct device_node *dev,
  51                                        int *addrc, int *sizec)
  52 {
  53         if (addrc)
  54                 *addrc = of_n_addr_cells(dev);
  55         if (sizec)
  56                 *sizec = of_n_size_cells(dev);
  57 }
  58
  59 static u64 of_bus_default_map(__be32 *addr, const __be32 *range,
  60                 int na, int ns, int pna)
  61 {
  62         u64 cp, s, da;
  63
  64         cp = of_read_number(range, na);
  65         s  = of_read_number(range + na + pna, ns);
  66         da = of_read_number(addr, na);
  67
  68         pr_debug("OF: default map, cp=%llx, s=%llx, da=%llx\n",
  69                  (unsigned long long)cp, (unsigned long long)s,
  70                  (unsigned long long)da);
  71
  72         /*
  73          * If the number of address cells is larger than 2 we assume the
  74          * mapping doesn't specify a physical address. Rather, the address
  75          * specifies an identifier that must match exactly.
  76          */
  77         if (na > 2 && memcmp(range, addr, na * 4) != 0)
  78                 return OF_BAD_ADDR;
  79
  80         if (da < cp || da >= (cp + s))
  81                 return OF_BAD_ADDR;
  82         return da - cp;
  83 }
  84
  85 static int of_bus_default_translate(__be32 *addr, u64 offset, int na)
  86 {
  87         u64 a = of_read_number(addr, na);
  88         memset(addr, 0, na * 4);
  89         a += offset;
  90         if (na > 1)
  91                 addr[na - 2] = cpu_to_be32(a >> 32);
  92         addr[na - 1] = cpu_to_be32(a & 0xffffffffu);
  93
  94         return 0;
  95 }
  96
  97 static unsigned int of_bus_default_get_flags(const __be32 *addr)
  98 {
  99         return IORESOURCE_MEM;
 100 }
 101
 102 #ifdef CONFIG_PCI
 103 /*
 104  * PCI bus specific translator
 105  */
 106
 107 static int of_bus_pci_match(struct device_node *np)
 108 {
 109         /*
 110          * "vci" is for the /chaos bridge on 1st-gen PCI powermacs
 111          * "ht" is hypertransport
 112          */
 113         return !strcmp(np->type, "pci") || !strcmp(np->type, "vci") ||
 114                 !strcmp(np->type, "ht");
 115 }
 116
 117 static void of_bus_pci_count_cells(struct device_node *np,
 118                                    int *addrc, int *sizec)
 119 {
 120         if (addrc)
 121                 *addrc = 3;
 122         if (sizec)
 123                 *sizec = 2;
 124 }
 125
 126 static unsigned int of_bus_pci_get_flags(const __be32 *addr)
 127 {
 128         unsigned int flags = 0;
 129         u32 w = be32_to_cpup(addr);
 130
 131         switch((w >> 24) & 0x03) {
 132         case 0x01:
 133                 flags |= IORESOURCE_IO;
 134                 break;
 135         case 0x02: /* 32 bits */
 136         case 0x03: /* 64 bits */
 137                 flags |= IORESOURCE_MEM;
 138                 break;
 139         }
 140         if (w & 0x40000000)
 141                 flags |= IORESOURCE_PREFETCH;
 142         return flags;
 143 }
 144
 145 static u64 of_bus_pci_map(__be32 *addr, const __be32 *range, int na, int ns,
 146                 int pna)
 147 {
 148         u64 cp, s, da;
 149         unsigned int af, rf;
 150
 151         af = of_bus_pci_get_flags(addr);
 152         rf = of_bus_pci_get_flags(range);
 153
 154         /* Check address type match */
 155         if ((af ^ rf) & (IORESOURCE_MEM | IORESOURCE_IO))
 156                 return OF_BAD_ADDR;
 157
 158         /* Read address values, skipping high cell */
 159         cp = of_read_number(range + 1, na - 1);
 160         s  = of_read_number(range + na + pna, ns);
 161         da = of_read_number(addr + 1, na - 1);
 162
 163         pr_debug("OF: PCI map, cp=%llx, s=%llx, da=%llx\n",
 164                  (unsigned long long)cp, (unsigned long long)s,
 165                  (unsigned long long)da);
 166
 167         if (da < cp || da >= (cp + s))
 168                 return OF_BAD_ADDR;
 169         return da - cp;
 170 }
 171
 172 static int of_bus_pci_translate(__be32 *addr, u64 offset, int na)
 173 {
 174         return of_bus_default_translate(addr + 1, offset, na - 1);
 175 }
 176
 177 const __be32 *of_get_pci_address(struct device_node *dev, int bar_no, u64 *size,
 178                         unsigned int *flags)
 179 {
 180         const __be32 *prop;
 181         unsigned int psize;
 182         struct device_node *parent;
 183         struct of_bus *bus;
 184         int onesize, i, na, ns;
 185
 186         /* Get parent & match bus type */
 187         parent = of_get_parent(dev);
 188         if (parent == NULL)
 189                 return NULL;
 190         bus = of_match_bus(parent);
 191         if (strcmp(bus->name, "pci")) {
 192                 of_node_put(parent);
 193                 return NULL;
 194         }
 195         bus->count_cells(dev, &na, &ns);
 196         of_node_put(parent);
 197         if (!OF_CHECK_ADDR_COUNT(na))
 198                 return NULL;
 199
 200         /* Get "reg" or "assigned-addresses" property */
 201         prop = of_get_property(dev, bus->addresses, &psize);
 202         if (prop == NULL)
 203                 return NULL;
 204         psize /= 4;
 205
 206         onesize = na + ns;
 207         for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++) {
 208                 u32 val = be32_to_cpu(prop[0]);
 209                 if ((val & 0xff) == ((bar_no * 4) + PCI_BASE_ADDRESS_0)) {
 210                         if (size)
 211                                 *size = of_read_number(prop + na, ns);
 212                         if (flags)
 213                                 *flags = bus->get_flags(prop);
 214                         return prop;
 215                 }
 216         }
 217         return NULL;
 218 }
 219 EXPORT_SYMBOL(of_get_pci_address);
 220
 221 int of_pci_address_to_resource(struct device_node *dev, int bar,
 222                                struct resource *r)
 223 {
 224         const __be32    *addrp;
 225         u64             size;
 226         unsigned int    flags;
 227
 228         addrp = of_get_pci_address(dev, bar, &size, &flags);
 229         if (addrp == NULL)
 230                 return -EINVAL;
 231         return __of_address_to_resource(dev, addrp, size, flags, NULL, r);
 232 }
 233 EXPORT_SYMBOL_GPL(of_pci_address_to_resource);
 234 #endif /* CONFIG_PCI */
 235
 236 /*
 237  * ISA bus specific translator
 238  */
 239
 240 static int of_bus_isa_match(struct device_node *np)
 241 {
 242         return !strcmp(np->name, "isa");
 243 }
 244
 245 static void of_bus_isa_count_cells(struct device_node *child,
 246                                    int *addrc, int *sizec)
 247 {
 248         if (addrc)
 249                 *addrc = 2;
 250         if (sizec)
 251                 *sizec = 1;
 252 }
 253
 254 static u64 of_bus_isa_map(__be32 *addr, const __be32 *range, int na, int ns,
 255                 int pna)
 256 {
 257         u64 cp, s, da;
 258
 259         /* Check address type match */
 260         if ((addr[0] ^ range[0]) & cpu_to_be32(1))
 261                 return OF_BAD_ADDR;
 262
 263         /* Read address values, skipping high cell */
 264         cp = of_read_number(range + 1, na - 1);
 265         s  = of_read_number(range + na + pna, ns);
 266         da = of_read_number(addr + 1, na - 1);
 267
 268         pr_debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n",
 269                  (unsigned long long)cp, (unsigned long long)s,
 270                  (unsigned long long)da);
 271
 272         if (da < cp || da >= (cp + s))
 273                 return OF_BAD_ADDR;
 274         return da - cp;
 275 }
 276
 277 static int of_bus_isa_translate(__be32 *addr, u64 offset, int na)
 278 {
 279         return of_bus_default_translate(addr + 1, offset, na - 1);
 280 }
 281
 282 static unsigned int of_bus_isa_get_flags(const __be32 *addr)
 283 {
 284         unsigned int flags = 0;
 285         u32 w = be32_to_cpup(addr);
 286
 287         if (w & 1)
 288                 flags |= IORESOURCE_IO;
 289         else
 290                 flags |= IORESOURCE_MEM;
 291         return flags;
 292 }
 293
 294 /*
 295  * Array of bus specific translators
 296  */
 297
 298 static struct of_bus of_busses[] = {
 299 #ifdef CONFIG_PCI
 300         /* PCI */
 301         {
 302                 .name = "pci",
 303                 .addresses = "assigned-addresses",
 304                 .match = of_bus_pci_match,
 305                 .count_cells = of_bus_pci_count_cells,
 306                 .map = of_bus_pci_map,
 307                 .translate = of_bus_pci_translate,
 308                 .get_flags = of_bus_pci_get_flags,
 309         },
 310 #endif /* CONFIG_PCI */
 311         /* ISA */
 312         {
 313                 .name = "isa",
 314                 .addresses = "reg",
 315                 .match = of_bus_isa_match,
 316                 .count_cells = of_bus_isa_count_cells,
 317                 .map = of_bus_isa_map,
 318                 .translate = of_bus_isa_translate,
 319                 .get_flags = of_bus_isa_get_flags,
 320         },
 321         /* Default */
 322         {
 323                 .name = "default",
 324                 .addresses = "reg",
 325                 .match = NULL,
 326                 .count_cells = of_bus_default_count_cells,
 327                 .map = of_bus_default_map,
 328                 .translate = of_bus_default_translate,
 329                 .get_flags = of_bus_default_get_flags,
 330         },
 331 };
 332
 333 static struct of_bus *of_match_bus(struct device_node *np)
 334 {
 335         int i;
 336
 337         for (i = 0; i < ARRAY_SIZE(of_busses); i++)
 338                 if (!of_busses[i].match || of_busses[i].match(np))
 339                         return &of_busses[i];
 340         BUG();
 341         return NULL;
 342 }
 343
 344 static int of_translate_one(struct device_node *parent, struct of_bus *bus,
 345                             struct of_bus *pbus, __be32 *addr,
 346                             int na, int ns, int pna, const char *rprop)
 347 {
 348         const __be32 *ranges;
 349         unsigned int rlen;
 350         int rone;
 351         u64 offset = OF_BAD_ADDR;
 352
 353         /* Normally, an absence of a "ranges" property means we are
 354          * crossing a non-translatable boundary, and thus the addresses
 355          * below the current not cannot be converted to CPU physical ones.
 356          * Unfortunately, while this is very clear in the spec, it's not
 357          * what Apple understood, and they do have things like /uni-n or
 358          * /ht nodes with no "ranges" property and a lot of perfectly
 359          * useable mapped devices below them. Thus we treat the absence of
 360          * "ranges" as equivalent to an empty "ranges" property which means
 361          * a 1:1 translation at that level. It's up to the caller not to try
 362          * to translate addresses that aren't supposed to be translated in
 363          * the first place. --BenH.
 364          *
 365          * As far as we know, this damage only exists on Apple machines, so
 366          * This code is only enabled on powerpc. --gcl
 367          */
 368         ranges = of_get_property(parent, rprop, &rlen);
 369 #if !defined(CONFIG_PPC)
 370         if (ranges == NULL) {
 371                 pr_err("OF: no ranges; cannot translate\n");
 372                 return 1;
 373         }
 374 #endif /* !defined(CONFIG_PPC) */
 375         if (ranges == NULL || rlen == 0) {
 376                 offset = of_read_number(addr, na);
 377                 memset(addr, 0, pna * 4);
 378                 pr_debug("OF: empty ranges; 1:1 translation\n");
 379                 goto finish;
 380         }
 381
 382         pr_debug("OF: walking ranges...\n");
 383
 384         /* Now walk through the ranges */
 385         rlen /= 4;
 386         rone = na + pna + ns;
 387         for (; rlen >= rone; rlen -= rone, ranges += rone) {
 388                 offset = bus->map(addr, ranges, na, ns, pna);
 389                 if (offset != OF_BAD_ADDR)
 390                         break;
 391         }
 392         if (offset == OF_BAD_ADDR) {
 393                 pr_debug("OF: not found !\n");
 394                 return 1;
 395         }
 396         memcpy(addr, ranges + na, 4 * pna);
 397
 398  finish:
 399         of_dump_addr("OF: parent translation for:", addr, pna);
 400         pr_debug("OF: with offset: %llx\n", (unsigned long long)offset);
 401
 402         /* Translate it into parent bus space */
 403         return pbus->translate(addr, offset, pna);
 404 }
 405
 406 /*
 407  * Translate an address from the device-tree into a CPU physical address,
 408  * this walks up the tree and applies the various bus mappings on the
 409  * way.
 410  *
 411  * Note: We consider that crossing any level with #size-cells == 0 to mean
 412  * that translation is impossible (that is we are not dealing with a value
 413  * that can be mapped to a cpu physical address). This is not really specified
 414  * that way, but this is traditionally the way IBM at least do things
 415  */
 416 static u64 __of_translate_address(struct device_node *dev,
 417                                   const __be32 *in_addr, const char *rprop)
 418 {
 419         struct device_node *parent = NULL;
 420         struct of_bus *bus, *pbus;
 421         __be32 addr[OF_MAX_ADDR_CELLS];
 422         int na, ns, pna, pns;
 423         u64 result = OF_BAD_ADDR;
 424
 425         pr_debug("OF: ** translation for device %s **\n", dev->full_name);
 426
 427         /* Increase refcount at current level */
 428         of_node_get(dev);
 429
 430         /* Get parent & match bus type */
 431         parent = of_get_parent(dev);
 432         if (parent == NULL)
 433                 goto bail;
 434         bus = of_match_bus(parent);
 435
 436         /* Count address cells & copy address locally */
 437         bus->count_cells(dev, &na, &ns);
 438         if (!OF_CHECK_COUNTS(na, ns)) {
 439                 printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
 440                        dev->full_name);
 441                 goto bail;
 442         }
 443         memcpy(addr, in_addr, na * 4);
 444
 445         pr_debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
 446             bus->name, na, ns, parent->full_name);
 447         of_dump_addr("OF: translating address:", addr, na);
 448
 449         /* Translate */
 450         for (;;) {
 451                 /* Switch to parent bus */
 452                 of_node_put(dev);
 453                 dev = parent;
 454                 parent = of_get_parent(dev);
 455
 456                 /* If root, we have finished */
 457                 if (parent == NULL) {
 458                         pr_debug("OF: reached root node\n");
 459                         result = of_read_number(addr, na);
 460                         break;
 461                 }
 462
 463                 /* Get new parent bus and counts */
 464                 pbus = of_match_bus(parent);
 465                 pbus->count_cells(dev, &pna, &pns);
 466                 if (!OF_CHECK_COUNTS(pna, pns)) {
 467                         printk(KERN_ERR "prom_parse: Bad cell count for %s\n",
 468                                dev->full_name);
 469                         break;
 470                 }
 471
 472                 pr_debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
 473                     pbus->name, pna, pns, parent->full_name);
 474
 475                 /* Apply bus translation */
 476                 if (of_translate_one(dev, bus, pbus, addr, na, ns, pna, rprop))
 477                         break;
 478
 479                 /* Complete the move up one level */
 480                 na = pna;
 481                 ns = pns;
 482                 bus = pbus;
 483
 484                 of_dump_addr("OF: one level translation:", addr, na);
 485         }
 486  bail:
 487         of_node_put(parent);
 488         of_node_put(dev);
 489
 490         return result;
 491 }
 492
 493 u64 of_translate_address(struct device_node *dev, const __be32 *in_addr)
 494 {
 495         return __of_translate_address(dev, in_addr, "ranges");
 496 }
 497 EXPORT_SYMBOL(of_translate_address);
 498
 499 u64 of_translate_dma_address(struct device_node *dev, const __be32 *in_addr)
 500 {
 501         return __of_translate_address(dev, in_addr, "dma-ranges");
 502 }
 503 EXPORT_SYMBOL(of_translate_dma_address);
 504
 505 bool of_can_translate_address(struct device_node *dev)
 506 {
 507         struct device_node *parent;
 508         struct of_bus *bus;
 509         int na, ns;
 510
 511         parent = of_get_parent(dev);
 512         if (parent == NULL)
 513                 return false;
 514
 515         bus = of_match_bus(parent);
 516         bus->count_cells(dev, &na, &ns);
 517
 518         of_node_put(parent);
 519
 520         return OF_CHECK_COUNTS(na, ns);
 521 }
 522 EXPORT_SYMBOL(of_can_translate_address);
 523
 524 const __be32 *of_get_address(struct device_node *dev, int index, u64 *size,
 525                     unsigned int *flags)
 526 {
 527         const __be32 *prop;
 528         unsigned int psize;
 529         struct device_node *parent;
 530         struct of_bus *bus;
 531         int onesize, i, na, ns;
 532
 533         /* Get parent & match bus type */
 534         parent = of_get_parent(dev);
 535         if (parent == NULL)
 536                 return NULL;
 537         bus = of_match_bus(parent);
 538         bus->count_cells(dev, &na, &ns);
 539         of_node_put(parent);
 540         if (!OF_CHECK_ADDR_COUNT(na))
 541                 return NULL;
 542
 543         /* Get "reg" or "assigned-addresses" property */
 544         prop = of_get_property(dev, bus->addresses, &psize);
 545         if (prop == NULL)
 546                 return NULL;
 547         psize /= 4;
 548
 549         onesize = na + ns;
 550         for (i = 0; psize >= onesize; psize -= onesize, prop += onesize, i++)
 551                 if (i == index) {
 552                         if (size)
 553                                 *size = of_read_number(prop + na, ns);
 554                         if (flags)
 555                                 *flags = bus->get_flags(prop);
 556                         return prop;
 557                 }
 558         return NULL;
 559 }
 560 EXPORT_SYMBOL(of_get_address);
 561
 562 static int __of_address_to_resource(struct device_node *dev,
 563                 const __be32 *addrp, u64 size, unsigned int flags,
 564                 const char *name, struct resource *r)
 565 {
 566         u64 taddr;
 567
 568         if ((flags & (IORESOURCE_IO | IORESOURCE_MEM)) == 0)
 569                 return -EINVAL;
 570         taddr = of_translate_address(dev, addrp);
 571         if (taddr == OF_BAD_ADDR)
 572                 return -EINVAL;
 573         memset(r, 0, sizeof(struct resource));
 574         if (flags & IORESOURCE_IO) {
 575                 unsigned long port;
 576                 port = pci_address_to_pio(taddr);
 577                 if (port == (unsigned long)-1)
 578                         return -EINVAL;
 579                 r->start = port;
 580                 r->end = port + size - 1;
 581         } else {
 582                 r->start = taddr;
 583                 r->end = taddr + size - 1;
 584         }
 585         r->flags = flags;
 586         r->name = name ? name : dev->full_name;
 587
 588         return 0;
 589 }
 590
 591 /**
 592  * of_address_to_resource - Translate device tree address and return as resource
 593  *
 594  * Note that if your address is a PIO address, the conversion will fail if
 595  * the physical address can't be internally converted to an IO token with
 596  * pci_address_to_pio(), that is because it's either called to early or it
 597  * can't be matched to any host bridge IO space
 598  */
 599 int of_address_to_resource(struct device_node *dev, int index,
 600                            struct resource *r)
 601 {
 602         const __be32    *addrp;
 603         u64             size;
 604         unsigned int    flags;
 605         const char      *name = NULL;
 606
 607         addrp = of_get_address(dev, index, &size, &flags);
 608         if (addrp == NULL)
 609                 return -EINVAL;
 610
 611         /* Get optional "reg-names" property to add a name to a resource */
 612         of_property_read_string_index(dev, "reg-names", index, &name);
 613
 614         return __of_address_to_resource(dev, addrp, size, flags, name, r);
 615 }
 616 EXPORT_SYMBOL_GPL(of_address_to_resource);
 617
 618 struct device_node *of_find_matching_node_by_address(struct device_node *from,
 619                                         const struct of_device_id *matches,
 620                                         u64 base_address)
 621 {
 622         struct device_node *dn = of_find_matching_node(from, matches);
 623         struct resource res;
 624
 625         while (dn) {
 626                 if (of_address_to_resource(dn, 0, &res))
 627                         continue;
 628                 if (res.start == base_address)
 629                         return dn;
 630                 dn = of_find_matching_node(dn, matches);
 631         }
 632
 633         return NULL;
 634 }
 635
 636
 637 /**
 638  * of_iomap - Maps the memory mapped IO for a given device_node
 639  * @device:     the device whose io range will be mapped
 640  * @index:      index of the io range
 641  *
 642  * Returns a pointer to the mapped memory
 643  */
 644 void __iomem *of_iomap(struct device_node *np, int index)
 645 {
 646         struct resource res;
 647
 648         if (of_address_to_resource(np, index, &res))
 649                 return NULL;
 650
 651         return ioremap(res.start, resource_size(&res));
 652 }
 653 EXPORT_SYMBOL(of_iomap);