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 #ifndef CONFIG_SYS_MONITOR_LEN
  39 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  40 #endif
  41
  42 u32 *boot_params_ptr = NULL;
  43 struct spl_image_info spl_image;
  44
  45 /* Define board data structure */
  46 static bd_t bdata __attribute__ ((section(".data")));
  47
  48 inline void hang(void)
  49 {
  50         puts("### ERROR ### Please RESET the board ###\n");
  51         for (;;)
  52                 ;
  53 }
  54
  55 /*
  56  * Default function to determine if u-boot or the OS should
  57  * be started. This implementation always returns 1.
  58  *
  59  * Please implement your own board specific funcion to do this.
  60  *
  61  * RETURN
  62  * 0 to not start u-boot
  63  * positive if u-boot should start
  64  */
  65 #ifdef CONFIG_SPL_OS_BOOT
  66 __weak int spl_start_uboot(void)
  67 {
  68         puts("SPL: Please implement spl_start_uboot() for your board\n");
  69         puts("SPL: Direct Linux boot not active!\n");
  70         return 1;
  71 }
  72 #endif
  73
  74 void spl_parse_image_header(const struct image_header *header)
  75 {
  76         u32 header_size = sizeof(struct image_header);
  77
  78         if (image_get_magic(header) == IH_MAGIC) {
  79                 spl_image.size = image_get_data_size(header) + header_size;
  80                 spl_image.entry_point = image_get_load(header);
  81                 /* Load including the header */
  82                 spl_image.load_addr = spl_image.entry_point - header_size;
  83                 spl_image.os = image_get_os(header);
  84                 spl_image.name = image_get_name(header);
  85                 debug("spl: payload image: %s load addr: 0x%x size: %d\n",
  86                         spl_image.name, spl_image.load_addr, spl_image.size);
  87         } else {
  88                 /* Signature not found - assume u-boot.bin */
  89                 puts("mkimage signature not found, assuming u-boot.bin ..\n");
  90                 debug("mkimage signature not found - ih_magic = %x\n",
  91                         header->ih_magic);
  92                 /* Let's assume U-Boot will not be more than 200 KB */
  93                 spl_image.size = CONFIG_SYS_MONITOR_LEN;
  94                 spl_image.entry_point = CONFIG_SYS_TEXT_BASE;
  95                 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
  96                 spl_image.os = IH_OS_U_BOOT;
  97                 spl_image.name = "U-Boot";
  98         }
  99 }
 100
 101 static void __noreturn jump_to_image_no_args(void)
 102 {
 103         typedef void __noreturn (*image_entry_noargs_t)(u32 *);
 104         image_entry_noargs_t image_entry =
 105                         (image_entry_noargs_t) spl_image.entry_point;
 106
 107         debug("image entry point: 0x%X\n", spl_image.entry_point);
 108         /* Pass the saved boot_params from rom code */
 109 #if defined(CONFIG_VIRTIO) || defined(CONFIG_ZEBU)
 110         image_entry = (image_entry_noargs_t)0x80100000;
 111 #endif
 112         u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
 113         image_entry((u32 *)boot_params_ptr_addr);
 114 }
 115
 116 void board_init_r(gd_t *dummy1, ulong dummy2)
 117 {
 118         u32 boot_device;
 119         debug(">>spl:board_init_r()\n");
 120
 121 #ifdef CONFIG_SYS_SPL_MALLOC_START
 122         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 123                         CONFIG_SYS_SPL_MALLOC_SIZE);
 124 #endif
 125
 126 #ifdef CONFIG_SPL_BOARD_INIT
 127         spl_board_init();
 128 #endif
 129
 130         boot_device = spl_boot_device();
 131         debug("boot device - %d\n", boot_device);
 132         switch (boot_device) {
 133 #ifdef CONFIG_SPL_MMC_SUPPORT
 134         case BOOT_DEVICE_MMC1:
 135         case BOOT_DEVICE_MMC2:
 136         case BOOT_DEVICE_MMC2_2:
 137                 spl_mmc_load_image();
 138                 break;
 139 #endif
 140 #ifdef CONFIG_SPL_NAND_SUPPORT
 141         case BOOT_DEVICE_NAND:
 142                 spl_nand_load_image();
 143                 break;
 144 #endif
 145 #ifdef CONFIG_SPL_YMODEM_SUPPORT
 146         case BOOT_DEVICE_UART:
 147                 spl_ymodem_load_image();
 148                 break;
 149 #endif
 150 #ifdef CONFIG_SPL_SPI_SUPPORT
 151         case BOOT_DEVICE_SPI:
 152                 spi_boot();
 153         break;
 154 #endif
 155         default:
 156                 puts("SPL: Un-supported Boot Device\n");
 157                 debug("Found: %d\n", boot_device);
 158                 hang();
 159                 break;
 160         }
 161
 162         switch (spl_image.os) {
 163         case IH_OS_U_BOOT:
 164                 debug("Jumping to U-Boot\n");
 165                 jump_to_image_no_args();
 166                 break;
 167 #ifdef CONFIG_SPL_OS_BOOT
 168         case IH_OS_LINUX:
 169                 debug("Jumping to Linux\n");
 170                 spl_board_prepare_for_linux();
 171                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
 172                 break;
 173 #endif
 174         default:
 175                 puts("Unsupported OS image.. Jumping nevertheless..\n");
 176                 jump_to_image_no_args();
 177         }
 178 }
 179
 180 /*
 181  * This requires UART clocks to be enabled.  In order for this to work the
 182  * caller must ensure that the gd pointer is valid.
 183  */
 184 void preloader_console_init(void)
 185 {
 186         gd->bd = &bdata;
 187         gd->flags |= GD_FLG_RELOC;
 188         gd->baudrate = CONFIG_BAUDRATE;
 189
 190         serial_init();          /* serial communications setup */
 191
 192         gd->have_console = 1;
 193
 194         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 195                         U_BOOT_TIME ")\n");
 196 #ifdef CONFIG_SPL_DISPLAY_PRINT
 197         spl_display_print();
 198 #endif
 199 }