SPL: Add option to skip copying of the mkimage header
[platform/kernel/u-boot.git] / 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                 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) {
80                         /*
81                          * On some system (e.g. powerpc), the load-address and
82                          * entry-point is located at address 0. We can't load
83                          * to 0-0x40. So skip header in this case.
84                          */
85                         spl_image.load_addr = image_get_load(header);
86                         spl_image.entry_point = image_get_ep(header);
87                         spl_image.size = image_get_data_size(header);
88                 } else {
89                         spl_image.entry_point = image_get_load(header);
90                         /* Load including the header */
91                         spl_image.load_addr = spl_image.entry_point -
92                                 header_size;
93                         spl_image.size = image_get_data_size(header) +
94                                 header_size;
95                 }
96                 spl_image.os = image_get_os(header);
97                 spl_image.name = image_get_name(header);
98                 debug("spl: payload image: %s load addr: 0x%x size: %d\n",
99                         spl_image.name, spl_image.load_addr, spl_image.size);
100         } else {
101                 /* Signature not found - assume u-boot.bin */
102                 puts("mkimage signature not found, assuming u-boot.bin ..\n");
103                 debug("mkimage signature not found - ih_magic = %x\n",
104                         header->ih_magic);
105                 /* Let's assume U-Boot will not be more than 200 KB */
106                 spl_image.size = CONFIG_SYS_MONITOR_LEN;
107                 spl_image.entry_point = CONFIG_SYS_TEXT_BASE;
108                 spl_image.load_addr = CONFIG_SYS_TEXT_BASE;
109                 spl_image.os = IH_OS_U_BOOT;
110                 spl_image.name = "U-Boot";
111         }
112 }
113
114 static void __noreturn jump_to_image_no_args(void)
115 {
116         typedef void __noreturn (*image_entry_noargs_t)(u32 *);
117         image_entry_noargs_t image_entry =
118                         (image_entry_noargs_t) spl_image.entry_point;
119
120         debug("image entry point: 0x%X\n", spl_image.entry_point);
121         /* Pass the saved boot_params from rom code */
122 #if defined(CONFIG_VIRTIO) || defined(CONFIG_ZEBU)
123         image_entry = (image_entry_noargs_t)0x80100000;
124 #endif
125         u32 boot_params_ptr_addr = (u32)&boot_params_ptr;
126         image_entry((u32 *)boot_params_ptr_addr);
127 }
128
129 void board_init_r(gd_t *dummy1, ulong dummy2)
130 {
131         u32 boot_device;
132         debug(">>spl:board_init_r()\n");
133
134 #ifdef CONFIG_SYS_SPL_MALLOC_START
135         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
136                         CONFIG_SYS_SPL_MALLOC_SIZE);
137 #endif
138
139 #ifdef CONFIG_SPL_BOARD_INIT
140         spl_board_init();
141 #endif
142
143         boot_device = spl_boot_device();
144         debug("boot device - %d\n", boot_device);
145         switch (boot_device) {
146 #ifdef CONFIG_SPL_MMC_SUPPORT
147         case BOOT_DEVICE_MMC1:
148         case BOOT_DEVICE_MMC2:
149         case BOOT_DEVICE_MMC2_2:
150                 spl_mmc_load_image();
151                 break;
152 #endif
153 #ifdef CONFIG_SPL_NAND_SUPPORT
154         case BOOT_DEVICE_NAND:
155                 spl_nand_load_image();
156                 break;
157 #endif
158 #ifdef CONFIG_SPL_NOR_SUPPORT
159         case BOOT_DEVICE_NOR:
160                 spl_nor_load_image();
161                 break;
162 #endif
163 #ifdef CONFIG_SPL_YMODEM_SUPPORT
164         case BOOT_DEVICE_UART:
165                 spl_ymodem_load_image();
166                 break;
167 #endif
168 #ifdef CONFIG_SPL_SPI_SUPPORT
169         case BOOT_DEVICE_SPI:
170                 spi_boot();
171         break;
172 #endif
173         default:
174                 puts("SPL: Un-supported Boot Device\n");
175                 debug("Found: %d\n", boot_device);
176                 hang();
177                 break;
178         }
179
180         switch (spl_image.os) {
181         case IH_OS_U_BOOT:
182                 debug("Jumping to U-Boot\n");
183                 jump_to_image_no_args();
184                 break;
185 #ifdef CONFIG_SPL_OS_BOOT
186         case IH_OS_LINUX:
187                 debug("Jumping to Linux\n");
188                 spl_board_prepare_for_linux();
189                 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR);
190                 break;
191 #endif
192         default:
193                 puts("Unsupported OS image.. Jumping nevertheless..\n");
194                 jump_to_image_no_args();
195         }
196 }
197
198 /*
199  * This requires UART clocks to be enabled.  In order for this to work the
200  * caller must ensure that the gd pointer is valid.
201  */
202 void preloader_console_init(void)
203 {
204         gd->bd = &bdata;
205         gd->flags |= GD_FLG_RELOC;
206         gd->baudrate = CONFIG_BAUDRATE;
207
208         serial_init();          /* serial communications setup */
209
210         gd->have_console = 1;
211
212         puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
213                         U_BOOT_TIME ")\n");
214 #ifdef CONFIG_SPL_DISPLAY_PRINT
215         spl_display_print();
216 #endif
217 }