arch/powerpc/platforms/powermac/bootx_init.c

   1 /*
   2  *  Early boot support code for BootX bootloader
   3  *
   4  *  Copyright (C) 2005 Ben. Herrenschmidt (benh@kernel.crashing.org)
   5  *
   6  *  This program is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU General Public License
   8  *  as published by the Free Software Foundation; either version
   9  *  2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/string.h>
  14 #include <linux/init.h>
  15 #include <linux/version.h>
  16 #include <asm/sections.h>
  17 #include <asm/prom.h>
  18 #include <asm/page.h>
  19 #include <asm/bootx.h>
  20 #include <asm/bootinfo.h>
  21 #include <asm/btext.h>
  22 #include <asm/io.h>
  23
  24 #undef DEBUG
  25 #define SET_BOOT_BAT
  26
  27 #ifdef DEBUG
  28 #define DBG(fmt...) do { bootx_printf(fmt); } while(0)
  29 #else
  30 #define DBG(fmt...) do { } while(0)
  31 #endif
  32
  33 extern void __start(unsigned long r3, unsigned long r4, unsigned long r5);
  34
  35 static unsigned long __initdata bootx_dt_strbase;
  36 static unsigned long __initdata bootx_dt_strend;
  37 static unsigned long __initdata bootx_node_chosen;
  38 static boot_infos_t * __initdata bootx_info;
  39 static char __initdata bootx_disp_path[256];
  40
  41 /* Is boot-info compatible ? */
  42 #define BOOT_INFO_IS_COMPATIBLE(bi) \
  43         ((bi)->compatible_version <= BOOT_INFO_VERSION)
  44 #define BOOT_INFO_IS_V2_COMPATIBLE(bi)  ((bi)->version >= 2)
  45 #define BOOT_INFO_IS_V4_COMPATIBLE(bi)  ((bi)->version >= 4)
  46
  47 #ifdef CONFIG_BOOTX_TEXT
  48 static void __init bootx_printf(const char *format, ...)
  49 {
  50         const char *p, *q, *s;
  51         va_list args;
  52         unsigned long v;
  53
  54         va_start(args, format);
  55         for (p = format; *p != 0; p = q) {
  56                 for (q = p; *q != 0 && *q != '\n' && *q != '%'; ++q)
  57                         ;
  58                 if (q > p)
  59                         btext_drawtext(p, q - p);
  60                 if (*q == 0)
  61                         break;
  62                 if (*q == '\n') {
  63                         ++q;
  64                         btext_flushline();
  65                         btext_drawstring("\r\n");
  66                         btext_flushline();
  67                         continue;
  68                 }
  69                 ++q;
  70                 if (*q == 0)
  71                         break;
  72                 switch (*q) {
  73                 case 's':
  74                         ++q;
  75                         s = va_arg(args, const char *);
  76                         if (s == NULL)
  77                                 s = "<NULL>";
  78                         btext_drawstring(s);
  79                         break;
  80                 case 'x':
  81                         ++q;
  82                         v = va_arg(args, unsigned long);
  83                         btext_drawhex(v);
  84                         break;
  85                 }
  86         }
  87 }
  88 #else /* CONFIG_BOOTX_TEXT */
  89 static void __init bootx_printf(const char *format, ...) {}
  90 #endif /* CONFIG_BOOTX_TEXT */
  91
  92 static void * __init bootx_early_getprop(unsigned long base,
  93                                          unsigned long node,
  94                                          char *prop)
  95 {
  96         struct bootx_dt_node *np = (struct bootx_dt_node *)(base + node);
  97         u32 *ppp = &np->properties;
  98
  99         while(*ppp) {
 100                 struct bootx_dt_prop *pp =
 101                         (struct bootx_dt_prop *)(base + *ppp);
 102
 103                 if (strcmp((char *)((unsigned long)pp->name + base),
 104                            prop) == 0) {
 105                         return (void *)((unsigned long)pp->value + base);
 106                 }
 107                 ppp = &pp->next;
 108         }
 109         return NULL;
 110 }
 111
 112 #define dt_push_token(token, mem) \
 113         do { \
 114                 *(mem) = _ALIGN_UP(*(mem),4); \
 115                 *((u32 *)*(mem)) = token; \
 116                 *(mem) += 4; \
 117         } while(0)
 118
 119 static unsigned long __init bootx_dt_find_string(char *str)
 120 {
 121         char *s, *os;
 122
 123         s = os = (char *)bootx_dt_strbase;
 124         s += 4;
 125         while (s <  (char *)bootx_dt_strend) {
 126                 if (strcmp(s, str) == 0)
 127                         return s - os;
 128                 s += strlen(s) + 1;
 129         }
 130         return 0;
 131 }
 132
 133 static void __init bootx_dt_add_prop(char *name, void *data, int size,
 134                                   unsigned long *mem_end)
 135 {
 136         unsigned long soff = bootx_dt_find_string(name);
 137         if (data == NULL)
 138                 size = 0;
 139         if (soff == 0) {
 140                 bootx_printf("WARNING: Can't find string index for <%s>\n",
 141                              name);
 142                 return;
 143         }
 144         if (size > 0x20000) {
 145                 bootx_printf("WARNING: ignoring large property ");
 146                 bootx_printf("%s length 0x%x\n", name, size);
 147                 return;
 148         }
 149         dt_push_token(OF_DT_PROP, mem_end);
 150         dt_push_token(size, mem_end);
 151         dt_push_token(soff, mem_end);
 152
 153         /* push property content */
 154         if (size && data) {
 155                 memcpy((void *)*mem_end, data, size);
 156                 *mem_end = _ALIGN_UP(*mem_end + size, 4);
 157         }
 158 }
 159
 160 static void __init bootx_add_chosen_props(unsigned long base,
 161                                           unsigned long *mem_end)
 162 {
 163         u32 val;
 164
 165         if (bootx_info->kernelParamsOffset) {
 166                 char *args = (char *)((unsigned long)bootx_info) +
 167                         bootx_info->kernelParamsOffset;
 168                 bootx_dt_add_prop("bootargs", args, strlen(args) + 1, mem_end);
 169         }
 170         if (bootx_info->ramDisk) {
 171                 val = ((unsigned long)bootx_info) + bootx_info->ramDisk;
 172                 bootx_dt_add_prop("linux,initrd-start", &val, 4, mem_end);
 173                 val += bootx_info->ramDiskSize;
 174                 bootx_dt_add_prop("linux,initrd-end", &val, 4, mem_end);
 175         }
 176         if (strlen(bootx_disp_path))
 177                 bootx_dt_add_prop("linux,stdout-path", bootx_disp_path,
 178                                   strlen(bootx_disp_path) + 1, mem_end);
 179 }
 180
 181 static void __init bootx_add_display_props(unsigned long base,
 182                                            unsigned long *mem_end)
 183 {
 184         boot_infos_t *bi = bootx_info;
 185         u32 tmp;
 186
 187         bootx_dt_add_prop("linux,boot-display", NULL, 0, mem_end);
 188         bootx_dt_add_prop("linux,opened", NULL, 0, mem_end);
 189         tmp = bi->dispDeviceDepth;
 190         bootx_dt_add_prop("linux,bootx-depth", &tmp, 4, mem_end);
 191         tmp = bi->dispDeviceRect[2] - bi->dispDeviceRect[0];
 192         bootx_dt_add_prop("linux,bootx-width", &tmp, 4, mem_end);
 193         tmp = bi->dispDeviceRect[3] - bi->dispDeviceRect[1];
 194         bootx_dt_add_prop("linux,bootx-height", &tmp, 4, mem_end);
 195         tmp = bi->dispDeviceRowBytes;
 196         bootx_dt_add_prop("linux,bootx-linebytes", &tmp, 4, mem_end);
 197         tmp = (u32)bi->dispDeviceBase;
 198         if (tmp == 0)
 199                 tmp = (u32)bi->logicalDisplayBase;
 200         tmp += bi->dispDeviceRect[1] * bi->dispDeviceRowBytes;
 201         tmp += bi->dispDeviceRect[0] * ((bi->dispDeviceDepth + 7) / 8);
 202         bootx_dt_add_prop("linux,bootx-addr", &tmp, 4, mem_end);
 203 }
 204
 205 static void __init bootx_dt_add_string(char *s, unsigned long *mem_end)
 206 {
 207         unsigned int l = strlen(s) + 1;
 208         memcpy((void *)*mem_end, s, l);
 209         bootx_dt_strend = *mem_end = *mem_end + l;
 210 }
 211
 212 static void __init bootx_scan_dt_build_strings(unsigned long base,
 213                                                unsigned long node,
 214                                                unsigned long *mem_end)
 215 {
 216         struct bootx_dt_node *np = (struct bootx_dt_node *)(base + node);
 217         u32 *cpp, *ppp = &np->properties;
 218         unsigned long soff;
 219         char *namep;
 220
 221         /* Keep refs to known nodes */
 222         namep = np->full_name ? (char *)(base + np->full_name) : NULL;
 223         if (namep == NULL) {
 224                 bootx_printf("Node without a full name !\n");
 225                 namep = "";
 226         }
 227         DBG("* strings: %s\n", namep);
 228
 229         if (!strcmp(namep, "/chosen")) {
 230                 DBG(" detected /chosen ! adding properties names !\n");
 231                 bootx_dt_add_string("linux,platform", mem_end);
 232                 bootx_dt_add_string("linux,stdout-path", mem_end);
 233                 bootx_dt_add_string("linux,initrd-start", mem_end);
 234                 bootx_dt_add_string("linux,initrd-end", mem_end);
 235                 bootx_dt_add_string("bootargs", mem_end);
 236                 bootx_node_chosen = node;
 237         }
 238         if (node == bootx_info->dispDeviceRegEntryOffset) {
 239                 DBG(" detected display ! adding properties names !\n");
 240                 bootx_dt_add_string("linux,boot-display", mem_end);
 241                 bootx_dt_add_string("linux,opened", mem_end);
 242                 bootx_dt_add_string("linux,bootx-depth", mem_end);
 243                 bootx_dt_add_string("linux,bootx-width", mem_end);
 244                 bootx_dt_add_string("linux,bootx-height", mem_end);
 245                 bootx_dt_add_string("linux,bootx-linebytes", mem_end);
 246                 bootx_dt_add_string("linux,bootx-addr", mem_end);
 247                 strncpy(bootx_disp_path, namep, 255);
 248         }
 249
 250         /* get and store all property names */
 251         while (*ppp) {
 252                 struct bootx_dt_prop *pp =
 253                         (struct bootx_dt_prop *)(base + *ppp);
 254
 255                 namep = pp->name ? (char *)(base + pp->name) : NULL;
 256                 if (namep == NULL || strcmp(namep, "name") == 0)
 257                         goto next;
 258                 /* get/create string entry */
 259                 soff = bootx_dt_find_string(namep);
 260                 if (soff == 0)
 261                         bootx_dt_add_string(namep, mem_end);
 262         next:
 263                 ppp = &pp->next;
 264         }
 265
 266         /* do all our children */
 267         cpp = &np->child;
 268         while(*cpp) {
 269                 np = (struct bootx_dt_node *)(base + *cpp);
 270                 bootx_scan_dt_build_strings(base, *cpp, mem_end);
 271                 cpp = &np->sibling;
 272         }
 273 }
 274
 275 static void __init bootx_scan_dt_build_struct(unsigned long base,
 276                                               unsigned long node,
 277                                               unsigned long *mem_end)
 278 {
 279         struct bootx_dt_node *np = (struct bootx_dt_node *)(base + node);
 280         u32 *cpp, *ppp = &np->properties;
 281         char *namep, *p, *ep, *lp;
 282         int l;
 283
 284         dt_push_token(OF_DT_BEGIN_NODE, mem_end);
 285
 286         /* get the node's full name */
 287         namep = np->full_name ? (char *)(base + np->full_name) : NULL;
 288         if (namep == NULL)
 289                 namep = "";
 290         l = strlen(namep);
 291
 292         DBG("* struct: %s\n", namep);
 293
 294         /* Fixup an Apple bug where they have bogus \0 chars in the
 295          * middle of the path in some properties, and extract
 296          * the unit name (everything after the last '/').
 297          */
 298         memcpy((void *)*mem_end, namep, l + 1);
 299         namep = (char *)*mem_end;
 300         for (lp = p = namep, ep = namep + l; p < ep; p++) {
 301                 if (*p == '/')
 302                         lp = namep;
 303                 else if (*p != 0)
 304                         *lp++ = *p;
 305         }
 306         *lp = 0;
 307         *mem_end = _ALIGN_UP((unsigned long)lp + 1, 4);
 308
 309         /* get and store all properties */
 310         while (*ppp) {
 311                 struct bootx_dt_prop *pp =
 312                         (struct bootx_dt_prop *)(base + *ppp);
 313
 314                 namep = pp->name ? (char *)(base + pp->name) : NULL;
 315                 /* Skip "name" */
 316                 if (namep == NULL || !strcmp(namep, "name"))
 317                         goto next;
 318                 /* Skip "bootargs" in /chosen too as we replace it */
 319                 if (node == bootx_node_chosen && !strcmp(namep, "bootargs"))
 320                         goto next;
 321
 322                 /* push property head */
 323                 bootx_dt_add_prop(namep,
 324                                   pp->value ? (void *)(base + pp->value): NULL,
 325                                   pp->length, mem_end);
 326         next:
 327                 ppp = &pp->next;
 328         }
 329
 330         if (node == bootx_node_chosen)
 331                 bootx_add_chosen_props(base, mem_end);
 332         if (node == bootx_info->dispDeviceRegEntryOffset)
 333                 bootx_add_display_props(base, mem_end);
 334
 335         /* do all our children */
 336         cpp = &np->child;
 337         while(*cpp) {
 338                 np = (struct bootx_dt_node *)(base + *cpp);
 339                 bootx_scan_dt_build_struct(base, *cpp, mem_end);
 340                 cpp = &np->sibling;
 341         }
 342
 343         dt_push_token(OF_DT_END_NODE, mem_end);
 344 }
 345
 346 static unsigned long __init bootx_flatten_dt(unsigned long start)
 347 {
 348         boot_infos_t *bi = bootx_info;
 349         unsigned long mem_start, mem_end;
 350         struct boot_param_header *hdr;
 351         unsigned long base;
 352         u64 *rsvmap;
 353
 354         /* Start using memory after the big blob passed by BootX, get
 355          * some space for the header
 356          */
 357         mem_start = mem_end = _ALIGN_UP(((unsigned long)bi) + start, 4);
 358         DBG("Boot params header at: %x\n", mem_start);
 359         hdr = (struct boot_param_header *)mem_start;
 360         mem_end += sizeof(struct boot_param_header);
 361         rsvmap = (u64 *)(_ALIGN_UP(mem_end, 8));
 362         hdr->off_mem_rsvmap = ((unsigned long)rsvmap) - mem_start;
 363         mem_end = ((unsigned long)rsvmap) + 8 * sizeof(u64);
 364
 365         /* Get base of tree */
 366         base = ((unsigned long)bi) + bi->deviceTreeOffset;
 367
 368         /* Build string array */
 369         DBG("Building string array at: %x\n", mem_end);
 370         DBG("Device Tree Base=%x\n", base);
 371         bootx_dt_strbase = mem_end;
 372         mem_end += 4;
 373         bootx_dt_strend = mem_end;
 374         bootx_scan_dt_build_strings(base, 4, &mem_end);
 375         hdr->off_dt_strings = bootx_dt_strbase - mem_start;
 376         hdr->dt_strings_size = bootx_dt_strend - bootx_dt_strbase;
 377
 378         /* Build structure */
 379         mem_end = _ALIGN(mem_end, 16);
 380         DBG("Building device tree structure at: %x\n", mem_end);
 381         hdr->off_dt_struct = mem_end - mem_start;
 382         bootx_scan_dt_build_struct(base, 4, &mem_end);
 383         dt_push_token(OF_DT_END, &mem_end);
 384
 385         /* Finish header */
 386         hdr->boot_cpuid_phys = 0;
 387         hdr->magic = OF_DT_HEADER;
 388         hdr->totalsize = mem_end - mem_start;
 389         hdr->version = OF_DT_VERSION;
 390         /* Version 16 is not backward compatible */
 391         hdr->last_comp_version = 0x10;
 392
 393         /* Reserve the whole thing and copy the reserve map in, we
 394          * also bump mem_reserve_cnt to cause further reservations to
 395          * fail since it's too late.
 396          */
 397         mem_end = _ALIGN(mem_end, PAGE_SIZE);
 398         DBG("End of boot params: %x\n", mem_end);
 399         rsvmap[0] = mem_start;
 400         rsvmap[1] = mem_end;
 401         rsvmap[2] = 0;
 402         rsvmap[3] = 0;
 403
 404         return (unsigned long)hdr;
 405 }
 406
 407
 408 #ifdef CONFIG_BOOTX_TEXT
 409 static void __init btext_welcome(boot_infos_t *bi)
 410 {
 411         unsigned long flags;
 412         unsigned long pvr;
 413
 414         bootx_printf("Welcome to Linux, kernel " UTS_RELEASE "\n");
 415         bootx_printf("\nlinked at        : 0x%x", KERNELBASE);
 416         bootx_printf("\nframe buffer at  : 0x%x", bi->dispDeviceBase);
 417         bootx_printf(" (phys), 0x%x", bi->logicalDisplayBase);
 418         bootx_printf(" (log)");
 419         bootx_printf("\nklimit           : 0x%x",(unsigned long)klimit);
 420         bootx_printf("\nboot_info at     : 0x%x", bi);
 421         __asm__ __volatile__ ("mfmsr %0" : "=r" (flags));
 422         bootx_printf("\nMSR              : 0x%x", flags);
 423         __asm__ __volatile__ ("mfspr %0, 287" : "=r" (pvr));
 424         bootx_printf("\nPVR              : 0x%x", pvr);
 425         pvr >>= 16;
 426         if (pvr > 1) {
 427             __asm__ __volatile__ ("mfspr %0, 1008" : "=r" (flags));
 428             bootx_printf("\nHID0             : 0x%x", flags);
 429         }
 430         if (pvr == 8 || pvr == 12 || pvr == 0x800c) {
 431             __asm__ __volatile__ ("mfspr %0, 1019" : "=r" (flags));
 432             bootx_printf("\nICTC             : 0x%x", flags);
 433         }
 434 #ifdef DEBUG
 435         bootx_printf("\n\n");
 436         bootx_printf("bi->deviceTreeOffset   : 0x%x\n",
 437                      bi->deviceTreeOffset);
 438         bootx_printf("bi->deviceTreeSize     : 0x%x\n",
 439                      bi->deviceTreeSize);
 440 #endif
 441         bootx_printf("\n\n");
 442 }
 443 #endif /* CONFIG_BOOTX_TEXT */
 444
 445 void __init bootx_init(unsigned long r3, unsigned long r4)
 446 {
 447         boot_infos_t *bi = (boot_infos_t *) r4;
 448         unsigned long hdr;
 449         unsigned long space;
 450         unsigned long ptr, x;
 451         char *model;
 452         unsigned long offset = reloc_offset();
 453
 454         reloc_got2(offset);
 455
 456         bootx_info = bi;
 457
 458         /* We haven't cleared any bss at this point, make sure
 459          * what we need is initialized
 460          */
 461         bootx_dt_strbase = bootx_dt_strend = 0;
 462         bootx_node_chosen = 0;
 463         bootx_disp_path[0] = 0;
 464
 465         if (!BOOT_INFO_IS_V2_COMPATIBLE(bi))
 466                 bi->logicalDisplayBase = bi->dispDeviceBase;
 467
 468         /* Fixup depth 16 -> 15 as that's what MacOS calls 16bpp */
 469         if (bi->dispDeviceDepth == 16)
 470                 bi->dispDeviceDepth = 15;
 471
 472 #ifdef CONFIG_BOOTX_TEXT
 473         ptr = (unsigned long)bi->logicalDisplayBase;
 474         ptr += bi->dispDeviceRect[1] * bi->dispDeviceRowBytes;
 475         ptr += bi->dispDeviceRect[0] * ((bi->dispDeviceDepth + 7) / 8);
 476         btext_setup_display(bi->dispDeviceRect[2] - bi->dispDeviceRect[0],
 477                             bi->dispDeviceRect[3] - bi->dispDeviceRect[1],
 478                             bi->dispDeviceDepth, bi->dispDeviceRowBytes,
 479                             (unsigned long)bi->logicalDisplayBase);
 480         btext_clearscreen();
 481         btext_flushscreen();
 482 #endif /* CONFIG_BOOTX_TEXT */
 483
 484         /*
 485          * Test if boot-info is compatible.  Done only in config
 486          * CONFIG_BOOTX_TEXT since there is nothing much we can do
 487          * with an incompatible version, except display a message
 488          * and eventually hang the processor...
 489          *
 490          * I'll try to keep enough of boot-info compatible in the
 491          * future to always allow display of this message;
 492          */
 493         if (!BOOT_INFO_IS_COMPATIBLE(bi)) {
 494                 bootx_printf(" !!! WARNING - Incompatible version"
 495                              " of BootX !!!\n\n\n");
 496                 for (;;)
 497                         ;
 498         }
 499         if (bi->architecture != BOOT_ARCH_PCI) {
 500                 bootx_printf(" !!! WARNING - Usupported machine"
 501                              " architecture !\n");
 502                 for (;;)
 503                         ;
 504         }
 505
 506 #ifdef CONFIG_BOOTX_TEXT
 507         btext_welcome(bi);
 508 #endif
 509         /* New BootX enters kernel with MMU off, i/os are not allowed
 510          * here. This hack will have been done by the boostrap anyway.
 511          */
 512         if (bi->version < 4) {
 513                 /*
 514                  * XXX If this is an iMac, turn off the USB controller.
 515                  */
 516                 model = (char *) bootx_early_getprop(r4 + bi->deviceTreeOffset,
 517                                                      4, "model");
 518                 if (model
 519                     && (strcmp(model, "iMac,1") == 0
 520                         || strcmp(model, "PowerMac1,1") == 0)) {
 521                         bootx_printf("iMac,1 detected, shutting down USB \n");
 522                         out_le32((unsigned __iomem *)0x80880008, 1);    /* XXX */
 523                 }
 524         }
 525
 526         /* Get a pointer that points above the device tree, args, ramdisk,
 527          * etc... to use for generating the flattened tree
 528          */
 529         if (bi->version < 5) {
 530                 space = bi->deviceTreeOffset + bi->deviceTreeSize;
 531                 if (bi->ramDisk)
 532                         space = bi->ramDisk + bi->ramDiskSize;
 533         } else
 534                 space = bi->totalParamsSize;
 535
 536         bootx_printf("Total space used by parameters & ramdisk: %x \n", space);
 537
 538         /* New BootX will have flushed all TLBs and enters kernel with
 539          * MMU switched OFF, so this should not be useful anymore.
 540          */
 541         if (bi->version < 4) {
 542                 bootx_printf("Touching pages...\n");
 543
 544                 /*
 545                  * Touch each page to make sure the PTEs for them
 546                  * are in the hash table - the aim is to try to avoid
 547                  * getting DSI exceptions while copying the kernel image.
 548                  */
 549                 for (ptr = ((unsigned long) &_stext) & PAGE_MASK;
 550                      ptr < (unsigned long)bi + space; ptr += PAGE_SIZE)
 551                         x = *(volatile unsigned long *)ptr;
 552         }
 553
 554         /* Ok, now we need to generate a flattened device-tree to pass
 555          * to the kernel
 556          */
 557         bootx_printf("Preparing boot params...\n");
 558
 559         hdr = bootx_flatten_dt(space);
 560
 561 #ifdef CONFIG_BOOTX_TEXT
 562 #ifdef SET_BOOT_BAT
 563         bootx_printf("Preparing BAT...\n");
 564         btext_prepare_BAT();
 565 #else
 566         btext_unmap();
 567 #endif
 568 #endif
 569
 570         reloc_got2(-offset);
 571
 572         __start(hdr, KERNELBASE + offset, 0);
 573 }