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