arch/x86/lib/zimage.c

   1 /*
   2  * Copyright (c) 2011 The Chromium OS Authors.
   3  * (C) Copyright 2002
   4  * Daniel Engström, Omicron Ceti AB, <daniel@omicron.se>
   5  *
   6  * See file CREDITS for list of people who contributed to this
   7  * project.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  22  * MA 02111-1307 USA
  23  */
  24
  25 /*
  26  * Linux x86 zImage and bzImage loading
  27  *
  28  * based on the procdure described in
  29  * linux/Documentation/i386/boot.txt
  30  */
  31
  32 #include <common.h>
  33 #include <asm/io.h>
  34 #include <asm/ptrace.h>
  35 #include <asm/zimage.h>
  36 #include <asm/byteorder.h>
  37 #include <asm/bootparam.h>
  38 #ifdef CONFIG_SYS_COREBOOT
  39 #include <asm/arch/timestamp.h>
  40 #endif
  41 #include <linux/compiler.h>
  42
  43 /*
  44  * Memory lay-out:
  45  *
  46  * relative to setup_base (which is 0x90000 currently)
  47  *
  48  *      0x0000-0x7FFF   Real mode kernel
  49  *      0x8000-0x8FFF   Stack and heap
  50  *      0x9000-0x90FF   Kernel command line
  51  */
  52 #define DEFAULT_SETUP_BASE      0x90000
  53 #define COMMAND_LINE_OFFSET     0x9000
  54 #define HEAP_END_OFFSET         0x8e00
  55
  56 #define COMMAND_LINE_SIZE       2048
  57
  58 unsigned generic_install_e820_map(unsigned max_entries,
  59                                   struct e820entry *entries)
  60 {
  61         return 0;
  62 }
  63
  64 unsigned install_e820_map(unsigned max_entries,
  65                           struct e820entry *entries)
  66         __attribute__((weak, alias("generic_install_e820_map")));
  67
  68 static void build_command_line(char *command_line, int auto_boot)
  69 {
  70         char *env_command_line;
  71
  72         command_line[0] = '\0';
  73
  74         env_command_line =  getenv("bootargs");
  75
  76         /* set console= argument if we use a serial console */
  77         if (!strstr(env_command_line, "console=")) {
  78                 if (!strcmp(getenv("stdout"), "serial")) {
  79
  80                         /* We seem to use serial console */
  81                         sprintf(command_line, "console=ttyS0,%s ",
  82                                 getenv("baudrate"));
  83                 }
  84         }
  85
  86         if (auto_boot)
  87                 strcat(command_line, "auto ");
  88
  89         if (env_command_line)
  90                 strcat(command_line, env_command_line);
  91
  92         printf("Kernel command line: \"%s\"\n", command_line);
  93 }
  94
  95 static int kernel_magic_ok(struct setup_header *hdr)
  96 {
  97         if (KERNEL_MAGIC != hdr->boot_flag) {
  98                 printf("Error: Invalid Boot Flag "
  99                         "(found 0x%04x, expected 0x%04x)\n",
 100                         hdr->boot_flag, KERNEL_MAGIC);
 101                 return 0;
 102         } else {
 103                 printf("Valid Boot Flag\n");
 104                 return 1;
 105         }
 106 }
 107
 108 static int get_boot_protocol(struct setup_header *hdr)
 109 {
 110         if (hdr->header == KERNEL_V2_MAGIC) {
 111                 printf("Magic signature found\n");
 112                 return hdr->version;
 113         } else {
 114                 /* Very old kernel */
 115                 printf("Magic signature not found\n");
 116                 return 0x0100;
 117         }
 118 }
 119
 120 struct boot_params *load_zimage(char *image, unsigned long kernel_size,
 121                                 void **load_address)
 122 {
 123         struct boot_params *setup_base;
 124         int setup_size;
 125         int bootproto;
 126         int big_image;
 127
 128         struct boot_params *params = (struct boot_params *)image;
 129         struct setup_header *hdr = &params->hdr;
 130
 131         /* base address for real-mode segment */
 132         setup_base = (struct boot_params *)DEFAULT_SETUP_BASE;
 133
 134         if (!kernel_magic_ok(hdr))
 135                 return 0;
 136
 137         /* determine size of setup */
 138         if (0 == hdr->setup_sects) {
 139                 printf("Setup Sectors = 0 (defaulting to 4)\n");
 140                 setup_size = 5 * 512;
 141         } else {
 142                 setup_size = (hdr->setup_sects + 1) * 512;
 143         }
 144
 145         printf("Setup Size = 0x%8.8lx\n", (ulong)setup_size);
 146
 147         if (setup_size > SETUP_MAX_SIZE)
 148                 printf("Error: Setup is too large (%d bytes)\n", setup_size);
 149
 150         /* determine boot protocol version */
 151         bootproto = get_boot_protocol(hdr);
 152
 153         printf("Using boot protocol version %x.%02x\n",
 154                (bootproto & 0xff00) >> 8, bootproto & 0xff);
 155
 156         if (bootproto >= 0x0200) {
 157                 if (hdr->setup_sects >= 15) {
 158                         printf("Linux kernel version %s\n",
 159                                 (char *)params +
 160                                 hdr->kernel_version + 0x200);
 161                 } else {
 162                         printf("Setup Sectors < 15 - "
 163                                 "Cannot print kernel version.\n");
 164                 }
 165         }
 166
 167         /* Determine image type */
 168         big_image = (bootproto >= 0x0200) &&
 169                     (hdr->loadflags & BIG_KERNEL_FLAG);
 170
 171         /* Determine load address */
 172         if (big_image)
 173                 *load_address = (void *)BZIMAGE_LOAD_ADDR;
 174         else
 175                 *load_address = (void *)ZIMAGE_LOAD_ADDR;
 176
 177         printf("Building boot_params at 0x%8.8lx\n", (ulong)setup_base);
 178         memset(setup_base, 0, sizeof(*setup_base));
 179         setup_base->hdr = params->hdr;
 180
 181         if (bootproto >= 0x0204)
 182                 kernel_size = hdr->syssize * 16;
 183         else
 184                 kernel_size -= setup_size;
 185
 186         if (bootproto == 0x0100) {
 187                 /*
 188                  * A very old kernel MUST have its real-mode code
 189                  * loaded at 0x90000
 190                  */
 191                 if ((u32)setup_base != 0x90000) {
 192                         /* Copy the real-mode kernel */
 193                         memmove((void *)0x90000, setup_base, setup_size);
 194
 195                         /* Copy the command line */
 196                         memmove((void *)0x99000,
 197                                 (u8 *)setup_base + COMMAND_LINE_OFFSET,
 198                                 COMMAND_LINE_SIZE);
 199
 200                          /* Relocated */
 201                         setup_base = (struct boot_params *)0x90000;
 202                 }
 203
 204                 /* It is recommended to clear memory up to the 32K mark */
 205                 memset((u8 *)0x90000 + setup_size, 0,
 206                        SETUP_MAX_SIZE - setup_size);
 207         }
 208
 209         if (big_image) {
 210                 if (kernel_size > BZIMAGE_MAX_SIZE) {
 211                         printf("Error: bzImage kernel too big! "
 212                                 "(size: %ld, max: %d)\n",
 213                                 kernel_size, BZIMAGE_MAX_SIZE);
 214                         return 0;
 215                 }
 216         } else if ((kernel_size) > ZIMAGE_MAX_SIZE) {
 217                 printf("Error: zImage kernel too big! (size: %ld, max: %d)\n",
 218                        kernel_size, ZIMAGE_MAX_SIZE);
 219                 return 0;
 220         }
 221
 222         printf("Loading %s at address %p (%ld bytes)\n",
 223                 big_image ? "bzImage" : "zImage", *load_address, kernel_size);
 224
 225         memmove(*load_address, image + setup_size, kernel_size);
 226
 227         return setup_base;
 228 }
 229
 230 int setup_zimage(struct boot_params *setup_base, char *cmd_line, int auto_boot,
 231                  unsigned long initrd_addr, unsigned long initrd_size)
 232 {
 233         struct setup_header *hdr = &setup_base->hdr;
 234         int bootproto = get_boot_protocol(hdr);
 235
 236         setup_base->e820_entries = install_e820_map(
 237                 ARRAY_SIZE(setup_base->e820_map), setup_base->e820_map);
 238
 239         if (bootproto == 0x0100) {
 240                 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
 241                 setup_base->screen_info.cl_offset = COMMAND_LINE_OFFSET;
 242         }
 243         if (bootproto >= 0x0200) {
 244                 hdr->type_of_loader = 8;
 245
 246                 if (initrd_addr) {
 247                         printf("Initial RAM disk at linear address "
 248                                "0x%08lx, size %ld bytes\n",
 249                                initrd_addr, initrd_size);
 250
 251                         hdr->ramdisk_image = initrd_addr;
 252                         hdr->ramdisk_size = initrd_size;
 253                 }
 254         }
 255
 256         if (bootproto >= 0x0201) {
 257                 hdr->heap_end_ptr = HEAP_END_OFFSET;
 258                 hdr->loadflags |= HEAP_FLAG;
 259         }
 260
 261         if (bootproto >= 0x0202) {
 262                 hdr->cmd_line_ptr = (uintptr_t)cmd_line;
 263         } else if (bootproto >= 0x0200) {
 264                 setup_base->screen_info.cl_magic = COMMAND_LINE_MAGIC;
 265                 setup_base->screen_info.cl_offset =
 266                         (uintptr_t)cmd_line - (uintptr_t)setup_base;
 267
 268                 hdr->setup_move_size = 0x9100;
 269         }
 270
 271         /* build command line at COMMAND_LINE_OFFSET */
 272         build_command_line(cmd_line, auto_boot);
 273         return 0;
 274 }
 275
 276 /*
 277  * Implement a weak default function for boards that optionally
 278  * need to clean up the system before jumping to the kernel.
 279  */
 280 __weak void board_final_cleanup(void)
 281 {
 282 }
 283
 284 void boot_zimage(void *setup_base, void *load_address)
 285 {
 286         debug("## Transferring control to Linux (at address %08x) ...\n",
 287               (u32)setup_base);
 288
 289         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
 290 #ifdef CONFIG_BOOTSTAGE_REPORT
 291         bootstage_report();
 292 #endif
 293         board_final_cleanup();
 294
 295         printf("\nStarting kernel ...\n\n");
 296
 297 #ifdef CONFIG_SYS_COREBOOT
 298         timestamp_add_now(TS_U_BOOT_START_KERNEL);
 299 #endif
 300         /*
 301          * Set %ebx, %ebp, and %edi to 0, %esi to point to the boot_params
 302          * structure, and then jump to the kernel. We assume that %cs is
 303          * 0x10, 4GB flat, and read/execute, and the data segments are 0x18,
 304          * 4GB flat, and read/write. U-boot is setting them up that way for
 305          * itself in arch/i386/cpu/cpu.c.
 306          */
 307         __asm__ __volatile__ (
 308         "movl $0, %%ebp\n"
 309         "cli\n"
 310         "jmp *%[kernel_entry]\n"
 311         :: [kernel_entry]"a"(load_address),
 312            [boot_params] "S"(setup_base),
 313            "b"(0), "D"(0)
 314         :  "%ebp"
 315         );
 316 }
 317
 318 void setup_pcat_compatibility(void)
 319         __attribute__((weak, alias("__setup_pcat_compatibility")));
 320
 321 void __setup_pcat_compatibility(void)
 322 {
 323 }
 324
 325 int do_zboot(cmd_tbl_t *cmdtp, int flag, int argc, char *const argv[])
 326 {
 327         struct boot_params *base_ptr;
 328         void *bzImage_addr = NULL;
 329         void *load_address;
 330         char *s;
 331         ulong bzImage_size = 0;
 332         ulong initrd_addr = 0;
 333         ulong initrd_size = 0;
 334
 335         disable_interrupts();
 336
 337         /* Setup board for maximum PC/AT Compatibility */
 338         setup_pcat_compatibility();
 339
 340         if (argc >= 2) {
 341                 /* argv[1] holds the address of the bzImage */
 342                 s = argv[1];
 343         } else {
 344                 s = getenv("fileaddr");
 345         }
 346
 347         if (s)
 348                 bzImage_addr = (void *)simple_strtoul(s, NULL, 16);
 349
 350         if (argc >= 3) {
 351                 /* argv[2] holds the size of the bzImage */
 352                 bzImage_size = simple_strtoul(argv[2], NULL, 16);
 353         }
 354
 355         if (argc >= 4)
 356                 initrd_addr = simple_strtoul(argv[3], NULL, 16);
 357         if (argc >= 5)
 358                 initrd_size = simple_strtoul(argv[4], NULL, 16);
 359
 360         /* Lets look for */
 361         base_ptr = load_zimage(bzImage_addr, bzImage_size, &load_address);
 362
 363         if (!base_ptr) {
 364                 printf("## Kernel loading failed ...\n");
 365                 return -1;
 366         }
 367         if (setup_zimage(base_ptr, (char *)base_ptr + COMMAND_LINE_OFFSET,
 368                         0, initrd_addr, initrd_size)) {
 369                 printf("Setting up boot parameters failed ...\n");
 370                 return -1;
 371         }
 372
 373         /* we assume that the kernel is in place */
 374         boot_zimage(base_ptr, load_address);
 375         /* does not return */
 376
 377         return -1;
 378 }
 379
 380 U_BOOT_CMD(
 381         zboot, 5, 0,    do_zboot,
 382         "Boot bzImage",
 383         "[addr] [size] [initrd addr] [initrd size]\n"
 384         "      addr -        The optional starting address of the bzimage.\n"
 385         "                    If not set it defaults to the environment\n"
 386         "                    variable \"fileaddr\".\n"
 387         "      size -        The optional size of the bzimage. Defaults to\n"
 388         "                    zero.\n"
 389         "      initrd addr - The address of the initrd image to use, if any.\n"
 390         "      initrd size - The size of the initrd image to use, if any.\n"
 391 );