xref: /openbmc/u-boot/arch/arm/lib/bootm.c (revision 3f82d89d)
1 /* Copyright (C) 2011
2  * Corscience GmbH & Co. KG - Simon Schwarz <schwarz@corscience.de>
3  *  - Added prep subcommand support
4  *  - Reorganized source - modeled after powerpc version
5  *
6  * (C) Copyright 2002
7  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
8  * Marius Groeger <mgroeger@sysgo.de>
9  *
10  * Copyright (C) 2001  Erik Mouw (J.A.K.Mouw@its.tudelft.nl)
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307	 USA
25  *
26  */
27 
28 #include <common.h>
29 #include <command.h>
30 #include <image.h>
31 #include <u-boot/zlib.h>
32 #include <asm/byteorder.h>
33 #include <fdt.h>
34 #include <libfdt.h>
35 #include <fdt_support.h>
36 #include <asm/bootm.h>
37 
38 DECLARE_GLOBAL_DATA_PTR;
39 
40 #if defined(CONFIG_SETUP_MEMORY_TAGS) || \
41 	defined(CONFIG_CMDLINE_TAG) || \
42 	defined(CONFIG_INITRD_TAG) || \
43 	defined(CONFIG_SERIAL_TAG) || \
44 	defined(CONFIG_REVISION_TAG)
45 static struct tag *params;
46 #endif
47 
48 static ulong get_sp(void)
49 {
50 	ulong ret;
51 
52 	asm("mov %0, sp" : "=r"(ret) : );
53 	return ret;
54 }
55 
56 void arch_lmb_reserve(struct lmb *lmb)
57 {
58 	ulong sp;
59 
60 	/*
61 	 * Booting a (Linux) kernel image
62 	 *
63 	 * Allocate space for command line and board info - the
64 	 * address should be as high as possible within the reach of
65 	 * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
66 	 * memory, which means far enough below the current stack
67 	 * pointer.
68 	 */
69 	sp = get_sp();
70 	debug("## Current stack ends at 0x%08lx ", sp);
71 
72 	/* adjust sp by 1K to be safe */
73 	sp -= 1024;
74 	lmb_reserve(lmb, sp,
75 		    gd->bd->bi_dram[0].start + gd->bd->bi_dram[0].size - sp);
76 }
77 
78 #ifdef CONFIG_OF_LIBFDT
79 static int fixup_memory_node(void *blob)
80 {
81 	bd_t	*bd = gd->bd;
82 	int bank;
83 	u64 start[CONFIG_NR_DRAM_BANKS];
84 	u64 size[CONFIG_NR_DRAM_BANKS];
85 
86 	for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
87 		start[bank] = bd->bi_dram[bank].start;
88 		size[bank] = bd->bi_dram[bank].size;
89 	}
90 
91 	return fdt_fixup_memory_banks(blob, start, size, CONFIG_NR_DRAM_BANKS);
92 }
93 #endif
94 
95 static void announce_and_cleanup(void)
96 {
97 	printf("\nStarting kernel ...\n\n");
98 	bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
99 #ifdef CONFIG_BOOTSTAGE_REPORT
100 	bootstage_report();
101 #endif
102 
103 #ifdef CONFIG_USB_DEVICE
104 	udc_disconnect();
105 #endif
106 	cleanup_before_linux();
107 }
108 
109 #if defined(CONFIG_SETUP_MEMORY_TAGS) || \
110 	defined(CONFIG_CMDLINE_TAG) || \
111 	defined(CONFIG_INITRD_TAG) || \
112 	defined(CONFIG_SERIAL_TAG) || \
113 	defined(CONFIG_REVISION_TAG)
114 static void setup_start_tag (bd_t *bd)
115 {
116 	params = (struct tag *)bd->bi_boot_params;
117 
118 	params->hdr.tag = ATAG_CORE;
119 	params->hdr.size = tag_size (tag_core);
120 
121 	params->u.core.flags = 0;
122 	params->u.core.pagesize = 0;
123 	params->u.core.rootdev = 0;
124 
125 	params = tag_next (params);
126 }
127 #endif
128 
129 #ifdef CONFIG_SETUP_MEMORY_TAGS
130 static void setup_memory_tags(bd_t *bd)
131 {
132 	int i;
133 
134 	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
135 		params->hdr.tag = ATAG_MEM;
136 		params->hdr.size = tag_size (tag_mem32);
137 
138 		params->u.mem.start = bd->bi_dram[i].start;
139 		params->u.mem.size = bd->bi_dram[i].size;
140 
141 		params = tag_next (params);
142 	}
143 }
144 #endif
145 
146 #ifdef CONFIG_CMDLINE_TAG
147 static void setup_commandline_tag(bd_t *bd, char *commandline)
148 {
149 	char *p;
150 
151 	if (!commandline)
152 		return;
153 
154 	/* eat leading white space */
155 	for (p = commandline; *p == ' '; p++);
156 
157 	/* skip non-existent command lines so the kernel will still
158 	 * use its default command line.
159 	 */
160 	if (*p == '\0')
161 		return;
162 
163 	params->hdr.tag = ATAG_CMDLINE;
164 	params->hdr.size =
165 		(sizeof (struct tag_header) + strlen (p) + 1 + 4) >> 2;
166 
167 	strcpy (params->u.cmdline.cmdline, p);
168 
169 	params = tag_next (params);
170 }
171 #endif
172 
173 #ifdef CONFIG_INITRD_TAG
174 static void setup_initrd_tag(bd_t *bd, ulong initrd_start, ulong initrd_end)
175 {
176 	/* an ATAG_INITRD node tells the kernel where the compressed
177 	 * ramdisk can be found. ATAG_RDIMG is a better name, actually.
178 	 */
179 	params->hdr.tag = ATAG_INITRD2;
180 	params->hdr.size = tag_size (tag_initrd);
181 
182 	params->u.initrd.start = initrd_start;
183 	params->u.initrd.size = initrd_end - initrd_start;
184 
185 	params = tag_next (params);
186 }
187 #endif
188 
189 #ifdef CONFIG_SERIAL_TAG
190 void setup_serial_tag(struct tag **tmp)
191 {
192 	struct tag *params = *tmp;
193 	struct tag_serialnr serialnr;
194 	void get_board_serial(struct tag_serialnr *serialnr);
195 
196 	get_board_serial(&serialnr);
197 	params->hdr.tag = ATAG_SERIAL;
198 	params->hdr.size = tag_size (tag_serialnr);
199 	params->u.serialnr.low = serialnr.low;
200 	params->u.serialnr.high= serialnr.high;
201 	params = tag_next (params);
202 	*tmp = params;
203 }
204 #endif
205 
206 #ifdef CONFIG_REVISION_TAG
207 void setup_revision_tag(struct tag **in_params)
208 {
209 	u32 rev = 0;
210 	u32 get_board_rev(void);
211 
212 	rev = get_board_rev();
213 	params->hdr.tag = ATAG_REVISION;
214 	params->hdr.size = tag_size (tag_revision);
215 	params->u.revision.rev = rev;
216 	params = tag_next (params);
217 }
218 #endif
219 
220 #if defined(CONFIG_SETUP_MEMORY_TAGS) || \
221 	defined(CONFIG_CMDLINE_TAG) || \
222 	defined(CONFIG_INITRD_TAG) || \
223 	defined(CONFIG_SERIAL_TAG) || \
224 	defined(CONFIG_REVISION_TAG)
225 static void setup_end_tag(bd_t *bd)
226 {
227 	params->hdr.tag = ATAG_NONE;
228 	params->hdr.size = 0;
229 }
230 #endif
231 
232 #ifdef CONFIG_OF_LIBFDT
233 static int create_fdt(bootm_headers_t *images)
234 {
235 	ulong of_size = images->ft_len;
236 	char **of_flat_tree = &images->ft_addr;
237 	ulong *initrd_start = &images->initrd_start;
238 	ulong *initrd_end = &images->initrd_end;
239 	struct lmb *lmb = &images->lmb;
240 	ulong rd_len;
241 	int ret;
242 
243 	debug("using: FDT\n");
244 
245 	boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
246 
247 	rd_len = images->rd_end - images->rd_start;
248 	ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
249 			initrd_start, initrd_end);
250 	if (ret)
251 		return ret;
252 
253 	ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
254 	if (ret)
255 		return ret;
256 
257 	fdt_chosen(*of_flat_tree, 1);
258 	fixup_memory_node(*of_flat_tree);
259 	fdt_fixup_ethernet(*of_flat_tree);
260 	fdt_initrd(*of_flat_tree, *initrd_start, *initrd_end, 1);
261 
262 	return 0;
263 }
264 #endif
265 
266 /* Subcommand: PREP */
267 static void boot_prep_linux(bootm_headers_t *images)
268 {
269 #ifdef CONFIG_CMDLINE_TAG
270 	char *commandline = getenv("bootargs");
271 #endif
272 
273 #ifdef CONFIG_OF_LIBFDT
274 	if (images->ft_len) {
275 		debug("using: FDT\n");
276 		if (create_fdt(images)) {
277 			printf("FDT creation failed! hanging...");
278 			hang();
279 		}
280 	} else
281 #endif
282 	{
283 #if defined(CONFIG_SETUP_MEMORY_TAGS) || \
284 	defined(CONFIG_CMDLINE_TAG) || \
285 	defined(CONFIG_INITRD_TAG) || \
286 	defined(CONFIG_SERIAL_TAG) || \
287 	defined(CONFIG_REVISION_TAG)
288 		debug("using: ATAGS\n");
289 		setup_start_tag(gd->bd);
290 #ifdef CONFIG_SERIAL_TAG
291 		setup_serial_tag(&params);
292 #endif
293 #ifdef CONFIG_CMDLINE_TAG
294 		setup_commandline_tag(gd->bd, commandline);
295 #endif
296 #ifdef CONFIG_REVISION_TAG
297 		setup_revision_tag(&params);
298 #endif
299 #ifdef CONFIG_SETUP_MEMORY_TAGS
300 		setup_memory_tags(gd->bd);
301 #endif
302 #ifdef CONFIG_INITRD_TAG
303 		if (images->rd_start && images->rd_end)
304 			setup_initrd_tag(gd->bd, images->rd_start,
305 			images->rd_end);
306 #endif
307 		setup_end_tag(gd->bd);
308 #else /* all tags */
309 		printf("FDT and ATAGS support not compiled in - hanging\n");
310 		hang();
311 #endif /* all tags */
312 	}
313 }
314 
315 /* Subcommand: GO */
316 static void boot_jump_linux(bootm_headers_t *images)
317 {
318 	unsigned long machid = gd->bd->bi_arch_number;
319 	char *s;
320 	void (*kernel_entry)(int zero, int arch, uint params);
321 	unsigned long r2;
322 
323 	kernel_entry = (void (*)(int, int, uint))images->ep;
324 
325 	s = getenv("machid");
326 	if (s) {
327 		strict_strtoul(s, 16, &machid);
328 		printf("Using machid 0x%lx from environment\n", machid);
329 	}
330 
331 	debug("## Transferring control to Linux (at address %08lx)" \
332 		"...\n", (ulong) kernel_entry);
333 	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
334 	announce_and_cleanup();
335 
336 #ifdef CONFIG_OF_LIBFDT
337 	if (images->ft_len)
338 		r2 = (unsigned long)images->ft_addr;
339 	else
340 #endif
341 		r2 = gd->bd->bi_boot_params;
342 
343 	kernel_entry(0, machid, r2);
344 }
345 
346 /* Main Entry point for arm bootm implementation
347  *
348  * Modeled after the powerpc implementation
349  * DIFFERENCE: Instead of calling prep and go at the end
350  * they are called if subcommand is equal 0.
351  */
352 int do_bootm_linux(int flag, int argc, char *argv[], bootm_headers_t *images)
353 {
354 	/* No need for those on ARM */
355 	if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
356 		return -1;
357 
358 	if (flag & BOOTM_STATE_OS_PREP) {
359 		boot_prep_linux(images);
360 		return 0;
361 	}
362 
363 	if (flag & BOOTM_STATE_OS_GO) {
364 		boot_jump_linux(images);
365 		return 0;
366 	}
367 
368 	boot_prep_linux(images);
369 	boot_jump_linux(images);
370 	return 0;
371 }
372 
373 #ifdef CONFIG_CMD_BOOTZ
374 
375 struct zimage_header {
376 	uint32_t	code[9];
377 	uint32_t	zi_magic;
378 	uint32_t	zi_start;
379 	uint32_t	zi_end;
380 };
381 
382 #define	LINUX_ARM_ZIMAGE_MAGIC	0x016f2818
383 
384 int bootz_setup(void *image, void **start, void **end)
385 {
386 	struct zimage_header *zi = (struct zimage_header *)image;
387 
388 	if (zi->zi_magic != LINUX_ARM_ZIMAGE_MAGIC) {
389 		puts("Bad Linux ARM zImage magic!\n");
390 		return 1;
391 	}
392 
393 	*start = (void *)zi->zi_start;
394 	*end = (void *)zi->zi_end;
395 
396 	debug("Kernel image @ 0x%08x [ 0x%08x - 0x%08x ]\n",
397 		(uint32_t)image, (uint32_t)*start, (uint32_t)*end);
398 
399 	return 0;
400 }
401 #endif	/* CONFIG_CMD_BOOTZ */
402