common/spl/spl.c

   1 /*
   2  * (C) Copyright 2010
   3  * Texas Instruments, <www.ti.com>
   4  *
   5  * Aneesh V <aneesh@ti.com>
   6  *
   7  * See file CREDITS for list of people who contributed to this
   8  * project.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 of
  13  * the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  23  * MA 02111-1307 USA
  24  */
  25 #include <common.h>
  26 #include <spl.h>
  27 #include <asm/u-boot.h>
  28 #include <nand.h>
  29 #include <fat.h>
  30 #include <version.h>
  31 #include <i2c.h>
  32 #include <image.h>
  33 #include <malloc.h>
  34 #include <linux/compiler.h>
  35
  36 DECLARE_GLOBAL_DATA_PTR;
  37
  38 u32 *boot_params_ptr = NULL;
  39 struct spl_image_info spl_image;
  40
  41 /* Define global data structure pointer to it*/
  42 static gd_t gdata __attribute__ ((section(".data")));
  43 static bd_t bdata __attribute__ ((section(".data")));
  44
  45 inline void hang(void)
  46 {
  47         puts("### ERROR ### Please RESET the board ###\n");
  48         for (;;)
  49                 ;
  50 }
  51
  52 void board_init_f(ulong dummy)
  53 {
  54         /*
  55          * We call relocate_code() with relocation target same as the
  56          * CONFIG_SYS_SPL_TEXT_BASE. This will result in relocation getting
  57          * skipped. Instead, only .bss initialization will happen. That's
  58          * all we need
  59          */
  60         debug(">>board_init_f()\n");
  61         relocate_code(CONFIG_SPL_STACK, &gdata, CONFIG_SPL_TEXT_BASE);
  62 }
  63
  64 /*
  65  * Default function to determine if u-boot or the OS should
  66  * be started. This implementation always returns 1.
  67  *
  68  * Please implement your own board specific funcion to do this.
  69  *
  70  * RETURN
  71  * 0 to not start u-boot
  72  * positive if u-boot should start
  73  */
  74 #ifdef CONFIG_SPL_OS_BOOT
  75 __weak int spl_start_uboot(void)
  76 {
  77         puts("SPL: Please implement spl_start_uboot() for your board\n");
  78         puts("SPL: Direct Linux boot not active!\n");
  79         return 1;
  80 }
  81 #endif
  82
  83 void spl_parse_image_header(const struct image_header *header)
  84 {
  85         u32 header_size = sizeof(struct image_header);
  86
  87         if (__be32_to_cpu(header->ih_magic) == IH_MAGIC) {
  88                 spl_image.size = __be32_to_cpu(header->ih_size) + header_size;
  89                 spl_image.entry_point = __be32_to_cpu(header->ih_load);
  90                 /* Load including the header */
  91                 spl_image.load_addr = spl_image.entry_point - header_size;
  92                 spl_image.os = header->ih_os;
  93                 spl_image.name = (const char *)&header->ih_name;
  94                 debug("spl: payload image: %s load addr: 0x%x size: %d\n",
  95                         spl_image.name, spl_image.load_addr, spl_image.size);
  96         } else {
  97                 /* Signature not found - assume u-boot.bin */
  98                 puts("mkimage signature not found, assuming u-boot.bin ..\n");
  99                 debug("mkimage signature not found - ih_magic = %x\n",
 100                         header->ih_magic);
 101                 /* Let's assume U-Boot will not be more than 200 KB */
 102                 spl_image.size = 200 * 1024;
 103                 spl_image.entry_point = CONFIG_SYS_TEXT_BASE;
 104                 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
 105                 spl_image.os = IH_OS_U_BOOT;
 106                 spl_image.name = "U-Boot";
 107         }
 108 }
 109
 110 /*
 111  * This function jumps to an image with argument. Normally an FDT or ATAGS
 112  * image.
 113  * arg: Pointer to paramter image in RAM
 114  */
 115 #ifdef CONFIG_SPL_OS_BOOT
 116 static void __noreturn jump_to_image_linux(void *arg)
 117 {
 118         debug("Entering kernel arg pointer: 0x%p\n", arg);
 119         typedef void (*image_entry_arg_t)(int, int, void *)
 120                 __attribute__ ((noreturn));
 121         image_entry_arg_t image_entry =
 122                 (image_entry_arg_t) spl_image.entry_point;
 123         cleanup_before_linux();
 124         image_entry(0, CONFIG_MACH_TYPE, arg);
 125 }
 126 #endif
 127
 128 static void __noreturn jump_to_image_no_args(void)
 129 {
 130         typedef void __noreturn (*image_entry_noargs_t)(u32 *);
 131         image_entry_noargs_t image_entry =
 132                         (image_entry_noargs_t) spl_image.entry_point;
 133
 134         debug("image entry point: 0x%X\n", spl_image.entry_point);
 135         /* Pass the saved boot_params from rom code */
 136 #if defined(CONFIG_VIRTIO) || defined(CONFIG_ZEBU)
 137         image_entry = (image_entry_noargs_t)0x80100000;
 138 #endif
 139         u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
 140         image_entry((u32 *)boot_params_ptr_addr);
 141 }
 142
 143 void board_init_r(gd_t *id, ulong dummy)
 144 {
 145         u32 boot_device;
 146         debug(">>spl:board_init_r()\n");
 147
 148 #ifdef CONFIG_SYS_SPL_MALLOC_START
 149         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 150                         CONFIG_SYS_SPL_MALLOC_SIZE);
 151 #endif
 152
 153 #ifdef CONFIG_SPL_BOARD_INIT
 154         spl_board_init();
 155 #endif
 156
 157         boot_device = spl_boot_device();
 158         debug("boot device - %d\n", boot_device);
 159         switch (boot_device) {
 160 #ifdef CONFIG_SPL_MMC_SUPPORT
 161         case BOOT_DEVICE_MMC1:
 162         case BOOT_DEVICE_MMC2:
 163         case BOOT_DEVICE_MMC2_2:
 164                 spl_mmc_load_image();
 165                 break;
 166 #endif
 167 #ifdef CONFIG_SPL_NAND_SUPPORT
 168         case BOOT_DEVICE_NAND:
 169                 spl_nand_load_image();
 170                 break;
 171 #endif
 172 #ifdef CONFIG_SPL_YMODEM_SUPPORT
 173         case BOOT_DEVICE_UART:
 174                 spl_ymodem_load_image();
 175                 break;
 176 #endif
 177 #ifdef CONFIG_SPL_SPI_SUPPORT
 178         case BOOT_DEVICE_SPI:
 179                 spi_boot();
 180         break;
 181 #endif
 182         default:
 183                 puts("SPL: Un-supported Boot Device\n");
 184                 debug("Found: %d\n", boot_device);
 185                 hang();
 186                 break;
 187         }
 188
 189         switch (spl_image.os) {
 190         case IH_OS_U_BOOT:
 191                 debug("Jumping to U-Boot\n");
 192                 jump_to_image_no_args();
 193                 break;
 194 #ifdef CONFIG_SPL_OS_BOOT
 195         case IH_OS_LINUX:
 196                 debug("Jumping to Linux\n");
 197                 spl_board_prepare_for_linux();
 198                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
 199                 break;
 200 #endif
 201         default:
 202                 puts("Unsupported OS image.. Jumping nevertheless..\n");
 203                 jump_to_image_no_args();
 204         }
 205 }
 206
 207 /* This requires UART clocks to be enabled */
 208 void preloader_console_init(void)
 209 {
 210         gd = &gdata;
 211         gd->bd = &bdata;
 212         gd->flags |= GD_FLG_RELOC;
 213         gd->baudrate = CONFIG_BAUDRATE;
 214
 215         serial_init();          /* serial communications setup */
 216
 217         gd->have_console = 1;
 218
 219         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 220                         U_BOOT_TIME ")\n");
 221 #ifdef CONFIG_SPL_DISPLAY_PRINT
 222         spl_display_print();
 223 #endif
 224 }