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 /*
  78  * Weak default function for board specific cleanup/preparation before
  79  * Linux boot. Some boards/platforms might not need it, so just provide
  80  * an empty stub here.
  81  */
  82 __weak void spl_board_prepare_for_linux(void)
  83 {
  84         /* Nothing to do! */
  85 }
  86
  87 void spl_parse_image_header(const struct image_header *header)
  88 {
  89         u32 header_size = sizeof(struct image_header);
  90
  91         if (image_get_magic(header) == IH_MAGIC) {
  92                 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
  93                         /*
  94                          * On some system (e.g. powerpc), the load-address and
  95                          * entry-point is located at address 0. We can't load
  96                          * to 0-0x40. So skip header in this case.
  97                          */
  98                         spl_image.load_addr = image_get_load(header);
  99                         spl_image.entry_point = image_get_ep(header);
 100                         spl_image.size = image_get_data_size(header);
 101                 } else {
 102                         spl_image.entry_point = image_get_load(header);
 103                         /* Load including the header */
 104                         spl_image.load_addr = spl_image.entry_point -
 105                                 header_size;
 106                         spl_image.size = image_get_data_size(header) +
 107                                 header_size;
 108                 }
 109                 spl_image.os = image_get_os(header);
 110                 spl_image.name = image_get_name(header);
 111                 debug("spl: payload image: %s load addr: 0x%x size: %d\n",
 112                         spl_image.name, spl_image.load_addr, spl_image.size);
 113         } else {
 114                 /* Signature not found - assume u-boot.bin */
 115                 debug("mkimage signature not found - ih_magic = %x\n",
 116                         header->ih_magic);
 117                 /* Let's assume U-Boot will not be more than 200 KB */
 118                 spl_image.size = CONFIG_SYS_MONITOR_LEN;
 119                 spl_image.entry_point = CONFIG_SYS_UBOOT_START;
 120                 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
 121                 spl_image.os = IH_OS_U_BOOT;
 122                 spl_image.name = "U-Boot";
 123         }
 124 }
 125
 126 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
 127 {
 128         typedef void __noreturn (*image_entry_noargs_t)(void);
 129
 130         image_entry_noargs_t image_entry =
 131                         (image_entry_noargs_t) spl_image->entry_point;
 132
 133         debug("image entry point: 0x%X\n", spl_image->entry_point);
 134         image_entry();
 135 }
 136
 137 #ifdef CONFIG_SPL_RAM_DEVICE
 138 static void spl_ram_load_image(void)
 139 {
 140         const struct image_header *header;
 141
 142         /*
 143          * Get the header.  It will point to an address defined by handoff
 144          * which will tell where the image located inside the flash. For
 145          * now, it will temporary fixed to address pointed by U-Boot.
 146          */
 147         header = (struct image_header *)
 148                 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header));
 149
 150         spl_parse_image_header(header);
 151 }
 152 #endif
 153
 154 void board_init_r(gd_t *dummy1, ulong dummy2)
 155 {
 156         u32 boot_device;
 157         debug(">>spl:board_init_r()\n");
 158
 159 #ifdef CONFIG_SYS_SPL_MALLOC_START
 160         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
 161                         CONFIG_SYS_SPL_MALLOC_SIZE);
 162 #endif
 163
 164 #ifndef CONFIG_PPC
 165         /*
 166          * timer_init() does not exist on PPC systems. The timer is initialized
 167          * and enabled (decrementer) in interrupt_init() here.
 168          */
 169         timer_init();
 170 #endif
 171
 172 #ifdef CONFIG_SPL_BOARD_INIT
 173         spl_board_init();
 174 #endif
 175
 176         boot_device = spl_boot_device();
 177         debug("boot device - %d\n", boot_device);
 178         switch (boot_device) {
 179 #ifdef CONFIG_SPL_RAM_DEVICE
 180         case BOOT_DEVICE_RAM:
 181                 spl_ram_load_image();
 182                 break;
 183 #endif
 184 #ifdef CONFIG_SPL_MMC_SUPPORT
 185         case BOOT_DEVICE_MMC1:
 186         case BOOT_DEVICE_MMC2:
 187         case BOOT_DEVICE_MMC2_2:
 188                 spl_mmc_load_image();
 189                 break;
 190 #endif
 191 #ifdef CONFIG_SPL_NAND_SUPPORT
 192         case BOOT_DEVICE_NAND:
 193                 spl_nand_load_image();
 194                 break;
 195 #endif
 196 #ifdef CONFIG_SPL_ONENAND_SUPPORT
 197         case BOOT_DEVICE_ONENAND:
 198                 spl_onenand_load_image();
 199                 break;
 200 #endif
 201 #ifdef CONFIG_SPL_NOR_SUPPORT
 202         case BOOT_DEVICE_NOR:
 203                 spl_nor_load_image();
 204                 break;
 205 #endif
 206 #ifdef CONFIG_SPL_YMODEM_SUPPORT
 207         case BOOT_DEVICE_UART:
 208                 spl_ymodem_load_image();
 209                 break;
 210 #endif
 211 #ifdef CONFIG_SPL_SPI_SUPPORT
 212         case BOOT_DEVICE_SPI:
 213                 spl_spi_load_image();
 214                 break;
 215 #endif
 216 #ifdef CONFIG_SPL_ETH_SUPPORT
 217         case BOOT_DEVICE_CPGMAC:
 218 #ifdef CONFIG_SPL_ETH_DEVICE
 219                 spl_net_load_image(CONFIG_SPL_ETH_DEVICE);
 220 #else
 221                 spl_net_load_image(NULL);
 222 #endif
 223                 break;
 224 #endif
 225 #ifdef CONFIG_SPL_USBETH_SUPPORT
 226         case BOOT_DEVICE_USBETH:
 227                 spl_net_load_image("usb_ether");
 228                 break;
 229 #endif
 230         default:
 231                 debug("SPL: Un-supported Boot Device\n");
 232                 hang();
 233         }
 234
 235         switch (spl_image.os) {
 236         case IH_OS_U_BOOT:
 237                 debug("Jumping to U-Boot\n");
 238                 break;
 239 #ifdef CONFIG_SPL_OS_BOOT
 240         case IH_OS_LINUX:
 241                 debug("Jumping to Linux\n");
 242                 spl_board_prepare_for_linux();
 243                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
 244 #endif
 245         default:
 246                 debug("Unsupported OS image.. Jumping nevertheless..\n");
 247         }
 248         jump_to_image_no_args(&spl_image);
 249 }
 250
 251 /*
 252  * This requires UART clocks to be enabled.  In order for this to work the
 253  * caller must ensure that the gd pointer is valid.
 254  */
 255 void preloader_console_init(void)
 256 {
 257         gd->bd = &bdata;
 258         gd->baudrate = CONFIG_BAUDRATE;
 259
 260         serial_init();          /* serial communications setup */
 261
 262         gd->have_console = 1;
 263
 264         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
 265                         U_BOOT_TIME ")\n");
 266 #ifdef CONFIG_SPL_DISPLAY_PRINT
 267         spl_display_print();
 268 #endif
 269 }