drivers/of/address.c

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