arch/sparc/kernel/prom_32.c

   1 /*
   2  * Procedures for creating, accessing and interpreting the device tree.
   3  *
   4  * Paul Mackerras       August 1996.
   5  * Copyright (C) 1996-2005 Paul Mackerras.
   6  *
   7  *  Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
   8  *    {engebret|bergner}@us.ibm.com
   9  *
  10  *  Adapted for sparc32 by David S. Miller davem@davemloft.net
  11  *
  12  *      This program is free software; you can redistribute it and/or
  13  *      modify it under the terms of the GNU General Public License
  14  *      as published by the Free Software Foundation; either version
  15  *      2 of the License, or (at your option) any later version.
  16  */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/types.h>
  20 #include <linux/string.h>
  21 #include <linux/mm.h>
  22 #include <linux/bootmem.h>
  23 #include <linux/module.h>
  24
  25 #include <asm/prom.h>
  26 #include <asm/oplib.h>
  27
  28 #include "prom.h"
  29
  30 static unsigned int prom_early_allocated;
  31
  32 void * __init prom_early_alloc(unsigned long size)
  33 {
  34         void *ret;
  35
  36         ret = __alloc_bootmem(size, SMP_CACHE_BYTES, 0UL);
  37         if (ret != NULL)
  38                 memset(ret, 0, size);
  39
  40         prom_early_allocated += size;
  41
  42         return ret;
  43 }
  44
  45 static int is_root_node(const struct device_node *dp)
  46 {
  47         if (!dp)
  48                 return 0;
  49
  50         return (dp->parent == NULL);
  51 }
  52
  53 /* The following routines deal with the black magic of fully naming a
  54  * node.
  55  *
  56  * Certain well known named nodes are just the simple name string.
  57  *
  58  * Actual devices have an address specifier appended to the base name
  59  * string, like this "foo@addr".  The "addr" can be in any number of
  60  * formats, and the platform plus the type of the node determine the
  61  * format and how it is constructed.
  62  *
  63  * For children of the ROOT node, the naming convention is fixed and
  64  * determined by whether this is a sun4u or sun4v system.
  65  *
  66  * For children of other nodes, it is bus type specific.  So
  67  * we walk up the tree until we discover a "device_type" property
  68  * we recognize and we go from there.
  69  */
  70 static void __init sparc32_path_component(struct device_node *dp, char *tmp_buf)
  71 {
  72         struct linux_prom_registers *regs;
  73         struct property *rprop;
  74
  75         rprop = of_find_property(dp, "reg", NULL);
  76         if (!rprop)
  77                 return;
  78
  79         regs = rprop->value;
  80         sprintf(tmp_buf, "%s@%x,%x",
  81                 dp->name,
  82                 regs->which_io, regs->phys_addr);
  83 }
  84
  85 /* "name@slot,offset"  */
  86 static void __init sbus_path_component(struct device_node *dp, char *tmp_buf)
  87 {
  88         struct linux_prom_registers *regs;
  89         struct property *prop;
  90
  91         prop = of_find_property(dp, "reg", NULL);
  92         if (!prop)
  93                 return;
  94
  95         regs = prop->value;
  96         sprintf(tmp_buf, "%s@%x,%x",
  97                 dp->name,
  98                 regs->which_io,
  99                 regs->phys_addr);
 100 }
 101
 102 /* "name@devnum[,func]" */
 103 static void __init pci_path_component(struct device_node *dp, char *tmp_buf)
 104 {
 105         struct linux_prom_pci_registers *regs;
 106         struct property *prop;
 107         unsigned int devfn;
 108
 109         prop = of_find_property(dp, "reg", NULL);
 110         if (!prop)
 111                 return;
 112
 113         regs = prop->value;
 114         devfn = (regs->phys_hi >> 8) & 0xff;
 115         if (devfn & 0x07) {
 116                 sprintf(tmp_buf, "%s@%x,%x",
 117                         dp->name,
 118                         devfn >> 3,
 119                         devfn & 0x07);
 120         } else {
 121                 sprintf(tmp_buf, "%s@%x",
 122                         dp->name,
 123                         devfn >> 3);
 124         }
 125 }
 126
 127 /* "name@addrhi,addrlo" */
 128 static void __init ebus_path_component(struct device_node *dp, char *tmp_buf)
 129 {
 130         struct linux_prom_registers *regs;
 131         struct property *prop;
 132
 133         prop = of_find_property(dp, "reg", NULL);
 134         if (!prop)
 135                 return;
 136
 137         regs = prop->value;
 138
 139         sprintf(tmp_buf, "%s@%x,%x",
 140                 dp->name,
 141                 regs->which_io, regs->phys_addr);
 142 }
 143
 144 static void __init __build_path_component(struct device_node *dp, char *tmp_buf)
 145 {
 146         struct device_node *parent = dp->parent;
 147
 148         if (parent != NULL) {
 149                 if (!strcmp(parent->type, "pci") ||
 150                     !strcmp(parent->type, "pciex"))
 151                         return pci_path_component(dp, tmp_buf);
 152                 if (!strcmp(parent->type, "sbus"))
 153                         return sbus_path_component(dp, tmp_buf);
 154                 if (!strcmp(parent->type, "ebus"))
 155                         return ebus_path_component(dp, tmp_buf);
 156
 157                 /* "isa" is handled with platform naming */
 158         }
 159
 160         /* Use platform naming convention.  */
 161         return sparc32_path_component(dp, tmp_buf);
 162 }
 163
 164 static char * __init build_path_component(struct device_node *dp)
 165 {
 166         char tmp_buf[64], *n;
 167
 168         tmp_buf[0] = '\0';
 169         __build_path_component(dp, tmp_buf);
 170         if (tmp_buf[0] == '\0')
 171                 strcpy(tmp_buf, dp->name);
 172
 173         n = prom_early_alloc(strlen(tmp_buf) + 1);
 174         strcpy(n, tmp_buf);
 175
 176         return n;
 177 }
 178
 179 static char * __init build_full_name(struct device_node *dp)
 180 {
 181         int len, ourlen, plen;
 182         char *n;
 183
 184         plen = strlen(dp->parent->full_name);
 185         ourlen = strlen(dp->path_component_name);
 186         len = ourlen + plen + 2;
 187
 188         n = prom_early_alloc(len);
 189         strcpy(n, dp->parent->full_name);
 190         if (!is_root_node(dp->parent)) {
 191                 strcpy(n + plen, "/");
 192                 plen++;
 193         }
 194         strcpy(n + plen, dp->path_component_name);
 195
 196         return n;
 197 }
 198
 199 static struct property * __init build_one_prop(phandle node, char *prev, char *special_name, void *special_val, int special_len)
 200 {
 201         static struct property *tmp = NULL;
 202         struct property *p;
 203         int len;
 204         const char *name;
 205
 206         if (tmp) {
 207                 p = tmp;
 208                 memset(p, 0, sizeof(*p) + 32);
 209                 tmp = NULL;
 210         } else {
 211                 p = prom_early_alloc(sizeof(struct property) + 32);
 212                 p->unique_id = prom_unique_id++;
 213         }
 214
 215         p->name = (char *) (p + 1);
 216         if (special_name) {
 217                 strcpy(p->name, special_name);
 218                 p->length = special_len;
 219                 p->value = prom_early_alloc(special_len);
 220                 memcpy(p->value, special_val, special_len);
 221         } else {
 222                 if (prev == NULL) {
 223                         name = prom_firstprop(node, NULL);
 224                 } else {
 225                         name = prom_nextprop(node, prev, NULL);
 226                 }
 227                 if (strlen(name) == 0) {
 228                         tmp = p;
 229                         return NULL;
 230                 }
 231                 strcpy(p->name, name);
 232                 p->length = prom_getproplen(node, p->name);
 233                 if (p->length <= 0) {
 234                         p->length = 0;
 235                 } else {
 236                         p->value = prom_early_alloc(p->length + 1);
 237                         len = prom_getproperty(node, p->name, p->value,
 238                                                p->length);
 239                         if (len <= 0)
 240                                 p->length = 0;
 241                         ((unsigned char *)p->value)[p->length] = '\0';
 242                 }
 243         }
 244         return p;
 245 }
 246
 247 static struct property * __init build_prop_list(phandle node)
 248 {
 249         struct property *head, *tail;
 250
 251         head = tail = build_one_prop(node, NULL,
 252                                      ".node", &node, sizeof(node));
 253
 254         tail->next = build_one_prop(node, NULL, NULL, NULL, 0);
 255         tail = tail->next;
 256         while(tail) {
 257                 tail->next = build_one_prop(node, tail->name,
 258                                             NULL, NULL, 0);
 259                 tail = tail->next;
 260         }
 261
 262         return head;
 263 }
 264
 265 static char * __init get_one_property(phandle node, char *name)
 266 {
 267         char *buf = "<NULL>";
 268         int len;
 269
 270         len = prom_getproplen(node, name);
 271         if (len > 0) {
 272                 buf = prom_early_alloc(len);
 273                 len = prom_getproperty(node, name, buf, len);
 274         }
 275
 276         return buf;
 277 }
 278
 279 static struct device_node * __init create_node(phandle node)
 280 {
 281         struct device_node *dp;
 282
 283         if (!node)
 284                 return NULL;
 285
 286         dp = prom_early_alloc(sizeof(*dp));
 287         dp->unique_id = prom_unique_id++;
 288
 289         kref_init(&dp->kref);
 290
 291         dp->name = get_one_property(node, "name");
 292         dp->type = get_one_property(node, "device_type");
 293         dp->node = node;
 294
 295         /* Build interrupts later... */
 296
 297         dp->properties = build_prop_list(node);
 298
 299         return dp;
 300 }
 301
 302 static struct device_node * __init build_tree(struct device_node *parent, phandle node, struct device_node ***nextp)
 303 {
 304         struct device_node *dp;
 305
 306         dp = create_node(node);
 307         if (dp) {
 308                 *(*nextp) = dp;
 309                 *nextp = &dp->allnext;
 310
 311                 dp->parent = parent;
 312                 dp->path_component_name = build_path_component(dp);
 313                 dp->full_name = build_full_name(dp);
 314
 315                 dp->child = build_tree(dp, prom_getchild(node), nextp);
 316
 317                 dp->sibling = build_tree(parent, prom_getsibling(node), nextp);
 318         }
 319
 320         return dp;
 321 }
 322
 323 struct device_node *of_console_device;
 324 EXPORT_SYMBOL(of_console_device);
 325
 326 char *of_console_path;
 327 EXPORT_SYMBOL(of_console_path);
 328
 329 char *of_console_options;
 330 EXPORT_SYMBOL(of_console_options);
 331
 332 extern void restore_current(void);
 333
 334 static void __init of_console_init(void)
 335 {
 336         char *msg = "OF stdout device is: %s\n";
 337         struct device_node *dp;
 338         unsigned long flags;
 339         const char *type;
 340         phandle node;
 341         int skip, tmp, fd;
 342
 343         of_console_path = prom_early_alloc(256);
 344
 345         switch (prom_vers) {
 346         case PROM_V0:
 347                 skip = 0;
 348                 switch (*romvec->pv_stdout) {
 349                 case PROMDEV_SCREEN:
 350                         type = "display";
 351                         break;
 352
 353                 case PROMDEV_TTYB:
 354                         skip = 1;
 355                         /* FALLTHRU */
 356
 357                 case PROMDEV_TTYA:
 358                         type = "serial";
 359                         break;
 360
 361                 default:
 362                         prom_printf("Invalid PROM_V0 stdout value %u\n",
 363                                     *romvec->pv_stdout);
 364                         prom_halt();
 365                 }
 366
 367                 tmp = skip;
 368                 for_each_node_by_type(dp, type) {
 369                         if (!tmp--)
 370                                 break;
 371                 }
 372                 if (!dp) {
 373                         prom_printf("Cannot find PROM_V0 console node.\n");
 374                         prom_halt();
 375                 }
 376                 of_console_device = dp;
 377
 378                 strcpy(of_console_path, dp->full_name);
 379                 if (!strcmp(type, "serial")) {
 380                         strcat(of_console_path,
 381                                (skip ? ":b" : ":a"));
 382                 }
 383                 break;
 384
 385         default:
 386         case PROM_V2:
 387         case PROM_V3:
 388                 fd = *romvec->pv_v2bootargs.fd_stdout;
 389
 390                 spin_lock_irqsave(&prom_lock, flags);
 391                 node = (*romvec->pv_v2devops.v2_inst2pkg)(fd);
 392                 restore_current();
 393                 spin_unlock_irqrestore(&prom_lock, flags);
 394
 395                 if (!node) {
 396                         prom_printf("Cannot resolve stdout node from "
 397                                     "instance %08x.\n", fd);
 398                         prom_halt();
 399                 }
 400                 dp = of_find_node_by_phandle(node);
 401                 type = of_get_property(dp, "device_type", NULL);
 402
 403                 if (!type) {
 404                         prom_printf("Console stdout lacks "
 405                                     "device_type property.\n");
 406                         prom_halt();
 407                 }
 408
 409                 if (strcmp(type, "display") && strcmp(type, "serial")) {
 410                         prom_printf("Console device_type is neither display "
 411                                     "nor serial.\n");
 412                         prom_halt();
 413                 }
 414
 415                 of_console_device = dp;
 416
 417                 if (prom_vers == PROM_V2) {
 418                         strcpy(of_console_path, dp->full_name);
 419                         switch (*romvec->pv_stdout) {
 420                         case PROMDEV_TTYA:
 421                                 strcat(of_console_path, ":a");
 422                                 break;
 423                         case PROMDEV_TTYB:
 424                                 strcat(of_console_path, ":b");
 425                                 break;
 426                         }
 427                 } else {
 428                         const char *path;
 429
 430                         dp = of_find_node_by_path("/");
 431                         path = of_get_property(dp, "stdout-path", NULL);
 432                         if (!path) {
 433                                 prom_printf("No stdout-path in root node.\n");
 434                                 prom_halt();
 435                         }
 436                         strcpy(of_console_path, path);
 437                 }
 438                 break;
 439         }
 440
 441         of_console_options = strrchr(of_console_path, ':');
 442         if (of_console_options) {
 443                 of_console_options++;
 444                 if (*of_console_options == '\0')
 445                         of_console_options = NULL;
 446         }
 447
 448         prom_printf(msg, of_console_path);
 449         printk(msg, of_console_path);
 450 }
 451
 452 void __init prom_build_devicetree(void)
 453 {
 454         struct device_node **nextp;
 455
 456         allnodes = create_node(prom_root_node);
 457         allnodes->path_component_name = "";
 458         allnodes->full_name = "/";
 459
 460         nextp = &allnodes->allnext;
 461         allnodes->child = build_tree(allnodes,
 462                                      prom_getchild(allnodes->node),
 463                                      &nextp);
 464         of_console_init();
 465
 466         printk("PROM: Built device tree with %u bytes of memory.\n",
 467                prom_early_allocated);
 468 }