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