xref: /openbmc/u-boot/arch/powerpc/lib/bootm.c (revision ee52b188)
1 /*
2  * (C) Copyright 2008 Semihalf
3  *
4  * (C) Copyright 2000-2006
5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
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 
26 
27 #include <common.h>
28 #include <watchdog.h>
29 #include <command.h>
30 #include <image.h>
31 #include <malloc.h>
32 #include <u-boot/zlib.h>
33 #include <bzlib.h>
34 #include <environment.h>
35 #include <asm/byteorder.h>
36 #include <asm/mp.h>
37 
38 #if defined(CONFIG_OF_LIBFDT)
39 #include <fdt.h>
40 #include <libfdt.h>
41 #include <fdt_support.h>
42 
43 #endif
44 
45 #ifdef CONFIG_SYS_INIT_RAM_LOCK
46 #include <asm/cache.h>
47 #endif
48 
49 DECLARE_GLOBAL_DATA_PTR;
50 
51 extern ulong get_effective_memsize(void);
52 static ulong get_sp (void);
53 static void set_clocks_in_mhz (bd_t *kbd);
54 
55 #ifndef CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE
56 #define CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE	(768*1024*1024)
57 #endif
58 
59 static void boot_jump_linux(bootm_headers_t *images)
60 {
61 	void	(*kernel)(bd_t *, ulong r4, ulong r5, ulong r6,
62 			  ulong r7, ulong r8, ulong r9);
63 #ifdef CONFIG_OF_LIBFDT
64 	char *of_flat_tree = images->ft_addr;
65 #endif
66 
67 	kernel = (void (*)(bd_t *, ulong, ulong, ulong,
68 			   ulong, ulong, ulong))images->ep;
69 	debug ("## Transferring control to Linux (at address %08lx) ...\n",
70 		(ulong)kernel);
71 
72 	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
73 
74 #if defined(CONFIG_SYS_INIT_RAM_LOCK) && !defined(CONFIG_E500)
75 	unlock_ram_in_cache();
76 #endif
77 
78 #if defined(CONFIG_OF_LIBFDT)
79 	if (of_flat_tree) {	/* device tree; boot new style */
80 		/*
81 		 * Linux Kernel Parameters (passing device tree):
82 		 *   r3: pointer to the fdt
83 		 *   r4: 0
84 		 *   r5: 0
85 		 *   r6: epapr magic
86 		 *   r7: size of IMA in bytes
87 		 *   r8: 0
88 		 *   r9: 0
89 		 */
90 #if defined(CONFIG_MPC85xx) || defined(CONFIG_440)
91  #define EPAPR_MAGIC	(0x45504150)
92 #else
93  #define EPAPR_MAGIC	(0x65504150)
94 #endif
95 
96 		debug ("   Booting using OF flat tree...\n");
97 		WATCHDOG_RESET ();
98 		(*kernel) ((bd_t *)of_flat_tree, 0, 0, EPAPR_MAGIC,
99 			   getenv_bootm_mapsize(), 0, 0);
100 		/* does not return */
101 	} else
102 #endif
103 	{
104 		/*
105 		 * Linux Kernel Parameters (passing board info data):
106 		 *   r3: ptr to board info data
107 		 *   r4: initrd_start or 0 if no initrd
108 		 *   r5: initrd_end - unused if r4 is 0
109 		 *   r6: Start of command line string
110 		 *   r7: End   of command line string
111 		 *   r8: 0
112 		 *   r9: 0
113 		 */
114 		ulong cmd_start = images->cmdline_start;
115 		ulong cmd_end = images->cmdline_end;
116 		ulong initrd_start = images->initrd_start;
117 		ulong initrd_end = images->initrd_end;
118 		bd_t *kbd = images->kbd;
119 
120 		debug ("   Booting using board info...\n");
121 		WATCHDOG_RESET ();
122 		(*kernel) (kbd, initrd_start, initrd_end,
123 			   cmd_start, cmd_end, 0, 0);
124 		/* does not return */
125 	}
126 	return ;
127 }
128 
129 void arch_lmb_reserve(struct lmb *lmb)
130 {
131 	phys_size_t bootm_size;
132 	ulong size, sp, bootmap_base;
133 
134 	bootmap_base = getenv_bootm_low();
135 	bootm_size = getenv_bootm_size();
136 
137 #ifdef DEBUG
138 	if (((u64)bootmap_base + bootm_size) >
139 	    (CONFIG_SYS_SDRAM_BASE + (u64)gd->ram_size))
140 		puts("WARNING: bootm_low + bootm_size exceed total memory\n");
141 	if ((bootmap_base + bootm_size) > get_effective_memsize())
142 		puts("WARNING: bootm_low + bootm_size exceed eff. memory\n");
143 #endif
144 
145 	size = min(bootm_size, get_effective_memsize());
146 	size = min(size, CONFIG_SYS_LINUX_LOWMEM_MAX_SIZE);
147 
148 	if (size < bootm_size) {
149 		ulong base = bootmap_base + size;
150 		printf("WARNING: adjusting available memory to %lx\n", size);
151 		lmb_reserve(lmb, base, bootm_size - size);
152 	}
153 
154 	/*
155 	 * Booting a (Linux) kernel image
156 	 *
157 	 * Allocate space for command line and board info - the
158 	 * address should be as high as possible within the reach of
159 	 * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
160 	 * memory, which means far enough below the current stack
161 	 * pointer.
162 	 */
163 	sp = get_sp();
164 	debug ("## Current stack ends at 0x%08lx\n", sp);
165 
166 	/* adjust sp by 4K to be safe */
167 	sp -= 4096;
168 	lmb_reserve(lmb, sp, (CONFIG_SYS_SDRAM_BASE + get_effective_memsize() - sp));
169 
170 #ifdef CONFIG_MP
171 	cpu_mp_lmb_reserve(lmb);
172 #endif
173 
174 	return ;
175 }
176 
177 static void boot_prep_linux(bootm_headers_t *images)
178 {
179 #ifdef CONFIG_MP
180 	/*
181 	 * if we are MP make sure to flush the device tree so any changes are
182 	 * made visibile to all other cores.  In AMP boot scenarios the cores
183 	 * might not be HW cache coherent with each other.
184 	 */
185 	flush_cache((unsigned long)images->ft_addr, images->ft_len);
186 #endif
187 }
188 
189 static int boot_cmdline_linux(bootm_headers_t *images)
190 {
191 	ulong of_size = images->ft_len;
192 	struct lmb *lmb = &images->lmb;
193 	ulong *cmd_start = &images->cmdline_start;
194 	ulong *cmd_end = &images->cmdline_end;
195 
196 	int ret = 0;
197 
198 	if (!of_size) {
199 		/* allocate space and init command line */
200 		ret = boot_get_cmdline (lmb, cmd_start, cmd_end);
201 		if (ret) {
202 			puts("ERROR with allocation of cmdline\n");
203 			return ret;
204 		}
205 	}
206 
207 	return ret;
208 }
209 
210 static int boot_bd_t_linux(bootm_headers_t *images)
211 {
212 	ulong of_size = images->ft_len;
213 	struct lmb *lmb = &images->lmb;
214 	bd_t **kbd = &images->kbd;
215 
216 	int ret = 0;
217 
218 	if (!of_size) {
219 		/* allocate space for kernel copy of board info */
220 		ret = boot_get_kbd (lmb, kbd);
221 		if (ret) {
222 			puts("ERROR with allocation of kernel bd\n");
223 			return ret;
224 		}
225 		set_clocks_in_mhz(*kbd);
226 	}
227 
228 	return ret;
229 }
230 
231 /*
232  * Verify the device tree.
233  *
234  * This function is called after all device tree fix-ups have been enacted,
235  * so that the final device tree can be verified.  The definition of "verified"
236  * is up to the specific implementation.  However, it generally means that the
237  * addresses of some of the devices in the device tree are compared with the
238  * actual addresses at which U-Boot has placed them.
239  *
240  * Returns 1 on success, 0 on failure.  If 0 is returned, U-boot will halt the
241  * boot process.
242  */
243 static int __ft_verify_fdt(void *fdt)
244 {
245 	return 1;
246 }
247 __attribute__((weak, alias("__ft_verify_fdt"))) int ft_verify_fdt(void *fdt);
248 
249 static int boot_body_linux(bootm_headers_t *images)
250 {
251 	ulong rd_len;
252 	struct lmb *lmb = &images->lmb;
253 	ulong *initrd_start = &images->initrd_start;
254 	ulong *initrd_end = &images->initrd_end;
255 #if defined(CONFIG_OF_LIBFDT)
256 	ulong of_size = images->ft_len;
257 	char **of_flat_tree = &images->ft_addr;
258 #endif
259 
260 	int ret;
261 
262 #if defined(CONFIG_OF_LIBFDT)
263 	boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
264 #endif
265 
266 	/* allocate space and init command line */
267 	ret = boot_cmdline_linux(images);
268 	if (ret)
269 		return ret;
270 
271 	/* allocate space for kernel copy of board info */
272 	ret = boot_bd_t_linux(images);
273 	if (ret)
274 		return ret;
275 
276 	rd_len = images->rd_end - images->rd_start;
277 	ret = boot_ramdisk_high (lmb, images->rd_start, rd_len, initrd_start, initrd_end);
278 	if (ret)
279 		return ret;
280 
281 #if defined(CONFIG_OF_LIBFDT)
282 	ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
283 	if (ret)
284 		return ret;
285 
286 	/*
287 	 * Add the chosen node if it doesn't exist, add the env and bd_t
288 	 * if the user wants it (the logic is in the subroutines).
289 	 */
290 	if (of_size) {
291 		if (fdt_chosen(*of_flat_tree, 1) < 0) {
292 			puts ("ERROR: ");
293 			puts ("/chosen node create failed");
294 			puts (" - must RESET the board to recover.\n");
295 			return -1;
296 		}
297 #ifdef CONFIG_OF_BOARD_SETUP
298 		/* Call the board-specific fixup routine */
299 		ft_board_setup(*of_flat_tree, gd->bd);
300 #endif
301 
302 		/* Delete the old LMB reservation */
303 		lmb_free(lmb, (phys_addr_t)(u32)*of_flat_tree,
304 				(phys_size_t)fdt_totalsize(*of_flat_tree));
305 
306 		ret = fdt_resize(*of_flat_tree);
307 		if (ret < 0)
308 			return ret;
309 		of_size = ret;
310 
311 		if (*initrd_start && *initrd_end) {
312 			of_size += FDT_RAMDISK_OVERHEAD;
313 			fdt_set_totalsize(*of_flat_tree, of_size);
314 		}
315 		/* Create a new LMB reservation */
316 		lmb_reserve(lmb, (ulong)*of_flat_tree, of_size);
317 
318 		/* fixup the initrd now that we know where it should be */
319 		if (*initrd_start && *initrd_end)
320 			fdt_initrd(*of_flat_tree, *initrd_start, *initrd_end, 1);
321 
322 		if (!ft_verify_fdt(*of_flat_tree))
323 			return -1;
324 	}
325 #endif	/* CONFIG_OF_LIBFDT */
326 	return 0;
327 }
328 
329 __attribute__((noinline))
330 int do_bootm_linux(int flag, int argc, char * const argv[], bootm_headers_t *images)
331 {
332 	int	ret;
333 
334 	if (flag & BOOTM_STATE_OS_CMDLINE) {
335 		boot_cmdline_linux(images);
336 		return 0;
337 	}
338 
339 	if (flag & BOOTM_STATE_OS_BD_T) {
340 		boot_bd_t_linux(images);
341 		return 0;
342 	}
343 
344 	if (flag & BOOTM_STATE_OS_PREP) {
345 		boot_prep_linux(images);
346 		return 0;
347 	}
348 
349 	if (flag & BOOTM_STATE_OS_GO) {
350 		boot_jump_linux(images);
351 		return 0;
352 	}
353 
354 	boot_prep_linux(images);
355 	ret = boot_body_linux(images);
356 	if (ret)
357 		return ret;
358 	boot_jump_linux(images);
359 
360 	return 0;
361 }
362 
363 static ulong get_sp (void)
364 {
365 	ulong sp;
366 
367 	asm( "mr %0,1": "=r"(sp) : );
368 	return sp;
369 }
370 
371 static void set_clocks_in_mhz (bd_t *kbd)
372 {
373 	char	*s;
374 
375 	if ((s = getenv ("clocks_in_mhz")) != NULL) {
376 		/* convert all clock information to MHz */
377 		kbd->bi_intfreq /= 1000000L;
378 		kbd->bi_busfreq /= 1000000L;
379 #if defined(CONFIG_MPC8220)
380 		kbd->bi_inpfreq /= 1000000L;
381 		kbd->bi_pcifreq /= 1000000L;
382 		kbd->bi_pevfreq /= 1000000L;
383 		kbd->bi_flbfreq /= 1000000L;
384 		kbd->bi_vcofreq /= 1000000L;
385 #endif
386 #if defined(CONFIG_CPM2)
387 		kbd->bi_cpmfreq /= 1000000L;
388 		kbd->bi_brgfreq /= 1000000L;
389 		kbd->bi_sccfreq /= 1000000L;
390 		kbd->bi_vco	/= 1000000L;
391 #endif
392 #if defined(CONFIG_MPC5xxx)
393 		kbd->bi_ipbfreq /= 1000000L;
394 		kbd->bi_pcifreq /= 1000000L;
395 #endif /* CONFIG_MPC5xxx */
396 	}
397 }
398