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_UBOOT_START
  39 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
  40 #endif
  41 #ifndef CONFIG_SYS_MONITOR_LEN
  42 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
  43 #endif
  44
  45 u32 *boot_params_ptr = NULL;
  46 struct spl_image_info spl_image;
  47
  48 /* Define board data structure */
  49 static bd_t bdata __attribute__ ((section(".data")));
  50
  51 inline void hang(void)
  52 {
  53         puts("### ERROR ### Please RESET the board ###\n");
  54         for (;;)
  55                 ;
  56 }
  57
  58 /*
  59  * Default function to determine if u-boot or the OS should
  60  * be started. This implementation always returns 1.
  61  *
  62  * Please implement your own board specific funcion to do this.
  63  *
  64  * RETURN
  65  * 0 to not start u-boot
  66  * positive if u-boot should start
  67  */
  68 #ifdef CONFIG_SPL_OS_BOOT
  69 __weak int spl_start_uboot(void)
  70 {
  71         puts("SPL: Please implement spl_start_uboot() for your board\n");
  72         puts("SPL: Direct Linux boot not active!\n");
  73         return 1;
  74 }
  75 #endif
  76
  77 void spl_parse_image_header(const struct image_header *header)
  78 {
  79         u32 header_size = sizeof(struct image_header);
  80
  81         if (image_get_magic(header) == IH_MAGIC) {
  82                 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
  83                         /*
  84                          * On some system (e.g. powerpc), the load-address and
  85                          * entry-point is located at address 0. We can't load
  86                          * to 0-0x40. So skip header in this case.
  87                          */
  88                         spl_image.load_addr = image_get_load(header);
  89                         spl_image.entry_point = image_get_ep(header);
  90                         spl_image.size = image_get_data_size(header);
  91                 } else {
  92                         spl_image.entry_point = image_get_load(header);
  93                         /* Load including the header */
  94                         spl_image.load_addr = spl_image.entry_point -
  95                                 header_size;
  96                         spl_image.size = image_get_data_size(header) +
  97                                 header_size;
  98                 }
  99                 spl_image.os = image_get_os(header);
 100                 spl_image.name = image_get_name(header);
 101                 debug("spl: payload image: %s load addr: 0x%x size: %d\n",
 102                         spl_image.name, spl_image.load_addr, spl_image.size);
 103         } else {
 104                 /* Signature not found - assume u-boot.bin */
 105                 debug("mkimage signature not found - ih_magic = %x\n",
 106                         header->ih_magic);
 107                 /* Let's assume U-Boot will not be more than 200 KB */
 108                 spl_image.size = CONFIG_SYS_MONITOR_LEN;
 109                 spl_image.entry_point = CONFIG_SYS_UBOOT_START;
 110                 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
 111                 spl_image.os = IH_OS_U_BOOT;
 112                 spl_image.name = "U-Boot";
 113         }
 114 }
 115
 116 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 117 {
 118         typedef void __noreturn (*image_entry_noargs_t)(u32 *);
 119         image_entry_noargs_t image_entry =
 120                         (image_entry_noargs_t) spl_image->entry_point;
 121
 122         debug("image entry point: 0x%X\n", spl_image->entry_point);
 123         /* Pass the saved boot_params from rom code */
 124 #if defined(CONFIG_VIRTIO) || defined(CONFIG_ZEBU)
 125         image_entry = (image_entry_noargs_t)0x80100000;
 126 #endif
 127         u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
 128         image_entry((u32 *)boot_params_ptr_addr);
 129 }
 130
 131 #ifdef CONFIG_SPL_RAM_DEVICE
 132 static void spl_ram_load_image(void)
 133 {
 134         const struct image_header *header;
 135
 136         /*
 137          * Get the header.  It will point to an address defined by handoff
 138          * which will tell where the image located inside the flash. For
 139          * now, it will temporary fixed to address pointed by U-Boot.
 140          */
 141         header = (struct image_header *)
 142                 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
 143
 144         spl_parse_image_header(header);
 145 }
 146 #endif
 147
 148 void board_init_r(gd_t *dummy1, ulong dummy2)
 149 {
 150         u32 boot_device;
 151         debug(">>spl:board_init_r()\n");
 152
 153 #ifdef CONFIG_SYS_SPL_MALLOC_START
 154         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 155                         CONFIG_SYS_SPL_MALLOC_SIZE);
 156 #endif
 157
 158         timer_init();
 159
 160 #ifdef CONFIG_SPL_BOARD_INIT
 161         spl_board_init();
 162 #endif
 163
 164         boot_device = spl_boot_device();
 165         debug("boot device - %d\n", boot_device);
 166         switch (boot_device) {
 167 #ifdef CONFIG_SPL_RAM_DEVICE
 168         case BOOT_DEVICE_RAM:
 169                 spl_ram_load_image();
 170                 break;
 171 #endif
 172 #ifdef CONFIG_SPL_MMC_SUPPORT
 173         case BOOT_DEVICE_MMC1:
 174         case BOOT_DEVICE_MMC2:
 175         case BOOT_DEVICE_MMC2_2:
 176                 spl_mmc_load_image();
 177                 break;
 178 #endif
 179 #ifdef CONFIG_SPL_NAND_SUPPORT
 180         case BOOT_DEVICE_NAND:
 181                 spl_nand_load_image();
 182                 break;
 183 #endif
 184 #ifdef CONFIG_SPL_NOR_SUPPORT
 185         case BOOT_DEVICE_NOR:
 186                 spl_nor_load_image();
 187                 break;
 188 #endif
 189 #ifdef CONFIG_SPL_YMODEM_SUPPORT
 190         case BOOT_DEVICE_UART:
 191                 spl_ymodem_load_image();
 192                 break;
 193 #endif
 194 #ifdef CONFIG_SPL_SPI_SUPPORT
 195         case BOOT_DEVICE_SPI:
 196                 spl_spi_load_image();
 197                 break;
 198 #endif
 199 #ifdef CONFIG_SPL_ETH_SUPPORT
 200         case BOOT_DEVICE_CPGMAC:
 201 #ifdef CONFIG_SPL_ETH_DEVICE
 202                 spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
 203 #else
 204                 spl_net_load_image(NULL);
 205 #endif
 206                 break;
 207 #endif
 208         default:
 209                 debug("SPL: Un-supported Boot Device\n");
 210                 hang();
 211         }
 212
 213         switch (spl_image.os) {
 214         case IH_OS_U_BOOT:
 215                 debug("Jumping to U-Boot\n");
 216                 break;
 217 #ifdef CONFIG_SPL_OS_BOOT
 218         case IH_OS_LINUX:
 219                 debug("Jumping to Linux\n");
 220                 spl_board_prepare_for_linux();
 221                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
 222 #endif
 223         default:
 224                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 225         }
 226         jump_to_image_no_args(&spl_image);
 227 }
 228
 229 /*
 230  * This requires UART clocks to be enabled.  In order for this to work the
 231  * caller must ensure that the gd pointer is valid.
 232  */
 233 void preloader_console_init(void)
 234 {
 235         gd->bd = &bdata;
 236         gd->baudrate = CONFIG_BAUDRATE;
 237
 238         serial_init();          /* serial communications setup */
 239
 240         gd->have_console = 1;
 241
 242         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 243                         U_BOOT_TIME ")\n");
 244 #ifdef CONFIG_SPL_DISPLAY_PRINT
 245         spl_display_print();
 246 #endif
 247 }