common/spl/spl.c

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